split 4.0.1 → 4.0.3

data/lib/split/experiment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rubystats'
-
 module Split
   class Experiment
     attr_accessor :name
@@ -13,7 +11,7 @@ module Split
     attr_reader :resettable
 
     DEFAULT_OPTIONS = {
-      :resettable => true
+      resettable: true
     }
 
     def self.find(name)
@@ -52,7 +50,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
 
@@ -87,7 +85,7 @@ module Split
         persist_experiment_configuration
       end
 
-      redis.hmset(experiment_config_key, :resettable, resettable,
+      redis.hmset(experiment_config_key, :resettable, resettable.to_s,
                                          :algorithm, algorithm.to_s)
       self
     end
@@ -96,7 +94,7 @@ module Split
       if @alternatives.empty? && Split.configuration.experiment_for(@name).nil?
         raise ExperimentNotFound.new("Experiment #{@name} not found")
       end
-      @alternatives.each {|a| a.validate! }
+      @alternatives.each { |a| a.validate! }
       goals_collection.validate!
     end
 
@@ -109,7 +107,7 @@ module Split
     end
 
     def [](name)
-      alternatives.find{|a| a.name == name}
+      alternatives.find { |a| a.name == name }
     end
 
     def algorithm
@@ -121,7 +119,7 @@ module Split
     end
 
     def resettable=(resettable)
-      @resettable = resettable.is_a?(String) ? resettable == 'true' : resettable
+      @resettable = resettable.is_a?(String) ? resettable == "true" : resettable
     end
 
     def alternatives=(alts)
@@ -157,7 +155,7 @@ module Split
     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
@@ -262,8 +260,8 @@ module Split
       exp_config = redis.hgetall(experiment_config_key)
 
       options = {
-        resettable: exp_config['resettable'],
-        algorithm: exp_config['algorithm'],
+        resettable: exp_config["resettable"],
+        algorithm: exp_config["algorithm"],
         alternatives: load_alternatives_from_redis,
         goals: Split::GoalsCollection.new(@name).load_from_redis,
         metadata: load_metadata_from_redis
@@ -272,7 +270,16 @@ module Split
       set_alternatives_and_options(options)
     end
 
+    def can_calculate_winning_alternatives?
+      self.alternatives.all? do |alternative|
+        alternative.participant_count >= 0 &&
+        (alternative.participant_count >= alternative.completed_count)
+      end
+    end
+
     def calc_winning_alternatives
+      return unless can_calculate_winning_alternatives?
+
       # Cache the winning alternatives so we recalculate them once per the specified interval.
       intervals_since_epoch =
         Time.now.utc.to_i / Split.configuration.winning_alternative_recalculation_interval
@@ -328,11 +335,11 @@ module Split
       winning_counts.each do |alternative, wins|
         alternative_probabilities[alternative] = wins / number_of_simulations.to_f
       end
-      return alternative_probabilities
+      alternative_probabilities
     end
 
     def count_simulated_wins(winning_alternatives)
-       # initialize a hash to keep track of winning alternative in simulations
+      # initialize a hash to keep track of winning alternative in simulations
       winning_counts = {}
       alternatives.each do |alternative|
         winning_counts[alternative] = 0
@@ -341,7 +348,7 @@ module Split
       winning_alternatives.each do |alternative|
         winning_counts[alternative] += 1
       end
-      return winning_counts
+      winning_counts
     end
 
     def find_simulated_winner(simulated_cr_hash)
@@ -353,7 +360,7 @@ module Split
         end
       end
       winner = winning_pair[0]
-      return winner
+      winner
     end
 
     def calc_simulated_conversion_rates(beta_params)
@@ -363,11 +370,11 @@ module Split
       beta_params.each do |alternative, params|
         alpha = params[0]
         beta = params[1]
-        simulated_conversion_rate = Rubystats::BetaDistribution.new(alpha, beta).rng
+        simulated_conversion_rate = Split::Algorithms.beta_distribution_rng(alpha, beta)
         simulated_cr_hash[alternative] = simulated_conversion_rate
       end
 
-      return simulated_cr_hash
+      simulated_cr_hash
     end
 
     def calc_beta_params(goal = nil)
@@ -381,7 +388,7 @@ module Split
 
         beta_params[alternative] = params
       end
-      return beta_params
+      beta_params
     end
 
     def calc_time=(time)
@@ -394,11 +401,11 @@ module Split
 
     def jstring(goal = nil)
       js_id = if goal.nil?
-                name
-              else
-                name + "-" + goal
-              end
-      js_id.gsub('/', '--')
+        name
+      else
+        name + "-" + goal
+      end
+      js_id.gsub("/", "--")
     end
 
     def cohorting_disabled?
@@ -410,95 +417,93 @@ module Split
 
     def disable_cohorting
       @cohorting_disabled = true
-      redis.hset(experiment_config_key, :cohorting, true)
+      redis.hset(experiment_config_key, :cohorting, true.to_s)
     end
 
     def enable_cohorting
       @cohorting_disabled = false
-      redis.hset(experiment_config_key, :cohorting, false)
+      redis.hset(experiment_config_key, :cohorting, false.to_s)
     end
 
     protected
+      def experiment_config_key
+        "experiment_configurations/#{@name}"
+      end
 
-    def experiment_config_key
-      "experiment_configurations/#{@name}"
-    end
-
-    def load_metadata_from_configuration
-      Split.configuration.experiment_for(@name)[:metadata]
-    end
+      def load_metadata_from_configuration
+        Split.configuration.experiment_for(@name)[:metadata]
+      end
 
-    def load_metadata_from_redis
-      meta = redis.get(metadata_key)
-      JSON.parse(meta) unless meta.nil?
-    end
+      def load_metadata_from_redis
+        meta = redis.get(metadata_key)
+        JSON.parse(meta) unless meta.nil?
+      end
 
-    def load_alternatives_from_configuration
-      alts = Split.configuration.experiment_for(@name)[:alternatives]
-      raise ArgumentError, "Experiment configuration is missing :alternatives array" unless alts
-      if alts.is_a?(Hash)
-        alts.keys
-      else
-        alts.flatten
+      def load_alternatives_from_configuration
+        alts = Split.configuration.experiment_for(@name)[:alternatives]
+        raise ArgumentError, "Experiment configuration is missing :alternatives array" unless alts
+        if alts.is_a?(Hash)
+          alts.keys
+        else
+          alts.flatten
+        end
       end
-    end
 
-    def load_alternatives_from_redis
-      alternatives = redis.lrange(@name, 0, -1)
-      alternatives.map do |alt|
-        alt = begin
-                JSON.parse(alt)
-              rescue
-                alt
-              end
-        Split::Alternative.new(alt, @name)
+      def load_alternatives_from_redis
+        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
-    end
 
     private
+      def redis
+        Split.redis
+      end
 
-    def redis
-      Split.redis
-    end
+      def redis_interface
+        RedisInterface.new
+      end
 
-    def redis_interface
-      RedisInterface.new
-    end
+      def persist_experiment_configuration
+        redis_interface.add_to_set(:experiments, name)
+        redis_interface.persist_list(name, @alternatives.map { |alt| { alt.name => alt.weight }.to_json })
+        goals_collection.save
 
-    def persist_experiment_configuration
-      redis_interface.add_to_set(:experiments, name)
-      redis_interface.persist_list(name, @alternatives.map{|alt| {alt.name => alt.weight}.to_json})
-      goals_collection.save
+        if @metadata
+          redis.set(metadata_key, @metadata.to_json)
+        else
+          delete_metadata
+        end
+      end
 
-      if @metadata
-        redis.set(metadata_key, @metadata.to_json)
-      else
+      def remove_experiment_configuration
+        @alternatives.each(&:delete)
+        goals_collection.delete
         delete_metadata
+        redis.del(@name)
       end
-    end
 
-    def remove_experiment_configuration
-      @alternatives.each(&:delete)
-      goals_collection.delete
-      delete_metadata
-      redis.del(@name)
-    end
-
-    def experiment_configuration_has_changed?
-      existing_experiment = Experiment.find(@name)
+      def experiment_configuration_has_changed?
+        existing_experiment = Experiment.find(@name)
 
-      existing_experiment.alternatives.map(&:to_s) != @alternatives.map(&:to_s) ||
-        existing_experiment.goals != @goals ||
-        existing_experiment.metadata != @metadata
-    end
+        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 goals_collection
+        Split::GoalsCollection.new(@name, @goals)
+      end
 
-    def remove_experiment_cohorting
-      @cohorting_disabled = false
-      redis.hdel(experiment_config_key, :cohorting)
-    end
+      def remove_experiment_cohorting
+        @cohorting_disabled = false
+        redis.hdel(experiment_config_key, :cohorting)
+      end
   end
 end

data/lib/split/experiment_catalog.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 module Split
   class ExperimentCatalog
     # Return all experiments
     def self.all
       # Call compact to prevent nil experiments from being returned -- seems to happen during gem upgrades
-      Split.redis.smembers(:experiments).map {|e| find(e)}.compact
+      Split.redis.smembers(:experiments).map { |e| find(e) }.compact
     end
 
     # Return experiments without a winner (considered "active") first
     def self.all_active_first
-      all.partition{|e| not e.winner}.map{|es| es.sort_by(&:name)}.flatten
+      all.partition { |e| not e.winner }.map { |es| es.sort_by(&:name) }.flatten
     end
 
     def self.find(name)
@@ -19,14 +20,14 @@ module Split
     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?
+      if control.is_a?(Array) && 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]
+      experiment_name = experiment_name_with_version.to_s.split(":")[0]
       Split::Experiment.new(experiment_name,
-          :alternatives => [control].compact + alternatives, :goals => goals)
+          alternatives: [control].compact + alternatives, goals: goals)
     end
 
     def self.find_or_create(metric_descriptor, control = nil, *alternatives)

data/lib/split/extensions/string.rb

@@ -4,7 +4,7 @@ class String
   # Constatntize is often provided by ActiveSupport, but ActiveSupport is not a dependency of Split.
   unless method_defined?(:constantize)
     def constantize
-      names = self.split('::')
+      names = self.split("::")
       names.shift if names.empty? || names.first.empty?
 
       constant = Object

data/lib/split/goals_collection.rb

@@ -2,8 +2,7 @@
 
 module Split
   class GoalsCollection
-
-    def initialize(experiment_name, goals=nil)
+    def initialize(experiment_name, goals = nil)
       @experiment_name = experiment_name
       @goals = goals
     end
@@ -15,10 +14,10 @@ module Split
     def load_from_configuration
       goals = Split.configuration.experiment_for(@experiment_name)[:goals]
 
-      if goals.nil?
-        goals = []
-      else
+      if goals
         goals.flatten
+      else
+        []
       end
     end
 
@@ -29,7 +28,7 @@ module Split
 
     def validate!
       unless @goals.nil? || @goals.kind_of?(Array)
-        raise ArgumentError, 'Goals must be an array'
+        raise ArgumentError, "Goals must be an array"
       end
     end
 
@@ -38,9 +37,8 @@ module Split
     end
 
     private
-
-    def goals_key
-      "#{@experiment_name}:goals"
-    end
+      def goals_key
+        "#{@experiment_name}:goals"
+      end
   end
 end

data/lib/split/helper.rb

@@ -12,9 +12,9 @@ module Split
         alternative = if Split.configuration.enabled && !exclude_visitor?
           experiment.save
           raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
-          trial = Trial.new(:user => ab_user, :experiment => experiment,
-              :override => override_alternative(experiment.name), :exclude => exclude_visitor?,
-              :disabled => split_generically_disabled?)
+          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
@@ -44,21 +44,21 @@ module Split
       ab_user.delete(experiment.key)
     end
 
-    def finish_experiment(experiment, options = {:reset => true})
+    def finish_experiment(experiment, options = { reset: true })
       return false if active_experiments[experiment.name].nil?
       return true if experiment.has_winner?
       should_reset = experiment.resettable? && options[:reset]
       if ab_user[experiment.finished_key] && !should_reset
-        return true
+        true
       else
         alternative_name = ab_user[experiment.key]
         trial = Trial.new(
-          :user => ab_user, 
-          :experiment => experiment,
-          :alternative => alternative_name,
-          :goals => options[:goals],
-        )      
-        
+          user: ab_user,
+          experiment: experiment,
+          alternative: alternative_name,
+          goals: options[:goals],
+        )
+
         trial.complete!(self)
 
         if should_reset
@@ -69,7 +69,7 @@ module Split
       end
     end
 
-    def ab_finished(metric_descriptor, options = {:reset => true})
+    def ab_finished(metric_descriptor, options = { reset: true })
       return if exclude_visitor? || Split.configuration.disabled?
       metric_descriptor, goals = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
@@ -77,7 +77,7 @@ module Split
       if experiments.any?
         experiments.each do |experiment|
           next if override_present?(experiment.key)
-          finish_experiment(experiment, options.merge(:goals => goals))
+          finish_experiment(experiment, options.merge(goals: goals))
         end
       end
     rescue => e
@@ -86,7 +86,7 @@ module Split
     end
 
     def ab_record_extra_info(metric_descriptor, key, value = 1)
-      return if exclude_visitor? || Split.configuration.disabled?
+      return if exclude_visitor? || Split.configuration.disabled? || value.nil?
       metric_descriptor, _ = normalize_metric(metric_descriptor)
       experiments = Metric.possible_experiments(metric_descriptor)
 
@@ -95,7 +95,7 @@ module Split
           alternative_name = ab_user[experiment.key]
 
           if alternative_name
-            alternative = experiment.alternatives.find{|alt| alt.name == alternative_name}
+            alternative = experiment.alternatives.find { |alt| alt.name == alternative_name }
             alternative.record_extra_info(key, value) if alternative
           end
         end
@@ -105,7 +105,7 @@ module Split
       Split.configuration.db_failover_on_db_error.call(e)
     end
 
-    def ab_active_experiments()
+    def ab_active_experiments
       ab_user.active_experiments
     rescue => e
       raise unless Split.configuration.db_failover
@@ -127,14 +127,14 @@ module Split
     def override_alternative_by_cookies(experiment_name)
       return unless defined?(request)
 
-      if request.cookies && request.cookies.key?('split_override')
-        experiments = JSON.parse(request.cookies['split_override']) rescue {}
+      if request.cookies && request.cookies.key?("split_override")
+        experiments = JSON.parse(request.cookies["split_override"]) rescue {}
         experiments[experiment_name]
       end
     end
 
     def split_generically_disabled?
-      defined?(params) && params['SPLIT_DISABLE']
+      defined?(params) && params["SPLIT_DISABLE"]
     end
 
     def ab_user
@@ -150,7 +150,7 @@ module Split
     end
 
     def is_preview?
-      defined?(request) && defined?(request.headers) && request.headers['x-purpose'] == 'preview'
+      defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
     end
 
     def is_ignored_ip_address?

data/lib/split/metric.rb

@@ -16,13 +16,13 @@ module Split
     def self.load_from_redis(name)
       metric = Split.redis.hget(:metrics, name)
       if metric
-        experiment_names = metric.split(',')
+        experiment_names = metric.split(",")
 
         experiments = experiment_names.collect do |experiment_name|
           Split::ExperimentCatalog.find(experiment_name)
         end
 
-        Split::Metric.new(:name => name, :experiments => experiments)
+        Split::Metric.new(name: name, experiments: experiments)
       else
         nil
       end
@@ -31,7 +31,7 @@ module Split
     def self.load_from_configuration(name)
       metrics = Split.configuration.metrics
       if metrics && metrics[name]
-        Split::Metric.new(:experiments => metrics[name], :name => name)
+        Split::Metric.new(experiments: metrics[name], name: name)
       else
         nil
       end
@@ -77,7 +77,7 @@ module Split
     end
 
     def save
-      Split.redis.hset(:metrics, name, experiments.map(&:name).join(','))
+      Split.redis.hset(:metrics, name, experiments.map(&:name).join(","))
     end
 
     def complete!
@@ -97,6 +97,5 @@ module Split
       return metric_name, goals
     end
     private_class_method :normalize_metric
-
   end
 end