Fall back to Rack::Utils for rails<8.0

Author: seanpdoyle

lib/active_resource/formats/url_encoded_format.rb

@@ -1,17 +1,30 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/array/wrap"
+require "active_resource/formats/url_encoded_format/query_parser"
 
 module ActiveResource
   module Formats
     module UrlEncodedFormat
-      extend self
+      extend self, ActiveSupport::Autoload
 
-      # An object that responds to +#from_pairs+ that transforms an Array of
-      # name value pairs into a params Hash.
-      #
-      #  Defaults to calling Array#to_h when ActionDispatch::ParamBuilder is unavailable.
-      mattr_accessor :param_builder, default: self
+      autoload :ActionDispatchQueryParser
+      autoload :QueryParser
+      autoload :RackQueryParser
+
+      # An object that responds to +#parse_nested_query+ to transforms a query
+      # string into a params Hash.
+      attr_reader :query_parser
+
+      def query_parser=(name)
+        @query_parser =
+          case name
+          when nil, :active_resource then QueryParser
+          when :rack then RackQueryParser
+          when :action_dispatch then ActionDispatchQueryParser
+          else name
+          end
+      end
+      self.query_parser = QueryParser
 
       def mime_type
         "application/x-www-form-urlencoded"
@@ -24,12 +37,9 @@ def encode(params, options = nil)
 
       # URL decode the query string
       def decode(query, remove_root = true)
-        query = URI.decode_www_form(query) if query.is_a?(String)
-        param_builder.from_pairs(query)
-      end
-
-      def from_pairs(array) # :nodoc:
-        array.to_h
+        return query if query.is_a?(Hash)
+        query = URI.encode_www_form(query) if query.is_a?(Array)
+        query_parser.parse_nested_query(query)
       end
     end
   end

lib/active_resource/formats/url_encoded_format/action_dispatch_query_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "action_dispatch/http/param_builder"
+
+module ActiveResource
+  module Formats
+    module UrlEncodedFormat
+      module ActionDispatchQueryParser
+        extend self
+
+        def parse_nested_query(query)
+          ActionDispatch::ParamBuilder.from_query_string(query)
+        end
+      end
+    end
+  end
+end

lib/active_resource/formats/url_encoded_format/query_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveResource
+  module Formats
+    module UrlEncodedFormat
+      module QueryParser
+        extend self
+
+        def parse_nested_query(query)
+          query = URI.decode_www_form(query) if query.is_a?(String)
+
+          query.to_h
+        end
+      end
+    end
+  end
+end

lib/active_resource/formats/url_encoded_format/rack_query_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rack/utils"
+
+module ActiveResource
+  module Formats
+    module UrlEncodedFormat
+      module RackQueryParser
+        extend self
+
+        def parse_nested_query(query)
+          Rack::Utils.parse_nested_query(query)
+        end
+      end
+    end
+  end
+end

lib/active_resource/railtie.rb

@@ -34,11 +34,13 @@ class Railtie < Rails::Railtie
       ActiveSupport.on_load(:active_resource) { self.logger ||= ::Rails.logger }
     end
 
-    initializer "active_resource.url_encoded_form_format" do
+    initializer "active_resource.url_encoded_format" do
       ActiveSupport.on_load(:action_controller) do
-        require "action_dispatch/http/param_builder"
-
-        ActiveResource::Formats[:url_encoded_form].param_builder = ActionDispatch::ParamBuilder
+        if ActionPack::VERSION::MAJOR >= 8
+          Formats::UrlEncodedFormat.query_parser = :action_dispatch
+        else
+          Formats::UrlEncodedFormat.query_parser = :rack
+        end
       end
     end
 

test/cases/finder_test.rb

@@ -8,7 +8,6 @@
 require "fixtures/proxy"
 require "fixtures/pet"
 require "active_support/core_ext/hash/conversions"
-require "action_dispatch/http/param_builder"
 
 module CamelcaseUrlEncodedFormat
   extend ActiveResource::Formats::UrlEncodedFormat
@@ -189,8 +188,8 @@ def test_where_clause_string
   end
 
   def test_where_clause_string_with_multiple_params
-    previous_param_builder = ActiveResource::Formats::UrlEncodedFormat.param_builder
-    ActiveResource::Formats::UrlEncodedFormat.param_builder = ActionDispatch::ParamBuilder
+    previous_query_parser = ActiveResource::Formats::UrlEncodedFormat.query_parser
+    ActiveResource::Formats::UrlEncodedFormat.query_parser = :rack
 
     query = URI.encode_www_form([ [ "id[]", "1" ], [ "id[]", "2" ] ])
     ActiveResource::HttpMock.respond_to { |m| m.get "/people.json?" + query, {}, @people }
@@ -200,7 +199,7 @@ def test_where_clause_string_with_multiple_params
     assert_kind_of Person, people.second
     assert_equal [ "Matz", "David" ], people.map(&:name)
   ensure
-    ActiveResource::Formats::UrlEncodedFormat.param_builder = previous_param_builder
+    ActiveResource::Formats::UrlEncodedFormat.query_parser = previous_query_parser
   end
 
   def test_where_clause_array
@@ -213,8 +212,8 @@ def test_where_clause_array
   end
 
   def test_where_clause_with_multiple_params
-    previous_param_builder = ActiveResource::Formats::UrlEncodedFormat.param_builder
-    ActiveResource::Formats::UrlEncodedFormat.param_builder = ActionDispatch::ParamBuilder
+    previous_query_parser = ActiveResource::Formats::UrlEncodedFormat.query_parser
+    ActiveResource::Formats::UrlEncodedFormat.query_parser = :rack
 
     ids = [ [ "id[]", "1" ], [ "id[]", "2" ] ]
     ActiveResource::HttpMock.respond_to { |m| m.get "/people.json?" + URI.encode_www_form(ids), {}, @people }
@@ -224,7 +223,7 @@ def test_where_clause_with_multiple_params
     assert_kind_of Person, people.second
     assert_equal [ "Matz", "David" ], people.map(&:name)
   ensure
-    ActiveResource::Formats::UrlEncodedFormat.param_builder = previous_param_builder
+    ActiveResource::Formats::UrlEncodedFormat.query_parser = previous_query_parser
   end
 
   def test_where_with_clause_in

test/cases/formats/url_encoded_format_test.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require "abstract_unit"
-require "action_dispatch/http/param_builder"
+require "action_dispatch"
 
 class UrlEncodedFormatTest < ActiveSupport::TestCase
+  test "#mime_type returns application/x-www-form-urlencoded" do
+    assert_equal "application/x-www-form-urlencoded", ActiveResource::Formats::UrlEncodedFormat.mime_type
+  end
+
   test "#encode transforms a Hash into an application/x-www-form-urlencoded query string" do
     params = { "a" => 1, "b" => 2, "c" => [ 3, 4 ] }
 
@@ -44,55 +48,93 @@ class UrlEncodedFormatTest < ActiveSupport::TestCase
     assert_equal({ "person[name]" => "Matz" }, decoded)
   end
 
-  test "#decode transforms an application/x-www-form-urlencoded query string with multiple params into a Hash" do
-    format = ActiveResource::Formats::UrlEncodedFormat
-    previous_param_builder = format.param_builder
-    format.param_builder = ActionDispatch::ParamBuilder
+  test "#decode returns a Hash of query string pairs" do
+    decoded = ActiveResource::Formats::UrlEncodedFormat.decode("a" => "1")
 
+    assert_equal({ "a" => "1" }, decoded)
+  end
+end
+
+class UrlEncodedFormatRackQueryParserTest < ActiveSupport::TestCase
+  setup do
+    @previous_query_parser = ActiveResource::Formats::UrlEncodedFormat.query_parser
+    ActiveResource::Formats::UrlEncodedFormat.query_parser = :rack
+  end
+
+  teardown do
+    ActiveResource::Formats::UrlEncodedFormat.query_parser = @previous_query_parser
+  end
+
+  test "#decode transforms an application/x-www-form-urlencoded query string with multiple params into a Hash" do
     query = URI.encode_www_form([ [ "a[]", "1" ], [ "a[]", "2" ] ])
 
-    decoded = format.decode(query)
+    decoded = ActiveResource::Formats::UrlEncodedFormat.decode(query)
 
     assert_equal({ "a" => [ "1", "2" ] }, decoded)
-  ensure
-    format.param_builder = previous_param_builder
   end
 
   test "#decode transforms an Array of query string pairs with multiple params into a Hash" do
-    format = ActiveResource::Formats::UrlEncodedFormat
-    previous_param_builder = format.param_builder
-    format.param_builder = ActionDispatch::ParamBuilder
-
     pairs = [ [ "a[]", "1" ], [ "a[]", "2" ] ]
 
-    decoded = format.decode(pairs)
+    decoded = ActiveResource::Formats::UrlEncodedFormat.decode(pairs)
 
     assert_equal({ "a" => [ "1", "2" ] }, decoded)
-  ensure
-    format.param_builder = previous_param_builder
   end
 
-  test "#decode transforms an Array of nested query string pairs into a Hash using ActionDispatch::ParamBuilder" do
-    format = ActiveResource::Formats::UrlEncodedFormat
-    previous_param_builder = format.param_builder
-    format.param_builder = ActionDispatch::ParamBuilder
-
+  test "#decode transforms an Array of nested query string pairs into a Hash" do
     pairs = [ [ "person[name]", "Matz" ] ]
 
-    decoded = format.decode(pairs)
+    decoded = ActiveResource::Formats::UrlEncodedFormat.decode(pairs)
 
     assert_equal({ "person" => { "name" => "Matz" } }, decoded)
-  ensure
-    format.param_builder = previous_param_builder
   end
 
   test "#decode returns a Hash of query string pairs" do
     decoded = ActiveResource::Formats::UrlEncodedFormat.decode("a" => "1")
 
     assert_equal({ "a" => "1" }, decoded)
   end
+end
 
-  test "#mime_type returns application/x-www-form-urlencoded" do
-    assert_equal "application/x-www-form-urlencoded", ActiveResource::Formats::UrlEncodedFormat.mime_type
+if ActionPack::VERSION::MAJOR >= 8
+  class UrlEncodedFormatActionDispatchQueryParserTest < ActiveSupport::TestCase
+    setup do
+      @previous_query_parser = ActiveResource::Formats::UrlEncodedFormat.query_parser
+      ActiveResource::Formats::UrlEncodedFormat.query_parser = :action_dispatch
+    end
+
+    teardown do
+      ActiveResource::Formats::UrlEncodedFormat.query_parser = @previous_query_parser
+    end
+
+    test "#decode transforms an application/x-www-form-urlencoded query string with multiple params into a Hash" do
+      query = URI.encode_www_form([ [ "a[]", "1" ], [ "a[]", "2" ] ])
+
+      decoded = ActiveResource::Formats::UrlEncodedFormat.decode(query)
+
+      assert_equal({ "a" => [ "1", "2" ] }, decoded)
+    end
+
+    test "#decode transforms an Array of query string pairs with multiple params into a Hash" do
+      pairs = [ [ "a[]", "1" ], [ "a[]", "2" ] ]
+
+      decoded = ActiveResource::Formats::UrlEncodedFormat.decode(pairs)
+
+      assert_equal({ "a" => [ "1", "2" ] }, decoded)
+    end
+
+    test "#decode transforms an Array of nested query string pairs into a Hash" do
+      pairs = [ [ "person[name]", "Matz" ] ]
+
+      decoded = ActiveResource::Formats::UrlEncodedFormat.decode(pairs)
+
+      assert_equal({ "person" => { "name" => "Matz" } }, decoded)
+    end
+
+    test "#decode returns a Hash of query string pairs" do
+      decoded = ActiveResource::Formats::UrlEncodedFormat.decode("a" => "1")
+
+      assert_equal({ "a" => "1" }, decoded)
+    end
   end
 end