Class Hoodoo::ActiveRecord::Support < Object

Back-end of sorts for ::full_scope_for. Given a base scope (e.g. 'Model.all'), applies all available appropriate scoping additions included by that model, such as Hoodoo::ActiveRecord::Secure and Hoodoo::ActiveRecord::Translated, except for the dating modules Hoodoo::ActiveRecord::Dated and Hoodoo::ActiveRecord::ManuallyDated.

If you wish to use dating as well, call ::full_scope_for instead.

base_scope

The ActiveRecord::Relation instance providing the base scope to which additions will be made.

klass

The ActiveRecord::Base subclass class (not instance) which is making the call here. This is the entity which is checked for module inclusions to determine how the query chain should be assembled.

context

Hoodoo::Services::Context instance describing a call context. This is typically a value passed to one of the Hoodoo::Services::Implementation instance methods that a resource subclass implements.

Returns the given input scope, with additional conditions added for any Hoodoo ActiveRecord extension modules included by the ActiveRecord model class that the scope targets.

Returns a (newly generated) Hash of search keys mapping to helper Procs which are in the same format as would be passed to Hoodoo::ActiveRecord::Finder::ClassMethods#search_with or Hoodoo::ActiveRecord::Finder::ClassMethods#filter_with, describing the default framework search parameters. The middleware defines keys, but each ORM adapter module must specify how those keys actually get used to search inside supported database engines.

Given an ActiveRecord class and Hoodoo request context, work out which Hoodoo support modules are included within this class and call base methods to provide a fully specified basic query chain obeying all the necessary aspects of the ActiveRecord model class and the request.

Each of the following are called if the owning module is included:

• Hoodoo::ActiveRecord::Secure#secure

• Hoodoo::ActiveRecord::Translated#translated

• Hoodoo::ActiveRecord::Dated#dated (if “dating_enabled?” is true)

• Hoodoo::ActiveRecord::ManuallyDated#manually_dated (if “manual_dating_enabled?” is true)

klass

The ActiveRecord::Base subclass class (not instance) which is making the call here. This is the entity which is checked for module inclusions to determine how the query chain should be assembled.

context

Hoodoo::Services::Context instance describing a call context. This is typically a value passed to one of the Hoodoo::Services::Implementation instance methods that a resource subclass implements.

Returns an ActiveRecord::Relation instance which is anything from a generic anonymous scope, all the way through to a secured, translated, backdated scope for use with subsequent query refinements.

Takes a Hash of possibly-non-String keys and with nil values or Proc instances appropriate for Hoodoo::ActiveRecord::Finder::ClassMethods#search_with / Hoodoo::ActiveRecord::Finder::ClassMethods#filter_with. Returns a similar Hash with all-String keys and a Proc for every value.

hash

Hash Symbol or String keys and Proc instance or nil values.

When given an ActiveRecord model instance which may have errors set on it as a result of a prior validate or save call, map any found errors from ActiveRecord to a Hoodoo::Errors instance. The mapping is comprehensive; it even checks the data type of errant columns and tries to find a generic... family error to use for mapped result (e.g. generic.invalid_string or generic.invalid_integer).

Usually, the Hoodoo:ActiveRecord::ErrorMapping mixin is included into an ActiveRecord model directly and this method is therefore not used directly; Hoodoo:ActiveRecord::ErrorMapping.adds_errors_to? or similar is called instead.

Associations

When a model has associations and nested attributes are accepted for those associations, a validity query on an instance constructed with nested attributes will cause ActiveRecord to traverse all such attributes and aggregate specific errors on the parent object. This is specifically different from validates_associated, wherein associations constructed and attached through any means are validated independently, with validation errors independently added to those objects and the parent only gaining a generic “foo is invalid” error.

In such cases, the error mapper will attempt to path-traverse the error's column references to determine the association's column type and produce a fully mapped error with a reference to the full path. Service authors are encouraged to use this approach if associations are involved, as it yields the most comprehensive mapped error collection.

In the example below, note how the Child model does not need to include Hoodoo error mapping (though it can do so harmlessly if it so wishes) because it is the Parent model that drives the mapping of all the validations aggregated by ActiveRecord into an instance of Parent due to accepts_nested_attributes_for.

So, given this:

def Parent < ActiveRecord::Base
  has_many :children
  accepts_nested_attributes_for :children
end

def Child < ActiveRecord::Base
  belongs_to :parent

  # ...then add ActiveRecord validations - e.g.:

  validates :some_child_field, :length => { :maximum => 5 }
end

…then if a Parent were to be constructed thus:

parent = Parent.new( {
  "parent_field_1" = "foo",
  "parent_field_2" = "bar",
  "children_attributes" = [
    { "some_child_field" = "child_1_foo" },
    { "some_child_field" = "child_2_foo" },
    # ...
  ],
  # ...
} )

…then translate_errors_on( parent ) could return a Hoodoo::Errors collection containing entries such as:

{
  "code"      => "generic.invalid_string",
  "message    => "is too long (maximum is 5 characters)",
  "reference" => "children.some_child_field"
}

model_instance

The ActiveRecord model which may have errors set as a result of a prior validation failure.

hoodoo_errors

Optional Hoodoo::Errors instance. If provided, any mapped errors are added onto this existing set. If omitted, the method returns a new collection.

Returns a new Hoodoo::Errors collection (which may have no errors in it, if the model had not validation errors) or the value given in the hoodoo_errors parameter with zero or more new errors added.