split 3.0.0 → 4.0.1

data/gemfiles/6.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "codeclimate-test-reporter"
+gem "rails", "~> 6.1"
+
+gemspec path: "../"

data/gemfiles/7.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "codeclimate-test-reporter"
+gem "rails", "~> 7.0"
+
+gemspec path: "../"

data/lib/split/algorithms/block_randomization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Selects alternative with minimum count of participants
 # If all counts are even (i.e. all are minimum), samples from all possible alternatives
 

data/lib/split/algorithms/weighted_sample.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module Algorithms
     module WeightedSample
@@ -8,7 +9,7 @@ module Split
         total = weights.inject(:+)
         point = rand * total
 
-        experiment.alternatives.zip(weights).each do |n,w|
+        experiment.alternatives.zip(weights).each do |n, w|
           return n if w >= point
           point -= w
         end

data/lib/split/algorithms/whiplash.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 # A multi-armed bandit implementation inspired by
 # @aaronsw and victorykit/whiplash
-require 'simple-random'
+require 'rubystats'
 
 module Split
   module Algorithms
@@ -16,7 +17,7 @@ module Split
         def arm_guess(participants, completions)
           a = [participants, 0].max
           b = [participants-completions, 0].max
-          s = SimpleRandom.new; s.set_seed; s.beta(a+fairness_constant, b+fairness_constant)
+          Rubystats::BetaDistribution.new(a+fairness_constant, b+fairness_constant).rng
         end
 
         def best_guess(alternatives)

data/lib/split/alternative.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   class Alternative
     attr_accessor :name
@@ -15,7 +16,7 @@ module Split
         @name = name
         @weight = 1
       end
-      p_winner = 0.0
+      @p_winner = 0.0
     end
 
     def to_s
@@ -75,7 +76,7 @@ module Split
       return field
     end
 
-    def set_completed_count (count, goal = nil)
+    def set_completed_count(count, goal = nil)
       field = set_field(goal)
       Split.redis.hset(key, field, count.to_i)
     end
@@ -119,7 +120,10 @@ module Split
       n_a = alternative.participant_count
       n_c = control.participant_count
 
-      z_score = Split::Zscore.calculate(p_a, n_a, p_c, n_c)
+      # can't calculate zscore for P(x) > 1
+      return 'N/A' if p_a > 1 || p_c > 1
+
+      Split::Zscore.calculate(p_a, n_a, p_c, n_c)
     end
 
     def extra_info

data/lib/split/cache.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Split
+  class Cache
+
+    def self.clear
+      @cache = nil
+    end
+
+    def self.fetch(namespace, key)
+      return yield unless Split.configuration.cache
+
+      @cache ||= {}
+      @cache[namespace] ||= {}
+
+      value = @cache[namespace][key]
+      return value if value
+
+      @cache[namespace][key] = yield
+    end
+
+    def self.clear_key(key)
+      @cache&.keys&.each do |namespace|
+        @cache[namespace]&.delete(key)
+      end
+    end
+  end
+end

data/lib/split/combined_experiments_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Split
+  module CombinedExperimentsHelper
+    def ab_combined_test(metric_descriptor, control = nil, *alternatives)
+      return nil unless experiment = find_combined_experiment(metric_descriptor)
+      raise(Split::InvalidExperimentsFormatError, "Unable to find experiment #{metric_descriptor} in configuration") if experiment[:combined_experiments].nil?
+
+      alternative = nil
+      weighted_alternatives = nil
+      experiment[:combined_experiments].each do |combined_experiment|
+        if alternative.nil?
+          if control
+            alternative = ab_test(combined_experiment, control, alternatives)
+          else
+            normalized_alternatives = Split::Configuration.new.normalize_alternatives(experiment[:alternatives])
+            alternative = ab_test(combined_experiment, normalized_alternatives[0], *normalized_alternatives[1])
+          end
+        else
+          weighted_alternatives ||= experiment[:alternatives].each_with_object({}) do |alt, memo|
+            alt = Alternative.new(alt, experiment[:name]).name
+            memo[alt] = (alt == alternative ? 1 : 0)
+          end
+
+          ab_test(combined_experiment, [weighted_alternatives])
+        end
+      end
+      alternative
+    end
+
+    def find_combined_experiment(metric_descriptor)
+      raise(Split::InvalidExperimentsFormatError, 'Invalid descriptor class (String or Symbol required)') unless metric_descriptor.class == String || metric_descriptor.class == Symbol
+      raise(Split::InvalidExperimentsFormatError, 'Enable configuration') unless Split.configuration.enabled
+      raise(Split::InvalidExperimentsFormatError, 'Enable `allow_multiple_experiments`') unless Split.configuration.allow_multiple_experiments
+      Split::configuration.experiments[metric_descriptor.to_sym]
+    end
+  end
+end

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,13 +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
@@ -48,7 +55,9 @@ module Split
         'spider' => 'generic web spider',
         'UnwindFetchor' => 'Gnip crawler',
         'WordPress' => 'WordPress spider',
+        'YandexAccessibilityBot' => 'Yandex accessibility spider',
         'YandexBot' => 'Yandex spider',
+        'YandexMobileBot' => 'Yandex mobile spider',
         'ZIBB' => 'ZIBB spider',
 
         # HTTP libraries
@@ -58,12 +67,14 @@ module Split
         'ColdFusion' => 'ColdFusion http library',
         'EventMachine HttpClient' => 'Ruby http library',
         'Go http package' => 'Go http library',
+        'Go-http-client' => 'Go http library',
         'Java' => 'Generic Java http library',
         'libwww-perl' => 'Perl client-server library loved by script kids',
         'lwp-trivial' => 'Another Perl library loved by script kids',
         'Python-urllib' => 'Python http library',
         'PycURL' => 'Python http library',
         'Test Certificate Info' => 'C http library?',
+        'Typhoeus' => 'Ruby http library',
         'Wget' => 'wget unix CLI http client',
 
         # URL expanders / previewers
@@ -71,12 +82,16 @@ module Split
         'bitlybot' => 'bit.ly bot',
         'bot@linkfluence.net' => 'Linkfluence bot',
         'facebookexternalhit' => 'facebook bot',
+        'Facebot' => 'Facebook crawler',
         'Feedfetcher-Google' => 'Google Feedfetcher',
         'https://developers.google.com/+/web/snippet' => 'Google+ Snippet Fetcher',
+        'LinkedInBot' => 'LinkedIn bot',
         'LongURL' => 'URL expander service',
         'NING' => 'NING - Yet Another Twitter Swarmer',
+        'Pinterestbot' => 'Pinterest Bot',
         'redditbot' => 'Reddit Bot',
         'ShortLinkTranslate' => 'Link shortener',
+        'Slackbot' => 'Slackbot link expander',
         'TweetmemeBot' => 'TweetMeMe Crawler',
         'Twitterbot' => 'Twitter URL expander',
         'UnwindFetch' => 'Gnip URL expander',
@@ -84,10 +99,12 @@ module Split
 
         # Uptime monitoring
         'check_http' => 'Nagios monitor',
+        'GoogleStackdriverMonitoring' => 'Google Cloud monitor',
         'NewRelicPinger' => 'NewRelic monitor',
         'Panopta' => 'Monitoring service',
         'Pingdom' => 'Pingdom monitoring',
         'SiteUptime' => 'Site monitoring services',
+        'UptimeRobot' => 'Monitoring service',
 
         # ???
         'DigitalPersona Fingerprint Software' => 'HP Fingerprint scanner',
@@ -160,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]
@@ -203,26 +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)
@@ -19,9 +20,9 @@ module Split
 
     def round(number, precision = 2)
       begin
-        BigDecimal.new(number.to_s)
+        BigDecimal(number.to_s)
       rescue ArgumentError
-        BigDecimal.new(0)
+        BigDecimal(0)
       end.round(precision).to_f
     end
 

data/lib/split/dashboard/pagination_helpers.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'split/dashboard/paginator'
+
+module Split
+  module DashboardPaginationHelpers
+    def pagination_per
+      default_per_page = Split.configuration.dashboard_pagination_default_per_page
+      @pagination_per ||= (params[:per] || default_per_page).to_i
+    end
+
+    def page_number
+      @page_number ||= (params[:page] || 1).to_i
+    end
+
+    def paginated(collection)
+      Split::DashboardPaginator.new(collection, page_number, pagination_per).paginate
+    end
+
+    def pagination(collection)
+      html = []
+      html << first_page_tag if show_first_page_tag?
+      html << ellipsis_tag if show_first_ellipsis_tag?
+      html << prev_page_tag if show_prev_page_tag?
+      html << current_page_tag
+      html << next_page_tag if show_next_page_tag?(collection)
+      html << ellipsis_tag if show_last_ellipsis_tag?(collection)
+      html << last_page_tag(collection) if show_last_page_tag?(collection)
+      html.join
+    end
+
+    private
+
+    def show_first_page_tag?
+      page_number > 2
+    end
+
+    def first_page_tag
+      %Q(<a href="#{url.chop}?page=1&per=#{pagination_per}">1</a>)
+    end
+
+    def show_first_ellipsis_tag?
+      page_number >= 4
+    end
+
+    def ellipsis_tag
+      '<span>...</span>'
+    end
+
+    def show_prev_page_tag?
+      page_number > 1
+    end
+
+    def prev_page_tag
+      %Q(<a href="#{url.chop}?page=#{page_number - 1}&per=#{pagination_per}">#{page_number - 1}</a>)
+    end
+
+    def current_page_tag
+      "<span><b>#{page_number}</b></span>"
+    end
+
+    def show_next_page_tag?(collection)
+      (page_number * pagination_per) < collection.count
+    end
+
+    def next_page_tag
+      %Q(<a href="#{url.chop}?page=#{page_number + 1}&per=#{pagination_per}">#{page_number + 1}</a>)
+    end
+
+    def show_last_ellipsis_tag?(collection)
+      (total_pages(collection) - page_number) >= 3
+    end
+
+    def total_pages(collection)
+      collection.count / pagination_per + ((collection.count % pagination_per).zero? ? 0 : 1)
+    end
+
+    def show_last_page_tag?(collection)
+      page_number < (total_pages(collection) - 1)
+    end
+
+    def last_page_tag(collection)
+      total = total_pages(collection)
+      %Q(<a href="#{url.chop}?page=#{total}&per=#{pagination_per}">#{total}</a>)
+    end
+  end
+end

data/lib/split/dashboard/paginator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Split
+  class DashboardPaginator
+    def initialize(collection, page_number, per)
+      @collection = collection
+      @page_number = page_number
+      @per = per
+    end
+
+    def paginate
+      to = @page_number * @per
+      from = to - @per
+      @collection[from...to]
+    end
+  end
+end

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

@@ -317,3 +317,17 @@ a.button.green:focus, button.green:focus, input[type="submit"].green:focus {
 }
 
 
+.pagination {
+  text-align: center;
+  font-size: 15px;
+}
+
+.pagination a, .paginaton span {
+  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/index.erb

@@ -6,7 +6,7 @@
   <input type="button" id="toggle-active" value="Hide active" />
   <input type="button" id="clear-filter" value="Clear filters" />
 
-  <% @experiments.each do |experiment| %>
+  <% paginated(@experiments).each do |experiment| %>
     <% if experiment.goals.empty? %>
       <%= erb :_experiment, :locals => {:goal => nil, :experiment => experiment} %>
     <% else %>
@@ -16,6 +16,10 @@
       <% end %>
     <% end %>
   <% end %>
+
+  <div class="pagination">
+    <%= pagination(@experiments) %>
+  </div>
 <% else %>
   <p class="intro">No experiments have started yet, you need to define them in your code and introduce them to your users.</p>
   <p class="intro">Check out the <a href='https://github.com/splitrb/split#readme'>Readme</a> for more help getting started.</p>

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,8 +1,10 @@
 # frozen_string_literal: true
+
 require 'sinatra/base'
 require 'split'
 require 'bigdecimal'
 require 'split/dashboard/helpers'
+require 'split/dashboard/pagination_helpers'
 
 module Split
   class Dashboard < Sinatra::Base
@@ -14,6 +16,7 @@ module Split
     set :method_override, true
 
     helpers Split::DashboardHelpers
+    helpers Split::DashboardPaginationHelpers
 
     get '/' do
       # Display experiments without a winner at the top of the dashboard
@@ -31,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
 
@@ -60,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,10 +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
+        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