split 4.0.1 → 4.0.3

data/spec/split_spec.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
-require 'spec_helper'
 
-RSpec.describe Split do
+require "spec_helper"
 
+RSpec.describe Split do
   around(:each) do |ex|
-    old_env, old_redis = [ENV.delete('REDIS_URL'), Split.redis]
+    old_env, old_redis = [ENV.delete("REDIS_URL"), Split.redis]
     ex.run
-    ENV['REDIS_URL'] = old_env
+    ENV["REDIS_URL"] = old_env
     Split.redis = old_redis
   end
 
-  describe '#redis=' do
-    it 'accepts a url string' do
-      Split.redis = 'redis://localhost:6379'
+  describe "#redis=" do
+    it "accepts a url string" do
+      Split.redis = "redis://localhost:6379"
       expect(Split.redis).to be_a(Redis)
 
       client = Split.redis.connection
@@ -20,8 +20,8 @@ RSpec.describe Split do
       expect(client[:port]).to eq(6379)
     end
 
-    it 'accepts an options hash' do
-      Split.redis = {host: 'localhost', port: 6379, db: 12}
+    it "accepts an options hash" do
+      Split.redis = { host: "localhost", port: 6379, db: 12 }
       expect(Split.redis).to be_a(Redis)
 
       client = Split.redis.connection
@@ -30,13 +30,13 @@ RSpec.describe Split do
       expect(client[:db]).to eq(12)
     end
 
-    it 'accepts a valid Redis instance' do
+    it "accepts a valid Redis instance" do
       other_redis = Redis.new(url: "redis://localhost:6379")
       Split.redis = other_redis
       expect(Split.redis).to eq(other_redis)
     end
 
-    it 'raises an ArgumentError when server cannot be determined' do
+    it "raises an ArgumentError when server cannot be determined" do
       expect { Split.redis = Object.new }.to raise_error(ArgumentError)
     end
   end

data/spec/support/cookies_mock.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-class CookiesMock
 
+class CookiesMock
   def initialize
     @cookies = {}
   end
@@ -16,5 +16,4 @@ class CookiesMock
   def delete(key)
     @cookies.delete(key)
   end
-
 end

data/spec/trial_spec.rb

@@ -1,54 +1,55 @@
 # frozen_string_literal: true
-require 'spec_helper'
-require 'split/trial'
+
+require "spec_helper"
+require "split/trial"
 
 describe Split::Trial do
   let(:user) { mock_user }
-  let(:alternatives) { ['basket', 'cart'] }
+  let(:alternatives) { ["basket", "cart"] }
   let(:experiment) do
-    Split::Experiment.new('basket_text', :alternatives => alternatives).save
+    Split::Experiment.new("basket_text", alternatives: alternatives).save
   end
 
   it "should be initializeable" do
-    experiment  = double('experiment')
-    alternative = double('alternative', :kind_of? => Split::Alternative)
-    trial = Split::Trial.new(:experiment => experiment, :alternative => alternative)
+    experiment  = double("experiment")
+    alternative = double("alternative", kind_of?: Split::Alternative)
+    trial = Split::Trial.new(experiment: experiment, alternative: alternative)
     expect(trial.experiment).to eq(experiment)
     expect(trial.alternative).to eq(alternative)
   end
 
   describe "alternative" do
     it "should use the alternative if specified" do
-      alternative = double('alternative', :kind_of? => Split::Alternative)
-      trial = Split::Trial.new(:experiment => double('experiment'),
-          :alternative => alternative, :user => user)
+      alternative = double("alternative", kind_of?: Split::Alternative)
+      trial = Split::Trial.new(experiment: double("experiment"),
+          alternative: alternative, user: user)
       expect(trial).not_to receive(:choose)
       expect(trial.alternative).to eq(alternative)
     end
 
     it "should load the alternative when the alternative name is set" do
-      experiment = Split::Experiment.new('basket_text', :alternatives => ['basket', 'cart'])
+      experiment = Split::Experiment.new("basket_text", alternatives: ["basket", "cart"])
       experiment.save
 
-      trial = Split::Trial.new(:experiment => experiment, :alternative => 'basket')
-      expect(trial.alternative.name).to eq('basket')
+      trial = Split::Trial.new(experiment: experiment, alternative: "basket")
+      expect(trial.alternative.name).to eq("basket")
     end
   end
 
   describe "metadata" do
     let(:metadata) { Hash[alternatives.map { |k| [k, "Metadata for #{k}"] }] }
     let(:experiment) do
-      Split::Experiment.new('basket_text', :alternatives => alternatives, :metadata => metadata).save
+      Split::Experiment.new("basket_text", alternatives: alternatives, metadata: metadata).save
     end
 
-    it 'has metadata on each trial' do
-      trial = Split::Trial.new(:experiment => experiment, :user => user, :metadata => metadata['cart'],
-                               :override => 'cart')
-      expect(trial.metadata).to eq(metadata['cart'])
+    it "has metadata on each trial" do
+      trial = Split::Trial.new(experiment: experiment, user: user, metadata: metadata["cart"],
+                               override: "cart")
+      expect(trial.metadata).to eq(metadata["cart"])
     end
 
-    it 'has metadata on each trial from the experiment' do
-      trial = Split::Trial.new(:experiment => experiment, :user => user)
+    it "has metadata on each trial from the experiment" do
+      trial = Split::Trial.new(experiment: experiment, user: user)
       trial.choose!
       expect(trial.metadata).to eq(metadata[trial.alternative.name])
       expect(trial.metadata).to match(/#{trial.alternative.name}/)
@@ -56,24 +57,24 @@ describe Split::Trial do
   end
 
   describe "#choose!" do
-    let(:context) { double(on_trial_callback: 'test callback') }
+    let(:context) { double(on_trial_callback: "test callback") }
     let(:trial) do
-      Split::Trial.new(:user => user, :experiment => experiment)
+      Split::Trial.new(user: user, experiment: experiment)
     end
 
-    shared_examples_for 'a trial with callbacks' do
-      it 'does not run if on_trial callback is not respondable' do
+    shared_examples_for "a trial with callbacks" do
+      it "does not run if on_trial callback is not respondable" do
         Split.configuration.on_trial = :foo
         allow(context).to receive(:respond_to?).with(:foo, true).and_return false
         expect(context).to_not receive(:foo)
         trial.choose! context
       end
-      it 'runs on_trial callback' do
+      it "runs on_trial callback" do
         Split.configuration.on_trial = :on_trial_callback
         expect(context).to receive(:on_trial_callback)
         trial.choose! context
       end
-      it 'does not run nil on_trial callback' do
+      it "does not run nil on_trial callback" do
         Split.configuration.on_trial = nil
         expect(context).not_to receive(:on_trial_callback)
         trial.choose! context
@@ -88,12 +89,12 @@ describe Split::Trial do
     end
 
     context "when override is present" do
-      let(:override) { 'cart' }
+      let(:override) { "cart" }
       let(:trial) do
-        Split::Trial.new(:user => user, :experiment => experiment, :override => override)
+        Split::Trial.new(user: user, experiment: experiment, override: override)
       end
 
-      it_behaves_like 'a trial with callbacks'
+      it_behaves_like "a trial with callbacks"
 
       it "picks the override" do
         expect(experiment).to_not receive(:next_alternative)
@@ -102,7 +103,7 @@ describe Split::Trial do
 
       context "when alternative doesn't exist" do
         let(:override) { nil }
-        it 'falls back on next_alternative' do
+        it "falls back on next_alternative" do
           expect(experiment).to receive(:next_alternative).and_call_original
           expect_alternative(trial, alternatives)
         end
@@ -111,7 +112,7 @@ describe Split::Trial do
 
     context "when disabled option is true" do
       let(:trial) do
-        Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+        Split::Trial.new(user: user, experiment: experiment, disabled: true)
       end
 
       it "picks the control", :aggregate_failures do
@@ -120,7 +121,7 @@ describe Split::Trial do
 
         expect(context).not_to receive(:on_trial_callback)
 
-        expect_alternative(trial, 'basket')
+        expect_alternative(trial, "basket")
         Split.configuration.on_trial = nil
       end
     end
@@ -132,7 +133,7 @@ describe Split::Trial do
 
         expect(experiment).to_not receive(:next_alternative)
         expect(context).not_to receive(:on_trial_callback)
-        expect_alternative(trial, 'basket')
+        expect_alternative(trial, "basket")
 
         Split.configuration.enabled = true
         Split.configuration.on_trial = nil
@@ -141,45 +142,45 @@ describe Split::Trial do
 
     context "when experiment has winner" do
       let(:trial) do
-        Split::Trial.new(:user => user, :experiment => experiment)
+        Split::Trial.new(user: user, experiment: experiment)
       end
 
-      it_behaves_like 'a trial with callbacks'
+      it_behaves_like "a trial with callbacks"
 
       it "picks the winner" do
-        experiment.winner = 'cart'
+        experiment.winner = "cart"
         expect(experiment).to_not receive(:next_alternative)
 
-        expect_alternative(trial, 'cart')
+        expect_alternative(trial, "cart")
       end
     end
 
     context "when exclude is true" do
       let(:trial) do
-        Split::Trial.new(:user => user, :experiment => experiment, :exclude => true)
+        Split::Trial.new(user: user, experiment: experiment, exclude: true)
       end
 
-      it_behaves_like 'a trial with callbacks'
+      it_behaves_like "a trial with callbacks"
 
       it "picks the control" do
         expect(experiment).to_not receive(:next_alternative)
-        expect_alternative(trial, 'basket')
+        expect_alternative(trial, "basket")
       end
     end
 
     context "when user is already participating" do
-      it_behaves_like 'a trial with callbacks'
+      it_behaves_like "a trial with callbacks"
 
       it "picks the same alternative" do
-        user[experiment.key] = 'basket'
+        user[experiment.key] = "basket"
         expect(experiment).to_not receive(:next_alternative)
 
-        expect_alternative(trial, 'basket')
+        expect_alternative(trial, "basket")
       end
 
       context "when alternative is not found" do
         it "falls back on next_alternative" do
-          user[experiment.key] = 'notfound'
+          user[experiment.key] = "notfound"
           expect(experiment).to receive(:next_alternative).and_call_original
           expect_alternative(trial, alternatives)
         end
@@ -213,7 +214,7 @@ describe Split::Trial do
 
           expect(experiment).to_not receive(:next_alternative)
           expect(context).not_to receive(:on_trial_callback)
-          expect_alternative(trial, 'basket')
+          expect_alternative(trial, "basket")
 
           Split.configuration.enabled = true
           Split.configuration.on_trial = nil
@@ -229,9 +230,9 @@ describe Split::Trial do
   end
 
   describe "#complete!" do
-    context 'when there are no goals' do
-      let(:trial) { Split::Trial.new(:user => user, :experiment => experiment) }
-      it 'should complete the trial' do
+    context "when there are no goals" do
+      let(:trial) { Split::Trial.new(user: user, experiment: experiment) }
+      it "should complete the trial" do
         trial.choose!
         old_completed_count = trial.alternative.completed_count
         trial.complete!
@@ -241,11 +242,11 @@ describe Split::Trial do
 
     context "when there are many goals" do
       let(:goals) { [ "goal1", "goal2" ] }
-      let(:trial) { Split::Trial.new(:user => user, :experiment => experiment, :goals => goals) }
+      let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goals) }
 
       it "increments the completed count corresponding to the goals" do
         trial.choose!
-        old_completed_counts = goals.map{ |goal| [goal, trial.alternative.completed_count(goal)] }.to_h 
+        old_completed_counts = goals.map { |goal| [goal, trial.alternative.completed_count(goal)] }.to_h
         trial.complete!
         goals.each { | goal | expect(trial.alternative.completed_count(goal)).to eq(old_completed_counts[goal] + 1) }
       end
@@ -253,7 +254,7 @@ describe Split::Trial do
 
     context "when there is 1 goal of type string" do
       let(:goal) { "goal" }
-      let(:trial) { Split::Trial.new(:user => user, :experiment => experiment, :goals => goal) }
+      let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goal) }
       it "increments the completed count corresponding to the goal" do
         trial.choose!
         old_completed_count = trial.alternative.completed_count(goal)
@@ -268,7 +269,7 @@ describe Split::Trial do
 
     context "when override is present" do
       it "stores when store_override is true" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'basket')
+        trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
 
         Split.configuration.store_override = true
         expect(user).to receive("[]=")
@@ -277,7 +278,7 @@ describe Split::Trial do
       end
 
       it "does not store when store_override is false" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :override => 'basket')
+        trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
 
         expect(user).to_not receive("[]=")
         trial.choose!
@@ -286,7 +287,7 @@ describe Split::Trial do
 
     context "when disabled is present" do
       it "stores when store_override is true" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+        trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
 
         Split.configuration.store_override = true
         expect(user).to receive("[]=")
@@ -294,7 +295,7 @@ describe Split::Trial do
       end
 
       it "does not store when store_override is false" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :disabled => true)
+        trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
 
         expect(user).to_not receive("[]=")
         trial.choose!
@@ -303,20 +304,20 @@ describe Split::Trial do
 
     context "when exclude is present" do
       it "does not store" do
-        trial = Split::Trial.new(:user => user, :experiment => experiment, :exclude => true)
+        trial = Split::Trial.new(user: user, experiment: experiment, exclude: true)
 
         expect(user).to_not receive("[]=")
         trial.choose!
       end
     end
 
-    context 'when experiment has winner' do
+    context "when experiment has winner" do
       let(:trial) do
-        experiment.winner = 'cart'
-        Split::Trial.new(:user => user, :experiment => experiment)
+        experiment.winner = "cart"
+        Split::Trial.new(user: user, experiment: experiment)
       end
 
-      it 'does not store' do
+      it "does not store" do
         expect(user).to_not receive("[]=")
         trial.choose!
       end

data/spec/user_spec.rb

@@ -1,71 +1,73 @@
-require 'spec_helper'
-require 'split/experiment_catalog'
-require 'split/experiment'
-require 'split/user'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "split/experiment_catalog"
+require "split/experiment"
+require "split/user"
 
 describe Split::User do
-  let(:user_keys) { { 'link_color' => 'blue' } }
-  let(:context) { double(:session => { split:  user_keys }) }
-  let(:experiment) { Split::Experiment.new('link_color') }
+  let(:user_keys) { { "link_color" => "blue" } }
+  let(:context) { double(session: { split:  user_keys }) }
+  let(:experiment) { Split::Experiment.new("link_color") }
 
   before(:each) do
     @subject = described_class.new(context)
   end
 
-  it 'delegates methods correctly' do
-    expect(@subject['link_color']).to eq(@subject.user['link_color'])
+  it "delegates methods correctly" do
+    expect(@subject["link_color"]).to eq(@subject.user["link_color"])
   end
 
-  context '#cleanup_old_versions!' do
+  context "#cleanup_old_versions!" do
     let(:experiment_version) { "#{experiment.name}:1" }
     let(:second_experiment_version) { "#{experiment.name}_another:1" }
     let(:third_experiment_version) { "variation_of_#{experiment.name}:1" }
     let(:user_keys) do
       {
-        experiment_version => 'blue',
-        second_experiment_version => 'red',
-        third_experiment_version => 'yellow'
+        experiment_version => "blue",
+        second_experiment_version => "red",
+        third_experiment_version => "yellow"
       }
     end
 
     before(:each) { @subject.cleanup_old_versions!(experiment) }
 
-    it 'removes key if old experiment is found' do
+    it "removes key if old experiment is found" do
       expect(@subject.keys).not_to include(experiment_version)
     end
 
-    it 'does not remove other keys' do
+    it "does not remove other keys" do
       expect(@subject.keys).to include(second_experiment_version, third_experiment_version)
     end
-  end 
+  end
 
-  context '#cleanup_old_experiments!' do
-    it 'removes key if experiment is not found' do
+  context "#cleanup_old_experiments!" do
+    it "removes key if experiment is not found" do
       @subject.cleanup_old_experiments!
       expect(@subject.keys).to be_empty
     end
 
-    it 'removes key if experiment has a winner' do
-      allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
+    it "removes key if experiment has a winner" do
+      allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
       allow(experiment).to receive(:start_time).and_return(Date.today)
       allow(experiment).to receive(:has_winner?).and_return(true)
       @subject.cleanup_old_experiments!
       expect(@subject.keys).to be_empty
     end
 
-    it 'removes key if experiment has not started yet' do
-      allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
+    it "removes key if experiment has not started yet" do
+      allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
       allow(experiment).to receive(:has_winner?).and_return(false)
       @subject.cleanup_old_experiments!
       expect(@subject.keys).to be_empty
     end
 
-    context 'with finished key' do
-      let(:user_keys) { { 'link_color' => 'blue', 'link_color:finished' => true } }
+    context "with finished key" do
+      let(:user_keys) { { "link_color" => "blue", "link_color:finished" => true } }
 
-      it 'does not remove finished key for experiment without a winner' do
-        allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
-        allow(Split::ExperimentCatalog).to receive(:find).with('link_color:finished').and_return(nil)
+      it "does not remove finished key for experiment without a winner" do
+        allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
+        allow(Split::ExperimentCatalog).to receive(:find).with("link_color:finished").and_return(nil)
         allow(experiment).to receive(:start_time).and_return(Date.today)
         allow(experiment).to receive(:has_winner?).and_return(false)
         @subject.cleanup_old_experiments!
@@ -74,33 +76,32 @@ describe Split::User do
       end
     end
 
-    context 'when already cleaned up' do
+    context "when already cleaned up" do
       before do
         @subject.cleanup_old_experiments!
       end
 
-      it 'does not clean up again' do
+      it "does not clean up again" do
         expect(@subject).to_not receive(:keys_without_finished)
         @subject.cleanup_old_experiments!
       end
     end
   end
 
-  context 'allows user to be loaded from adapter' do
-    it 'loads user from adapter (RedisAdapter)' do
+  context "allows user to be loaded from adapter" do
+    it "loads user from adapter (RedisAdapter)" do
       user = Split::Persistence::RedisAdapter.new(nil, 112233)
-      user['foo'] = 'bar'
+      user["foo"] = "bar"
 
       ab_user = Split::User.find(112233, :redis)
 
-      expect(ab_user['foo']).to eql('bar')
+      expect(ab_user["foo"]).to eql("bar")
     end
 
-    it 'returns nil if adapter does not implement a finder method' do
+    it "returns nil if adapter does not implement a finder method" do
       ab_user = Split::User.find(112233, :dual_adapter)
       expect(ab_user).to be_nil
     end
-
   end
 
   context "instantiated with custom adapter" do
@@ -114,5 +115,4 @@ describe Split::User do
       expect(@subject.user).to eq(custom_adapter)
     end
   end
-
 end

data/split.gemspec

@@ -9,36 +9,37 @@ Gem::Specification.new do |s|
   s.version     = Split::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Andrew Nesbitt"]
-  s.licenses    = ['MIT']
+  s.licenses    = ["MIT"]
   s.email       = ["andrewnez@gmail.com"]
   s.homepage    = "https://github.com/splitrb/split"
   s.summary     = "Rack based split testing framework"
 
   s.metadata    = {
-   "homepage_uri" => "https://github.com/splitrb/split",
-   "changelog_uri" => "https://github.com/splitrb/split/blob/master/CHANGELOG.md",
-   "source_code_uri" => "https://github.com/splitrb/split",
-   "bug_tracker_uri" => "https://github.com/splitrb/split/issues",
-   "wiki_uri" => "https://github.com/splitrb/split/wiki",
-   "mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
- }
+    "homepage_uri" => "https://github.com/splitrb/split",
+    "changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/splitrb/split",
+    "bug_tracker_uri" => "https://github.com/splitrb/split/issues",
+    "wiki_uri" => "https://github.com/splitrb/split/wiki",
+    "mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
+  }
 
-  s.required_ruby_version = '>= 2.5.0'
-  s.required_rubygems_version = '>= 2.0.0'
+  s.required_ruby_version = ">= 2.5.0"
+  s.required_rubygems_version = ">= 2.0.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency 'redis',           '>= 4.2'
-  s.add_dependency 'sinatra',         '>= 1.2.6'
-  s.add_dependency 'rubystats',       '>= 0.3.0'
+  s.add_dependency "redis",           ">= 4.2"
+  s.add_dependency "sinatra",         ">= 1.2.6"
+  s.add_dependency "rubystats",       ">= 0.3.0"
+  s.add_dependency "matrix"
 
-  s.add_development_dependency 'bundler',     '>= 1.17'
-  s.add_development_dependency 'simplecov',   '~> 0.15'
-  s.add_development_dependency 'rack-test',   '~> 1.1'
-  s.add_development_dependency 'rake',        '~> 13'
-  s.add_development_dependency 'rspec',       '~> 3.7'
-  s.add_development_dependency 'pry',         '~> 0.10'
-  s.add_development_dependency 'rails',       '>= 5.0'
+  s.add_development_dependency "bundler",     ">= 1.17"
+  s.add_development_dependency "simplecov",   "~> 0.15"
+  s.add_development_dependency "rack-test",   "~> 2.0"
+  s.add_development_dependency "rake",        "~> 13"
+  s.add_development_dependency "rspec",       "~> 3.7"
+  s.add_development_dependency "pry",         "~> 0.10"
+  s.add_development_dependency "rails",       ">= 5.0"
 end