split 3.0.0 → 3.3.0

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/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/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?)
@@ -96,6 +97,14 @@ module Split
       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
@@ -113,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/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/version.rb

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

data/lib/split.rb

@@ -13,6 +13,7 @@ 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'

data/spec/alternative_spec.rb

@@ -273,6 +273,18 @@ 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

data/spec/combined_experiments_helper_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'split/combined_experiments_helper'
+
+describe Split::CombinedExperimentsHelper do
+  include Split::CombinedExperimentsHelper
+
+  describe 'ab_combined_test' do
+    let!(:config_enabled) { true }
+    let!(:combined_experiments) { [:exp_1_click, :exp_1_scroll ]}
+    let!(:allow_multiple_experiments) { true }
+
+    before do
+      Split.configuration.experiments = {
+        :combined_exp_1 => {
+          :alternatives => [ {"control"=> 0.5}, {"test-alt"=> 0.5} ],
+          :metric => :my_metric,
+          :combined_experiments => combined_experiments
+        }
+      }
+      Split.configuration.enabled = config_enabled
+      Split.configuration.allow_multiple_experiments = allow_multiple_experiments
+    end
+
+    context 'without config enabled' do
+      let!(:config_enabled) { false }
+
+      it "raises an error" do
+        expect(lambda { ab_combined_test :combined_exp_1 }).to raise_error(Split::InvalidExperimentsFormatError )
+      end
+    end
+
+    context 'multiple experiments disabled' do
+      let!(:allow_multiple_experiments) { false }
+
+      it "raises an error if multiple experiments is disabled" do
+        expect(lambda { ab_combined_test :combined_exp_1 }).to raise_error(Split::InvalidExperimentsFormatError)
+      end
+    end
+
+    context 'without combined experiments' do
+      let!(:combined_experiments) { nil }
+
+      it "raises an error" do
+        expect(lambda { ab_combined_test :combined_exp_1 }).to raise_error(Split::InvalidExperimentsFormatError )
+      end
+    end
+
+    it "uses same alternative for all sub experiments and returns the alternative" do
+      allow(self).to receive(:get_alternative) { "test-alt" }
+      expect(self).to receive(:ab_test).with(:exp_1_click, {"control"=>0.5}, {"test-alt"=>0.5}) { "test-alt" }
+      expect(self).to receive(:ab_test).with(:exp_1_scroll, [{"control" => 0, "test-alt" => 1}])
+
+      expect(ab_combined_test('combined_exp_1')).to eq('test-alt')
+    end
+  end
+end

data/spec/dashboard/pagination_helpers_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+require 'split/dashboard/pagination_helpers'
+
+describe Split::DashboardPaginationHelpers do
+  include Split::DashboardPaginationHelpers
+
+  let(:url) { '/split/' }
+
+  describe '#pagination_per' do
+    context 'when params empty' do
+      let(:params) { Hash[] }
+
+      it 'returns 10' do
+        expect(pagination_per).to eql 10
+      end
+    end
+
+    context 'when params[:per] is 5' do
+      let(:params) { Hash[per: 5] }
+
+      it 'returns 5' do
+        expect(pagination_per).to eql 5
+      end
+    end
+  end
+
+  describe '#page_number' do
+    context 'when params empty' do
+      let(:params) { Hash[] }
+
+      it 'returns 1' do
+        expect(page_number).to eql 1
+      end
+    end
+
+    context 'when params[:page] is "2"' do
+      let(:params) { Hash[page: '2'] }
+
+      it 'returns 2' do
+        expect(page_number).to eql 2
+      end
+    end
+  end
+
+  describe '#paginated' do
+    let(:collection) { (1..20).to_a }
+    let(:params) { Hash[per: '5', page: '3'] }
+
+    it { expect(paginated(collection)).to eql [11, 12, 13, 14, 15] }
+  end
+
+  describe '#show_first_page_tag?' do
+    context 'when page is 1' do
+      it { expect(show_first_page_tag?).to be false }
+    end
+
+    context 'when page is 3' do
+      let(:params) { Hash[page: '3'] }
+      it { expect(show_first_page_tag?).to be true }
+    end
+  end
+
+  describe '#first_page_tag' do
+    it { expect(first_page_tag).to eql '<a href="/split?page=1&per=10">1</a>' }
+  end
+
+  describe '#show_first_ellipsis_tag?' do
+    context 'when page is 1' do
+      it { expect(show_first_ellipsis_tag?).to be false }
+    end
+
+    context 'when page is 4' do
+      let(:params) { Hash[page: '4'] }
+      it { expect(show_first_ellipsis_tag?).to be true }
+    end
+  end
+
+  describe '#ellipsis_tag' do
+    it { expect(ellipsis_tag).to eql '<span>...</span>' }
+  end
+
+  describe '#show_prev_page_tag?' do
+    context 'when page is 1' do
+      it { expect(show_prev_page_tag?).to be false }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(show_prev_page_tag?).to be true }
+    end
+  end
+
+  describe '#prev_page_tag' do
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+
+      it do
+        expect(prev_page_tag).to eql '<a href="/split?page=1&per=10">1</a>'
+      end
+    end
+
+    context 'when page is 3' do
+      let(:params) { Hash[page: '3'] }
+
+      it do
+        expect(prev_page_tag).to eql '<a href="/split?page=2&per=10">2</a>'
+      end
+    end
+  end
+
+  describe '#show_prev_page_tag?' do
+    context 'when page is 1' do
+      it { expect(show_prev_page_tag?).to be false }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(show_prev_page_tag?).to be true }
+    end
+  end
+
+  describe '#current_page_tag' do
+    context 'when page is 1' do
+      let(:params) { Hash[page: '1'] }
+      it { expect(current_page_tag).to eql '<span><b>1</b></span>' }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(current_page_tag).to eql '<span><b>2</b></span>' }
+    end
+  end
+
+  describe '#show_next_page_tag?' do
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+
+      context 'when collection length is 20' do
+        let(:collection) { (1..20).to_a }
+        it { expect(show_next_page_tag?(collection)).to be false }
+      end
+
+      context 'when collection length is 25' do
+        let(:collection) { (1..25).to_a }
+        it { expect(show_next_page_tag?(collection)).to be true }
+      end
+    end
+  end
+
+  describe '#next_page_tag' do
+    context 'when page is 1' do
+      let(:params) { Hash[page: '1'] }
+      it { expect(next_page_tag).to eql '<a href="/split?page=2&per=10">2</a>' }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(next_page_tag).to eql '<a href="/split?page=3&per=10">3</a>' }
+    end
+  end
+
+  describe '#total_pages' do
+    context 'when collection length is 30' do
+      let(:collection) { (1..30).to_a }
+      it { expect(total_pages(collection)).to eql 3 }
+    end
+
+    context 'when collection length is 35' do
+      let(:collection) { (1..35).to_a }
+      it { expect(total_pages(collection)).to eql 4 }
+    end
+  end
+
+  describe '#show_last_ellipsis_tag?' do
+    let(:collection) { (1..30).to_a }
+    let(:params) { Hash[per: '5', page: '2'] }
+    it { expect(show_last_ellipsis_tag?(collection)).to be true }
+  end
+
+  describe '#show_last_page_tag?' do
+    let(:collection) { (1..30).to_a }
+
+    context 'when page is 5/6' do
+      let(:params) { Hash[per: '5', page: '5'] }
+      it { expect(show_last_page_tag?(collection)).to be false }
+    end
+
+    context 'when page is 4/6' do
+      let(:params) { Hash[per: '5', page: '4'] }
+      it { expect(show_last_page_tag?(collection)).to be true }
+    end
+  end
+
+  describe '#last_page_tag' do
+    let(:collection) { (1..30).to_a }
+    it { expect(last_page_tag(collection)).to eql '<a href="/split?page=3&per=10">3</a>' }
+  end
+end

data/spec/dashboard/paginator_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'split/dashboard/paginator'
+
+describe Split::DashboardPaginator do
+  context 'when collection is 1..20' do
+    let(:collection) { (1..20).to_a }
+
+    context 'when per 5 for page' do
+      let(:per) { 5 }
+
+      it 'when page number is 1 result is [1, 2, 3, 4, 5]' do
+        result = Split::DashboardPaginator.new(collection, 1, per).paginate
+        expect(result).to eql [1, 2, 3, 4, 5]
+      end
+
+      it 'when page number is 2 result is [6, 7, 8, 9, 10]' do
+        result = Split::DashboardPaginator.new(collection, 2, per).paginate
+        expect(result).to eql [6, 7, 8, 9, 10]
+      end
+    end
+
+    context 'when per 10 for page' do
+      let(:per) { 10 }
+
+      it 'when page number is 1 result is [1..10]' do
+        result = Split::DashboardPaginator.new(collection, 1, per).paginate
+        expect(result).to eql [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+      end
+
+      it 'when page number is 2 result is [10..20]' do
+        result = Split::DashboardPaginator.new(collection, 2, per).paginate
+        expect(result).to eql [11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
+      end
+    end
+  end
+end

data/spec/experiment_spec.rb

@@ -458,7 +458,7 @@ describe Split::Experiment do
       expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
     end
 
-    it "should calculate the probability of being the winning alternative separately for each goal" do
+    it "should calculate the probability of being the winning alternative separately for each goal", :skip => true do
       experiment = Split::ExperimentCatalog.find_or_create({'link_color3' => ["purchase", "refund"]}, 'blue', 'red', 'green')
       goal1 = experiment.goals[0]
       goal2 = experiment.goals[1]