mirror of
https://github.com/ruby/ruby.git
synced 2025-08-16 05:59:00 +02:00
d7af8afe1b
(https://github.com/ruby/rdoc/pull/1114)
It's hard to distinguish code object classes by their file names alone.
And given that we have 18 such classes, it'd make the codebase a lot
easier to understand if we grouped them into a single directory.
Given that these classes are all autoloaded in `lib/rdoc.rb` instead
of required individually, this change should have minimum impact on
projects using RDoc as they generally just require `rdoc`, not individual
files. An example is Rails' `sdoc`:
https://github.com/rails/sdoc/blob/main/lib/sdoc/rdoc_monkey_patches.rb
4211292ffe
120 lines
2.8 KiB
Ruby
120 lines
2.8 KiB
Ruby
# frozen_string_literal: true
|
|
##
|
|
# A Mixin adds features from a module into another context. RDoc::Include and
|
|
# RDoc::Extend are both mixins.
|
|
|
|
class RDoc::Mixin < RDoc::CodeObject
|
|
|
|
##
|
|
# Name of included module
|
|
|
|
attr_accessor :name
|
|
|
|
##
|
|
# Creates a new Mixin for +name+ with +comment+
|
|
|
|
def initialize(name, comment)
|
|
super()
|
|
@name = name
|
|
self.comment = comment
|
|
@module = nil # cache for module if found
|
|
end
|
|
|
|
##
|
|
# Mixins are sorted by name
|
|
|
|
def <=> other
|
|
return unless self.class === other
|
|
|
|
name <=> other.name
|
|
end
|
|
|
|
def == other # :nodoc:
|
|
self.class === other and @name == other.name
|
|
end
|
|
|
|
alias eql? == # :nodoc:
|
|
|
|
##
|
|
# Full name based on #module
|
|
|
|
def full_name
|
|
m = self.module
|
|
RDoc::ClassModule === m ? m.full_name : @name
|
|
end
|
|
|
|
def hash # :nodoc:
|
|
[@name, self.module].hash
|
|
end
|
|
|
|
def inspect # :nodoc:
|
|
"#<%s:0x%x %s.%s %s>" % [
|
|
self.class,
|
|
object_id,
|
|
parent_name, self.class.name.downcase, @name,
|
|
]
|
|
end
|
|
|
|
##
|
|
# Attempts to locate the included module object. Returns the name if not
|
|
# known.
|
|
#
|
|
# The scoping rules of Ruby to resolve the name of an included module are:
|
|
# - first look into the children of the current context;
|
|
# - if not found, look into the children of included modules,
|
|
# in reverse inclusion order;
|
|
# - if still not found, go up the hierarchy of names.
|
|
#
|
|
# This method has <code>O(n!)</code> behavior when the module calling
|
|
# include is referencing nonexistent modules. Avoid calling #module until
|
|
# after all the files are parsed. This behavior is due to ruby's constant
|
|
# lookup behavior.
|
|
#
|
|
# As of the beginning of October, 2011, no gem includes nonexistent modules.
|
|
|
|
def module
|
|
return @module if @module
|
|
|
|
# search the current context
|
|
return @name unless parent
|
|
full_name = parent.child_name(@name)
|
|
@module = @store.modules_hash[full_name]
|
|
return @module if @module
|
|
return @name if @name =~ /^::/
|
|
|
|
# search the includes before this one, in reverse order
|
|
searched = parent.includes.take_while { |i| i != self }.reverse
|
|
searched.each do |i|
|
|
inc = i.module
|
|
next if String === inc
|
|
full_name = inc.child_name(@name)
|
|
@module = @store.modules_hash[full_name]
|
|
return @module if @module
|
|
end
|
|
|
|
# go up the hierarchy of names
|
|
up = parent.parent
|
|
while up
|
|
full_name = up.child_name(@name)
|
|
@module = @store.modules_hash[full_name]
|
|
return @module if @module
|
|
up = up.parent
|
|
end
|
|
|
|
@name
|
|
end
|
|
|
|
##
|
|
# Sets the store for this class or module and its contained code objects.
|
|
|
|
def store= store
|
|
super
|
|
|
|
@file = @store.add_file @file.full_name if @file
|
|
end
|
|
|
|
def to_s # :nodoc:
|
|
"#{self.class.name.downcase} #@name in: #{parent}"
|
|
end
|
|
|
|
end
|