rdoc 5.1.0 → 6.3.1

data/lib/rdoc/markup/to_html_crossref.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Subclass of the RDoc::Markup::ToHtml class that supports looking up method
 # names, classes, etc to create links.  RDoc::CrossReference is used to
@@ -39,26 +39,37 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     @hyperlink_all = @options.hyperlink_all
     @show_hash     = @options.show_hash
 
-    crossref_re = @hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
-    @markup.add_special crossref_re, :CROSSREF
-
     @cross_reference = RDoc::CrossReference.new @context
   end
 
+  def init_link_notation_regexp_handlings
+    add_regexp_handling_RDOCLINK
+
+    # The crossref must be linked before tidylink because Klass.method[:sym]
+    # will be processed as a tidylink first and will be broken.
+    crossref_re = @options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
+    @markup.add_regexp_handling crossref_re, :CROSSREF
+
+    add_regexp_handling_TIDYLINK
+  end
+
   ##
   # Creates a link to the reference +name+ if the name exists.  If +text+ is
   # given it is used as the link text, otherwise +name+ is used.
 
-  def cross_reference name, text = nil
+  def cross_reference name, text = nil, code = true
     lookup = name
 
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
 
-    name = "#{CGI.unescape $'} at #{$1}" if name =~ /(.*[^#:])@/
-
-    text = name unless text
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
+      text ||= "#{CGI.unescape $'} at <code>#{$1}</code>"
+      code = false
+    else
+      text ||= name
+    end
 
-    link lookup, text
+    link lookup, text, code
   end
 
   ##
@@ -68,8 +79,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # example, ToHtml is found, even without the <tt>RDoc::Markup::</tt> prefix,
   # because we look for it in module Markup first.
 
-  def handle_special_CROSSREF(special)
-    name = special.text
+  def handle_regexp_CROSSREF(target)
+    name = target.text
 
     return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
 
@@ -87,22 +98,22 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Handles <tt>rdoc-ref:</tt> scheme links and allows RDoc::Markup::ToHtml to
   # handle other schemes.
 
-  def handle_special_HYPERLINK special
-    return cross_reference $' if special.text =~ /\Ardoc-ref:/
+  def handle_regexp_HYPERLINK target
+    return cross_reference $' if target.text =~ /\Ardoc-ref:/
 
     super
   end
 
   ##
-  # +special+ is an rdoc-schemed link that will be converted into a hyperlink.
+  # +target+ is an rdoc-schemed link that will be converted into a hyperlink.
   # For the rdoc-ref scheme the cross-reference will be looked up and the
   # given name will be used.
   #
   # All other contents are handled by
-  # {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_special_RDOCLINK]
+  # {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]
 
-  def handle_special_RDOCLINK special
-    url = special.text
+  def handle_regexp_RDOCLINK target
+    url = target.text
 
     case url
     when /\Ardoc-ref:/ then
@@ -119,38 +130,42 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   def gen_url url, text
     return super unless url =~ /\Ardoc-ref:/
 
-    cross_reference $', text
+    name = $'
+    cross_reference name, text, name == text
   end
 
   ##
   # Creates an HTML link to +name+ with the given +text+.
 
-  def link name, text
-    original_name = name
-
-    if name =~ /(.*[^#:])@/ then
+  def link name, text, code = true
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
       name = $1
       label = $'
     end
 
     ref = @cross_reference.resolve name, text
 
-    text = ref.output_name @context if
-      RDoc::MethodAttr === ref and text == original_name
-
     case ref
     when String then
       ref
     else
       path = ref.as_href @from_path
 
+      if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
+        text = "<code>#{CGI.escapeHTML text}</code>"
+      end
+
       if path =~ /#/ then
         path << "-label-#{label}"
       elsif ref.sections and
             ref.sections.any? { |section| label == section.title } then
         path << "##{label}"
       else
-        path << "#label-#{label}"
+        if ref.respond_to?(:aref)
+          path << "##{ref.aref}-label-#{label}"
+        else
+          path << "#label-#{label}"
+        end
       end if label
 
       "<a href=\"#{path}\">#{text}</a>"

data/lib/rdoc/markup/to_html_snippet.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Outputs RDoc markup as paragraphs with inline markup only.
 
@@ -44,7 +44,7 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
     @mask       = 0
     @paragraphs = 0
 
-    @markup.add_special RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
+    @markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
   end
 
   ##
@@ -71,7 +71,7 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
 
     text = paragraph.text @hard_break
 
-    @res << "#{para}#{wrap to_html text}\n"
+    @res << "#{para}#{to_html text}\n"
 
     add_paragraph
   end
@@ -123,16 +123,16 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   end
 
   ##
-  # Removes escaping from the cross-references in +special+
+  # Removes escaping from the cross-references in +target+
 
-  def handle_special_CROSSREF special
-    special.text.sub(/\A\\/, '')
+  def handle_regexp_CROSSREF target
+    target.text.sub(/\A\\/, '')
   end
 
   ##
-  # +special+ is a <code><br></code>
+  # +target+ is a <code><br></code>
 
-  def handle_special_HARD_BREAK special
+  def handle_regexp_HARD_BREAK target
     @characters -= 4
     '<br>'
   end
@@ -226,8 +226,8 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
       when String then
         text = convert_string item
         res << truncate(text)
-      when RDoc::Markup::Special then
-        text = convert_special item
+      when RDoc::Markup::RegexpHandling then
+        text = convert_regexp_handling item
         res << truncate(text)
       else
         raise "Unknown flow element: #{item.inspect}"

data/lib/rdoc/markup/to_joined_paragraph.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Joins the parts of an RDoc::Markup::Paragraph into a single String.
 #
@@ -23,37 +23,11 @@ class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
   # Converts the parts of +paragraph+ to a single entry.
 
   def accept_paragraph paragraph
-    parts = []
-    string = false
-
-    paragraph.parts.each do |part|
-      if String === part then
-        if string then
-          string << part
-        else
-          parts << part
-          string = part
-        end
-      else
-        parts << part
-        string = false
-      end
-    end
-
-    parts = parts.map do |part|
-      if String === part then
-        part.rstrip
-      else
-        part
-      end
-    end
-
-    # TODO use Enumerable#chunk when Ruby 1.8 support is dropped
-    #parts = paragraph.parts.chunk do |part|
-    #  String === part
-    #end.map do |string, chunk|
-    #  string ? chunk.join.rstrip : chunk
-    #end.flatten
+    parts = paragraph.parts.chunk do |part|
+      String === part
+    end.map do |string, chunk|
+      string ? chunk.join.rstrip : chunk
+    end.flatten
 
     paragraph.parts.replace parts
   end
@@ -67,6 +41,7 @@ class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
   alias accept_raw             ignore
   alias accept_rule            ignore
   alias accept_verbatim        ignore
+  alias accept_table           ignore
 
 end
 

data/lib/rdoc/markup/to_label.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'cgi'
 
 ##
@@ -16,8 +16,8 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   def initialize markup = nil
     super nil, markup
 
-    @markup.add_special RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
-    @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)
+    @markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
+    @markup.add_regexp_handling(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)
 
     add_tag :BOLD, '', ''
     add_tag :TT,   '', ''
@@ -36,20 +36,20 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   end
 
   ##
-  # Converts the CROSSREF +special+ to plain text, removing the suppression
+  # Converts the CROSSREF +target+ to plain text, removing the suppression
   # marker, if any
 
-  def handle_special_CROSSREF special
-    text = special.text
+  def handle_regexp_CROSSREF target
+    text = target.text
 
     text.sub(/^\\/, '')
   end
 
   ##
-  # Converts the TIDYLINK +special+ to just the text part
+  # Converts the TIDYLINK +target+ to just the text part
 
-  def handle_special_TIDYLINK special
-    text = special.text
+  def handle_regexp_TIDYLINK target
+    text = target.text
 
     return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
 
@@ -68,7 +68,7 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   alias accept_rule               ignore
   alias accept_verbatim           ignore
   alias end_accepting             ignore
-  alias handle_special_HARD_BREAK ignore
+  alias handle_regexp_HARD_BREAK  ignore
   alias start_accepting           ignore
 
 end

data/lib/rdoc/markup/to_markdown.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 # :markup: markdown
 
 ##
@@ -19,8 +19,8 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
     @headings[5] = ['##### ',  '']
     @headings[6] = ['###### ', '']
 
-    add_special_RDOCLINK
-    add_special_TIDYLINK
+    add_regexp_handling_RDOCLINK
+    add_regexp_handling_TIDYLINK
 
     @hard_break = "  \n"
   end
@@ -37,7 +37,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Adds a newline to the output
 
-  def handle_special_HARD_BREAK special
+  def handle_regexp_HARD_BREAK target
     "  \n"
   end
 
@@ -131,7 +131,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
       @res << part
     end
 
-    @res << "\n" unless @res =~ /\n\z/
+    @res << "\n"
   end
 
   ##
@@ -166,8 +166,8 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Converts the RDoc markup tidylink into a Markdown.style link.
 
-  def handle_special_TIDYLINK special
-    text = special.text
+  def handle_regexp_TIDYLINK target
+    text = target.text
 
     return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
 
@@ -184,8 +184,8 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Converts the rdoc-...: links into a Markdown.style links.
 
-  def handle_special_RDOCLINK special
-    handle_rdoc_link special.text
+  def handle_regexp_RDOCLINK target
+    handle_rdoc_link target.text
   end
 
 end

data/lib/rdoc/markup/to_rdoc.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Outputs RDoc markup as RDoc markup! (mostly)
 
@@ -45,7 +45,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   def initialize markup = nil
     super nil, markup
 
-    @markup.add_special(/\\\S/, :SUPPRESSED_CROSSREF)
+    @markup.add_regexp_handling(/\\\S/, :SUPPRESSED_CROSSREF)
     @width = 78
     init_tags
 
@@ -234,7 +234,35 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
       @res << part
     end
 
-    @res << "\n" unless @res =~ /\n\z/
+    @res << "\n"
+  end
+
+  ##
+  # Adds +table+ to the output
+
+  def accept_table header, body, aligns
+    widths = header.zip(body) do |h, b|
+      [h.size, b.size].max
+    end
+    aligns = aligns.map do |a|
+      case a
+      when nil
+        :center
+      when :left
+        :ljust
+      when :right
+        :rjust
+      end
+    end
+    @res << header.zip(widths, aligns) do |h, w, a|
+      h.__send__(a, w)
+    end.join("|").rstrip << "\n"
+    @res << widths.map {|w| "-" * w }.join("|") << "\n"
+    body.each do |row|
+      @res << row.zip(widths, aligns) do |t, w, a|
+        t.__send__(a, w)
+      end.join("|").rstrip << "\n"
+    end
   end
 
   ##
@@ -253,10 +281,10 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   end
 
   ##
-  # Removes preceding \\ from the suppressed crossref +special+
+  # Removes preceding \\ from the suppressed crossref +target+
 
-  def handle_special_SUPPRESSED_CROSSREF special
-    text = special.text
+  def handle_regexp_SUPPRESSED_CROSSREF target
+    text = target.text
     text = text.sub('\\', '') unless in_tt?
     text
   end
@@ -264,7 +292,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Adds a newline to the output
 
-  def handle_special_HARD_BREAK special
+  def handle_regexp_HARD_BREAK target
     "\n"
   end
 

data/lib/rdoc/markup/to_table_of_contents.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Extracts just the RDoc::Markup::Heading elements from a
 # RDoc::Markup::Document to help build a table of contents
@@ -82,6 +82,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   alias accept_list_item_end   ignore
   alias accept_list_end_bullet ignore
   alias accept_list_start      ignore
+  alias accept_table           ignore
   # :startdoc:
 
 end

data/lib/rdoc/markup/to_test.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # This Markup outputter is used for testing purposes.
 

data/lib/rdoc/markup/to_tt_only.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Extracts sections of text enclosed in plus, tt or code.  Used to discover
 # undocumented parameters.
@@ -91,8 +91,8 @@ class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
       when RDoc::Markup::AttrChanger then
         off_tags res, item
         on_tags res, item
-      when RDoc::Markup::Special then
-        @res << convert_special(item) if in_tt? # TODO can this happen?
+      when RDoc::Markup::RegexpHandling then
+        @res << convert_regexp_handling(item) if in_tt? # TODO can this happen?
       else
         raise "Unknown flow element: #{item.inspect}"
       end

data/lib/rdoc/markup/verbatim.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A section of verbatim text
 

data/lib/rdoc/markup.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # RDoc::Markup parses plain text documents and attempts to decompose them into
 # their constituent parts.  Some of these parts are high-level: paragraphs,
@@ -65,17 +65,16 @@
 #   puts h.convert(input_string)
 #
 # You can extend the RDoc::Markup parser to recognize new markup
-# sequences, and to add special processing for text that matches a
-# regular expression.  Here we make WikiWords significant to the parser,
-# and also make the sequences {word} and \<no>text...</no> signify
+# sequences, and to add regexp handling. Here we make WikiWords significant to
+# the parser, and also make the sequences {word} and \<no>text...</no> signify
 # strike-through text.  We then subclass the HTML output class to deal
 # with these:
 #
 #   require 'rdoc'
 #
 #   class WikiHtml < RDoc::Markup::ToHtml
-#     def handle_special_WIKIWORD(special)
-#       "<font color=red>" + special.text + "</font>"
+#     def handle_regexp_WIKIWORD(target)
+#       "<font color=red>" + target.text + "</font>"
 #     end
 #   end
 #
@@ -83,7 +82,7 @@
 #   markup.add_word_pair("{", "}", :STRIKE)
 #   markup.add_html("no", :STRIKE)
 #
-#   markup.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
+#   markup.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
 #
 #   wh = WikiHtml.new RDoc::Options.new, markup
 #   wh.add_tag(:STRIKE, "<strike>", "</strike>")
@@ -377,7 +376,7 @@
 #
 # Example links:
 #
-#   https://github.com/rdoc/rdoc
+#   https://github.com/ruby/rdoc
 #   mailto:user@example.com
 #   {RDoc Documentation}[http://rdoc.rubyforge.org]
 #   {RDoc Markup}[rdoc-ref:RDoc::Markup]
@@ -764,7 +763,7 @@ Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} #{RUBY_RELEASE_DATE}
 
 Please file a bug report with the above information at:
 
-https://github.com/rdoc/rdoc/issues
+https://github.com/ruby/rdoc/issues
 
     EOF
     raise
@@ -800,13 +799,12 @@ https://github.com/rdoc/rdoc/issues
   # Add to other inline sequences.  For example, we could add WikiWords using
   # something like:
   #
-  #    parser.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
+  #    parser.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
   #
-  # Each wiki word will be presented to the output formatter via the
-  # accept_special method.
+  # Each wiki word will be presented to the output formatter.
 
-  def add_special(pattern, name)
-    @attribute_manager.add_special(pattern, name)
+  def add_regexp_handling(pattern, name)
+    @attribute_manager.add_regexp_handling(pattern, name)
   end
 
   ##
@@ -832,7 +830,7 @@ https://github.com/rdoc/rdoc/issues
   autoload :AttrSpan,              'rdoc/markup/attr_span'
   autoload :Attributes,            'rdoc/markup/attributes'
   autoload :AttributeManager,      'rdoc/markup/attribute_manager'
-  autoload :Special,               'rdoc/markup/special'
+  autoload :RegexpHandling,        'rdoc/markup/regexp_handling'
 
   # RDoc::Markup AST
   autoload :BlankLine,             'rdoc/markup/blank_line'
@@ -845,14 +843,13 @@ https://github.com/rdoc/rdoc/issues
   autoload :List,                  'rdoc/markup/list'
   autoload :ListItem,              'rdoc/markup/list_item'
   autoload :Paragraph,             'rdoc/markup/paragraph'
+  autoload :Table,                 'rdoc/markup/table'
   autoload :Raw,                   'rdoc/markup/raw'
   autoload :Rule,                  'rdoc/markup/rule'
   autoload :Verbatim,              'rdoc/markup/verbatim'
 
   # Formatters
   autoload :Formatter,             'rdoc/markup/formatter'
-  autoload :FormatterTestCase,     'rdoc/markup/formatter_test_case'
-  autoload :TextFormatterTestCase, 'rdoc/markup/text_formatter_test_case'
 
   autoload :ToAnsi,                'rdoc/markup/to_ansi'
   autoload :ToBs,                  'rdoc/markup/to_bs'

data/lib/rdoc/meta_method.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # MetaMethod represents a meta-programmed method
 

data/lib/rdoc/method_attr.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Abstract class representing either a method or an attribute.
 
@@ -188,7 +188,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

data/lib/rdoc/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.

data/lib/rdoc/normal_class.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A normal class, neither singleton nor anonymous
 
@@ -47,9 +47,9 @@ 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
 

data/lib/rdoc/normal_module.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A normal module, like NormalClass