active_admin_filter_extensions 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d830dd4ae0f8db4ee8e74080ea33d93071aaafc4a7ad30b0b7b5ab67da1ceeca
-  data.tar.gz: da0e3e34de9845286118c35f11078230e6add9693f62bd37b63745d1ac6c7cb3
+  metadata.gz: d0c78b8910b00dd6300b7b3eebb5e5538eb534df7bb4ae2f37e206ed7c7e0a9b
+  data.tar.gz: 39b6b4f970c13cf26b71837b73463e9b1d13468eb2c6150deb4513759ddad7a6
 SHA512:
-  metadata.gz: 42761e0adb059a3e53670ce31ed273de6eabfccef2f4339236022e74008229bcc2e8964a4545cd0f54ab20d0b48c6619904938a7d47e7bac114e34c6e2642819
-  data.tar.gz: '02581ca6ab8af05d3a5c1aa8e483aef78ae21085432d957609d179efc9c7afe48b8c5f05230c9003acbbfb057a7eab505896174a42fd2442b0af8c45ff28f286'
+  metadata.gz: a7854f6af602da404309b0734e83ab47b1d60df0a7ed7667abecc4525efb5e0b1d70f9f459bf43a30179e3823bf5621efab8ae969494cec12ffe9830d8214904
+  data.tar.gz: a5681dbf451ed707c92c6ce2be45cba12e4f7aaa81854eed31b783fc4335aa65720c26f7e6f83ef67a7d9638a93034bd8a2e20172efb37c9492986bb7464d167

data/README.md

@@ -358,7 +358,10 @@ Four prints in small type:
   never a condition and is never touched.
 * **Anything that reads `params[:q]` for the effective filters** (drill-down links, exports)
   should read `filtering_params` instead - on the rendered page they agree, but only
-  `filtering_params` is also right on the non-redirected formats.
+  `filtering_params` is also right on the non-redirected formats. A page that translates those
+  values before passing them on - renaming a key an input suffixed, turning a sentinel into
+  another predicate - wants `applied_filter_params`: the same values as an indifferent copy,
+  safe to read by symbol and to mutate. Both are helpers, so a view can call them too.
 
 Tested against Active Admin 3.5 on Rails 8.0 and 8.1, under Ruby 3.3, 3.4 and 4.0.
 

data/lib/active_admin_filter_extensions/filter_defaults.rb

@@ -28,7 +28,7 @@ module ActiveAdminFilterExtensions
     # #filter_defaults_apply? which lets defaults through on a partly filtered request keeps
     # the values that were actually asked for.
     #
-    # @return [Hash, ActionController::Parameters] values passed to Ransack
+    # @return [Hash] values passed to Ransack
     def filtering_params
       requested = requested_filtering_params
       # Materialized on every path: computing it is also what validates, loudly, that every
@@ -56,6 +56,20 @@ module ActiveAdminFilterExtensions
       defaults.merge(requested || {})
     end
 
+    # The same values, as an indifferent deep copy: readable by symbol and safe to mutate. A page
+    # that builds its own collection or its own links usually has to translate those values
+    # into whatever it talks to - renaming a key an input suffixed, turning a sentinel into a
+    # different predicate - and must not do that to the Hash #filtering_params itself returns,
+    # which is also what fills the filters form and decides the canonicalizing redirect.
+    #
+    # @return [ActiveSupport::HashWithIndifferentAccess]
+    def applied_filter_params
+      # deep_dup, not just with_indifferent_access: that copies the containers but keeps the
+      # value objects, so a `gsub!` or `replace` on a String value would reach back into the
+      # request's own and change what the next #filtering_params answers.
+      filtering_params.deep_dup.with_indifferent_access
+    end
+
     def complete_with_groups(defaults)
       with_groups.each do |keys|
         next unless keys.any? { |key| defaults.key?(key) }

data/lib/active_admin_filter_extensions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveAdminFilterExtensions
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/active_admin_filter_extensions.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "activeadmin"
+require "active_support/core_ext/object/deep_dup"
 require "active_admin_filter_extensions/version"
 
 # The violation messages live in plain i18n - config/locales/en.yml here, overridable by the
@@ -45,7 +46,8 @@ ActiveAdmin.before_load do |_app|
   ActiveAdmin::ResourceController.include ActiveAdminFilterExtensions::SearchKeys
   ActiveAdmin::ResourceController.include ActiveAdminFilterExtensions::RequiredFilters
   ActiveAdmin::ResourceController.include ActiveAdminFilterExtensions::FilterDefaults
-  ActiveAdmin::ResourceController.helper_method :filtering_params, :filter_default_values, :visible_filters
+  ActiveAdmin::ResourceController.helper_method :filtering_params, :applied_filter_params,
+                                                :filter_default_values, :visible_filters
 
   ActiveAdmin::Resource.prepend ActiveAdminFilterExtensions::ResourceExtension
   ActiveAdmin::ResourceDSL.include ActiveAdminFilterExtensions::Policies::ResourcePolicyDSL

data/spec/data_access_spec.rb

@@ -53,6 +53,36 @@ RSpec.describe ActiveAdminFilterExtensions::DataAccess do
     end
   end
 
+  describe "#applied_filter_params" do
+    let(:filters) { { position_eq: { extensions: { default: "20" } } } }
+
+    it "reads by symbol what the request spelled as a String" do
+      expect(controller.send(:applied_filter_params)[:position_eq]).to eq("20")
+    end
+
+    it "hands out a copy, so a caller translating the values cannot rewrite the search" do
+      applied = controller.send(:applied_filter_params)
+      applied[:position_gt] = applied.delete(:position_eq)
+
+      expect(controller.send(:filtering_params)).to eq("position_eq" => "20")
+      expect(searched_with).to eq("position_eq" => "20")
+    end
+
+    context "when the request carries a value of its own" do
+      let(:filters) { { title_cont: {} } }
+      # Mutable on purpose: with_indifferent_access alone copies the Hash but hands out this
+      # very String, so editing it in place would reach back into the request.
+      let(:params) { { q: { "title_cont" => String.new("hello") } } }
+
+      it "copies the values too, so editing one in place cannot reach the request" do
+        controller.send(:applied_filter_params)[:title_cont].replace("bye")
+
+        expect(controller.send(:filtering_params)).to eq("title_cont" => "hello")
+        expect(searched_with).to eq("title_cont" => "hello")
+      end
+    end
+  end
+
   describe "a Hash default" do
     let(:filters) { { created_at: { as: :date_range, extensions: { default: { gteq: "2020-01-01" } } } } }
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/deep_dup"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/hash_with_indifferent_access"
 # Pure Ruby, no Active Admin boot required - `visible_filters` resolves `:if` / `:unless` with it.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_filter_extensions
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Igor Fedoronchuk