split 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d56d14f269b46f4409460cd7f8805c423d2ba92
-  data.tar.gz: 574c8c51ccf9a72efad3aace656e80e95301bd3b
+  metadata.gz: 1819f5bb2d97f871dce0a859b30f0d6a10a94341
+  data.tar.gz: b9026aa79967696c5f29de4ea320972257a0327d
 SHA512:
-  metadata.gz: 9be1ddfbab6be25f4458ff893a272523e15b8109727b2eddae3d508db5afed4b810693d61e9c5931b7e5d0ebf36610d442bb08a22869b29c8583ca07e144722f
-  data.tar.gz: 77b36b084453e5aaa46be4d9d1b0551e22c51547a4df02a642dd9ebf94c23c5fdb6fa8a01a2fe7be8f5052dce3cc5003a7c29c7b178d4c54ee5c57b098fd0240
+  metadata.gz: 2736a69b3f38e61393b4bb3a44fa9bea24a5ed2982689eff841d1e3c2e9516cb870795bf2fd7299e394bd8c520a13335e8399163eacf92dd512cdd46cfeff212
+  data.tar.gz: 3ca9fecdbe966b6e64586e3bcaa500be8daaa1b2a2aab2cefac664d98e73297f539b218fe9728a567fc612770bb947dcc2bd90db7343dc5a59490a9d3377aefd

data/LICENSE

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2013 Andrew Nesbitt
 
 Permission is hereby granted, free of charge, to any person obtaining

data/lib/split/dashboard.rb

@@ -45,6 +45,12 @@ module Split
       redirect url('/')
     end
 
+    post '/reopen/:experiment' do
+      @experiment = Split::Experiment.find(params[:experiment])
+      @experiment.reset_winner
+      redirect url('/')
+    end
+
     delete '/:experiment' do
       @experiment = Split::Experiment.find(params[:experiment])
       @experiment.delete

data/lib/split/dashboard/public/dashboard.js

@@ -16,4 +16,9 @@ function confirmWinner() {
 function confirmStep(step) {
   var agree = confirm(step);
   return agree ? true : false;
-}
+}
+
+function confirmReopen() {
+  var agree = confirm("This will reopen the experiment. Are you sure?");
+  return agree ? true : false;
+}

data/lib/split/dashboard/views/_controls.erb

@@ -1,3 +1,8 @@
+<% if experiment.has_winner? %>
+  <form action="<%= url "/reopen/#{experiment.name}" %>" method='post' onclick="return confirmReopen()">
+    <input type="submit" value="Reopen Experiment">
+  </form>
+<% end %>
 <% if experiment.start_time %>
   <form action="<%= url "/reset/#{experiment.name}" %>" method='post' onclick="return confirmReset()">
     <input type="submit" value="Reset Data">

data/lib/split/dashboard/views/_experiment.erb

@@ -59,7 +59,7 @@
           <span title='z-score: <%= round(alternative.z_score(goal), 3) %>'><%= confidence_level(alternative.z_score(goal)) %></span>
         </td>
         <td>
-          <% if experiment.winner %>
+          <% if experiment.has_winner? %>
             <% if experiment.winner.name == alternative.name %>
               Winner
             <% else %>

data/lib/split/experiment.rb

@@ -79,7 +79,6 @@ module Split
         @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
         @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
       else
-
         existing_alternatives = load_alternatives_from_redis
         existing_goals = load_goals_from_redis
         unless existing_alternatives == @alternatives.map(&:name) && existing_goals == @goals
@@ -149,6 +148,10 @@ module Split
       end
     end
 
+    def has_winner?
+      !winner.nil?
+    end
+
     def winner=(winner_name)
       Split.redis.hset(:experiment_winner, name, winner_name.to_s)
     end

data/lib/split/helper.rb

@@ -6,16 +6,20 @@ module Split
         puts 'WARNING: You should always pass the control alternative through as the second argument with any other alternatives as the third because the order of the hash is not preserved in ruby 1.8'
       end
 
-      # Check if array is passed to ab_test: ab_test('name', ['Alt 1', 'Alt 2', 'Alt 3'])
+      # 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?
         control, alternatives = control.first, control[1..-1]
       end
 
       begin
-      experiment_name_with_version, goals = normalize_experiment(metric_descriptor)
-      experiment_name = experiment_name_with_version.to_s.split(':')[0]
-      experiment = Split::Experiment.new(experiment_name, :alternatives => [control].compact + alternatives, :goals => goals)
-      control ||= experiment.control && experiment.control.name
+        experiment_name_with_version, goals = normalize_experiment(metric_descriptor)
+        experiment_name = experiment_name_with_version.to_s.split(':')[0]
+        experiment = Split::Experiment.new(
+          experiment_name,
+          :alternatives => [control].compact + alternatives,
+          :goals => goals)
+        control ||= experiment.control && experiment.control.name
 
         ret = if Split.configuration.enabled
           experiment.save
@@ -23,8 +27,7 @@ module Split
         else
           control_variable(control)
         end
-
-      rescue => e
+      rescue Errno::ECONNREFUSED => e
         raise(e) unless Split.configuration.db_failover
         Split.configuration.db_failover_on_db_error.call(e)
 
@@ -32,9 +35,7 @@ module Split
           ret = override_alternative(experiment_name)
         end
       ensure
-        unless ret
-          ret = control_variable(control)
-        end
+        ret ||= control_variable(control)
       end
 
       if block_given?
@@ -55,7 +56,7 @@ module Split
     end
 
     def finish_experiment(experiment, options = {:reset => true})
-      return true unless experiment.winner.nil?
+      return true if experiment.has_winner?
       should_reset = experiment.resettable? && options[:reset]
       if ab_user[experiment.finished_key] && !should_reset
         return true
@@ -168,7 +169,7 @@ module Split
       if override_present?(experiment.name)
         ret = override_alternative(experiment.name)
         ab_user[experiment.key] = ret if Split.configuration.store_override
-      elsif ! experiment.winner.nil?
+      elsif experiment.has_winner?
         ret = experiment.winner.name
       else
         clean_old_versions(experiment)

data/lib/split/trial.rb

@@ -10,7 +10,7 @@ module Split
     end
 
     def alternative
-      @alternative ||=  if experiment.winner
+      @alternative ||=  if experiment.has_winner?
                           experiment.winner
                         end
     end

data/lib/split/version.rb

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

data/spec/alternative_spec.rb

@@ -11,32 +11,22 @@ describe Split::Alternative do
     Split::Alternative.new('Cart', 'basket_text')
   }
 
-  let(:experiment) {
+  let!(:experiment) {
     Split::Experiment.find_or_create({"basket_text" => ["purchase", "refund"]}, "Basket", "Cart")
   }
 
   let(:goal1) { "purchase" }
   let(:goal2) { "refund" }
 
-  # setup experiment
-  before do
-    experiment
-  end
-
   it "should have goals" do
     alternative.goals.should eql(["purchase", "refund"])
   end
 
-  it "should have a name" do
-    alternative.name.should eql('Basket')
-  end
-
-  it "return only the name" do
+  it "should have and only return the name" do
     alternative.name.should eql('Basket')
   end
 
   describe 'weights' do
-
     it "should set the weights" do
       experiment = Split::Experiment.new('basket_text', :alternatives => [{'Basket' => 0.6}, {"Cart" => 0.4}])
       first = experiment.alternatives[0]
@@ -248,7 +238,7 @@ describe Split::Alternative do
 
       alternative2.participant_count = 142
       alternative2.set_completed_count(119)
-      
+
       alternative2.z_score.round(2).should eql(2.58)
     end
 

data/spec/dashboard_spec.rb

@@ -59,6 +59,53 @@ describe Split::Dashboard do
     end
   end
 
+  describe "index page" do
+    context "with winner" do
+      before { experiment.winner = 'red' }
+
+      it "displays `Reopen Experiment` button" do
+        get '/'
+
+        expect(last_response.body).to include('Reopen Experiment')
+      end
+    end
+
+    context "without winner" do
+      it "should not display `Reopen Experiment` button" do
+        get '/'
+
+        expect(last_response.body).to_not include('Reopen Experiment')
+      end
+    end
+  end
+
+  describe "reopen experiment" do
+    before { experiment.winner = 'red' }
+
+    it 'redirects' do
+      post "/reopen/#{experiment.name}"
+
+      expect(last_response).to be_redirect
+    end
+
+    it "removes winner" do
+      post "/reopen/#{experiment.name}"
+
+      expect(experiment).to_not have_winner
+    end
+
+    it "keeps existing stats" do
+      red_link.participant_count = 5
+      blue_link.participant_count = 7
+      experiment.winner = 'blue'
+
+      post "/reopen/#{experiment.name}"
+
+      expect(red_link.participant_count).to eq(5)
+      expect(blue_link.participant_count).to eq(7)
+    end
+  end
+
   it "should reset an experiment" do
     red_link.participant_count = 5
     blue_link.participant_count = 7

data/spec/experiment_spec.rb

@@ -201,6 +201,22 @@ describe Split::Experiment do
     end
   end
 
+  describe 'has_winner?' do
+    context 'with winner' do
+      before { experiment.winner = 'red' }
+
+      it 'returns true' do
+        expect(experiment).to have_winner
+      end
+    end
+
+    context 'without winner' do
+      it 'returns false' do
+        expect(experiment).to_not have_winner
+      end
+    end
+  end
+
   describe 'reset' do
     before { experiment.save }
     it 'should reset all alternatives' do

data/spec/helper_spec.rb

@@ -10,7 +10,6 @@ describe Split::Helper do
   }
 
   describe "ab_test" do
-
     it "should not raise an error when passed strings for alternatives" do
       lambda { ab_test('xyz', '1', '2', '3') }.should_not raise_error
     end
@@ -41,7 +40,6 @@ describe Split::Helper do
     end
 
     it "should increment the participation counter after assignment to a new user" do
-
       previous_red_count = Split::Alternative.new('red', 'link_color').participant_count
       previous_blue_count = Split::Alternative.new('blue', 'link_color').participant_count
 
@@ -81,9 +79,7 @@ describe Split::Helper do
     end
 
     it "should return the given alternative for an existing user" do
-      alternative = ab_test('link_color', 'blue', 'red')
-      repeat_alternative = ab_test('link_color', 'blue', 'red')
-      alternative.should eql repeat_alternative
+      ab_test('link_color', 'blue', 'red').should eql ab_test('link_color', 'blue', 'red')
     end
 
     it 'should always return the winner if one is present' do
@@ -105,7 +101,7 @@ describe Split::Helper do
       alternative.should eql('red')
     end
 
-    it "should not store the via params forced alternative" do
+    it "should not store the split when a param forced alternative" do
       @params = {'link_color' => 'blue'}
       ab_user.should_not_receive(:[]=)
       ab_test('link_color', 'blue', 'red')
@@ -135,7 +131,7 @@ describe Split::Helper do
       ret.should eql("shared/#{alt}")
     end
 
-    it "should allow the share of visitors see an alternative to be specificed" do
+    it "should allow the share of visitors see an alternative to be specified" do
       ab_test('link_color', {'blue' => 0.8}, {'red' => 20})
       ['red', 'blue'].should include(ab_user['link_color'])
     end
@@ -277,7 +273,6 @@ describe Split::Helper do
         finished(@experiment_name)
       end
     end
-
   end
 
   context "finished with config" do
@@ -374,7 +369,6 @@ describe Split::Helper do
       ab_user[exp.key].should == alternative_name
       ab_user[exp.finished_key].should == true
     end
-
   end
 
   describe 'conversions' do
@@ -431,7 +425,6 @@ describe Split::Helper do
     end
   end
 
-
   describe 'when providing custom ignore logic' do
     context "using a proc to configure custom logic" do
 
@@ -452,7 +445,6 @@ describe Split::Helper do
   end
 
   shared_examples_for "a disabled test" do
-
     describe 'ab_test' do
       it 'should return the control' do
         alternative = ab_test('link_color', 'blue', 'red')
@@ -460,7 +452,6 @@ describe Split::Helper do
       end
 
       it "should not increment the participation count" do
-
         previous_red_count = Split::Alternative.new('red', 'link_color').participant_count
         previous_blue_count = Split::Alternative.new('blue', 'link_color').participant_count
 
@@ -489,9 +480,7 @@ describe Split::Helper do
   end
 
   describe 'when ip address is ignored' do
-
     context "individually" do
-
       before(:each) do
         @request = OpenStruct.new(:ip => '81.19.48.130')
         Split.configure do |c|
@@ -500,11 +489,9 @@ describe Split::Helper do
       end
 
       it_behaves_like "a disabled test"
-
     end
 
     context "for a range" do
-
       before(:each) do
         @request = OpenStruct.new(:ip => '81.19.48.129')
         Split.configure do |c|
@@ -513,11 +500,9 @@ describe Split::Helper do
       end
 
       it_behaves_like "a disabled test"
-
     end
 
     context "using both a range and a specific value" do
-
       before(:each) do
         @request = OpenStruct.new(:ip => '81.19.48.128')
         Split.configure do |c|
@@ -527,9 +512,7 @@ describe Split::Helper do
       end
 
       it_behaves_like "a disabled test"
-
     end
-
   end
 
   describe 'versioned experiments' do
@@ -602,13 +585,11 @@ describe Split::Helper do
   end
 
   context 'when redis is not available' do
-
     before(:each) do
       Split.stub(:redis).and_raise(Errno::ECONNREFUSED.new)
     end
 
     context 'and db_failover config option is turned off' do
-
       before(:each) do
         Split.configure do |config|
           config.db_failover = false
@@ -617,55 +598,35 @@ describe Split::Helper do
 
       describe 'ab_test' do
         it 'should raise an exception' do
-          lambda {
-            ab_test('link_color', 'blue', 'red')
-          }.should raise_error
+          lambda { ab_test('link_color', 'blue', 'red') }.should raise_error
         end
       end
 
       describe 'finished' do
         it 'should raise an exception' do
-          lambda {
-            finished('link_color')
-          }.should raise_error
+          lambda { finished('link_color') }.should raise_error
         end
       end
 
       describe "disable split testing" do
-
         before(:each) do
           Split.configure do |config|
             config.enabled = false
           end
         end
 
-        after(:each) do
-          Split.configure do |config|
-            config.enabled = true
-          end
-        end
-
         it "should not attempt to connect to redis" do
-
-          lambda {
-            ab_test('link_color', 'blue', 'red')
-          }.should_not raise_error
+          lambda { ab_test('link_color', 'blue', 'red') }.should_not raise_error
         end
 
         it "should return control variable" do
           ab_test('link_color', 'blue', 'red').should eq('blue')
-          lambda {
-            finished('link_color')
-          }.should_not raise_error
+          lambda { finished('link_color') }.should_not raise_error
         end
-
       end
-
-
     end
 
     context 'and db_failover config option is turned on' do
-
       before(:each) do
         Split.configure do |config|
           config.db_failover = true
@@ -674,10 +635,9 @@ describe Split::Helper do
 
       describe 'ab_test' do
         it 'should not raise an exception' do
-          lambda {
-            ab_test('link_color', 'blue', 'red')
-          }.should_not raise_error
+          lambda { ab_test('link_color', 'blue', 'red') }.should_not raise_error
         end
+
         it 'should call db_failover_on_db_error proc with error as parameter' do
           Split.configure do |config|
             config.db_failover_on_db_error = proc do |error|
@@ -687,6 +647,7 @@ describe Split::Helper do
           Split.configuration.db_failover_on_db_error.should_receive(:call)
           ab_test('link_color', 'blue', 'red')
         end
+
         it 'should always use first alternative' do
           ab_test('link_color', 'blue', 'red').should eq('blue')
           ab_test('link_color', {'blue' => 0.01}, 'red' => 0.2).should eq('blue')
@@ -732,16 +693,16 @@ describe Split::Helper do
 
       describe 'finished' do
         it 'should not raise an exception' do
-          lambda {
-            finished('link_color')
-          }.should_not raise_error
+          lambda { finished('link_color') }.should_not raise_error
         end
+
         it 'should call db_failover_on_db_error proc with error as parameter' do
           Split.configure do |config|
             config.db_failover_on_db_error = proc do |error|
               error.should be_a(Errno::ECONNREFUSED)
             end
           end
+
           Split.configuration.db_failover_on_db_error.should_receive(:call)
           finished('link_color')
         end
@@ -812,7 +773,6 @@ describe Split::Helper do
       ab_test :my_experiment
       experiment = Split::Experiment.new(:my_experiment)
       experiment.alternatives.collect{|a| [a.name, a.weight]}.should == [['control_opt', 0.67], ['second_opt', 0.1], ['third_opt', 0.23]]
-
     end
 
     it "accepts probability on some alternatives" do
@@ -842,7 +802,7 @@ describe Split::Helper do
       ab_test :my_experiment
       experiment = Split::Experiment.new(:my_experiment)
       names_and_weights = experiment.alternatives.collect{|a| [a.name, a.weight]}
-      names_and_weights.should ==  [['control_opt', 0.18], ['second_opt', 0.18], ['third_opt', 0.64]]
+      names_and_weights.should == [['control_opt', 0.18], ['second_opt', 0.18], ['third_opt', 0.64]]
       names_and_weights.inject(0){|sum, nw| sum + nw[1]}.should == 1.0
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis