split 3.3.2 → 4.0.0.pre2

data/lib/split/configuration.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
+
 module Split
   class Configuration
-    attr_accessor :bots
-    attr_accessor :robot_regex
     attr_accessor :ignore_ip_addresses
     attr_accessor :ignore_filter
     attr_accessor :db_failover
@@ -12,6 +11,7 @@ module Split
     attr_accessor :enabled
     attr_accessor :persistence
     attr_accessor :persistence_cookie_length
+    attr_accessor :persistence_cookie_domain
     attr_accessor :algorithm
     attr_accessor :store_override
     attr_accessor :start_manually
@@ -22,14 +22,20 @@ module Split
     attr_accessor :on_experiment_reset
     attr_accessor :on_experiment_delete
     attr_accessor :on_before_experiment_reset
+    attr_accessor :on_experiment_winner_choose
     attr_accessor :on_before_experiment_delete
     attr_accessor :include_rails_helper
     attr_accessor :beta_probability_simulations
     attr_accessor :winning_alternative_recalculation_interval
     attr_accessor :redis
+    attr_accessor :dashboard_pagination_default_per_page
+    attr_accessor :cache
 
     attr_reader :experiments
 
+    attr_writer :bots
+    attr_writer :robot_regex
+
     def bots
       @bots ||= {
         # Indexers
@@ -82,7 +88,7 @@ module Split
         'LinkedInBot' => 'LinkedIn bot',
         'LongURL' => 'URL expander service',
         'NING' => 'NING - Yet Another Twitter Swarmer',
-        'Pinterest' => 'Pinterest Bot',
+        'Pinterestbot' => 'Pinterest Bot',
         'redditbot' => 'Reddit Bot',
         'ShortLinkTranslate' => 'Link shortener',
         'Slackbot' => 'Slackbot link expander',
@@ -171,7 +177,7 @@ module Split
     end
 
     def normalize_alternatives(alternatives)
-      given_probability, num_with_probability = alternatives.inject([0,0]) do |a,v|
+      given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
         p, n = a
         if percent = value_for(v, :percent)
           [p + percent, n + 1]
@@ -214,27 +220,20 @@ module Split
       @on_experiment_delete = proc{|experiment|}
       @on_before_experiment_reset = proc{|experiment|}
       @on_before_experiment_delete = proc{|experiment|}
+      @on_experiment_winner_choose = proc{|experiment|}
       @db_failover_allow_parameter_override = false
       @allow_multiple_experiments = false
       @enabled = true
       @experiments = {}
       @persistence = Split::Persistence::SessionAdapter
       @persistence_cookie_length = 31536000 # One year from now
+      @persistence_cookie_domain = nil
       @algorithm = Split::Algorithms::WeightedSample
       @include_rails_helper = true
       @beta_probability_simulations = 10000
       @winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
       @redis = ENV.fetch(ENV.fetch('REDIS_PROVIDER', 'REDIS_URL'), 'redis://localhost:6379')
-    end
-
-    def redis_url=(value)
-      warn '[DEPRECATED] `redis_url=` is deprecated in favor of `redis=`'
-      self.redis = value
-    end
-
-    def redis_url
-      warn '[DEPRECATED] `redis_url` is deprecated in favor of `redis`'
-      self.redis
+      @dashboard_pagination_default_per_page = 10
     end
 
     private

data/lib/split/dashboard/helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module DashboardHelpers
     def h(text)

data/lib/split/dashboard/pagination_helpers.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
+
 require 'split/dashboard/paginator'
 
 module Split
   module DashboardPaginationHelpers
-    DEFAULT_PER = 10
-
     def pagination_per
-      @pagination_per ||= (params[:per] || DEFAULT_PER).to_i
+      default_per_page = Split.configuration.dashboard_pagination_default_per_page
+      @pagination_per ||= (params[:per] || default_per_page).to_i
     end
 
     def page_number

data/lib/split/dashboard/paginator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class DashboardPaginator
     def initialize(collection, page_number, per)

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

@@ -22,3 +22,13 @@ function confirmReopen() {
   var agree = confirm("This will reopen the experiment. Are you sure?");
   return agree ? true : false;
 }
+
+function confirmEnableCohorting(){
+  var agree = confirm("This will enable the cohorting of the experiment. Are you sure?");
+  return agree ? true : false;
+}
+
+function confirmDisableCohorting(){
+  var agree = confirm("This will disable the cohorting of the experiment. Note: Existing participants will continue to receive their alternative and may continue to convert. Are you sure?");
+  return agree ? true : false;
+}

data/lib/split/dashboard/public/style.css

@@ -326,3 +326,8 @@ a.button.green:focus, button.green:focus, input[type="submit"].green:focus {
   display: inline-block;
   padding: 5px;
 }
+
+.divider {
+  display: inline-block;
+  margin-left: 10px;
+}

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

@@ -2,7 +2,20 @@
   <form action="<%= url "/reopen?experiment=#{experiment.name}" %>" method='post' onclick="return confirmReopen()">
     <input type="submit" value="Reopen Experiment">
   </form>
+<% else %>
+  <% if experiment.cohorting_disabled? %>
+    <form action="<%= url "/update_cohorting?experiment=#{experiment.name}" %>" method='post' onclick="return confirmEnableCohorting()">
+      <input type="hidden" name="cohorting_action" value="enable">
+      <input type="submit" value="Enable Cohorting" class="green">
+    </form>
+  <% else %>
+    <form action="<%= url "/update_cohorting?experiment=#{experiment.name}" %>" method='post' onclick="return confirmDisableCohorting()">
+      <input type="hidden" name="cohorting_action" value="disable">
+      <input type="submit" value="Disable Cohorting" class="red">
+    </form>
+  <% end %>
 <% end %>
+<span class="divider">|</span>
 <% if experiment.start_time %>
   <form action="<%= url "/reset?experiment=#{experiment.name}" %>" method='post' onclick="return confirmReset()">
     <input type="submit" value="Reset Data">

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

@@ -21,7 +21,7 @@
   </div>
 
   <div id="footer">
-    <p>Powered by <a href="http://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
+    <p>Powered by <a href="https://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
   </div>
 </body>
 </html>

data/lib/split/dashboard.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'sinatra/base'
 require 'split'
 require 'bigdecimal'
@@ -33,7 +34,13 @@ module Split
     end
 
     post '/force_alternative' do
-      Split::User.new(self)[params[:experiment]] = params[:alternative]
+      experiment = Split::ExperimentCatalog.find(params[:experiment])
+      alternative = Split::Alternative.new(params[:alternative], experiment.name)
+
+      cookies = JSON.parse(request.cookies['split_override']) rescue {}
+      cookies[experiment.name] = alternative.name
+      response.set_cookie('split_override', { value: cookies.to_json, path: '/' })
+
       redirect url('/')
     end
 
@@ -62,6 +69,17 @@ module Split
       redirect url('/')
     end
 
+    post '/update_cohorting' do
+      @experiment = Split::ExperimentCatalog.find(params[:experiment])
+      case params[:cohorting_action].downcase
+      when "enable"
+        @experiment.enable_cohorting
+      when "disable"
+        @experiment.disable_cohorting
+      end
+      redirect url('/')
+    end
+
     delete '/experiment' do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.delete

data/lib/split/encapsulated_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "split/helper"
 
 # Split's helper exposes all kinds of methods we don't want to
@@ -28,8 +29,8 @@ module Split
       end
     end
 
-    def ab_test(*arguments,&block)
-      split_context_shim.ab_test(*arguments,&block)
+    def ab_test(*arguments, &block)
+      split_context_shim.ab_test(*arguments, &block)
     end
 
     private

data/lib/split/engine.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
+
 module Split
   class Engine < ::Rails::Engine
     initializer "split" do |app|
       if Split.configuration.include_rails_helper
-        ActionController::Base.send :include, Split::Helper
-        ActionController::Base.helper Split::Helper
-        ActionController::Base.send :include, Split::CombinedExperimentsHelper
-        ActionController::Base.helper Split::CombinedExperimentsHelper
+        ActiveSupport.on_load(:action_controller) do
+          ::ActionController::Base.send :include, Split::Helper
+          ::ActionController::Base.helper Split::Helper
+          ::ActionController::Base.send :include, Split::CombinedExperimentsHelper
+          ::ActionController::Base.helper Split::CombinedExperimentsHelper
+        end
       end
     end
   end

data/lib/split/exceptions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class InvalidPersistenceAdapterError < StandardError; end
   class ExperimentNotFound < StandardError; end

data/lib/split/experiment.rb

@@ -1,38 +1,34 @@
 # frozen_string_literal: true
+
+require 'rubystats'
+
 module Split
   class Experiment
     attr_accessor :name
-    attr_writer :algorithm
-    attr_accessor :resettable
     attr_accessor :goals
-    attr_accessor :alternatives
     attr_accessor :alternative_probabilities
     attr_accessor :metadata
 
+    attr_reader :alternatives
+    attr_reader :resettable
+
     DEFAULT_OPTIONS = {
       :resettable => true
     }
 
+    def self.find(name)
+      Split.cache(:experiments, name) do
+        return unless Split.redis.exists?(name)
+        Experiment.new(name).tap { |exp| exp.load_from_redis }
+      end
+    end
+
     def initialize(name, options = {})
       options = DEFAULT_OPTIONS.merge(options)
 
       @name = name.to_s
 
-      alternatives = extract_alternatives_from_options(options)
-
-      if alternatives.empty? && (exp_config = Split.configuration.experiment_for(name))
-        options = {
-          alternatives: load_alternatives_from_configuration,
-          goals: Split::GoalsCollection.new(@name).load_from_configuration,
-          metadata: load_metadata_from_configuration,
-          resettable: exp_config[:resettable],
-          algorithm: exp_config[:algorithm]
-        }
-      else
-        options[:alternatives] = alternatives
-      end
-
-      set_alternatives_and_options(options)
+      extract_alternatives_from_options(options)
     end
 
     def self.finished_key(key)
@@ -40,11 +36,15 @@ module Split
     end
 
     def set_alternatives_and_options(options)
-      self.alternatives = options[:alternatives]
-      self.goals = options[:goals]
-      self.resettable = options[:resettable]
-      self.algorithm = options[:algorithm]
-      self.metadata = options[:metadata]
+      options_with_defaults = DEFAULT_OPTIONS.merge(
+        options.reject { |k, v| v.nil? }
+      )
+
+      self.alternatives = options_with_defaults[:alternatives]
+      self.goals = options_with_defaults[:goals]
+      self.resettable = options_with_defaults[:resettable]
+      self.algorithm = options_with_defaults[:algorithm]
+      self.metadata = options_with_defaults[:metadata]
     end
 
     def extract_alternatives_from_options(options)
@@ -52,7 +52,7 @@ module Split
 
       if alts.length == 1
         if alts[0].is_a? Hash
-          alts = alts[0].map{|k,v| {k => v} }
+          alts = alts[0].map{|k, v| {k => v} }
         end
       end
 
@@ -81,14 +81,14 @@ module Split
 
       if new_record?
         start unless Split.configuration.start_manually
+        persist_experiment_configuration
       elsif experiment_configuration_has_changed?
         reset unless Split.configuration.reset_manually
+        persist_experiment_configuration
       end
 
-      persist_experiment_configuration if new_record? || experiment_configuration_has_changed?
-
-      redis.hset(experiment_config_key, :resettable, resettable)
-      redis.hset(experiment_config_key, :algorithm, algorithm.to_s)
+      redis.hmset(experiment_config_key, :resettable, resettable,
+                                         :algorithm, algorithm.to_s)
       self
     end
 
@@ -101,7 +101,7 @@ module Split
     end
 
     def new_record?
-      !redis.exists(name)
+      ExperimentCatalog.find(name).nil?
     end
 
     def ==(obj)
@@ -135,24 +135,29 @@ module Split
     end
 
     def winner
-      experiment_winner = redis.hget(:experiment_winner, name)
-      if experiment_winner
-        Split::Alternative.new(experiment_winner, name)
-      else
-        nil
+      Split.cache(:experiment_winner, name) do
+        experiment_winner = redis.hget(:experiment_winner, name)
+        if experiment_winner
+          Split::Alternative.new(experiment_winner, name)
+        else
+          nil
+        end
       end
     end
 
     def has_winner?
-      !winner.nil?
+      return @has_winner if defined? @has_winner
+      @has_winner = !winner.nil?
     end
 
     def winner=(winner_name)
       redis.hset(:experiment_winner, name, winner_name.to_s)
+      @has_winner = true
+      Split.configuration.on_experiment_winner_choose.call(self)
     end
 
     def participant_count
-      alternatives.inject(0){|sum,a| sum + a.participant_count}
+      alternatives.inject(0){|sum, a| sum + a.participant_count}
     end
 
     def control
@@ -161,6 +166,8 @@ module Split
 
     def reset_winner
       redis.hdel(:experiment_winner, name)
+      @has_winner = false
+      Split::Cache.clear_key(@name)
     end
 
     def start
@@ -168,13 +175,15 @@ module Split
     end
 
     def start_time
-      t = redis.hget(:experiment_start_times, @name)
-      if t
-        # Check if stored time is an integer
-        if t =~ /^[-+]?[0-9]+$/
-          Time.at(t.to_i)
-        else
-          Time.parse(t)
+      Split.cache(:experiment_start_times, @name) do
+        t = redis.hget(:experiment_start_times, @name)
+        if t
+          # Check if stored time is an integer
+          if t =~ /^[-+]?[0-9]+$/
+            Time.at(t.to_i)
+          else
+            Time.parse(t)
+          end
         end
       end
     end
@@ -225,6 +234,7 @@ module Split
 
     def reset
       Split.configuration.on_before_experiment_reset.call(self)
+      Split::Cache.clear_key(@name)
       alternatives.each(&:reset)
       reset_winner
       Split.configuration.on_experiment_reset.call(self)
@@ -238,6 +248,7 @@ module Split
       end
       reset_winner
       redis.srem(:experiments, name)
+      remove_experiment_cohorting
       remove_experiment_configuration
       Split.configuration.on_experiment_delete.call(self)
       increment_version
@@ -335,7 +346,7 @@ module Split
 
     def find_simulated_winner(simulated_cr_hash)
       # figure out which alternative had the highest simulated conversion rate
-      winning_pair = ["",0.0]
+      winning_pair = ["", 0.0]
       simulated_cr_hash.each do |alternative, rate|
         if rate > winning_pair[1]
           winning_pair = [alternative, rate]
@@ -346,17 +357,13 @@ module Split
     end
 
     def calc_simulated_conversion_rates(beta_params)
-      # initialize a random variable (from which to simulate conversion rates ~beta-distributed)
-      rand = SimpleRandom.new
-      rand.set_seed
-
       simulated_cr_hash = {}
 
       # create a hash which has the conversion rate pulled from each alternative's beta distribution
       beta_params.each do |alternative, params|
         alpha = params[0]
         beta = params[1]
-        simulated_conversion_rate = rand.beta(alpha, beta)
+        simulated_conversion_rate = Rubystats::BetaDistribution.new(alpha, beta).rng
         simulated_cr_hash[alternative] = simulated_conversion_rate
       end
 
@@ -394,6 +401,23 @@ module Split
       js_id.gsub('/', '--')
     end
 
+    def cohorting_disabled?
+      @cohorting_disabled ||= begin
+        value = redis.hget(experiment_config_key, :cohorting)
+        value.nil? ? false : value.downcase == "true"
+      end
+    end
+
+    def disable_cohorting
+      @cohorting_disabled = true
+      redis.hset(experiment_config_key, :cohorting, true)
+    end
+
+    def enable_cohorting
+      @cohorting_disabled = false
+      redis.hset(experiment_config_key, :cohorting, false)
+    end
+
     protected
 
     def experiment_config_key
@@ -420,14 +444,14 @@ module Split
     end
 
     def load_alternatives_from_redis
-      case redis.type(@name)
-      when 'set' # convert legacy sets to lists
-        alts = redis.smembers(@name)
-        redis.del(@name)
-        alts.reverse.each {|a| redis.lpush(@name, a) }
-        redis.lrange(@name, 0, -1)
-      else
-        redis.lrange(@name, 0, -1)
+      alternatives = redis.lrange(@name, 0, -1)
+      alternatives.map do |alt|
+        alt = begin
+                JSON.parse(alt)
+              rescue
+                alt
+              end
+        Split::Alternative.new(alt, @name)
       end
     end
 
@@ -443,9 +467,14 @@ module Split
 
     def persist_experiment_configuration
       redis_interface.add_to_set(:experiments, name)
-      redis_interface.persist_list(name, @alternatives.map(&:name))
+      redis_interface.persist_list(name, @alternatives.map{|alt| {alt.name => alt.weight}.to_json})
       goals_collection.save
-      redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
+
+      if @metadata
+        redis.set(metadata_key, @metadata.to_json)
+      else
+        delete_metadata
+      end
     end
 
     def remove_experiment_configuration
@@ -456,16 +485,20 @@ module Split
     end
 
     def experiment_configuration_has_changed?
-      existing_alternatives = load_alternatives_from_redis
-      existing_goals = Split::GoalsCollection.new(@name).load_from_redis
-      existing_metadata = load_metadata_from_redis
-      existing_alternatives != @alternatives.map(&:name) ||
-        existing_goals != @goals ||
-        existing_metadata != @metadata
+      existing_experiment = Experiment.find(@name)
+
+      existing_experiment.alternatives.map(&:to_s) != @alternatives.map(&:to_s) ||
+        existing_experiment.goals != @goals ||
+        existing_experiment.metadata != @metadata
     end
 
     def goals_collection
       Split::GoalsCollection.new(@name, @goals)
     end
+
+    def remove_experiment_cohorting
+      @cohorting_disabled = false
+      redis.hdel(experiment_config_key, :cohorting)
+    end
   end
 end

data/lib/split/experiment_catalog.rb

@@ -13,8 +13,7 @@ module Split
     end
 
     def self.find(name)
-      return unless Split.redis.exists(name)
-      Experiment.new(name).tap { |exp| exp.load_from_redis }
+      Experiment.find(name)
     end
 
     def self.find_or_initialize(metric_descriptor, control = nil, *alternatives)
@@ -46,6 +45,5 @@ module Split
       return experiment_name, goals
     end
     private_class_method :normalize_experiment
-
   end
 end

data/lib/split/extensions/string.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class String
   # Constatntize is often provided by ActiveSupport, but ActiveSupport is not a dependency of Split.
   unless method_defined?(:constantize)

data/lib/split/goals_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Split
   class GoalsCollection