split 4.0.1 → 4.0.2

data/lib/split/experiment_catalog.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 module Split
   class ExperimentCatalog
     # Return all experiments
     def self.all
       # Call compact to prevent nil experiments from being returned -- seems to happen during gem upgrades
-      Split.redis.smembers(:experiments).map {|e| find(e)}.compact
+      Split.redis.smembers(:experiments).map { |e| find(e) }.compact
     end
 
     # Return experiments without a winner (considered "active") first
     def self.all_active_first
-      all.partition{|e| not e.winner}.map{|es| es.sort_by(&:name)}.flatten
+      all.partition { |e| not e.winner }.map { |es| es.sort_by(&:name) }.flatten
     end
 
     def self.find(name)
@@ -19,14 +20,14 @@ module Split
     def self.find_or_initialize(metric_descriptor, control = nil, *alternatives)
       # Check if array is passed to ab_test
       # e.g. ab_test('name', ['Alt 1', 'Alt 2', 'Alt 3'])
-      if control.is_a? Array and alternatives.length.zero?
+      if control.is_a?(Array) && alternatives.length.zero?
         control, alternatives = control.first, control[1..-1]
       end
 
       experiment_name_with_version, goals = normalize_experiment(metric_descriptor)
-      experiment_name = experiment_name_with_version.to_s.split(':')[0]
+      experiment_name = experiment_name_with_version.to_s.split(":")[0]
       Split::Experiment.new(experiment_name,
-          :alternatives => [control].compact + alternatives, :goals => goals)
+          alternatives: [control].compact + alternatives, goals: goals)
     end
 
     def self.find_or_create(metric_descriptor, control = nil, *alternatives)

data/lib/split/extensions/string.rb

@@ -4,7 +4,7 @@ class String
   # Constatntize is often provided by ActiveSupport, but ActiveSupport is not a dependency of Split.
   unless method_defined?(:constantize)
     def constantize
-      names = self.split('::')
+      names = self.split("::")
       names.shift if names.empty? || names.first.empty?
 
       constant = Object

data/lib/split/goals_collection.rb

@@ -2,8 +2,7 @@
 
 module Split
   class GoalsCollection
-
-    def initialize(experiment_name, goals=nil)
+    def initialize(experiment_name, goals = nil)
       @experiment_name = experiment_name
       @goals = goals
     end
@@ -15,10 +14,10 @@ module Split
     def load_from_configuration
       goals = Split.configuration.experiment_for(@experiment_name)[:goals]
 
-      if goals.nil?
-        goals = []
-      else
+      if goals
         goals.flatten
+      else
+        []
       end
     end
 
@@ -29,7 +28,7 @@ module Split
 
     def validate!
       unless @goals.nil? || @goals.kind_of?(Array)
-        raise ArgumentError, 'Goals must be an array'
+        raise ArgumentError, "Goals must be an array"
       end
     end
 
@@ -38,9 +37,8 @@ module Split
     end
 
     private
-
-    def goals_key
-      "#{@experiment_name}:goals"
-    end
+      def goals_key
+        "#{@experiment_name}:goals"
+      end
   end
 end

data/lib/split/helper.rb

@@ -12,9 +12,9 @@ module Split
         alternative = if Split.configuration.enabled && !exclude_visitor?
           experiment.save
           raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
-          trial = Trial.new(:user => ab_user, :experiment => experiment,
-              :override => override_alternative(experiment.name), :exclude => exclude_visitor?,
-              :disabled => split_generically_disabled?)
+          trial = Trial.new(user: ab_user, experiment: experiment,
+              override: override_alternative(experiment.name), exclude: exclude_visitor?,
+              disabled: split_generically_disabled?)
           alt = trial.choose!(self)
           alt ? alt.name : nil
         else
@@ -44,21 +44,21 @@ module Split
       ab_user.delete(experiment.key)
     end
 
-    def finish_experiment(experiment, options = {:reset => true})
+    def finish_experiment(experiment, options = { reset: true })
       return false if active_experiments[experiment.name].nil?
       return true if experiment.has_winner?
       should_reset = experiment.resettable? && options[:reset]
       if ab_user[experiment.finished_key] && !should_reset
-        return true
+        true
       else
         alternative_name = ab_user[experiment.key]
         trial = Trial.new(
-          :user => ab_user, 
-          :experiment => experiment,
-          :alternative => alternative_name,
-          :goals => options[:goals],
-        )      
-        
+          user: ab_user,
+          experiment: experiment,
+          alternative: alternative_name,
+          goals: options[:goals],
+        )
+
         trial.complete!(self)
 
         if should_reset
@@ -69,7 +69,7 @@ module Split
       end
     end
 
-    def ab_finished(metric_descriptor, options = {:reset => true})
+    def ab_finished(metric_descriptor, options = { reset: true })
       return if exclude_visitor? || Split.configuration.disabled?
       metric_descriptor, goals = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
@@ -77,7 +77,7 @@ module Split
       if experiments.any?
         experiments.each do |experiment|
           next if override_present?(experiment.key)
-          finish_experiment(experiment, options.merge(:goals => goals))
+          finish_experiment(experiment, options.merge(goals: goals))
         end
       end
     rescue => e
@@ -95,7 +95,7 @@ module Split
           alternative_name = ab_user[experiment.key]
 
           if alternative_name
-            alternative = experiment.alternatives.find{|alt| alt.name == alternative_name}
+            alternative = experiment.alternatives.find { |alt| alt.name == alternative_name }
             alternative.record_extra_info(key, value) if alternative
           end
         end
@@ -105,7 +105,7 @@ module Split
       Split.configuration.db_failover_on_db_error.call(e)
     end
 
-    def ab_active_experiments()
+    def ab_active_experiments
       ab_user.active_experiments
     rescue => e
       raise unless Split.configuration.db_failover
@@ -127,14 +127,14 @@ module Split
     def override_alternative_by_cookies(experiment_name)
       return unless defined?(request)
 
-      if request.cookies && request.cookies.key?('split_override')
-        experiments = JSON.parse(request.cookies['split_override']) rescue {}
+      if request.cookies && request.cookies.key?("split_override")
+        experiments = JSON.parse(request.cookies["split_override"]) rescue {}
         experiments[experiment_name]
       end
     end
 
     def split_generically_disabled?
-      defined?(params) && params['SPLIT_DISABLE']
+      defined?(params) && params["SPLIT_DISABLE"]
     end
 
     def ab_user
@@ -150,7 +150,7 @@ module Split
     end
 
     def is_preview?
-      defined?(request) && defined?(request.headers) && request.headers['x-purpose'] == 'preview'
+      defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
     end
 
     def is_ignored_ip_address?

data/lib/split/metric.rb

@@ -16,13 +16,13 @@ module Split
     def self.load_from_redis(name)
       metric = Split.redis.hget(:metrics, name)
       if metric
-        experiment_names = metric.split(',')
+        experiment_names = metric.split(",")
 
         experiments = experiment_names.collect do |experiment_name|
           Split::ExperimentCatalog.find(experiment_name)
         end
 
-        Split::Metric.new(:name => name, :experiments => experiments)
+        Split::Metric.new(name: name, experiments: experiments)
       else
         nil
       end
@@ -31,7 +31,7 @@ module Split
     def self.load_from_configuration(name)
       metrics = Split.configuration.metrics
       if metrics && metrics[name]
-        Split::Metric.new(:experiments => metrics[name], :name => name)
+        Split::Metric.new(experiments: metrics[name], name: name)
       else
         nil
       end
@@ -77,7 +77,7 @@ module Split
     end
 
     def save
-      Split.redis.hset(:metrics, name, experiments.map(&:name).join(','))
+      Split.redis.hset(:metrics, name, experiments.map(&:name).join(","))
     end
 
     def complete!
@@ -97,6 +97,5 @@ module Split
       return metric_name, goals
     end
     private_class_method :normalize_metric
-
   end
 end

data/lib/split/persistence/cookie_adapter.rb

@@ -5,7 +5,6 @@ require "json"
 module Split
   module Persistence
     class CookieAdapter
-
       def initialize(context)
         @context = context
         @request, @response = context.request, context.response
@@ -30,50 +29,49 @@ module Split
       end
 
       private
+        def set_cookie(value = {})
+          cookie_key = :split.to_s
+          cookie_value = default_options.merge(value: JSON.generate(value))
+          if action_dispatch?
+            # The "send" is necessary when we call ab_test from the controller
+            # and thus @context is a rails controller, because then "cookies" is
+            # a private method.
+            @context.send(:cookies)[cookie_key] = cookie_value
+          else
+            set_cookie_via_rack(cookie_key, cookie_value)
+          end
+        end
 
-      def set_cookie(value = {})
-        cookie_key = :split.to_s
-        cookie_value = default_options.merge(value: JSON.generate(value))
-        if action_dispatch?
-          # The "send" is necessary when we call ab_test from the controller
-          # and thus @context is a rails controller, because then "cookies" is
-          # a private method.
-          @context.send(:cookies)[cookie_key] = cookie_value
-        else
-          set_cookie_via_rack(cookie_key, cookie_value)
+        def default_options
+          { expires: @expires, path: "/", domain: cookie_domain_config }.compact
         end
-      end
 
-      def default_options
-        { expires: @expires, path: '/', domain: cookie_domain_config }.compact
-      end
+        def set_cookie_via_rack(key, value)
+          delete_cookie_header!(@response.header, key, value)
+          Rack::Utils.set_cookie_header!(@response.header, key, value)
+        end
 
-      def set_cookie_via_rack(key, value)
-        delete_cookie_header!(@response.header, key, value)
-        Rack::Utils.set_cookie_header!(@response.header, key, value)
-      end
+        # Use Rack::Utils#make_delete_cookie_header after Rack 2.0.0
+        def delete_cookie_header!(header, key, value)
+          cookie_header = header["Set-Cookie"]
+          case cookie_header
+          when nil, ""
+            cookies = []
+          when String
+            cookies = cookie_header.split("\n")
+          when Array
+            cookies = cookie_header
+          end
 
-      # Use Rack::Utils#make_delete_cookie_header after Rack 2.0.0
-      def delete_cookie_header!(header, key, value)
-        cookie_header = header['Set-Cookie']
-        case cookie_header
-        when nil, ''
-          cookies = []
-        when String
-          cookies = cookie_header.split("\n")
-        when Array
-          cookies = cookie_header
+          cookies.reject! { |cookie| cookie =~ /\A#{Rack::Utils.escape(key)}=/ }
+          header["Set-Cookie"] = cookies.join("\n")
         end
 
-        cookies.reject! { |cookie| cookie =~ /\A#{Rack::Utils.escape(key)}=/ }
-        header['Set-Cookie'] = cookies.join("\n")
-      end
-
-      def hash
-        @hash ||= begin
-          if cookies = @cookies[:split.to_s]
+        def hash
+          @hash ||= if cookies = @cookies[:split.to_s]
             begin
-              JSON.parse(cookies)
+              parsed = JSON.parse(cookies)
+              parsed.is_a?(Hash) ? parsed : {}
             rescue JSON::ParserError
               {}
             end
@@ -81,19 +79,18 @@ module Split
             {}
           end
         end
-      end
 
-      def cookie_length_config
-        Split.configuration.persistence_cookie_length
-      end
+        def cookie_length_config
+          Split.configuration.persistence_cookie_length
+        end
 
-      def cookie_domain_config
-        Split.configuration.persistence_cookie_domain
-      end
+        def cookie_domain_config
+          Split.configuration.persistence_cookie_domain
+        end
 
-      def action_dispatch?
-        defined?(Rails) && @response.is_a?(ActionDispatch::Response)
-      end
+        def action_dispatch?
+          defined?(Rails) && @response.is_a?(ActionDispatch::Response)
+        end
     end
   end
 end

data/lib/split/persistence/dual_adapter.rb

@@ -3,7 +3,7 @@
 module Split
   module Persistence
     class DualAdapter
-      def self.with_config(options={})
+      def self.with_config(options = {})
         self.config.merge!(options)
         self
       end
@@ -72,14 +72,13 @@ module Split
       end
 
       private
+        def decrement_participation?(old_value, value)
+          !old_value.nil? && !value.nil? && old_value != value
+        end
 
-      def decrement_participation?(old_value, value)
-        !old_value.nil? && !value.nil? && old_value != value
-      end
-
-      def decrement_participation(key, value)
-        Split.redis.hincrby("#{key}:#{value}", 'participant_count', -1)
-      end
+        def decrement_participation(key, value)
+          Split.redis.hincrby("#{key}:#{value}", "participant_count", -1)
+        end
     end
   end
 end

data/lib/split/persistence/redis_adapter.rb

@@ -3,7 +3,7 @@
 module Split
   module Persistence
     class RedisAdapter
-      DEFAULT_CONFIG = {:namespace => 'persistence'}.freeze
+      DEFAULT_CONFIG = { namespace: "persistence" }.freeze
 
       attr_reader :redis_key
 
@@ -44,7 +44,7 @@ module Split
         new(nil, user_id)
       end
 
-      def self.with_config(options={})
+      def self.with_config(options = {})
         self.config.merge!(options)
         self
       end
@@ -56,7 +56,6 @@ module Split
       def self.reset_config!
         @config = DEFAULT_CONFIG.dup
       end
-
     end
   end
 end

data/lib/split/persistence/session_adapter.rb

@@ -3,7 +3,6 @@
 module Split
   module Persistence
     class SessionAdapter
-
       def initialize(context)
         @session = context.session
         @session[:split] ||= {}
@@ -24,7 +23,6 @@ module Split
       def keys
         @session[:split].keys
       end
-
     end
   end
 end

data/lib/split/persistence.rb

@@ -2,10 +2,10 @@
 
 module Split
   module Persistence
-    require 'split/persistence/cookie_adapter'
-    require 'split/persistence/dual_adapter'
-    require 'split/persistence/redis_adapter'
-    require 'split/persistence/session_adapter'
+    require "split/persistence/cookie_adapter"
+    require "split/persistence/dual_adapter"
+    require "split/persistence/redis_adapter"
+    require "split/persistence/session_adapter"
 
     ADAPTERS = {
       cookie: Split::Persistence::CookieAdapter,

data/lib/split/redis_interface.rb

@@ -24,7 +24,6 @@ module Split
     end
 
     private
-
-    attr_accessor :redis
+      attr_accessor :redis
   end
 end

data/lib/split/trial.rb

@@ -24,15 +24,15 @@ module Split
 
     def alternative
       @alternative ||=  if @experiment.has_winner?
-                          @experiment.winner
-                        end
+        @experiment.winner
+      end
     end
 
     def alternative=(alternative)
       @alternative = if alternative.kind_of?(Split::Alternative)
         alternative
       else
-        @experiment.alternatives.find{|a| a.name == alternative }
+        @experiment.alternatives.find { |a| a.name == alternative }
       end
     end
 
@@ -41,7 +41,7 @@ module Split
         if Array(goals).empty?
           alternative.increment_completion
         else
-          Array(goals).each {|g| alternative.increment_completion(g) }
+          Array(goals).each { |g| alternative.increment_completion(g) }
         end
 
         run_callback context, Split.configuration.on_trial_complete
@@ -97,31 +97,30 @@ module Split
     end
 
     private
+      def run_callback(context, callback_name)
+        context.send(callback_name, self) if callback_name && context.respond_to?(callback_name, true)
+      end
 
-    def run_callback(context, callback_name)
-      context.send(callback_name, self) if callback_name && context.respond_to?(callback_name, true)
-    end
-
-    def override_is_alternative?
-      @experiment.alternatives.map(&:name).include?(@options[:override])
-    end
+      def override_is_alternative?
+        @experiment.alternatives.map(&:name).include?(@options[:override])
+      end
 
-    def should_store_alternative?
-      if @options[:override] || @options[:disabled]
-        Split.configuration.store_override
-      else
-        !exclude_user?
+      def should_store_alternative?
+        if @options[:override] || @options[:disabled]
+          Split.configuration.store_override
+        else
+          !exclude_user?
+        end
       end
-    end
 
-    def cleanup_old_versions
-      if @experiment.version > 0
-        @user.cleanup_old_versions!(@experiment)
+      def cleanup_old_versions
+        if @experiment.version > 0
+          @user.cleanup_old_versions!(@experiment)
+        end
       end
-    end
 
-    def exclude_user?
-      @options[:exclude] || @experiment.start_time.nil? || @user.max_experiments_reached?(@experiment.key)
-    end
+      def exclude_user?
+        @options[:exclude] || @experiment.start_time.nil? || @user.max_experiments_reached?(@experiment.key)
+      end
   end
 end

data/lib/split/user.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Split
   class User
@@ -26,10 +26,10 @@ module Split
     end
 
     def max_experiments_reached?(experiment_key)
-      if Split.configuration.allow_multiple_experiments == 'control'
+      if Split.configuration.allow_multiple_experiments == "control"
         experiments = active_experiments
         experiment_key_without_version = key_without_version(experiment_key)
-        count_control = experiments.count {|k, v| k == experiment_key_without_version || v == 'control'}
+        count_control = experiments.count { |k, v| k == experiment_key_without_version || v == "control" }
         experiments.size > count_control
       else
         !Split.configuration.allow_multiple_experiments &&
@@ -65,17 +65,16 @@ module Split
     end
 
     private
+      def keys_without_experiment(keys, experiment_key)
+        keys.reject { |k| k.match(Regexp.new("^#{experiment_key}(:finished)?$")) }
+      end
 
-    def keys_without_experiment(keys, experiment_key)
-      keys.reject { |k| k.match(Regexp.new("^#{experiment_key}(:finished)?$")) }
-    end
-
-    def keys_without_finished(keys)
-      keys.reject { |k| k.include?(":finished") }
-    end
+      def keys_without_finished(keys)
+        keys.reject { |k| k.include?(":finished") }
+      end
 
-    def key_without_version(key)
-      key.split(/\:\d(?!\:)/)[0]
-    end
+      def key_without_version(key)
+        key.split(/\:\d(?!\:)/)[0]
+      end
   end
 end

data/lib/split/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Split
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 end

data/lib/split/zscore.rb

@@ -2,7 +2,6 @@
 
 module Split
   class Zscore
-
     include Math
 
     def self.calculate(p1, n1, p2, n2)
@@ -51,8 +50,7 @@ module Split
       # Calculate z-score
       z_score = (p_1 - p_2)/(se)
 
-      return z_score
-
+      z_score
     end
   end
 end