Module: DuckRecord::Reflection::ClassMethods

Defined in:
lib/duck_record/reflection.rb

Overview

Reflection enables the ability to examine the associations and aggregations of Active Record classes and objects. This information, for example, can be used in a form builder that takes an Active Record object and creates input fields for all of the attributes depending on their type and displays the associations to other objects.

MacroReflection class has info for AggregateReflection and AssociationReflection classes.

Instance Method Summary collapse

Instance Method Details

#_reflect_on_association(association) ⇒ Object

:nodoc:



91
92
93
 
# File 'lib/duck_record/reflection.rb', line 91

def _reflect_on_association(association) #:nodoc:
  _reflections[association.to_s]
end

#clear_reflections_cache ⇒ Object

:nodoc:



95
96
97
 
# File 'lib/duck_record/reflection.rb', line 95

def clear_reflections_cache # :nodoc:
  @__reflections = nil
end

#reflect_on_all_associations(macro = nil) ⇒ Object

Returns an array of AssociationReflection objects for all the associations in the class. If you only want to reflect on a certain association type, pass in the symbol (:has_many, :has_one, :belongs_to) as the first parameter.

Example:

Account.reflect_on_all_associations             # returns an array of all associations
Account.reflect_on_all_associations(:has_many)  # returns an array of all has_many associations



76
77
78
79
80
 
# File 'lib/duck_record/reflection.rb', line 76

def reflect_on_all_associations(macro = nil)
  association_reflections = reflections.values
  association_reflections.select! { |reflection| reflection.macro == macro } if macro
  association_reflections
end

#reflect_on_association(association) ⇒ Object

Returns the AssociationReflection object for the association (use the symbol).

Account.reflect_on_association(:owner)             # returns the owner AssociationReflection
Invoice.reflect_on_association(:line_items).macro  # returns :has_many



87
88
89
 
# File 'lib/duck_record/reflection.rb', line 87

def reflect_on_association(association)
  reflections[association.to_s]
end

#reflections ⇒ Object

Returns a Hash of name of the reflection as the key and an AssociationReflection as the value.

Account.reflections # => {"balance" => AggregateReflection}



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/duck_record/reflection.rb', line 47

def reflections
  @__reflections ||= begin
    ref = {}

    _reflections.each do |name, reflection|
      parent_reflection = reflection.parent_reflection

      if parent_reflection
        parent_name = parent_reflection.name
        ref[parent_name.to_s] = parent_reflection
      else
        ref[name] = reflection
      end
    end

    ref
  end
end