active_admin_filter_extensions 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0443509d93e7b99ed2bc83008c9e5fffe5549792149739800b4f333c33a0636e'
-  data.tar.gz: c656901ee3a0f18e865e9653d34661a6eca3be4bc4dd0cb551c1521cf7f30bd9
+  metadata.gz: d830dd4ae0f8db4ee8e74080ea33d93071aaafc4a7ad30b0b7b5ab67da1ceeca
+  data.tar.gz: da0e3e34de9845286118c35f11078230e6add9693f62bd37b63745d1ac6c7cb3
 SHA512:
-  metadata.gz: 25d494262038dafecea4a3fecba7f7b71f718338392d434b74645f8ca3e9fb81682653a84f383b4ed294530fbc90f5b73086d942a318526dae92d8c8e09f2347
-  data.tar.gz: 3a0ab0e4b77ce5465ccfec957a767fce7ef67a51e166270adae9fb70f3e8cc7671634b7b25710816d7b0dc18b3c18b23f3776fc27bb9b67c1b78236efc13eccc
+  metadata.gz: 42761e0adb059a3e53670ce31ed273de6eabfccef2f4339236022e74008229bcc2e8964a4545cd0f54ab20d0b48c6619904938a7d47e7bac114e34c6e2642819
+  data.tar.gz: '02581ca6ab8af05d3a5c1aa8e483aef78ae21085432d957609d179efc9c7afe48b8c5f05230c9003acbbfb057a7eab505896174a42fd2442b0af8c45ff28f286'

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
 

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/policies.rb

@@ -232,10 +232,29 @@ module ActiveAdminFilterExtensions
 
       # The filter's own predicate dropdown submits _gt/_lt/_not_eq and friends beside the
       # derived head key; a value policy guarding only the head leaves the same column one
-      # dropdown click from unpoliced. Siblings = request keys naming the same attribute.
+      # dropdown click from unpoliced. Siblings = request keys naming the same attribute,
+      # minus the predicates answered by a boolean rather than by a value of the attribute's
+      # own type: `?q[customer_id_null]=true` carries "true", which `sanitize: :digits`
+      # empties and `validate: :integer` refuses - the reset would then drop a condition a
+      # drill-down link spelled out. A boolean predicate the filter declares itself stays
+      # policed: that one its author asked for.
       def sibling_predicate_keys(q, keys)
         bases = keys.map { |key| strip_ransack_predicate(key) }
-        q.keys.select { |key| bases.include?(strip_ransack_predicate(key)) }
+        declared = keys.map(&:to_s)
+        q.keys.select do |key|
+          next false unless bases.include?(strip_ransack_predicate(key))
+
+          declared.include?(key.to_s) || !boolean_predicate?(key)
+        end
+      end
+
+      def boolean_predicate?(name)
+        # Without Ransack there is nothing to ask - and nothing is stripped either, so a
+        # sibling can only be the declared key itself.
+        return false unless defined?(::Ransack::Predicate)
+
+        predicate = ::Ransack::Predicate.detect_from_string(name.to_s)
+        predicate && ::Ransack::Predicate.named(predicate)&.type == :boolean
       end
 
       def strip_ransack_predicate(name)

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.0"
+  VERSION = "1.1.0"
 end

data/lib/active_admin_filter_extensions.rb

@@ -17,6 +17,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

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/integration/numeric_builtins_spec.rb

@@ -78,6 +78,19 @@ RSpec.describe "built-in numeric policies", type: :feature do
       expect(page).to have_no_content("drop me")
     end
 
+    it "leaves a boolean predicate of the same attribute to Ransack" do
+      # `?q[position_null]=true` is answered by "true", not by a value of the column's own
+      # type: the digits sanitizer would empty it and the integer validator refuse it, and the
+      # reset would drop a condition the admin's own drill-down link spelled out.
+      Post.create!(title: "no position", body: "no position body", status: "draft")
+
+      visit "/admin/integer_posts?q%5Bposition_null%5D=true"
+
+      expect(query_of(page.current_url)["q"]).to eq("position_null" => "true")
+      expect(page).to have_content("no position")
+      expect(page).to have_no_content("keep me")
+    end
+
     it "sanitizes a sibling predicate too" do
       visit "/admin/integer_posts?q%5Bposition_lt%5D=2%200a"
 

metadata

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