split 4.0.1 → 4.0.3

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
 
@@ -27,7 +27,7 @@ module Split
       end
 
       def []=(field, value)
-        Split.redis.hset(redis_key, field, value)
+        Split.redis.hset(redis_key, field, value.to_s)
         expire_seconds = self.class.config[:expire_seconds]
         Split.redis.expire(redis_key, expire_seconds) if expire_seconds
       end
@@ -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

@@ -11,6 +11,7 @@ module Split
       if list_values.length > 0
         redis.multi do |multi|
           tmp_list = "#{list_name}_tmp"
+          tmp_list += redis_namespace_used? ? "{#{Split.redis.namespace}:#{list_name}}" : "{#{list_name}}"
           multi.rpush(tmp_list, list_values)
           multi.rename(tmp_list, list_name)
         end
@@ -20,11 +21,16 @@ module Split
     end
 
     def add_to_set(set_name, value)
+      return redis.sadd?(set_name, value) if redis.respond_to?(:sadd?)
+
       redis.sadd(set_name, value)
     end
 
     private
+      attr_accessor :redis
 
-    attr_accessor :redis
+      def redis_namespace_used?
+        Redis.const_defined?("Namespace") && Split.redis.is_a?(Redis::Namespace)
+      end
   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.3"
 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

data/lib/split.rb

@@ -1,29 +1,30 @@
 # frozen_string_literal: true
 
-require 'redis'
+require "redis"
 
-require 'split/algorithms/block_randomization'
-require 'split/algorithms/weighted_sample'
-require 'split/algorithms/whiplash'
-require 'split/alternative'
-require 'split/cache'
-require 'split/configuration'
-require 'split/encapsulated_helper'
-require 'split/exceptions'
-require 'split/experiment'
-require 'split/experiment_catalog'
-require 'split/extensions/string'
-require 'split/goals_collection'
-require 'split/helper'
-require 'split/combined_experiments_helper'
-require 'split/metric'
-require 'split/persistence'
-require 'split/redis_interface'
-require 'split/trial'
-require 'split/user'
-require 'split/version'
-require 'split/zscore'
-require 'split/engine' if defined?(Rails)
+require "split/algorithms"
+require "split/algorithms/block_randomization"
+require "split/algorithms/weighted_sample"
+require "split/algorithms/whiplash"
+require "split/alternative"
+require "split/cache"
+require "split/configuration"
+require "split/encapsulated_helper"
+require "split/exceptions"
+require "split/experiment"
+require "split/experiment_catalog"
+require "split/extensions/string"
+require "split/goals_collection"
+require "split/helper"
+require "split/combined_experiments_helper"
+require "split/metric"
+require "split/persistence"
+require "split/redis_interface"
+require "split/trial"
+require "split/user"
+require "split/version"
+require "split/zscore"
+require "split/engine" if defined?(Rails)
 
 module Split
   extend self
@@ -75,8 +76,8 @@ end
 # Check to see if being run in a Rails application.  If so, wait until before_initialize to run configuration so Gems that create ENV variables have the chance to initialize first.
 if defined?(::Rails)
   class Split::Railtie < Rails::Railtie
-    config.before_initialize { Split.configure {} }
+    config.before_initialize { Split.configure { } }
   end
 else
-  Split.configure {}
+  Split.configure { }
 end

data/spec/algorithms/block_randomization_spec.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Split::Algorithms::BlockRandomization do
-
-  let(:experiment) { Split::Experiment.new 'experiment' }
-  let(:alternative_A) { Split::Alternative.new 'A', 'experiment' }
-  let(:alternative_B) { Split::Alternative.new 'B', 'experiment' }
-  let(:alternative_C) { Split::Alternative.new 'C', 'experiment' }
+  let(:experiment) { Split::Experiment.new "experiment" }
+  let(:alternative_A) { Split::Alternative.new "A", "experiment" }
+  let(:alternative_B) { Split::Alternative.new "B", "experiment" }
+  let(:alternative_C) { Split::Alternative.new "C", "experiment" }
 
   before :each do
     allow(experiment).to receive(:alternatives) { [alternative_A, alternative_B, alternative_C] }

data/spec/algorithms/weighted_sample_spec.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 describe Split::Algorithms::WeightedSample do
   it "should return an alternative" do
-    experiment = Split::ExperimentCatalog.find_or_create('link_color', {'blue' => 100}, {'red' => 0 })
+    experiment = Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 100 }, { "red" => 0 })
     expect(Split::Algorithms::WeightedSample.choose_alternative(experiment).class).to eq(Split::Alternative)
   end
 
   it "should always return a heavily weighted option" do
-    experiment = Split::ExperimentCatalog.find_or_create('link_color', {'blue' => 100}, {'red' => 0 })
-    expect(Split::Algorithms::WeightedSample.choose_alternative(experiment).name).to eq('blue')
+    experiment = Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 100 }, { "red" => 0 })
+    expect(Split::Algorithms::WeightedSample.choose_alternative(experiment).name).to eq("blue")
   end
 
   it "should return one of the results" do
-    experiment = Split::ExperimentCatalog.find_or_create('link_color', {'blue' => 1}, {'red' => 1 })
-    expect(['red', 'blue']).to include Split::Algorithms::WeightedSample.choose_alternative(experiment).name
+    experiment = Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 1 })
+    expect(["red", "blue"]).to include Split::Algorithms::WeightedSample.choose_alternative(experiment).name
   end
 end

data/spec/algorithms/whiplash_spec.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 describe Split::Algorithms::Whiplash do
-
   it "should return an algorithm" do
-    experiment = Split::ExperimentCatalog.find_or_create('link_color', {'blue' => 1}, {'red' => 1 })
+    experiment = Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 1 })
     expect(Split::Algorithms::Whiplash.choose_alternative(experiment).class).to eq(Split::Alternative)
   end
 
   it "should return one of the results" do
-    experiment = Split::ExperimentCatalog.find_or_create('link_color', {'blue' => 1}, {'red' => 1 })
-    expect(['red', 'blue']).to include Split::Algorithms::Whiplash.choose_alternative(experiment).name
+    experiment = Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 1 })
+    expect(["red", "blue"]).to include Split::Algorithms::Whiplash.choose_alternative(experiment).name
   end
 
   it "should guess floats" do
@@ -20,5 +20,4 @@ describe Split::Algorithms::Whiplash do
     expect(Split::Algorithms::Whiplash.send(:arm_guess, 1000, 5).class).to eq(Float)
     expect(Split::Algorithms::Whiplash.send(:arm_guess, 10, -2).class).to eq(Float)
   end
-
 end