Enforce Rubocop via Travis (#72)

Author: oakbani

.rubocop.yml

@@ -1,3 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -10,26 +15,29 @@ Metrics/PerceivedComplexity:
 Metrics/ClassLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/LineLength:
-  Max: 120
+  Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
-Style/AccessorMethodName:
+Metrics/ModuleLength:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
 
-Style/FormatString:
-  Enabled: false
-
 Style/SignalException:
   EnforcedStyle: only_raise
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Style/WordArray:
+Naming/VariableNumber:
   Enabled: false
+
+Lint/RescueWithoutErrorClass:
+   Enabled: false

.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-12-06 17:48:00 +0500 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+Lint/LiteralAsCondition:
+  Exclude:
+    - 'lib/optimizely/project_config.rb'
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/optimizely.rb'

.travis.yml

@@ -5,5 +5,6 @@ before_install: gem install bundler -v 1.10.6
 install:
   - bundle install
   - bundle exec rake install
+before_script: "rubocop"
 script: "rake spec"
 after_success: "coveralls"

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in optimizely-sdk.gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require_relative 'spec/benchmarking/benchmark'
 
@@ -14,4 +16,4 @@ task :benchmark do
   OptimizelyBenchmark.run_tests
 end
 
-task :default => :spec
+task default: :spec

lib/optimizely.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #    Copyright 2016-2017, Optimizely and contributors
 #
@@ -29,7 +31,6 @@
 
 module Optimizely
   class Project
-
     # Boolean representing if the instance represents a usable Optimizely Project
     attr_reader :is_valid
 
@@ -148,9 +149,7 @@ def get_variation(experiment_key, user_id, attributes = nil)
 
       unless variation_id.nil?
         variation = @config.get_variation_from_id(experiment_key, variation_id)
-        if variation
-          return variation['key']
-        end
+        return variation['key'] if variation
       end
       nil
     end
@@ -165,7 +164,7 @@ def set_forced_variation(experiment_key, user_id, variation_key)
       #
       # Returns - Boolean - indicates if the set completed successfully.
 
-      @config.set_forced_variation(experiment_key, user_id, variation_key);
+      @config.set_forced_variation(experiment_key, user_id, variation_key)
     end
 
     def get_forced_variation(experiment_key, user_id)
@@ -177,10 +176,8 @@ def get_forced_variation(experiment_key, user_id)
       # Returns String|nil The forced variation key.
 
       forced_variation_key = nil
-      forced_variation = @config.get_forced_variation(experiment_key, user_id);
-      if forced_variation
-        forced_variation_key = forced_variation['key']
-      end
+      forced_variation = @config.get_forced_variation(experiment_key, user_id)
+      forced_variation_key = forced_variation['key'] if forced_variation
 
       forced_variation_key
     end
@@ -199,7 +196,7 @@ def track(event_key, user_id, attributes = nil, event_tags = nil)
         return nil
       end
 
-      if event_tags and event_tags.is_a? Numeric
+      if event_tags && event_tags.is_a?(Numeric)
         event_tags = {
           'revenue' => event_tags
         }
@@ -227,19 +224,18 @@ def track(event_key, user_id, attributes = nil, event_tags = nil)
       conversion_event = @event_builder.create_conversion_event(event_key, user_id, attributes,
                                                                 event_tags, experiment_variation_map)
       @logger.log(Logger::INFO,
-                  'Dispatching conversion event to URL %s with params %s.' % [conversion_event.url,
-                                                                              conversion_event.params])
+                  "Dispatching conversion event to URL #{conversion_event.url} with params #{conversion_event.params}.")
       begin
         @event_dispatcher.dispatch_event(conversion_event)
       rescue => e
         @logger.log(Logger::ERROR, "Unable to dispatch conversion event. Error: #{e}")
       end
 
       @notification_center.send_notifications(
-          NotificationCenter::NOTIFICATION_TYPES[:TRACK],
-          event_key, user_id, attributes, event_tags, conversion_event
+        NotificationCenter::NOTIFICATION_TYPES[:TRACK],
+        event_key, user_id, attributes, event_tags, conversion_event
       )
-      return nil
+      nil
     end
 
     def is_feature_enabled(feature_flag_key, user_id, attributes = nil)
@@ -282,7 +278,7 @@ def is_feature_enabled(feature_flag_key, user_id, attributes = nil)
       end
 
       @logger.log(Logger::INFO,
-        "Feature '#{feature_flag_key}' is not enabled for user '#{user_id}'.")
+                  "Feature '#{feature_flag_key}' is not enabled for user '#{user_id}'.")
       false
     end
 
@@ -300,12 +296,12 @@ def get_feature_variable_string(feature_flag_key, variable_key, user_id, attribu
       variable_value = get_feature_variable_for_type(
         feature_flag_key,
         variable_key,
-        Optimizely::Helpers::Constants::VARIABLE_TYPES["STRING"],
+        Optimizely::Helpers::Constants::VARIABLE_TYPES['STRING'],
         user_id,
         attributes
       )
 
-      return variable_value
+      variable_value
     end
 
     def get_feature_variable_boolean(feature_flag_key, variable_key, user_id, attributes = nil)
@@ -322,12 +318,12 @@ def get_feature_variable_boolean(feature_flag_key, variable_key, user_id, attrib
       variable_value = get_feature_variable_for_type(
         feature_flag_key,
         variable_key,
-        Optimizely::Helpers::Constants::VARIABLE_TYPES["BOOLEAN"],
+        Optimizely::Helpers::Constants::VARIABLE_TYPES['BOOLEAN'],
         user_id,
         attributes
       )
 
-      return variable_value
+      variable_value
     end
 
     def get_feature_variable_double(feature_flag_key, variable_key, user_id, attributes = nil)
@@ -344,12 +340,12 @@ def get_feature_variable_double(feature_flag_key, variable_key, user_id, attribu
       variable_value = get_feature_variable_for_type(
         feature_flag_key,
         variable_key,
-        Optimizely::Helpers::Constants::VARIABLE_TYPES["DOUBLE"],
+        Optimizely::Helpers::Constants::VARIABLE_TYPES['DOUBLE'],
         user_id,
         attributes
       )
 
-      return variable_value
+      variable_value
     end
 
     def get_feature_variable_integer(feature_flag_key, variable_key, user_id, attributes = nil)
@@ -366,12 +362,12 @@ def get_feature_variable_integer(feature_flag_key, variable_key, user_id, attrib
       variable_value = get_feature_variable_for_type(
         feature_flag_key,
         variable_key,
-        Optimizely::Helpers::Constants::VARIABLE_TYPES["INTEGER"],
+        Optimizely::Helpers::Constants::VARIABLE_TYPES['INTEGER'],
         user_id,
         attributes
       )
 
-      return variable_value
+      variable_value
     end
 
     private
@@ -391,17 +387,17 @@ def get_feature_variable_for_type(feature_flag_key, variable_key, variable_type,
       #             in case of variable type mismatch
 
       unless feature_flag_key
-        @logger.log(Logger::ERROR, "Feature flag key cannot be empty.")
+        @logger.log(Logger::ERROR, 'Feature flag key cannot be empty.')
         return nil
       end
 
       unless variable_key
-        @logger.log(Logger::ERROR, "Variable key cannot be empty.")
+        @logger.log(Logger::ERROR, 'Variable key cannot be empty.')
         return nil
       end
 
       unless user_id
-        @logger.log(Logger::ERROR, "User ID cannot be empty.")
+        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
         return nil
       end
 
@@ -419,7 +415,7 @@ def get_feature_variable_for_type(feature_flag_key, variable_key, variable_type,
       # Returns nil if type differs
       if variable['type'] != variable_type
         @logger.log(Logger::WARN,
-          "Requested variable as type '#{variable_type}' but variable '#{variable_key}' is of type '#{variable['type']}'.")
+                    "Requested variable as type '#{variable_type}' but variable '#{variable_key}' is of type '#{variable['type']}'.")
         return nil
       else
         decision = @decision_service.get_variation_for_feature(feature_flag, user_id, attributes)
@@ -428,17 +424,17 @@ def get_feature_variable_for_type(feature_flag_key, variable_key, variable_type,
           variation = decision['variation']
           variation_variable_usages = @config.variation_id_to_variable_usage_map[variation['id']]
           variable_id = variable['id']
-          if variation_variable_usages and variation_variable_usages.key?(variable_id)
+          if variation_variable_usages&.key?(variable_id)
             variable_value = variation_variable_usages[variable_id]['value']
             @logger.log(Logger::INFO,
-              "Got variable value '#{variable_value}' for variable '#{variable_key}' of feature flag '#{feature_flag_key}'.")
+                        "Got variable value '#{variable_value}' for variable '#{variable_key}' of feature flag '#{feature_flag_key}'.")
           else
             @logger.log(Logger::DEBUG,
-              "Variable '#{variable_key}' is not used in variation '#{variation['key']}'. Returning the default variable value '#{variable_value}'.")
+                        "Variable '#{variable_key}' is not used in variation '#{variation['key']}'. Returning the default variable value '#{variable_value}'.")
           end
         else
           @logger.log(Logger::INFO,
-            "User '#{user_id}' was not bucketed into any variation for feature flag '#{feature_flag_key}'. Returning the default variable value '#{variable_value}'.")
+                      "User '#{user_id}' was not bucketed into any variation for feature flag '#{feature_flag_key}'. Returning the default variable value '#{variable_value}'.")
         end
       end
 
@@ -483,13 +479,9 @@ def user_inputs_valid?(attributes = nil, event_tags = nil)
       #
       # Returns boolean True if inputs are valid. False otherwise.
 
-      if !attributes.nil? && !attributes_valid?(attributes)
-        return false
-      end
+      return false if !attributes.nil? && !attributes_valid?(attributes)
 
-      if !event_tags.nil? && !event_tags_valid?(event_tags)
-        return false
-      end
+      return false if !event_tags.nil? && !event_tags_valid?(event_tags)
 
       true
     end
@@ -514,30 +506,29 @@ def event_tags_valid?(event_tags)
 
     def validate_instantiation_options(datafile, skip_json_validation)
       unless skip_json_validation
-        raise InvalidInputError.new('datafile') unless Helpers::Validator.datafile_valid?(datafile)
+        raise InvalidInputError, 'datafile' unless Helpers::Validator.datafile_valid?(datafile)
       end
 
-      raise InvalidInputError.new('logger') unless Helpers::Validator.logger_valid?(@logger)
-      raise InvalidInputError.new('error_handler') unless Helpers::Validator.error_handler_valid?(@error_handler)
-      raise InvalidInputError.new('event_dispatcher') unless Helpers::Validator.event_dispatcher_valid?(@event_dispatcher)
+      raise InvalidInputError, 'logger' unless Helpers::Validator.logger_valid?(@logger)
+      raise InvalidInputError, 'error_handler' unless Helpers::Validator.error_handler_valid?(@error_handler)
+      raise InvalidInputError, 'event_dispatcher' unless Helpers::Validator.event_dispatcher_valid?(@event_dispatcher)
     end
 
     def send_impression(experiment, variation_key, user_id, attributes = nil)
       experiment_key = experiment['key']
       variation_id = @config.get_variation_id_from_key(experiment_key, variation_key)
       impression_event = @event_builder.create_impression_event(experiment, variation_id, user_id, attributes)
       @logger.log(Logger::INFO,
-                  'Dispatching impression event to URL %s with params %s.' % [impression_event.url,
-                                                                              impression_event.params])
+                  "Dispatching impression event to URL #{impression_event.url} with params #{impression_event.params}.")
       begin
         @event_dispatcher.dispatch_event(impression_event)
       rescue => e
         @logger.log(Logger::ERROR, "Unable to dispatch impression event. Error: #{e}")
       end
       variation = @config.get_variation_from_id(experiment_key, variation_id)
       @notification_center.send_notifications(
-          NotificationCenter::NOTIFICATION_TYPES[:ACTIVATE],
-          experiment,user_id, attributes, variation, impression_event
+        NotificationCenter::NOTIFICATION_TYPES[:ACTIVATE],
+        experiment, user_id, attributes, variation, impression_event
       )
     end
   end

lib/optimizely/audience.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -43,7 +45,7 @@ def user_in_experiment?(config, experiment, attributes)
       audience_ids.each do |audience_id|
         audience = config.get_audience_from_id(audience_id)
         audience_conditions = audience['conditions']
-        audience_conditions = JSON.load(audience_conditions)
+        audience_conditions = JSON.parse(audience_conditions)
         return true if @condition_evaluator.evaluate(audience_conditions)
       end