Class: Toller::Filters::ScopeHandler

Inherits:
Object
  • Object
show all
Defined in:
lib/toller/filters/scope_handler.rb

Overview

Scope handler for filter

Instance Method Summary collapse

Instance Method Details

#call(collection, value, properties) ⇒ ActiveRecord::Relation

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.

Parameters:

  • collection (ActiveRecord::Relation) —

    the collection to filter

  • value (Object) —

    the filter param value to pass to the scope

  • properties (Hash) —

    the filter's properties, used to resolve :scope_name (falling back to :field)

Returns:

  • (ActiveRecord::Relation) —

    the scoped collection, or collection unchanged if the scope is unknown



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/toller/filters/scope_handler.rb', line 19

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