split 2.0.0 → 3.0.0

data/spec/experiment_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 require 'spec_helper'
-require 'split/experiment'
-require 'split/algorithms'
 require 'time'
 
 describe Split::Experiment do
@@ -13,9 +11,7 @@ describe Split::Experiment do
     Split::Alternative.new(color, 'link_color')
   end
 
-  let(:experiment) {
-    new_experiment
-  }
+  let(:experiment) { new_experiment }
 
   let(:blue) { alternative("blue") }
   let(:green) { alternative("green") }
@@ -242,7 +238,15 @@ describe Split::Experiment do
   end
 
   describe 'reset' do
-    before { experiment.save }
+    let(:reset_manually) { false }
+
+    before do
+      allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
+      experiment.save
+      green.increment_participation
+      green.increment_participation
+    end
+
     it 'should reset all alternatives' do
       experiment.winner = 'green'
 
@@ -352,6 +356,34 @@ describe Split::Experiment do
       same_experiment_again = same_but_different_alternative
       expect(same_experiment_again.version).to eq(1)
     end
+
+    context 'when experiment configuration is changed' do
+      let(:reset_manually) { false }
+
+      before do
+        experiment.save
+        allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
+        green.increment_participation
+        green.increment_participation
+        experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
+                                                goals: %w(purchase))
+        experiment.save
+      end
+
+      it 'resets all alternatives' do
+        expect(green.participant_count).to eq(0)
+        expect(green.completed_count).to eq(0)
+      end
+
+      context 'when reset_manually is set' do
+        let(:reset_manually) { true }
+
+        it 'does not reset alternatives' do
+          expect(green.participant_count).to eq(2)
+          expect(green.completed_count).to eq(0)
+        end
+      end
+    end
   end
 
   describe 'alternatives passed as non-strings' do
@@ -448,5 +480,4 @@ describe Split::Experiment do
       expect(experiment.calc_winning_alternatives).to be nil
     end
   end
-
 end

data/spec/helper_spec.rb

@@ -197,24 +197,51 @@ describe Split::Helper do
       expect(button_size_alt.participant_count).to eq(1)
     end
 
-    it "should let a user participate in many experiment with one non-'control' alternative with allow_multiple_experiments = 'control'" do
-      Split.configure do |config|
-        config.allow_multiple_experiments = 'control'
-      end
-      groups = []
-      (0..100).each do |n|
-        alt = ab_test("test#{n}".to_sym, {'control' => (100 - n)}, {'test#{n}-alt' => n})
-        groups << alt
+    context "with allow_multiple_experiments = 'control'" do
+      it "should let a user participate in many experiment with one non-'control' alternative" do
+        Split.configure do |config|
+          config.allow_multiple_experiments = 'control'
+        end
+        groups = 100.times.map do |n|
+          ab_test("test#{n}".to_sym, {'control' => (100 - n)}, {"test#{n}-alt" => n})
+        end
+
+        experiments = ab_user.active_experiments
+        expect(experiments.size).to be > 1
+
+        count_control = experiments.values.count { |g| g == 'control' }
+        expect(count_control).to eq(experiments.size - 1)
+
+        count_alts = groups.count { |g| g != 'control' }
+        expect(count_alts).to eq(1)
       end
 
-      experiments = ab_user.active_experiments
-      expect(experiments.size).to be > 1
+      context "when user already has experiment" do
+        let(:mock_user){ Split::User.new(self, {'test_0' => 'test-alt'}) }
+        before{
+          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
+        }
 
-      count_control = experiments.values.count { |g| g == 'control' }
-      expect(count_control).to eq(experiments.size - 1)
+        it "should restore previously selected alternative" do
+          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' => 1}, {"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' } }
+
+          expect(ab_test(:test_0, {'control' => 0}, {"test-alt" => 100})).to eq 'control'
+          expect(ab_test(:test_1, {'control' => 100}, {"test-alt" => 1})).to eq 'test-alt'
+        end
+
+      end
 
-      count_alts = groups.count { |g| g != 'control' }
-      expect(count_alts).to eq(1)
     end
 
     it "should not over-write a finished key when an experiment is on a later version" do
@@ -642,6 +669,22 @@ describe Split::Helper do
 
       it_behaves_like "a disabled test"
     end
+
+    context "when ignored other address" do
+      before do
+        @request = OpenStruct.new(:ip => '1.1.1.1')
+        Split.configure do |c|
+          c.ignore_ip_addresses << '81.19.48.130'
+        end
+      end
+
+      it "works as usual" do
+        alternative_name = ab_test('link_color', 'red', 'blue')
+        expect{
+          ab_finished('link_color')
+        }.to change(Split::Alternative.new(alternative_name, 'link_color'), :completed_count).by(1)
+      end
+    end
   end
 
   describe 'versioned experiments' do
@@ -774,7 +817,7 @@ describe Split::Helper do
             end
           end
 
-          expect(Split.configuration.db_failover_on_db_error).to receive(:call)
+          expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
           ab_test('link_color', 'blue', 'red')
         end
 
@@ -833,7 +876,7 @@ describe Split::Helper do
             end
           end
 
-          expect(Split.configuration.db_failover_on_db_error).to receive(:call)
+          expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
           ab_finished('link_color')
         end
       end

data/spec/persistence/dual_adapter_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe Split::Persistence::DualAdapter do
+
+  let(:context){ "some context" }
+
+  let(:just_adapter){ Class.new }
+  let(:selected_adapter_instance){ double }
+  let(:selected_adapter){
+    c = Class.new
+    expect(c).to receive(:new){ selected_adapter_instance }
+    c
+  }
+  let(:not_selected_adapter){
+    c = Class.new
+    expect(c).not_to receive(:new)
+    c
+  }
+
+  shared_examples_for "forwarding calls" do
+    it "#[]=" do
+      expect(selected_adapter_instance).to receive(:[]=).with('my_key', 'my_value')
+      expect_any_instance_of(not_selected_adapter).not_to receive(:[]=)
+      subject["my_key"] = "my_value"
+    end
+
+    it "#[]" do
+      expect(selected_adapter_instance).to receive(:[]).with('my_key'){'my_value'}
+      expect_any_instance_of(not_selected_adapter).not_to receive(:[])
+      expect(subject["my_key"]).to eq('my_value')
+    end
+
+    it "#delete" do
+      expect(selected_adapter_instance).to receive(:delete).with('my_key'){'my_value'}
+      expect_any_instance_of(not_selected_adapter).not_to receive(:delete)
+      expect(subject.delete("my_key")).to eq('my_value')
+    end
+
+    it "#keys" do
+      expect(selected_adapter_instance).to receive(:keys){'my_value'}
+      expect_any_instance_of(not_selected_adapter).not_to receive(:keys)
+      expect(subject.keys).to eq('my_value')
+    end
+  end
+
+  context "when logged in" do
+    subject {
+      described_class.with_config(
+        logged_in: -> (context) { true },
+        logged_in_adapter: selected_adapter,
+        logged_out_adapter: not_selected_adapter
+        ).new(context)
+    }
+
+    it_should_behave_like "forwarding calls"
+  end
+
+  context "when not logged in" do
+    subject {
+      described_class.with_config(
+        logged_in: -> (context) { false },
+        logged_in_adapter: not_selected_adapter,
+        logged_out_adapter: selected_adapter
+        ).new(context)
+    }
+
+    it_should_behave_like "forwarding calls"
+  end
+
+  describe "when errors in config" do
+    before{
+      described_class.config.clear
+    }
+    let(:some_proc){ ->{} }
+    it "when no logged in adapter" do
+      expect{
+        described_class.with_config(
+          logged_in: some_proc,
+          logged_out_adapter: just_adapter
+          ).new(context)
+      }.to raise_error(StandardError, /:logged_in_adapter/)
+    end
+    it "when no logged out adapter" do
+      expect{
+        described_class.with_config(
+          logged_in: some_proc,
+          logged_in_adapter: just_adapter
+          ).new(context)
+      }.to raise_error(StandardError, /:logged_out_adapter/)
+    end
+    it "when no logged in detector" do
+      expect{
+        described_class.with_config(
+          logged_in_adapter: just_adapter,
+          logged_out_adapter: just_adapter
+          ).new(context)
+      }.to raise_error(StandardError, /:logged_in$/)
+    end
+  end
+
+end

data/spec/redis_interface_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Split::RedisInterface do
+  let(:list_name) { 'list_name' }
+  let(:set_name) { 'set_name' }
+  let(:interface) { described_class.new }
+
+  describe '#persist_list' do
+    subject(:persist_list) do
+      interface.persist_list(list_name, %w(a b c d))
+    end
+
+    specify do
+      expect(persist_list).to eq %w(a b c d)
+      expect(Split.redis.lindex(list_name, 0)).to eq 'a'
+      expect(Split.redis.lindex(list_name, 1)).to eq 'b'
+      expect(Split.redis.lindex(list_name, 2)).to eq 'c'
+      expect(Split.redis.lindex(list_name, 3)).to eq 'd'
+      expect(Split.redis.llen(list_name)).to eq 4
+    end
+
+    context 'list is overwritten but not deleted' do
+      specify do
+        expect(persist_list).to eq %w(a b c d)
+        interface.persist_list(list_name, ['z'])
+        expect(Split.redis.lindex(list_name, 0)).to eq 'z'
+        expect(Split.redis.llen(list_name)).to eq 1
+      end
+    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')
+    end
+
+    specify do
+      add_to_set
+      expect(Split.redis.sismember(set_name, 'something')).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,33 +4,34 @@ ENV['RACK_ENV'] = "test"
 require 'rubygems'
 require 'bundler/setup'
 
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+SimpleCov.start
 
 require 'split'
 require 'ostruct'
 require 'yaml'
-require 'complex' if RUBY_VERSION.match(/1\.8/)
 
 Dir['./spec/support/*.rb'].each { |f| require f }
 
 require "fakeredis"
 
-fakeredis = Redis.new
+G_fakeredis = Redis.new
 
-RSpec.configure do |config|
-  config.order = 'random'
-  config.before(:each) do
+module GlobalSharedContext
+  extend RSpec::SharedContext
+  let(:mock_user){ Split::User.new(double(session: {})) }
+  before(:each) do
     Split.configuration = Split::Configuration.new
-    Split.redis = fakeredis
+    Split.redis = G_fakeredis
     Split.redis.flushall
     @ab_user = mock_user
     params = nil
   end
 end
 
-def mock_user
-  Split::User.new(double(session: {}))
+RSpec.configure do |config|
+  config.order = 'random'
+  config.include GlobalSharedContext
 end
 
 def session

data/spec/split_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Split do
+
+  around(:each) do |ex|
+    old_env, old_redis = [ENV.delete('REDIS_URL'), Split.redis]
+    ex.run
+    ENV['REDIS_URL'] = old_env
+    Split.redis = old_redis
+  end
+
+  describe '#redis=' do
+    it 'accepts a url string' do
+      Split.redis = 'redis://localhost:6379'
+      expect(Split.redis).to be_a(Redis)
+
+      client = Split.redis.client
+      expect(client.host).to eq("localhost")
+      expect(client.port).to eq(6379)
+    end
+
+    it 'accepts an options hash' do
+      Split.redis = {host: 'localhost', port: 6379, db: 12}
+      expect(Split.redis).to be_a(Redis)
+
+      client = Split.redis.client
+      expect(client.host).to eq("localhost")
+      expect(client.port).to eq(6379)
+      expect(client.db).to eq(12)
+    end
+
+    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
+      expect { Split.redis = Object.new }.to raise_error(ArgumentError)
+    end
+  end
+end

data/split.gemspec

@@ -21,15 +21,14 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'redis',           '>= 2.1'
-  s.add_dependency 'redis-namespace', '>= 1.1.0'
   s.add_dependency 'sinatra',         '>= 1.2.6'
   s.add_dependency 'simple-random',   '>= 0.9.3'
 
   s.add_development_dependency 'bundler',     '~> 1.10'
-  s.add_development_dependency 'coveralls',   '~> 0.8'
+  s.add_development_dependency 'simplecov',   '~> 0.12'
   s.add_development_dependency 'rack-test',   '~> 0.6'
   s.add_development_dependency 'rake',        '~> 11.1'
   s.add_development_dependency 'rspec',       '~> 3.4'
   s.add_development_dependency 'pry',         '~> 0.10'
-  s.add_development_dependency 'fakeredis',   '~> 0.5.0'
+  s.add_development_dependency 'fakeredis',   '~> 0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-17 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: redis-namespace
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 description: 
 email:
 - andrewnez@gmail.com
@@ -171,7 +157,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".csslintrc"
+- ".eslintignore"
+- ".eslintrc"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
@@ -181,10 +172,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/4.1.gemfile
 - gemfiles/4.2.gemfile
+- gemfiles/5.0.gemfile
 - lib/split.rb
-- lib/split/algorithms.rb
+- lib/split/algorithms/block_randomization.rb
 - lib/split/algorithms/weighted_sample.rb
 - lib/split/algorithms/whiplash.rb
 - lib/split/alternative.rb
@@ -206,8 +197,6 @@ files:
 - lib/split/exceptions.rb
 - lib/split/experiment.rb
 - lib/split/experiment_catalog.rb
-- lib/split/extensions.rb
-- lib/split/extensions/array.rb
 - lib/split/extensions/string.rb
 - lib/split/goals_collection.rb
 - lib/split/helper.rb
@@ -217,10 +206,12 @@ files:
 - lib/split/persistence/dual_adapter.rb
 - lib/split/persistence/redis_adapter.rb
 - lib/split/persistence/session_adapter.rb
+- lib/split/redis_interface.rb
 - lib/split/trial.rb
 - lib/split/user.rb
 - lib/split/version.rb
 - lib/split/zscore.rb
+- spec/algorithms/block_randomization_spec.rb
 - spec/algorithms/weighted_sample_spec.rb
 - spec/algorithms/whiplash_spec.rb
 - spec/alternative_spec.rb
@@ -234,10 +225,13 @@ files:
 - spec/helper_spec.rb
 - spec/metric_spec.rb
 - spec/persistence/cookie_adapter_spec.rb
+- spec/persistence/dual_adapter_spec.rb
 - spec/persistence/redis_adapter_spec.rb
 - spec/persistence/session_adapter_spec.rb
 - spec/persistence_spec.rb
+- spec/redis_interface_spec.rb
 - spec/spec_helper.rb
+- spec/split_spec.rb
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
 - spec/user_spec.rb
@@ -267,6 +261,7 @@ signing_key:
 specification_version: 4
 summary: Rack based split testing framework
 test_files:
+- spec/algorithms/block_randomization_spec.rb
 - spec/algorithms/weighted_sample_spec.rb
 - spec/algorithms/whiplash_spec.rb
 - spec/alternative_spec.rb
@@ -280,11 +275,13 @@ test_files:
 - spec/helper_spec.rb
 - spec/metric_spec.rb
 - spec/persistence/cookie_adapter_spec.rb
+- spec/persistence/dual_adapter_spec.rb
 - spec/persistence/redis_adapter_spec.rb
 - spec/persistence/session_adapter_spec.rb
 - spec/persistence_spec.rb
+- spec/redis_interface_spec.rb
 - spec/spec_helper.rb
+- spec/split_spec.rb
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
 - spec/user_spec.rb
-has_rdoc: 

data/gemfiles/4.1.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rails", "~> 4.1"
-
-gemspec :path => "../"

data/lib/split/algorithms.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-%w[weighted_sample whiplash].each do |f|
-  require "split/algorithms/#{f}"
-end

data/lib/split/extensions/array.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-class Array
-  # maintain backwards compatibility with 1.8.7
-  alias_method :sample, :choice unless method_defined?(:sample)
-end

data/lib/split/extensions.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-%w[array string].each do |f|
-  require "split/extensions/#{f}"
-end