split 4.0.3 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746dd3b526b5464f12e01e2f00f8ff62b71ac6483527632f6f0bca7bc5242e8c
-  data.tar.gz: bb40ca355a1aa9eec9cfb4067e6e2b3c381072830cffadffe414f8d7a4af043f
+  metadata.gz: c0c7476504dcc3b062af1a156fc7021b65e64bcc64a96d5faeabd9c4bd3fc987
+  data.tar.gz: c8cb8c4335be14da004d94da31a5cb21ee80a13f0b782f7e94c36f698f1765ef
 SHA512:
-  metadata.gz: 70466ddfe57955a43dda0506c4a23806f6bdab154b344e495879027ae2baebec93d59f34018e78a3e83ef945c776c7a2ddcf2b40cd71998fb0bc9207ed60df61
-  data.tar.gz: db1d46d7e7e1826aacf80ec1c8634f0502bd07d4b58d488e57f4917a8843954d568b4cd20c9e2db09ac2ff80811b14ec68a3158b870d091eeabf4e426af8172d
+  metadata.gz: 2bc0b3bbaeef30019bdcf913b8b20c3ac32efec3e025692eef5b3d552a0e7246b67a4dbcb73de7a01dd82d78d985587d21737f5f6cc77dcf4e1540eb067b9655
+  data.tar.gz: 87763ae8d35cf44780362e460c86ef7f818b32b5b7d5f4f1e4ec3c24cedf1b277bf162c2f34daba0cb1477f4acd44c8b4aa2d436be396ec51fbc19d8edcb72de

data/.github/workflows/ci.yml

@@ -6,52 +6,40 @@ 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'
-
-          - gemfile: 6.1.gemfile
-            ruby: '3.0'
-
-          - gemfile: 7.0.gemfile
-            ruby: '3.0'
-
-          - gemfile: 7.0.gemfile
-            ruby: '3.1'
-
-          - gemfile: 7.0.gemfile
-            ruby: '3.2'
-
+        ruby: ["3.5.0-preview1", "3.4", "3.3", "3.2", "3.1", "3.0", "2.7"]
+        rails: ["8.0", "7.2", "7.1", "6.1"]
+        exclude:
+          - rails: "6.1"
+            ruby: "3.4"
+
+          - rails: "6.1"
+            ruby: "3.5.0-preview1"
+
+          - rails: "7.2"
+            ruby: "2.7"
+          - rails: "7.2"
+            ruby: "3.0"
+
+          - rails: "8.0"
+            ruby: "2.7"
+          - rails: "8.0"
+            ruby: "3.0"
+          - rails: "8.0"
+            ruby: "3.1"
     runs-on: ubuntu-latest
 
     services:
       redis:
         image: redis
-        ports: ['6379:6379']
+        ports: ["6379:6379"]
         options: >-
           --health-cmd "redis-cli ping"
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
 
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
     steps:
       - uses: actions/checkout@v4
 
@@ -61,7 +49,6 @@ jobs:
 
       - name: Install dependencies
         run: |
-          bundle config set gemfile "${GITHUB_WORKSPACE}/gemfiles/${{ matrix.gemfile }}"
           bundle install --jobs 4 --retry 3
 
       - name: Display Ruby version

data/CHANGELOG.md

@@ -1,4 +1,24 @@
-# 4.0.3 (November 15rd, 2023)
+# 4.0.5 (Aug 3rd, 2025)
+
+Bugfixes:
+- Handle when Rails is partially loaded as a Gem. (@bjacobs09,  #727)
+- Fix Rack compatibility with versions > 3 (@andrehjr, #729)
+
+Misc:
+- Add funding_uri to gemspec (@andrew, #726)
+- Drop Rails 5.x Support (@andrehjr, #728)
+- Drop Rails 6.0 and Ruby < 2.6 (@andrehjr, #729)
+- Add support for Ruby 3.5+ (@andrehjr, #737)
+
+# 4.0.4 (March 3rd, 2024)
+
+Bugfixes:
+- Better integration for EncapsulatedHelper when needing params/request info (@henrique-ft, #721 and #723)
+
+Misc:
+- Make specs compatible with newer Rack versions (@andrehjr,  #722)
+
+# 4.0.3 (November 15th, 2023)
 
 Bugfixes:
 - Do not throw error if alternativas have data that can lead to negative numbers for probability calculation (@andrehjr, #703)

data/Gemfile

@@ -6,3 +6,6 @@ gemspec
 
 gem "rubocop", require: false
 gem "codeclimate-test-reporter"
+gem "concurrent-ruby", "< 1.3.5"
+
+gem "rails", "~> #{ENV.fetch('RAILS_VERSION', '8.0')}"

data/lib/split/dashboard.rb

@@ -29,7 +29,8 @@ module Split
       if Object.const_defined?("Rails") && Rails.respond_to?(:env)
         @current_env = Rails.env.titlecase
       else
-        @current_env = "Rack: #{Rack.version}"
+        rack_version = Rack.respond_to?(:version) ? Rack.version : Rack.release
+        @current_env = "Rack: #{rack_version}"
       end
       erb :index
     end

data/lib/split/encapsulated_helper.rb

@@ -23,6 +23,14 @@ module Split
         @context = context
       end
 
+      def params
+        request.params if request && request.respond_to?(:params)
+      end
+
+      def request
+        @context.request if @context.respond_to?(:request)
+      end
+
       def ab_user
         @ab_user ||= Split::User.new(@context)
       end

data/lib/split/helper.rb

@@ -121,11 +121,11 @@ module Split
     end
 
     def override_alternative_by_params(experiment_name)
-      defined?(params) && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
+      params_present? && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
     end
 
     def override_alternative_by_cookies(experiment_name)
-      return unless defined?(request)
+      return unless request_present?
 
       if request.cookies && request.cookies.key?("split_override")
         experiments = JSON.parse(request.cookies["split_override"]) rescue {}
@@ -134,7 +134,7 @@ module Split
     end
 
     def split_generically_disabled?
-      defined?(params) && params["SPLIT_DISABLE"]
+      params_present? && params["SPLIT_DISABLE"]
     end
 
     def ab_user
@@ -142,26 +142,34 @@ module Split
     end
 
     def exclude_visitor?
-      defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
+      request_present? && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
     end
 
     def is_robot?
-      defined?(request) && request.user_agent =~ Split.configuration.robot_regex
+      request_present? && request.user_agent =~ Split.configuration.robot_regex
     end
 
     def is_preview?
-      defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
+      request_present? && defined?(request.headers) && request.headers["x-purpose"] == "preview"
     end
 
     def is_ignored_ip_address?
       return false if Split.configuration.ignore_ip_addresses.empty?
 
       Split.configuration.ignore_ip_addresses.each do |ip|
-        return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
+        return true if request_present? && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
       end
       false
     end
 
+    def params_present?
+      defined?(params) && params
+    end
+
+    def request_present?
+      defined?(request) && request
+    end
+
     def active_experiments
       ab_user.active_experiments
     end

data/lib/split/persistence/cookie_adapter.rb

@@ -47,8 +47,9 @@ module Split
         end
 
         def set_cookie_via_rack(key, value)
-          delete_cookie_header!(@response.header, key, value)
-          Rack::Utils.set_cookie_header!(@response.header, key, value)
+          headers = @response.respond_to?(:header) ? @response.header : @response.headers
+          delete_cookie_header!(headers, key, value)
+          Rack::Utils.set_cookie_header!(headers, key, value)
         end
 
         # Use Rack::Utils#make_delete_cookie_header after Rack 2.0.0

data/lib/split/redis_interface.rb

@@ -30,7 +30,7 @@ module Split
       attr_accessor :redis
 
       def redis_namespace_used?
-        Redis.const_defined?("Namespace") && Split.redis.is_a?(Redis::Namespace)
+        defined?(Redis::Namespace) && Split.redis.is_a?(Redis::Namespace)
       end
   end
 end

data/lib/split/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Split
-  VERSION = "4.0.3"
+  VERSION = "4.0.5"
 end

data/lib/split.rb

@@ -24,7 +24,7 @@ require "split/trial"
 require "split/user"
 require "split/version"
 require "split/zscore"
-require "split/engine" if defined?(Rails)
+require "split/engine" if defined?(::Rails::Engine)
 
 module Split
   extend self
@@ -74,7 +74,7 @@ module Split
 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)
+if defined?(::Rails::Railtie)
   class Split::Railtie < Rails::Railtie
     config.before_initialize { Split.configure { } }
   end

data/spec/encapsulated_helper_spec.rb

@@ -3,11 +3,7 @@
 require "spec_helper"
 
 describe Split::EncapsulatedHelper do
-  include Split::EncapsulatedHelper
-
-  def params
-    raise NoMethodError, "This method is not really defined"
-  end
+  let(:context_shim) { Split::EncapsulatedHelper::ContextShim.new(double(request: request)) }
 
   describe "ab_test" do
     before do
@@ -15,20 +11,15 @@ describe Split::EncapsulatedHelper do
       .and_return(mock_user)
     end
 
-    it "should not raise an error when params raises an error" do
-      expect { params }.to raise_error(NoMethodError)
-      expect { ab_test("link_color", "blue", "red") }.not_to raise_error
-    end
-
     it "calls the block with selected alternative" do
-      expect { |block| ab_test("link_color", "red", "red", &block) }.to yield_with_args("red", {})
+      expect { |block| context_shim.ab_test("link_color", "red", "red", &block) }.to yield_with_args("red", {})
     end
 
     context "inside a view" do
       it "works inside ERB" do
         require "erb"
         template = ERB.new(<<-ERB.split(/\s+/s).map(&:strip).join(" "), nil, "%")
-          foo <% ab_test(:foo, '1', '2') do |alt, meta| %>
+          foo <% context_shim.ab_test(:foo, '1', '2') do |alt, meta| %>
             static <%= alt %>
           <% end %>
         ERB
@@ -43,8 +34,43 @@ describe Split::EncapsulatedHelper do
         include Split::EncapsulatedHelper
         public :session
       }.new
+
       expect(ctx).to receive(:session) { {} }
       expect { ctx.ab_test("link_color", "blue", "red") }.not_to raise_error
     end
+
+    context "when request is defined in context of ContextShim" do
+      context "when overriding by params" do
+        it do
+          ctx = Class.new {
+            public :session
+            def request
+              build_request(params: {
+                "ab_test" => { "link_color" => "blue" }
+              })
+            end
+          }.new
+
+          context_shim = Split::EncapsulatedHelper::ContextShim.new(ctx)
+          expect(context_shim.ab_test("link_color", "blue", "red")).to be("blue")
+        end
+      end
+
+      context "when overriding by cookies" do
+        it do
+          ctx = Class.new {
+            public :session
+            def request
+              build_request(cookies: {
+                "split_override" => '{ "link_color": "red" }'
+              })
+            end
+          }.new
+
+          context_shim = Split::EncapsulatedHelper::ContextShim.new(ctx)
+          expect(context_shim.ab_test("link_color", "blue", "red")).to be("red")
+        end
+      end
+    end
   end
 end

data/spec/helper_spec.rb

@@ -670,7 +670,7 @@ describe Split::Helper do
 
   describe "when user is a robot" do
     before(:each) do
-      @request = OpenStruct.new(user_agent: "Googlebot/2.1 (+http://www.google.com/bot.html)")
+      @request = build_request(user_agent: "Googlebot/2.1 (+http://www.google.com/bot.html)")
     end
 
     describe "ab_test" do
@@ -768,7 +768,7 @@ describe Split::Helper do
   describe "when ip address is ignored" do
     context "individually" do
       before(:each) do
-        @request = OpenStruct.new(ip: "81.19.48.130")
+        @request = build_request(ip: "81.19.48.130")
         Split.configure do |c|
           c.ignore_ip_addresses << "81.19.48.130"
         end
@@ -779,7 +779,7 @@ describe Split::Helper do
 
     context "for a range" do
       before(:each) do
-        @request = OpenStruct.new(ip: "81.19.48.129")
+        @request = build_request(ip: "81.19.48.129")
         Split.configure do |c|
           c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
         end
@@ -790,7 +790,7 @@ describe Split::Helper do
 
     context "using both a range and a specific value" do
       before(:each) do
-        @request = OpenStruct.new(ip: "81.19.48.128")
+        @request = build_request(ip: "81.19.48.128")
         Split.configure do |c|
           c.ignore_ip_addresses << "81.19.48.130"
           c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
@@ -802,7 +802,7 @@ describe Split::Helper do
 
     context "when ignored other address" do
       before do
-        @request = OpenStruct.new(ip: "1.1.1.1")
+        @request = build_request(ip: "1.1.1.1")
         Split.configure do |c|
           c.ignore_ip_addresses << "81.19.48.130"
         end
@@ -819,7 +819,7 @@ describe Split::Helper do
 
   describe "when user is previewing" do
     before(:each) do
-      @request = OpenStruct.new(headers: { "x-purpose" => "preview" })
+      @request = build_request(headers: { "x-purpose" => "preview" })
     end
 
     it_behaves_like "a disabled test"

data/spec/persistence/cookie_adapter_spec.rb

@@ -67,14 +67,14 @@ 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} [A-Z]{3}\Z/)
+      expect(Array(context.response.headers["Set-Cookie"])).to include(/\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
       context.response.set_cookie "dummy", "wow"
       subject["foo"] = "FOO"
-      expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
-      expect(context.response.headers["Set-Cookie"]).to include("split=")
+      expect(Array(context.response.headers["Set-Cookie"])).to include(/dummy=wow/)
+      expect(Array(context.response.headers["Set-Cookie"])).to include(/split=/)
     end
   end
 

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ require "simplecov"
 SimpleCov.start
 
 require "split"
-require "ostruct"
 require "yaml"
 require "pry"
 
@@ -44,11 +43,24 @@ def params
   @params ||= {}
 end
 
-def request(ua = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27")
-  @request ||= begin
-    r = OpenStruct.new
-    r.user_agent = ua
-    r.ip = "192.168.1.1"
-    r
-  end
+def request
+  @request ||= build_request
+end
+
+DummyRequest = Struct.new(:user_agent, :ip, :params, :cookies, :headers)
+
+def build_request(
+  user_agent: "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27",
+  ip: "192.168.1.1",
+  params: {},
+  cookies: {},
+  headers: {}
+)
+  r = DummyRequest.new
+  r.user_agent = user_agent
+  r.ip = ip
+  r.params = params
+  r.cookies = cookies
+  r.headers = headers
+  r
 end

data/split.gemspec

@@ -20,10 +20,11 @@ Gem::Specification.new do |s|
     "source_code_uri" => "https://github.com/splitrb/split",
     "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"
+    "mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby",
+    "funding_uri" => "https://opencollective.com/split"
   }
 
-  s.required_ruby_version = ">= 2.5.0"
+  s.required_ruby_version = ">= 2.7.0"
   s.required_rubygems_version = ">= 2.0.0"
 
   s.files         = `git ls-files`.split("\n")
@@ -34,6 +35,8 @@ Gem::Specification.new do |s|
   s.add_dependency "sinatra",         ">= 1.2.6"
   s.add_dependency "rubystats",       ">= 0.3.0"
   s.add_dependency "matrix"
+  s.add_dependency "bigdecimal"
+  s.add_dependency "cgi"
 
   s.add_development_dependency "bundler",     ">= 1.17"
   s.add_development_dependency "simplecov",   "~> 0.15"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.5
 platform: ruby
 authors:
 - Andrew Nesbitt
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,6 +65,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +191,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
 email:
 - andrewnez@gmail.com
 executables: []
@@ -189,10 +215,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/5.2.gemfile
-- gemfiles/6.0.gemfile
-- gemfiles/6.1.gemfile
-- gemfiles/7.0.gemfile
 - lib/split.rb
 - lib/split/algorithms.rb
 - lib/split/algorithms/block_randomization.rb
@@ -274,7 +296,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: 
+  funding_uri: https://opencollective.com/split
 rdoc_options: []
 require_paths:
 - lib
@@ -282,15 +304,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Rack based split testing framework
 test_files:

data/gemfiles/5.2.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rubocop", require: false
-gem "codeclimate-test-reporter"
-gem "rails", "~> 5.2"
-
-gemspec path: "../"

data/gemfiles/6.0.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rubocop", require: false
-gem "codeclimate-test-reporter"
-gem "rails", "~> 6.0"
-
-gemspec path: "../"

data/gemfiles/6.1.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rubocop", require: false
-gem "codeclimate-test-reporter"
-gem "rails", "~> 6.1"
-
-gemspec path: "../"

data/gemfiles/7.0.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem "rubocop", require: false
-gem "codeclimate-test-reporter"
-gem "rails", "~> 7.0"
-
-gemspec path: "../"