filterameter 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abb0f5a22c735d69e3e44625f0fd4a0cd451f35499677f4f0d51d5a7aff8ea3a
-  data.tar.gz: 359eefe9c128bd46651e475e6fc1620d145c68478429e8d49ab3d601fa95f2bb
+  metadata.gz: f62d4fc49f10adca7c1fec20fb17e430740035d69b154f973d8f300405f64f9c
+  data.tar.gz: 7369430dbb71a29faf17853a35eaa69f3a35fae52b82d63e85f5c14bd550aa51
 SHA512:
-  metadata.gz: 3b11d1b2281e340ecc32ea75e37c857f888cce526fda98b4c2d96a5bbfd8a7ba0f2cbd901480c10eb8b6fc4ca4d48080e43f79f66e7bdb879819d407c896b237
-  data.tar.gz: 285384ed0b9506937406aa0d83744b99239666a4d84b7b0d6893bc1351ac26e227eb37cd1d9baa2c3e7be720fea36a9acc1a7b7d3979006fd8be0eaaa72dd21b
+  metadata.gz: e5ee234ae90460282e2618135b96f91882af00361b1c16eda99beb42640cf9c4186d1bb61fa1989235015a1f4dff07f7611ca5dea55ec6277c27dc9239329bc8
+  data.tar.gz: 6f802f89428a06de2f077d5c4b38464bc8ad1ee4327d334856f3421481cba3af84ef789cb2e85863fe933f8b45f90fe2b7640910d16618bb97e35c65d9bda691

data/README.md

@@ -200,6 +200,7 @@ Rails conventions are used to determine the controller's model. For example, the
 filter_model 'Picture'
 ```
 
+_Important:_ If the `filter_model` declaration is used, it must be before any filter or sort declarations.
 
 ### Building the Query
 
@@ -299,25 +300,48 @@ For example, the following sorts by size descending:
 
 `/widgets?filter[sort]=-size`
 
+### Configuration
 
-#### Override the Filter Key
+There are three configuration options:
 
-To change the source of the query parameters, override the `filter_parameters` method. Here is another way to provide a default filter:
+- action_on_undeclared_parameters
+- action_on_validation_failure
+- filter_key
 
-```ruby
-def filter_parameters
-  super.with_defaults(active: true)
-end
-```
+The configuration options can be set in an initializer, an environment file, or in `application.rb`. 
+
+The options can be set directly...
 
-This also provides an easy way to nest the criteria under a key other than `filter`:
+`Filterameter.configuration.action_on_undeclared_parameters = :log`
+
+...or the configuration can be yielded:
 
 ```ruby
-def filter_parameters
-  params.to_unsafe_h.fetch(:criteria, {})
+Filterameter.configure do |config|
+  config.action_on_undeclared_parameters = :log
+  config.action_on_validation_failuer = :log
+  config.filter_key = :f
 end
 ```
 
+#### Action On Undeclared Parameters
+
+Occurs when the filter parameter contains any keys that are not defined. Valid actions are `:log`, `:raise`, and `false` (do not take action). By default, development will log, test will raise, and production will do nothing.
+
+#### Action on Validation Failure
+
+Occurs when a filter parameter fails a validation. Valid actions are `:log`, `:raise`, and `false` (do not take action). By default, development will log, test will raise, and production will do nothing.
+
+#### Filter Key
+
+By default, the filter parameters are nested under the key `:filter`. Use this setting to override the key.
+
+If the filter parameters are NOT nested, set this to false. Doing so will restrict the filter parameters to only
+those that have been declared, meaning undeclared parameters are ignored (and the action_on_undeclared_parameters
+configuration option does not come into play).
+
+
+
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/filterameter/configuration.rb

@@ -6,16 +6,27 @@ module Filterameter
   # Class Configuration stores the following settings:
   # - action_on_undeclared_parameters
   # - action_on_validation_failure
+  # - filter_key
   #
   # == Action on Undeclared Parameters
+  #
   # Occurs when the filter parameter contains any keys that are not defined. Valid actions are :log, :raise, and
   # false (do not take action). By default, development will log, test will raise, and production will do nothing.
   #
   # == Action on Validation Failure
+  #
   # Occurs when a filter parameter fails a validation. Valid actions are :log, :raise, and false (do not take action).
   # By default, development will log, test will raise, and production will do nothing.
+  #
+  # == Filter Key
+  #
+  # By default, the filter parameters are nested under the key :filter. Use this setting to override the key.
+  #
+  # If the filter parameters are NOT nested, set this to false. Doing so will restrict the filter parameters to only
+  # those that have been declared, meaning undeclared parameters are ignored (and the action_on_undeclared_parameters
+  # configuration option does not come into play).
   class Configuration
-    attr_accessor :action_on_undeclared_parameters, :action_on_validation_failure
+    attr_accessor :action_on_undeclared_parameters, :action_on_validation_failure, :filter_key
 
     def initialize
       @action_on_undeclared_parameters =
@@ -27,6 +38,8 @@ module Filterameter
           else
             false
           end
+
+      @filter_key = :filter
     end
   end
 end

data/lib/filterameter/declarative_filters.rb

@@ -29,7 +29,13 @@ module Filterameter
     end
 
     def filter_parameters
-      params.to_unsafe_h.fetch(:filter, {})
+      filter_key = Filterameter.configuration.filter_key
+
+      if filter_key
+        params.to_unsafe_h.fetch(filter_key, {})
+      else
+        params.to_unsafe_h.slice(*self.class.filter_coordinator.filter_parameter_names, :sort)
+      end
     end
 
     private

data/lib/filterameter/filter_coordinator.rb

@@ -19,7 +19,7 @@ module Filterameter
   class FilterCoordinator
     attr_writer :query_variable_name
 
-    delegate :add_filter, :add_sort, to: :registry
+    delegate :add_filter, :add_sort, :filter_parameter_names, to: :registry
     delegate :build_query, to: :query_builder
 
     def initialize(controller_name, controller_path)

data/lib/filterameter/log_subscriber.rb

@@ -14,8 +14,8 @@ module Filterameter
 
     def undeclared_parameters(event)
       debug do
-        keys = event.payload[:keys]
-        "  Undeclared filter parameter#{'s' if keys.size > 1}: #{keys.map { |e| ":#{e}" }.join(', ')}"
+        key = event.payload[:key]
+        "  Undeclared filter parameter: #{key}"
       end
     end
   end

data/lib/filterameter/registries/filter_registry.rb

@@ -24,6 +24,10 @@ module Filterameter
         @declarations.values
       end
 
+      def filter_parameter_names
+        @declarations.keys
+      end
+
       private
 
       # if range is enabled, then in addition to the attribute filter this also adds min and/or max filters

data/lib/filterameter/registries/registry.rb

@@ -6,7 +6,7 @@ module Filterameter
     #
     # Class Registry records declarations and allows resulting filters and sorts to be fetched from sub-registries.
     class Registry
-      delegate :filter_declarations, :ranges, to: :@filter_registry
+      delegate :filter_declarations, :filter_parameter_names, :ranges, to: :@filter_registry
 
       def initialize(model_class)
         @filter_registry = Filterameter::Registries::FilterRegistry.new(Filterameter::FilterFactory.new(model_class))

data/lib/filterameter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Filterameter
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterameter
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Todd Kummer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails