split 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3b1309c8ead9c52a0d0d6fe52c9b7e14caf82ea
-  data.tar.gz: 79d96d59eb43b6ce77fd9822f4f324cf4cf8b1e7
+  metadata.gz: ea348c09640ba8869242588929d2d337856fc834
+  data.tar.gz: 0bb555acfabcaf683051058097da01b803c56a50
 SHA512:
-  metadata.gz: c206f354515025bfbb3acae7641c99216078493f0d3de1d4bcabee6224ce6b44fd920af04ded93c807c7a07d8167fe6fd6e4c3fe008b83e521d5332f62023c65
-  data.tar.gz: e7613adebd501d9a4caa5d1c68f41cbec9b6b363a4da61a086865e356ebd360761e39ec47bb6b8de567d1499b8d47ea39ba0015b67a120ef2e5fefacc1fe16c0
+  metadata.gz: f411a5636ee2fcc0c296f2e3e1e24515af7524be73eec1fe8bd86998564eb61fcc60419d52dc02588a92ac85ecb28c6525e9a007cc5607efe1942a56c1fa3262
+  data.tar.gz: 6ff0d6a3be6295653be81d34e0c2479c2d38bd8e1ac6a2fb0aa20e5796329add32cf465b884d5ede25ba9121343ae888de62e78f9aff5e468604f635c2efabb6

data/.travis.yml

@@ -1,32 +1,13 @@
 language: ruby
-bundler_args: ''
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - ruby-head
-  - jruby-19mode
-  - jruby-head
+  - 2.1.5
 
-  - rbx-19mode
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx-19mode
-    - rvm: jruby-head
-  exclude:
-    - rvm: 1.9.2
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: jruby-18mode
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: rbx-18mode
-      gemfile: gemfiles/4.0.gemfile
 gemfile:
-  - gemfiles/3.0.gemfile
-  - gemfiles/3.1.gemfile
   - gemfiles/3.2.gemfile
   - gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
 
 services:
    - redis-server
 cache: bundler
+sudo: false

data/Appraisals

@@ -1,15 +1,11 @@
-appraise "3.0" do
-  gem "rails", "~> 3.0.20"
-end
-
-appraise "3.1" do
-  gem "rails", "~> 3.1.12"
-end
-
 appraise "3.2" do
   gem "rails", "~> 3.2.13"
 end
 
 appraise "4.0" do
-  gem "rails", "4.0.0.rc1"
+  gem "rails", "~> 4.0.12"
+end
+
+appraise "4.1" do
+  gem "rails", "~> 4.1.8"
 end

data/{CHANGELOG.mdown → CHANGELOG.md}

@@ -1,3 +1,20 @@
+## 1.1.0 (January 9th, 2015)
+
+Features:
+
+  - Decouple trial from Split::Helper (@joshdover, #286)
+  - Helper method for Active Experiments (@blahblahblah-, #273)
+
+Misc:
+
+  - Use the new travis container based infrastructure for tests (@andrew, #280)
+
+## 1.0.0 (October 12th, 2014)
+
+Changes:
+
+  - Remove support for Ruby 1.8.7 and Rails 2.3 (@qpowell, #271)
+
 ## 0.8.0 (September 25th, 2014)
 
 Features:

data/Gemfile

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "appraisal"
+gem "appraisal"

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Andrew Nesbitt
+Copyright (c) 2015 Andrew Nesbitt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/{README.mdown → README.md}

@@ -220,7 +220,7 @@ Using Redis will allow ab_users to persist across sessions or machines.
 
 ```ruby
 Split.configure do |config|
-  config.persistence = Split::Persistence::RedisAdapter.with_config(:lookup_by => proc { |context| context.current_user_id }
+  config.persistence = Split::Persistence::RedisAdapter.with_config(:lookup_by => proc { |context| context.current_user_id })
   # Equivalent
   # config.persistence = Split::Persistence::RedisAdapter.with_config(:lookup_by => :current_user_id }
 end
@@ -638,18 +638,7 @@ Ryan bates has produced an excellent 10 minute screencast about split on the Rai
 
 ## Contributors
 
-Special thanks to the following people for submitting patches:
-
-* Lloyd Pick
-* Jeffery Chupp
-* Andrew Appleton
-* Phil Nash
-* Dave Goodchild
-* Ian Young
-* Nathan Woodhull
-* Ville Lautanala
-* Liu Jin
-* Peter Schröder
+Over 70 different people have contributed to the project, you can see them all here: https://github.com/andrew/split/graphs/contributors
 
 ## Development
 
@@ -672,4 +661,4 @@ Tests can be ran with `rake spec`
 
 ## Copyright
 
-Copyright (c) 2013 Andrew Nesbitt. See [LICENSE](https://github.com/andrew/split/blob/master/LICENSE) for details.
+Copyright (c) 2015 Andrew Nesbitt. See [LICENSE](https://github.com/andrew/split/blob/master/LICENSE) for details.

data/gemfiles/4.0.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "4.0.0.rc1"
+gem "rails", "~> 4.0.12"
 
 gemspec :path => "../"

data/gemfiles/{3.1.gemfile → 4.1.gemfile}

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 3.1.12"
+gem "rails", "~> 4.1.8"
 
 gemspec :path => "../"

data/lib/split/alternative.rb

@@ -104,7 +104,7 @@ module Split
     end
 
     def experiment
-      Split::Experiment.find(experiment_name)
+      Split::ExperimentCatalog.find(experiment_name)
     end
 
     def z_score(goal = nil)

data/lib/split/dashboard.rb

@@ -16,7 +16,7 @@ module Split
 
     get '/' do
       # Display experiments without a winner at the top of the dashboard
-      @experiments = Split::Experiment.all_active_first
+      @experiments = Split::ExperimentCatalog.all_active_first
 
       @metrics = Split::Metric.all
 
@@ -30,32 +30,32 @@ module Split
     end
 
     post '/:experiment' do
-      @experiment = Split::Experiment.find(params[:experiment])
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @alternative = Split::Alternative.new(params[:alternative], params[:experiment])
       @experiment.winner = @alternative.name
       redirect url('/')
     end
 
     post '/start/:experiment' do
-      @experiment = Split::Experiment.find(params[:experiment])
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.start
       redirect url('/')
     end
 
     post '/reset/:experiment' do
-      @experiment = Split::Experiment.find(params[:experiment])
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.reset
       redirect url('/')
     end
 
     post '/reopen/:experiment' do
-      @experiment = Split::Experiment.find(params[:experiment])
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.reset_winner
       redirect url('/')
     end
 
     delete '/:experiment' do
-      @experiment = Split::Experiment.find(params[:experiment])
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.delete
       redirect url('/')
     end

data/lib/split/experiment.rb

@@ -1,4 +1,4 @@
-  module Split
+module Split
   class Experiment
     attr_accessor :name
     attr_writer :algorithm
@@ -8,7 +8,7 @@
     attr_accessor :alternative_probabilities
 
     DEFAULT_OPTIONS = {
-      :resettable => true,
+      :resettable => true
     }
 
     def initialize(name, options = {})
@@ -71,23 +71,6 @@
       alts
     end
 
-    def self.all
-      ExperimentCatalog.all
-    end
-
-    # Return experiments without a winner (considered "active") first
-    def self.all_active_first
-      ExperimentCatalog.all_active_first
-    end
-
-    def self.find(name)
-      ExperimentCatalog.find(name)
-    end
-
-    def self.find_or_create(label, *alternatives)
-      ExperimentCatalog.find_or_create(label, *alternatives)
-    end
-
     def save
       validate!
 

data/lib/split/experiment_catalog.rb

@@ -21,23 +21,32 @@ module Split
       obj
     end
 
-    def self.find_or_create(label, *alternatives)
-      experiment_name_with_version, goals = normalize_experiment(label)
-      name = experiment_name_with_version.to_s.split(':')[0]
+    def self.find_or_initialize(metric_descriptor, control = nil, *alternatives)
+      # 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
+
+      experiment_name_with_version, goals = normalize_experiment(metric_descriptor)
+      experiment_name = experiment_name_with_version.to_s.split(':')[0]
+      Split::Experiment.new(experiment_name,
+          :alternatives => [control].compact + alternatives, :goals => goals)
+    end
 
-      exp = Experiment.new name, :alternatives => alternatives, :goals => goals
-      exp.save
-      exp
+    def self.find_or_create(metric_descriptor, control = nil, *alternatives)
+      experiment = find_or_initialize(metric_descriptor, control, *alternatives)
+      experiment.save
     end
 
     private
 
-    def self.normalize_experiment(label)
-      if Hash === label
-        experiment_name = label.keys.first
-        goals = label.values.first
+    def self.normalize_experiment(metric_descriptor)
+      if Hash === metric_descriptor
+        experiment_name = metric_descriptor.keys.first
+        goals = Array(metric_descriptor.values.first)
       else
-        experiment_name = label
+        experiment_name = metric_descriptor
         goals = []
       end
       return experiment_name, goals

data/lib/split/helper.rb

@@ -1,51 +1,42 @@
 module Split
   module Helper
 
-    def ab_test(metric_descriptor, control=nil, *alternatives)
-
-      # 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
-
+    def ab_test(metric_descriptor, control = nil, *alternatives)
       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
-
-        ret = if Split.configuration.enabled
+        experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
+
+        alternative = if Split.configuration.enabled
           experiment.save
-          start_trial( Trial.new(:experiment => experiment) )
+          trial = Trial.new(:user => ab_user, :experiment => experiment,
+              :override => override_alternative(experiment.name), :exclude => exclude_visitor?,
+              :disabled => split_generically_disabled?)
+          alt = trial.choose!(self)
+          alt ? alt.name : nil
         else
-          control_variable(control)
+          control_variable(experiment.control)
         end
       rescue Errno::ECONNREFUSED, Redis::CannotConnectError => e
         raise(e) unless Split.configuration.db_failover
         Split.configuration.db_failover_on_db_error.call(e)
 
         if Split.configuration.db_failover_allow_parameter_override
-          ret = override_alternative(experiment_name) if override_present?(experiment_name)
-          ret = control_variable(control) if split_generically_disabled?
+          alternative = override_alternative(experiment.name) if override_present?(experiment.name)
+          alternative = control_variable(experiment.control) if split_generically_disabled?
         end
       ensure
-        ret ||= control_variable(control)
+        alternative ||= control_variable(experiment.control)
       end
 
       if block_given?
         if defined?(capture) # a block in a rails view
-          block = Proc.new { yield(ret) }
-          concat(capture(ret, &block))
+          block = Proc.new { yield(alternative) }
+          concat(capture(alternative, &block))
           false
         else
-          yield(ret)
+          yield(alternative)
         end
       else
-        ret
+        alternative
       end
     end
 
@@ -60,8 +51,9 @@ module Split
         return true
       else
         alternative_name = ab_user[experiment.key]
-        trial = Trial.new(:experiment => experiment, :alternative => alternative_name, :goals => options[:goals])
-        call_trial_complete_hook(trial) if trial.complete!
+        trial = Trial.new(:user => ab_user, :experiment => experiment,
+              :alternative => alternative_name)
+        trial.complete!(options[:goals], self)
 
         if should_reset
           reset!(experiment)
@@ -74,7 +66,7 @@ module Split
 
     def finished(metric_descriptor, options = {:reset => true})
       return if exclude_visitor? || Split.configuration.disabled?
-      metric_descriptor, goals = normalize_experiment(metric_descriptor)
+      metric_descriptor, goals = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
 
       if experiments.any?
@@ -110,30 +102,7 @@ module Split
     end
 
     def exclude_visitor?
-      instance_eval(&Split.configuration.ignore_filter)
-    end
-
-    def not_allowed_to_test?(experiment_key)
-      !Split.configuration.allow_multiple_experiments && doing_other_tests?(experiment_key)
-    end
-
-    def doing_other_tests?(experiment_key)
-      keys_without_experiment(ab_user.keys, experiment_key).length > 0
-    end
-
-    def clean_old_versions(experiment)
-      old_versions(experiment).each do |old_key|
-        ab_user.delete old_key
-      end
-    end
-
-    def old_versions(experiment)
-      if experiment.version > 0
-        keys = ab_user.keys.select { |k| k.match(Regexp.new(experiment.name)) }
-        keys_without_experiment(keys, experiment.key)
-      else
-        []
-      end
+      instance_eval(&Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot?
     end
 
     def is_robot?
@@ -149,9 +118,21 @@ module Split
       false
     end
 
+    def active_experiments
+      experiment_pairs = {}
+      ab_user.keys.each do |key|
+        Metric.possible_experiments(key).each do |experiment|
+          if !experiment.has_winner?
+            experiment_pairs[key] = ab_user[key]
+          end
+        end
+      end
+      return experiment_pairs
+    end
+
     protected
 
-    def normalize_experiment(metric_descriptor)
+    def normalize_metric(metric_descriptor)
       if Hash === metric_descriptor
         experiment_name = metric_descriptor.keys.first
         goals = Array(metric_descriptor.values.first)
@@ -163,51 +144,7 @@ module Split
     end
 
     def control_variable(control)
-      Hash === control ? control.keys.first : control
-    end
-
-    def start_trial(trial)
-      experiment = trial.experiment
-      if override_present?(experiment.name) and experiment[override_alternative(experiment.name)]
-        ret = override_alternative(experiment.name)
-        ab_user[experiment.key] = ret if Split.configuration.store_override
-      elsif split_generically_disabled?
-        ret = experiment.control.name
-        ab_user[experiment.key] = ret if Split.configuration.store_override
-      elsif experiment.has_winner?
-        ret = experiment.winner.name
-      else
-        clean_old_versions(experiment)
-        if exclude_visitor? || not_allowed_to_test?(experiment.key) || not_started?(experiment)
-          ret = experiment.control.name
-        else
-          if ab_user[experiment.key]
-            ret = ab_user[experiment.key]
-          else
-            trial.choose!
-            call_trial_choose_hook(trial)
-            ret = begin_experiment(experiment, trial.alternative.name)
-          end
-        end
-      end
-
-      ret
-    end
-
-    def not_started?(experiment)
-      experiment.start_time.nil?
-    end
-
-    def call_trial_choose_hook(trial)
-      send(Split.configuration.on_trial_choose, trial) if Split.configuration.on_trial_choose
-    end
-
-    def call_trial_complete_hook(trial)
-      send(Split.configuration.on_trial_complete, trial) if Split.configuration.on_trial_complete
-    end
-
-    def keys_without_experiment(keys, experiment_key)
-      keys.reject { |k| k.match(Regexp.new("^#{experiment_key}(:finished)?$")) }
+      Hash === control ? control.keys.first.to_s : control.to_s
     end
   end
 end