filterameter 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e753f63174bbf6eb6a0ad352fc518782bc092f5e9075bcd596d540c76ceb6ab1
-  data.tar.gz: 14f544522f30cbf4d2d6fe54fb5e8a5e0310172fcc75007c087e9402359d6ae3
+  metadata.gz: 83338f9a61d92c1d562a5708a0268e647d52916960b4d750a75f3cd6107bee7a
+  data.tar.gz: a3036ffda002e4075a40be6225681bb67ed9b2f5c2534ecf5370aff70e7d375c
 SHA512:
-  metadata.gz: 13b2457bf17e0cdd1d9b11075d4a5df015179b46000a2b3418d10ab5885bb5d2fc0435c59bfdae7668c2cf165973084ccd2a1403e95f32e1e40cef1a67849dfb
-  data.tar.gz: 26b14da4bdc7e786dbd025af086dc9aadac131306c3ef82ea7ef8f73e72e7518e4de825d34ab80b51ed2b3052705060ebf87b6ae5dce56a8adc697f051928258
+  metadata.gz: c923a97b54f2da6ed9f2d17743213cde5f16f9525383ef1bbe7081f02ae69ac46553e398a5d5f45b5292f65b84d0a0a681fb198633b06d44eb0ab013a606338c
+  data.tar.gz: 5dae50a8f42ad0ac9a83dbe497f948f7dbabba29157daf5549478487f6c973a129ee514d04e40820467d3abb8111bf2430d82cf7495bf599e06225f7cb684a4b

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/filter_registry.rb

@@ -16,13 +16,14 @@ module Filterameter
     end
 
     def add_filter(parameter_name, options)
-      @declarations[parameter_name.to_s] = Filterameter::FilterDeclaration.new(parameter_name, options).tap do |fd|
-        add_declarations_for_range(fd, options, parameter_name) if fd.range_enabled?
+      name = parameter_name.to_s
+      @declarations[name] = Filterameter::FilterDeclaration.new(name, options).tap do |fd|
+        add_declarations_for_range(fd, options, name) if fd.range_enabled?
       end
     end
 
-    def fetch(name)
-      name = name.to_s
+    def fetch(parameter_name)
+      name = parameter_name.to_s
       @filters.fetch(name) do
         raise Filterameter::Exceptions::UndeclaredParameterError, name unless @declarations.keys.include?(name)
 

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

@@ -11,7 +11,7 @@ module Filterameter
     end
 
     def build_query(filter_params, starting_query = nil)
-      valid_filters(filter_params)
+      valid_filters(filter_params.stringify_keys)
         .tap { |parameters| convert_min_and_max_to_range(parameters) }
         .reduce(starting_query || @default_query) do |query, (name, value)|
         add_filter_parameter_to_query(query, name, value)
@@ -64,7 +64,15 @@ module Filterameter
         raise Filterameter::Exceptions::ValidationError, validator.errors
       end
 
-      filter_params.except(*validator.errors.attribute_names.map(&:to_s))
+      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
     end
 
     def validator_class

data/lib/filterameter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Filterameter
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Todd Kummer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +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.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -72,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: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 1.60.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: 1.22.3
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.23.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +164,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: Enable filter parameters to be declared in controllers.
+description: Enable filter parameters to be declared in query classes or controllers.
 email:
 - todd@rockridgesolutions.com
 executables: []
@@ -194,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Declarative Filter Parameters for Rails Controllers
+summary: Declarative Filter Parameters
 test_files: []