split 4.0.1 → 4.0.2

data/lib/split/dashboard/helpers.rb

@@ -7,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)
@@ -32,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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'split/dashboard/paginator'
+require "split/dashboard/paginator"
 
 module Split
   module DashboardPaginationHelpers
@@ -30,58 +30,57 @@ module Split
     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
+      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/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,10 +312,13 @@ 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;

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

@@ -1,10 +1,12 @@
 <% if @experiments.any? %>
   <p class="intro">The list below contains all the registered experiments along with the number of test participants, completed and conversion rate currently in the system.</p>
 
-  <input type="text" placeholder="Begin typing to filter" id="filter" />
-  <input type="button" id="toggle-completed" value="Hide completed" />
-  <input type="button" id="toggle-active" value="Hide active" />
-  <input type="button" id="clear-filter" value="Clear filters" />
+  <div class="dashboard-controls">
+    <input type="text" placeholder="Begin typing to filter" id="filter" />
+    <input type="button" id="toggle-completed" value="Hide completed" />
+    <input type="button" id="toggle-active" value="Hide active" />
+    <input type="button" id="clear-filter" value="Clear filters" />
+  </div>
 
   <% paginated(@experiments).each do |experiment| %>
     <% if experiment.goals.empty? %>
@@ -24,3 +26,16 @@
   <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>
 <% end %>
+
+<div class="dashboard-controls dashboard-controls-bottom">
+  <form action="<%= url "/initialize_experiment" %>" method='post'>
+    <label>Add unregistered experiment: </label>
+    <select name="experiment" id="experiment-select">
+      <option selected disabled>experiment</option>
+      <% @unintialized_experiments.sort.each do |experiment_name| %>
+          <option value="<%= experiment_name %>"><%= experiment_name %></option>
+      <% end %>
+    </select>
+    <input type="submit" id="register-experiment-btn" value="register experiment"/>
+  </form>
+<div>

data/lib/split/dashboard.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'sinatra/base'
-require 'split'
-require 'bigdecimal'
-require 'split/dashboard/helpers'
-require 'split/dashboard/pagination_helpers'
+require "sinatra/base"
+require "split"
+require "bigdecimal"
+require "split/dashboard/helpers"
+require "split/dashboard/pagination_helpers"
 
 module Split
   class Dashboard < Sinatra::Base
@@ -18,14 +18,15 @@ module Split
     helpers Split::DashboardHelpers
     helpers Split::DashboardPaginationHelpers
 
-    get '/' do
+    get "/" do
       # Display experiments without a winner at the top of the dashboard
       @experiments = Split::ExperimentCatalog.all_active_first
+      @unintialized_experiments = Split.configuration.experiments.keys - @experiments.map(&:name)
 
       @metrics = Split::Metric.all
 
       # Display Rails Environment mode (or Rack version if not using Rails)
-      if Object.const_defined?('Rails')
+      if Object.const_defined?("Rails") && Rails.respond_to?(:env)
         @current_env = Rails.env.titlecase
       else
         @current_env = "Rack: #{Rack.version}"
@@ -33,43 +34,48 @@ module Split
       erb :index
     end
 
-    post '/force_alternative' do
+    post "/initialize_experiment" do
+      Split::ExperimentCatalog.find_or_create(params[:experiment]) unless params[:experiment].nil? || params[:experiment].empty?
+      redirect url("/")
+    end
+
+    post "/force_alternative" do
       experiment = Split::ExperimentCatalog.find(params[:experiment])
       alternative = Split::Alternative.new(params[:alternative], experiment.name)
 
-      cookies = JSON.parse(request.cookies['split_override']) rescue {}
+      cookies = JSON.parse(request.cookies["split_override"]) rescue {}
       cookies[experiment.name] = alternative.name
-      response.set_cookie('split_override', { value: cookies.to_json, path: '/' })
+      response.set_cookie("split_override", { value: cookies.to_json, path: "/" })
 
-      redirect url('/')
+      redirect url("/")
     end
 
-    post '/experiment' do
+    post "/experiment" do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @alternative = Split::Alternative.new(params[:alternative], params[:experiment])
       @experiment.winner = @alternative.name
-      redirect url('/')
+      redirect url("/")
     end
 
-    post '/start' do
+    post "/start" do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.start
-      redirect url('/')
+      redirect url("/")
     end
 
-    post '/reset' do
+    post "/reset" do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.reset
-      redirect url('/')
+      redirect url("/")
     end
 
-    post '/reopen' do
+    post "/reopen" do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.reset_winner
-      redirect url('/')
+      redirect url("/")
     end
 
-    post '/update_cohorting' do
+    post "/update_cohorting" do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       case params[:cohorting_action].downcase
       when "enable"
@@ -77,13 +83,13 @@ module Split
       when "disable"
         @experiment.disable_cohorting
       end
-      redirect url('/')
+      redirect url("/")
     end
 
-    delete '/experiment' do
+    delete "/experiment" do
       @experiment = Split::ExperimentCatalog.find(params[:experiment])
       @experiment.delete
-      redirect url('/')
+      redirect url("/")
     end
   end
 end

data/lib/split/encapsulated_helper.rb

@@ -15,7 +15,6 @@ require "split/helper"
 #
 module Split
   module EncapsulatedHelper
-
     class ContextShim
       include Split::Helper
       public :ab_test, :ab_finished
@@ -34,10 +33,9 @@ module Split
     end
 
     private
-
-    # instantiate and memoize a context shim in case of multiple ab_test* calls
-    def split_context_shim
-      @split_context_shim ||= ContextShim.new(self)
-    end
+      # instantiate and memoize a context shim in case of multiple ab_test* calls
+      def split_context_shim
+        @split_context_shim ||= ContextShim.new(self)
+      end
   end
 end

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
@@ -328,11 +326,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 +339,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 +351,7 @@ module Split
         end
       end
       winner = winning_pair[0]
-      return winner
+      winner
     end
 
     def calc_simulated_conversion_rates(beta_params)
@@ -363,11 +361,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 +379,7 @@ module Split
 
         beta_params[alternative] = params
       end
-      return beta_params
+      beta_params
     end
 
     def calc_time=(time)
@@ -394,11 +392,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 +408,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