split 3.0.0 → 4.0.1

data/.rubocop_todo.yml

@@ -0,0 +1,226 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-07-05 01:43:26 UTC using RuboCop version 0.86.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/CommentIndentation:
+  Exclude:
+    - 'lib/split/experiment.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/ElseAlignment:
+  Exclude:
+    - 'lib/split/experiment.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: around, only_before
+Layout/EmptyLinesAroundAccessModifier:
+  Exclude:
+    - 'lib/split/algorithms/block_randomization.rb'
+    - 'lib/split/algorithms/whiplash.rb'
+    - 'lib/split/alternative.rb'
+    - 'lib/split/configuration.rb'
+    - 'lib/split/dashboard/pagination_helpers.rb'
+    - 'lib/split/encapsulated_helper.rb'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/goals_collection.rb'
+    - 'lib/split/persistence/cookie_adapter.rb'
+    - 'lib/split/persistence/dual_adapter.rb'
+    - 'lib/split/redis_interface.rb'
+    - 'lib/split/trial.rb'
+    - 'lib/split/user.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/split/experiment_catalog.rb'
+    - 'lib/split/goals_collection.rb'
+    - 'lib/split/metric.rb'
+    - 'lib/split/persistence/cookie_adapter.rb'
+    - 'lib/split/persistence/redis_adapter.rb'
+    - 'lib/split/persistence/session_adapter.rb'
+    - 'lib/split/zscore.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/split/dashboard/helpers.rb'
+    - 'lib/split/zscore.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/split/encapsulated_helper.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, AutoCorrect, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/split/configuration.rb'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/trial.rb'
+
+# Offense count: 17
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/split/algorithms/block_randomization.rb'
+    - 'lib/split/algorithms/whiplash.rb'
+    - 'lib/split/alternative.rb'
+    - 'lib/split/configuration.rb'
+    - 'lib/split/dashboard/pagination_helpers.rb'
+    - 'lib/split/encapsulated_helper.rb'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/goals_collection.rb'
+    - 'lib/split/persistence/cookie_adapter.rb'
+    - 'lib/split/persistence/dual_adapter.rb'
+    - 'lib/split/redis_interface.rb'
+    - 'lib/split/trial.rb'
+    - 'lib/split/user.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+    - 'lib/split/goals_collection.rb'
+    - 'lib/split/persistence/dual_adapter.rb'
+    - 'lib/split/persistence/redis_adapter.rb'
+    - 'lib/split/user.rb'
+
+# Offense count: 15
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'lib/split/configuration.rb'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/experiment_catalog.rb'
+    - 'lib/split/helper.rb'
+    - 'lib/split/trial.rb'
+
+# Offense count: 35
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'lib/split.rb'
+    - 'lib/split/configuration.rb'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/experiment_catalog.rb'
+    - 'lib/split/helper.rb'
+    - 'lib/split/trial.rb'
+    - 'lib/split/user.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/split/experiment.rb'
+    - 'lib/split/helper.rb'
+    - 'lib/split/persistence/redis_adapter.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingEmptyLines:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/split/helper.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/split/goals_collection.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, conditionals
+Style/AndOr:
+  Exclude:
+    - 'lib/split/experiment_catalog.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ColonMethodCall:
+  Exclude:
+    - 'lib/split/combined_experiments_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/DefWithParentheses:
+  Exclude:
+    - 'lib/split/helper.rb'
+
+# Offense count: 23
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/experiment_catalog.rb'
+    - 'lib/split/helper.rb'
+    - 'lib/split/metric.rb'
+    - 'lib/split/persistence.rb'
+    - 'lib/split/persistence/redis_adapter.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: require_parentheses, require_no_parentheses, require_no_parentheses_except_multiline
+Style/MethodDefParentheses:
+  Exclude:
+    - 'lib/split/configuration.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/split/alternative.rb'
+    - 'lib/split/experiment.rb'
+    - 'lib/split/helper.rb'
+    - 'lib/split/zscore.rb'
+
+# Offense count: 258
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false

data/Appraisals

@@ -4,5 +4,16 @@ end
 
 appraise "5.0" do
   gem "rails", "~> 5.0"
-  gem "sinatra", git: "https://github.com/sinatra/sinatra"
+end
+
+appraise "5.1" do
+  gem "rails", "~> 5.1"
+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,160 @@
+## 4.0.1 (December 30th, 2021)
+
+Bugfixes:
+- ab_test must return metadata on error or if split is disabled/excluded user (@andrehjr, #622)
+- Fix versioned experiments when used with allow_multiple_experiments=control (@andrehjr, #613)
+- Only block Pinterest bot (@huoxito, #606)
+- Respect experiment defaults when loading experiments in initializer. (@mattwd7, #599)
+- Removes metadata key when it updated to nil (@andrehjr, #633)
+- Force experiment does not count for metrics (@andrehjr, #637)
+- Fix cleanup_old_versions! misbehaviour (@serggl, #661)
+
+Features:
+- Make goals accessible via on_trial_complete callbacks (@robin-phung, #625)
+- Replace usage of SimpleRandom with RubyStats(Used for Beta Distribution RNG) (@andrehjr, #616)
+- Introduce enable/disable experiment cohorting (@robin-phung, #615)
+- Add on_experiment_winner_choose callback (@GenaMinenkov, #574)
+- Add Split::Cache to reduce load on Redis (@rdh, #648)
+- Caching based optimization in the experiment#save path (@amangup, #652)
+- Adds config option for cookie domain (@joedelia, #664)
+
+Misc:
+- Drop support for Ruby < 2.5 (@andrehjr, #627)
+- Drop support for Rails < 5 (@andrehjr, #607)
+- Bump minimum required redis to 4.2 (@andrehjr, #628)
+- Removed repeated loading from config (@robin-phung, #619)
+- Simplify RedisInterface usage when persisting Experiment alternatives (@andrehjr, #632)
+- Remove redis_url impl. Deprecated on version 2.2 (@andrehjr, #631)
+- Remove thread_safe config as redis-rb is thread_safe by default (@andrehjr, #630)
+- Fix typo of in `Split::Trial` class variable (TomasBarry, #644)
+- Single HSET to update values, instead of multiple ones (@andrehjr, #640)
+- Use Redis#hmset to keep compatibility with Redis < 4.0 (@andrehjr, #659)
+- Remove 'set' parsing for alternatives. Sets were used as storage and deprecated on 0.x (@andrehjr, #639)
+- Adding documentation related to what is stored on cookies. (@andrehjr, #634)
+- Keep railtie defined under the Split gem namespace (@avit, #666)
+- Update RSpec helper to support block syntax (@clowder, #665)
+
+## 3.4.1 (November 12th, 2019)
+
+Bugfixes:
+- Reference ActionController directly when including split helpers, to avoid breaking Rails API Controllers (@andrehjr, #602)
+
+## 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:
+
+- Allow configuration of how often winning alternatives are recalculated (@patbl, #501)
+
+Bugfixes:
+
+- Avoid z_score numeric exception for conversion rates >1 (@cmantas, #503)
+- Fix combined experiments (@semanticart, #502)
+
+## 3.1.1 (August 30th, 2017)
+
+Bugfixes:
+
+- Bring back support for ruby 1.9.3 and greater (rubygems 2.0.0 or greater now required) (@patbl, #498)
+
+Misc:
+
+- Document testing with RSpec (@eliotsykes, #495)
+
+## 3.1.0 (August 14th, 2017)
+
+Features:
+
+- Support for combined experiments (@daviddening, #493)
+- Rewrite CookieAdapter to work with Rack::Request and Rack::Response directly (@andrehjr, #490)
+- Enumeration of a User's Experiments that Respects the db_failover Option(@MarkRoddy, #487)
+
+Bugfixes:
+
+- Blocked a few more common bot user agents (@kylerippey, #485)
+
+Misc:
+
+- Repository Audit by Maintainer.io (@RichardLitt, #484)
+- Update development dependencies
+- Test on ruby 2.4.1
+- Test compatibility with rails 5.1
+- Add uris to metadata section in gemspec
+
 ## 3.0.0 (March 30th, 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/CONTRIBUTING.md

@@ -1,13 +1,62 @@
-## Contributing
+# Contributing to Split
 
-*Note*: Split requires Ruby 1.9.2 or higher. 
+Want to contribute to Split? That's great! Here are a couple of guidelines that will help you contribute. Before we get started: Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming place for **everyone** to contribute to. By participating in this project you agree to abide by its terms.
+
+#### Overview
+
+* [Contribution workflow](#contribution-workflow)
+* [Setup instructions](#setup-instructions)
+* [Reporting a bug](#reporting-a-bug)
+* [Contributing to an existing issue](#contributing-to-an-existing-issue)
+* [Our labels](#our-labels)
+* [Additional info](#additional-info)
+
+## Contribution workflow
 
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Add documentation if necessary.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Commit. Do not mess with  the Rakefile, version, or history.
+  (If you want to have your own version, that is fine. But bump version in a commit by itself I can ignore when I pull.)
 * Send a pull request. Bonus points for topic branches.
-* Discussion at the [Google Group](https://groups.google.com/d/forum/split-ruby)
+* Discussion at the [Google Group](https://groups.google.com/d/forum/split-ruby)
+
+## Setup instructions
+
+You can find in-depth instructions to install in our [README](https://github.com/splitrb/split/blob/master/README.md).
+
+*Note*: Split requires Ruby 1.9.2 or higher.
+
+## Reporting a bug
+
+So you've found a bug, and want to help us fix it? Before filing a bug report, please double-check the bug hasn't already been reported. You can do so [on our issue tracker](https://github.com/splitrb/split/issues?q=is%3Aissue+is%3Aopen+label%3Abug). If something hasn't been raised, you can go ahead and create a new issue with the following information:
+
+* When did the error happen?
+* How can the error be reproduced?
+* If possible, please also provide an error message or a screenshot to illustrate the problem.
+
+If you want to be really thorough, there is a great overview on Stack Overflow of [what you should consider when reporting a bug](http://stackoverflow.com/questions/240323/how-to-report-bugs-the-smart-way).
+
+It goes without saying that you're welcome to help investigate further and/or find a fix for the bug. If you want to do so, just mention it in your bug report and offer your help!
+
+## Contributing to an existing issue
+
+### Finding an issue to work on 
+
+We've got a few open issues and are always glad to get help on that front. You can view the list of issues [here](https://github.com/splitrb/split/issues). Most of the issues are labelled, so you can use the labels to get an idea of which issue could be a good fit for you. (Here's [a good article](https://medium.freecodecamp.com/finding-your-first-open-source-project-or-bug-to-work-on-1712f651e5ba) on how to find your first bug to fix).
+
+Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.
+
+If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.
+
+Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?
+
+And if at any point you get stuck: don't hesitate to ask for help. 
+
+### Making your contribution  
+
+We've outlined the contribution workflow [here](#contribution-workflow). If you're a first-timer, don't worry! GitHub has a ton of guides to help you through your first pull request: You can find out more about pull requests [here](https://help.github.com/articles/about-pull-requests/) and about creating a pull request [here](https://help.github.com/articles/creating-a-pull-request/).
+
+Especially if you're a newcomer to Open Source and you've found some little bumps along the way while contributing, we recommend you write about them. [Here](https://medium.freecodecamp.com/new-contributors-to-open-source-please-blog-more-920af14cffd)'s a great article about why writing about your experience is important; this will encourage other beginners to try their luck at Open Source, too!

data/Gemfile

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

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Andrew Nesbitt
+Copyright (c) 2017 Andrew Nesbitt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the