split 2.2.0 → 3.3.0

data/lib/split/configuration.rb

@@ -25,6 +25,7 @@ module Split
     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_reader :experiments
@@ -48,7 +49,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
@@ -71,12 +74,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',
+        'Pinterest' => 'Pinterest Bot',
         'redditbot' => 'Reddit Bot',
         'ShortLinkTranslate' => 'Link shortener',
+        'Slackbot' => 'Slackbot link expander',
         'TweetmemeBot' => 'TweetMeMe Crawler',
         'Twitterbot' => 'Twitter URL expander',
         'UnwindFetch' => 'Gnip URL expander',
@@ -212,6 +219,7 @@ module Split
       @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
 

data/lib/split/dashboard/helpers.rb

@@ -18,7 +18,11 @@ module Split
     end
 
     def round(number, precision = 2)
-      BigDecimal.new(number.to_s).round(precision).to_f
+      begin
+        BigDecimal.new(number.to_s)
+      rescue ArgumentError
+        BigDecimal.new(0)
+      end.round(precision).to_f
     end
 
     def confidence_level(z_score)

data/lib/split/dashboard/pagination_helpers.rb

@@ -0,0 +1,87 @@
+# 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
+    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_tagcollection 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,16 @@
+# 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/style.css

@@ -317,3 +317,12 @@ 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;
+}

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

@@ -5,6 +5,25 @@
 <% end %>
 
 <% experiment.calc_winning_alternatives %>
+<%
+  extra_columns = []
+  experiment.alternatives.each do |alternative|
+    extra_info = alternative.extra_info || {}
+    extra_columns += extra_info.keys
+  end
+
+  extra_columns.uniq!
+  summary_texts = {}
+  extra_columns.each do |column|
+    extra_infos = experiment.alternatives.map(&:extra_info).select{|extra_info| extra_info && extra_info[column] }
+    if extra_infos[0][column].kind_of?(Numeric)
+      summary_texts[column] = extra_infos.inject(0){|sum, extra_info| sum += extra_info[column]}
+    else
+      summary_texts[column] = "N/A"
+    end
+  end
+%>
+
 
 <div class="<%= experiment_class %>" data-name="<%= experiment.name %>" data-complete="<%= experiment.has_winner? %>">
   <div class="experiment-header">
@@ -32,6 +51,9 @@
       <th>Non-finished</th>
       <th>Completed</th>
       <th>Conversion Rate</th>
+      <% extra_columns.each do |column| %>
+        <th><%= column %></th>
+      <% end %>
       <th>
         <form>
           <select id="dropdown-<%=experiment.jstring(goal)%>" name="dropdown-<%=experiment.jstring(goal)%>">
@@ -82,6 +104,9 @@
             });
           });
         </script>
+        <% extra_columns.each do |column| %>
+          <td><%= alternative.extra_info && alternative.extra_info[column] %></td>
+        <% end %>
         <td>
           <div class="box-<%=experiment.jstring(goal)%> confidence-<%=experiment.jstring(goal)%>">
             <span title='z-score: <%= round(alternative.z_score(goal), 3) %>'><%= confidence_level(alternative.z_score(goal)) %></span>
@@ -90,7 +115,7 @@
           <div class="box-<%=experiment.jstring(goal)%> probability-<%=experiment.jstring(goal)%>">
             <span title="p_winner: <%= round(alternative.p_winner(goal), 3) %>"><%= number_to_percentage(round(alternative.p_winner(goal), 3)) %>%</span>
           </div>
-        </td>        
+        </td>
         <td>
           <% if experiment.has_winner? %>
             <% if experiment.winner.name == alternative.name %>
@@ -118,6 +143,11 @@
       <td><%= total_unfinished %></td>
       <td><%= total_completed %></td>
       <td>N/A</td>
+      <% extra_columns.each do |column| %>
+        <td>
+          <%= summary_texts[column] %>
+        </td>
+      <% end %>
       <td>N/A</td>
       <td>N/A</td>
     </tr>

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.rb

@@ -3,6 +3,7 @@ require 'sinatra/base'
 require 'split'
 require 'bigdecimal'
 require 'split/dashboard/helpers'
+require 'split/dashboard/pagination_helpers'
 
 module Split
   class Dashboard < Sinatra::Base
@@ -14,6 +15,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

data/lib/split/encapsulated_helper.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require "split/helper"
+
 # Split's helper exposes all kinds of methods we don't want to
 # mix into our model classes.
 #

data/lib/split/engine.rb

@@ -5,6 +5,8 @@ module Split
       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
       end
     end
   end

data/lib/split/experiment.rb

@@ -262,10 +262,11 @@ module Split
     end
 
     def calc_winning_alternatives
-      # Super simple cache so that we only recalculate winning alternatives once per day
-      days_since_epoch = Time.now.utc.to_i / 86400
+      # 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
 
-      if self.calc_time != days_since_epoch
+      if self.calc_time != intervals_since_epoch
         if goals.empty?
           self.estimate_winning_alternative
         else
@@ -274,7 +275,7 @@ module Split
           end
         end
 
-        self.calc_time = days_since_epoch
+        self.calc_time = intervals_since_epoch
 
         self.save
       end

data/lib/split/helper.rb

@@ -10,6 +10,7 @@ module Split
         experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
         alternative = if Split.configuration.enabled
           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?)
@@ -76,6 +77,34 @@ module Split
       Split.configuration.db_failover_on_db_error.call(e)
     end
 
+    def ab_record_extra_info(metric_descriptor, key, value = 1)
+      return if exclude_visitor? || Split.configuration.disabled?
+      metric_descriptor, goals = normalize_metric(metric_descriptor)
+      experiments = Metric.possible_experiments(metric_descriptor)
+
+      if experiments.any?
+        experiments.each do |experiment|
+          alternative_name = ab_user[experiment.key]
+
+          if alternative_name
+            alternative = experiment.alternatives.find{|alt| alt.name == alternative_name}
+            alternative.record_extra_info(key, value) if alternative
+          end
+        end
+      end
+    rescue => e
+      raise unless Split.configuration.db_failover
+      Split.configuration.db_failover_on_db_error.call(e)
+    end
+
+    def ab_active_experiments()
+      ab_user.active_experiments
+    rescue => e
+      raise unless Split.configuration.db_failover
+      Split.configuration.db_failover_on_db_error.call(e)
+    end
+
+
     def override_present?(experiment_name)
       override_alternative(experiment_name)
     end
@@ -93,13 +122,17 @@ module Split
     end
 
     def exclude_visitor?
-      instance_eval(&Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot?
+      instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?
     end
 
     def is_robot?
       defined?(request) && request.user_agent =~ Split.configuration.robot_regex
     end
 
+    def is_preview?
+      defined?(request) && defined?(request.headers) && request.headers['x-purpose'] == 'preview'
+    end
+
     def is_ignored_ip_address?
       return false if Split.configuration.ignore_ip_addresses.empty?
 

data/lib/split/persistence/cookie_adapter.rb

@@ -6,20 +6,22 @@ module Split
     class CookieAdapter
 
       def initialize(context)
-        @cookies = context.send(:cookies)
+        @context = context
+        @request, @response = context.request, context.response
+        @cookies = @request.cookies
         @expires = Time.now + cookie_length_config
       end
 
       def [](key)
-        hash[key]
+        hash[key.to_s]
       end
 
       def []=(key, value)
-        set_cookie(hash.merge(key => value))
+        set_cookie(hash.merge!(key.to_s => value))
       end
 
       def delete(key)
-        set_cookie(hash.tap { |h| h.delete(key) })
+        set_cookie(hash.tap { |h| h.delete(key.to_s) })
       end
 
       def keys
@@ -28,22 +30,55 @@ module Split
 
       private
 
-      def set_cookie(value)
-        @cookies[:split] = {
-          :value => JSON.generate(value),
-          :expires => @expires
-        }
+      def set_cookie(value = {})
+        cookie_key = :split.to_s
+        cookie_value = default_options.merge(value: JSON.generate(value))
+        if action_dispatch?
+          # The "send" is necessary when we call ab_test from the controller
+          # and thus @context is a rails controller, because then "cookies" is
+          # a private method.
+          @context.send(:cookies)[cookie_key] = cookie_value
+        else
+          set_cookie_via_rack(cookie_key, cookie_value)
+        end
+      end
+
+      def default_options
+        { expires: @expires, path: '/' }
+      end
+
+      def set_cookie_via_rack(key, value)
+        delete_cookie_header!(@response.header, key, value)
+        Rack::Utils.set_cookie_header!(@response.header, key, value)
+      end
+
+      # Use Rack::Utils#make_delete_cookie_header after Rack 2.0.0
+      def delete_cookie_header!(header, key, value)
+        cookie_header = header['Set-Cookie']
+        case cookie_header
+        when nil, ''
+          cookies = []
+        when String
+          cookies = cookie_header.split("\n")
+        when Array
+          cookies = cookie_header
+        end
+
+        cookies.reject! { |cookie| cookie =~ /\A#{Rack::Utils.escape(key)}=/ }
+        header['Set-Cookie'] = cookies.join("\n")
       end
 
       def hash
-        if @cookies[:split]
-          begin
-            JSON.parse(@cookies[:split])
-          rescue JSON::ParserError
+        @hash ||= begin
+          if cookies = @cookies[:split.to_s]
+            begin
+              JSON.parse(cookies)
+            rescue JSON::ParserError
+              {}
+            end
+          else
             {}
           end
-        else
-          {}
         end
       end
 
@@ -51,6 +86,9 @@ module Split
         Split.configuration.persistence_cookie_length
       end
 
+      def action_dispatch?
+        defined?(Rails) && @response.is_a?(ActionDispatch::Response)
+      end
     end
   end
 end

data/lib/split/persistence/dual_adapter.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require 'forwardable'
+
 module Split
   module Persistence
     class DualAdapter

data/lib/split/persistence.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
-%w[session_adapter cookie_adapter redis_adapter dual_adapter].each do |f|
-  require "split/persistence/#{f}"
-end
 
 module Split
   module Persistence
+    require 'split/persistence/cookie_adapter'
+    require 'split/persistence/dual_adapter'
+    require 'split/persistence/redis_adapter'
+    require 'split/persistence/session_adapter'
+
     ADAPTERS = {
       :cookie => Split::Persistence::CookieAdapter,
       :session => Split::Persistence::SessionAdapter

data/lib/split/redis_interface.rb

@@ -35,9 +35,7 @@ module Split
     end
 
     def make_list_length(list_name, new_length)
-      while list_length(list_name) > new_length
-        remove_last_item_from_list(list_name)
-      end
+      redis.ltrim(list_name, 0, new_length - 1)
     end
 
     def add_to_set(set_name, value)

data/lib/split/user.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module Split
   class User
     extend Forwardable

data/lib/split/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Split
-  MAJOR   = 2
-  MINOR   = 2
+  MAJOR   = 3
+  MINOR   = 3
   PATCH   = 0
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/lib/split/zscore.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Split
-  module Zscore
+  class Zscore
 
     include Math
 

data/lib/split.rb

@@ -1,24 +1,26 @@
 # frozen_string_literal: true
-%w[algorithms
-   alternative
-   configuration
-   exceptions
-   experiment
-   experiment_catalog
-   extensions
-   goals_collection
-   helper
-   metric
-   persistence
-   encapsulated_helper
-   redis_interface
-   trial
-   user
-   version
-   zscore].each do |f|
-  require "split/#{f}"
-end
+require 'redis'
 
+require 'split/algorithms/block_randomization'
+require 'split/algorithms/weighted_sample'
+require 'split/algorithms/whiplash'
+require 'split/alternative'
+require 'split/configuration'
+require 'split/encapsulated_helper'
+require 'split/exceptions'
+require 'split/experiment'
+require 'split/experiment_catalog'
+require 'split/extensions/string'
+require 'split/goals_collection'
+require 'split/helper'
+require 'split/combined_experiments_helper'
+require 'split/metric'
+require 'split/persistence'
+require 'split/redis_interface'
+require 'split/trial'
+require 'split/user'
+require 'split/version'
+require 'split/zscore'
 require 'split/engine' if defined?(Rails)
 
 module Split

data/spec/algorithms/block_randomization_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Split::Algorithms::BlockRandomization do
+
+  let(:experiment) { Split::Experiment.new 'experiment' }
+  let(:alternative_A) { Split::Alternative.new 'A', 'experiment' }
+  let(:alternative_B) { Split::Alternative.new 'B', 'experiment' }
+  let(:alternative_C) { Split::Alternative.new 'C', 'experiment' }
+
+  before :each do
+    allow(experiment).to receive(:alternatives) { [alternative_A, alternative_B, alternative_C] }
+  end
+
+  it "should return an alternative" do
+    expect(Split::Algorithms::BlockRandomization.choose_alternative(experiment).class).to eq(Split::Alternative)
+  end
+
+  it "should always return the minimum participation option" do
+    allow(alternative_A).to receive(:participant_count) { 1 }
+    allow(alternative_B).to receive(:participant_count) { 1 }
+    allow(alternative_C).to receive(:participant_count) { 0 }
+    expect(Split::Algorithms::BlockRandomization.choose_alternative(experiment)).to eq(alternative_C)
+  end
+
+  it "should return one of the minimum participation options when multiple" do
+    allow(alternative_A).to receive(:participant_count) { 0 }
+    allow(alternative_B).to receive(:participant_count) { 0 }
+    allow(alternative_C).to receive(:participant_count) { 0 }
+    alternative = Split::Algorithms::BlockRandomization.choose_alternative(experiment)
+    expect([alternative_A, alternative_B, alternative_C].include?(alternative)).to be(true)
+  end
+end

data/spec/alternative_spec.rb

@@ -273,5 +273,48 @@ describe Split::Alternative do
       expect(control.z_score(goal1)).to eq('N/A')
       expect(control.z_score(goal2)).to eq('N/A')
     end
+
+    it "should not blow up for Conversion Rates > 1" do
+      control = experiment.control
+      control.participant_count = 3474
+      control.set_completed_count(4244)
+
+      alternative2.participant_count = 3434
+      alternative2.set_completed_count(4358)
+
+      expect { control.z_score }.not_to raise_error
+      expect { alternative2.z_score }.not_to raise_error
+    end
+  end
+
+  describe "extra_info" do
+    it "reads saved value of recorded_info in redis" do
+      saved_recorded_info = {"key_1" => 1, "key_2" => "2"}
+      Split.redis.hset "#{alternative.experiment_name}:#{alternative.name}", 'recorded_info', saved_recorded_info.to_json
+      extra_info = alternative.extra_info
+
+      expect(extra_info).to eql(saved_recorded_info)
+    end
+  end
+
+  describe "record_extra_info" do
+    it "saves key" do
+      alternative.record_extra_info("signup", 1)
+      expect(alternative.extra_info["signup"]).to eql(1)
+    end
+
+    it "adds value to saved key's value second argument is number" do
+      alternative.record_extra_info("signup", 1)
+      alternative.record_extra_info("signup", 2)
+      expect(alternative.extra_info["signup"]).to eql(3)
+    end
+
+    it "sets saved's key value to the second argument if it's a string" do
+      alternative.record_extra_info("signup", "Value 1")
+      expect(alternative.extra_info["signup"]).to eql("Value 1")
+
+      alternative.record_extra_info("signup", "Value 2")
+      expect(alternative.extra_info["signup"]).to eql("Value 2")
+    end
   end
 end