split 4.0.0.pre → 4.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a8ee5e18e49d1020baf846f2e2403d9f54705c551690335e4898c43cffb93b9
-  data.tar.gz: 84db3159654293b4cda8905138f9bb0dbb0b8ba4e130580eb6758d74e3d70873
+  metadata.gz: 8bc6c9cfc3470eb28463fe0d286124b8ad89132e458963cfea9035f82d2dc484
+  data.tar.gz: 5cacccff1115b056ecafcea231ea27fff5d564ee9630b4279d8ce1fa5d8282ca
 SHA512:
-  metadata.gz: 846c82ad7655d028ab719c85d3bc1589453f55adbc0bae011f1b4f4c28d478f121dc1905b3d4b5d81a39b7884d5e7c20ba7d06bf6bdb7d5216b5b07974587031
-  data.tar.gz: ca6166dc4dec2102ba82c80f4cb73308a9b4e87785276f4bb63ef5e702b55e2cc71146a537fd1306005aad2f77916c096484812f85bc90887400ca280a73a4b1
+  metadata.gz: bca228077d8dbecf7e06f21f411070effcc520c64d09b055c41fea4da7d786bedb81dbdd4f389a20f9166e08d9abf26ff75ea60bd1daf43c2555f5621adbb1e0
+  data.tar.gz: ad2aca522d8d7f7bad54ee256c8626dd7747ae6c65aaf6da40d0de4c56d78f2bddd34af4c22be9d9fc943538446e523bf1f6ae7bf43e59505eddd350507b168d

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,61 @@
+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'
+
+    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@v2
+
+      - 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

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 4.0.0.pre
+## 4.0.0.pre2
 
 Bugfixes:
 - ab_test must return metadata on error or if split is disabled/excluded user (@andrehjr, #622)
@@ -6,6 +6,8 @@ Bugfixes:
 - 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 (@serggi, #661)
 
 Features:
 - Make goals accessible via on_trial_complete callbacks (@robin-phung, #625)
@@ -14,10 +16,11 @@ Features:
 - 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 (@andrehkr, #607)
+- 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)
@@ -25,8 +28,10 @@ Misc:
 - 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)
 
 ## 3.4.1 (November 12th, 2019)
 

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)
@@ -175,8 +175,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
@@ -648,7 +650,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|
@@ -786,7 +788,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

data/lib/split/configuration.rb

@@ -11,6 +11,7 @@ module Split
     attr_accessor :enabled
     attr_accessor :persistence
     attr_accessor :persistence_cookie_length
+    attr_accessor :persistence_cookie_domain
     attr_accessor :algorithm
     attr_accessor :store_override
     attr_accessor :start_manually
@@ -226,6 +227,7 @@ module Split
       @experiments = {}
       @persistence = Split::Persistence::SessionAdapter
       @persistence_cookie_length = 31536000 # One year from now
+      @persistence_cookie_domain = nil
       @algorithm = Split::Algorithms::WeightedSample
       @include_rails_helper = true
       @beta_probability_simulations = 10000

data/lib/split/experiment.rb

@@ -87,8 +87,8 @@ module Split
         persist_experiment_configuration
       end
 
-      redis.hset(experiment_config_key, :resettable, resettable,
-                                        :algorithm, algorithm.to_s)
+      redis.hmset(experiment_config_key, :resettable, resettable,
+                                         :algorithm, algorithm.to_s)
       self
     end
 

data/lib/split/persistence/cookie_adapter.rb

@@ -45,7 +45,7 @@ module Split
       end
 
       def default_options
-        { expires: @expires, path: '/' }
+        { expires: @expires, path: '/', domain: cookie_domain_config }.compact
       end
 
       def set_cookie_via_rack(key, value)
@@ -87,6 +87,10 @@ module Split
         Split.configuration.persistence_cookie_length
       end
 
+      def cookie_domain_config
+        Split.configuration.persistence_cookie_domain
+      end
+
       def action_dispatch?
         defined?(Rails) && @response.is_a?(ActionDispatch::Response)
       end

data/lib/split/user.rb

@@ -38,7 +38,7 @@ module Split
     end
 
     def cleanup_old_versions!(experiment)
-      keys = user.keys.select { |k| k.match(Regexp.new(experiment.name)) }
+      keys = user.keys.select { |k| key_without_version(k) == experiment.name }
       keys_without_experiment(keys, experiment.key).each { |key| user.delete(key) }
     end
 

data/lib/split/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Split
-  VERSION = "4.0.0.pre"
+  VERSION = "4.0.0.pre2"
 end

data/lib/split.rb

@@ -74,7 +74,7 @@ end
 
 # Check to see if being run in a Rails application.  If so, wait until before_initialize to run configuration so Gems that create ENV variables have the chance to initialize first.
 if defined?(::Rails)
-  class Railtie < Rails::Railtie
+  class Split::Railtie < Rails::Railtie
     config.before_initialize { Split.configure {} }
   end
 else

data/spec/configuration_spec.rb

@@ -214,7 +214,10 @@ describe Split::Configuration do
 
   context "redis configuration" do
     it "should default to local redis server" do
-      expect(@config.redis).to eq("redis://localhost:6379")
+      old_redis_url = ENV['REDIS_URL']
+      ENV.delete('REDIS_URL')
+      expect(Split::Configuration.new.redis).to eq("redis://localhost:6379")
+      ENV['REDIS_URL'] = old_redis_url
     end
 
     it "should allow for redis url to be configured" do
@@ -224,9 +227,10 @@ describe Split::Configuration do
 
     context "provided REDIS_URL environment variable" do
       it "should use the ENV variable" do
+        old_redis_url = ENV['REDIS_URL']
         ENV['REDIS_URL'] = "env_redis_url"
         expect(Split::Configuration.new.redis).to eq("env_redis_url")
-        ENV.delete('REDIS_URL')
+        ENV['REDIS_URL'] = old_redis_url
       end
     end
   end
@@ -242,4 +246,15 @@ describe Split::Configuration do
     end
   end
 
+  context "persistence cookie domain" do
+    it "should default to nil" do
+      expect(@config.persistence_cookie_domain).to eq(nil)
+    end
+
+    it "should allow the persistence cookie domain to be configured" do
+      @config.persistence_cookie_domain = '.acme.com'
+      expect(@config.persistence_cookie_domain).to eq('.acme.com')
+    end
+  end
+
 end

data/spec/user_spec.rb

@@ -17,11 +17,25 @@ describe Split::User do
   end
 
   context '#cleanup_old_versions!' do
-    let(:user_keys) { { 'link_color:1' => 'blue' } }
+    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'
+      }
+    end
+
+    before(:each) { @subject.cleanup_old_versions!(experiment) }
 
     it 'removes key if old experiment is found' do
-      @subject.cleanup_old_versions!(experiment)
-      expect(@subject.keys).to be_empty
+      expect(@subject.keys).not_to include(experiment_version)
+    end
+
+    it 'does not remove other keys' do
+      expect(@subject.keys).to include(second_experiment_version, third_experiment_version)
     end
   end 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre
+  version: 4.0.0.pre2
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -163,11 +163,12 @@ files:
 - ".eslintrc"
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md

data/.travis.yml

@@ -1,32 +0,0 @@
-language: ruby
-rvm:
-  - 2.5.7
-  - 2.6.6
-  - 2.7.1
-
-services:
-  - redis-server
-
-gemfile:
-  - gemfiles/5.0.gemfile
-  - gemfiles/5.1.gemfile
-  - gemfiles/5.2.gemfile
-  - gemfiles/6.0.gemfile
-
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler --version=1.17.3
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - RAILS_ENV=test bundle exec rake spec
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-cache: bundler
-sudo: false