Module: Filterameter

Defined in:
lib/filterameter.rb,
lib/filterameter/version.rb,
lib/filterameter/exceptions.rb,
lib/filterameter/configuration.rb,
lib/filterameter/filter_factory.rb,
lib/filterameter/log_subscriber.rb,
lib/filterameter/parameters_base.rb,
lib/filterameter/controller_filters.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/filters/conditional_scope_filter.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: DeclarativeFilters, Exceptions, Filters Classes: Configuration, ControllerFilters, FilterDeclaration, FilterFactory, LogSubscriber, ParametersBase

Constant Summary collapse

VERSION =
'0.1.4'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configurationObject



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

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

Class Method Details

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

Yields:



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

def self.configure
  yield(configuration)
end

.resetObject



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

def self.reset
  @configuration = Configuration.new
end