split 2.2.0 → 3.1.0

data/lib/split/alternative.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
-require 'split/zscore'
-
-# TODO - take out require and implement using file paths?
-
 module Split
   class Alternative
     attr_accessor :name
     attr_accessor :experiment_name
     attr_accessor :weight
-
-    include Zscore
+    attr_accessor :recorded_info
 
     def initialize(name, experiment_name)
       @experiment_name = experiment_name
@@ -127,10 +122,37 @@ module Split
       z_score = Split::Zscore.calculate(p_a, n_a, p_c, n_c)
     end
 
+    def extra_info
+      data = Split.redis.hget(key, 'recorded_info')
+      if data && data.length > 1
+        begin
+          JSON.parse(data)
+        rescue
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    def record_extra_info(k, value = 1)
+      @recorded_info = self.extra_info || {}
+
+      if value.kind_of?(Numeric)
+        @recorded_info[k] ||= 0
+        @recorded_info[k] += value
+      else
+        @recorded_info[k] = value
+      end
+
+      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
     end
 
     def validate!
@@ -140,7 +162,7 @@ module Split
     end
 
     def reset
-      Split.redis.hmset key, 'participant_count', 0, 'completed_count', 0
+      Split.redis.hmset key, 'participant_count', 0, 'completed_count', 0, 'recorded_info', nil
       unless goals.empty?
         goals.each do |g|
           field = "completed_count:#{g}"

data/lib/split/combined_experiments_helper.rb

@@ -0,0 +1,30 @@
+# 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?
+
+      alternative = nil
+      experiment[:combined_experiments].each do |combined_experiment|
+        if alternative.nil?
+          if control
+            alternative = ab_test(combined_experiment, control, alternatives)
+          else
+            normalized_alternatives = Split::Configuration.new.normalize_alternatives(experiment[:alternatives])
+            alternative = ab_test(combined_experiment, normalized_alternatives[0], *normalized_alternatives[1])
+          end
+        else
+          ab_test(combined_experiment, [{alternative => 1}])
+        end
+      end
+    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]
+    end
+  end
+end

data/lib/split/configuration.rb

@@ -48,7 +48,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
@@ -73,10 +75,13 @@ module Split
         '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',

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/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/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/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&.dig(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

data/lib/split/persistence/cookie_adapter.rb

@@ -6,20 +6,21 @@ module Split
     class CookieAdapter
 
       def initialize(context)
-        @cookies = context.send(:cookies)
+        @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 +29,25 @@ module Split
 
       private
 
-      def set_cookie(value)
-        @cookies[:split] = {
-          :value => JSON.generate(value),
-          :expires => @expires
-        }
+      def set_cookie(value = {})
+        @response.set_cookie :split.to_s, default_options.merge(value: JSON.generate(value))
+      end
+
+      def default_options
+        { expires: @expires, path: '/' }
       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
 

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/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   = 1
   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

@@ -274,4 +274,35 @@ describe Split::Alternative do
       expect(control.z_score(goal2)).to eq('N/A')
     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

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 alternatives for all sub experiments " 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, [{"test-alt" => 1}] )
+
+      ab_combined_test('combined_exp_1')
+    end
+  end
+end

data/spec/dashboard_helpers_spec.rb

@@ -24,5 +24,19 @@ describe Split::DashboardHelpers do
       expect(confidence_level(2.58)).to eq('99% confidence')
       expect(confidence_level(3.00)).to eq('99% confidence')
     end
+
+    describe '#round' do
+      it 'can round number strings' do
+        expect(round('3.1415')).to eq BigDecimal.new('3.14')
+      end
+
+      it 'can round number strings for precsion' do
+        expect(round('3.1415', 1)).to eq BigDecimal.new('3.1')
+      end
+
+      it 'can handle invalid number strings' do
+        expect(round('N/A')).to be_zero
+      end
+    end
   end
 end

data/spec/experiment_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 require 'spec_helper'
-require 'split/experiment'
-require 'split/algorithms'
 require 'time'
 
 describe Split::Experiment do

data/spec/helper_spec.rb

@@ -35,6 +35,18 @@ describe Split::Helper do
       expect(lambda { ab_test({'link_color' => "purchase"}, 'blue', 'red') }).not_to raise_error
     end
 
+    it "raises an appropriate error when processing combined expirements" do
+      Split.configuration.experiments = {
+        :combined_exp_1 => {
+          :alternatives => [  { name: "control", percent: 50 },  { name: "test-alt", percent: 50 } ],
+          :metric => :my_metric,
+          :combined_experiments => [:combined_exp_1_sub_1]
+        }
+      }
+      Split::ExperimentCatalog.find_or_create('combined_exp_1')
+      expect(lambda { ab_test('combined_exp_1')}).to raise_error(Split::InvalidExperimentsFormatError )
+    end
+
     it "should assign a random alternative to a new user when there are an equal number of alternatives assigned" do
       ab_test('link_color', 'blue', 'red')
       expect(['red', 'blue']).to include(ab_user['link_color'])

data/spec/persistence/cookie_adapter_spec.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 require "spec_helper"
+require 'rack/test'
 
 describe Split::Persistence::CookieAdapter do
 
-  let(:context) { double(:cookies => CookiesMock.new) }
+  let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
+  let(:request) { Rack::Request.new(env) }
+  let(:response) { Rack::MockResponse.new(200, {}, "") }
+  let(:context) { double(request: request, response: response) }
   subject { Split::Persistence::CookieAdapter.new(context) }
 
   describe "#[] and #[]=" do
@@ -30,7 +34,7 @@ describe Split::Persistence::CookieAdapter do
   end
 
   it "handles invalid JSON" do
-    context.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
+    context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
     expect(subject["my_key"]).to be_nil
     subject["my_key"] = "my_value"
     expect(subject["my_key"]).to eq("my_value")

data/split.gemspec

@@ -12,6 +12,15 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/splitrb/split"
   s.summary     = "Rack based split testing framework"
 
+  s.metadata    = {
+   "homepage_uri" => "https://github.com/splitrb/split",
+   "changelog_uri" => "https://github.com/splitrb/split/blob/master/CHANGELOG.md",
+   "source_code_uri" => "https://github.com/splitrb/split",
+   "bug_tracker_uri" => "https://github.com/splitrb/split/issues",
+   "wiki_uri" => "https://github.com/splitrb/split/wiki",
+   "mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
+ }
+
   s.required_ruby_version = '>= 1.9.2'
 
   s.rubyforge_project = "split"
@@ -24,10 +33,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'sinatra',         '>= 1.2.6'
   s.add_dependency 'simple-random',   '>= 0.9.3'
 
-  s.add_development_dependency 'bundler',     '~> 1.10'
+  s.add_development_dependency 'bundler',     '~> 1.14'
   s.add_development_dependency 'simplecov',   '~> 0.12'
   s.add_development_dependency 'rack-test',   '~> 0.6'
-  s.add_development_dependency 'rake',        '~> 11.1'
+  s.add_development_dependency 'rake',        '~> 12'
   s.add_development_dependency 'rspec',       '~> 3.4'
   s.add_development_dependency 'pry',         '~> 0.10'
   s.add_development_dependency 'fakeredis',   '~> 0.6.0'