filterameter 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83338f9a61d92c1d562a5708a0268e647d52916960b4d750a75f3cd6107bee7a
-  data.tar.gz: a3036ffda002e4075a40be6225681bb67ed9b2f5c2534ecf5370aff70e7d375c
+  metadata.gz: fab4750d809945619906678860278bb1266e20f3167a7e1cf15ca2cfcdb2404d
+  data.tar.gz: da0d8f1d87b5aa8393f0283ce92442b968a4f388f6aa86eaf65c0740f3da8a7f
 SHA512:
-  metadata.gz: c923a97b54f2da6ed9f2d17743213cde5f16f9525383ef1bbe7081f02ae69ac46553e398a5d5f45b5292f65b84d0a0a681fb198633b06d44eb0ab013a606338c
-  data.tar.gz: 5dae50a8f42ad0ac9a83dbe497f948f7dbabba29157daf5549478487f6c973a129ee514d04e40820467d3abb8111bf2430d82cf7495bf599e06225f7cb684a4b
+  metadata.gz: 6c4c735e792c7da17e8753e760e2e75143e1e959f0000fb2367246dc280a57fc3709d47ac063a8261a3429727ac178d41c18fc4a0fc2abcec8417e2ec0c28240
+  data.tar.gz: 2a92f39bcd0af14ff33f3efc35f65def9d882a3caf01b18a04ec0c31ece6977966962ce88d893d0efb62c2b4492babe2d90b02fde8f730a76121c869d2ca3c3c

data/README.md

@@ -4,7 +4,7 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/d9d87f9ce8020eb6e656/maintainability)](https://codeclimate.com/github/RockSolt/filterameter/maintainability)
 
 # Filterameter
-Declarative filter parameters provide provide clean and clear filters for queries.
+Declarative filter parameters provide clean and clear filters for queries.
 
 ## Usage
 Declare filters in query classes or controllers to increase readability and reduce boilerplate code. Filters can be declared for attributes, scopes, or attributes from singular associations (`belongs_to` or `has_one`). Validations can also be assigned.
@@ -170,22 +170,42 @@ Or install it yourself as:
 $ gem install filterameter
 ```
 
+## Forms and Query Parameters
+
+The controller mixin will look for filter parameters nested under the `filter` key. For example, here's what the query parameters might look like for size and color:
+
+```
+?filter[size]=large&filter[color]=blue
+```
+
+On [a generic search form](https://guides.rubyonrails.org/form_helpers.html#a-generic-search-form), the [`form_with` form helper takes the option `scope`](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-form_with) that allows parameters to be grouped:
+
+```erb
+<%= form_with url: "/search", scope: :filter, method: :get do |form| %>
+  <%= form.label :size, "Size:" %>
+  <%= form.text_field :size %>
+  <%= form.label :color, "Color:" %>
+  <%= form.text_field :color %>
+  <%= form.submit "Search" %>
+<% end %>
+```
+
 
 ## Running Tests
 
-Tests are written in RSpec and the dummy app uses a docker database. First, start the database and prepare it from the dummy folder.
+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.
 
 ```bash
-cd spec/dummy
-docker-compose up -d
-bundle exec rails db:test:prepare
-cd ../..
+bin/start_db.rb
+bundle exec rspec
 ```
 
-Run the tests from the main directory
+The tests can also be run across all the ruby and Rails combinations using appraisal. The install is also a one-time step.
 
 ```bash
-bundle exec rspec
+bundle exec appraisal install
+bundle exec appraisal rspec
 ```
 
 ## License

data/lib/filterameter/filters/conditional_scope_filter.rb

@@ -13,7 +13,7 @@ module Filterameter
       def apply(query, value)
         return query unless ActiveModel::Type::Boolean.new.cast(value)
 
-        query.send(@scope_name)
+        query.public_send(@scope_name)
       end
     end
   end

data/lib/filterameter/filters/scope_filter.rb

@@ -11,7 +11,7 @@ module Filterameter
       end
 
       def apply(query, value)
-        query.send(@scope_name, value)
+        query.public_send(@scope_name, value)
       end
     end
   end

data/lib/filterameter/query_builder.rb

@@ -64,15 +64,7 @@ module Filterameter
         raise Filterameter::Exceptions::ValidationError, validator.errors
       end
 
-      filter_params.except(*invalid_attributes(validator.errors).map(&:to_s))
-    end
-
-    def invalid_attributes(errors)
-      if errors.respond_to? :attribute_names
-        errors.attribute_names
-      else # pre rails 6.1
-        errors.keys
-      end
+      filter_params.except(*validator.errors.attribute_names.map(&:to_s))
     end
 
     def validator_class

data/lib/filterameter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterameter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Todd Kummer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +171,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/filterameter.rb
@@ -222,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Declarative Filter Parameters

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2019 Todd Kummer
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.