split 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e3f5edc1fef8a1131b615f82d5ec12cac72c29
-  data.tar.gz: bd21bc8f80816d06b3e05532152525e81c54e018
+  metadata.gz: 979183911b308ee1272e4d98e1bd0b8c87be732d
+  data.tar.gz: 8a4e49e77326cd94165f551b5e2080eaff78f053
 SHA512:
-  metadata.gz: 6c3dc4cf24791918469b0c7677b63ea04510ff216c3cb46de2fffe82ebb77110d8ec94269dff6ee32fe20c49ff256c9dee304b07933116166ba91746ca486737
-  data.tar.gz: 51b7bceb61bb92b61abd0b35eae3f5b142f6e1b48341a4a9d1753a4853289fc998e1a60dc462c3b8bac53c71f231b050952ab3f89a69d175ec32e78f0e7f3e97
+  metadata.gz: a990656f1a7342d069565c5ed6723577b915f77df5000e2d2fd8623105f060d2e079af2ded60d9b3b46120316db35a2c2ed1d88a68218e68784797ae83c4b9e1
+  data.tar.gz: 8c8ce0354d575b9b212c997753200b00e22eb9d379617303e3b95e14717a118182d238bd4141c0a1c9e4411e3066f503174462bac5253a35c8e19960d408f120

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.0 (July 17th, 2016)
+
+Breaking changes:
+
+- Removed deprecated `finished` and `begin_experiment` methods
+- Namespaced override param to avoid potential clashes (@henrik, #398)
+
 ## 1.7.0 (June 28th, 2016)
 
 Features:

data/README.md

@@ -136,7 +136,7 @@ You can do this by passing it as a parameter in the url.
 
 If you have an experiment called `button_color` with alternatives called `red` and `blue` used on your homepage, a url such as:
 
-    http://myawesomesite.com?button_color=red
+    http://myawesomesite.com?ab_test[button_color]=red
 
 will always have red buttons. This won't be stored in your session or count towards to results, unless you set the `store_override` configuration option.
 

data/lib/split/encapsulated_helper.rb

@@ -15,7 +15,7 @@ module Split
 
     class ContextShim
       include Split::Helper
-      public :ab_test, :finished, :ab_finished
+      public :ab_test, :ab_finished
 
       def initialize(context)
         @context = context
@@ -43,11 +43,6 @@ module Split
       end
     end
 
-    def ab_test_finished(*arguments)
-      warn 'DEPRECATION WARNING: ab_test_finished is deprecated and will be removed from Split 2.0.0'
-      split_context_shim.finished *arguments
-    end
-
     private
 
     # instantiate and memoize a context shim in case of multiple ab_test* calls

data/lib/split/helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module Split
   module Helper
+    OVERRIDE_PARAM_NAME = "ab_test"
+
     module_function
 
     def ab_test(metric_descriptor, control = nil, *alternatives)
@@ -74,30 +76,18 @@ module Split
       Split.configuration.db_failover_on_db_error.call(e)
     end
 
-    def finished(metric_descriptor, options = {:reset => true})
-      warn 'DEPRECATION WARNING: finished method was renamed to ab_finished and will be removed in Split 2.0.0'
-      ab_finished(metric_descriptor, options)
-    end
-
     def override_present?(experiment_name)
-      defined?(params) && params[experiment_name]
+      override_alternative(experiment_name)
     end
 
     def override_alternative(experiment_name)
-      params[experiment_name] if override_present?(experiment_name)
+      defined?(params) && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
     end
 
     def split_generically_disabled?
       defined?(params) && params['SPLIT_DISABLE']
     end
 
-    def begin_experiment(experiment, alternative_name = nil)
-      warn 'DEPRECATION WARNING: begin_experiment is deprecated and will be removed from Split 2.0.0'
-      alternative_name ||= experiment.control.name
-      ab_user[experiment.key] = alternative_name
-      alternative_name
-    end
-
     def ab_user
       @ab_user ||= User.new(self)
     end

data/lib/split/version.rb

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

data/spec/goals_collection_spec.rb

@@ -24,7 +24,7 @@ describe Split::GoalsCollection do
   describe "#validate!" do
     it "should't raise ArgumentError if @goals is nil?" do
       goals_collection = Split::GoalsCollection.new('experiment_name')
-      expect { goals_collection.validate! }.not_to raise_error(ArgumentError)
+      expect { goals_collection.validate! }.not_to raise_error
     end
 
     it "should raise ArgumentError if @goals is not an Array" do
@@ -36,7 +36,7 @@ describe Split::GoalsCollection do
     it "should't raise ArgumentError if @goals is an array" do
       goals_collection = Split::GoalsCollection.
         new('experiment_name', ['an array'])
-      expect { goals_collection.validate! }.not_to raise_error(ArgumentError)
+      expect { goals_collection.validate! }.not_to raise_error
     end
   end
 

data/spec/helper_spec.rb

@@ -89,27 +89,33 @@ describe Split::Helper do
       expect(ab_test('link_color', 'blue', 'red')).to eq('orange')
     end
 
-    it "should allow the alternative to be force by passing it in the params" do
-      @params = {'link_color' => 'blue'}
+    it "should allow the alternative to be forced by passing it in the params" do
+      # ?ab_test[link_color]=blue
+      @params = { 'ab_test' => { 'link_color' => 'blue' } }
+
       alternative = ab_test('link_color', 'blue', 'red')
       expect(alternative).to eq('blue')
+
       alternative = ab_test('link_color', {'blue' => 1}, 'red' => 5)
       expect(alternative).to eq('blue')
-      @params = {'link_color' => 'red'}
+
+      @params = { 'ab_test' => { 'link_color' => 'red' } }
+
       alternative = ab_test('link_color', 'blue', 'red')
       expect(alternative).to eq('red')
+
       alternative = ab_test('link_color', {'blue' => 5}, 'red' => 1)
       expect(alternative).to eq('red')
     end
 
     it "should not allow an arbitrary alternative" do
-      @params = {'link_color' => 'pink'}
+      @params = { 'ab_test' => { 'link_color' => 'pink' } }
       alternative = ab_test('link_color', 'blue')
       expect(alternative).to eq('blue')
     end
 
     it "should not store the split when a param forced alternative" do
-      @params = {'link_color' => 'blue'}
+      @params = { 'ab_test' => { 'link_color' => 'blue' } }
       expect(ab_user).not_to receive(:[]=)
       ab_test('link_color', 'blue', 'red')
     end
@@ -136,7 +142,7 @@ describe Split::Helper do
       before { Split.configuration.store_override = true }
 
       it "should store the forced alternative" do
-        @params = {'link_color' => 'blue'}
+        @params = { 'ab_test' => { 'link_color' => 'blue' } }
         expect(ab_user).to receive(:[]=).with('link_color', 'blue')
         ab_test('link_color', 'blue', 'red')
       end
@@ -232,7 +238,7 @@ describe Split::Helper do
     end
 
     it 'should be passed to helper block' do
-      @params = {'my_experiment' => 'one'}
+      @params = { 'ab_test' => { 'my_experiment' => 'one' } }
       expect(ab_test('my_experiment')).to eq 'one'
       expect(ab_test('my_experiment') do |alternative, meta|
         meta
@@ -790,7 +796,7 @@ describe Split::Helper do
 
           context 'and given an override parameter' do
             it 'should use given override instead of the first alternative' do
-              @params = {'link_color' => 'red'}
+              @params = { 'ab_test' => { 'link_color' => 'red' } }
               expect(ab_test('link_color', 'blue', 'red')).to eq('red')
               expect(ab_test('link_color', 'blue', 'red', 'green')).to eq('red')
               expect(ab_test('link_color', {'blue' => 0.01}, 'red' => 0.2)).to eq('red')

metadata

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