active_admin_filter_extensions 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51bc6cafe8895502a79f648a96f6c7e4f28fbb9c3a985eac07c43aa7d86e320f
-  data.tar.gz: 37c3a1beef3da668ac558dc7364b076f8212d980f9efce5da8110213fac3aa22
+  metadata.gz: d0c78b8910b00dd6300b7b3eebb5e5538eb534df7bb4ae2f37e206ed7c7e0a9b
+  data.tar.gz: 39b6b4f970c13cf26b71837b73463e9b1d13468eb2c6150deb4513759ddad7a6
 SHA512:
-  metadata.gz: a4fbb0cfa85464dbee996d124f7fa47120bd618e04a2fe645683b8a32593107921d0eda74ad39cbb8bb3898e23c4816ae9453c13b25e7eb52dfd31740def0535
-  data.tar.gz: d81c7d2722af7494ab5ff73255ea76818ed826d8196b9f04e9b5c94417ac1d29bbc24696311124b80394ab29826e26f58150a5a49f74235d18edb55b65b5a626
+  metadata.gz: a7854f6af602da404309b0734e83ab47b1d60df0a7ed7667abecc4525efb5e0b1d70f9f459bf43a30179e3823bf5621efab8ae969494cec12ffe9830d8214904
+  data.tar.gz: a5681dbf451ed707c92c6ce2be45cba12e4f7aaa81854eed31b783fc4335aa65720c26f7e6f83ef67a7d9638a93034bd8a2e20172efb37c9492986bb7464d167

data/README.md

@@ -170,7 +170,17 @@ end
 ```
 
 The message is flashed only when the defaults actually took effect. Pass `flash_key:` to use
-something other than `:notice`.
+something other than `:notice`, or move the default for the whole application once:
+
+```ruby
+# config/initializers/active_admin_filter_extensions.rb
+ActiveAdminFilterExtensions.notice_flash_key = :filters_notice
+```
+
+Worth doing where the layout renders its own key for "why this page is cut down": Active Admin
+writes action results to `:notice`, and on a shared key the arriving message wins, so a batch
+action's result would silence the notice. The key is read when the notice is written and
+`flash_key:` on the resource still beats it.
 
 ## Required filters: the mandatory window
 
@@ -348,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/notice.rb

@@ -12,7 +12,12 @@ module ActiveAdminFilterExtensions
   # message is only flashed when the defaults actually took effect, so it stays quiet once the
   # admin has filtered for themselves.
   module Notice
-    def default_filters_notice(message, flash_key: :notice)
+    # The key this resource's notice goes under: what it declared, else the app-wide default.
+    def self.flash_key_for(config)
+      config.default_filters_notice_flash_key || ActiveAdminFilterExtensions.notice_flash_key
+    end
+
+    def default_filters_notice(message, flash_key: nil)
       # Declared on the resource rather than closed over, so that the redirect - which answers
       # the request the notice belongs on with a 302 - can find it and carry it across.
       config.default_filters_notice = message
@@ -27,7 +32,8 @@ module ActiveAdminFilterExtensions
         # default slice - the notice on top of it would be noise.
         next if filter_policy_errors.present?
 
-        flash.now[flash_key] = ::MethodOrProcHelper.render_in_context(self, message)
+        flash.now[Notice.flash_key_for(active_admin_config)] =
+          ::MethodOrProcHelper.render_in_context(self, message)
       end
     end
   end

data/lib/active_admin_filter_extensions/redirect.rb

@@ -71,7 +71,7 @@ module ActiveAdminFilterExtensions
            filter_policy_errors.empty? && filter_defaults_engaged?
           # On a shared key - the default is :notice, the same key a batch action writes - the
           # arriving message wins: it names what just happened, the notice can wait.
-          key = active_admin_config.default_filters_notice_flash_key
+          key = Notice.flash_key_for(active_admin_config)
           flash[key] = ::MethodOrProcHelper.render_in_context(self, message) if flash[key].blank?
         end
 

data/lib/active_admin_filter_extensions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveAdminFilterExtensions
-  VERSION = "1.0.1"
+  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
@@ -17,6 +18,21 @@ require "active_admin_filter_extensions/policies"
 require "active_admin_filter_extensions/notice"
 
 module ActiveAdminFilterExtensions
+  class << self
+    # Where a filters notice goes when the resource does not say. Active Admin writes action
+    # results to :notice, and an app whose layout renders its own key for "why this page is
+    # cut down" would otherwise repeat `flash_key:` on every index that declares a notice:
+    #
+    #   ActiveAdminFilterExtensions.notice_flash_key = :notice_message
+    #
+    # Read when the notice is written, not when the resource is registered, so initializer
+    # order does not decide it.
+    attr_writer :notice_flash_key
+
+    def notice_flash_key
+      @notice_flash_key ||= :notice
+    end
+  end
 end
 
 # `add_filter` stores whatever options it is given without a whitelist, so `default:` needs no
@@ -30,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/integration/filter_defaults_spec.rb

@@ -191,6 +191,33 @@ RSpec.describe "Filter default values", type: :feature do
 
       expect(page).to have_no_content("Showing published posts by default")
     end
+
+    describe "the app-wide key" do
+      # Deliberately a key no resource declares, so an example cannot pass by coincidence:
+      # NoticePost's own key is :filters_notice.
+      around do |example|
+        previous = ActiveAdminFilterExtensions.notice_flash_key
+        ActiveAdminFilterExtensions.notice_flash_key = :app_wide_notice
+        example.run
+        ActiveAdminFilterExtensions.notice_flash_key = previous
+      end
+
+      it "takes a notice that named no key of its own" do
+        # The resource says only the message; the app said where its notices go. Asserted on
+        # the rendered flash class, which is what the layout keys off.
+        visit "/admin/colliding_notice_posts"
+
+        expect(page).to have_css(".flash_app_wide_notice", text: "Showing published posts by default")
+        expect(page).to have_no_css(".flash_notice")
+      end
+
+      it "loses to the key the resource declared" do
+        visit "/admin/notice_posts"
+
+        expect(page).to have_css(".flash_filters_notice", text: "Showing published posts by default")
+        expect(page).to have_no_css(".flash_app_wide_notice")
+      end
+    end
   end
 
   describe "requests that carry no q of their own" do

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.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Igor Fedoronchuk