filterameter 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50c824121830196b05ccb71f43495ad4d5197f85fe9d31456edc549fd2462a59
-  data.tar.gz: 4bb268b89c285e6542b0347bb3c52ca903f4d9be517f33b6303a76200b36f6c6
+  metadata.gz: 02daf1402e83a27c8b13ed7e548dfe269b7a1e6c7c5085f9aad2220509793253
+  data.tar.gz: 1ddcce714232b71be40272ac3e84f116e38af380928407936a082ade5395c743
 SHA512:
-  metadata.gz: 21e92b0610890ed0ccbd8e3bdba68864de0c28d1c1ea42af40e51e696b0950c0ed6dd2d085673e493f400ca875d0307eeaaf9b844d021f1ae0d2fe11d53420c7
-  data.tar.gz: 77edd1277a98e49ab6c6425fe387404176477afc9050bafbb4d3d0eb34268d0e0e4a1f2983fb3b4951a0c9e7c88a0309464ab11112d67ae401ebcb75f7a74617
+  metadata.gz: b33c74905694f9a1682a4c7faefb6e11cbeff81a7c2bae32dd3a39f25393d50a7eb86fc766825f9296c2ce19440aed296eab17bebfd6f1eac77a41aa749dbeeb
+  data.tar.gz: 36f85f875a0c15258988cbbf97062caa75e1e47de1142484eaa96b8bae7f757d5a94e5fd5ac07b2137db7f1d8cb146adb76b3d6aa2849ad3507707e22b87b783

data/README.md

@@ -42,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)
@@ -82,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`:
@@ -185,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
 

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`.

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.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: filterameter
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Todd Kummer
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 2026-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -196,7 +196,8 @@ files:
 homepage: https://github.com/RockSolt/filterameter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib