diff options
| author | Stan Lo <[email protected]> | 2024-07-02 11:14:56 +0100 |
|---|---|---|
| committer | git <[email protected]> | 2024-07-02 10:15:00 +0000 |
| commit | d7af8afe1b85b8de04cd77c673b0f6ef3f3627fa (patch) | |
| tree | 84776ba8b6a7ef72ca5520cf900aa9e5f991ad89 /lib/rdoc/require.rb | |
| parent | 1ab31eb4294132a0fb3282755843575da87f0918 (diff) | |
[ruby/rdoc] Group code object files into the same directory
(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
https://github.com/ruby/rdoc/commit/4211292ffe
Diffstat (limited to 'lib/rdoc/require.rb')
| -rw-r--r-- | lib/rdoc/require.rb | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/lib/rdoc/require.rb b/lib/rdoc/require.rb deleted file mode 100644 index 05e26b84b0..0000000000 --- a/lib/rdoc/require.rb +++ /dev/null @@ -1,51 +0,0 @@ -# frozen_string_literal: true -## -# A file loaded by \#require - -class RDoc::Require < RDoc::CodeObject - - ## - # Name of the required file - - attr_accessor :name - - ## - # Creates a new Require that loads +name+ with +comment+ - - def initialize(name, comment) - super() - @name = name.gsub(/'|"/, "") #' - @top_level = nil - self.comment = comment - end - - def inspect # :nodoc: - "#<%s:0x%x require '%s' in %s>" % [ - self.class, - object_id, - @name, - parent_file_name, - ] - end - - def to_s # :nodoc: - "require #{name} in: #{parent}" - end - - ## - # The RDoc::TopLevel corresponding to this require, or +nil+ if not found. - - def top_level - @top_level ||= begin - tl = RDoc::TopLevel.all_files_hash[name + '.rb'] - - if tl.nil? and RDoc::TopLevel.all_files.first.full_name =~ %r(^lib/) then - # second chance - tl = RDoc::TopLevel.all_files_hash['lib/' + name + '.rb'] - end - - tl - end - end - -end |