split 3.2.0 → 4.0.5

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
@@ -37,11 +38,11 @@ module Split
     end
 
     def participant_count
-      Split.redis.hget(key, 'participant_count').to_i
+      Split.redis.hget(key, "participant_count").to_i
     end
 
     def participant_count=(count)
-      Split.redis.hset(key, 'participant_count', count.to_i)
+      Split.redis.hset(key, "participant_count", count.to_i)
     end
 
     def completed_count(goal = nil)
@@ -66,22 +67,22 @@ module Split
     def set_field(goal)
       field = "completed_count"
       field += ":" + goal unless goal.nil?
-      return field
+      field
     end
 
     def set_prob_field(goal)
       field = "p_winner"
       field += ":" + goal unless goal.nil?
-      return field
+      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
 
     def increment_participation
-      Split.redis.hincrby key, 'participant_count', 1
+      Split.redis.hincrby key, "participant_count", 1
     end
 
     def increment_completion(goal = nil)
@@ -111,7 +112,7 @@ module Split
       control = experiment.control
       alternative = self
 
-      return 'N/A' if control.name == alternative.name
+      return "N/A" if control.name == alternative.name
 
       p_a = alternative.conversion_rate(goal)
       p_c = control.conversion_rate(goal)
@@ -120,13 +121,13 @@ module Split
       n_c = control.participant_count
 
       # can't calculate zscore for P(x) > 1
-      return 'N/A' if p_a > 1 || p_c > 1
+      return "N/A" if p_a > 1 || p_c > 1
 
-      z_score = Split::Zscore.calculate(p_a, n_a, p_c, n_c)
+      Split::Zscore.calculate(p_a, n_a, p_c, n_c)
     end
 
     def extra_info
-      data = Split.redis.hget(key, 'recorded_info')
+      data = Split.redis.hget(key, "recorded_info")
       if data && data.length > 1
         begin
           JSON.parse(data)
@@ -148,24 +149,24 @@ module Split
         @recorded_info[k] = value
       end
 
-      Split.redis.hset key, 'recorded_info', (@recorded_info || {}).to_json
+      Split.redis.hset key, "recorded_info", (@recorded_info || {}).to_json
     end
 
     def save
-      Split.redis.hsetnx key, 'participant_count', 0
-      Split.redis.hsetnx key, 'completed_count', 0
-      Split.redis.hsetnx key, 'p_winner', p_winner
-      Split.redis.hsetnx key, 'recorded_info', (@recorded_info || {}).to_json
+      Split.redis.hsetnx key, "participant_count", 0
+      Split.redis.hsetnx key, "completed_count", 0
+      Split.redis.hsetnx key, "p_winner", p_winner
+      Split.redis.hsetnx key, "recorded_info", (@recorded_info || {}).to_json
     end
 
     def validate!
       unless String === @name || hash_with_correct_values?(@name)
-        raise ArgumentError, 'Alternative must be a string'
+        raise ArgumentError, "Alternative must be a string"
       end
     end
 
     def reset
-      Split.redis.hmset key, 'participant_count', 0, 'completed_count', 0, 'recorded_info', nil
+      Split.redis.hmset key, "participant_count", 0, "completed_count", 0, "recorded_info", ""
       unless goals.empty?
         goals.each do |g|
           field = "completed_count:#{g}"
@@ -179,13 +180,12 @@ module Split
     end
 
     private
+      def hash_with_correct_values?(name)
+        Hash === name && String === name.keys.first && Float(name.values.first) rescue false
+      end
 
-    def hash_with_correct_values?(name)
-      Hash === name && String === name.keys.first && Float(name.values.first) rescue false
-    end
-
-    def key
-      "#{experiment_name}:#{name}"
-    end
+      def key
+        "#{experiment_name}:#{name}"
+      end
   end
 end

data/lib/split/cache.rb

@@ -0,0 +1,27 @@
+# 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

@@ -1,9 +1,10 @@
 # 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?
+      raise(Split::InvalidExperimentsFormatError, "Unable to find experiment #{metric_descriptor} in configuration") if experiment[:combined_experiments].nil?
 
       alternative = nil
       weighted_alternatives = nil
@@ -28,10 +29,10 @@ module Split
     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
-      experiment = Split::configuration.experiments[metric_descriptor.to_sym]
+      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,89 +22,100 @@ 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
-        'AdsBot-Google' => 'Google Adwords',
-        'Baidu' => 'Chinese search engine',
-        'Baiduspider' => 'Chinese search engine',
-        'bingbot' => 'Microsoft bing bot',
-        'Butterfly' => 'Topsy Labs',
-        'Gigabot' => 'Gigabot spider',
-        'Googlebot' => 'Google spider',
-        'MJ12bot' => 'Majestic-12 spider',
-        'msnbot' => 'Microsoft bot',
-        'rogerbot' => 'SeoMoz spider',
-        'PaperLiBot' => 'PaperLi is another content curation service',
-        'Slurp' => 'Yahoo spider',
-        'Sogou' => 'Chinese search engine',
-        'spider' => 'generic web spider',
-        'UnwindFetchor' => 'Gnip crawler',
-        'WordPress' => 'WordPress spider',
-        'YandexAccessibilityBot' => 'Yandex accessibility spider',
-        'YandexBot' => 'Yandex spider',
-        'YandexMobileBot' => 'Yandex mobile spider',
-        'ZIBB' => 'ZIBB spider',
+        "AdsBot-Google" => "Google Adwords",
+        "Baidu" => "Chinese search engine",
+        "Baiduspider" => "Chinese search engine",
+        "bingbot" => "Microsoft bing bot",
+        "Butterfly" => "Topsy Labs",
+        "Gigabot" => "Gigabot spider",
+        "Googlebot" => "Google spider",
+        "MJ12bot" => "Majestic-12 spider",
+        "msnbot" => "Microsoft bot",
+        "rogerbot" => "SeoMoz spider",
+        "PaperLiBot" => "PaperLi is another content curation service",
+        "Slurp" => "Yahoo spider",
+        "Sogou" => "Chinese search engine",
+        "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
-        'Apache-HttpClient' => 'Java http library',
-        'AppEngine-Google' => 'Google App Engine',
-        'curl' => 'curl unix CLI http client',
-        'ColdFusion' => 'ColdFusion http library',
-        'EventMachine HttpClient' => 'Ruby http library',
-        'Go http package' => '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?',
-        'Wget' => 'wget unix CLI http client',
+        "Apache-HttpClient" => "Java http library",
+        "AppEngine-Google" => "Google App Engine",
+        "curl" => "curl unix CLI http client",
+        "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
-        'awe.sm' => 'Awe.sm URL expander',
-        'bitlybot' => 'bit.ly bot',
-        'bot@linkfluence.net' => 'Linkfluence bot',
-        'facebookexternalhit' => 'facebook bot',
-        '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',
-        'Pinterest' => 'Pinterest Bot',
-        'redditbot' => 'Reddit Bot',
-        'ShortLinkTranslate' => 'Link shortener',
-        'Slackbot' => 'Slackbot link expander',
-        'TweetmemeBot' => 'TweetMeMe Crawler',
-        'Twitterbot' => 'Twitter URL expander',
-        'UnwindFetch' => 'Gnip URL expander',
-        'vkShare' => 'VKontake Sharer',
+        "awe.sm" => "Awe.sm URL expander",
+        "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",
+        "vkShare" => "VKontake Sharer",
 
         # Uptime monitoring
-        'check_http' => 'Nagios monitor',
-        'NewRelicPinger' => 'NewRelic monitor',
-        'Panopta' => 'Monitoring service',
-        'Pingdom' => 'Pingdom monitoring',
-        'SiteUptime' => 'Site monitoring services',
+        "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',
-        'ShowyouBot' => 'Showyou iOS app spider',
-        'ZyBorg' => 'Zyborg? Hmmm....',
-        'ELB-HealthChecker' => 'ELB Health Check'
+        "DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
+        "ShowyouBot" => "Showyou iOS app spider",
+        "ZyBorg" => "Zyborg? Hmmm....",
+        "ELB-HealthChecker" => "ELB Health Check"
       }
     end
 
-    def experiments= experiments
-      raise InvalidExperimentsFormatError.new('Experiments must be a Hash') unless experiments.respond_to?(:keys)
+    def experiments=(experiments)
+      raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
       @experiments = experiments
     end
 
@@ -146,8 +157,8 @@ module Split
 
       @experiments.each do |experiment_name, settings|
         alternatives = if (alts = value_for(settings, :alternatives))
-                         normalize_alternatives(alts)
-                       end
+          normalize_alternatives(alts)
+        end
 
         experiment_data = {
           alternatives: alternatives,
@@ -166,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]
@@ -202,46 +213,38 @@ module Split
 
     def initialize
       @ignore_ip_addresses = []
-      @ignore_filter = proc{ |request| is_robot? || is_ignored_ip_address? }
+      @ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
       @db_failover = false
-      @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_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| }
+      @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
+      @redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
+      @dashboard_pagination_default_per_page = 10
     end
 
     private
-
-    def value_for(hash, key)
-      if hash.kind_of?(Hash)
-        hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
+      def value_for(hash, key)
+        if hash.kind_of?(Hash)
+          hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
+        end
       end
-    end
 
-    def escaped_bots
-      bots.map { |key, _| Regexp.escape(key) }
-    end
+      def escaped_bots
+        bots.map { |key, _| Regexp.escape(key) }
+      end
   end
 end

data/lib/split/dashboard/helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module DashboardHelpers
     def h(text)
@@ -6,11 +7,11 @@ module Split
     end
 
     def url(*path_parts)
-      [ path_prefix, path_parts ].join("/").squeeze('/')
+      [ path_prefix, path_parts ].join("/").squeeze("/")
     end
 
     def path_prefix
-      request.env['SCRIPT_NAME']
+      request.env["SCRIPT_NAME"]
     end
 
     def number_to_percentage(number, precision = 2)
@@ -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
 
@@ -31,15 +32,14 @@ module Split
       z = round(z_score.to_s.to_f, 3).abs
 
       if z >= 2.58
-        '99% confidence'
+        "99% confidence"
       elsif z >= 1.96
-        '95% confidence'
+        "95% confidence"
       elsif z >= 1.65
-        '90% confidence'
+        "90% confidence"
       else
-        'Insufficient confidence'
+        "Insufficient confidence"
       end
-
     end
   end
 end

data/lib/split/dashboard/pagination_helpers.rb

@@ -0,0 +1,86 @@
+# 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

@@ -258,7 +258,7 @@ body {
   color: #408C48;
 }
 
-a.button, button, input[type="submit"] {
+.experiment a.button, .experiment button, .experiment input[type="submit"] {
   padding: 4px 10px;
   overflow: hidden;
   background: #d8dae0;
@@ -312,8 +312,25 @@ a.button.green:focus, button.green:focus, input[type="submit"].green:focus {
   background:#768E7A;
 }
 
-#filter, #clear-filter {
+.dashboard-controls input, .dashboard-controls select {
   padding: 10px;
 }
 
+.dashboard-controls-bottom {
+  margin-top: 10px;
+}
+
+.pagination {
+  text-align: center;
+  font-size: 15px;
+}
+
+.pagination a, .paginaton span {
+  display: inline-block;
+  padding: 5px;
+}
 
+.divider {
+  display: inline-block;
+  margin-left: 10px;
+}