split 3.3.0 → 3.4.0

data/.travis.yml

@@ -2,18 +2,19 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0
-  - 2.1
-  - 2.2.0
+  - 2.1.10
   - 2.2.2
-  - 2.4.3
-  - 2.5.1
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 
 gemfile:
   - gemfiles/4.2.gemfile
   - gemfiles/5.0.gemfile
   - gemfiles/5.1.gemfile
   - gemfiles/5.2.gemfile
-
+  - gemfiles/6.0.gemfile
 
 matrix:
   exclude:
@@ -21,30 +22,36 @@ matrix:
     gemfile: gemfiles/5.0.gemfile
   - rvm: 1.9.3
     gemfile: gemfiles/5.1.gemfile
+  - rvm: 1.9.3
+    gemfile: gemfiles/5.2.gemfile
+  - rvm: 1.9.3
+    gemfile: gemfiles/6.0.gemfile
   - rvm: 2.0
     gemfile: gemfiles/5.0.gemfile
   - rvm: 2.0
     gemfile: gemfiles/5.1.gemfile
-  - rvm: 2.1
-    gemfile: gemfiles/5.0.gemfile
-  - rvm: 2.1
-    gemfile: gemfiles/5.1.gemfile
-  - rvm: 2.2.0
-    gemfile: gemfiles/5.0.gemfile
-  - rvm: 2.2.0
-    gemfile: gemfiles/5.1.gemfile
-  - rvm: 1.9.3
-    gemfile: gemfiles/5.2.gemfile
   - rvm: 2.0
     gemfile: gemfiles/5.2.gemfile
-  - rvm: 2.1
-    gemfile: gemfiles/5.2.gemfile
-  - rvm: 2.2.0
+  - rvm: 2.0
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.1.10
+    gemfile: gemfiles/5.0.gemfile
+  - rvm: 2.1.10
+    gemfile: gemfiles/5.1.gemfile
+  - rvm: 2.1.10
     gemfile: gemfiles/5.2.gemfile
-
+  - rvm: 2.1.10
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.2.2
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.3.8
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.4.9
+    gemfile: gemfiles/6.0.gemfile
 
 before_install:
-  - gem update --system && gem install bundler
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler --version=1.17.3
 
 script:
   - RAILS_ENV=test bundle exec rake spec && bundle exec codeclimate-test-reporter

data/Appraisals

@@ -13,3 +13,7 @@ end
 appraise "5.2" do
   gem "rails", "~> 5.2"
 end
+
+appraise "6.0" do
+  gem 'rails', '~> 6.0'
+end

data/CHANGELOG.md

@@ -1,3 +1,78 @@
+## 3.4.0 (November 9th, 2019)
+
+Features:
+- Improve DualAdapter (@santib, #588), adds a new configuration for the DualAdapter, making it possible to keep consistency for logged_out/logged_in users. It's a opt-in flag. No Behavior was changed on this release.
+- Make dashboard pagination default "per" param configurable (@alopatin, #597)
+
+Bugfixes:
+- Fix `force_alternative` for experiments with incremented version (@giraffate, #568)
+- Persist alternative weights (@giraffate, #570)
+- Combined experiment performance improvements (@gnanou, #575)
+- Handle correctly case when ab_finished is called before ab_test for a user (@gnanou, #577)
+- When loading active_experiments, it should not look into user's 'finished' keys (@andrehjr, #582)
+
+Misc:
+- Remove `rubyforge_project` from gemspec (@giraffate, #583)
+- Fix URLs to replace http with https (@giraffate , #584)
+- Lazily include split helpers in ActionController::Base (@hasghari, #586)
+- Fix unused variable warnings (@andrehjr, #592)
+- Fix ruby warnings (@andrehjr, #593)
+- Update rubocop.yml config (@andrehjr, #594)
+- Add frozen_string_literal to all files that were missing it (@andrehjr, #595)
+
+## 3.3.2 (April 12th, 2019)
+
+Features:
+- Added uptime robot to configuration.rb (@razel1982, #556)
+- Check to see if being run in Rails application and run in before_initialize (@husteadrobert, #555)
+
+Bugfixes:
+- Fix error message interpolation (@hanibash, #553)
+- Fix Bigdecimal warnings (@agraves, #551)
+- Avoid hitting up on redis for robots/excluded users. (@andrehjr, #544)
+- Checks for defined?(request) on Helper#exclude_visitor?. (@andrehjr)
+
+Misc:
+- Update travis to add Rails 6 (@edmilton, #559)
+- Fix broken specs in developement environment (@dougpetronilio, #557)
+
+## 3.3.1 (January 11th, 2019)
+
+Features:
+- Filter some more bots (@janosch-x, #542)
+
+Bugfixes:
+- Fix Dashboard Pagination Helper typo (@cattekin, #541)
+- Do not storage alternative in cookie if experiment has a winner (@sadhu89, #539)
+- fix user participating alternative not found (@NaturalHokke, #536)
+
+Misc:
+- Tweak RSpec instructions (@eliotsykes, #540)
+- Improve README regarding rspec usage (@vermaxik, #538)
+
+## 3.3.0 (August 13th, 2018)
+
+Features:
+
+- Added pagination for dashboard (@GeorgeGorbanev, #518)
+- Add Facebot crawler to list of bots (@pfeiffer, #530)
+- Ignore previewing requests (@pfeiffer, #531)
+- Fix binding of ignore_filter (@pfeiffer, #533)
+
+Bugfixes:
+
+- Fix cookie header duplication (@andrehjr, #522)
+
+Performance:
+
+- Improve performance of RedisInterface#make_list_length by using LTRIM command (@mlovic, #509)
+
+Misc:
+
+- Update development dependencies
+- test rails 5.2 on travis (@lostapathy, #524)
+- update ruby versions for travis (@lostapathy, #525)
+
 ## 3.2.0 (September 21st, 2017)
 
 Features:

data/CODE_OF_CONDUCT.md

@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at [https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,13 +1,13 @@
-# [Split](http://libraries.io/rubygems/split)
+# [Split](https://libraries.io/rubygems/split)
 
 [![Gem Version](https://badge.fury.io/rb/split.svg)](http://badge.fury.io/rb/split)
-[![Build Status](https://secure.travis-ci.org/splitrb/split.svg?branch=master)](http://travis-ci.org/splitrb/split)
+[![Build Status](https://secure.travis-ci.org/splitrb/split.svg?branch=master)](https://travis-ci.org/splitrb/split)
 [![Code Climate](https://codeclimate.com/github/splitrb/split/badges/gpa.svg)](https://codeclimate.com/github/splitrb/split)
 [![Test Coverage](https://codeclimate.com/github/splitrb/split/badges/coverage.svg)](https://codeclimate.com/github/splitrb/split/coverage)
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![Open Source Helpers](https://www.codetriage.com/splitrb/split/badges/users.svg)](https://www.codetriage.com/splitrb/split)
 
-> 📈 The Rack Based A/B testing framework http://libraries.io/rubygems/split
+> 📈 The Rack Based A/B testing framework https://libraries.io/rubygems/split
 
 Split is a rack based A/B testing framework designed to work with Rails, Sinatra or any other rack based app.
 
@@ -110,9 +110,9 @@ Split has two options for you to use to determine which alternative is the best.
 
 The first option (default on the dashboard) uses a z test (n>30) for the difference between your control and alternative conversion rates to calculate statistical significance. This test will tell you whether an alternative is better or worse than your control, but it will not distinguish between which alternative is the best in an experiment with multiple alternatives. Split will only tell you if your experiment is 90%, 95%, or 99% significant, and this test only works if you have more than 30 participants and 5 conversions for each branch.
 
-As per this [blog post](http://www.evanmiller.org/how-not-to-run-an-ab-test.html) on the pitfalls of A/B testing, it is highly recommended that you determine your requisite sample size for each branch before running the experiment. Otherwise, you'll have an increased rate of false positives (experiments which show a significant effect where really there is none).
+As per this [blog post](https://www.evanmiller.org/how-not-to-run-an-ab-test.html) on the pitfalls of A/B testing, it is highly recommended that you determine your requisite sample size for each branch before running the experiment. Otherwise, you'll have an increased rate of false positives (experiments which show a significant effect where really there is none).
 
-[Here](http://www.evanmiller.org/ab-testing/sample-size.html) is a sample size calculator for your convenience.
+[Here](https://www.evanmiller.org/ab-testing/sample-size.html) is a sample size calculator for your convenience.
 
 The second option uses simulations from a beta distribution to determine the probability that the given alternative is the winner compared to all other alternatives. You can view these probabilities by clicking on the drop-down menu labeled "Confidence." This option should be used when the experiment has more than just 1 control and 1 alternative. It can also be used for a simple, 2-alternative A/B test.
 
@@ -159,15 +159,15 @@ In the event you want to disable all tests without having to know the individual
 
 It is not required to send `SPLIT_DISABLE=false` to activate Split.
 
-To aid testing with RSpec, write `split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
+
+### Rspec Helper
+To aid testing with RSpec, write `spec/support/split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
 
 ```ruby
-# Recommended path for this file is 'spec/support/split_helper.rb', and you will need to ensure it
-# is `require`-d by rails_helper.rb or spec_helper.rb
+# Create a file with these contents at 'spec/support/split_helper.rb'
+# and ensure it is `require`d in your rails_helper.rb or spec_helper.rb
 module SplitHelper
 
-  # Usage:
-  #
   # Force a specific experiment alternative to always be returned:
   #   use_ab_test(signup_form: "single_page")
   #
@@ -176,18 +176,26 @@ module SplitHelper
   #
   def use_ab_test(alternatives_by_experiment)
     allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment|
-      alternative =
-        alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
+      alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
     end
   end
 end
 
+# Make the `use_ab_test` method available to all specs:
 RSpec.configure do |config|
-  # Make the `use_ab_test` method available to all specs:
   config.include SplitHelper
 end
 ```
 
+Now you can call `use_ab_test(alternatives_by_experiment)`  in your specs, for example:
+```ruby
+it "registers using experimental signup" do
+  use_ab_test experiment_name: "alternative_name"
+  post "/signups"
+  ...
+end
+```
+
 
 ### Starting experiments manually
 
@@ -210,6 +218,12 @@ The user will then always see the alternative they started with.
 
 Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
 
+### Reset experiments manually
+
+By default Split automatically resets the experiment whenever it detects the configuration for an experiment has changed (e.g. you call `ab_test` with different alternatives). You can prevent this by setting the option `reset_manually` to `true`.
+
+You may want to do this when you want to change something, like the variants' names, the metadata about an experiment, etc. without resetting everything.
+
 ### Multiple experiments at once
 
 By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.
@@ -346,7 +360,7 @@ end
 
 If you are running `ab_test` from a view, you must define your event
 hook callback as a
-[helper_method](http://apidock.com/rails/AbstractController/Helpers/ClassMethods/helper_method)
+[helper_method](https://apidock.com/rails/AbstractController/Helpers/ClassMethods/helper_method)
 in the controller:
 
 ``` ruby
@@ -432,7 +446,7 @@ match "/split" => Split::Dashboard, anchor: false, via: [:get, :post, :delete],
 end
 ```
 
-More information on this [here](http://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
+More information on this [here](https://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
 
 ### Screenshot
 
@@ -450,6 +464,7 @@ Split.configure do |config|
   config.enabled = true
   config.persistence = Split::Persistence::SessionAdapter
   #config.start_manually = false ## new test will have to be started manually from the admin panel. default false
+  #config.reset_manually = false ## if true, it never resets the experiment data, even if the configuration changes
   config.include_rails_helper = true
   config.redis = "redis://custom.redis.url:6380"
 end
@@ -541,7 +556,7 @@ and:
 ab_finished(:my_first_experiment)
 ```
 
-You can also add meta data for each experiment, very useful when you need more than an alternative name to change behaviour:
+You can also add meta data for each experiment, which is very useful when you need more than an alternative name to change behaviour:
 
 ```ruby
 Split.configure do |config|
@@ -586,6 +601,8 @@ or in views:
 <% end %>
 ```
 
+The keys used in meta data should be Strings
+
 #### Metrics
 
 You might wish to track generic metrics, such as conversions, and use
@@ -809,8 +826,8 @@ end
 
 ## Extensions
 
-  - [Split::Export](http://github.com/splitrb/split-export) - Easily export A/B test data out of Split.
-  - [Split::Analytics](http://github.com/splitrb/split-analytics) - Push test data to Google Analytics.
+  - [Split::Export](https://github.com/splitrb/split-export) - Easily export A/B test data out of Split.
+  - [Split::Analytics](https://github.com/splitrb/split-analytics) - Push test data to Google Analytics.
   - [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - Store experiment data in mongoid (still uses redis).
   - [Split::Cacheable](https://github.com/harrystech/split_cacheable) - Automatically create cache buckets per test.
   - [Split::Counters](https://github.com/bernardkroes/split-counters) - Add counters per experiment and alternative.
@@ -822,7 +839,7 @@ Ryan bates has produced an excellent 10 minute screencast about split on the Rai
 
 ## Blogposts
 
-* [Recipe: A/B testing with KISSMetrics and the split gem](http://robots.thoughtbot.com/post/9595887299/recipe-a-b-testing-with-kissmetrics-and-the-split-gem)
+* [Recipe: A/B testing with KISSMetrics and the split gem](https://robots.thoughtbot.com/post/9595887299/recipe-a-b-testing-with-kissmetrics-and-the-split-gem)
 * [Rails A/B testing with Split on Heroku](http://blog.nathanhumbert.com/2012/02/rails-ab-testing-with-split-on-heroku.html)
 
 ## Backers
@@ -902,9 +919,9 @@ Please do! Over 70 different people have contributed to the project, you can see
 
 ### Development
 
-The source code is hosted at [GitHub](http://github.com/splitrb/split).
+The source code is hosted at [GitHub](https://github.com/splitrb/split).
 
-Report issues and feature requests on [GitHub Issues](http://github.com/splitrb/split/issues).
+Report issues and feature requests on [GitHub Issues](https://github.com/splitrb/split/issues).
 
 You can find a discussion form on [Google Groups](https://groups.google.com/d/forum/split-ruby).
 
@@ -935,4 +952,4 @@ Please note that this project is released with a [Contributor Code of Conduct](C
 
 ## Copyright
 
-[MIT License](LICENSE) © 2018 [Andrew Nesbitt](https://github.com/andrew).
+[MIT License](LICENSE) © 2019 [Andrew Nesbitt](https://github.com/andrew).

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'appraisal'

data/gemfiles/6.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "codeclimate-test-reporter"
+gem "rails", "~> 6.0"
+
+gemspec path: "../"

data/lib/split/algorithms/block_randomization.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Selects alternative with minimum count of participants
 # If all counts are even (i.e. all are minimum), samples from all possible alternatives
 

data/lib/split/alternative.rb

@@ -15,7 +15,7 @@ module Split
         @name = name
         @weight = 1
       end
-      p_winner = 0.0
+      @p_winner = 0.0
     end
 
     def to_s
@@ -75,7 +75,7 @@ module Split
       return field
     end
 
-    def set_completed_count (count, goal = nil)
+    def set_completed_count(count, goal = nil)
       field = set_field(goal)
       Split.redis.hset(key, field, count.to_i)
     end
@@ -122,7 +122,7 @@ module Split
       # can't calculate zscore for P(x) > 1
       return 'N/A' if p_a > 1 || p_c > 1
 
-      z_score = Split::Zscore.calculate(p_a, n_a, p_c, n_c)
+      Split::Zscore.calculate(p_a, n_a, p_c, n_c)
     end
 
     def extra_info

data/lib/split/combined_experiments_helper.rb

@@ -3,7 +3,7 @@ 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?
+      raise(Split::InvalidExperimentsFormatError, "Unable to find experiment #{metric_descriptor} in configuration") if experiment[:combined_experiments].nil?
 
       alternative = nil
       weighted_alternatives = nil
@@ -31,7 +31,7 @@ module Split
       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]
+      Split::configuration.experiments[metric_descriptor.to_sym]
     end
   end
 end

data/lib/split/configuration.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 module Split
   class Configuration
-    attr_accessor :bots
-    attr_accessor :robot_regex
     attr_accessor :ignore_ip_addresses
     attr_accessor :ignore_filter
     attr_accessor :db_failover
@@ -27,9 +25,13 @@ module Split
     attr_accessor :beta_probability_simulations
     attr_accessor :winning_alternative_recalculation_interval
     attr_accessor :redis
+    attr_accessor :dashboard_pagination_default_per_page
 
     attr_reader :experiments
 
+    attr_writer :bots
+    attr_writer :robot_regex
+
     def bots
       @bots ||= {
         # Indexers
@@ -61,12 +63,14 @@ module Split
         'ColdFusion' => 'ColdFusion http library',
         'EventMachine HttpClient' => 'Ruby http library',
         'Go http package' => 'Go http library',
+        'Go-http-client' => 'Go http library',
         'Java' => 'Generic Java http library',
         'libwww-perl' => 'Perl client-server library loved by script kids',
         'lwp-trivial' => 'Another Perl library loved by script kids',
         'Python-urllib' => 'Python http library',
         'PycURL' => 'Python http library',
         'Test Certificate Info' => 'C http library?',
+        'Typhoeus' => 'Ruby http library',
         'Wget' => 'wget unix CLI http client',
 
         # URL expanders / previewers
@@ -91,10 +95,12 @@ module Split
 
         # Uptime monitoring
         'check_http' => 'Nagios monitor',
+        'GoogleStackdriverMonitoring' => 'Google Cloud monitor',
         'NewRelicPinger' => 'NewRelic monitor',
         'Panopta' => 'Monitoring service',
         'Pingdom' => 'Pingdom monitoring',
         'SiteUptime' => 'Site monitoring services',
+        'UptimeRobot' => 'Monitoring service',
 
         # ???
         'DigitalPersona Fingerprint Software' => 'HP Fingerprint scanner',
@@ -221,6 +227,7 @@ module Split
       @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')
+      @dashboard_pagination_default_per_page = 10
     end
 
     def redis_url=(value)

data/lib/split/dashboard/helpers.rb

@@ -19,9 +19,9 @@ module Split
 
     def round(number, precision = 2)
       begin
-        BigDecimal.new(number.to_s)
+        BigDecimal(number.to_s)
       rescue ArgumentError
-        BigDecimal.new(0)
+        BigDecimal(0)
       end.round(precision).to_f
     end
 

data/lib/split/dashboard/pagination_helpers.rb

@@ -3,10 +3,9 @@ require 'split/dashboard/paginator'
 
 module Split
   module DashboardPaginationHelpers
-    DEFAULT_PER = 10
-
     def pagination_per
-      @pagination_per ||= (params[:per] || DEFAULT_PER).to_i
+      default_per_page = Split.configuration.dashboard_pagination_default_per_page
+      @pagination_per ||= (params[:per] || default_per_page).to_i
     end
 
     def page_number
@@ -25,7 +24,7 @@ module Split
       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 << last_page_tag(collection) if show_last_page_tag?(collection)
       html.join
     end
 

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

@@ -21,7 +21,7 @@
   </div>
 
   <div id="footer">
-    <p>Powered by <a href="http://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
+    <p>Powered by <a href="https://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
   </div>
 </body>
 </html>

data/lib/split/dashboard.rb

@@ -33,7 +33,10 @@ module Split
     end
 
     post '/force_alternative' do
-      Split::User.new(self)[params[:experiment]] = params[:alternative]
+      experiment = Split::ExperimentCatalog.find(params[:experiment])
+      alternative = Split::Alternative.new(params[:alternative], experiment.name)
+      alternative.increment_participation
+      Split::User.new(self)[experiment.key] = alternative.name
       redirect url('/')
     end
 

data/lib/split/engine.rb

@@ -3,10 +3,12 @@ module Split
   class Engine < ::Rails::Engine
     initializer "split" do |app|
       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
+        ActiveSupport.on_load(:action_controller) do
+          include Split::Helper
+          helper Split::Helper
+          include Split::CombinedExperimentsHelper
+          helper Split::CombinedExperimentsHelper
+        end
       end
     end
   end