Module: Ooor::Reflection::ClassMethods
- Defined in:
- lib/ooor/reflection.rb
Overview
Reflection enables to interrogate Active Record classes and objects about their associations and aggregations. This information can, for example, 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
- #create_reflection(macro, name, options, active_record) ⇒ Object
-
#reflect_on_aggregation(aggregation) ⇒ Object
Returns the AggregateReflection object for the named
aggregation
(use the symbol). -
#reflect_on_all_aggregations ⇒ Object
Returns an array of AggregateReflection objects for all the aggregations in the class.
-
#reflect_on_all_associations(macro = nil) ⇒ Object
Returns an array of AssociationReflection objects for all the associations in the class.
-
#reflect_on_all_autosave_associations ⇒ Object
Returns an array of AssociationReflection objects for all associations which have
:autosave
enabled. -
#reflect_on_association(association) ⇒ Object
Returns the AssociationReflection object for the
association
(use the symbol).
Instance Method Details
#create_reflection(macro, name, options, active_record) ⇒ Object
26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/ooor/reflection.rb', line 26 def create_reflection(macro, name, , active_record) case macro when :has_many, :belongs_to, :has_one, :has_and_belongs_to_many klass = [:through] ? ThroughReflection : AssociationReflection reflection = klass.new(macro, name, , active_record) when :composed_of reflection = AggregateReflection.new(macro, name, , active_record) end self.reflections = self.reflections.merge(name => reflection) reflection end |
#reflect_on_aggregation(aggregation) ⇒ Object
Returns the AggregateReflection object for the named aggregation
(use the symbol).
Account.reflect_on_aggregation(:balance) # => the balance AggregateReflection
48 49 50 |
# File 'lib/ooor/reflection.rb', line 48 def reflect_on_aggregation(aggregation) reflections[aggregation].is_a?(AggregateReflection) ? reflections[aggregation] : nil end |
#reflect_on_all_aggregations ⇒ Object
Returns an array of AggregateReflection objects for all the aggregations in the class.
40 41 42 |
# File 'lib/ooor/reflection.rb', line 40 def reflect_on_all_aggregations reflections.values.grep(AggregateReflection) 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
62 63 64 65 |
# File 'lib/ooor/reflection.rb', line 62 def reflect_on_all_associations(macro = nil) association_reflections = reflections.values.grep(AssociationReflection) macro ? association_reflections.select { |reflection| reflection.macro == macro } : association_reflections end |
#reflect_on_all_autosave_associations ⇒ Object
Returns an array of AssociationReflection objects for all associations which have :autosave
enabled.
77 78 79 |
# File 'lib/ooor/reflection.rb', line 77 def reflect_on_all_autosave_associations reflections.values.select { |reflection| reflection.[:autosave] } 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
72 73 74 |
# File 'lib/ooor/reflection.rb', line 72 def reflect_on_association(association) reflections[association].is_a?(AssociationReflection) ? reflections[association] : nil end |