filterameter 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9666ad7ecd3f4cb352a26a7b8522fdff5a4ed94f9fa26199111659944982d8b1
-  data.tar.gz: 93b5c66bfac1d89d8e77b6e967da5cce8531633029718f8c5484b8688bcef428
+  metadata.gz: 02daf1402e83a27c8b13ed7e548dfe269b7a1e6c7c5085f9aad2220509793253
+  data.tar.gz: 1ddcce714232b71be40272ac3e84f116e38af380928407936a082ade5395c743
 SHA512:
-  metadata.gz: 4daba3e1643f9b6cb5a1c00f81b734bba3e8d10e55038a8bad8ae2e1b74f9172b74870836d8c27d6afb506bb19092c5631ccea70e0feccc44dbe15758d0ca583
-  data.tar.gz: 879d2e0e5bc26f3bd4341bad4c5974f4ef17696418e05e6da8bb1cd5f6c7b8e16bfe835ae78ad08e954c487e3f8164b5b1bf1006a59b7e99cab5e775b0b79026
+  metadata.gz: b33c74905694f9a1682a4c7faefb6e11cbeff81a7c2bae32dd3a39f25393d50a7eb86fc766825f9296c2ce19440aed296eab17bebfd6f1eac77a41aa749dbeeb
+  data.tar.gz: 36f85f875a0c15258988cbbf97062caa75e1e47de1142484eaa96b8bae7f757d5a94e5fd5ac07b2137db7f1d8cb146adb76b3d6aa2849ad3507707e22b87b783

data/README.md

@@ -1,7 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/filterameter.svg)](https://badge.fury.io/rb/filterameter)
 [![RuboCop](https://github.com/RockSolt/filterameter/workflows/RuboCop/badge.svg)](https://github.com/RockSolt/filterameter/actions?query=workflow%3ARuboCop)
 [![RSpec](https://github.com/RockSolt/filterameter/workflows/RSpec/badge.svg)](https://github.com/RockSolt/filterameter/actions?query=workflow%3ARSpec)
-[![Maintainability](https://api.codeclimate.com/v1/badges/d9d87f9ce8020eb6e656/maintainability)](https://codeclimate.com/github/RockSolt/filterameter/maintainability)
 
 # Filterameter
 Filterameter provides declarative filters for Rails controllers to reduce boilerplate code and increase readability. How many times have you seen (or written) this controller action?
@@ -43,6 +42,7 @@ Simplify and speed development of Rails controllers by making filter parameters
     - [Partial](#partial)
     - [Range](#range)
     - [Sortable](#sortable)
+    - [Converters](#converters)
   - [Scope Filters](#scope-filters)
   - [Sorting](#sorting)
   - [Building the Query](#building-the-query)
@@ -83,6 +83,9 @@ Include module `Filterameter::DeclarativeFilters` in the controller to provide t
   filter :brand_name, association: :brand, name: :name
   filter :on_sale, association: :price, validates: [{ numericality: { greater_than: 0 } },
                                                     { numericality: { less_than: 100 } }]
+  filter :amount do |value|
+    value.is_a?(String) ? value.delete(",") : value
+  end
 ```
 
 Filters without options can be declared all at once with `filters`:
@@ -147,7 +150,7 @@ There are two shortcuts: : the partial option can be declared with `true`, which
 ```ruby
 filter :description, partial: true
 filter :department_name, partial: :from_start
-filter :reason, partial: { match: :dynamic, case_sensitive: true } 
+filter :reason, partial: { match: :dynamic, case_sensitive: true }
 ```
 
 The `match` options defines where you are searching (which then controls where the wildcard(s) appear):
@@ -186,6 +189,17 @@ The following filters are not sortable:
 - scope filters (see [_Sorting with a Scope_](#sorting-with-a-scope))
 - filters with collection associations
 
+#### Converters
+
+If the filter value needs to be converted before being applied to the query, a converter block can be provided. The block should take the parameter value as an argument and return the converted value.
+
+For example, if the amount filter should remove commas from the value before applying it to the query, the declaration would look like this:
+
+```ruby
+filter :amount do |value|
+  value.is_a?(String) ? value.delete(",") : value
+end
+```
 
 ### Scope Filters
 
@@ -267,7 +281,7 @@ There are two ways to apply the filters and build the query, depending on how mu
 
 Add before action callback `build_filtered_query` for controller actions that should build the query. This can be done either in the `ApplicationController` or on a case-by-case basis.
 
-When using the callback, the variable name is the pluralized model name. For example, the Photo model will use the variable `@photos` to store the query. The variable name can be explicitly specified with with `filter_query_var_name`. For example, if the query is stored as `@data`, use the following:
+When using the callback, the variable name is the pluralized model name. For example, the Photo model will use the variable `@photos` to store the query. The variable name can be explicitly specified with `filter_query_var_name`. For example, if the query is stored as `@data`, use the following:
 
 ```ruby
 filter_query_var_name :data
@@ -338,7 +352,7 @@ Note that the starting query provides the model, so the model is not looked up a
 
 ### Specifying the Model
 
-Rails conventions are used to determine the controller's model. For example, the PhotosController builds a query against the Photo model. If a controller is namespaced, the model will first be looked up without the namespace, then with the namespace. 
+Rails conventions are used to determine the controller's model. For example, the PhotosController builds a query against the Photo model. If a controller is namespaced, the model will first be looked up without the namespace, then with the namespace.
 
 **If the conventions do not provide the correct model**, the model can be named explicitly with the following:
 
@@ -356,7 +370,7 @@ There are three configuration options:
 - action_on_validation_failure
 - filter_key
 
-The configuration options can be set in an initializer, an environment file, or in `application.rb`. 
+The configuration options can be set in an initializer, an environment file, or in `application.rb`.
 
 The options can be set directly...
 
@@ -367,7 +381,7 @@ The options can be set directly...
 ```ruby
 Filterameter.configure do |config|
   config.action_on_undeclared_parameters = :log
-  config.action_on_validation_failuer = :log
+  config.action_on_validation_failure = :log
   config.filter_key = :f
 end
 ```
@@ -433,7 +447,7 @@ The sort is also nested underneath the filter key:
 
 Use an array to pass multiple sorts. The order of the parameters is the order the sorts will be applied. For example, the following sorts first by size then by color:
 
-`/widgets?filter[sort]=size&filter[sort]=color`
+`/widgets?filter[sort][]=size&filter[sort][]=color`
 
 Sorts are ascending by default, but can use a prefix can be added to control the sort:
 
@@ -446,7 +460,7 @@ For example, the following sorts by size descending:
 
 ## Contribute
 
-Feedback, feature requests, and proposed changes are welcomed. Please use the [issue tracker](https://github.com/RockSolt/filterameter/issues) 
+Feedback, feature requests, and proposed changes are welcomed. Please use the [issue tracker](https://github.com/RockSolt/filterameter/issues)
 for feedback and feature requests. To propose a change directly, please fork the repo and open a pull request. Keep an eye on the actions to make
 sure the tests and Rubocop are passing. [Code Climate](https://codeclimate.com/github/RockSolt/filterameter) is also used manually to assess the codeline.
 
@@ -460,11 +474,10 @@ Gold stars will be awarded if you are able to [replicate the issue with a test](
 
 ### Running Tests
 
-Tests are written in RSpec and the dummy app uses a docker database. The script `bin/start_db.sh` starts and prepares the test
-database. It is a one-time step before running the tests.
+Tests are written in RSpec.
 
 ```bash
-bin/start_db.rb
+bin/prepare_db.sh
 bundle exec rspec
 ```
 

data/lib/filterameter/declarative_filters.rb

@@ -61,8 +61,8 @@ module Filterameter
       #     filter :department_name, partial: :from_start
       #     filter :reason, partial: { match: :dynamic, case_sensitive: true }
       #     filter :price, range: true
-      def filter(name, options = {})
-        filter_coordinator.add_filter(name, options)
+      def filter(name, options = {}, &converter)
+        filter_coordinator.add_filter(name, options.merge(converter:))
       end
 
       # Declares a list of filters without options. Filters that require options must be declared with `filter`.
@@ -93,7 +93,7 @@ module Filterameter
 
       # Declares a list of sorts without options. Sorts that require options must be declared with `sort`.
       def sorts(*parameter_names)
-        parameter_names.each { |parameter_name| filter(parameter_name) }
+        parameter_names.each { |parameter_name| sort(parameter_name) }
       end
 
       # Declares a default sort order for the query. Specify a list of sort names and directions as pairs.

data/lib/filterameter/filter_declaration.rb

@@ -16,7 +16,7 @@ module Filterameter
   class FilterDeclaration
     VALID_RANGE_OPTIONS = [true, :min_only, :max_only].freeze
 
-    attr_reader :name, :parameter_name, :association, :validations
+    attr_reader :name, :parameter_name, :association, :validations, :converter
 
     def initialize(parameter_name, options, range_type: nil)
       @parameter_name = parameter_name.to_s
@@ -29,6 +29,7 @@ module Filterameter
       @raw_range = options[:range]
       @range_type = range_type
       @sortable = options.fetch(:sortable, true)
+      @converter = options[:converter]
     end
 
     def nested?
@@ -88,7 +89,7 @@ module Filterameter
     private
 
     def validate_options(options)
-      options.assert_valid_keys(:name, :association, :validates, :partial, :range, :sortable)
+      options.assert_valid_keys(:name, :association, :validates, :partial, :range, :sortable, :converter)
       validate_range(options[:range]) if options.key?(:range)
     end
 

data/lib/filterameter/filter_factory.rb

@@ -15,7 +15,7 @@ module Filterameter
       if declaration.nested?
         build_nested_filter(declaration, context)
       else
-        build_filter(@model_class, declaration, context.scope?)
+        build_filter_or_scope_filter(@model_class, declaration, context.scope?)
       end
     end
 
@@ -23,23 +23,29 @@ module Filterameter
 
     def build_nested_filter(declaration, context)
       model = context.model_from_association
-      filter = build_filter(model, declaration, context.scope?)
+      filter = build_filter_or_scope_filter(model, declaration, context.scope?)
       nested_filter_class = context.any_collections? ? Filters::NestedCollectionFilter : Filters::NestedFilter
 
       nested_filter_class.new(declaration.association, model, filter)
     end
 
-    def build_filter(model, declaration, declaration_is_a_scope) # rubocop:disable Metrics/MethodLength
+    def build_filter_or_scope_filter(model, declaration, declaration_is_a_scope)
       if declaration_is_a_scope
         build_scope_filter(model, declaration)
-      elsif declaration.partial_search?
-        Filterameter::Filters::MatchesFilter.new(declaration.name, declaration.partial_options)
+      else
+        build_filter(model, declaration)
+      end
+    end
+
+    def build_filter(model, declaration)
+      if declaration.partial_search?
+        Filterameter::Filters::MatchesFilter.new(declaration.name, declaration.partial_options, &declaration.converter)
       elsif declaration.minimum_range?
-        Filterameter::Filters::MinimumFilter.new(model, declaration.name)
+        Filterameter::Filters::MinimumFilter.new(model, declaration.name, &declaration.converter)
       elsif declaration.maximum_range?
-        Filterameter::Filters::MaximumFilter.new(model, declaration.name)
+        Filterameter::Filters::MaximumFilter.new(model, declaration.name, &declaration.converter)
       else
-        Filterameter::Filters::AttributeFilter.new(declaration.name)
+        Filterameter::Filters::AttributeFilter.new(declaration.name, &declaration.converter)
       end
     end
 
@@ -48,9 +54,9 @@ module Filterameter
     def build_scope_filter(model, declaration)
       number_of_arguments = model.method(declaration.name).arity
       if number_of_arguments < 1
-        Filterameter::Filters::ConditionalScopeFilter.new(declaration.name)
+        Filterameter::Filters::ConditionalScopeFilter.new(declaration.name, &declaration.converter)
       elsif number_of_arguments == 1
-        Filterameter::Filters::ScopeFilter.new(declaration.name)
+        Filterameter::Filters::ScopeFilter.new(declaration.name, &declaration.converter)
       else
         raise Filterameter::DeclarationErrors::FilterScopeArgumentError.new(model.name, declaration.name)
       end

data/lib/filterameter/filters/arel_filter.rb

@@ -10,9 +10,10 @@ module Filterameter
       include Filterameter::Errors
       include Filterameter::Filters::AttributeValidator
 
-      def initialize(model, attribute_name)
+      def initialize(model, attribute_name, &converter)
         @attribute_name = attribute_name
         @arel_attribute = model.arel_table[attribute_name]
+        @converter = converter
       end
     end
   end

data/lib/filterameter/filters/attribute_filter.rb

@@ -9,11 +9,13 @@ module Filterameter
       include Filterameter::Errors
       include AttributeValidator
 
-      def initialize(attribute_name)
+      def initialize(attribute_name, &converter)
         @attribute_name = attribute_name
+        @converter = converter
       end
 
       def apply(query, value)
+        value = @converter.call(value) if @converter
         query.where(@attribute_name => value)
       end
     end

data/lib/filterameter/filters/conditional_scope_filter.rb

@@ -8,11 +8,13 @@ module Filterameter
     class ConditionalScopeFilter
       include Filterameter::Errors
 
-      def initialize(scope_name)
+      def initialize(scope_name, &converter)
         @scope_name = scope_name
+        @converter = converter
       end
 
       def apply(query, value)
+        value = @converter.call(value) if @converter
         return query unless ActiveModel::Type::Boolean.new.cast(value)
 
         query.public_send(@scope_name)

data/lib/filterameter/filters/matches_filter.rb

@@ -9,14 +9,16 @@ module Filterameter
       include Filterameter::Errors
       include Filterameter::Filters::AttributeValidator
 
-      def initialize(attribute_name, options)
+      def initialize(attribute_name, options, &converter)
         @attribute_name = attribute_name
         @prefix = options.match_anywhere? ? '%' : nil
         @suffix = options.match_anywhere? || options.match_from_start? ? '%' : nil
         @case_sensitive = options.case_sensitive?
+        @converter = converter
       end
 
       def apply(query, value)
+        value = @converter.call(value) if @converter
         arel = query.arel_table[@attribute_name].matches("#{@prefix}#{value}#{@suffix}", false, @case_sensitive)
         query.where(arel)
       end

data/lib/filterameter/filters/maximum_filter.rb

@@ -7,6 +7,7 @@ module Filterameter
     # Class MaximumFilter adds criteria for all values greater than or equal to a maximum.
     class MaximumFilter < ArelFilter
       def apply(query, value)
+        value = @converter.call(value) if @converter
         query.where(@arel_attribute.lteq(value))
       end
     end

data/lib/filterameter/filters/minimum_filter.rb

@@ -7,6 +7,7 @@ module Filterameter
     # Class MinimumFilter adds criteria for all values greater than or equal to a minimum.
     class MinimumFilter < ArelFilter
       def apply(query, value)
+        value = @converter.call(value) if @converter
         query.where(@arel_attribute.gteq(value))
       end
     end

data/lib/filterameter/filters/scope_filter.rb

@@ -8,11 +8,13 @@ module Filterameter
     class ScopeFilter
       include Filterameter::Errors
 
-      def initialize(scope_name)
+      def initialize(scope_name, &converter)
         @scope_name = scope_name
+        @converter = converter
       end
 
       def apply(query, value)
+        value = @converter.call(value) if @converter
         query.public_send(@scope_name, value)
       end
 

data/lib/filterameter/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: filterameter
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Todd Kummer
 bindir: bin
 cert_chain: []
-date: 2025-03-15 00:00:00.000000000 Z
+date: 2026-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,62 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.16'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: guard-rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -127,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -155,28 +99,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.30.0
+        version: '2.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.30.0
+        version: '2.32'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -252,7 +196,8 @@ files:
 homepage: https://github.com/RockSolt/filterameter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -267,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Declarative Filter Parameters
 test_files: []