edge badge

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

Methods
C
D
I
S
Class Public methods
clear()
# File activesupport/lib/active_support/descendants_tracker.rb, line 23
def clear
  if defined? ActiveSupport::Dependencies
    # to_unload? is only defined in Zeitwerk mode.
    to_unload = if Dependencies.respond_to?(:to_unload?)
      ->(klass) { Dependencies.to_unload?(klass.name) }
    else
      ->(klass) { Dependencies.autoloaded?(klass) }
    end

    @@direct_descendants.each do |klass, descendants|
      if to_unload[klass]
        @@direct_descendants.delete(klass)
      else
        descendants.reject! { |v| to_unload[v] }
      end
    end
  else
    @@direct_descendants.clear
  end
end
descendants(klass)
# File activesupport/lib/active_support/descendants_tracker.rb, line 17
def descendants(klass)
  arr = []
  accumulate_descendants(klass, arr)
  arr
end
direct_descendants(klass)
# 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)

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

# File activesupport/lib/active_support/descendants_tracker.rb, line 46
def store_inherited(klass, descendant)
  (@@direct_descendants[klass] ||= DescendantsArray.new) << descendant
end
Instance Public methods
descendants()
# File activesupport/lib/active_support/descendants_tracker.rb, line 71
def descendants
  DescendantsTracker.descendants(self)
end
direct_descendants()
# File activesupport/lib/active_support/descendants_tracker.rb, line 67
def direct_descendants
  DescendantsTracker.direct_descendants(self)
end
inherited(base)
# File activesupport/lib/active_support/descendants_tracker.rb, line 62
def inherited(base)
  DescendantsTracker.store_inherited(self, base)
  super
end