split 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746dd3b526b5464f12e01e2f00f8ff62b71ac6483527632f6f0bca7bc5242e8c
-  data.tar.gz: bb40ca355a1aa9eec9cfb4067e6e2b3c381072830cffadffe414f8d7a4af043f
+  metadata.gz: 80d095f07432d336e773b30c3c5a873b554dd682f65ace33886d1a83697d447a
+  data.tar.gz: 9a504a3c9d4c67391528e1640c2c7eac3cfcafe91305cadb901e48541726f04c
 SHA512:
-  metadata.gz: 70466ddfe57955a43dda0506c4a23806f6bdab154b344e495879027ae2baebec93d59f34018e78a3e83ef945c776c7a2ddcf2b40cd71998fb0bc9207ed60df61
-  data.tar.gz: db1d46d7e7e1826aacf80ec1c8634f0502bd07d4b58d488e57f4917a8843954d568b4cd20c9e2db09ac2ff80811b14ec68a3158b870d091eeabf4e426af8172d
+  metadata.gz: 68e5919618103f315fa9f4f0d18384392c02c01c680c13d50a77cfa0507bd19a1c01fb5c1db66619329c1ef38013c3ebe90e880f6af5c9bac9ba2d1a76b3963a
+  data.tar.gz: 1ae5fe0187e16b4bb3efc14a0e0ded4df98527fbc530dab4a89c544d133b1a7e8cd0adc6579f0f43ea3c84aa6899a2d123e97c5af105ce158e804a5ac8286728

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-# 4.0.3 (November 15rd, 2023)
+# 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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Split
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 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/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

@@ -44,11 +44,20 @@ 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
+
+def build_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",
+  ip: "192.168.1.1",
+  params: {},
+  cookies: {}
+)
+  r = OpenStruct.new
+  r.user_agent = ua
+  r.ip = ip
+  r.params = params
+  r.cookies = cookies
+  r
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Andrew Nesbitt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -164,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+description:
 email:
 - andrewnez@gmail.com
 executables: []
@@ -274,7 +274,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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -289,8 +289,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Rack based split testing framework
 test_files: