filterameter 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5ff39d6e3e772f3943678ecc748ca3f9d9234417958fc9254071ee14764ed31
-  data.tar.gz: 22e0d442436d0cae884e60a60066eea859c7de22251d6471e05c289af50f3da1
+  metadata.gz: 65c8829537f7ee2affcc40a56fb5de2b58d4789fc6d1e9811b33607c86c9c01b
+  data.tar.gz: e731021c3cda4e0330b2a7bc499b90ceb49cd918ddd635d57a37c4bf2ce3a9bc
 SHA512:
-  metadata.gz: 67cd4b48cf4f50e0681e34003f0f9ebe7ae753b703f83121d017daaee7185c846c4e2e467d2b140fc14ced8e11b07f88b155a1dda4b6e0a9104906348f077a53
-  data.tar.gz: f80c40fcd3a438682bd95c7b3c282dae7cc199c57375372314d0720c234c53aa0b4609c47cccc2dcb85505a023f74e9ba6c6e2125714a5d48710c87bff20a6d5
+  metadata.gz: 20d94a91e915e4f7048db9d11b9608c6f7eaa3d47c018a5ff5132d63736c54e1be96b5ce7f1050325d610c7009e1b64582a2f7253f0cd6a8b37e1e65f4f0f37f
+  data.tar.gz: f5aa757afd07c03e2654f11cd34b348c3d0d810231ac9831c82b04e936bb9009fb20f6a8fd93b2193ddfe344481053c0b608d2a074843972d6a35b37f194329a

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/coordinators/base.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require 'filterameter/filter_declaration'
-require 'filterameter/filter_factory'
-require 'filterameter/filter_registry'
-require 'filterameter/log_subscriber'
-require 'filterameter/parameters_base'
-require 'filterameter/query_builder'
-
 module Filterameter
   module Coordinators
     # = Coordinators Base

data/lib/filterameter/coordinators/controller_coordinator.rb

@@ -7,8 +7,6 @@ require 'action_dispatch'
 require 'action_controller/metal/live'
 require 'action_controller/metal/strong_parameters'
 
-require 'filterameter/coordinators/base'
-
 module Filterameter
   module Coordinators
     # = Controller Filters

data/lib/filterameter/declarative_controller_filters.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'filterameter/filterable'
-require 'filterameter/coordinators/controller_coordinator'
-
 module Filterameter
   # = Declarative Controller Filters
   #

data/lib/filterameter/declarative_filters.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'filterameter/coordinators/query_coordinator'
-require 'filterameter/filterable'
-require 'filterameter/query_builder'
-
 module Filterameter
   # = Declarative Filters
   #

data/lib/filterameter/exceptions/cannot_determine_model_error.rb

@@ -9,8 +9,8 @@ module Filterameter
     # explicitly by adding a call to `filter_model`.
     class CannotDetermineModelError < FilterameterError
       def initialize(name, path)
-        super "Cannot determine model name from controller name #{value_and_classify(name)} " \
-              "or path #{value_and_classify(path)}. Declare the model explicitly with filter_model."
+        super("Cannot determine model name from controller name #{value_and_classify(name)} " \
+              "or path #{value_and_classify(path)}. Declare the model explicitly with filter_model.")
       end
 
       private

data/lib/filterameter/exceptions.rb

@@ -6,7 +6,3 @@ module Filterameter
     end
   end
 end
-
-require 'filterameter/exceptions/cannot_determine_model_error'
-require 'filterameter/exceptions/validation_error'
-require 'filterameter/exceptions/undeclared_parameter_error'

data/lib/filterameter/filter_declaration.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/array/wrap'
-require 'filterameter/options/partial_options'
 
 module Filterameter
   # = Filter Declaration

data/lib/filterameter/filter_factory.rb

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
 
-require 'filterameter/filters/arel_filter'
-require 'filterameter/filters/attribute_filter'
-require 'filterameter/filters/conditional_scope_filter'
-require 'filterameter/filters/matches_filter'
-require 'filterameter/filters/maximum_filter'
-require 'filterameter/filters/minimum_filter'
-require 'filterameter/filters/nested_filter'
-require 'filterameter/filters/scope_filter'
-
 module Filterameter
   # = Filter Factory
   #

data/lib/filterameter/options/partial_options.rb

@@ -1,82 +1,84 @@
 # frozen_string_literal: true
 
-module Options
-  # = Partial Options
-  #
-  # Class PartialOptions parses the options passed in as partial, then exposes those. Here are the options along with
-  # their valid values:
-  # - match: anywhere (default), from_start, dynamic
-  # - case_sensitive: true, false (default)
-  #
-  # Options may be specified by passing a hash with the option keys:
-  #
-  #   partial: { match: :from_start, case_sensitive: true }
-  #
-  # There are two shortcuts: the partial option can be declared with `true`, which just uses the defaults; or the
-  # partial option can be declared with the match option directly, such as partial: :from_start.
-  class PartialOptions
-    VALID_OPTIONS = %i[match case_sensitive].freeze
-    VALID_MATCH_OPTIONS = %w[anywhere from_start dynamic].freeze
+module Filterameter
+  module Options
+    # = Partial Options
+    #
+    # Class PartialOptions parses the options passed in as partial, then exposes those. Here are the options along with
+    # their valid values:
+    # - match: anywhere (default), from_start, dynamic
+    # - case_sensitive: true, false (default)
+    #
+    # Options may be specified by passing a hash with the option keys:
+    #
+    #   partial: { match: :from_start, case_sensitive: true }
+    #
+    # There are two shortcuts: the partial option can be declared with `true`, which just uses the defaults; or the
+    # partial option can be declared with the match option directly, such as partial: :from_start.
+    class PartialOptions
+      VALID_OPTIONS = %i[match case_sensitive].freeze
+      VALID_MATCH_OPTIONS = %w[anywhere from_start dynamic].freeze
 
-    def initialize(options)
-      @match = 'anywhere'
-      @case_sensitive = false
+      def initialize(options)
+        @match = 'anywhere'
+        @case_sensitive = false
 
-      case options
-      when TrueClass
-        nil
-      when Hash
-        evaluate_hash(options)
-      when String, Symbol
-        assign_match(options)
+        case options
+        when TrueClass
+          nil
+        when Hash
+          evaluate_hash(options)
+        when String, Symbol
+          assign_match(options)
+        end
       end
-    end
 
-    def case_sensitive?
-      @case_sensitive
-    end
+      def case_sensitive?
+        @case_sensitive
+      end
 
-    def match_anywhere?
-      @match == 'anywhere'
-    end
+      def match_anywhere?
+        @match == 'anywhere'
+      end
 
-    def match_from_start?
-      @match == 'from_start'
-    end
+      def match_from_start?
+        @match == 'from_start'
+      end
 
-    def match_dynamically?
-      @match == 'dynamic'
-    end
+      def match_dynamically?
+        @match == 'dynamic'
+      end
 
-    private
+      private
 
-    def evaluate_hash(options)
-      options.assert_valid_keys(:match, :case_sensitive)
-      assign_match(options[:match]) if options.key?(:match)
-      assign_case_sensitive(options[:case_sensitive]) if options.key?(:case_sensitive)
-    end
+      def evaluate_hash(options)
+        options.assert_valid_keys(:match, :case_sensitive)
+        assign_match(options[:match]) if options.key?(:match)
+        assign_case_sensitive(options[:case_sensitive]) if options.key?(:case_sensitive)
+      end
 
-    def assign_match(value)
-      validate_match(value)
-      @match = value.to_s
-    end
+      def assign_match(value)
+        validate_match(value)
+        @match = value.to_s
+      end
 
-    def validate_match(value)
-      return if VALID_MATCH_OPTIONS.include? value.to_s
+      def validate_match(value)
+        return if VALID_MATCH_OPTIONS.include? value.to_s
 
-      raise ArgumentError,
-            "Invalid match option for partial: #{value}. Valid options are #{VALID_MATCH_OPTIONS.to_sentence}"
-    end
+        raise ArgumentError,
+              "Invalid match option for partial: #{value}. Valid options are #{VALID_MATCH_OPTIONS.to_sentence}"
+      end
 
-    def assign_case_sensitive(value)
-      validate_case_sensitive(value)
-      @case_sensitive = value
-    end
+      def assign_case_sensitive(value)
+        validate_case_sensitive(value)
+        @case_sensitive = value
+      end
 
-    def validate_case_sensitive(value)
-      return if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      def validate_case_sensitive(value)
+        return if value.is_a?(TrueClass) || value.is_a?(FalseClass)
 
-      raise ArgumentError, "Invalid case_sensitive option for partial: #{value}. Valid options are true and false."
+        raise ArgumentError, "Invalid case_sensitive option for partial: #{value}. Valid options are true and false."
+      end
     end
   end
 end

data/lib/filterameter/parameters_base.rb

@@ -2,7 +2,6 @@
 
 require 'active_model/attribute_assignment'
 require 'active_model/validations'
-require 'filterameter/validators/inclusion_validator'
 
 module Filterameter
   # = Parameters

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.3.0'
+  VERSION = '0.4.1'
 end

data/lib/filterameter.rb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
-require 'filterameter/configuration'
-require 'filterameter/declarative_controller_filters'
-require 'filterameter/declarative_filters'
-require 'filterameter/exceptions'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
 
 # = Filterameter
-#
-# Module Filterameter can be mixed into a controller to provide the DSL to describe each controller's filters.
-#
-# The model class must be declared if it cannot be derived. It can be derived if (A) the model is not namespaced and its
-# name matches the controller name (for example BrandsController -> Brand) or (B) both the controller and model share
-# the same namespace and name.
 module Filterameter
   class << self
     attr_writer :configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterameter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Todd Kummer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-30 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -86,56 +86,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.5.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 1.60.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 1.60.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.15.1
+        version: 2.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.15.1
+        version: 2.23.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +171,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/filterameter.rb
@@ -208,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+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.