split 4.0.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b66f4b21c4201228d9622d5e00ff2a2e957714edfce11316316a2ca3e405ce
-  data.tar.gz: 6a441cf39a14ef9e36b805e7728f34029db7f7d1e1e90f3389168942b7b77f60
+  metadata.gz: 746dd3b526b5464f12e01e2f00f8ff62b71ac6483527632f6f0bca7bc5242e8c
+  data.tar.gz: bb40ca355a1aa9eec9cfb4067e6e2b3c381072830cffadffe414f8d7a4af043f
 SHA512:
-  metadata.gz: bc46df4b6f301b8bdaf99ba4648f7363ad2c1234b3be7586e078b9772fec9a2bae3c9e15335c0c207e88c45113a1348a0dcd608a9dcfee654846753ba59c6696
-  data.tar.gz: 53dffc60d0f0617f1a1e943170f7702eff6ec5d00381b9d3b19380ef50aaef4c76956974a94a645bfb288eddd75486f24c2c2d3c56e7465f85f68791f1aeda31
+  metadata.gz: 70466ddfe57955a43dda0506c4a23806f6bdab154b344e495879027ae2baebec93d59f34018e78a3e83ef945c776c7a2ddcf2b40cd71998fb0bc9207ed60df61
+  data.tar.gz: db1d46d7e7e1826aacf80ec1c8634f0502bd07d4b58d488e57f4917a8843954d568b4cd20c9e2db09ac2ff80811b14ec68a3158b870d091eeabf4e426af8172d

data/.github/workflows/ci.yml

@@ -34,9 +34,11 @@ jobs:
           - gemfile: 7.0.gemfile
             ruby: '3.0'
 
-          # - gemfile: 7.0.gemfile
-          #   ruby: '3.1'
+          - gemfile: 7.0.gemfile
+            ruby: '3.1'
 
+          - gemfile: 7.0.gemfile
+            ruby: '3.2'
 
     runs-on: ubuntu-latest
 
@@ -51,7 +53,7 @@ jobs:
           --health-retries 5
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:
@@ -69,3 +71,6 @@ jobs:
         run: bundle exec rspec
         env:
           REDIS_URL: redis:6379
+
+      - name: Rubocop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -1,12 +1,9 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   TargetRubyVersion: 2.5
   DisabledByDefault: true
+  SuggestExtensions: false
   Exclude:
-    - 'Appraisals'
     - 'gemfiles/**/*'
-    - 'spec/**/*.rb'
 
 Style/AndOr:
   Enabled: true
@@ -114,7 +111,7 @@ Layout/SpaceInsideParens:
   Enabled: true
 
 Style/StringLiterals:
-  Enabled: false
+  Enabled: true
   EnforcedStyle: double_quotes
 
 Layout/IndentationStyle:

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+# 4.0.3 (November 15rd, 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:

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

@@ -4,5 +4,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "appraisal"
+gem "rubocop", require: false
 gem "codeclimate-test-reporter"

data/README.md

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

data/gemfiles/7.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", "~> 7.0"
 

data/lib/split/algorithms/block_randomization.rb

@@ -12,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/whiplash.rb

@@ -2,7 +2,6 @@
 
 # A multi-armed bandit implementation inspired by
 # @aaronsw and victorykit/whiplash
-require 'rubystats'
 
 module Split
   module Algorithms
@@ -13,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
-          Rubystats::BetaDistribution.new(a+fairness_constant, b+fairness_constant).rng
-        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

data/lib/split/alternative.rb

@@ -38,11 +38,11 @@ module Split
     end
 
     def participant_count
-      Split.redis.hget(key, 'participant_count').to_i
+      Split.redis.hget(key, "participant_count").to_i
     end
 
     def participant_count=(count)
-      Split.redis.hset(key, 'participant_count', count.to_i)
+      Split.redis.hset(key, "participant_count", count.to_i)
     end
 
     def completed_count(goal = nil)
@@ -67,13 +67,13 @@ module Split
     def set_field(goal)
       field = "completed_count"
       field += ":" + goal unless goal.nil?
-      return field
+      field
     end
 
     def set_prob_field(goal)
       field = "p_winner"
       field += ":" + goal unless goal.nil?
-      return field
+      field
     end
 
     def set_completed_count(count, goal = nil)
@@ -82,7 +82,7 @@ module Split
     end
 
     def increment_participation
-      Split.redis.hincrby key, 'participant_count', 1
+      Split.redis.hincrby key, "participant_count", 1
     end
 
     def increment_completion(goal = nil)
@@ -112,7 +112,7 @@ module Split
       control = experiment.control
       alternative = self
 
-      return 'N/A' if control.name == alternative.name
+      return "N/A" if control.name == alternative.name
 
       p_a = alternative.conversion_rate(goal)
       p_c = control.conversion_rate(goal)
@@ -121,13 +121,13 @@ module Split
       n_c = control.participant_count
 
       # can't calculate zscore for P(x) > 1
-      return 'N/A' if p_a > 1 || p_c > 1
+      return "N/A" if p_a > 1 || p_c > 1
 
       Split::Zscore.calculate(p_a, n_a, p_c, n_c)
     end
 
     def extra_info
-      data = Split.redis.hget(key, 'recorded_info')
+      data = Split.redis.hget(key, "recorded_info")
       if data && data.length > 1
         begin
           JSON.parse(data)
@@ -149,24 +149,24 @@ module Split
         @recorded_info[k] = value
       end
 
-      Split.redis.hset key, 'recorded_info', (@recorded_info || {}).to_json
+      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
+      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!
       unless String === @name || hash_with_correct_values?(@name)
-        raise ArgumentError, 'Alternative must be a string'
+        raise ArgumentError, "Alternative must be a string"
       end
     end
 
     def reset
-      Split.redis.hmset key, 'participant_count', 0, 'completed_count', 0, 'recorded_info', nil
+      Split.redis.hmset key, "participant_count", 0, "completed_count", 0, "recorded_info", ""
       unless goals.empty?
         goals.each do |g|
           field = "completed_count:#{g}"
@@ -180,13 +180,12 @@ module Split
     end
 
     private
+      def hash_with_correct_values?(name)
+        Hash === name && String === name.keys.first && Float(name.values.first) rescue false
+      end
 
-    def hash_with_correct_values?(name)
-      Hash === name && String === name.keys.first && Float(name.values.first) rescue false
-    end
-
-    def key
-      "#{experiment_name}:#{name}"
-    end
+      def key
+        "#{experiment_name}:#{name}"
+      end
   end
 end

data/lib/split/cache.rb

@@ -2,7 +2,6 @@
 
 module Split
   class Cache
-
     def self.clear
       @cache = nil
     end

data/lib/split/combined_experiments_helper.rb

@@ -29,10 +29,10 @@ module Split
     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
-      Split::configuration.experiments[metric_descriptor.to_sym]
+      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
+      Split.configuration.experiments[metric_descriptor.to_sym]
     end
   end
 end