split 3.4.1 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51ebd6a368635471d5c3f820488065669ac7dc1ad7ed7eba61f2c4154ca42b7
-  data.tar.gz: 7fabe9a63a07037b144b91a11c89675d48a6ec9a5883e47bf8193584c461d003
+  metadata.gz: 80d095f07432d336e773b30c3c5a873b554dd682f65ace33886d1a83697d447a
+  data.tar.gz: 9a504a3c9d4c67391528e1640c2c7eac3cfcafe91305cadb901e48541726f04c
 SHA512:
-  metadata.gz: 49c32cc9c769184b79716956046604e8f63de0fba0a87036f6cf2809803e74c376887db47e3a472d9b5acfb5172eb5d0bcea1c700bf74f799a5d259e0cf3dd49
-  data.tar.gz: b930240fd33d85f594fef51f756100f925581fc1ead0dd910a1a51417362c68ab03aea6adbb1b50076db78114a1bc842fd2cd2d4a9462b9d50aa43c25b166df8
+  metadata.gz: 68e5919618103f315fa9f4f0d18384392c02c01c680c13d50a77cfa0507bd19a1c01fb5c1db66619329c1ef38013c3ebe90e880f6af5c9bac9ba2d1a76b3963a
+  data.tar.gz: 1ae5fe0187e16b4bb3efc14a0e0ded4df98527fbc530dab4a89c544d133b1a7e8cd0adc6579f0f43ea3c84aa6899a2d123e97c5af105ce158e804a5ac8286728

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: split

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,76 @@
+name: split
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        include:
+          - gemfile: 5.2.gemfile
+            ruby: 2.5
+
+          - gemfile: 5.2.gemfile
+            ruby: 2.6
+
+          - gemfile: 5.2.gemfile
+            ruby: 2.7
+
+          - gemfile: 6.0.gemfile
+            ruby: 2.5
+
+          - gemfile: 6.0.gemfile
+            ruby: 2.6
+
+          - gemfile: 6.0.gemfile
+            ruby: 2.7
+
+          - gemfile: 6.0.gemfile
+            ruby: '3.0'
+
+          - gemfile: 6.1.gemfile
+            ruby: '3.0'
+
+          - gemfile: 7.0.gemfile
+            ruby: '3.0'
+
+          - gemfile: 7.0.gemfile
+            ruby: '3.1'
+
+          - gemfile: 7.0.gemfile
+            ruby: '3.2'
+
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        ports: ['6379:6379']
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: |
+          bundle config set gemfile "${GITHUB_WORKSPACE}/gemfiles/${{ matrix.gemfile }}"
+          bundle install --jobs 4 --retry 3
+
+      - name: Display Ruby version
+        run: ruby -v
+
+      - name: Test
+        run: bundle exec rspec
+        env:
+          REDIS_URL: redis:6379
+
+      - name: Rubocop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -1,7 +1,180 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
+  TargetRubyVersion: 2.5
+  DisabledByDefault: true
+  SuggestExtensions: false
   Exclude:
-    - 'Appraisals'
     - 'gemfiles/**/*'
-    - 'spec/**/*.rb'
+
+Style/AndOr:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/RedundantFreeze:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/IndentationStyle:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,90 @@
+# 4.0.4 (March 3rd, 2024)
+
+Bugfixes:
+- Better integration for EncapsulatedHelper when needing params/request info (@henrique-ft, #721 and #723)
+
+Misc:
+- Make specs compatible with newer Rack versions (@andrehjr,  #722)
+
+# 4.0.3 (November 15th, 2023)
+
+Bugfixes:
+- Do not throw error if alternativas have data that can lead to negative numbers for probability calculation (@andrehjr, #703)
+- Do not persist invalid extra_info on ab_record_extra_info. (@trostli @andrehjr, #717)
+- CROSSSLOT keys issue fix when using redis cluster (@naveen-chidhambaram, #710)
+- Convert value to string before saving it in RedisAdapter (@Jealrock, #714)
+- Fix deprecation warning with Redis 4.8.0 (@martingregoire, #701)
+
+Misc:
+- Add matrix as a default dependency (@andrehjr, #705)
+- Add Ruby 3.2 to Github Actions (@andrehjr, #702)
+- Update documentation regarding finding users outside a web session (@andrehjr, #716)
+- Update actions/checkout to v4 (@andrehjr, #718)
+
+# 4.0.2 (December 2nd, 2022)
+
+Bugfixes:
+- Stop crashing on non-hash json (@knarewski, #697)
+- Handle when Rails is partially loaded as a Gem (@TSMMark, #687)
+
+Features:
+- Add support for redis-client, which does not automatically cast types to strings (@knarewski, #696)
+- Add ability to initialize experiments (@robin-phung, #673)
+
+Misc:
+- Fix default branch name and gem metadata indentation (@ursm, #693)
+- Update actions/checkout to v3 (@andrehjr, #683)
+- Enforce double quotes (@andrehjr, #682)
+- Fix Rubocop Style/* Offenses (@andrehjr, #681)
+- Enable rubocop on Github Actions (@andrehjr, #680)
+- Fix all Layout issues on the project (@andrehjr, #679)
+- Fix Style/HashSyntax offenses (@andrehjr, #678)
+- Remove usage of deprecated implicit block expectation from specs (@andrehjr, #677)
+- Remove appraisals configuration (@andrehjr, #676)
+- Add Ruby 3.1 (@andrehjr, #675)
+- Encapsulate Split::Algorithms at our own module to avoid explicit calling rubystats everywhere (@andrehjr, #674)
+
+## 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:

data/CONTRIBUTING.md

@@ -25,7 +25,7 @@ Want to contribute to Split? That's great! Here are a couple of guidelines that
 
 ## Setup instructions
 
-You can find in-depth instructions to install in our [README](https://github.com/splitrb/split/blob/master/README.md).
+You can find in-depth instructions to install in our [README](https://github.com/splitrb/split/blob/main/README.md).
 
 *Note*: Split requires Ruby 1.9.2 or higher.
 

data/Gemfile

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
-gem "appraisal"
+gem "rubocop", require: false
 gem "codeclimate-test-reporter"

data/README.md

@@ -1,7 +1,7 @@
 # [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)](https://travis-ci.org/splitrb/split)
+![Build status](https://github.com/splitrb/split/actions/workflows/ci.yml/badge.svg?branch=main)
 [![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)
@@ -19,11 +19,13 @@ Split is designed to be hacker friendly, allowing for maximum customisation and
 
 ### Requirements
 
-Split currently requires Ruby 1.9.3 or higher. If your project requires compatibility with Ruby 1.8.x and Rails 2.3, please use v0.8.0.
+Split v4.0+ is currently tested with Ruby >= 2.5 and Rails >= 5.2.
+
+If your project requires compatibility with Ruby 2.4.x or older Rails versions. You can try v3.0 or v0.8.0(for Ruby 1.9.3)
 
 Split uses Redis as a datastore.
 
-Split only supports Redis 2.0 or greater.
+Split only supports Redis 4.0 or greater.
 
 If you're on OS X, Homebrew is the simplest way to install Redis:
 
@@ -175,8 +177,10 @@ module SplitHelper
   #   use_ab_test(signup_form: "single_page", pricing: "show_enterprise_prices")
   #
   def use_ab_test(alternatives_by_experiment)
-    allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment|
-      alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
+    allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment, &block|
+      variant = alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
+      block.call(variant) unless block.nil?
+      variant
     end
   end
 end
@@ -263,7 +267,7 @@ Split.configure do |config|
 end
 ```
 
-By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
+When using the cookie persistence, Split stores data into an anonymous tracking cookie named 'split', which expires in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
 
 ```ruby
 Split.configure do |config|
@@ -272,6 +276,8 @@ Split.configure do |config|
 end
 ```
 
+The data stored consists of the experiment name and the variants the user is in. Example: { "experiment_name" => "variant_a" }
+
 __Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
 
 #### Redis
@@ -386,6 +392,8 @@ Split.configure do |config|
   # before experiment reset or deleted
   config.on_before_experiment_reset  = -> (example) { # Do something on reset }
   config.on_before_experiment_delete = -> (experiment) { # Do something else on delete }
+  # after experiment winner had been set
+  config.on_experiment_winner_choose = -> (experiment) { # Do something on winner choose }
 end
 ```
 
@@ -644,7 +652,7 @@ The API to define goals for an experiment is this:
 ab_test({link_color: ["purchase", "refund"]}, "red", "blue")
 ```
 
-or you can you can define them in a configuration file:
+or you can define them in a configuration file:
 
 ```ruby
 Split.configure do |config|
@@ -752,6 +760,20 @@ split_config = YAML.load_file(Rails.root.join('config', 'split.yml'))
 Split.redis = split_config[Rails.env]
 ```
 
+### Redis Caching (v4.0+)
+
+In some high-volume usage scenarios, Redis load can be incurred by repeated 
+fetches for fairly static data.  Enabling caching will reduce this load.
+
+ ```ruby
+Split.configuration.cache = true
+````
+
+This currently caches:
+  - `Split::ExperimentCatalog.find`
+  - `Split::Experiment.start_time`
+  - `Split::Experiment.winner`
+
 ## Namespaces
 
 If you're running multiple, separate instances of Split you may want
@@ -768,7 +790,7 @@ library. To configure Split to use `Redis::Namespace`, do the following:
   ```
 
 2. Configure `Split.redis` to use a `Redis::Namespace` instance (possible in an
-   intializer):
+   initializer):
 
   ```ruby
   redis = Redis.new(url: ENV['REDIS_URL']) # or whatever config you want
@@ -785,10 +807,16 @@ conduct experiments that are not tied to a web session.
 ```ruby
 # create a new experiment
 experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
+
+# find the user
+user = Split::User.find(user_id, :redis)
+
 # create a new trial
-trial = Split::Trial.new(:experiment => experiment)
+trial = Split::Trial.new(user: user, experiment: experiment)
+
 # run trial
 trial.choose!
+
 # get the result, returns either red or blue
 trial.alternative.name
 

data/Rakefile

@@ -1,9 +1,9 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'appraisal'
 
-RSpec::Core::RakeTask.new('spec')
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-task :default => :spec
+RSpec::Core::RakeTask.new("spec")
+
+task default: :spec

data/gemfiles/5.2.gemfile

@@ -1,8 +1,6 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
-gem "appraisal"
+gem "rubocop", require: false
 gem "codeclimate-test-reporter"
 gem "rails", "~> 5.2"
 

data/gemfiles/6.0.gemfile

@@ -1,8 +1,6 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
-gem "appraisal"
+gem "rubocop", require: false
 gem "codeclimate-test-reporter"
 gem "rails", "~> 6.0"
 

data/gemfiles/{5.0.gemfile → 6.1.gemfile}

@@ -1,9 +1,7 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
-gem "appraisal"
+gem "rubocop", require: false
 gem "codeclimate-test-reporter"
-gem "rails", "~> 5.0"
+gem "rails", "~> 6.1"
 
 gemspec path: "../"

data/gemfiles/{5.1.gemfile → 7.0.gemfile}

@@ -1,9 +1,7 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
-gem "appraisal"
+gem "rubocop", require: false
 gem "codeclimate-test-reporter"
-gem "rails", "~> 5.1"
+gem "rails", "~> 7.0"
 
 gemspec path: "../"

data/lib/split/algorithms/block_randomization.rb

@@ -1,4 +1,5 @@
 # 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
 
@@ -11,12 +12,11 @@ module Split
         end
 
         private
-
-        def minimum_participant_alternatives(alternatives)
-          alternatives_by_count = alternatives.group_by(&:participant_count)
-          min_group = alternatives_by_count.min_by { |k, v| k }
-          min_group.last
-        end
+          def minimum_participant_alternatives(alternatives)
+            alternatives_by_count = alternatives.group_by(&:participant_count)
+            min_group = alternatives_by_count.min_by { |k, v| k }
+            min_group.last
+          end
       end
     end
   end

data/lib/split/algorithms/weighted_sample.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Split
   module Algorithms
     module WeightedSample
@@ -8,7 +9,7 @@ module Split
         total = weights.inject(:+)
         point = rand * total
 
-        experiment.alternatives.zip(weights).each do |n,w|
+        experiment.alternatives.zip(weights).each do |n, w|
           return n if w >= point
           point -= w
         end

data/lib/split/algorithms/whiplash.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 # A multi-armed bandit implementation inspired by
 # @aaronsw and victorykit/whiplash
-require 'simple-random'
 
 module Split
   module Algorithms
@@ -12,26 +12,25 @@ module Split
         end
 
         private
+          def arm_guess(participants, completions)
+            a = [participants, 0].max
+            b = [participants-completions, 0].max
+            Split::Algorithms.beta_distribution_rng(a + fairness_constant, b + fairness_constant)
+          end
 
-        def arm_guess(participants, completions)
-          a = [participants, 0].max
-          b = [participants-completions, 0].max
-          s = SimpleRandom.new; s.set_seed; s.beta(a+fairness_constant, b+fairness_constant)
-        end
-
-        def best_guess(alternatives)
-          guesses = {}
-          alternatives.each do |alternative|
-            guesses[alternative.name] = arm_guess(alternative.participant_count, alternative.all_completed_count)
+          def best_guess(alternatives)
+            guesses = {}
+            alternatives.each do |alternative|
+              guesses[alternative.name] = arm_guess(alternative.participant_count, alternative.all_completed_count)
+            end
+            gmax = guesses.values.max
+            best = guesses.keys.select { |name| guesses[name] ==  gmax }
+            best.sample
           end
-          gmax = guesses.values.max
-          best = guesses.keys.select { |name| guesses[name] ==  gmax }
-          best.sample
-        end
 
-        def fairness_constant
-          7
-        end
+          def fairness_constant
+            7
+          end
       end
     end
   end

data/lib/split/algorithms.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "matrix"
+require "rubystats"
+
+module Split
+  module Algorithms
+    class << self
+      def beta_distribution_rng(a, b)
+        Rubystats::BetaDistribution.new(a, b).rng
+      end
+    end
+  end
+end