rdoc 5.1.0 → 6.13.1

data/lib/rdoc/{context → code_object/context}/section.rb

@@ -1,4 +1,6 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
+require 'cgi/util'
+
 ##
 # A section of documentation like:
 #
@@ -34,8 +36,6 @@ class RDoc::Context::Section
 
   attr_reader :title
 
-  @@sequence = "SEC00000"
-
   ##
   # Creates a new section with +title+ and +comment+
 
@@ -43,9 +43,6 @@ class RDoc::Context::Section
     @parent = parent
     @title = title ? title.strip : title
 
-    @@sequence.succ!
-    @sequence = @@sequence.dup
-
     @comments = []
 
     add_comment comment
@@ -64,19 +61,10 @@ class RDoc::Context::Section
   # Adds +comment+ to this section
 
   def add_comment comment
-    comment = extract_comment comment
-
-    return if comment.empty?
-
-    case comment
-    when RDoc::Comment then
-      @comments << comment
-    when RDoc::Markup::Document then
-      @comments.concat comment.parts
-    when Array then
-      @comments.concat comment
-    else
-      raise TypeError, "unknown comment type: #{comment.inspect}"
+    comments = Array(comment)
+    comments.each do |c|
+      extracted_comment = extract_comment(c)
+      @comments << extracted_comment unless extracted_comment.empty?
     end
   end
 
@@ -100,10 +88,6 @@ class RDoc::Context::Section
 
   def extract_comment comment
     case comment
-    when Array then
-      comment.map do |c|
-        extract_comment c
-      end
     when nil
       RDoc::Comment.new ''
     when RDoc::Comment then
@@ -118,8 +102,6 @@ class RDoc::Context::Section
                        end
       end
 
-      comment
-    when RDoc::Markup::Document then
       comment
     else
       raise TypeError, "unknown comment #{comment.inspect}"
@@ -138,20 +120,7 @@ class RDoc::Context::Section
   # The files comments in this section come from
 
   def in_files
-    return [] if @comments.empty?
-
-    case @comments
-    when Array then
-      @comments.map do |comment|
-        comment.file
-      end
-    when RDoc::Markup::Document then
-      @comment.parts.map do |document|
-        document.file
-      end
-    else
-      raise RDoc::Error, "BUG: unknown comment class #{@comments.class}"
-    end
+    @comments.map(&:file)
   end
 
   ##
@@ -173,7 +142,7 @@ class RDoc::Context::Section
     @parent  = nil
 
     @title    = array[1]
-    @comments = array[2]
+    @comments = array[2].parts.map { |doc| RDoc::Comment.from_document(doc) }
   end
 
   ##
@@ -181,26 +150,7 @@ class RDoc::Context::Section
   # multiple RDoc::Markup::Documents with their file set.
 
   def parse
-    case @comments
-    when String then
-      super
-    when Array then
-      docs = @comments.map do |comment, location|
-        doc = super comment
-        doc.file = location if location
-        doc
-      end
-
-      RDoc::Markup::Document.new(*docs)
-    when RDoc::Comment then
-      doc = super @comments.text, comments.format
-      doc.file = @comments.location
-      doc
-    when RDoc::Markup::Document then
-      return @comments
-    else
-      raise ArgumentError, "unknown comment class #{comments.class}"
-    end
+    RDoc::Markup::Document.new(*@comments.map(&:parse))
   end
 
   ##
@@ -216,30 +166,10 @@ class RDoc::Context::Section
   # Removes a comment from this section if it is from the same file as
   # +comment+
 
-  def remove_comment comment
-    return if @comments.empty?
-
-    case @comments
-    when Array then
-      @comments.delete_if do |my_comment|
-        my_comment.file == comment.file
-      end
-    when RDoc::Markup::Document then
-      @comments.parts.delete_if do |document|
-        document.file == comment.file.name
-      end
-    else
-      raise RDoc::Error, "BUG: unknown comment class #{@comments.class}"
+  def remove_comment target_comment
+    @comments.delete_if do |stored_comment|
+      stored_comment.file == target_comment.file
     end
   end
 
-  ##
-  # Section sequence number (deprecated)
-
-  def sequence
-    warn "RDoc::Context::Section#sequence is deprecated, use #aref"
-    @sequence
-  end
-
 end
-

data/lib/rdoc/{context.rb → code_object/context.rb}

@@ -1,6 +1,4 @@
-# frozen_string_literal: false
-require 'cgi'
-
+# frozen_string_literal: true
 ##
 # A Context is something that can hold modules, classes, methods, attributes,
 # aliases, requires, and includes. Classes, modules, and files are all
@@ -239,7 +237,7 @@ class RDoc::Context < RDoc::CodeObject
 
       if known then
         known.comment = attribute.comment if known.comment.empty?
-      elsif registered = @methods_hash[attribute.pretty_name << '='] and
+      elsif registered = @methods_hash[attribute.pretty_name + '='] and
             RDoc::Attr === registered then
         registered.rw = 'RW'
       else
@@ -249,7 +247,7 @@ class RDoc::Context < RDoc::CodeObject
     end
 
     if attribute.rw.index 'W' then
-      key = attribute.pretty_name << '='
+      key = attribute.pretty_name + '='
       known = @methods_hash[key]
 
       if known then
@@ -407,6 +405,7 @@ class RDoc::Context < RDoc::CodeObject
     mod.section = current_section # TODO declaring context? something is
                                   # wrong here...
     mod.parent = self
+    mod.full_name = nil
     mod.store = @store
 
     unless @done_documenting then
@@ -414,6 +413,10 @@ class RDoc::Context < RDoc::CodeObject
       # this must be done AFTER adding mod to its parent, so that the full
       # name is correct:
       all_hash[mod.full_name] = mod
+      if @store.unmatched_constant_alias[mod.full_name] then
+        to, file = @store.unmatched_constant_alias[mod.full_name]
+        add_module_alias mod, mod.name, to, file
+      end
     end
 
     mod
@@ -479,7 +482,7 @@ class RDoc::Context < RDoc::CodeObject
         known.comment = method.comment if known.comment.empty?
         previously = ", previously in #{known.file}" unless
           method.file == known.file
-        @store.rdoc.options.warn \
+        @store.options.warn \
           "Duplicate method #{known.full_name} in #{method.file}#{previously}"
       end
     else
@@ -510,41 +513,53 @@ class RDoc::Context < RDoc::CodeObject
     add_class_or_module mod, @modules, @store.modules_hash
   end
 
+  ##
+  # Adds a module by +RDoc::NormalModule+ instance. See also #add_module.
+
+  def add_module_by_normal_module(mod)
+    add_class_or_module mod, @modules, @store.modules_hash
+  end
+
   ##
   # Adds an alias from +from+ (a class or module) to +name+ which was defined
   # in +file+.
 
-  def add_module_alias from, name, file
+  def add_module_alias from, from_name, to, file
     return from if @done_documenting
 
-    to_name = child_name name
+    to_full_name = child_name to.name
 
     # if we already know this name, don't register an alias:
     # see the metaprogramming in lib/active_support/basic_object.rb,
     # where we already know BasicObject is a class when we find
     # BasicObject = BlankSlate
-    return from if @store.find_class_or_module to_name
+    return from if @store.find_class_or_module to_full_name
+
+    unless from
+      @store.unmatched_constant_alias[child_name(from_name)] = [to, file]
+      return to
+    end
 
-    to = from.dup
-    to.name = name
-    to.full_name = nil
+    new_to = from.dup
+    new_to.name = to.name
+    new_to.full_name = nil
 
-    if to.module? then
-      @store.modules_hash[to_name] = to
-      @modules[name] = to
+    if new_to.module? then
+      @store.modules_hash[to_full_name] = new_to
+      @modules[to.name] = new_to
     else
-      @store.classes_hash[to_name] = to
-      @classes[name] = to
+      @store.classes_hash[to_full_name] = new_to
+      @classes[to.name] = new_to
     end
 
     # Registers a constant for this alias.  The constant value and comment
     # will be updated later, when the Ruby parser adds the constant
-    const = RDoc::Constant.new name, nil, to.comment
+    const = RDoc::Constant.new to.name, nil, new_to.comment
     const.record_location file
     const.is_alias_for = from
     add_constant const
 
-    to
+    new_to
   end
 
   ##
@@ -673,13 +688,6 @@ class RDoc::Context < RDoc::CodeObject
     section
   end
 
-  ##
-  # Is part of this thing was defined in +file+?
-
-  def defined_in?(file)
-    @in_files.include?(file)
-  end
-
   def display(method_attr) # :nodoc:
     if method_attr.is_a? RDoc::Attr
       "#{method_attr.definition} #{method_attr.pretty_name}"
@@ -695,14 +703,7 @@ class RDoc::Context < RDoc::CodeObject
   # This method exists to make it easy to work with Context subclasses that
   # aren't part of RDoc.
 
-  def each_ancestor # :nodoc:
-  end
-
-  ##
-  # Iterator for attributes
-
-  def each_attribute # :yields: attribute
-    @attributes.each { |a| yield a }
+  def each_ancestor(&_) # :nodoc:
   end
 
   ##
@@ -712,27 +713,6 @@ class RDoc::Context < RDoc::CodeObject
     classes_and_modules.sort.each(&block)
   end
 
-  ##
-  # Iterator for constants
-
-  def each_constant # :yields: constant
-    @constants.each {|c| yield c}
-  end
-
-  ##
-  # Iterator for included modules
-
-  def each_include # :yields: include
-    @includes.each do |i| yield i end
-  end
-
-  ##
-  # Iterator for extension modules
-
-  def each_extend # :yields: extend
-    @extends.each do |e| yield e end
-  end
-
   ##
   # Iterator for methods
 
@@ -762,7 +742,7 @@ class RDoc::Context < RDoc::CodeObject
     attributes.default = []
 
     sort_sections.each do |section|
-      yield section, constants[section].sort, attributes[section].sort
+      yield section, constants[section].select(&:display?).sort, attributes[section].select(&:display?).sort
     end
   end
 
@@ -832,13 +812,6 @@ class RDoc::Context < RDoc::CodeObject
     end
   end
 
-  ##
-  # Finds a file with +name+ in this context
-
-  def find_file_named name
-    @store.find_file_named name
-  end
-
   ##
   # Finds an instance method with +name+ in this context
 
@@ -856,14 +829,20 @@ class RDoc::Context < RDoc::CodeObject
     find_attribute_named(symbol) or
     find_external_alias_named(symbol) or
     find_module_named(symbol) or
-    find_file_named(symbol)
+    @store.find_file_named(symbol)
   end
 
   ##
   # Finds a method named +name+ with singleton value +singleton+.
 
   def find_method(name, singleton)
-    @method_list.find { |m| m.name == name && m.singleton == singleton }
+    @method_list.find { |m|
+      if m.singleton
+        m.name == name && m.singleton == singleton
+      else
+        m.name == name && !m.singleton && !singleton
+      end
+    }
   end
 
   ##
@@ -952,10 +931,10 @@ class RDoc::Context < RDoc::CodeObject
   ##
   # URL for this with a +prefix+
 
-  def http_url(prefix)
+  def http_url
     path = name_for_path
     path = path.gsub(/<<\s*(\w*)/, 'from-\1') if path =~ /<</
-    path = [prefix] + path.split('::')
+    path = path.split('::')
 
     File.join(*path.compact) + '.html'
   end
@@ -967,13 +946,21 @@ class RDoc::Context < RDoc::CodeObject
     @instance_attributes ||= attributes.reject { |a| a.singleton }
   end
 
+  ##
+  # Instance methods
+
+  def instance_methods
+    @instance_methods ||= method_list.reject { |a| a.singleton }
+  end
+
   ##
   # Instance methods
   #--
-  # TODO rename to instance_methods
+  # TODO remove this later
 
   def instance_method_list
-    @instance_method_list ||= method_list.reject { |a| a.singleton }
+    warn '#instance_method_list is obsoleted, please use #instance_methods'
+    @instance_methods ||= method_list.reject { |a| a.singleton }
   end
 
   ##
@@ -1079,6 +1066,7 @@ class RDoc::Context < RDoc::CodeObject
     return if [:private, :nodoc].include? min_visibility
     remove_invisible_in @method_list, min_visibility
     remove_invisible_in @attributes, min_visibility
+    remove_invisible_in @constants, min_visibility
   end
 
   ##
@@ -1165,6 +1153,17 @@ class RDoc::Context < RDoc::CodeObject
     end
   end
 
+  ##
+  # Given an array +names+ of constants, set the visibility of each constant to
+  # +visibility+
+
+  def set_constant_visibility_for(names, visibility)
+    names.each do |name|
+      constant = @constants_hash[name] or next
+      constant.visibility = visibility
+    end
+  end
+
   ##
   # Sorts sections alphabetically (default) or in TomDoc fashion (none,
   # Public, Internal, Deprecated)
@@ -1218,6 +1217,6 @@ class RDoc::Context < RDoc::CodeObject
     klass
   end
 
-  autoload :Section, 'rdoc/context/section'
+  autoload :Section, "#{__dir__}/context/section"
 
 end

data/lib/rdoc/{extend.rb → code_object/extend.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A Module extension to a class with \#extend
 #
@@ -7,4 +7,3 @@
 class RDoc::Extend < RDoc::Mixin
 
 end
-

data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb}

@@ -1,7 +1,6 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # GhostMethod represents a method referenced only by a comment
 
 class RDoc::GhostMethod < RDoc::AnyMethod
 end
-

data/lib/rdoc/{include.rb → code_object/include.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A Module included in a class with \#include
 #
@@ -7,4 +7,3 @@
 class RDoc::Include < RDoc::Mixin
 
 end
-

data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb}

@@ -1,7 +1,6 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # MetaMethod represents a meta-programmed method
 
 class RDoc::MetaMethod < RDoc::AnyMethod
 end
-

data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Abstract class representing either a method or an attribute.
 
@@ -63,19 +63,13 @@ class RDoc::MethodAttr < RDoc::CodeObject
 
   attr_reader :arglists
 
-  ##
-  # Pretty parameter list for this method
-
-  attr_reader :param_seq
-
-
   ##
   # Creates a new MethodAttr from token stream +text+ and method or attribute
   # name +name+.
   #
   # Usually this is called by super from a subclass.
 
-  def initialize text, name
+  def initialize(text, name, singleton: false)
     super()
 
     @text = text
@@ -84,14 +78,13 @@ class RDoc::MethodAttr < RDoc::CodeObject
     @aliases      = []
     @is_alias_for = nil
     @parent_name  = nil
-    @singleton    = nil
+    @singleton    = singleton
     @visibility   = :public
     @see = false
 
     @arglists     = nil
     @block_params = nil
     @call_seq     = nil
-    @param_seq    = nil
     @params       = nil
   end
 
@@ -114,8 +107,8 @@ class RDoc::MethodAttr < RDoc::CodeObject
     return unless other.respond_to?(:singleton) &&
                   other.respond_to?(:name)
 
-    [     @singleton ? 0 : 1,       name] <=>
-    [other.singleton ? 0 : 1, other.name]
+    [@singleton      ? 0 : 1, name_ord_range,       name] <=>
+    [other.singleton ? 0 : 1, other.name_ord_range, other.name]
   end
 
   def == other # :nodoc:
@@ -188,7 +181,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
       next if String === ancestor
       next if parent == ancestor
 
-      other = ancestor.find_method_named('#' << name) ||
+      other = ancestor.find_method_named('#' + name) ||
               ancestor.find_attribute_named(name)
 
       return other if other
@@ -268,8 +261,8 @@ class RDoc::MethodAttr < RDoc::CodeObject
       when 'const_get' then 'const'
       when 'new' then
         $1.split('::').last.  # ClassName => class_name
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+          gsub(/([a-z\d])([A-Z])/, '\1_\2').
           downcase
       else
         $2
@@ -289,9 +282,9 @@ class RDoc::MethodAttr < RDoc::CodeObject
   # HTML id-friendly method/attribute name
 
   def html_name
-    require 'cgi'
+    require 'cgi/util'
 
-    CGI.escape(@name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '')
+    CGI.escape(@name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
   end
 
   ##
@@ -320,19 +313,6 @@ class RDoc::MethodAttr < RDoc::CodeObject
     @singleton ? '::' : '#'
   end
 
-  ##
-  # Name for output to HTML.  For class methods the full name with a "." is
-  # used like +SomeClass.method_name+.  For instance methods the class name is
-  # used if +context+ does not match the parent.
-  #
-  # This is to help prevent people from using :: to call class methods.
-
-  def output_name context
-    return "#{name_prefix}#{@name}" if context == parent
-
-    "#{parent_name}#{@singleton ? '.' : '#'}#{@name}"
-  end
-
   ##
   # Method/attribute name with class/instance indicator
 
@@ -415,5 +395,16 @@ class RDoc::MethodAttr < RDoc::CodeObject
     end
   end
 
+  def name_ord_range # :nodoc:
+    case name.ord
+    when 0..64 # anything below "A"
+      1
+    when 91..96 # the symbols between "Z" and "a"
+      2
+    when 123..126 # 7-bit symbols above "z": "{", "|", "}", "~"
+      3
+    else # everythig else can be sorted as normal
+      4
+    end
+  end
 end
-

data/lib/rdoc/{mixin.rb → code_object/mixin.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A Mixin adds features from a module into another context.  RDoc::Include and
 # RDoc::Extend are both mixins.
@@ -118,4 +118,3 @@ class RDoc::Mixin < RDoc::CodeObject
   end
 
 end
-

data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A normal class, neither singleton nor anonymous
 
@@ -47,16 +47,16 @@ class RDoc::NormalClass < RDoc::ClassModule
   def to_s # :nodoc:
     display = "#{self.class.name} #{self.full_name}"
     if superclass
-      display << ' < ' << (superclass.is_a?(String) ? superclass : superclass.full_name)
+      display += ' < ' + (superclass.is_a?(String) ? superclass : superclass.full_name)
     end
-    display << ' -> ' << is_alias_for.to_s if is_alias_for
+    display += ' -> ' + is_alias_for.to_s if is_alias_for
     display
   end
 
   def pretty_print q # :nodoc:
     superclass = @superclass ? " < #{@superclass}" : nil
 
-    q.group 2, "[class #{full_name}#{superclass} ", "]" do
+    q.group 2, "[class #{full_name}#{superclass}", "]" do
       q.breakable
       q.text "includes:"
       q.breakable
@@ -90,4 +90,3 @@ class RDoc::NormalClass < RDoc::ClassModule
   end
 
 end
-

data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A normal module, like NormalClass
 
@@ -30,7 +30,7 @@ class RDoc::NormalModule < RDoc::ClassModule
   end
 
   def pretty_print q # :nodoc:
-    q.group 2, "[module #{full_name}: ", "]" do
+    q.group 2, "[module #{full_name}:", "]" do
       q.breakable
       q.text "includes:"
       q.breakable
@@ -71,4 +71,3 @@ class RDoc::NormalModule < RDoc::ClassModule
   end
 
 end
-

data/lib/rdoc/{require.rb → code_object/require.rb}

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A file loaded by \#require
 
@@ -24,7 +24,7 @@ class RDoc::Require < RDoc::CodeObject
       self.class,
       object_id,
       @name,
-      parent_file_name,
+      @parent ? @parent.base_name : '(unknown)'
     ]
   end
 
@@ -49,4 +49,3 @@ class RDoc::Require < RDoc::CodeObject
   end
 
 end
-