split 3.3.2 → 3.4.0

data/.travis.yml

@@ -3,11 +3,11 @@ rvm:
   - 1.9.3
   - 2.0
   - 2.1.10
-  - 2.2.0
   - 2.2.2
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 
 gemfile:
   - gemfiles/4.2.gemfile
@@ -16,7 +16,6 @@ gemfile:
   - gemfiles/5.2.gemfile
   - gemfiles/6.0.gemfile
 
-
 matrix:
   exclude:
   - rvm: 1.9.3
@@ -43,20 +42,15 @@ matrix:
     gemfile: gemfiles/5.2.gemfile
   - rvm: 2.1.10
     gemfile: gemfiles/6.0.gemfile
-  - rvm: 2.2.0
-    gemfile: gemfiles/5.0.gemfile
-  - rvm: 2.2.0
-    gemfile: gemfiles/5.1.gemfile
-  - rvm: 2.2.0
-    gemfile: gemfiles/5.2.gemfile
-  - rvm: 2.2.0
-    gemfile: gemfiles/6.0.gemfile
   - rvm: 2.2.2
     gemfile: gemfiles/6.0.gemfile
-  - rvm: 2.4.5
+  - rvm: 2.3.8
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.4.9
     gemfile: gemfiles/6.0.gemfile
 
 before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
   - gem install bundler --version=1.17.3
 
 script:

data/Appraisals

@@ -15,5 +15,5 @@ appraise "5.2" do
 end
 
 appraise "6.0" do
-  gem 'rails', '~> 6.0.0.beta3'
+  gem 'rails', '~> 6.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 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:

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.
 
@@ -360,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
@@ -446,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
 
@@ -556,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|
@@ -601,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
@@ -824,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.
@@ -837,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
@@ -917,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).
 

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

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "codeclimate-test-reporter"
-gem "rails", "~> 6.0.0.beta3"
+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

@@ -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
@@ -225,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.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/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

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

data/lib/split/experiment.rb

@@ -2,13 +2,13 @@
 module Split
   class Experiment
     attr_accessor :name
-    attr_writer :algorithm
-    attr_accessor :resettable
     attr_accessor :goals
-    attr_accessor :alternatives
     attr_accessor :alternative_probabilities
     attr_accessor :metadata
 
+    attr_reader :alternatives
+    attr_reader :resettable
+
     DEFAULT_OPTIONS = {
       :resettable => true
     }
@@ -25,7 +25,7 @@ module Split
           alternatives: load_alternatives_from_configuration,
           goals: Split::GoalsCollection.new(@name).load_from_configuration,
           metadata: load_metadata_from_configuration,
-          resettable: exp_config[:resettable],
+          resettable: exp_config.fetch(:resettable, true),
           algorithm: exp_config[:algorithm]
         }
       else
@@ -62,7 +62,7 @@ module Split
           alts = load_alternatives_from_configuration
           options[:goals] = Split::GoalsCollection.new(@name).load_from_configuration
           options[:metadata] = load_metadata_from_configuration
-          options[:resettable] = exp_config[:resettable]
+          options[:resettable] = exp_config.fetch(:resettable, true)
           options[:algorithm] = exp_config[:algorithm]
         end
       end
@@ -81,12 +81,12 @@ module Split
 
       if new_record?
         start unless Split.configuration.start_manually
+        persist_experiment_configuration
       elsif experiment_configuration_has_changed?
         reset unless Split.configuration.reset_manually
+        persist_experiment_configuration
       end
 
-      persist_experiment_configuration if new_record? || experiment_configuration_has_changed?
-
       redis.hset(experiment_config_key, :resettable, resettable)
       redis.hset(experiment_config_key, :algorithm, algorithm.to_s)
       self
@@ -144,11 +144,13 @@ module Split
     end
 
     def has_winner?
-      !winner.nil?
+      return @has_winner if defined? @has_winner
+      @has_winner = !winner.nil?
     end
 
     def winner=(winner_name)
       redis.hset(:experiment_winner, name, winner_name.to_s)
+      @has_winner = true
     end
 
     def participant_count
@@ -161,6 +163,7 @@ module Split
 
     def reset_winner
       redis.hdel(:experiment_winner, name)
+      @has_winner = false
     end
 
     def start
@@ -420,14 +423,22 @@ module Split
     end
 
     def load_alternatives_from_redis
-      case redis.type(@name)
-      when 'set' # convert legacy sets to lists
-        alts = redis.smembers(@name)
-        redis.del(@name)
-        alts.reverse.each {|a| redis.lpush(@name, a) }
-        redis.lrange(@name, 0, -1)
-      else
-        redis.lrange(@name, 0, -1)
+      alternatives = case redis.type(@name)
+                     when 'set' # convert legacy sets to lists
+                       alts = redis.smembers(@name)
+                       redis.del(@name)
+                       alts.reverse.each {|a| redis.lpush(@name, a) }
+                       redis.lrange(@name, 0, -1)
+                     else
+                       redis.lrange(@name, 0, -1)
+                     end
+      alternatives.map do |alt|
+        alt = begin
+                JSON.parse(alt)
+              rescue
+                alt
+              end
+        Split::Alternative.new(alt, @name)
       end
     end
 
@@ -443,7 +454,7 @@ module Split
 
     def persist_experiment_configuration
       redis_interface.add_to_set(:experiments, name)
-      redis_interface.persist_list(name, @alternatives.map(&:name))
+      redis_interface.persist_list(name, @alternatives.map{|alt| {alt.name => alt.weight}.to_json})
       goals_collection.save
       redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
     end
@@ -459,7 +470,7 @@ module Split
       existing_alternatives = load_alternatives_from_redis
       existing_goals = Split::GoalsCollection.new(@name).load_from_redis
       existing_metadata = load_metadata_from_redis
-      existing_alternatives != @alternatives.map(&:name) ||
+      existing_alternatives.map(&:to_s) != @alternatives.map(&:to_s) ||
         existing_goals != @goals ||
         existing_metadata != @metadata
     end