filterameter 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab4750d809945619906678860278bb1266e20f3167a7e1cf15ca2cfcdb2404d
-  data.tar.gz: da0d8f1d87b5aa8393f0283ce92442b968a4f388f6aa86eaf65c0740f3da8a7f
+  metadata.gz: f44f6d30fd92e15bc7652df41d75e2d620740fb19f146cbb253274460c3686f2
+  data.tar.gz: 84109580ba0079787e3bcc0e20054a71c2eb2ae7efc512d511124172f19c69fc
 SHA512:
-  metadata.gz: 6c4c735e792c7da17e8753e760e2e75143e1e959f0000fb2367246dc280a57fc3709d47ac063a8261a3429727ac178d41c18fc4a0fc2abcec8417e2ec0c28240
-  data.tar.gz: 2a92f39bcd0af14ff33f3efc35f65def9d882a3caf01b18a04ec0c31ece6977966962ce88d893d0efb62c2b4492babe2d90b02fde8f730a76121c869d2ca3c3c
+  metadata.gz: 4b8606c20e87f96b25876da9b670f555b1c95b40bc5fa13368174d1e4264ea1a535a93ea714111171710de12e301876aa59081f327a9cbd8e4f5a6735f2c0406
+  data.tar.gz: 1f848be8b42e68845cebaabadd04b0e9019dab54d9cfdfa2628048215cb6ed5c5e37360fa99a473208cf4539a5963a065f0790a75ecc5d795e45037ae35f7347

data/README.md

@@ -4,10 +4,10 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/d9d87f9ce8020eb6e656/maintainability)](https://codeclimate.com/github/RockSolt/filterameter/maintainability)
 
 # Filterameter
-Declarative filter parameters provide clean and clear filters for queries.
+Declarative filter parameters provide clean and clear filters for Rails controllers.
 
 ## 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.
+Declare filters in 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.
 
 ```ruby
   filter :color
@@ -85,39 +85,9 @@ filter :sale_price, range: :max_only
 
 In the first example, query parameters could include <tt>price</tt>, <tt>price_min</tt>, and <tt>price_max</tt>.
 
-### Query Classes
-
-Include module `Filterameter::DeclarativeFilters` in the query class. The model must be declared using `model`, and a default query can optionally be declared using `default_query`. If no default query is provided, then the default is `.all`.
-
-#### Example
-
-Here's what a query class for the Widgets model with filters on size and color might look like:
-
-```ruby
-class WidgetQuery
-  include Filterameter::DeclarativeFilters
-
-  model Widget
-  filter :size
-  filter :color
-end
-```
-
-Build the query using class method `build_query`. The method takes two parameters:
-
-- filter: the hash of filter parameters
-- starting_query: any scope to build on (if not provided, the default query is the starting point)
-
-Here's how the query might be invoked:
-
-```ruby
-filters = { size: 'large', color: 'blue' }
-widgets = WidgetQuery.build_query(filters, Widget.limit(10))
-```
-
 ### Controllers
 
-Include module `Filterameter::DeclarativeControllerFilters` in the controller. Add before action callback `build_filtered_query` for controller actions that should build the query.
+Include module `Filterameter::DeclarativeFilters` in the controller. Add before action callback `build_filtered_query` for controller actions that should build the query.
 
 Rails conventions are used to determine the controller's model as well as the name of the instance variable to apply the filters to. For example, the PhotosController will use the variable `@photos` to store a query against the Photo model. **If the conventions do not provide the correct info**, they can be overridden with the following two methods:
 
@@ -141,7 +111,7 @@ In the happy path, the WidgetsController serves Widgets and can filter on size a
 
 ```ruby
 class WidgetController < ApplicationController
-  include Filterameter::DeclarativeControllerFilters
+  include Filterameter::DeclarativeFilters
   before_action :build_filtered_query, only: :index
 
   filter :size

data/lib/filterameter/declarative_filters.rb

@@ -1,27 +1,37 @@
 # frozen_string_literal: true
 
 module Filterameter
-  # = Declarative Filters
+  # = Declarative Controller Filters
   #
-  # Mixin DeclarativeFilters is included to build query classes using the filter DSL.
+  # Mixin DeclarativeFilters can included in controllers to enable the filter DSL.
   module DeclarativeFilters
     extend ActiveSupport::Concern
     include Filterameter::Filterable
 
     class_methods do
-      delegate :build_query, to: :filter_coordinator
-
-      def model(model_class)
+      def filter_model(model_class, query_var_name = nil)
         filter_coordinator.model_class = model_class
+        filter_query_var_name(query_var_name) if query_var_name.present?
       end
 
-      def default_query(query)
-        filter_coordinator.default_query = query
+      def filter_query_var_name(query_variable_name)
+        filter_coordinator.query_variable_name = query_variable_name
       end
 
       def filter_coordinator
-        @filter_coordinator ||= Filterameter::Coordinators::QueryCoordinator.new
+        @filter_coordinator ||= Filterameter::FilterCoordinator.new(controller_name, controller_path)
       end
     end
+
+    private
+
+    def build_filtered_query
+      var_name = "@#{self.class.filter_coordinator.query_variable_name}"
+      instance_variable_set(
+        var_name,
+        self.class.filter_coordinator.build_query(params.to_unsafe_h.fetch(:filter, {}),
+                                                  instance_variable_get(var_name))
+      )
+    end
   end
 end

data/lib/filterameter/filter_coordinator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+require 'active_support/rails'
+require 'action_dispatch'
+require 'action_controller/metal/live'
+require 'action_controller/metal/strong_parameters'
+
+module Filterameter
+  # = Filter Coordinator
+  #
+  # Class FilterCoordinator stores the configuration declared via class-level method calls such as the list of
+  # filters and the optionally declared model class. Each controller will have one instance of the coordinator
+  # stored as a class variable.
+  #
+  # The coordinators encapsulate references to the Query Builder and Filter Registry to keep the namespace clean for
+  # controllers that implement filter parameters.
+  class FilterCoordinator
+    attr_writer :query_variable_name
+
+    delegate :add_filter, to: :registry
+    delegate :build_query, to: :query_builder
+
+    def initialize(controller_name, controller_path)
+      @controller_name = controller_name
+      @controller_path = controller_path
+    end
+
+    def model_class=(model_class)
+      @model_class = model_class.is_a?(String) ? model_class.constantize : model_class
+    end
+
+    def query_builder
+      @query_builder ||= Filterameter::QueryBuilder.new(default_query, registry)
+    end
+
+    def query_variable_name
+      @query_variable_name ||= model_class.model_name.plural
+    end
+
+    private
+
+    def model_class
+      @model_class ||= @controller_name.classify.safe_constantize ||
+                       @controller_path.classify.safe_constantize ||
+                       raise(Filterameter::Exceptions::CannotDetermineModelError.new(@controller_name,
+                                                                                     @controller_path))
+    end
+
+    def default_query
+      model_class.all
+    end
+
+    # lazy so that model_class can be optionally set
+    def registry
+      @registry ||= Filterameter::FilterRegistry.new(Filterameter::FilterFactory.new(model_class))
+    end
+  end
+end

data/lib/filterameter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterameter
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Todd Kummer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -175,15 +175,12 @@ files:
 - Rakefile
 - lib/filterameter.rb
 - lib/filterameter/configuration.rb
-- lib/filterameter/coordinators/base.rb
-- lib/filterameter/coordinators/controller_coordinator.rb
-- lib/filterameter/coordinators/query_coordinator.rb
-- lib/filterameter/declarative_controller_filters.rb
 - lib/filterameter/declarative_filters.rb
 - lib/filterameter/exceptions.rb
 - lib/filterameter/exceptions/cannot_determine_model_error.rb
 - lib/filterameter/exceptions/undeclared_parameter_error.rb
 - lib/filterameter/exceptions/validation_error.rb
+- lib/filterameter/filter_coordinator.rb
 - lib/filterameter/filter_declaration.rb
 - lib/filterameter/filter_factory.rb
 - lib/filterameter/filter_registry.rb

data/lib/filterameter/coordinators/base.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Filterameter
-  module Coordinators
-    # = Coordinators Base
-    #
-    # The main responsibility of the Coordinators classes is to keep the namespace clean for controllers and query
-    # objects that implement filter parameters. The coordinators encapsulate references to the Query Builder and
-    # Filter Registry.
-    class Base
-      attr_reader :model_class
-
-      delegate :add_filter, to: :registry
-      delegate :build_query, to: :query_builder
-
-      def model_class=(model_class)
-        @model_class = model_class.is_a?(String) ? model_class.constantize : model_class
-      end
-
-      def query_builder
-        @query_builder ||= Filterameter::QueryBuilder.new(default_query, registry)
-      end
-
-      private
-
-      def default_query
-        model_class.all
-      end
-
-      # lazy so that model_class can be optionally set
-      def registry
-        @registry ||= Filterameter::FilterRegistry.new(Filterameter::FilterFactory.new(model_class))
-      end
-    end
-  end
-end

data/lib/filterameter/coordinators/controller_coordinator.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/inflector'
-
-require 'active_support/rails'
-require 'action_dispatch'
-require 'action_controller/metal/live'
-require 'action_controller/metal/strong_parameters'
-
-module Filterameter
-  module Coordinators
-    # = Controller Filters
-    #
-    # Class ControllerFilters stores the configuration declared via class-level method calls such as the list of
-    # filters and the optionally declared model class. Each controller will have one instance of the controller
-    # declarations stored as a class variable.
-    class ControllerCoordinator < Filterameter::Coordinators::Base
-      attr_writer :query_variable_name
-
-      def initialize(controller_name, controller_path)
-        @controller_name = controller_name
-        @controller_path = controller_path
-        super()
-      end
-
-      def query_variable_name
-        @query_variable_name ||= model_class.model_name.plural
-      end
-
-      private
-
-      def model_class
-        @model_class ||= @controller_name.classify.safe_constantize ||
-                         @controller_path.classify.safe_constantize ||
-                         raise(Filterameter::Exceptions::CannotDetermineModelError.new(@controller_name,
-                                                                                       @controller_path))
-      end
-    end
-  end
-end

data/lib/filterameter/coordinators/query_coordinator.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Filterameter
-  module Coordinators
-    # = Query Coordinator
-    #
-    # Class QueryCoordinator coordinates the filter logic for query classes.
-    class QueryCoordinator < Filterameter::Coordinators::Base
-      attr_writer :default_query
-
-      private
-
-      def default_query
-        @default_query || super
-      end
-    end
-  end
-end

data/lib/filterameter/declarative_controller_filters.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Filterameter
-  # = Declarative Controller Filters
-  #
-  # Mixin DeclarativeControllerFilters can included in controllers to enable the filter DSL.
-  module DeclarativeControllerFilters
-    extend ActiveSupport::Concern
-    include Filterameter::Filterable
-
-    class_methods do
-      def filter_model(model_class, query_var_name = nil)
-        filter_coordinator.model_class = model_class
-        filter_query_var_name(query_var_name) if query_var_name.present?
-      end
-
-      def filter_query_var_name(query_variable_name)
-        filter_coordinator.query_variable_name = query_variable_name
-      end
-
-      def filter_coordinator
-        @filter_coordinator ||= Filterameter::Coordinators::ControllerCoordinator.new(controller_name, controller_path)
-      end
-    end
-
-    private
-
-    def build_filtered_query
-      var_name = "@#{self.class.filter_coordinator.query_variable_name}"
-      instance_variable_set(
-        var_name,
-        self.class.filter_coordinator.build_query(params.to_unsafe_h.fetch(:filter, {}),
-                                                  instance_variable_get(var_name))
-      )
-    end
-  end
-end