split 1.0.0 → 1.1.0

data/spec/helper_spec.rb

@@ -6,7 +6,7 @@ describe Split::Helper do
   include Split::Helper
 
   let(:experiment) {
-    Split::Experiment.find_or_create('link_color', 'blue', 'red')
+    Split::ExperimentCatalog.find_or_create('link_color', 'blue', 'red')
   }
 
   describe "ab_test" do
@@ -53,7 +53,7 @@ describe Split::Helper do
 
     it 'should not increment the counter for an experiment that the user is not participating in' do
       ab_test('link_color', 'blue', 'red')
-      e = Split::Experiment.find_or_create('button_size', 'small', 'big')
+      e = Split::ExperimentCatalog.find_or_create('button_size', 'small', 'big')
       expect(lambda {
         # User shouldn't participate in this second experiment
         ab_test('button_size', 'small', 'big')
@@ -61,7 +61,7 @@ describe Split::Helper do
     end
 
     it 'should not increment the counter for an ended experiment' do
-      e = Split::Experiment.find_or_create('button_size', 'small', 'big')
+      e = Split::ExperimentCatalog.find_or_create('button_size', 'small', 'big')
       e.winner = 'small'
       expect(lambda {
         a = ab_test('button_size', 'small', 'big')
@@ -71,7 +71,7 @@ describe Split::Helper do
 
     it 'should not increment the counter for an not started experiment' do
       expect(Split.configuration).to receive(:start_manually).and_return(true)
-      e = Split::Experiment.find_or_create('button_size', 'small', 'big')
+      e = Split::ExperimentCatalog.find_or_create('button_size', 'small', 'big')
       expect(lambda {
         a = ab_test('button_size', 'small', 'big')
         expect(a).to eq('small')
@@ -162,7 +162,7 @@ describe Split::Helper do
 
     it "should allow alternative weighting interface as a single hash" do
       ab_test('link_color', {'blue' => 0.01}, 'red' => 0.2)
-      experiment = Split::Experiment.find('link_color')
+      experiment = Split::ExperimentCatalog.find('link_color')
       expect(experiment.alternatives.map(&:name)).to eq(['blue', 'red'])
       # TODO: persist alternative weights
       # expect(experiment.alternatives.collect{|a| a.weight}).to eq([0.01, 0.2])
@@ -202,7 +202,7 @@ describe Split::Helper do
     before(:each) do
       @experiment_name = 'link_color'
       @alternatives = ['blue', 'red']
-      @experiment = Split::Experiment.find_or_create(@experiment_name, *@alternatives)
+      @experiment = Split::ExperimentCatalog.find_or_create(@experiment_name, *@alternatives)
       @alternative_name = ab_test(@experiment_name, *@alternatives)
       @previous_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
     end
@@ -237,7 +237,7 @@ describe Split::Helper do
     end
 
     it 'should not increment the counter for an ended experiment' do
-      e = Split::Experiment.find_or_create('button_size', 'small', 'big')
+      e = Split::ExperimentCatalog.find_or_create('button_size', 'small', 'big')
       e.winner = 'small'
       a = ab_test('button_size', 'small', 'big')
       expect(a).to eq('small')
@@ -278,12 +278,6 @@ describe Split::Helper do
       expect(lambda { finished('some_experiment_not_started_by_the_user') }).not_to raise_exception
     end
 
-    it 'should not be doing other tests when it has completed one that has :reset => false' do
-      ab_user[@experiment.key] = @alternative_name
-      ab_user[@experiment.finished_key] = true
-      expect(doing_other_tests?(@experiment.key)).to be false
-    end
-
     context "when on_trial_complete is set" do
       before { Split.configuration.on_trial_complete = :some_method }
       it "should call the method" do
@@ -308,7 +302,7 @@ describe Split::Helper do
         }
       }
       alternative = ab_test(:my_experiment)
-      experiment = Split::Experiment.find :my_experiment
+      experiment = Split::ExperimentCatalog.find :my_experiment
 
       finished :my_experiment
       expect(ab_user).to eq(experiment.key => alternative, experiment.finished_key => true)
@@ -321,7 +315,7 @@ describe Split::Helper do
 
     def should_finish_experiment(experiment_name, should_finish=true)
       alts = Split.configuration.experiments[experiment_name][:alternatives]
-      experiment = Split::Experiment.find_or_create(experiment_name, *alts)
+      experiment = Split::ExperimentCatalog.find_or_create(experiment_name, *alts)
       alt_name = ab_user[experiment.key] = alts.first
       alt = double('alternative')
       expect(alt).to receive(:name).at_most(1).times.and_return(alt_name)
@@ -372,7 +366,7 @@ describe Split::Helper do
         }
       }
       alternative_name = ab_test(:my_exp)
-      exp = Split::Experiment.find :my_exp
+      exp = Split::ExperimentCatalog.find :my_exp
 
       finished :my_metric
       expect(ab_user[exp.key]).to eq(alternative_name)
@@ -387,7 +381,7 @@ describe Split::Helper do
         }
       }
       alternative_name = ab_test(:my_exp)
-      exp = Split::Experiment.find :my_exp
+      exp = Split::ExperimentCatalog.find :my_exp
 
       finished :my_metric, :reset => false
       expect(ab_user[exp.key]).to eq(alternative_name)
@@ -409,6 +403,47 @@ describe Split::Helper do
     end
   end
 
+  describe 'active experiments' do
+    it 'should show an active test' do
+      alternative = ab_test('def', '4', '5', '6')
+      expect(active_experiments.count).to eq 1
+      expect(active_experiments.first[0]).to eq "def"
+      expect(active_experiments.first[1]).to eq alternative
+    end
+
+    it 'should show a finished test' do
+      alternative = ab_test('def', '4', '5', '6')
+      finished('def', {:reset => false})
+      expect(active_experiments.count).to eq 1
+      expect(active_experiments.first[0]).to eq "def"
+      expect(active_experiments.first[1]).to eq alternative
+    end
+
+    it 'should show multiple tests' do
+      Split.configure do |config|
+        config.allow_multiple_experiments = true
+      end
+      alternative = ab_test('def', '4', '5', '6')
+      another_alternative = ab_test('ghi', '7', '8', '9')
+      expect(active_experiments.count).to eq 2
+      expect(active_experiments['def']).to eq alternative
+      expect(active_experiments['ghi']).to eq another_alternative
+    end
+
+    it 'should not show tests with winners' do
+      Split.configure do |config|
+        config.allow_multiple_experiments = true
+      end
+      e = Split::ExperimentCatalog.find_or_create('def', '4', '5', '6')
+      e.winner = '4'
+      alternative = ab_test('def', '4', '5', '6')
+      another_alternative = ab_test('ghi', '7', '8', '9')
+      expect(active_experiments.count).to eq 1
+      expect(active_experiments.first[0]).to eq "ghi"
+      expect(active_experiments.first[1]).to eq another_alternative
+    end
+  end
+
   describe 'when user is a robot' do
     before(:each) do
       @request = OpenStruct.new(:user_agent => 'Googlebot/2.1 (+http://www.google.com/bot.html)')
@@ -847,7 +882,7 @@ describe Split::Helper do
   end
 
   it 'should handle multiple experiments correctly' do
-    experiment2 = Split::Experiment.find_or_create('link_color2', 'blue', 'red')
+    experiment2 = Split::ExperimentCatalog.find_or_create('link_color2', 'blue', 'red')
     alternative_name = ab_test('link_color', 'blue', 'red')
     alternative_name2 = ab_test('link_color2', 'blue', 'red')
     finished('link_color2')
@@ -861,7 +896,7 @@ describe Split::Helper do
     before do
       @experiment = {'link_color' => ["purchase", "refund"]}
       @alternatives = ['blue', 'red']
-      @experiment_name, @goals = normalize_experiment(@experiment)
+      @experiment_name, @goals = normalize_metric(@experiment)
       @goal1 = @goals[0]
       @goal2 = @goals[1]
     end
@@ -874,7 +909,7 @@ describe Split::Helper do
     describe "ab_test" do
       it "should allow experiment goals interface as a single hash" do
         ab_test(@experiment, *@alternatives)
-        experiment = Split::Experiment.find('link_color')
+        experiment = Split::ExperimentCatalog.find('link_color')
         expect(experiment.goals).to eq(['purchase', "refund"])
       end
     end

data/spec/metric_spec.rb

@@ -4,13 +4,13 @@ require 'split/metric'
 describe Split::Metric do
   describe 'possible experiments' do
     it "should load the experiment if there is one, but no metric" do
-      experiment = Split::Experiment.find_or_create('color', 'red', 'blue')
+      experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
       expect(Split::Metric.possible_experiments('color')).to eq([experiment])
     end
 
     it "should load the experiments in a metric" do
-      experiment1 = Split::Experiment.find_or_create('color', 'red', 'blue')
-      experiment2 = Split::Experiment.find_or_create('size', 'big', 'small')
+      experiment1 = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
+      experiment2 = Split::ExperimentCatalog.find_or_create('size', 'big', 'small')
 
       metric = Split::Metric.new(:name => 'purchase', :experiments => [experiment1, experiment2])
       metric.save
@@ -18,8 +18,8 @@ describe Split::Metric do
     end
 
     it "should load both the metric experiments and an experiment with the same name" do
-      experiment1 = Split::Experiment.find_or_create('purchase', 'red', 'blue')
-      experiment2 = Split::Experiment.find_or_create('size', 'big', 'small')
+      experiment1 = Split::ExperimentCatalog.find_or_create('purchase', 'red', 'blue')
+      experiment2 = Split::ExperimentCatalog.find_or_create('size', 'big', 'small')
 
       metric = Split::Metric.new(:name => 'purchase', :experiments => [experiment2])
       metric.save

data/spec/persistence/redis_adapter_spec.rb

@@ -16,6 +16,15 @@ describe Split::Persistence::RedisAdapter do
       end
     end
 
+    context 'config with key' do
+      before { Split::Persistence::RedisAdapter.reset_config! }
+      subject { Split::Persistence::RedisAdapter.new(context, 'manual') }
+
+      it 'should be "persistence:manual"' do
+        expect(subject.redis_key).to eq('persistence:manual')
+      end
+    end
+
     context 'config with lookup_by = proc { "block" }' do
       before { Split::Persistence::RedisAdapter.with_config(:lookup_by => proc{'block'}) }
 

data/spec/spec_helper.rb

@@ -36,4 +36,4 @@ def request(ua = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) Apple
   r.user_agent = ua
   r.ip = '192.168.1.1'
   @request ||= r
-end
+end

data/spec/trial_spec.rb

@@ -2,61 +2,158 @@ require 'spec_helper'
 require 'split/trial'
 
 describe Split::Trial do
+  let(:user) { Split::Persistence.adapter.new(double(session: {})) }
+  let(:experiment) do
+    Split::Experiment.new('basket_text', :alternatives => ['basket', 'cart']).save
+  end
+
   it "should be initializeable" do
     experiment  = double('experiment')
     alternative = double('alternative', :kind_of? => Split::Alternative)
     trial = Split::Trial.new(:experiment => experiment, :alternative => alternative)
     expect(trial.experiment).to eq(experiment)
     expect(trial.alternative).to eq(alternative)
-    expect(trial.goals).to eq([])
   end
 
   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'), :alternative => alternative)
+      trial = Split::Trial.new(:experiment => experiment = double('experiment'),
+          :alternative => alternative, :user => user)
       expect(trial).not_to receive(:choose)
       expect(trial.alternative).to eq(alternative)
     end
 
-    it "should populate alternative with a full alternative object after calling choose" do
+    it "should load the alternative when the alternative name is set" do
       experiment = Split::Experiment.new('basket_text', :alternatives => ['basket', 'cart'])
       experiment.save
-      trial = Split::Trial.new(:experiment => experiment)
-      trial.choose
-      expect(trial.alternative.class).to eq(Split::Alternative)
-      expect(['basket', 'cart']).to include(trial.alternative.name)
-    end
 
-    it "should populate an alternative when only one option is offerred" do
-      experiment = Split::Experiment.new('basket_text', :alternatives => ['basket'])
-      experiment.save
-      trial = Split::Trial.new(:experiment => experiment)
-      trial.choose
-      expect(trial.alternative.class).to eq(Split::Alternative)
+      trial = Split::Trial.new(:experiment => experiment, :alternative => 'basket')
       expect(trial.alternative.name).to eq('basket')
     end
+  end
 
+  describe "#choose!" do
+    def expect_alternative(trial, alternative_name)
+      3.times do
+        trial.choose!
+        expect(trial.alternative.name).to eq(alternative_name)
+      end
+    end
 
-    it "should choose from the available alternatives" do
-      trial = Split::Trial.new(:experiment => experiment = double('experiment'))
-      alternative = double('alternative', :kind_of? => Split::Alternative)
-      expect(experiment).to receive(:next_alternative).and_return(alternative)
-      expect(alternative).to receive(:increment_participation)
-      expect(experiment).to receive(:winner).at_most(1).times.and_return(nil)
-      trial.choose!
+    context "when override is present" do
+      it "picks the override" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'cart')
+        expect(experiment).to_not receive(:next_alternative)
 
-      expect(trial.alternative).to eq(alternative)
+        expect_alternative(trial, 'cart')
+      end
     end
-  end
 
-  describe "alternative_name" do
-    it "should load the alternative when the alternative name is set" do
-      experiment = Split::Experiment.new('basket_text', :alternatives => ['basket', "cart"])
-      experiment.save
+    context "when disabled option is true" do
+      it "picks the control" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+        expect(experiment).to_not receive(:next_alternative)
 
-      trial = Split::Trial.new(:experiment => experiment, :alternative => 'basket')
-      expect(trial.alternative.name).to eq('basket')
+        expect_alternative(trial, 'basket')
+      end
+    end
+
+    context "when Split is globally disabled" do
+      it "picks the control" do
+        Split.configuration.enabled = false
+        trial = Split::Trial.new(:user => user, :experiment => experiment)
+        expect(experiment).to_not receive(:next_alternative)
+
+        expect_alternative(trial, 'basket')
+        Split.configuration.enabled = true
+      end
+    end
+
+    context "when experiment has winner" do
+      it "picks the winner" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment)
+        experiment.winner = 'cart'
+        expect(experiment).to_not receive(:next_alternative)
+
+        expect_alternative(trial, 'cart')
+      end
+    end
+
+    context "when exclude is true" do
+      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 "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')
+      end
+    end
+
+    context "when user is a new participant" do
+      it "picks a new alternative" do
+        trial = Split::Trial.new(:user => user, :experiment => experiment)
+        expect(experiment).to receive(:next_alternative).and_call_original
+
+        trial.choose!
+        expect(trial.alternative.name).to_not be_empty
+      end
+    end
+
+    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')
+
+          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')
+
+          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)
+
+          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)
+
+          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)
+
+          expect(user).to_not receive("[]=")
+          trial.choose!
+        end
+      end
     end
   end
 end

data/split.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'sinatra',         '>= 1.2.6'
   s.add_dependency 'simple-random'
 
-  s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler',     '~> 1.6'
-  s.add_development_dependency 'rspec',       '~> 3.0'
-  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec',       '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - andrewnez@gmail.com
@@ -146,19 +146,15 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
-- CHANGELOG.mdown
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
-- README.mdown
+- README.md
 - Rakefile
-- changes.rtf
-- gemfiles/3.0.gemfile
-- gemfiles/3.0.gemfile.lock
-- gemfiles/3.1.gemfile
-- gemfiles/3.1.gemfile.lock
 - gemfiles/3.2.gemfile
 - gemfiles/4.0.gemfile
+- gemfiles/4.1.gemfile
 - lib/split.rb
 - lib/split/algorithms.rb
 - lib/split/algorithms/weighted_sample.rb
@@ -200,6 +196,7 @@ files:
 - spec/dashboard_helpers_spec.rb
 - spec/dashboard_spec.rb
 - spec/encapsulated_helper_spec.rb
+- spec/experiment_catalog_spec.rb
 - spec/experiment_spec.rb
 - spec/helper_spec.rb
 - spec/metric_spec.rb
@@ -231,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: split
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rack based split testing framework
@@ -243,6 +240,7 @@ test_files:
 - spec/dashboard_helpers_spec.rb
 - spec/dashboard_spec.rb
 - spec/encapsulated_helper_spec.rb
+- spec/experiment_catalog_spec.rb
 - spec/experiment_spec.rb
 - spec/helper_spec.rb
 - spec/metric_spec.rb