From 2aa9388746412bc88be6a1728ecfbcc8ceacbb30 Mon Sep 17 00:00:00 2001
From: Jon Leighton <j@jonathanleighton.com>
Date: Tue, 19 Oct 2010 17:40:14 +0100
Subject: Add some comments for ThroughReflection#through_reflection_chain
---
activerecord/lib/active_record/reflection.rb | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/activerecord/lib/active_record/reflection.rb b/activerecord/lib/active_record/reflection.rb
index 1ea892895f..824674ee1d 100644
--- a/activerecord/lib/active_record/reflection.rb
+++ b/activerecord/lib/active_record/reflection.rb
@@ -368,7 +368,16 @@ module ActiveRecord
@through_reflection ||= active_record.reflect_on_association(options[:through])
end
- # TODO: Documentation
+ # Returns an array of AssociationReflection objects which are involved in this through
+ # association. Each item in the array corresponds to a table which will be part of the
+ # query for this association.
+ #
+ # If the source reflection is itself a ThroughReflection, then we don't include self in
+ # the chain, but just defer to the source reflection.
+ #
+ # The chain is built by recursively calling through_reflection_chain on the source
+ # reflection and the through reflection. The base case for the recursion is a normal
+ # association, which just returns [self] for its through_reflection_chain.
def through_reflection_chain
@through_reflection_chain ||= begin
if source_reflection.source_reflection
--
cgit v1.2.3