split 3.3.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2527f0dab7b1f6c2de3e21b02fd933eef302046e7cdd4b8f42da20a3cdf1ba
-  data.tar.gz: 6332eabde240b1c408ff434850b7ac520b3081bfd5fe76f7343259a8eae039b6
+  metadata.gz: 1d316599c60ca79cff957c25c44d5901c0c2a86c3631e516b07aeac5afc720d3
+  data.tar.gz: 004f09975e36482ab4a56b7bd63fd9d703f067a26d9e9fd99e0a80b6cc2853b5
 SHA512:
-  metadata.gz: 331863e4c78e8dabf7eb23551608be301cdd33d4c14186ab47def00485b028c05784f70009fd66d1b3e240963d1cd45b61d2233b651fd0bcbcb79e2871d2a6ad
-  data.tar.gz: 2c8723105824b9dfc315f88de450be5c18aa32d20e2253a25ca9fcbb6b65b082697c0782719198a2f7b401e66824597a50c3f97dece30a3c9ceccb3fcd62fa95
+  metadata.gz: 9001316e86f2e91289523c51097b67dac319ee1cd9a6b27e6f323496258824afe8921fcc306a7ecdc8787406b64f6c8eaa49febf06069afe9532f42218baf8f9
+  data.tar.gz: 51b13b3950580e2b446cf688f651632ed2135dec37168e9681e9cf46623ce9707ab8db2b947ca0d1711d0a49d64e1721d4d58ba09b9f5c3fab62ef6f747f5c8f

data/.travis.yml

@@ -2,17 +2,19 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0
-  - 2.1
+  - 2.1.10
   - 2.2.0
   - 2.2.2
-  - 2.4.3
-  - 2.5.1
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 
 gemfile:
   - gemfiles/4.2.gemfile
   - gemfiles/5.0.gemfile
   - gemfiles/5.1.gemfile
   - gemfiles/5.2.gemfile
+  - gemfiles/6.0.gemfile
 
 
 matrix:
@@ -21,30 +23,41 @@ matrix:
     gemfile: gemfiles/5.0.gemfile
   - rvm: 1.9.3
     gemfile: gemfiles/5.1.gemfile
+  - rvm: 1.9.3
+    gemfile: gemfiles/5.2.gemfile
+  - rvm: 1.9.3
+    gemfile: gemfiles/6.0.gemfile
   - rvm: 2.0
     gemfile: gemfiles/5.0.gemfile
   - rvm: 2.0
     gemfile: gemfiles/5.1.gemfile
-  - rvm: 2.1
+  - rvm: 2.0
+    gemfile: gemfiles/5.2.gemfile
+  - rvm: 2.0
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.1.10
     gemfile: gemfiles/5.0.gemfile
-  - rvm: 2.1
+  - rvm: 2.1.10
     gemfile: gemfiles/5.1.gemfile
+  - rvm: 2.1.10
+    gemfile: gemfiles/5.2.gemfile
+  - rvm: 2.1.10
+    gemfile: gemfiles/6.0.gemfile
   - rvm: 2.2.0
     gemfile: gemfiles/5.0.gemfile
   - rvm: 2.2.0
     gemfile: gemfiles/5.1.gemfile
-  - rvm: 1.9.3
-    gemfile: gemfiles/5.2.gemfile
-  - rvm: 2.0
-    gemfile: gemfiles/5.2.gemfile
-  - rvm: 2.1
-    gemfile: gemfiles/5.2.gemfile
   - rvm: 2.2.0
     gemfile: gemfiles/5.2.gemfile
-
+  - rvm: 2.2.0
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.2.2
+    gemfile: gemfiles/6.0.gemfile
+  - rvm: 2.4.5
+    gemfile: gemfiles/6.0.gemfile
 
 before_install:
-  - gem update --system && gem install bundler
+  - gem install bundler --version=1.17.3
 
 script:
   - RAILS_ENV=test bundle exec rake spec && bundle exec codeclimate-test-reporter

data/Appraisals

@@ -13,3 +13,7 @@ end
 appraise "5.2" do
   gem "rails", "~> 5.2"
 end
+
+appraise "6.0" do
+  gem 'rails', '~> 6.0.0.beta3'
+end

data/CHANGELOG.md

@@ -1,3 +1,56 @@
+## 3.3.2 (April 12th, 2019)
+
+Features:
+- Added uptime robot to configuration.rb (@razel1982, #556)
+- Check to see if being run in Rails application and run in before_initialize (@husteadrobert, #555)
+
+Bugfixes:
+- Fix error message interpolation (@hanibash, #553)
+- Fix Bigdecimal warnings (@agraves, #551)
+- Avoid hitting up on redis for robots/excluded users. (@andrehjr, #544)
+- Checks for defined?(request) on Helper#exclude_visitor?. (@andrehjr)
+
+Misc:
+- Update travis to add Rails 6 (@edmilton, #559)
+- Fix broken specs in developement environment (@dougpetronilio, #557)
+
+## 3.3.1 (January 11th, 2019)
+
+Features:
+- Filter some more bots (@janosch-x, #542)
+
+Bugfixes:
+- Fix Dashboard Pagination Helper typo (@cattekin, #541)
+- Do not storage alternative in cookie if experiment has a winner (@sadhu89, #539)
+- fix user participating alternative not found (@NaturalHokke, #536)
+
+Misc:
+- Tweak RSpec instructions (@eliotsykes, #540)
+- Improve README regarding rspec usage (@vermaxik, #538)
+
+## 3.3.0 (August 13th, 2018)
+
+Features:
+
+- Added pagination for dashboard (@GeorgeGorbanev, #518)
+- Add Facebot crawler to list of bots (@pfeiffer, #530)
+- Ignore previewing requests (@pfeiffer, #531)
+- Fix binding of ignore_filter (@pfeiffer, #533)
+
+Bugfixes:
+
+- Fix cookie header duplication (@andrehjr, #522)
+
+Performance:
+
+- Improve performance of RedisInterface#make_list_length by using LTRIM command (@mlovic, #509)
+
+Misc:
+
+- Update development dependencies
+- test rails 5.2 on travis (@lostapathy, #524)
+- update ruby versions for travis (@lostapathy, #525)
+
 ## 3.2.0 (September 21st, 2017)
 
 Features:

data/README.md

@@ -159,15 +159,15 @@ In the event you want to disable all tests without having to know the individual
 
 It is not required to send `SPLIT_DISABLE=false` to activate Split.
 
-To aid testing with RSpec, write `split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
+
+### Rspec Helper
+To aid testing with RSpec, write `spec/support/split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
 
 ```ruby
-# Recommended path for this file is 'spec/support/split_helper.rb', and you will need to ensure it
-# is `require`-d by rails_helper.rb or spec_helper.rb
+# Create a file with these contents at 'spec/support/split_helper.rb'
+# and ensure it is `require`d in your rails_helper.rb or spec_helper.rb
 module SplitHelper
 
-  # Usage:
-  #
   # Force a specific experiment alternative to always be returned:
   #   use_ab_test(signup_form: "single_page")
   #
@@ -176,18 +176,26 @@ module SplitHelper
   #
   def use_ab_test(alternatives_by_experiment)
     allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment|
-      alternative =
-        alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
+      alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
     end
   end
 end
 
+# Make the `use_ab_test` method available to all specs:
 RSpec.configure do |config|
-  # Make the `use_ab_test` method available to all specs:
   config.include SplitHelper
 end
 ```
 
+Now you can call `use_ab_test(alternatives_by_experiment)`  in your specs, for example:
+```ruby
+it "registers using experimental signup" do
+  use_ab_test experiment_name: "alternative_name"
+  post "/signups"
+  ...
+end
+```
+
 
 ### Starting experiments manually
 
@@ -210,6 +218,12 @@ The user will then always see the alternative they started with.
 
 Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
 
+### Reset experiments manually
+
+By default Split automatically resets the experiment whenever it detects the configuration for an experiment has changed (e.g. you call `ab_test` with different alternatives). You can prevent this by setting the option `reset_manually` to `true`.
+
+You may want to do this when you want to change something, like the variants' names, the metadata about an experiment, etc. without resetting everything.
+
 ### Multiple experiments at once
 
 By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.
@@ -450,6 +464,7 @@ Split.configure do |config|
   config.enabled = true
   config.persistence = Split::Persistence::SessionAdapter
   #config.start_manually = false ## new test will have to be started manually from the admin panel. default false
+  #config.reset_manually = false ## if true, it never resets the experiment data, even if the configuration changes
   config.include_rails_helper = true
   config.redis = "redis://custom.redis.url:6380"
 end
@@ -935,4 +950,4 @@ Please note that this project is released with a [Contributor Code of Conduct](C
 
 ## Copyright
 
-[MIT License](LICENSE) © 2018 [Andrew Nesbitt](https://github.com/andrew).
+[MIT License](LICENSE) © 2019 [Andrew Nesbitt](https://github.com/andrew).

data/gemfiles/6.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "codeclimate-test-reporter"
+gem "rails", "~> 6.0.0.beta3"
+
+gemspec path: "../"

data/lib/split/combined_experiments_helper.rb

@@ -3,7 +3,7 @@ module Split
   module CombinedExperimentsHelper
     def ab_combined_test(metric_descriptor, control = nil, *alternatives)
       return nil unless experiment = find_combined_experiment(metric_descriptor)
-      raise(Split::InvalidExperimentsFormatError, 'Unable to find experiment #{metric_descriptor} in configuration') if experiment[:combined_experiments].nil?
+      raise(Split::InvalidExperimentsFormatError, "Unable to find experiment #{metric_descriptor} in configuration") if experiment[:combined_experiments].nil?
 
       alternative = nil
       weighted_alternatives = nil

data/lib/split/configuration.rb

@@ -61,12 +61,14 @@ module Split
         'ColdFusion' => 'ColdFusion http library',
         'EventMachine HttpClient' => 'Ruby http library',
         'Go http package' => 'Go http library',
+        'Go-http-client' => 'Go http library',
         'Java' => 'Generic Java http library',
         'libwww-perl' => 'Perl client-server library loved by script kids',
         'lwp-trivial' => 'Another Perl library loved by script kids',
         'Python-urllib' => 'Python http library',
         'PycURL' => 'Python http library',
         'Test Certificate Info' => 'C http library?',
+        'Typhoeus' => 'Ruby http library',
         'Wget' => 'wget unix CLI http client',
 
         # URL expanders / previewers
@@ -91,10 +93,12 @@ module Split
 
         # Uptime monitoring
         'check_http' => 'Nagios monitor',
+        'GoogleStackdriverMonitoring' => 'Google Cloud monitor',
         'NewRelicPinger' => 'NewRelic monitor',
         'Panopta' => 'Monitoring service',
         'Pingdom' => 'Pingdom monitoring',
         'SiteUptime' => 'Site monitoring services',
+        'UptimeRobot' => 'Monitoring service',
 
         # ???
         'DigitalPersona Fingerprint Software' => 'HP Fingerprint scanner',

data/lib/split/dashboard/helpers.rb

@@ -19,9 +19,9 @@ module Split
 
     def round(number, precision = 2)
       begin
-        BigDecimal.new(number.to_s)
+        BigDecimal(number.to_s)
       rescue ArgumentError
-        BigDecimal.new(0)
+        BigDecimal(0)
       end.round(precision).to_f
     end
 

data/lib/split/dashboard/pagination_helpers.rb

@@ -25,7 +25,7 @@ module Split
       html << current_page_tag
       html << next_page_tag if show_next_page_tag?(collection)
       html << ellipsis_tag if show_last_ellipsis_tag?(collection)
-      html << last_page_tagcollection if show_last_page_tag?(collection)
+      html << last_page_tag(collection) if show_last_page_tag?(collection)
       html.join
     end
 

data/lib/split/helper.rb

@@ -8,7 +8,7 @@ module Split
     def ab_test(metric_descriptor, control = nil, *alternatives)
       begin
         experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
-        alternative = if Split.configuration.enabled
+        alternative = if Split.configuration.enabled && !exclude_visitor?
           experiment.save
           raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
           trial = Trial.new(:user => ab_user, :experiment => experiment,
@@ -122,7 +122,7 @@ module Split
     end
 
     def exclude_visitor?
-      instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?
+      defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
     end
 
     def is_robot?

data/lib/split/trial.rb

@@ -68,10 +68,8 @@ module Split
         if exclude_user?
           self.alternative = @experiment.control
         else
-          value = @user[@experiment.key]
-          if value
-            self.alternative = value
-          else
+          self.alternative = @user[@experiment.key]
+          if alternative.nil?
             self.alternative = @experiment.next_alternative
 
             # Increment the number of participants since we are actually choosing a new alternative
@@ -82,7 +80,7 @@ module Split
         end
       end
 
-      @user[@experiment.key] = alternative.name if should_store_alternative?
+      @user[@experiment.key] = alternative.name if !@experiment.has_winner? && should_store_alternative?
       @alternative_choosen = true
       run_callback context, Split.configuration.on_trial unless @options[:disabled] || Split.configuration.disabled?
       alternative

data/lib/split/version.rb

@@ -2,6 +2,6 @@
 module Split
   MAJOR   = 3
   MINOR   = 3
-  PATCH   = 0
+  PATCH   = 2
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/lib/split.rb

@@ -66,4 +66,11 @@ module Split
   end
 end
 
-Split.configure {}
+# 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
+    config.before_initialize { Split.configure {} }
+  end
+else
+  Split.configure {}
+end

data/spec/helper_spec.rb

@@ -564,6 +564,11 @@ describe Split::Helper do
         expect(alternative).to eq experiment.control.name
       end
 
+      it 'should not create a experiment' do
+        ab_test('link_color', 'blue', 'red')
+        expect(Split::Experiment.new('link_color')).to be_a_new_record
+      end
+
       it "should not increment the participation count" do
 
         previous_red_count = Split::Alternative.new('red', 'link_color').participant_count

data/spec/trial_spec.rb

@@ -176,6 +176,14 @@ describe Split::Trial do
 
         expect_alternative(trial, 'basket')
       end
+
+      context "when alternative is not found" do
+        it "falls back on next_alternative" do
+          user[experiment.key] = 'notfound'
+          expect(experiment).to receive(:next_alternative).and_call_original
+          expect_alternative(trial, alternatives)
+        end
+      end
     end
 
     context "when user is a new participant" do
@@ -275,5 +283,17 @@ describe Split::Trial do
         trial.choose!
       end
     end
+
+    context 'when experiment has winner' do
+      let(:trial) do
+        experiment.winner = 'cart'
+        Split::Trial.new(:user => user, :experiment => experiment)
+      end
+
+      it 'does not store' do
+        expect(user).to_not receive("[]=")
+        trial.choose!
+      end
+    end
   end
 end

data/split.gemspec

@@ -34,11 +34,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'sinatra',         '>= 1.2.6'
   s.add_dependency 'simple-random',   '>= 0.9.3'
 
-  s.add_development_dependency 'bundler',     '~> 1.14'
+  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 'rspec',       '~> 3.7'
   s.add_development_dependency 'pry',         '~> 0.10'
   s.add_development_dependency 'fakeredis',   '~> 0.7'
+  s.add_development_dependency 'rails',       '>= 4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: 
 email:
 - andrewnez@gmail.com
@@ -176,6 +190,7 @@ files:
 - gemfiles/5.0.gemfile
 - gemfiles/5.1.gemfile
 - gemfiles/5.2.gemfile
+- gemfiles/6.0.gemfile
 - lib/split.rb
 - lib/split/algorithms/block_randomization.rb
 - lib/split/algorithms/weighted_sample.rb
@@ -270,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: split
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rack based split testing framework