rdoc 6.3.4.1 → 8.0.0

data/exe/rdoc

@@ -41,4 +41,3 @@ rescue Exception => e
 
   exit 1
 end
-

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

@@ -23,21 +23,15 @@ class RDoc::Alias < RDoc::CodeObject
   ##
   # Is this an alias declared in a singleton context?
 
-  attr_accessor :singleton
+  attr_reader :singleton
 
   ##
-  # Source file token stream
-
-  attr_reader :text
-
-  ##
-  # Creates a new Alias with a token stream of +text+ that aliases +old_name+
+  # Creates a new Alias that aliases +old_name+
   # to +new_name+, has +comment+ and is a +singleton+ context.
 
-  def initialize(text, old_name, new_name, comment, singleton = false)
+  def initialize(old_name, new_name, comment, singleton: false)
     super()
 
-    @text = text
     @singleton = singleton
     @old_name = old_name
     @new_name = new_name
@@ -59,18 +53,11 @@ class RDoc::Alias < RDoc::CodeObject
     "#alias-#{type}-#{html_name}"
   end
 
-  ##
-  # Full old name including namespace
-
-  def full_old_name
-    @full_name || "#{parent.name}#{pretty_old_name}"
-  end
-
   ##
   # HTML id-friendly version of +#new_name+.
 
   def html_name
-    CGI.escape(@new_name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '')
+    CGI.escape(@new_name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
   end
 
   def inspect # :nodoc:
@@ -109,4 +96,3 @@ class RDoc::Alias < RDoc::CodeObject
   end
 
 end
-

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

@@ -13,8 +13,10 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   # 3::
   #   RDoc 4.1
   #   Added is_alias_for
+  # 4::
+  #   Added type_signature_lines (serialized as joined string)
 
-  MARSHAL_VERSION = 3 # :nodoc:
+  MARSHAL_VERSION = 4 # :nodoc:
 
   ##
   # Don't rename \#initialize to \::new
@@ -26,9 +28,8 @@ class RDoc::AnyMethod < RDoc::MethodAttr
 
   attr_accessor :c_function
 
-  # Parameters for this method
-
-  attr_accessor :params
+  # The section title of the method (if defined in a C file via +:category:+)
+  attr_accessor :section_title
 
   ##
   # If true this method uses +super+ to call a superclass version
@@ -38,10 +39,10 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   include RDoc::TokenStream
 
   ##
-  # Creates a new AnyMethod with a token stream +text+ and +name+
+  # Creates a new AnyMethod with name +name+
 
-  def initialize text, name
-    super
+  def initialize(name, singleton: false)
+    super(name, singleton: singleton)
 
     @c_function = nil
     @dont_rename_initialize = false
@@ -53,15 +54,15 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   ##
   # Adds +an_alias+ as an alias for this method in +context+.
 
-  def add_alias an_alias, context = nil
-    method = self.class.new an_alias.text, an_alias.new_name
+  def add_alias(an_alias, context = nil)
+    method = self.class.new an_alias.new_name, singleton: singleton
 
     method.record_location an_alias.file
-    method.singleton = self.singleton
     method.params = self.params
     method.visibility = self.visibility
     method.comment = an_alias.comment
     method.is_alias_for = self
+    method.type_signature_lines = self.type_signature_lines
     @aliases << method
     context.add_method method if context
     method
@@ -106,12 +107,19 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   #
   # See also #param_seq
 
-  def call_seq= call_seq
-    return if call_seq.empty?
+  def call_seq=(call_seq)
+    return if call_seq.nil? || call_seq.empty?
 
     @call_seq = call_seq
   end
 
+  ##
+  # Whether the method has a call-seq.
+
+  def has_call_seq?
+    !!(@call_seq || is_alias_for&._call_seq)
+  end
+
   ##
   # Loads is_alias_for from the internal name.  Returns nil if the alias
   # cannot be found.
@@ -161,6 +169,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
       @parent.class,
       @section.title,
       is_alias_for,
+      @type_signature_lines&.join("\n"),
     ]
   end
 
@@ -171,7 +180,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize_visibility
 
     @dont_rename_initialize = nil
@@ -188,7 +197,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     @full_name     = array[2]
     @singleton     = array[3]
     @visibility    = array[4]
-    @comment       = array[5]
+    @comment       = RDoc::Comment.from_document array[5]
     @call_seq      = array[6]
     @block_params  = array[7]
     #                      8 handled below
@@ -199,9 +208,10 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     @parent_title  = array[13]
     @section_title = array[14]
     @is_alias_for  = array[15]
+    @type_signature_lines = array[16]&.split("\n")
 
-    array[8].each do |new_name, comment|
-      add_alias RDoc::Alias.new(nil, @name, new_name, comment, @singleton)
+    array[8].each do |new_name, document|
+      add_alias RDoc::Alias.new(@name, new_name, RDoc::Comment.from_document(document), singleton: @singleton)
     end
 
     @parent_name ||= if @full_name =~ /#/ then
@@ -293,10 +303,18 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     params
   end
 
+  ##
+  # Whether to skip the method description, true for methods that have
+  # aliases with a call-seq that doesn't include the method name.
+
+  def skip_description?
+    has_call_seq? && call_seq.nil? && !!(is_alias_for || !aliases.empty?)
+  end
+
   ##
   # Sets the store for this method and its referenced code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @file = @store.add_file @file.full_name if @file
@@ -338,7 +356,6 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     return call_seq unless is_alias_for || !aliases.empty?
 
     method_name = self.name
-    method_name = method_name[0, 1] if method_name =~ /\A\[/
 
     entries = call_seq.split "\n"
 
@@ -347,15 +364,24 @@ class RDoc::AnyMethod < RDoc::MethodAttr
       ignore << is_alias_for.name
       ignore.concat is_alias_for.aliases.map(&:name)
     end
-    ignore.map! { |n| n =~ /\A\[/ ? n[0, 1] : n}
+
     ignore.delete(method_name)
-    ignore = Regexp.union(ignore)
+    ignore_bracket_methods, ignore_other_methods = ignore.partition {|i| i.start_with?('[') }
 
-    matching = entries.reject do |entry|
-      entry =~ /^\w*\.?#{ignore}/ or
-        entry =~ /\s#{ignore}\s/
+    if ignore_other_methods.any?
+      ignore_union = Regexp.union(ignore_other_methods)
+      entries.reject! do |entry|
+        /\A(?:\w*\.)?#{ignore_union}(?:[(\s]|\z)/.match?(entry) ||
+          /\s#{ignore_union}\s/.match?(entry)
+      end
+    end
+    if ignore_bracket_methods.any?
+      entries.reject! do |entry|
+        # Ignore `receiver[arg] -> return_type` `[](arg)` `[]`
+        /\A\w*\[.*?\](?:[(\s]|\z)/.match?(entry)
+      end
     end
 
-    matching.join "\n"
+    entries.empty? ? nil : entries.join("\n")
   end
 end

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

@@ -10,8 +10,10 @@ class RDoc::Attr < RDoc::MethodAttr
   #   RDoc 4
   #    Added parent name and class
   #    Added section title
+  # 4::
+  #   Added type_signature_lines (serialized as joined string)
 
-  MARSHAL_VERSION = 3 # :nodoc:
+  MARSHAL_VERSION = 4 # :nodoc:
 
   ##
   # Is the attribute readable ('R'), writable ('W') or both ('RW')?
@@ -19,21 +21,20 @@ class RDoc::Attr < RDoc::MethodAttr
   attr_accessor :rw
 
   ##
-  # Creates a new Attr with body +text+, +name+, read/write status +rw+ and
+  # Creates a new Attr with +name+, read/write status +rw+ and
   # +comment+.  +singleton+ marks this as a class attribute.
 
-  def initialize(text, name, rw, comment, singleton = false)
-    super text, name
+  def initialize(name, rw, comment, singleton: false)
+    super(name, singleton: singleton)
 
     @rw = rw
-    @singleton = singleton
     self.comment = comment
   end
 
   ##
   # Attributes are equal when their names, singleton and rw are identical
 
-  def == other
+  def ==(other)
     self.class == other.class and
       self.name == other.name and
       self.rw == other.rw and
@@ -44,12 +45,12 @@ class RDoc::Attr < RDoc::MethodAttr
   # Add +an_alias+ as an attribute in +context+.
 
   def add_alias(an_alias, context)
-    new_attr = self.class.new(self.text, an_alias.new_name, self.rw,
-                              self.comment, self.singleton)
-
+    access_type = an_alias.new_name.end_with?('=') ? 'W' : 'R'
+    new_attr = self.class.new(an_alias.new_name, access_type, comment, singleton: singleton)
     new_attr.record_location an_alias.file
     new_attr.visibility = self.visibility
     new_attr.is_alias_for = self
+    new_attr.type_signature_lines = self.type_signature_lines
     @aliases << new_attr
     context.add_attribute new_attr
     new_attr
@@ -110,7 +111,8 @@ class RDoc::Attr < RDoc::MethodAttr
       @file.relative_name,
       @parent.full_name,
       @parent.class,
-      @section.title
+      @section.title,
+      @type_signature_lines&.join("\n"),
     ]
   end
 
@@ -121,7 +123,7 @@ class RDoc::Attr < RDoc::MethodAttr
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize_visibility
 
     @aliases      = []
@@ -136,19 +138,20 @@ class RDoc::Attr < RDoc::MethodAttr
     @full_name     = array[2]
     @rw            = array[3]
     @visibility    = array[4]
-    @comment       = array[5]
+    @comment       = RDoc::Comment.from_document array[5]
     @singleton     = array[6] || false # MARSHAL_VERSION == 0
     #                      7 handled below
     @parent_name   = array[8]
     @parent_class  = array[9]
     @section_title = array[10]
+    @type_signature_lines = array[11]&.split("\n")
 
     @file = RDoc::TopLevel.new array[7] if version > 1
 
     @parent_name ||= @full_name.split('#', 2).first
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[#{self.class.name} #{full_name} #{rw} #{visibility}", "]" do
       unless comment.empty? then
         q.breakable
@@ -173,4 +176,3 @@ class RDoc::Attr < RDoc::MethodAttr
   end
 
 end
-