toller 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 565b78efab21039ddd7025adad94e0ac2e045943acef17e97374aac58b0b3b10
-  data.tar.gz: a73035fb270e002dfd8cfe8ed38dff7317dbbf033e4aac922e5b409fc9aad92b
+  metadata.gz: bb4ebc1d6c6e8f4eaae0c68c740ae3b35693cd678c6e14e245295a40ad48f2d0
+  data.tar.gz: f380d915cb7f85ed2f3cd6873db803c71d01b9a28e96b9ba8375bb241a02432f
 SHA512:
-  metadata.gz: b6a9f24aeec9383b065c39c3430c63ab90bd75cd963b414418e552d3fdd22a151e0c1da7ece697c92116958d294781c83330145889266d6be739e7ba2698b78a
-  data.tar.gz: b816afc011e2070a7adfeee999702ecdf2ca04af45e50a4ec7966d98ef1fd5486aaa1bcffd4c48a443db9aafdc43a60c5679c7b4dd20e5ff918304b6b38232bd
+  metadata.gz: b84c1d90d5d1ebddb6ac81713874ce935d141664a3cb9b4601e08bd4394e844e26aa495d77d88b6381f39587093b3794411cefcc1fe082951239033ba2da070d
+  data.tar.gz: 2a1f0894da895687f8b8699073bd84932c41b1a1af591c95269f6e596e8555111af92dea2b065b598a1e3e18ee3f0869033385c46a44c04696d2fd1b74f37940

data/README.md

@@ -16,7 +16,7 @@ See the [wiki](https://github.com/dfreerksen/toller/wiki) for usage information.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'toller', '~> 1.0'
+gem 'toller', '~> 1.1'
 ```
 
 And then execute:

data/lib/toller/filter.rb

@@ -42,7 +42,7 @@ module Toller
       if type == :scope
         Filters::ScopeHandler.new.call(collection, value, properties)
       else
-        Filters::WhereHandler.new.call(collection, type, value, properties)
+        Filters::ColumnHandler.new.call(collection, type, value, properties)
       end
     end
 

data/lib/toller/filters/{where_handler.rb → column_handler.rb}

@@ -4,19 +4,27 @@ module Toller
   # :nodoc:
   module Filters
     ##
-    # Where handler for filter
-    class WhereHandler
+    # Column handler for filter
+    class ColumnHandler
       ##
       # Applies a plain `where` clause to +collection+ for a non-scope filter.
       #
+      # If +field+ isn't a real column on the collection's model, the filter is
+      # logged and skipped instead of raising once the relation is evaluated.
+      #
       # @param collection [ActiveRecord::Relation] the collection to filter
       # @param type [Symbol] the filter type (e.g. :string, :integer, :boolean)
       # @param value [Object] the raw filter param value
       # @param properties [Hash] the filter's properties, used to resolve `:field`
-      # @return [ActiveRecord::Relation] the filtered collection
+      # @return [ActiveRecord::Relation] the filtered collection, or +collection+ unchanged if `:field` is unknown
       def call(collection, type, value, properties)
         field_name = properties[:field]
 
+        unless collection.klass.column_names.include?(field_name.to_s)
+          Rails.logger.warn("[Toller] Skipping filter: #{collection.klass} has no column `#{field_name}`")
+          return collection
+        end
+
         mutated_value = value_mutator(type, value)
 
         collection.where(field_name => mutated_value)

data/lib/toller/filters/mutators/boolean.rb

@@ -16,7 +16,7 @@ module Toller
         # @param value [String] the raw filter param value
         # @return [Boolean] true if +value+ is one of "1", "t", "true", "y", "yes"; false otherwise
         def call(value)
-          %w[1 t true y yes].include?(value)
+          %w[1 t true y yes].include?(value.to_s.downcase)
         end
       end
     end

data/lib/toller/filters/mutators/common/range.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Toller
+  # :nodoc:
+  module Filters
+    # :nodoc:
+    module Mutators
+      # :nodoc:
+      module Common
+        ##
+        # Shared range-parsing behavior for filter mutators. Extend this module to get a
+        # `call(value)` that returns +value+ unchanged, or a Range when +value+ contains
+        # Ruby range syntax (`..` for inclusive, `...` for exclusive).
+        #
+        # Note: methods here must refer to Ruby's core Range class as `::Range` — a bare
+        # `Range` would resolve to this module (Mutators::Common::Range) instead, since
+        # Ruby's constant lookup checks the lexical scope before the top level.
+        module Range
+          ##
+          # Coerces a raw filter param into its original value or a Range.
+          #
+          # @param value [String] the raw filter param value
+          # @return [String,::Range] the original value, or a Range when the value contains range syntax
+          #                          (`..` or `...`)
+          def call(value)
+            range_dots = inclusive_or_exclusive_range(value)
+
+            return value if range_dots.blank?
+
+            range(value, range_dots)
+          end
+
+          ##
+          # Builds a Range by splitting +value+ on the given range dots.
+          #
+          # @param value [String] the raw range string, e.g. "1..10"
+          # @param dots [String] the range separator, either ".." or "..."
+          # @return [::Range] the resulting range, exclusive when +dots+ is "..."
+          def range(value, dots)
+            ::Range.new(*value.split(dots), dots == "...")
+          end
+
+          ##
+          # Detects whether +value+ contains inclusive or exclusive range syntax.
+          #
+          # @param value [String] the raw filter param value
+          # @return [String,nil] "..." for an exclusive range, ".." for an inclusive range, or nil if +value+ is not
+          #                      a range
+          def inclusive_or_exclusive_range(value)
+            return "..." if value.include?("...")
+            return ".." if value.include?("..")
+
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toller/filters/mutators/date.rb

@@ -8,43 +8,7 @@ module Toller
       ##
       # Date filter mutator
       module Date
-        module_function
-
-        ##
-        # Coerces a raw filter param into a date value or range.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,Range] the original value, or a Range when the value contains range syntax (`..` or `...`)
-        def call(value)
-          range_dots = inclusive_or_exclusive_range(value)
-
-          return value if range_dots.blank?
-
-          range(value, range_dots)
-        end
-
-        ##
-        # Builds a Range by splitting +value+ on the given range dots.
-        #
-        # @param value [String] the raw range string, e.g. "2024-01-01..2024-12-31"
-        # @param dots [String] the range separator, either ".." or "..."
-        # @return [Range] the resulting range
-        def range(value, dots)
-          Range.new(*value.split(dots))
-        end
-
-        ##
-        # Detects whether +value+ contains inclusive or exclusive range syntax.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,nil] "..." for an exclusive range, ".." for an inclusive range, or nil if +value+ is not
-        #                      a range
-        def inclusive_or_exclusive_range(value)
-          return "..." if value.include?("...")
-          return ".." if value.include?("..")
-
-          nil
-        end
+        extend Common::Range
       end
     end
   end

data/lib/toller/filters/mutators/datetime.rb

@@ -8,43 +8,7 @@ module Toller
       ##
       # Datetime filter mutator
       module Datetime
-        module_function
-
-        ##
-        # Coerces a raw filter param into a datetime value or range.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,Range] the original value, or a Range when the value contains range syntax (`..` or `...`)
-        def call(value)
-          range_dots = inclusive_or_exclusive_range(value)
-
-          return value if range_dots.blank?
-
-          range(value, range_dots)
-        end
-
-        ##
-        # Builds a Range by splitting +value+ on the given range dots.
-        #
-        # @param value [String] the raw range string, e.g. "2024-01-01..2024-12-31"
-        # @param dots [String] the range separator, either ".." or "..."
-        # @return [Range] the resulting range
-        def range(value, dots)
-          Range.new(*value.split(dots))
-        end
-
-        ##
-        # Detects whether +value+ contains inclusive or exclusive range syntax.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,nil] "..." for an exclusive range, ".." for an inclusive range, or nil if +value+ is not
-        #                      a range
-        def inclusive_or_exclusive_range(value)
-          return "..." if value.include?("...")
-          return ".." if value.include?("..")
-
-          nil
-        end
+        extend Common::Range
       end
     end
   end

data/lib/toller/filters/mutators/integer.rb

@@ -8,51 +8,7 @@ module Toller
       ##
       # Integer filter mutator
       module Integer
-        module_function
-
-        ##
-        # Coerces a raw filter param into an integer value or range.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String, Range] the original value, or a Range when the value contains range syntax (`..` or `...`)
-        def call(value)
-          return value unless range?(value)
-
-          range(value)
-        end
-
-        ##
-        # Checks whether +value+ contains range syntax.
-        #
-        # @param value [String] the raw filter param value
-        # @return [Boolean] true if +value+ contains `..` or `...`
-        def range?(value)
-          range_dots = inclusive_or_exclusive_range(value)
-
-          range_dots.present?
-        end
-
-        ##
-        # Builds a Range by splitting +value+ on its range dots.
-        #
-        # @param value [String] the raw range string, e.g. "1..10"
-        # @return [Range] the resulting range
-        def range(value)
-          Range.new(*value.split(inclusive_or_exclusive_range(value)))
-        end
-
-        ##
-        # Detects whether +value+ contains inclusive or exclusive range syntax.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,nil] "..." for an exclusive range, ".." for an inclusive range, or nil if +value+ is not
-        #                      a range
-        def inclusive_or_exclusive_range(value)
-          return "..." if value.include?("...")
-          return ".." if value.include?("..")
-
-          nil
-        end
+        extend Common::Range
       end
     end
   end

data/lib/toller/filters/mutators/time.rb

@@ -8,43 +8,7 @@ module Toller
       ##
       # Time filter mutator
       module Time
-        module_function
-
-        ##
-        # Coerces a raw filter param into a time value or range.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,Range] the original value, or a Range when the value contains range syntax (`..` or `...`)
-        def call(value)
-          range_dots = inclusive_or_exclusive_range(value)
-
-          return value if range_dots.blank?
-
-          range(value, range_dots)
-        end
-
-        ##
-        # Builds a Range by splitting +value+ on the given range dots.
-        #
-        # @param value [String] the raw range string, e.g. "09:00..17:00"
-        # @param dots [String] the range separator, either ".." or "..."
-        # @return [Range] the resulting range
-        def range(value, dots)
-          Range.new(*value.split(dots))
-        end
-
-        ##
-        # Detects whether +value+ contains inclusive or exclusive range syntax.
-        #
-        # @param value [String] the raw filter param value
-        # @return [String,nil] "..." for an exclusive range, ".." for an inclusive range, or nil if +value+ is not
-        #                      a range
-        def inclusive_or_exclusive_range(value)
-          return "..." if value.include?("...")
-          return ".." if value.include?("..")
-
-          nil
-        end
+        extend Common::Range
       end
     end
   end

data/lib/toller/filters/scope_handler.rb

@@ -9,13 +9,21 @@ module Toller
       ##
       # Applies a named scope to +collection+ for a `type: :scope` filter.
       #
+      # If the resolved scope doesn't exist on the collection's model, the
+      # filter is logged and skipped instead of raising a NoMethodError.
+      #
       # @param collection [ActiveRecord::Relation] the collection to filter
       # @param value [Object] the filter param value to pass to the scope
       # @param properties [Hash] the filter's properties, used to resolve `:scope_name` (falling back to `:field`)
-      # @return [ActiveRecord::Relation] the scoped collection
+      # @return [ActiveRecord::Relation] the scoped collection, or +collection+ unchanged if the scope is unknown
       def call(collection, value, properties)
         scoped_name = properties[:scope_name] || properties[:field]
 
+        unless collection.klass.respond_to?(scoped_name)
+          Rails.logger.warn("[Toller] Skipping filter: #{collection.klass} has no scope `#{scoped_name}`")
+          return collection
+        end
+
         collection.public_send(scoped_name, value)
       end
     end

data/lib/toller/sort.rb

@@ -42,7 +42,7 @@ module Toller
       if type == :scope
         Sorts::ScopeHandler.new.call(collection, direction, properties)
       else
-        Sorts::OrderHandler.new.call(collection, direction, properties)
+        Sorts::ColumnHandler.new.call(collection, direction, properties)
       end
     end
 

data/lib/toller/sorts/{order_handler.rb → column_handler.rb}

@@ -4,18 +4,26 @@ module Toller
   # :nodoc:
   module Sorts
     ##
-    # Order handler for filter
-    class OrderHandler
+    # Column handler for filter
+    class ColumnHandler
       ##
       # Applies a plain `order` clause to +collection+ for a non-scope sort.
       #
+      # If +field+ isn't a real column on the collection's model, the sort is
+      # logged and skipped instead of raising once the relation is evaluated.
+      #
       # @param collection [ActiveRecord::Relation] the collection to sort
       # @param direction [Symbol] the sort direction, :asc or :desc
       # @param properties [Hash] the sort's properties, used to resolve `:field`
-      # @return [ActiveRecord::Relation] the sorted collection
+      # @return [ActiveRecord::Relation] the sorted collection, or +collection+ unchanged if `:field` is unknown
       def call(collection, direction, properties)
         field_name = properties[:field]
 
+        unless collection.klass.column_names.include?(field_name.to_s)
+          Rails.logger.warn("[Toller] Skipping sort: #{collection.klass} has no column `#{field_name}`")
+          return collection
+        end
+
         collection.order(field_name => direction)
       end
     end

data/lib/toller/sorts/scope_handler.rb

@@ -9,13 +9,21 @@ module Toller
       ##
       # Applies a named scope to +collection+ for a `type: :scope` sort.
       #
+      # If the resolved scope doesn't exist on the collection's model, the
+      # sort is logged and skipped instead of raising a NoMethodError.
+      #
       # @param collection [ActiveRecord::Relation] the collection to sort
       # @param direction [Symbol] the sort direction, :asc or :desc, passed to the scope
       # @param properties [Hash] the sort's properties, used to resolve `:scope_name` (falling back to `:field`)
-      # @return [ActiveRecord::Relation] the scoped collection
+      # @return [ActiveRecord::Relation] the scoped collection, or +collection+ unchanged if the scope is unknown
       def call(collection, direction, properties)
         scoped_name = properties[:scope_name] || properties[:field]
 
+        unless collection.klass.respond_to?(scoped_name)
+          Rails.logger.warn("[Toller] Skipping sort: #{collection.klass} has no scope `#{scoped_name}`")
+          return collection
+        end
+
         collection.public_send(scoped_name, direction)
       end
     end

data/lib/toller/version.rb

@@ -2,5 +2,5 @@
 
 module Toller
   # @return [String] the current gem version
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/toller.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 require "toller/filter"
+require "toller/filters/column_handler"
 require "toller/filters/mutators/boolean"
+require "toller/filters/mutators/common/range"
 require "toller/filters/mutators/date"
 require "toller/filters/mutators/datetime"
 require "toller/filters/mutators/integer"
 require "toller/filters/mutators/time"
 require "toller/filters/scope_handler"
-require "toller/filters/where_handler"
 require "toller/retriever"
 require "toller/sort"
-require "toller/sorts/order_handler"
+require "toller/sorts/column_handler"
 require "toller/sorts/scope_handler"
 
 ##
@@ -20,6 +21,18 @@ require "toller/sorts/scope_handler"
 module Toller
   extend ActiveSupport::Concern
 
+  ##
+  # Coerces a raw string value into a boolean, using the same rule Toller's
+  # own `type: :boolean` filters use internally. Handy inside a model scope
+  # backing a `type: :scope` filter, which receives the raw param value
+  # unmutated.
+  #
+  # @param value [String] the raw value
+  # @return [Boolean] true if +value+ is one of "1", "t", "true", "y", "yes"; false otherwise
+  def self.truthy(value)
+    Filters::Mutators::Boolean.call(value)
+  end
+
   ##
   # Applies every active filter/sort for the current request to +collection+.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toller
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - David Freerksen
@@ -37,16 +37,17 @@ files:
 - Rakefile
 - lib/toller.rb
 - lib/toller/filter.rb
+- lib/toller/filters/column_handler.rb
 - lib/toller/filters/mutators/boolean.rb
+- lib/toller/filters/mutators/common/range.rb
 - lib/toller/filters/mutators/date.rb
 - lib/toller/filters/mutators/datetime.rb
 - lib/toller/filters/mutators/integer.rb
 - lib/toller/filters/mutators/time.rb
 - lib/toller/filters/scope_handler.rb
-- lib/toller/filters/where_handler.rb
 - lib/toller/retriever.rb
 - lib/toller/sort.rb
-- lib/toller/sorts/order_handler.rb
+- lib/toller/sorts/column_handler.rb
 - lib/toller/sorts/scope_handler.rb
 - lib/toller/version.rb
 homepage: https://github.com/dfreerksen/toller