split 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07f7886845453ce92ac81c33d32927c4c0528d39
-  data.tar.gz: 26a46a18c8a8e743ea532be9f9e2e3c63f516f4e
+  metadata.gz: eaed323e2d2459412259d82d76e4000c299c1db6
+  data.tar.gz: 54e05592a68ed6285e0ba613dadac52ed79bf23e
 SHA512:
-  metadata.gz: 1beb35f67693fa2073877c112cda7ba7abec3dfeff05699fdf13275d79ba0b424c982cc7c2811fdde826fcbced38f4e6b34d1e8db56786bf43aa7edff6d0bb92
-  data.tar.gz: d5956789a67b6d92d46e86e55b340900f806951a3dfea7419e1889df6844e21ef20a6777420fbb1362a8001f15c30e9114eb6020ec0de8b3bb508c8c58dfc6af
+  metadata.gz: a981adeb6a103db7766be39180bd353a31f642c659e4044071fbe8a094f4e36558705b477dd8a4b6eff893b11823209a241c24d5acc8d339201108abb33bf4b0
+  data.tar.gz: 7ca7d69fa815e194f9273974df0da3c556cb186f01720e8b342edd9482814725e4478006581b1878b1fb36f9fa53ed6f900176d3809101785d03bbac80e52f43

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.4.2 (April 25th, 2016)
+
+Misc:
+
+- Deprecated some legacy methods (@andreibondarev, #374)
+
 ## 1.4.1 (April 21st, 2016)
 
 Bugfixes:

data/README.md

@@ -165,6 +165,8 @@ finished(:experiment_name, reset: false)
 
 The user will then always see the alternative they started with.
 
+Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
+
 ### Multiple experiments at once
 
 By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.

data/lib/split.rb

@@ -12,6 +12,7 @@
    persistence
    encapsulated_helper
    trial
+   user
    version
    zscore].each do |f|
   require "split/#{f}"

data/lib/split/encapsulated_helper.rb

@@ -2,9 +2,9 @@
 # Split's helper exposes all kinds of methods we don't want to
 # mix into our model classes.
 #
-# This module exposes only two methods
-#  - ab_test and
-#  - ab_test_finished
+# This module exposes only two methods:
+#  - ab_test()
+#  - finished()
 # that can safely be mixed into any class.
 #
 # Passes the instance of the class that it's mixed into to the
@@ -22,7 +22,7 @@ module Split
       end
 
       def ab_user
-        @ab_user ||= Split::Persistence.adapter.new(@context)
+        @ab_user ||= Split::User.new(@context)
       end
     end
 
@@ -44,6 +44,7 @@ module Split
     end
 
     def ab_test_finished(*arguments)
+      warn 'DEPRECATION WARNING: ab_test_finished is deprecated and will be removed from Split 1.5.0'
       split_context_shim.finished *arguments
     end
 

data/lib/split/helper.rb

@@ -6,7 +6,6 @@ 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
           experiment.save
           trial = Trial.new(:user => ab_user, :experiment => experiment,
@@ -88,13 +87,14 @@ module Split
     end
 
     def begin_experiment(experiment, alternative_name = nil)
+      warn 'DEPRECATION WARNING: begin_experiment is deprecated and will be removed from Split 1.5.0'
       alternative_name ||= experiment.control.name
       ab_user[experiment.key] = alternative_name
       alternative_name
     end
 
     def ab_user
-      @ab_user ||= Split::Persistence.adapter.new(self)
+      @ab_user ||= User.new(self)
     end
 
     def exclude_visitor?

data/lib/split/trial.rb

@@ -50,6 +50,7 @@ module Split
     # method is guaranteed to only run once, and will skip the alternative choosing process if run
     # a second time.
     def choose!(context = nil)
+      @user.cleanup_old_experiments
       # Only run the process once
       return alternative if @alternative_choosen
 

data/lib/split/user.rb

@@ -0,0 +1,24 @@
+module Split
+  class User
+    extend Forwardable
+    def_delegators :@user, :keys, :[], :[]=, :delete
+    attr_reader :user
+
+    def initialize(context)
+      @user = Split::Persistence.adapter.new(context)
+    end
+
+    def cleanup_old_experiments
+      user.keys.each do |key|
+        experiment = ExperimentCatalog.find key_without_version(key)
+        if experiment.nil? || experiment.has_winner? || experiment.start_time.nil?
+          user.delete key
+        end
+      end
+    end
+
+    def key_without_version(key)
+      key.split(/\:\d(?!\:)/)[0]
+    end
+  end
+end

data/lib/split/version.rb

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

data/spec/encapsulated_helper_spec.rb

@@ -6,7 +6,7 @@ describe Split::EncapsulatedHelper do
 
   before do
     allow_any_instance_of(Split::EncapsulatedHelper::ContextShim).to receive(:ab_user)
-        .and_return({})
+        .and_return(mock_user)
   end
 
   def params

data/spec/helper_spec.rb

@@ -172,7 +172,7 @@ describe Split::Helper do
     it "should only let a user participate in one experiment at a time" do
       link_color = ab_test('link_color', 'blue', 'red')
       ab_test('button_size', 'small', 'big')
-      expect(ab_user).to eq({'link_color' => link_color})
+      expect(ab_user['link_color']).to eq(link_color)
       big = Split::Alternative.new('big', 'button_size')
       expect(big.participant_count).to eq(0)
       small = Split::Alternative.new('small', 'button_size')
@@ -185,7 +185,8 @@ describe Split::Helper do
       end
       link_color = ab_test('link_color', 'blue', 'red')
       button_size = ab_test('button_size', 'small', 'big')
-      expect(ab_user).to eq({'link_color' => link_color, 'button_size' => button_size})
+      expect(ab_user['link_color']).to eq(link_color)
+      expect(ab_user['button_size']).to eq(button_size)
       button_size_alt = Split::Alternative.new(button_size, 'button_size')
       expect(button_size_alt.participant_count).to eq(1)
     end
@@ -193,9 +194,9 @@ describe Split::Helper do
     it "should not over-write a finished key when an experiment is on a later version" do
       experiment.increment_version
       ab_user = { experiment.key => 'blue', experiment.finished_key => true }
-      finshed_session = ab_user.dup
+      finished_session = ab_user.dup
       ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq(finshed_session)
+      expect(ab_user).to eq(finished_session)
     end
   end
 
@@ -247,7 +248,8 @@ describe Split::Helper do
 
     it "should set experiment's finished key if reset is false" do
       finished(@experiment_name, {:reset => false})
-      expect(ab_user).to eq(@experiment.key => @alternative_name, @experiment.finished_key => true)
+      expect(ab_user[@experiment.key]).to eq(@alternative_name)
+      expect(ab_user[@experiment.finished_key]).to eq(true)
     end
 
     it 'should not increment the counter if reset is false and the experiment has been already finished' do
@@ -279,30 +281,31 @@ describe Split::Helper do
     end
 
     it "should clear out the user's participation from their session" do
-      expect(ab_user).to eq(@experiment.key => @alternative_name)
+      expect(ab_user[@experiment.key]).to eq(@alternative_name)
       finished(@experiment_name)
-      expect(ab_user).to eq({})
+      expect(ab_user.keys).to be_empty
     end
 
     it "should not clear out the users session if reset is false" do
-      expect(ab_user).to eq(@experiment.key => @alternative_name)
+      expect(ab_user[@experiment.key]).to eq(@alternative_name)
       finished(@experiment_name, {:reset => false})
-      expect(ab_user).to eq(@experiment.key => @alternative_name, @experiment.finished_key => true)
+      expect(ab_user[@experiment.key]).to eq(@alternative_name)
+      expect(ab_user[@experiment.finished_key]).to eq(true)
     end
 
     it "should reset the users session when experiment is not versioned" do
-      expect(ab_user).to eq(@experiment.key => @alternative_name)
+      expect(ab_user[@experiment.key]).to eq(@alternative_name)
       finished(@experiment_name)
-      expect(ab_user).to eq({})
+      expect(ab_user.keys).to be_empty
     end
 
     it "should reset the users session when experiment is versioned" do
       @experiment.increment_version
       @alternative_name = ab_test(@experiment_name, *@alternatives)
 
-      expect(ab_user).to eq(@experiment.key => @alternative_name)
+      expect(ab_user[@experiment.key]).to eq(@alternative_name)
       finished(@experiment_name)
-      expect(ab_user).to eq({})
+      expect(ab_user.keys).to be_empty
     end
 
     it "should do nothing where the experiment was not started by this user" do
@@ -337,7 +340,8 @@ describe Split::Helper do
       experiment = Split::ExperimentCatalog.find :my_experiment
 
       finished :my_experiment
-      expect(ab_user).to eq(experiment.key => alternative, experiment.finished_key => true)
+      expect(ab_user[experiment.key]).to eq(alternative)
+      expect(ab_user[experiment.finished_key]).to eq(true)
     end
   end
 
@@ -618,28 +622,28 @@ describe Split::Helper do
     it "should use version zero if no version is present" do
       alternative_name = ab_test('link_color', 'blue', 'red')
       expect(experiment.version).to eq(0)
-      expect(ab_user).to eq({'link_color' => alternative_name})
+      expect(ab_user['link_color']).to eq(alternative_name)
     end
 
     it "should save the version of the experiment to the session" do
       experiment.reset
       expect(experiment.version).to eq(1)
       alternative_name = ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq({'link_color:1' => alternative_name})
+      expect(ab_user['link_color:1']).to eq(alternative_name)
     end
 
     it "should load the experiment even if the version is not 0" do
       experiment.reset
       expect(experiment.version).to eq(1)
       alternative_name = ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq({'link_color:1' => alternative_name})
+      expect(ab_user['link_color:1']).to eq(alternative_name)
       return_alternative_name = ab_test('link_color', 'blue', 'red')
       expect(return_alternative_name).to eq(alternative_name)
     end
 
     it "should reset the session of a user on an older version of the experiment" do
       alternative_name = ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq({'link_color' => alternative_name})
+      expect(ab_user['link_color']).to eq(alternative_name)
       alternative = Split::Alternative.new(alternative_name, 'link_color')
       expect(alternative.participant_count).to eq(1)
 
@@ -656,7 +660,7 @@ describe Split::Helper do
 
     it "should cleanup old versions of experiments from the session" do
       alternative_name = ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq({'link_color' => alternative_name})
+      expect(ab_user['link_color']).to eq(alternative_name)
       alternative = Split::Alternative.new(alternative_name, 'link_color')
       expect(alternative.participant_count).to eq(1)
 
@@ -666,12 +670,12 @@ describe Split::Helper do
       expect(alternative.participant_count).to eq(0)
 
       new_alternative_name = ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq({'link_color:1' => new_alternative_name})
+      expect(ab_user['link_color:1']).to eq(new_alternative_name)
     end
 
     it "should only count completion of users on the current version" do
       alternative_name = ab_test('link_color', 'blue', 'red')
-      expect(ab_user).to eq({'link_color' => alternative_name})
+      expect(ab_user['link_color']).to eq(alternative_name)
       alternative = Split::Alternative.new(alternative_name, 'link_color')
 
       experiment.reset

data/spec/spec_helper.rb

@@ -19,11 +19,15 @@ RSpec.configure do |config|
   config.before(:each) do
     Split.configuration = Split::Configuration.new
     Split.redis.flushall
-    @ab_user = {}
+    @ab_user = mock_user
     params = nil
   end
 end
 
+def mock_user
+  Split::User.new(double(session: {}))
+end
+
 def session
   @session ||= {}
 end

data/spec/trial_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 require 'split/trial'
 
 describe Split::Trial do
-  let(:user) { Split::Persistence.adapter.new(double(session: {})) }
+  let(:user) { mock_user }
   let(:experiment) do
     Split::Experiment.new('basket_text', :alternatives => ['basket', 'cart']).save
   end

data/spec/user_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'split/experiment_catalog'
+require 'split/experiment'
+require 'split/user'
+
+describe Split::User do
+  let(:context) do
+    double(:session => { split: { 'link_color' => 'blue' } })
+  end
+
+  before(:each) do
+    @subject = described_class.new(context)
+  end
+
+  it 'delegates methods correctly' do
+    expect(@subject['link_color']).to eq(@subject.user['link_color'])
+  end
+
+  context '#cleanup_old_experiments' do
+    let(:experiment) { Split::Experiment.new('link_color') }
+
+    it 'removes key if experiment is not found' do
+      @subject.cleanup_old_experiments
+      expect(@subject.keys).to be_empty
+    end
+
+    it 'removes key if experiment has a winner' do
+      allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
+      allow(experiment).to receive(:start_time).and_return(Date.today)
+      allow(experiment).to receive(:has_winner?).and_return(true)
+      @subject.cleanup_old_experiments
+      expect(@subject.keys).to be_empty
+    end
+
+    it 'removes key if experiment has not started yet' do
+      allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
+      allow(experiment).to receive(:has_winner?).and_return(false)
+      @subject.cleanup_old_experiments
+      expect(@subject.keys).to be_empty
+    end    
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -203,6 +203,7 @@ files:
 - lib/split/persistence/redis_adapter.rb
 - lib/split/persistence/session_adapter.rb
 - lib/split/trial.rb
+- lib/split/user.rb
 - lib/split/version.rb
 - lib/split/zscore.rb
 - spec/algorithms/weighted_sample_spec.rb
@@ -224,6 +225,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
+- spec/user_spec.rb
 - split.gemspec
 homepage: https://github.com/splitrb/split
 licenses:
@@ -269,3 +271,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
+- spec/user_spec.rb