split 3.3.0 → 3.4.0

data/lib/split/experiment.rb

@@ -2,13 +2,13 @@
 module Split
   class Experiment
     attr_accessor :name
-    attr_writer :algorithm
-    attr_accessor :resettable
     attr_accessor :goals
-    attr_accessor :alternatives
     attr_accessor :alternative_probabilities
     attr_accessor :metadata
 
+    attr_reader :alternatives
+    attr_reader :resettable
+
     DEFAULT_OPTIONS = {
       :resettable => true
     }
@@ -25,7 +25,7 @@ module Split
           alternatives: load_alternatives_from_configuration,
           goals: Split::GoalsCollection.new(@name).load_from_configuration,
           metadata: load_metadata_from_configuration,
-          resettable: exp_config[:resettable],
+          resettable: exp_config.fetch(:resettable, true),
           algorithm: exp_config[:algorithm]
         }
       else
@@ -62,7 +62,7 @@ module Split
           alts = load_alternatives_from_configuration
           options[:goals] = Split::GoalsCollection.new(@name).load_from_configuration
           options[:metadata] = load_metadata_from_configuration
-          options[:resettable] = exp_config[:resettable]
+          options[:resettable] = exp_config.fetch(:resettable, true)
           options[:algorithm] = exp_config[:algorithm]
         end
       end
@@ -81,12 +81,12 @@ module Split
 
       if new_record?
         start unless Split.configuration.start_manually
+        persist_experiment_configuration
       elsif experiment_configuration_has_changed?
         reset unless Split.configuration.reset_manually
+        persist_experiment_configuration
       end
 
-      persist_experiment_configuration if new_record? || experiment_configuration_has_changed?
-
       redis.hset(experiment_config_key, :resettable, resettable)
       redis.hset(experiment_config_key, :algorithm, algorithm.to_s)
       self
@@ -144,11 +144,13 @@ module Split
     end
 
     def has_winner?
-      !winner.nil?
+      return @has_winner if defined? @has_winner
+      @has_winner = !winner.nil?
     end
 
     def winner=(winner_name)
       redis.hset(:experiment_winner, name, winner_name.to_s)
+      @has_winner = true
     end
 
     def participant_count
@@ -161,6 +163,7 @@ module Split
 
     def reset_winner
       redis.hdel(:experiment_winner, name)
+      @has_winner = false
     end
 
     def start
@@ -420,14 +423,22 @@ module Split
     end
 
     def load_alternatives_from_redis
-      case redis.type(@name)
-      when 'set' # convert legacy sets to lists
-        alts = redis.smembers(@name)
-        redis.del(@name)
-        alts.reverse.each {|a| redis.lpush(@name, a) }
-        redis.lrange(@name, 0, -1)
-      else
-        redis.lrange(@name, 0, -1)
+      alternatives = case redis.type(@name)
+                     when 'set' # convert legacy sets to lists
+                       alts = redis.smembers(@name)
+                       redis.del(@name)
+                       alts.reverse.each {|a| redis.lpush(@name, a) }
+                       redis.lrange(@name, 0, -1)
+                     else
+                       redis.lrange(@name, 0, -1)
+                     end
+      alternatives.map do |alt|
+        alt = begin
+                JSON.parse(alt)
+              rescue
+                alt
+              end
+        Split::Alternative.new(alt, @name)
       end
     end
 
@@ -443,7 +454,7 @@ module Split
 
     def persist_experiment_configuration
       redis_interface.add_to_set(:experiments, name)
-      redis_interface.persist_list(name, @alternatives.map(&:name))
+      redis_interface.persist_list(name, @alternatives.map{|alt| {alt.name => alt.weight}.to_json})
       goals_collection.save
       redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
     end
@@ -459,7 +470,7 @@ module Split
       existing_alternatives = load_alternatives_from_redis
       existing_goals = Split::GoalsCollection.new(@name).load_from_redis
       existing_metadata = load_metadata_from_redis
-      existing_alternatives != @alternatives.map(&:name) ||
+      existing_alternatives.map(&:to_s) != @alternatives.map(&:to_s) ||
         existing_goals != @goals ||
         existing_metadata != @metadata
     end

data/lib/split/goals_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Split
   class GoalsCollection
 

data/lib/split/helper.rb

@@ -8,7 +8,7 @@ module Split
     def ab_test(metric_descriptor, control = nil, *alternatives)
       begin
         experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
-        alternative = if Split.configuration.enabled
+        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,
@@ -44,6 +44,7 @@ module Split
     end
 
     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
@@ -79,7 +80,7 @@ module Split
 
     def ab_record_extra_info(metric_descriptor, key, value = 1)
       return if exclude_visitor? || Split.configuration.disabled?
-      metric_descriptor, goals = normalize_metric(metric_descriptor)
+      metric_descriptor, _ = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
 
       if experiments.any?
@@ -122,7 +123,7 @@ module Split
     end
 
     def exclude_visitor?
-      instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?
+      defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
     end
 
     def is_robot?

data/lib/split/persistence/dual_adapter.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 module Split
   module Persistence
     class DualAdapter
-      extend Forwardable
-      def_delegators :@adapter, :keys, :[], :[]=, :delete
+      def self.with_config(options={})
+        self.config.merge!(options)
+        self
+      end
+
+      def self.config
+        @config ||= {}
+      end
 
       def initialize(context)
         if logged_in = self.class.config[:logged_in]
@@ -22,22 +26,60 @@ module Split
           raise "Please configure :logged_out_adapter"
         end
 
-        if logged_in.call(context)
-          @adapter = logged_in_adapter.new(context)
+        @fallback_to_logged_out_adapter =
+          self.class.config[:fallback_to_logged_out_adapter] || false
+        @logged_in = logged_in.call(context)
+        @logged_in_adapter = logged_in_adapter.new(context)
+        @logged_out_adapter = logged_out_adapter.new(context)
+        @active_adapter = @logged_in ? @logged_in_adapter : @logged_out_adapter
+      end
+
+      def keys
+        if @fallback_to_logged_out_adapter
+          (@logged_in_adapter.keys + @logged_out_adapter.keys).uniq
         else
-          @adapter = logged_out_adapter.new(context)
+          @active_adapter.keys
         end
       end
 
-      def self.with_config(options={})
-        self.config.merge!(options)
-        self
+      def [](key)
+        if @fallback_to_logged_out_adapter
+          @logged_in && @logged_in_adapter[key] || @logged_out_adapter[key]
+        else
+          @active_adapter[key]
+        end
       end
 
-      def self.config
-        @config ||= {}
+      def []=(key, value)
+        if @fallback_to_logged_out_adapter
+          @logged_in_adapter[key] = value if @logged_in
+          old_value = @logged_out_adapter[key]
+          @logged_out_adapter[key] = value
+
+          decrement_participation(key, old_value) if decrement_participation?(old_value, value)
+        else
+          @active_adapter[key] = value
+        end
+      end
+
+      def delete(key)
+        if @fallback_to_logged_out_adapter
+          @logged_in_adapter.delete(key)
+          @logged_out_adapter.delete(key)
+        else
+          @active_adapter.delete(key)
+        end
       end
 
+      private
+
+      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
     end
   end
 end

data/lib/split/redis_interface.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Split
   # Simplifies the interface to Redis.
   class RedisInterface

data/lib/split/trial.rb

@@ -2,7 +2,7 @@
 module Split
   class Trial
     attr_accessor :experiment
-    attr_accessor :metadata
+    attr_writer :metadata
 
     def initialize(attrs = {})
       self.experiment   = attrs.delete(:experiment)
@@ -68,10 +68,8 @@ module Split
         if exclude_user?
           self.alternative = @experiment.control
         else
-          value = @user[@experiment.key]
-          if value
-            self.alternative = value
-          else
+          self.alternative = @user[@experiment.key]
+          if alternative.nil?
             self.alternative = @experiment.next_alternative
 
             # Increment the number of participants since we are actually choosing a new alternative
@@ -82,7 +80,7 @@ module Split
         end
       end
 
-      @user[@experiment.key] = alternative.name if should_store_alternative?
+      @user[@experiment.key] = alternative.name if !@experiment.has_winner? && should_store_alternative?
       @alternative_choosen = true
       run_callback context, Split.configuration.on_trial unless @options[:disabled] || Split.configuration.disabled?
       alternative

data/lib/split/user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 
 module Split
@@ -8,9 +9,11 @@ module Split
 
     def initialize(context, adapter=nil)
       @user = adapter || Split::Persistence.adapter.new(context)
+      @cleaned_up = false
     end
 
     def cleanup_old_experiments!
+      return if @cleaned_up
       keys_without_finished(user.keys).each do |key|
         experiment = ExperimentCatalog.find key_without_version(key)
         if experiment.nil? || experiment.has_winner? || experiment.start_time.nil?
@@ -18,6 +21,7 @@ module Split
           user.delete Experiment.finished_key(key)
         end
       end
+      @cleaned_up = true
     end
 
     def max_experiments_reached?(experiment_key)
@@ -38,7 +42,7 @@ module Split
 
     def active_experiments
       experiment_pairs = {}
-      user.keys.each do |key|
+      keys_without_finished(user.keys).each do |key|
         Metric.possible_experiments(key_without_version(key)).each do |experiment|
           if !experiment.has_winner?
             experiment_pairs[key_without_version(key)] = user[key]

data/lib/split/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Split
   MAJOR   = 3
-  MINOR   = 3
+  MINOR   = 4
   PATCH   = 0
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/lib/split.rb

@@ -66,4 +66,11 @@ module Split
   end
 end
 
-Split.configure {}
+# 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 Railtie < Rails::Railtie
+    config.before_initialize { Split.configure {} }
+  end
+else
+  Split.configure {}
+end

data/spec/dashboard/pagination_helpers_spec.rb

@@ -10,7 +10,9 @@ describe Split::DashboardPaginationHelpers do
     context 'when params empty' do
       let(:params) { Hash[] }
 
-      it 'returns 10' do
+      it 'returns the default (10)' do
+        default_per_page = Split.configuration.dashboard_pagination_default_per_page
+        expect(pagination_per).to eql default_per_page
         expect(pagination_per).to eql 10
       end
     end

data/spec/dashboard_helpers_spec.rb

@@ -27,11 +27,11 @@ describe Split::DashboardHelpers do
 
     describe '#round' do
       it 'can round number strings' do
-        expect(round('3.1415')).to eq BigDecimal.new('3.14')
+        expect(round('3.1415')).to eq BigDecimal('3.14')
       end
 
       it 'can round number strings for precsion' do
-        expect(round('3.1415', 1)).to eq BigDecimal.new('3.1')
+        expect(round('3.1415', 1)).to eq BigDecimal('3.1')
       end
 
       it 'can handle invalid number strings' do

data/spec/dashboard_spec.rb

@@ -29,6 +29,10 @@ describe Split::Dashboard do
   let(:red_link) { link("red") }
   let(:blue_link) { link("blue") }
 
+  before(:each) do
+    Split.configuration.beta_probability_simulations = 1
+  end
+
   it "should respond to /" do
     get '/'
     expect(last_response).to be_ok
@@ -74,17 +78,39 @@ describe Split::Dashboard do
   end
 
   describe "force alternative" do
-    let!(:user) do
-      Split::User.new(@app, { experiment.name => 'a' })
-    end
+    context "initial version" do
+      let!(:user) do
+        Split::User.new(@app, { experiment.name => 'red' })
+      end
 
-    before do
-      allow(Split::User).to receive(:new).and_return(user)
+      before do
+        allow(Split::User).to receive(:new).and_return(user)
+      end
+
+      it "should set current user's alternative" do
+        blue_link.participant_count = 7
+        post "/force_alternative?experiment=#{experiment.name}", alternative: "blue"
+        expect(user[experiment.key]).to eq("blue")
+        expect(blue_link.participant_count).to eq(8)
+      end
     end
 
-    it "should set current user's alternative" do
-      post "/force_alternative?experiment=#{experiment.name}", alternative: "b"
-      expect(user[experiment.name]).to eq("b")
+    context "incremented version" do
+      let!(:user) do
+        experiment.increment_version
+        Split::User.new(@app, { "#{experiment.name}:#{experiment.version}" => 'red' })
+      end
+
+      before do
+        allow(Split::User).to receive(:new).and_return(user)
+      end
+
+      it "should set current user's alternative" do
+        blue_link.participant_count = 7
+        post "/force_alternative?experiment=#{experiment.name}", alternative: "blue"
+        expect(user[experiment.key]).to eq("blue")
+        expect(blue_link.participant_count).to eq(8)
+      end
     end
   end
 
@@ -120,7 +146,7 @@ describe Split::Dashboard do
     it "removes winner" do
       post "/reopen?experiment=#{experiment.name}"
 
-      expect(experiment).to_not have_winner
+      expect(Split::ExperimentCatalog.find(experiment.name)).to_not have_winner
     end
 
     it "keeps existing stats" do
@@ -167,19 +193,14 @@ describe Split::Dashboard do
   end
 
   it "should display the start date" do
-    experiment_start_time = Time.parse('2011-07-07')
-    expect(Time).to receive(:now).at_least(:once).and_return(experiment_start_time)
-    experiment
+    experiment.start
 
     get '/'
 
-    expect(last_response.body).to include('<small>2011-07-07</small>')
+    expect(last_response.body).to include("<small>#{experiment.start_time.strftime('%Y-%m-%d')}</small>")
   end
 
   it "should handle experiments without a start date" do
-    experiment_start_time = Time.parse('2011-07-07')
-    expect(Time).to receive(:now).at_least(:once).and_return(experiment_start_time)
-
     Split.redis.hdel(:experiment_start_times, experiment.name)
 
     get '/'

data/spec/encapsulated_helper_spec.rb

@@ -33,7 +33,7 @@ describe Split::EncapsulatedHelper do
             static <%= alt %>
           <% end %>
         ERB
-        expect(template.result(binding)).to match /foo  static \d/
+        expect(template.result(binding)).to match(/foo  static \d/)
       end
 
     end

data/spec/experiment_spec.rb

@@ -35,6 +35,12 @@ describe Split::Experiment do
       expect(experiment.resettable).to be_truthy
     end
 
+    it "should be resettable when loading from configuration" do
+      allow(Split.configuration).to receive(:experiment_for).with('some_experiment') { { alternatives: %w(a b) } }
+
+      expect(Split::Experiment.new('some_experiment')).to be_resettable
+    end
+
     it "should save to redis" do
       experiment.save
       expect(Split.redis.exists('basket_text')).to be true
@@ -86,7 +92,7 @@ describe Split::Experiment do
       experiment.save
       experiment.save
       expect(Split.redis.exists('basket_text')).to be true
-      expect(Split.redis.lrange('basket_text', 0, -1)).to eq(['Basket', "Cart"])
+      expect(Split.redis.lrange('basket_text', 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
     end
 
     describe 'new record?' do
@@ -213,12 +219,41 @@ describe Split::Experiment do
     it "should have no winner initially" do
       expect(experiment.winner).to be_nil
     end
+  end
 
+  describe 'winner=' do
     it "should allow you to specify a winner" do
       experiment.save
       experiment.winner = 'red'
       expect(experiment.winner.name).to eq('red')
     end
+
+    context 'when has_winner state is memoized' do
+      before { expect(experiment).to_not have_winner }
+
+      it 'should keep has_winner state consistent' do
+        experiment.winner = 'red'
+        expect(experiment).to have_winner
+      end
+    end
+  end
+
+  describe 'reset_winner' do
+    before { experiment.winner = 'green' }
+
+    it 'should reset the winner' do
+      experiment.reset_winner
+      expect(experiment.winner).to be_nil
+    end
+
+    context 'when has_winner state is memoized' do
+      before { expect(experiment).to have_winner }
+
+      it 'should keep has_winner state consistent' do
+        experiment.reset_winner
+        expect(experiment).to_not have_winner
+      end
+    end
   end
 
   describe 'has_winner?' do
@@ -235,6 +270,12 @@ describe Split::Experiment do
         expect(experiment).to_not have_winner
       end
     end
+
+    it 'memoizes has_winner state' do
+      expect(experiment).to receive(:winner).once
+      expect(experiment).to_not have_winner
+      expect(experiment).to_not have_winner
+    end
   end
 
   describe 'reset' do
@@ -414,9 +455,7 @@ describe Split::Experiment do
     }
 
     context "saving experiment" do
-      def same_but_different_goals
-        Split::ExperimentCatalog.find_or_create({'link_color' => ["purchase", "refund"]}, 'blue', 'red', 'green')
-      end
+      let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({'link_color' => ["purchase", "refund"]}, 'blue', 'red', 'green') }
 
       before { experiment.save }
 
@@ -425,7 +464,7 @@ describe Split::Experiment do
       end
 
       it "should reset an experiment if it is loaded with different goals" do
-        same_experiment = same_but_different_goals
+        same_but_different_goals
         expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
       end