eeny-meeny 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b63f2223b23e189cdf963583f0666227ec3a6410
-  data.tar.gz: c2e23b8389b07ed951ed3506b3b3f6a6e88bdf1b
+SHA256:
+  metadata.gz: eb901520367109f3167e217522a3b712ae71167e04c0458d4dac2b0907b541bc
+  data.tar.gz: b360de703e230a8aef6fb7ec7211fe24aa2f79007bb2c3344591a452b40d26ae
 SHA512:
-  metadata.gz: 51f9a32c834a0b723e76ac840a9deca30deb98bb49bb41f671977f631d4dbddb5a094b0b6a35b16445b6886af629ce4413ed6f776b00e1ba410e02f048585f73
-  data.tar.gz: 79b2ed878d4a24c3a736b311a942d9386b5266eac1a0410ece9d0b76e90e42b6d640bdfadd798e4e9ed4b3b10af1c0c92704c03d6c3638b0550b2866ac50d136
+  metadata.gz: f9e244e1ba2895921276b2fe070689a2694296ce8db150e0f9ddde380608d65e5cda63afe6e130981da0c7eed3e5e32eb67e28b021cfc38cbf8d931d23b4a8e3
+  data.tar.gz: e84d5450b37db881191650f259a9abe353d63e8ab8cbdda3c666932029ad78774281f8d99ea73491c74f1807d3aad7dce6908b678c779b888b1c79a32b7c3b2d

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/.simplecov

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'simplecov-rcov'
+
+formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::RcovFormatter
+]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatters)
+SimpleCov.add_group('Lib', 'lib')
+SimpleCov.add_group('Helpers', 'lib/eeny-meeny/helpers')
+SimpleCov.add_group('Models', 'lib/eeny-meeny/models')
+SimpleCov.add_group('Routing', 'lib/eeny-meeny/routing')
+SimpleCov.add_group('Rake Tasks', 'lib/tasks')
+SimpleCov.add_group('Specs', 'spec')
+SimpleCov.start

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
-sudo: false
 env:
-  - "RAILS_VERSION=4.2.8"
+  - "RAILS_VERSION=6.1.4"
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.6.8
+  - 2.7.4

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 2.3.0 (2021-08-11)
+
+Changes:
+
+    - Support Rails 6 (PR: #11).
+    - Remove cookies for previous experiment versions (PR: #12).
+    - Update Travis configuration to include Ruby version 2.6 to 2.7.
+
 ### 2.2.2 (2019-04-08)
 
 Bugfixes:

data/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
-group :test do
-  gem 'codeclimate-test-reporter', require: nil
-end
-
 gemspec

data/README.md

@@ -3,7 +3,7 @@ eeny-meeny
 [![Gem Version](https://badge.fury.io/rb/eeny-meeny.svg)](https://badge.fury.io/rb/eeny-meeny)
 [![Code Climate](https://codeclimate.com/github/corthmann/eeny-meeny/badges/gpa.svg)](https://codeclimate.com/github/corthmann/eeny-meeny)
 [![Test Coverage](https://codeclimate.com/github/corthmann/eeny-meeny/badges/coverage.svg)](https://codeclimate.com/github/corthmann/eeny-meeny/coverage)
-[![Build Status](https://travis-ci.org/corthmann/eeny-meeny.svg?branch=master)](https://travis-ci.org/corthmann/eeny-meeny)
+[![Build Status](https://travis-ci.com/corthmann/eeny-meeny.svg?branch=master)](https://travis-ci.com/corthmann/eeny-meeny)
 
 Installation
 -------------

data/eeny-meeny.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/eeny-meeny/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'eeny-meeny'
   s.version     = EenyMeeny::VERSION.dup
-  s.date        = '2019-04-08'
+  s.date        = '2021-08-11'
   s.summary     = "A simple split and smoke testing tool for Rails"
   s.authors     = ["Christian Orthmann"]
   s.email       = 'christian.orthmann@gmail.com'
@@ -13,12 +13,12 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://rubygems.org/gems/eeny-meeny'
   s.license     = 'MIT'
 
-  s.add_development_dependency('rake', '~> 10')
+  s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec', '~> 3')
   s.add_development_dependency('simplecov', '~> 0')
   s.add_development_dependency('simplecov-rcov', '~> 0')
   s.add_development_dependency('yard', '>= 0.9.11', '< 1.0.0')
-  s.add_development_dependency('rack-test', '~> 0.6.3')
+  s.add_development_dependency('rack-test', '~> 1')
   s.add_runtime_dependency('rack', '>= 1.2.1', '< 3')
-  s.add_runtime_dependency('activesupport', '>= 3.0.0', '< 6.0.0')
+  s.add_runtime_dependency('activesupport', '>= 3.0.0', '< 6.2.0')
 end

data/lib/eeny-meeny/{experiment_helper.rb → helpers/experiment_helper.rb}

@@ -1,7 +1,13 @@
+require 'active_support/concern'
 require 'eeny-meeny/models/cookie'
 require 'eeny-meeny/models/experiment'
 
 module EenyMeeny::ExperimentHelper
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :participates_in?, :smoke_test?
+  end
 
   def participates_in?(experiment_id, variation_id: nil)
     experiment = EenyMeeny::Experiment.find_by_id(experiment_id)

data/lib/eeny-meeny/middleware.rb

@@ -85,7 +85,7 @@ module EenyMeeny
       # Skip if no valid 'smoke_test_id' query parameter present
       return env, new_cookies unless query_parameters.key?('smoke_test_id') && (query_parameters['smoke_test_id'] =~ /\A[A-Za-z_]+\z/)
       # Set HTTP_COOKIE header to enable smoke test on first pageview
-      cookie = EenyMeeny::Cookie.create_for_smoke_test(query_parameters['smoke_test_id'], @cookie_config)
+      cookie = EenyMeeny::Cookie.create_for_smoke_test(query_parameters['smoke_test_id'], **@cookie_config)
       env = add_or_replace_http_cookie(env, cookie)
       new_cookies[cookie.name] = cookie
       return env, new_cookies

data/lib/eeny-meeny/models/experiment.rb

@@ -1,3 +1,4 @@
+require 'eeny-meeny/models/cookie'
 require 'eeny-meeny/models/variation'
 require 'active_support/time'
 require 'active_support/core_ext/enumerable'
@@ -5,7 +6,9 @@ require 'active_support/core_ext/enumerable'
 module EenyMeeny
   class Experiment
 
-    COOKIE_EXPERIMENT_ID_REGEX = /\Aeeny_meeny_(.+)_v\d+\z/.freeze
+    COOKIE_EXPERIMENT_ID_REGEX = Regexp.new(
+      "\\A#{EenyMeeny::Cookie::EXPERIMENT_PREFIX}(.+)_v(\\d+)\\z"
+    ).freeze
 
     attr_reader :id, :name, :version, :variations, :total_weight, :end_at, :start_at
 
@@ -23,9 +26,12 @@ module EenyMeeny
     end
 
     def self.find_by_cookie_name(cookie_name)
-      if cookie_name =~ COOKIE_EXPERIMENT_ID_REGEX
-        find_by_id($1)
-      end
+      return unless cookie_name =~ COOKIE_EXPERIMENT_ID_REGEX
+
+      experiment = find_by_id($1)
+      return unless experiment && experiment.version.to_s == $2
+
+      experiment
     end
 
     def initialize(id, name: '', version: 1, variations: {}, start_at: nil, end_at: nil)

data/lib/eeny-meeny/railtie.rb

@@ -1,6 +1,6 @@
 require 'eeny-meeny'
-require 'eeny-meeny/experiment_helper'
 require 'eeny-meeny/middleware'
+require 'eeny-meeny/helpers/experiment_helper'
 
 module EenyMeeny
   class Railtie < Rails::Railtie
@@ -15,13 +15,17 @@ module EenyMeeny
         config.secure                = app.config.eeny_meeny[:secure]           if app.config.eeny_meeny.key?(:secure)
         config.query_parameters      = app.config.eeny_meeny[:query_parameters] if app.config.eeny_meeny.key?(:query_parameters)
       end
-      # Include Helpers in ActionController and ActionView
-      ActionController::Base.send :include, EenyMeeny::ExperimentHelper
-      ActionView::Base.send :include, EenyMeeny::ExperimentHelper
       # Insert Middleware
       app.middleware.insert_before ActionDispatch::Cookies, EenyMeeny::Middleware
     end
 
+    config.to_prepare do
+      # Include Helpers in ActionController and ActionView
+      ActiveSupport.on_load(:action_controller_base) do
+        include EenyMeeny::ExperimentHelper
+      end
+    end
+
     rake_tasks do
       load 'tasks/cookie.rake'
     end

data/lib/eeny-meeny/version.rb

@@ -1,3 +1,3 @@
 module EenyMeeny
-  VERSION = '2.2.2'
+  VERSION = '2.3.0'
 end

data/lib/tasks/cookie.rake

@@ -38,7 +38,7 @@ namespace :eeny_meeny do
       raise "Missing 'smoke_test_id' parameter" if (args['smoke_test_id'].nil? || args['smoke_test_id'].empty?)
       smoke_test_id = args['smoke_test_id']
       version       = args['version'] || 1
-      cookie = EenyMeeny::Cookie.create_for_smoke_test(smoke_test_id, EenyMeeny.config.cookies.merge(version: version))
+      cookie = EenyMeeny::Cookie.create_for_smoke_test(smoke_test_id, **EenyMeeny.config.cookies.merge(version: version))
       puts cookie
     end
   end

data/spec/eeny-meeny/experiment_helper_spec.rb

@@ -1,6 +1,5 @@
-require 'spec_helper'
 require 'eeny-meeny/middleware'
-require 'eeny-meeny/experiment_helper'
+require 'eeny-meeny/helpers/experiment_helper'
 require 'eeny-meeny/models/experiment'
 require 'eeny-meeny/models/variation'
 require 'eeny-meeny/models/cookie'

data/spec/eeny-meeny/middleware_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'eeny-meeny/models/encryptor'
 require 'eeny-meeny/middleware'
 
@@ -55,7 +54,7 @@ describe EenyMeeny::Middleware do
       let(:request) { Rack::MockRequest.new(subject) }
 
       before(:example) do
-        @original_request_cookies = 'test=abc;eeny_meeny_my_page_v1=on1tOQ5hiKdA0biVZVwvTUQcmkODacwdpi%2FedQJIYQz9KdWYAXqzCafF5Dqqa6xtHFBdXYVmz%2Bp4%2FigmKz4hBVYZbJU%2FMwBbvYG%2BIoBelk10PxwtyxbA%2BiDzFT4jZeiTkNOmZ3rp1Gzz74JjT4aocqB187p7SrpeM2jfyZ8ZKPOiZs6tXf0QoXkV%2BZbtxJLRPr5lgmGxslfM8vCIm1%2F0HQ%3D%3D;'
+        @original_request_cookies = 'test=abc;eeny_meeny_my_page_v1=on1tOQ5hiKdA0biVZVwvTUQcmkODacwdpi%2FedQJIYQz9KdWYAXqzCafF5Dqqa6xtHFBdXYVmz%2Bp4%2FigmKz4hBVYZbJU%2FMwBbvYG%2BIoBelk10PxwtyxbA%2BiDzFT4jZeiTkNOmZ3rp1Gzz74JjT4aocqB187p7SrpeM2jfyZ8ZKPOiZs6tXf0QoXkV%2BZbtxJLRPr5lgmGxslfM8vCIm1%2F0HQ%3D%3D;eeny_meeny_versioned_v3=UUgXwn3j0%2BOL2cpov4duTnuCJPc621yHd6GjuXpN0gnYLDASTsDpyk01CnFY5ZYCAo%2BgLO%2BwTbsYObP8dp30rA%3D%3D;'
         @response = request.get('/test',
                                 'CONTENT_TYPE' => 'text/plain',
                                 'HTTP_COOKIE' => @original_request_cookies)
@@ -72,9 +71,13 @@ describe EenyMeeny::Middleware do
 
     context 'and the request contains a cookie from an undefined experiment' do
       let(:request) { Rack::MockRequest.new(subject) }
+      let(:cookie_value) { 'eeny_meeny_undefined_experiment_v1=thevaluedoesntmatter' }
+      let(:return_value) do
+        "#{cookie_value}; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 GMT; SameSite=Strict"
+      end
 
       before(:example) do
-        @original_request_cookies = 'test=abc;eeny_meeny_undefined_experiment_v1=thevaluedoesntmatter;'
+        @original_request_cookies = "test=abc;#{cookie_value};"
         @response = request.get('/test',
                                 'CONTENT_TYPE' => 'text/plain',
                                 'HTTP_COOKIE' => @original_request_cookies)
@@ -82,7 +85,7 @@ describe EenyMeeny::Middleware do
 
 
       it "instructs the browser to remove through the 'Set-Cookie' header on the response" do
-        expect(@response['Set-Cookie']).to include('eeny_meeny_undefined_experiment_v1=thevaluedoesntmatter; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000; SameSite=Strict')
+        expect(@response['Set-Cookie']).to include(return_value)
       end
     end
 

data/spec/eeny-meeny/models/cookie_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'eeny-meeny/models/cookie'
 require 'eeny-meeny/models/experiment'
 

data/spec/eeny-meeny/models/experiment_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'eeny-meeny/models/experiment'
 require 'eeny-meeny/models/variation'
 
@@ -158,7 +157,7 @@ describe EenyMeeny::Experiment do
       it 'returns those experiments' do
         instances = described_class.find_all
         expect(instances).to be_a Array
-        expect(instances.size).to eq(2)
+        expect(instances.size).to eq(3)
         instances.each do |instance|
           expect(instance).to be_a EenyMeeny::Experiment
         end
@@ -213,6 +212,12 @@ describe EenyMeeny::Experiment do
       end
     end
 
+    context 'when the given cookie name does not match the experiment version' do
+      it 'returns the experiment' do
+        expect(described_class.find_by_cookie_name(:eeny_meeny_versioned_v2)).to be_nil
+      end
+    end
+
     context 'when the given cookie name does not match a configured experiment' do
       it 'returns nil' do
         expect(described_class.find_by_cookie_name(:eeny_meeny_undefined_experiment_v2)).to be_nil

data/spec/eeny-meeny/models/variation_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'eeny-meeny/models/variation'
 
 describe EenyMeeny::Variation do

data/spec/fixtures/experiments.yml

@@ -8,6 +8,16 @@
     :new:
       :name: New My Page
       :weight: 0.98
+:versioned:
+  :name: Versioned
+  :version: 3
+  :variations:
+    :old:
+      :name: Old Versioned Page
+      :weight: 0.02
+    :new:
+      :name: New Versioned Page
+      :weight: 0.98
 :expired:
   :name: Expired
   :version: 1

data/spec/spec_helper.rb

@@ -1,28 +1,15 @@
 require 'simplecov'
-require 'simplecov-rcov'
-require 'codeclimate-test-reporter'
 require 'active_support/time'
-
-SimpleCov.start do
-  formatter SimpleCov::Formatter::MultiFormatter.new([
-                SimpleCov::Formatter::HTMLFormatter,
-                SimpleCov::Formatter::RcovFormatter,
-                CodeClimate::TestReporter::Formatter])
-  add_group('EenyMeeny', 'lib/eeny-meeny')
-  add_group('Rake Tasks', 'lib/tasks')
-  add_group('Specs', 'spec')
-end
-
 require 'rspec'
 require 'yaml'
 require 'mock_rack_app'
-
 require 'eeny-meeny'
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = "random"
+  config.expose_dsl_globally = true
 
   config.before(:suite) do
     Time.zone = 'UTC'
@@ -41,5 +28,4 @@ RSpec.configure do |config|
       config.experiments = YAML.load_file(File.join('spec','fixtures','empty_experiments.yml'))
     end
   end
-
 end

data/spec/tasks/cookie_task_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'rake'
 
 describe 'cookie.rake', experiments: true do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eeny-meeny
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Christian Orthmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +129,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,13 +139,15 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.2.0
 description: 
 email: christian.orthmann@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".simplecov"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -154,7 +156,7 @@ files:
 - Rakefile
 - eeny-meeny.gemspec
 - lib/eeny-meeny.rb
-- lib/eeny-meeny/experiment_helper.rb
+- lib/eeny-meeny/helpers/experiment_helper.rb
 - lib/eeny-meeny/middleware.rb
 - lib/eeny-meeny/models/cookie.rb
 - lib/eeny-meeny/models/encryptor.rb
@@ -196,8 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A simple split and smoke testing tool for Rails