split 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaed323e2d2459412259d82d76e4000c299c1db6
-  data.tar.gz: 54e05592a68ed6285e0ba613dadac52ed79bf23e
+  metadata.gz: 86dd69d253b8dd5ddb9296729f89a04d98a482d4
+  data.tar.gz: 561287a2dfc015d8ec5b1751c78ef7852b626edb
 SHA512:
-  metadata.gz: a981adeb6a103db7766be39180bd353a31f642c659e4044071fbe8a094f4e36558705b477dd8a4b6eff893b11823209a241c24d5acc8d339201108abb33bf4b0
-  data.tar.gz: 7ca7d69fa815e194f9273974df0da3c556cb186f01720e8b342edd9482814725e4478006581b1878b1fb36f9fa53ed6f900176d3809101785d03bbac80e52f43
+  metadata.gz: c34f1b8d4893ada8c64a27deed0536aaa0f0922531abe9180d6c3eb96742dea570b8dedeef341961184b9cd2bc9ef3d0ee439cd18f945d371069006abee3a530
+  data.tar.gz: 7b63e41dc1d105ce2e1e00fd1488d7d149db7b44f5df6b4de6a835ed17532d8511593829babedab310b5258cf7861840a80e0d9bc50c333f04ce91acf997712d

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.3.1
 
 gemfile:
   - gemfiles/4.1.gemfile

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.4.3 (April 28th, 2016)
+
+Features:
+
+- add on_trial callback whenever a trial is started (@mtyeh411, #375)
+
+Bugfixes:
+
+- Allow algorithm configuration at experiment level (@007sumit, #376)
+
+Misc:
+
+- only choose override if it exists as valid alternative (@spheric, #377)
+
 ## 1.4.2 (April 25th, 2016)
 
 Misc:

data/README.md

@@ -242,7 +242,8 @@ For example:
 
 ``` ruby
 Split.configure do |config|
-  config.on_trial_choose   = :log_trial_choose
+  config.on_trial  = :log_trial # run on every trial
+  config.on_trial_choose   = :log_trial_choose # run on trials with new users only
   config.on_trial_complete = :log_trial_complete
 end
 ```
@@ -251,11 +252,16 @@ Set these attributes to a method name available in the same context as the
 `ab_test` method. These methods should accept one argument, a `Trial` instance.
 
 ``` ruby
-def log_trial_choose(trial)
+def log_trial(trial)
   logger.info "experiment=%s alternative=%s user=%s" %
     [ trial.experiment.name, trial.alternative, current_user.id ]
 end
 
+def log_trial_choose(trial)
+  logger.info "[new user] experiment=%s alternative=%s user=%s" %
+    [ trial.experiment.name, trial.alternative, current_user.id ]
+end
+
 def log_trial_complete(trial)
   logger.info "experiment=%s alternative=%s user=%s complete=true" %
     [ trial.experiment.name, trial.alternative, current_user.id ]

data/lib/split/configuration.rb

@@ -15,6 +15,7 @@ module Split
     attr_accessor :algorithm
     attr_accessor :store_override
     attr_accessor :start_manually
+    attr_accessor :on_trial
     attr_accessor :on_trial_choose
     attr_accessor :on_trial_complete
     attr_accessor :on_experiment_reset
@@ -150,6 +151,10 @@ module Split
             experiment_config[experiment_name.to_sym][:metadata] = metadata
           end
 
+          if algorithm = value_for(settings, :algorithm)
+            experiment_config[experiment_name.to_sym][:algorithm] = algorithm
+          end
+
           if (resettable = value_for(settings, :resettable)) != nil
             experiment_config[experiment_name.to_sym][:resettable] = resettable
           end

data/lib/split/trial.rb

@@ -41,8 +41,7 @@ module Split
           Array(goals).each {|g| alternative.increment_completion(g) }
         end
 
-        context.send(Split.configuration.on_trial_complete, self) \
-            if Split.configuration.on_trial_complete && context
+        run_callback context, Split.configuration.on_trial_complete
       end
     end
 
@@ -54,7 +53,7 @@ module Split
       # Only run the process once
       return alternative if @alternative_choosen
 
-      if @options[:override]
+      if override_is_alternative?
         self.alternative = @options[:override]
       elsif @options[:disabled] || Split.configuration.disabled?
         self.alternative = @experiment.control
@@ -73,19 +72,26 @@ module Split
           # Increment the number of participants since we are actually choosing a new alternative
           self.alternative.increment_participation
 
-          # Run the post-choosing hook on the context
-          context.send(Split.configuration.on_trial_choose, self) \
-              if Split.configuration.on_trial_choose && context
+          run_callback context, Split.configuration.on_trial_choose
         end
       end
 
       @user[@experiment.key] = alternative.name if should_store_alternative?
       @alternative_choosen = true
+      run_callback context, Split.configuration.on_trial unless @options[:disabled] || Split.configuration.disabled?
       alternative
     end
 
     private
 
+    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 should_store_alternative?
       if @options[:override] || @options[:disabled]
         Split.configuration.store_override

data/lib/split/version.rb

@@ -2,6 +2,6 @@
 module Split
   MAJOR   = 1
   MINOR   = 4
-  PATCH   = 2
+  PATCH   = 3
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/trial_spec.rb

@@ -4,8 +4,9 @@ require 'split/trial'
 
 describe Split::Trial do
   let(:user) { mock_user }
+  let(:alternatives) { ['basket', 'cart'] }
   let(:experiment) do
-    Split::Experiment.new('basket_text', :alternatives => ['basket', 'cart']).save
+    Split::Experiment.new('basket_text', :alternatives => alternatives).save
   end
 
   it "should be initializeable" do
@@ -19,7 +20,7 @@ describe Split::Trial do
   describe "alternative" do
     it "should use the alternative if specified" do
       alternative = double('alternative', :kind_of? => Split::Alternative)
-      trial = Split::Trial.new(:experiment => experiment = double('experiment'),
+      trial = Split::Trial.new(:experiment => double('experiment'),
           :alternative => alternative, :user => user)
       expect(trial).not_to receive(:choose)
       expect(trial.alternative).to eq(alternative)
@@ -35,7 +36,6 @@ describe Split::Trial do
   end
 
   describe "metadata" do
-    let(:alternatives) { ['basket', 'cart'] }
     let(:metadata) { Hash[alternatives.map { |k| [k, "Metadata for #{k}"] }] }
     let(:experiment) do
       Split::Experiment.new('basket_text', :alternatives => alternatives, :metadata => metadata).save
@@ -51,50 +51,102 @@ describe Split::Trial do
       trial = Split::Trial.new(:experiment => experiment, :user => user)
       trial.choose!
       expect(trial.metadata).to eq(metadata[trial.alternative.name])
-      expect(trial.metadata).to match /#{trial.alternative.name}/
+      expect(trial.metadata).to match(/#{trial.alternative.name}/)
     end
   end
 
   describe "#choose!" do
+    let(:context) { double(on_trial_callback: 'test callback') }
+    let(:trial) do
+      Split::Trial.new(:user => user, :experiment => experiment)
+    end
+
+    shared_examples_for 'a trial with callbacks' do
+      it 'does not run if on_trial callback is not respondable' do
+        Split.configuration.on_trial = :foo
+        allow(context).to receive(:respond_to?).with(:foo, true).and_return false
+        expect(context).to_not receive(:foo)
+        trial.choose! context
+      end
+      it 'runs on_trial callback' do
+        Split.configuration.on_trial = :on_trial_callback
+        expect(context).to receive(:on_trial_callback)
+        trial.choose! context
+      end
+      it 'does not run nil on_trial callback' do
+        Split.configuration.on_trial = nil
+        expect(context).not_to receive(:on_trial_callback)
+        trial.choose! context
+      end
+    end
+
     def expect_alternative(trial, alternative_name)
       3.times do
-        trial.choose!
-        expect(trial.alternative.name).to eq(alternative_name)
+        trial.choose! context
+        expect(alternative_name).to include(trial.alternative.name)
       end
     end
 
     context "when override is present" do
+      let(:override) { 'cart' }
+      let(:trial) do
+        Split::Trial.new(:user => user, :experiment => experiment, :override => override)
+      end
+
+      it_behaves_like 'a trial with callbacks'
+
       it "picks the override" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'cart')
         expect(experiment).to_not receive(:next_alternative)
+        expect_alternative(trial, override)
+      end
 
-        expect_alternative(trial, 'cart')
+      context "when alternative doesn't exist" do
+        let(:override) { nil }
+        it 'falls back on next_alternative' do
+          expect(experiment).to receive(:next_alternative).and_call_original
+          expect_alternative(trial, alternatives)
+        end
       end
     end
 
     context "when disabled option is true" do
-      it "picks the control" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+      let(:trial) do
+        Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+      end
+
+      it "picks the control", :aggregate_failures do
+        Split.configuration.on_trial = :on_trial_callback
         expect(experiment).to_not receive(:next_alternative)
 
+        expect(context).not_to receive(:on_trial_callback)
+
         expect_alternative(trial, 'basket')
+        Split.configuration.on_trial = nil
       end
     end
 
     context "when Split is globally disabled" do
-      it "picks the control" do
+      it "picks the control and does not run on_trial callbacks", :aggregate_failures do
         Split.configuration.enabled = false
-        trial = Split::Trial.new(:user => user, :experiment => experiment)
-        expect(experiment).to_not receive(:next_alternative)
+        Split.configuration.on_trial = :on_trial_callback
 
+        expect(experiment).to_not receive(:next_alternative)
+        expect(context).not_to receive(:on_trial_callback)
         expect_alternative(trial, 'basket')
+
         Split.configuration.enabled = true
+        Split.configuration.on_trial = nil
       end
     end
 
     context "when experiment has winner" do
+      let(:trial) do
+        Split::Trial.new(:user => user, :experiment => experiment)
+      end
+
+      it_behaves_like 'a trial with callbacks'
+
       it "picks the winner" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment)
         experiment.winner = 'cart'
         expect(experiment).to_not receive(:next_alternative)
 
@@ -103,18 +155,23 @@ describe Split::Trial do
     end
 
     context "when exclude is true" do
+      let(:trial) do
+        Split::Trial.new(:user => user, :experiment => experiment, :exclude => true)
+      end
+
+      it_behaves_like 'a trial with callbacks'
+
       it "picks the control" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :exclude => true)
         expect(experiment).to_not receive(:next_alternative)
-
         expect_alternative(trial, 'basket')
       end
     end
 
     context "when user is already participating" do
+      it_behaves_like 'a trial with callbacks'
+
       it "picks the same alternative" do
         user[experiment.key] = 'basket'
-        trial = Split::Trial.new(:user => user, :experiment => experiment)
         expect(experiment).to_not receive(:next_alternative)
 
         expect_alternative(trial, 'basket')
@@ -122,95 +179,99 @@ describe Split::Trial do
     end
 
     context "when user is a new participant" do
-      it "picks a new alternative" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment)
+      it "picks a new alternative and runs on_trial_choose callback", :aggregate_failures do
+        Split.configuration.on_trial_choose = :on_trial_choose_callback
+
         expect(experiment).to receive(:next_alternative).and_call_original
+        expect(context).to receive(:on_trial_choose_callback)
+
+        trial.choose! context
 
-        trial.choose!
         expect(trial.alternative.name).to_not be_empty
+        Split.configuration.on_trial_choose = nil
       end
     end
+  end
 
-    describe "#complete!" do
-      let(:trial) { Split::Trial.new(:user => user, :experiment => experiment) }
-      context 'when there are no goals' do
-        it 'should complete the trial' do
+  describe "#complete!" do
+    let(:trial) { Split::Trial.new(:user => user, :experiment => experiment) }
+    context 'when there are no goals' do
+      it 'should complete the trial' do
+        trial.choose!
+        old_completed_count = trial.alternative.completed_count
+        trial.complete!
+        expect(trial.alternative.completed_count).to be(old_completed_count+1)
+      end
+    end
+
+    context 'when there are many goals' do
+      let(:goals) { ['first', 'second'] }
+      let(:trial) { Split::Trial.new(:user => user, :experiment => experiment, :goals => goals) }
+      shared_examples_for "goal completion" do
+        it 'should not complete the trial' do
           trial.choose!
           old_completed_count = trial.alternative.completed_count
-          trial.complete!
-          expect(trial.alternative.completed_count).to be(old_completed_count+1)
+          trial.complete!(goal)
+          expect(trial.alternative.completed_count).to_not be(old_completed_count+1)
         end
       end
 
-      context 'when there are many goals' do
-        let(:goals) { ['first', 'second'] }
-        let(:trial) { Split::Trial.new(:user => user, :experiment => experiment, :goals => goals) }
-        shared_examples_for "goal completion" do
-          it 'should not complete the trial' do
-            trial.choose!
-            old_completed_count = trial.alternative.completed_count
-            trial.complete!(goal)
-            expect(trial.alternative.completed_count).to_not be(old_completed_count+1)
-          end
-        end
-
-        describe 'Array of Goals' do
-          let(:goal) { [goals.first] }
-          it_behaves_like 'goal completion'
-        end
-
-        describe 'String of Goal' do
-          let(:goal) { goals.first }
-          it_behaves_like 'goal completion'
-        end
+      describe 'Array of Goals' do
+        let(:goal) { [goals.first] }
+        it_behaves_like 'goal completion'
+      end
 
+      describe 'String of Goal' do
+        let(:goal) { goals.first }
+        it_behaves_like 'goal completion'
       end
+
     end
+  end
 
-    describe "alternative recording" do
-      before(:each) { Split.configuration.store_override = false }
+  describe "alternative recording" do
+    before(:each) { Split.configuration.store_override = false }
 
-      context "when override is present" do
-        it "stores when store_override is true" do
-          trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'basket')
+    context "when override is present" do
+      it "stores when store_override is true" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'basket')
 
-          Split.configuration.store_override = true
-          expect(user).to receive("[]=")
-          trial.choose!
-        end
+        Split.configuration.store_override = true
+        expect(user).to receive("[]=")
+        trial.choose!
+      end
 
-        it "does not store when store_override is false" do
-          trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'basket')
+      it "does not store when store_override is false" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'basket')
 
-          expect(user).to_not receive("[]=")
-          trial.choose!
-        end
+        expect(user).to_not receive("[]=")
+        trial.choose!
       end
+    end
 
-      context "when disabled is present" do
-        it "stores when store_override is true" do
-          trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+    context "when disabled is present" do
+      it "stores when store_override is true" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
 
-          Split.configuration.store_override = true
-          expect(user).to receive("[]=")
-          trial.choose!
-        end
+        Split.configuration.store_override = true
+        expect(user).to receive("[]=")
+        trial.choose!
+      end
 
-        it "does not store when store_override is false" do
-          trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+      it "does not store when store_override is false" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
 
-          expect(user).to_not receive("[]=")
-          trial.choose!
-        end
+        expect(user).to_not receive("[]=")
+        trial.choose!
       end
+    end
 
-      context "when exclude is present" do
-        it "does not store" do
-          trial = Split::Trial.new(:user => user, :experiment => experiment, :exclude => true)
+    context "when exclude is present" do
+      it "does not store" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :exclude => true)
 
-          expect(user).to_not receive("[]=")
-          trial.choose!
-        end
+        expect(user).to_not receive("[]=")
+        trial.choose!
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis