Module: Filterameter

Defined in:
lib/filterameter.rb,
lib/filterameter/version.rb,
lib/filterameter/exceptions.rb,
lib/filterameter/filterable.rb,
lib/filterameter/configuration.rb,
lib/filterameter/query_builder.rb,
lib/filterameter/filter_factory.rb,
lib/filterameter/log_subscriber.rb,
lib/filterameter/filter_registry.rb,
lib/filterameter/parameters_base.rb,
lib/filterameter/coordinators/base.rb,
lib/filterameter/filter_declaration.rb,
lib/filterameter/declarative_filters.rb,
lib/filterameter/filters/arel_filter.rb,
lib/filterameter/filters/scope_filter.rb,
lib/filterameter/filters/nested_filter.rb,
lib/filterameter/filters/matches_filter.rb,
lib/filterameter/filters/maximum_filter.rb,
lib/filterameter/filters/minimum_filter.rb,
lib/filterameter/filters/attribute_filter.rb,
lib/filterameter/exceptions/validation_error.rb,
lib/filterameter/coordinators/query_coordinator.rb,
lib/filterameter/declarative_controller_filters.rb,
lib/filterameter/validators/inclusion_validator.rb,
lib/filterameter/filters/conditional_scope_filter.rb,
lib/filterameter/coordinators/controller_coordinator.rb,
lib/filterameter/exceptions/undeclared_parameter_error.rb,
lib/filterameter/exceptions/cannot_determine_model_error.rb

Overview

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.

Defined Under Namespace

Modules: Coordinators, DeclarativeControllerFilters, DeclarativeFilters, Exceptions, Filterable, Filters, Validators Classes: Configuration, FilterDeclaration, FilterFactory, FilterRegistry, LogSubscriber, ParametersBase, QueryBuilder

Constant Summary collapse

VERSION = 
'0.3.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object 



20
21
22
 
# File 'lib/filterameter.rb', line 20

def self.configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Yields:



28
29
30
 
# File 'lib/filterameter.rb', line 28

def self.configure
  yield(configuration)
end

.reset ⇒ Object 



24
25
26
 
# File 'lib/filterameter.rb', line 24

def self.reset
  @configuration = Configuration.new
end