split 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5ce44cc3d861186dd8d1acce66eea15acb2f5af
-  data.tar.gz: 85bd7d57f7e56d0c4ac06ab8eecfbce40ec96060
+  metadata.gz: 07f7886845453ce92ac81c33d32927c4c0528d39
+  data.tar.gz: 26a46a18c8a8e743ea532be9f9e2e3c63f516f4e
 SHA512:
-  metadata.gz: 9aa91bd0caab6c179b0393bb25f075efa1782bee1ce6cc238b470dac58d76b9819d0e5534e18a68e872ee88d81f01f6fba9ac97e89bc0ede5add5dc00b5a16a6
-  data.tar.gz: 2aca58592f7a381482dbcfaec0ba8b490ccb2f032ad68a3e4a495a8dd56a26a337066929954380188da53fef7a21b21520a0601adb5a7125b3f62aae6dcc9340
+  metadata.gz: 1beb35f67693fa2073877c112cda7ba7abec3dfeff05699fdf13275d79ba0b424c982cc7c2811fdde826fcbced38f4e6b34d1e8db56786bf43aa7edff6d0bb92
+  data.tar.gz: d5956789a67b6d92d46e86e55b340900f806951a3dfea7419e1889df6844e21ef20a6777420fbb1362a8001f15c30e9114eb6020ec0de8b3bb508c8c58dfc6af

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.4.1 (April 21st, 2016)
+
+Bugfixes:
+
+- respect manual start configuration after an experiment has been deleted (@mtyeh411, #372)
+
+Misc:
+
+- Introduce goals collection to reduce complexity of Experiment#save (@pakallis, #365)
+- Revise specs according to http://betterspecs.org/ (@hkliya, #369)
+
 ## 1.4.0 (April 2nd, 2016)
 
 Features:

data/README.md

@@ -151,7 +151,7 @@ It is not required to send `SPLIT_DISABLE=false` to activate Split.
 By default new AB tests will be active right after deployment. In case you would like to start new test a while after
 the deploy, you can do it by setting the `start_manually` configuration option to `true`.
 
-After choosing this option tests won't be started right after deploy, but after pressing the `Start` button in Split admin dashboard.
+After choosing this option tests won't be started right after deploy, but after pressing the `Start` button in Split admin dashboard.  If a test is deleted from the Split dashboard, then it can only be started after pressing the `Start` button whenever being re-initialized.
 
 ### Reset after completion
 
@@ -284,8 +284,12 @@ For example:
 
 ``` ruby
 Split.configure do |config|
+  # after experiment reset or deleted
   config.on_experiment_reset  = -> (example) { # Do something on reset }
   config.on_experiment_delete = -> (experiment) { # Do something else on delete }
+  # before experiment reset or deleted
+  config.on_before_experiment_reset  = -> (example) { # Do something on reset }
+  config.on_before_experiment_delete = -> (experiment) { # Do something else on delete }
 end
 ```
 
@@ -445,9 +449,9 @@ Split.configure do |config|
       alternatives: ["a", "b"],
       metadata: {
         "a" => {"text" => "Have a fantastic day"},
-        "b" => {"text" => "Don't get hit by a bus"},
+        "b" => {"text" => "Don't get hit by a bus"}
       }
-    },
+    }
   }
 end
 ```
@@ -493,7 +497,7 @@ Split.configure do |config|
   config.experiments = {
     my_first_experiment: {
       alternatives: ["a", "b"],
-      metric: :my_metric,
+      metric: :my_metric
     }
   }
 end
@@ -628,7 +632,7 @@ trial.choose!
 trial.alternative.name
 
 # if the goal has been achieved, increment the successful completions for this alternative.
-if goal_acheived?
+if goal_achieved?
   trial.complete!
 end
 

data/lib/split.rb

@@ -6,6 +6,7 @@
    experiment
    experiment_catalog
    extensions
+   goals_collection
    helper
    metric
    persistence

data/lib/split/configuration.rb

@@ -19,6 +19,8 @@ module Split
     attr_accessor :on_trial_complete
     attr_accessor :on_experiment_reset
     attr_accessor :on_experiment_delete
+    attr_accessor :on_before_experiment_reset
+    attr_accessor :on_before_experiment_delete
     attr_accessor :include_rails_helper
     attr_accessor :beta_probability_simulations
     attr_accessor :redis_url
@@ -199,6 +201,8 @@ module Split
       @db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
       @on_experiment_reset = proc{|experiment|}
       @on_experiment_delete = proc{|experiment|}
+      @on_before_experiment_reset = proc{|experiment|}
+      @on_before_experiment_delete = proc{|experiment|}
       @db_failover_allow_parameter_override = false
       @allow_multiple_experiments = false
       @enabled = true

data/lib/split/experiment.rb

@@ -23,7 +23,7 @@ module Split
       if alternatives.empty? && (exp_config = Split.configuration.experiment_for(name))
         set_alternatives_and_options(
           alternatives: load_alternatives_from_configuration,
-          goals: load_goals_from_configuration,
+          goals: Split::GoalsCollection.new(@name).load_from_configuration,
           metadata: load_metadata_from_configuration,
           resettable: exp_config[:resettable],
           algorithm: exp_config[:algorithm]
@@ -60,7 +60,7 @@ module Split
         exp_config = Split.configuration.experiment_for(name)
         if exp_config
           alts = load_alternatives_from_configuration
-          options[:goals] = load_goals_from_configuration
+          options[:goals] = Split::GoalsCollection.new(@name).load_from_configuration
           options[:metadata] = load_metadata_from_configuration
           options[:resettable] = exp_config[:resettable]
           options[:algorithm] = exp_config[:algorithm]
@@ -84,21 +84,21 @@ module Split
         Split.redis.sadd(:experiments, name)
         start unless Split.configuration.start_manually
         @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
-        save_goals
+        goals_collection.save
         save_metadata
         Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
       else
         existing_alternatives = load_alternatives_from_redis
-        existing_goals = load_goals_from_redis
+        existing_goals = Split::GoalsCollection.new(@name).load_from_redis
         existing_metadata = load_metadata_from_redis
         unless existing_alternatives == @alternatives.map(&:name) && existing_goals == @goals && existing_metadata == @metadata
           reset
           @alternatives.each(&:delete)
-          delete_goals
+          goals_collection.delete
           delete_metadata
           Split.redis.del(@name)
           @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
-          save_goals
+          goals_collection.save
           save_metadata
         end
       end
@@ -113,9 +113,7 @@ module Split
         raise ExperimentNotFound.new("Experiment #{@name} not found")
       end
       @alternatives.each {|a| a.validate! }
-      unless @goals.nil? || goals.kind_of?(Array)
-        raise ArgumentError, 'Goals must be an array'
-      end
+      goals_collection.validate!
     end
 
     def new_record?
@@ -241,6 +239,7 @@ module Split
     end
 
     def reset
+      Split.configuration.on_before_experiment_reset.call(self)
       alternatives.each(&:reset)
       reset_winner
       Split.configuration.on_experiment_reset.call(self)
@@ -248,20 +247,20 @@ module Split
     end
 
     def delete
+      Split.configuration.on_before_experiment_delete.call(self)
+      if Split.configuration.start_manually
+        Split.redis.hdel(:experiment_start_times, @name)
+      end
       alternatives.each(&:delete)
       reset_winner
       Split.redis.srem(:experiments, name)
       Split.redis.del(name)
-      delete_goals
+      goals_collection.delete
       delete_metadata
       Split.configuration.on_experiment_delete.call(self)
       increment_version
     end
 
-    def delete_goals
-      Split.redis.del(goals_key)
-    end
-
     def delete_metadata
       Split.redis.del(metadata_key)
     end
@@ -271,7 +270,7 @@ module Split
       self.resettable = exp_config['resettable']
       self.algorithm = exp_config['algorithm']
       self.alternatives = load_alternatives_from_redis
-      self.goals = load_goals_from_redis
+      self.goals = Split::GoalsCollection.new(@name).load_from_redis
       self.metadata = load_metadata_from_redis
     end
 
@@ -419,19 +418,6 @@ module Split
       metadata = Split.configuration.experiment_for(@name)[:metadata]
     end
 
-    def load_goals_from_configuration
-      goals = Split.configuration.experiment_for(@name)[:goals]
-      if goals.nil?
-        goals = []
-      else
-        goals.flatten
-      end
-    end
-
-    def load_goals_from_redis
-      Split.redis.lrange(goals_key, 0, -1)
-    end
-
     def load_metadata_from_redis
       meta = Split.redis.get(metadata_key)
       JSON.parse(meta) unless meta.nil?
@@ -459,13 +445,14 @@ module Split
       end
     end
 
-    def save_goals
-      @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
-    end
-
     def save_metadata
       Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
     end
 
+    private
+
+    def goals_collection
+      Split::GoalsCollection.new(@name, @goals)
+    end
   end
 end

data/lib/split/goals_collection.rb

@@ -0,0 +1,44 @@
+module Split
+  class GoalsCollection
+
+    def initialize(experiment_name, goals=nil)
+      @experiment_name = experiment_name
+      @goals = goals
+    end
+
+    def load_from_redis
+      Split.redis.lrange(goals_key, 0, -1)
+    end
+
+    def load_from_configuration
+      goals = Split.configuration.experiment_for(@experiment_name)[:goals]
+
+      if goals.nil?
+        goals = []
+      else
+        goals.flatten
+      end
+    end
+
+    def save
+      return false if @goals.nil?
+      @goals.reverse.each { |goal| Split.redis.lpush(goals_key, goal) }
+    end
+
+    def validate!
+      unless @goals.nil? || @goals.kind_of?(Array)
+        raise ArgumentError, 'Goals must be an array'
+      end
+    end
+
+    def delete
+      Split.redis.del(goals_key)
+    end
+
+    private
+
+    def goals_key
+      "#{@experiment_name}:goals"
+    end
+  end
+end

data/lib/split/trial.rb

@@ -55,7 +55,7 @@ module Split
 
       if @options[:override]
         self.alternative = @options[:override]
-      elsif @options[:disabled] || !Split.configuration.enabled
+      elsif @options[:disabled] || Split.configuration.disabled?
         self.alternative = @experiment.control
       elsif @experiment.has_winner?
         self.alternative = @experiment.winner

data/lib/split/version.rb

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

data/spec/experiment_catalog_spec.rb

@@ -35,4 +35,19 @@ describe Split::ExperimentCatalog do
       expect(subject.find_or_create('my_exp', 'control me').control.to_s).to eq('control me')
     end
   end
+
+  describe '.find' do
+    it "should return an existing experiment" do
+      experiment = Split::Experiment.new('basket_text', alternatives: ['blue', 'red', 'green'])
+      experiment.save
+
+      experiment = subject.find('basket_text')
+
+      expect(experiment.name).to eq('basket_text')
+    end
+
+    it "should return nil if experiment not exist" do
+      expect(subject.find('non_existent_experiment')).to be_nil
+    end
+  end
 end

data/spec/experiment_spec.rb

@@ -104,18 +104,6 @@ describe Split::Experiment do
       end
     end
 
-    describe 'find' do
-      it "should return an existing experiment" do
-        experiment.save
-        experiment = Split::ExperimentCatalog.find('basket_text')
-        expect(experiment.name).to eq('basket_text')
-      end
-
-      it "should return an existing experiment" do
-        expect(Split::ExperimentCatalog.find('non_existent_experiment')).to be_nil
-      end
-    end
-
     describe 'control' do
       it 'should be the first alternative' do
         experiment.save
@@ -210,6 +198,18 @@ describe Split::Experiment do
       expect(Split.configuration.on_experiment_delete).to receive(:call)
       experiment.delete
     end
+
+    it "should call the on_before_experiment_delete hook" do
+      expect(Split.configuration.on_before_experiment_delete).to receive(:call)
+      experiment.delete
+    end
+
+    it 'should reset the start time if the experiment should be manually started' do
+      Split.configuration.start_manually = true
+      experiment.start
+      experiment.delete
+      expect(experiment.start_time).to be_nil
+    end
   end
 
 
@@ -276,6 +276,11 @@ describe Split::Experiment do
       expect(Split.configuration.on_experiment_reset).to receive(:call)
       experiment.reset
     end
+
+    it "should call the on_before_experiment_reset hook" do
+      expect(Split.configuration.on_before_experiment_reset).to receive(:call)
+      experiment.reset
+    end
   end
 
   describe 'algorithm' do
@@ -291,31 +296,38 @@ describe Split::Experiment do
     end
   end
 
-  describe 'next_alternative' do
-    let(:experiment) { Split::ExperimentCatalog.find_or_create('link_color', 'blue', 'red', 'green') }
+  describe '#next_alternative' do
+    context 'with multiple alternatives' do
+      let(:experiment) { Split::ExperimentCatalog.find_or_create('link_color', 'blue', 'red', 'green') }
 
-    it "should always return the winner if one exists" do
-      green = Split::Alternative.new('green', 'link_color')
-      experiment.winner = 'green'
+      context 'with winner' do
+        it "should always return the winner" do
+          green = Split::Alternative.new('green', 'link_color')
+          experiment.winner = 'green'
 
-      expect(experiment.next_alternative.name).to eq('green')
-      green.increment_participation
+          expect(experiment.next_alternative.name).to eq('green')
+          green.increment_participation
 
-      expect(experiment.next_alternative.name).to eq('green')
-    end
+          expect(experiment.next_alternative.name).to eq('green')
+        end
+      end
 
-    it "should use the specified algorithm if a winner does not exist" do
-      experiment.algorithm = Split::Algorithms::Whiplash
-      expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new('green', 'link_color'))
-      expect(experiment.next_alternative.name).to eq('green')
+      context 'without winner' do
+        it "should use the specified algorithm" do
+          experiment.algorithm = Split::Algorithms::Whiplash
+          expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new('green', 'link_color'))
+          expect(experiment.next_alternative.name).to eq('green')
+        end
+      end
     end
-  end
 
-  describe 'single alternative' do
-    let(:experiment) { Split::ExperimentCatalog.find_or_create('link_color', 'blue') }
+    context 'with single alternative' do
+      let(:experiment) { Split::ExperimentCatalog.find_or_create('link_color', 'blue') }
 
-    it "should always return the color blue" do
-      expect(experiment.next_alternative.name).to eq('blue')
+      it "should always return the only alternative" do
+        expect(experiment.next_alternative.name).to eq('blue')
+        expect(experiment.next_alternative.name).to eq('blue')
+      end
     end
   end
 
@@ -432,8 +444,7 @@ describe Split::Experiment do
 
     it "should return nil and not re-calculate probabilities if they have already been calculated today" do
       experiment = Split::ExperimentCatalog.find_or_create({'link_color3' => ["purchase", "refund"]}, 'blue', 'red', 'green')
-      experiment_calc_time = Time.now.utc.to_i / 86400
-      experiment.calc_time = experiment_calc_time
+      expect(experiment.calc_winning_alternatives).not_to be nil
       expect(experiment.calc_winning_alternatives).to be nil
     end
   end

data/spec/goals_collection_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'split/goals_collection'
+require 'time'
+
+describe Split::GoalsCollection do
+  let(:experiment_name) { 'experiment_name' }
+
+  describe 'initialization' do
+    let(:goals_collection) {
+      Split::GoalsCollection.new('experiment_name', ['goal1', 'goal2'])
+    }
+
+    it "should have an experiment_name" do
+      expect(goals_collection.instance_variable_get(:@experiment_name)).
+        to eq('experiment_name')
+    end
+
+    it "should have a list of goals" do
+      expect(goals_collection.instance_variable_get(:@goals)).
+        to eq(['goal1', 'goal2'])
+    end
+  end
+
+  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)
+    end
+
+    it "should raise ArgumentError if @goals is not an Array" do
+      goals_collection = Split::GoalsCollection.
+        new('experiment_name', 'not an array')
+      expect { goals_collection.validate! }.to raise_error(ArgumentError)
+    end
+
+    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)
+    end
+  end
+
+  describe "#delete" do
+    let(:goals_key) { "#{experiment_name}:goals" }
+
+    it "should delete goals from redis" do
+      goals_collection = Split::GoalsCollection.new(experiment_name, ['goal1'])
+      goals_collection.save
+
+      goals_collection.delete
+      expect(Split.redis.exists(goals_key)).to be false
+    end
+  end
+
+  describe "#save" do
+    let(:goals_key) { "#{experiment_name}:goals" }
+
+    it "should return false if @goals is nil" do
+      goals_collection = Split::GoalsCollection.
+        new(experiment_name, nil)
+
+      expect(goals_collection.save).to be false
+    end
+
+    it "should save goals to redis if @goals is valid" do
+      goals = ['valid goal 1', 'valid goal 2']
+      collection = Split::GoalsCollection.new(experiment_name, goals)
+      collection.save
+
+      expect(Split.redis.lrange(goals_key, 0, -1)).to eq goals
+    end
+
+    it "should return @goals if @goals is valid" do
+      goals_collection = Split::GoalsCollection.
+        new(experiment_name, ['valid goal'])
+
+      expect(goals_collection.save).to eq(['valid goal'])
+    end
+  end
+end

data/split.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack-test',   '~> 0.6'
   s.add_development_dependency 'rake',        '~> 11.1'
   s.add_development_dependency 'rspec',       '~> 3.4'
+  s.add_development_dependency 'pry',         '~> 0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: 
 email:
 - andrewnez@gmail.com
@@ -181,6 +195,7 @@ files:
 - lib/split/extensions.rb
 - lib/split/extensions/array.rb
 - lib/split/extensions/string.rb
+- lib/split/goals_collection.rb
 - lib/split/helper.rb
 - lib/split/metric.rb
 - lib/split/persistence.rb
@@ -199,6 +214,7 @@ files:
 - spec/encapsulated_helper_spec.rb
 - spec/experiment_catalog_spec.rb
 - spec/experiment_spec.rb
+- spec/goals_collection_spec.rb
 - spec/helper_spec.rb
 - spec/metric_spec.rb
 - spec/persistence/cookie_adapter_spec.rb
@@ -243,6 +259,7 @@ test_files:
 - spec/encapsulated_helper_spec.rb
 - spec/experiment_catalog_spec.rb
 - spec/experiment_spec.rb
+- spec/goals_collection_spec.rb
 - spec/helper_spec.rb
 - spec/metric_spec.rb
 - spec/persistence/cookie_adapter_spec.rb