split 3.4.1 → 4.0.0.pre

data/spec/goals_collection_spec.rb

@@ -48,7 +48,7 @@ describe Split::GoalsCollection do
       goals_collection.save
 
       goals_collection.delete
-      expect(Split.redis.exists(goals_key)).to be false
+      expect(Split.redis.exists?(goals_key)).to be false
     end
   end
 

data/spec/helper_spec.rb

@@ -229,13 +229,15 @@ describe Split::Helper do
 
       context "when user already has experiment" do
         let(:mock_user){ Split::User.new(self, {'test_0' => 'test-alt'}) }
-        before{
+
+        before do
           Split.configure do |config|
             config.allow_multiple_experiments = 'control'
           end
+
           Split::ExperimentCatalog.find_or_initialize('test_0', 'control', 'test-alt').save
           Split::ExperimentCatalog.find_or_initialize('test_1', 'control', 'test-alt').save
-        }
+        end
 
         it "should restore previously selected alternative" do
           expect(ab_user.active_experiments.size).to eq 1
@@ -243,6 +245,16 @@ describe Split::Helper do
           expect(ab_test(:test_0, {'control' => 1}, {"test-alt" => 100})).to eq 'test-alt'
         end
 
+        it "should select the correct alternatives after experiment resets" do
+          experiment = Split::ExperimentCatalog.find(:test_0)
+          experiment.reset
+          mock_user[experiment.key] = 'test-alt'
+
+          expect(ab_user.active_experiments.size).to eq 1
+          expect(ab_test(:test_0, {'control' => 100}, {"test-alt" => 1})).to eq 'test-alt'
+          expect(ab_test(:test_0, {'control' => 0}, {"test-alt" => 100})).to eq 'test-alt'
+        end
+
         it "lets override existing choice" do
           pending "this requires user store reset on first call not depending on whelther it is current trial"
           @params = { 'ab_test' => { 'test_1' => 'test-alt' } }
@@ -265,33 +277,63 @@ describe Split::Helper do
   end
 
   describe 'metadata' do
-    before do
-      Split.configuration.experiments = {
-        :my_experiment => {
-          :alternatives => ["one", "two"],
-          :resettable => false,
-          :metadata => { 'one' => 'Meta1', 'two' => 'Meta2' }
+    context 'is defined' do
+      before do
+        Split.configuration.experiments = {
+          :my_experiment => {
+            :alternatives => ["one", "two"],
+            :resettable => false,
+            :metadata => { 'one' => 'Meta1', 'two' => 'Meta2' }
+          }
         }
-      }
-    end
+      end
 
-    it 'should be passed to helper block' do
-      @params = { 'ab_test' => { 'my_experiment' => 'one' } }
-      expect(ab_test('my_experiment')).to eq 'one'
-      expect(ab_test('my_experiment') do |alternative, meta|
-        meta
-      end).to eq('Meta1')
+      it 'should be passed to helper block' do
+        @params = { 'ab_test' => { 'my_experiment' => 'two' } }
+        expect(ab_test('my_experiment')).to eq 'two'
+        expect(ab_test('my_experiment') do |alternative, meta|
+          meta
+        end).to eq('Meta2')
+      end
+
+      it 'should pass control metadata helper block if library disabled' do
+        Split.configure do |config|
+          config.enabled = false
+        end
+
+        expect(ab_test('my_experiment')).to eq 'one'
+        expect(ab_test('my_experiment') do |_, meta|
+          meta
+        end).to eq('Meta1')
+      end
     end
 
-    it 'should pass empty hash to helper block if library disabled' do
-      Split.configure do |config|
-        config.enabled = false
+    context 'is not defined' do
+      before do
+        Split.configuration.experiments = {
+          :my_experiment => {
+            :alternatives => ["one", "two"],
+            :resettable => false,
+            :metadata => nil
+          }
+        }
+      end
+
+      it 'should be passed to helper block' do
+        expect(ab_test('my_experiment') do |alternative, meta|
+          meta
+        end).to eq({})
       end
 
-      expect(ab_test('my_experiment')).to eq 'one'
-      expect(ab_test('my_experiment') do |_, meta|
-        meta
-      end).to eq({})
+      it 'should pass control metadata helper block if library disabled' do
+        Split.configure do |config|
+          config.enabled = false
+        end
+
+        expect(ab_test('my_experiment') do |_, meta|
+          meta
+        end).to eq({})
+      end
     end
   end
 
@@ -1096,15 +1138,9 @@ describe Split::Helper do
       end
 
       it "should increment the counter for the specified-goal completed alternative" do
-        expect(lambda {
-          expect(lambda {
-            ab_finished({"link_color" => ["purchase"]})
-          }).not_to change {
-            Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal2)
-          }
-        }).to change {
-          Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal1)
-        }.by(1)
+        expect{ ab_finished({"link_color" => ["purchase"]}) }
+          .to change{ Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal2) }.by(0)
+          .and change{ Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal1) }.by(1)
       end
     end
   end

data/spec/persistence/cookie_adapter_spec.rb

@@ -52,7 +52,7 @@ describe Split::Persistence::CookieAdapter do
     it "puts multiple experiments in a single cookie" do
       subject["foo"] = "FOO"
       subject["bar"] = "BAR"
-      expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
+      expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} [A-Z]{3}\Z/)
     end
 
     it "ensure other added cookies are not overriden" do

data/spec/persistence/redis_adapter_spec.rb

@@ -60,6 +60,15 @@ describe Split::Persistence::RedisAdapter do
     end
   end
 
+  describe '#find' do
+    before { Split::Persistence::RedisAdapter.with_config(:lookup_by => proc{'frag'}, :namespace => 'a_namespace') }
+
+    it "should create and user from a given key" do
+      adapter = Split::Persistence::RedisAdapter.find(2)
+      expect(adapter.redis_key).to eq("a_namespace:2")
+    end
+  end
+
   context 'functional tests' do
     before { Split::Persistence::RedisAdapter.with_config(:lookup_by => 'lookup') }
 

data/spec/redis_interface_spec.rb

@@ -29,75 +29,6 @@ describe Split::RedisInterface do
     end
   end
 
-  describe '#add_to_list' do
-    subject(:add_to_list) do
-      interface.add_to_list(list_name, 'y')
-      interface.add_to_list(list_name, 'z')
-    end
-
-    specify do
-      add_to_list
-      expect(Split.redis.lindex(list_name, 0)).to eq 'y'
-      expect(Split.redis.lindex(list_name, 1)).to eq 'z'
-      expect(Split.redis.llen(list_name)).to eq 2
-    end
-  end
-
-  describe '#set_list_index' do
-    subject(:set_list_index) do
-      interface.add_to_list(list_name, 'y')
-      interface.add_to_list(list_name, 'z')
-      interface.set_list_index(list_name, 0, 'a')
-    end
-
-    specify do
-      set_list_index
-      expect(Split.redis.lindex(list_name, 0)).to eq 'a'
-      expect(Split.redis.lindex(list_name, 1)).to eq 'z'
-      expect(Split.redis.llen(list_name)).to eq 2
-    end
-  end
-
-  describe '#list_length' do
-    subject(:list_length) do
-      interface.add_to_list(list_name, 'y')
-      interface.add_to_list(list_name, 'z')
-      interface.list_length(list_name)
-    end
-
-    specify do
-      expect(list_length).to eq 2
-    end
-  end
-
-  describe '#remove_last_item_from_list' do
-    subject(:remove_last_item_from_list) do
-      interface.add_to_list(list_name, 'y')
-      interface.add_to_list(list_name, 'z')
-      interface.remove_last_item_from_list(list_name)
-    end
-
-    specify do
-      remove_last_item_from_list
-      expect(Split.redis.lindex(list_name, 0)).to eq 'y'
-      expect(Split.redis.llen(list_name)).to eq 1
-    end
-  end
-
-  describe '#make_list_length' do
-    subject(:make_list_length) do
-      interface.add_to_list(list_name, 'y')
-      interface.add_to_list(list_name, 'z')
-      interface.make_list_length(list_name, 1)
-    end
-
-    specify do
-      make_list_length
-      expect(Split.redis.lindex(list_name, 0)).to eq 'y'
-      expect(Split.redis.llen(list_name)).to eq 1
-    end
-  end
-
   describe '#add_to_set' do
     subject(:add_to_set) do
       interface.add_to_set(set_name, 'something')

data/spec/spec_helper.rb

@@ -13,17 +13,16 @@ require 'yaml'
 
 Dir['./spec/support/*.rb'].each { |f| require f }
 
-require "fakeredis"
-
-G_fakeredis = Redis.new
-
 module GlobalSharedContext
   extend RSpec::SharedContext
   let(:mock_user){ Split::User.new(double(session: {})) }
+
   before(:each) do
     Split.configuration = Split::Configuration.new
-    Split.redis = G_fakeredis
-    Split.redis.flushall
+    Split.redis = Redis.new
+    Split.redis.select(10)
+    Split.redis.flushdb
+    Split::Cache.clear
     @ab_user = mock_user
     params = nil
   end

data/spec/trial_spec.rb

@@ -198,42 +198,68 @@ describe Split::Trial do
         expect(trial.alternative.name).to_not be_empty
         Split.configuration.on_trial_choose = nil
       end
+
+      it "assigns user to an alternative" do
+        trial.choose! context
+
+        expect(alternatives).to include(user[experiment.name])
+      end
+
+      context "when cohorting is disabled" do
+        before(:each) { allow(experiment).to receive(:cohorting_disabled?).and_return(true) }
+
+        it "picks the control and does not run on_trial callbacks" do
+          Split.configuration.on_trial = :on_trial_callback
+
+          expect(experiment).to_not receive(:next_alternative)
+          expect(context).not_to receive(:on_trial_callback)
+          expect_alternative(trial, 'basket')
+
+          Split.configuration.enabled = true
+          Split.configuration.on_trial = nil
+        end
+
+        it "user is not assigned an alternative" do
+          trial.choose! context
+
+          expect(user[experiment]).to eq(nil)
+        end
+      end
     end
   end
 
   describe "#complete!" do
-    let(:trial) { Split::Trial.new(:user => user, :experiment => experiment) }
     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!
-        expect(trial.alternative.completed_count).to be(old_completed_count+1)
+        expect(trial.alternative.completed_count).to eq(old_completed_count + 1)
       end
     end
 
-    context 'when there are many goals' do
-      let(:goals) { ['first', 'second'] }
+    context "when there are many goals" do
+      let(:goals) { [ "goal1", "goal2" ] }
       let(:trial) { Split::Trial.new(:user => user, :experiment => experiment, :goals => goals) }
-      shared_examples_for "goal completion" do
-        it 'should not complete the trial' do
-          trial.choose!
-          old_completed_count = trial.alternative.completed_count
-          trial.complete!(goal)
-          expect(trial.alternative.completed_count).to_not be(old_completed_count+1)
-        end
-      end
 
-      describe 'Array of Goals' do
-        let(:goal) { [goals.first] }
-        it_behaves_like 'goal completion'
+      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 
+        trial.complete!
+        goals.each { | goal | expect(trial.alternative.completed_count(goal)).to eq(old_completed_counts[goal] + 1) }
       end
+    end
 
-      describe 'String of Goal' do
-        let(:goal) { goals.first }
-        it_behaves_like 'goal completion'
+    context "when there is 1 goal of type string" do
+      let(:goal) { "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)
+        trial.complete!
+        expect(trial.alternative.completed_count(goal)).to eq(old_completed_count + 1)
       end
-
     end
   end
 

data/spec/user_spec.rb

@@ -72,6 +72,23 @@ describe Split::User do
     end
   end
 
+  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'
+
+      ab_user = Split::User.find(112233, :redis)
+
+      expect(ab_user['foo']).to eql('bar')
+    end
+
+    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
     let(:custom_adapter) { double(:persistence_adapter) }
 

data/split.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
+
 $:.push File.expand_path("../lib", __FILE__)
 require "split/version"
 
@@ -22,23 +23,22 @@ Gem::Specification.new do |s|
    "mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
  }
 
-  s.required_ruby_version = '>= 1.9.3'
+  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',           '>= 2.1'
+  s.add_dependency 'redis',           '>= 4.2'
   s.add_dependency 'sinatra',         '>= 1.2.6'
-  s.add_dependency 'simple-random',   '>= 0.9.3'
+  s.add_dependency 'rubystats',       '>= 0.3.0'
 
   s.add_development_dependency 'bundler',     '>= 1.17'
   s.add_development_dependency 'simplecov',   '~> 0.15'
-  s.add_development_dependency 'rack-test',   '~> 0.6'
-  s.add_development_dependency 'rake',        '~> 12'
+  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 'fakeredis',   '~> 0.7'
-  s.add_development_dependency 'rails',       '>= 4.2'
+  s.add_development_dependency 'rails',       '>= 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 4.0.0.pre
 platform: ruby
 authors:
 - Andrew Nesbitt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.6
 - !ruby/object:Gem::Dependency
-  name: simple-random
+  name: rubystats
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,35 +136,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-description: 
+        version: '5.0'
+description:
 email:
 - andrewnez@gmail.com
 executables: []
@@ -175,6 +161,7 @@ files:
 - ".csslintrc"
 - ".eslintignore"
 - ".eslintrc"
+- ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".gitignore"
 - ".rspec"
@@ -189,7 +176,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/4.2.gemfile
 - gemfiles/5.0.gemfile
 - gemfiles/5.1.gemfile
 - gemfiles/5.2.gemfile
@@ -199,6 +185,7 @@ files:
 - lib/split/algorithms/weighted_sample.rb
 - lib/split/algorithms/whiplash.rb
 - lib/split/alternative.rb
+- lib/split/cache.rb
 - lib/split/combined_experiments_helper.rb
 - lib/split/configuration.rb
 - lib/split/dashboard.rb
@@ -238,6 +225,7 @@ files:
 - spec/algorithms/weighted_sample_spec.rb
 - spec/algorithms/whiplash_spec.rb
 - spec/alternative_spec.rb
+- spec/cache_spec.rb
 - spec/combined_experiments_helper_spec.rb
 - spec/configuration_spec.rb
 - spec/dashboard/pagination_helpers_spec.rb
@@ -272,7 +260,7 @@ metadata:
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -280,15 +268,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Rack based split testing framework
 test_files:
@@ -296,6 +284,7 @@ test_files:
 - spec/algorithms/weighted_sample_spec.rb
 - spec/algorithms/whiplash_spec.rb
 - spec/alternative_spec.rb
+- spec/cache_spec.rb
 - spec/combined_experiments_helper_spec.rb
 - spec/configuration_spec.rb
 - spec/dashboard/pagination_helpers_spec.rb