Module: ActiveSupport::DescendantsTracker

Included in:
AbstractController::Base, ActionMailer::Preview, ActiveRecord::Base
Defined in:
activesupport/lib/active_support/descendants_tracker.rb

Overview

This module provides an internal implementation to track descendants which is faster than iterating through ObjectSpace.

Constant Summary collapse

@@direct_descendants = 
{}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.clear ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 18

def clear
  if defined? ActiveSupport::Dependencies
    @@direct_descendants.each do |klass, descendants|
      if ActiveSupport::Dependencies.autoloaded?(klass)
        @@direct_descendants.delete(klass)
      else
        descendants.reject! { |v| ActiveSupport::Dependencies.autoloaded?(v) }
      end
    end
  else
    @@direct_descendants.clear
  end
end

.descendants(klass) ⇒ Object 



12
13
14
15
16
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 12

def descendants(klass)
  arr = []
  accumulate_descendants(klass, arr)
  arr
end

.direct_descendants(klass) ⇒ Object 



8
9
10
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 8

def direct_descendants(klass)
  @@direct_descendants[klass] || []
end

.store_inherited(klass, descendant) ⇒ Object

This is the only method that is not thread safe, but is only ever called during the eager loading phase.



34
35
36
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 34

def store_inherited(klass, descendant)
  (@@direct_descendants[klass] ||= []) << descendant
end

Instance Method Details

#descendants ⇒ Object 



56
57
58
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 56

def descendants
  DescendantsTracker.descendants(self)
end

#direct_descendants ⇒ Object 



52
53
54
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 52

def direct_descendants
  DescendantsTracker.direct_descendants(self)
end

#inherited(base) ⇒ Object 



47
48
49
50
 
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 47

def inherited(base)
  DescendantsTracker.store_inherited(self, base)
  super
end