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.

Defined Under Namespace

Classes: DescendantsArray

Constant Summary collapse

@@direct_descendants =
{}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.clearObject


24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 24

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

.descendants(klass) ⇒ Object


18
19
20
21
22
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 18

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

.direct_descendants(klass) ⇒ Object


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

def direct_descendants(klass)
  descendants = @@direct_descendants[klass]
  descendants ? descendants.to_a : []
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.


40
41
42
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 40

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

.subclassesObject


16
17
18
19
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 16

def direct_descendants(klass)
  descendants = @@direct_descendants[klass]
  descendants ? descendants.to_a : []
end

Instance Method Details

#descendantsObject


65
66
67
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 65

def descendants
  DescendantsTracker.descendants(self)
end

#direct_descendantsObject Also known as: subclasses


60
61
62
# File 'activesupport/lib/active_support/descendants_tracker.rb', line 60

def direct_descendants
  DescendantsTracker.direct_descendants(self)
end

#inherited(base) ⇒ Object


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

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