rdoc 6.12.0 → 6.14.0

data/lib/rdoc/markup/heading.rb

@@ -27,7 +27,7 @@ RDoc::Markup::Heading =
 
     @to_html = RDoc::Markup::ToHtml.new nil
 
-    def @to_html.handle_regexp_CROSSREF target
+    def @to_html.handle_regexp_CROSSREF(target)
       target.text.sub(/^\\/, '')
     end
 
@@ -37,7 +37,7 @@ RDoc::Markup::Heading =
   ##
   # Calls #accept_heading on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_heading self
   end
 
@@ -52,7 +52,7 @@ RDoc::Markup::Heading =
   # Creates a fully-qualified label which will include the label from
   # +context+.  This helps keep ids unique in HTML.
 
-  def label context = nil
+  def label(context = nil)
     label = aref
 
     label = [context.aref, label].compact.join '-' if
@@ -66,10 +66,16 @@ RDoc::Markup::Heading =
   # element.
 
   def plain_html
-    self.class.to_html.to_html(text.dup)
+    text = self.text.dup
+
+    if matched = text.match(/rdoc-image:[^:]+:(.*)/)
+      text = matched[1]
+    end
+
+    self.class.to_html.to_html(text)
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[head: #{level} ", ']' do
       q.pp text
     end

data/lib/rdoc/markup/include.rb

@@ -20,17 +20,17 @@ class RDoc::Markup::Include
   ##
   # Creates a new include that will import +file+ from +include_path+
 
-  def initialize file, include_path
+  def initialize(file, include_path)
     @file = file
     @include_path = include_path
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other and
       @file == other.file and @include_path == other.include_path
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, '[incl ', ']' do
       q.text file
       q.breakable

data/lib/rdoc/markup/indented_paragraph.rb

@@ -19,14 +19,14 @@ class RDoc::Markup::IndentedParagraph < RDoc::Markup::Raw
     super(*parts)
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     super and indent == other.indent
   end
 
   ##
   # Calls #accept_indented_paragraph on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_indented_paragraph self
   end
 
@@ -34,7 +34,7 @@ class RDoc::Markup::IndentedParagraph < RDoc::Markup::Raw
   # Joins the raw paragraph text and converts inline HardBreaks to the
   # +hard_break+ text followed by the indent.
 
-  def text hard_break = nil
+  def text(hard_break = nil)
     @parts.map do |part|
       if RDoc::Markup::HardBreak === part then
         '%1$s%3$*2$s' % [hard_break, @indent, ' '] if hard_break

data/lib/rdoc/markup/list.rb

@@ -46,11 +46,11 @@ class RDoc::Markup::List
   ##
   # Appends +item+ to the list
 
-  def << item
+  def <<(item)
     @items << item
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and
       @type == other.type and
       @items == other.items
@@ -59,7 +59,7 @@ class RDoc::Markup::List
   ##
   # Runs this list and all its #items through +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_list_start self
 
     @items.each do |item|
@@ -83,7 +83,7 @@ class RDoc::Markup::List
     @items.last
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[list: #{@type} ", ']' do
       q.seplist @items do |item|
         q.pp item

data/lib/rdoc/markup/list_item.rb

@@ -33,11 +33,11 @@ class RDoc::Markup::ListItem
   ##
   # Appends +part+ to the ListItem
 
-  def << part
+  def <<(part)
     @parts << part
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and
       @label == other.label and
       @parts == other.parts
@@ -46,7 +46,7 @@ class RDoc::Markup::ListItem
   ##
   # Runs this list item and all its #parts through +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_list_item_start self
 
     @parts.each do |part|
@@ -70,7 +70,7 @@ class RDoc::Markup::ListItem
     @parts.length
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, '[item: ', ']' do
       case @label
       when Array then

data/lib/rdoc/markup/paragraph.rb

@@ -7,7 +7,7 @@ class RDoc::Markup::Paragraph < RDoc::Markup::Raw
   ##
   # Calls #accept_paragraph on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_paragraph self
   end
 
@@ -15,7 +15,7 @@ class RDoc::Markup::Paragraph < RDoc::Markup::Raw
   # Joins the raw paragraph text and converts inline HardBreaks to the
   # +hard_break+ text.
 
-  def text hard_break = ''
+  def text(hard_break = '')
     @parts.map do |part|
       if RDoc::Markup::HardBreak === part then
         hard_break

data/lib/rdoc/markup/parser.rb

@@ -57,7 +57,7 @@ class RDoc::Markup::Parser
   #
   # Use RDoc::Markup#parse instead of this method.
 
-  def self.parse str
+  def self.parse(str)
     parser = new
     parser.tokenize str
     doc = RDoc::Markup::Document.new
@@ -67,7 +67,7 @@ class RDoc::Markup::Parser
   ##
   # Returns a token stream for +str+, for testing
 
-  def self.tokenize str
+  def self.tokenize(str)
     parser = new
     parser.tokenize str
     parser.tokens
@@ -87,7 +87,7 @@ class RDoc::Markup::Parser
   ##
   # Builds a Heading of +level+
 
-  def build_heading level
+  def build_heading(level)
     type, text, = get
 
     text = case type
@@ -105,7 +105,7 @@ class RDoc::Markup::Parser
   ##
   # Builds a List flush to +margin+
 
-  def build_list margin
+  def build_list(margin)
     p :list_start => margin if @debug
 
     list = RDoc::Markup::List.new
@@ -205,7 +205,7 @@ class RDoc::Markup::Parser
   ##
   # Builds a Paragraph that is flush to +margin+
 
-  def build_paragraph margin
+  def build_paragraph(margin)
     p :paragraph_start => margin if @debug
 
     paragraph = RDoc::Markup::Paragraph.new
@@ -240,7 +240,7 @@ class RDoc::Markup::Parser
   # terminated by a newline.  Blank lines always consist of a single newline
   # character, and there is never a single newline at the end of the verbatim.
 
-  def build_verbatim margin
+  def build_verbatim(margin)
     p :verbatim_begin => margin if @debug
     verbatim = RDoc::Markup::Verbatim.new
 
@@ -339,7 +339,7 @@ class RDoc::Markup::Parser
   #
   # Returns +parent+.
 
-  def parse parent, indent = 0
+  def parse(parent, indent = 0)
     p :parse_start => indent if @debug
 
     until @tokens.empty? do
@@ -403,7 +403,7 @@ class RDoc::Markup::Parser
   ##
   # Small hook that is overridden by RDoc::TomDoc
 
-  def parse_text parent, indent # :nodoc:
+  def parse_text(parent, indent) # :nodoc:
     parent << build_paragraph(indent)
   end
 
@@ -465,7 +465,7 @@ class RDoc::Markup::Parser
   ##
   # Creates the StringScanner
 
-  def setup_scanner input
+  def setup_scanner(input)
     @s = MyStringScanner.new input
   end
 
@@ -474,7 +474,7 @@ class RDoc::Markup::Parser
   #
   # Optionally raises an error if the next token is not of the expected type.
 
-  def skip token_type, error = true
+  def skip(token_type, error = true)
     type, = get
     return unless type # end of stream
     return @current_token if token_type == type
@@ -485,7 +485,7 @@ class RDoc::Markup::Parser
   ##
   # Turns text +input+ into a stream of tokens
 
-  def tokenize input
+  def tokenize(input)
     setup_scanner input
 
     until @s.eos? do

data/lib/rdoc/markup/pre_process.rb

@@ -27,7 +27,7 @@ class RDoc::Markup::PreProcess
   # with the result RDoc::Comment (or text String) and the code object for the
   # comment (if any).
 
-  def self.post_process &block
+  def self.post_process(&block)
     @post_processors << block
   end
 
@@ -50,7 +50,7 @@ class RDoc::Markup::PreProcess
   #     # replace text, etc.
   #   end
 
-  def self.register directive, &block
+  def self.register(directive, &block)
     @registered[directive] = block
   end
 
@@ -96,7 +96,7 @@ class RDoc::Markup::PreProcess
   # directive's parameter is set as metadata on the +code_object+.  See
   # RDoc::CodeObject#metadata for details.
 
-  def handle text, code_object = nil, &block
+  def handle(text, code_object = nil, &block)
     first_line = 1
     if RDoc::Comment === text then
       comment = text
@@ -150,8 +150,8 @@ class RDoc::Markup::PreProcess
   #--
   # When 1.8.7 support is ditched prefix can be defaulted to ''
 
-  def handle_directive prefix, directive, param, code_object = nil,
-                       encoding = nil, line = nil
+  def handle_directive(prefix, directive, param, code_object = nil,
+                       encoding = nil, line = nil)
     blankline = "#{prefix.strip}\n"
     directive = directive.downcase
 
@@ -279,7 +279,7 @@ class RDoc::Markup::PreProcess
   # TODO shift left the whole file content in that case
   # TODO comment stop/start #-- and #++ in included file must be processed here
 
-  def include_file name, indent, encoding
+  def include_file(name, indent, encoding)
     full_name = find_include_file name
 
     unless full_name then

data/lib/rdoc/markup/raw.rb

@@ -20,29 +20,29 @@ class RDoc::Markup::Raw
   ##
   # Appends +text+
 
-  def << text
+  def <<(text)
     @parts << text
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and @parts == other.parts
   end
 
   ##
   # Calls #accept_raw+ on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_raw self
   end
 
   ##
   # Appends +other+'s parts
 
-  def merge other
+  def merge(other)
     @parts.concat other.parts
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     self.class.name =~ /.*::(\w{1,4})/i
 
     q.group 2, "[#{$1.downcase}: ", ']' do

data/lib/rdoc/markup/rule.rb

@@ -7,11 +7,11 @@ class RDoc::Markup::Rule < Struct.new :weight
   ##
   # Calls #accept_rule on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_rule self
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, '[rule:', ']' do
       q.pp weight
     end

data/lib/rdoc/markup/table.rb

@@ -13,23 +13,23 @@ class RDoc::Markup::Table
   attr_accessor :body
 
   # Creates new instance
-  def initialize header, align, body
+  def initialize(header, align, body)
     @header, @align, @body = header, align, body
   end
 
   # :stopdoc:
-  def == other
+  def ==(other)
     self.class == other.class and
       @header == other.header and
       @align == other.align and
       @body == other.body
   end
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_table @header, @body, @align
   end
 
-  def pretty_print q
+  def pretty_print(q)
     q.group 2, '[Table: ', ']' do
       q.group 2, '[Head: ', ']' do
         q.seplist @header.zip(@align) do |text, align|

data/lib/rdoc/markup/to_ansi.rb

@@ -7,7 +7,7 @@ class RDoc::Markup::ToAnsi < RDoc::Markup::ToRdoc
   ##
   # Creates a new ToAnsi visitor that is ready to output vibrant ANSI color!
 
-  def initialize markup = nil
+  def initialize(markup = nil)
     super
 
     @headings.clear
@@ -28,7 +28,7 @@ class RDoc::Markup::ToAnsi < RDoc::Markup::ToRdoc
   ##
   # Overrides indent width to ensure output lines up correctly.
 
-  def accept_list_item_end list_item
+  def accept_list_item_end(list_item)
     width = case @list_type.last
             when :BULLET then
               2
@@ -52,7 +52,7 @@ class RDoc::Markup::ToAnsi < RDoc::Markup::ToRdoc
   ##
   # Adds coloring to note and label list items
 
-  def accept_list_item_start list_item
+  def accept_list_item_start(list_item)
     bullet = case @list_type.last
              when :BULLET then
                '*'

data/lib/rdoc/markup/to_bs.rb

@@ -10,7 +10,7 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   ##
   # Returns a new ToBs that is ready for hot backspace action!
 
-  def initialize markup = nil
+  def initialize(markup = nil)
     super
 
     @in_b  = false
@@ -30,7 +30,7 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   ##
   # Makes heading text bold.
 
-  def accept_heading heading
+  def accept_heading(heading)
     use_prefix or @res << ' ' * @indent
     @res << @headings[heading.level][0]
     @in_b = true
@@ -43,7 +43,7 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   ##
   # Prepares the visitor for consuming +list_item+
 
-  def accept_list_item_start list_item
+  def accept_list_item_start(list_item)
     type = @list_type.last
 
     case type
@@ -68,7 +68,7 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   ##
   # Turns on or off regexp handling for +convert_string+
 
-  def annotate tag
+  def annotate(tag)
     case tag
     when '+b' then @in_b = true
     when '-b' then @in_b = false
@@ -81,14 +81,14 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   ##
   # Calls convert_string on the result of convert_regexp_handling
 
-  def convert_regexp_handling target
+  def convert_regexp_handling(target)
     convert_string super
   end
 
   ##
   # Adds bold or underline mixed with backspaces
 
-  def convert_string string
+  def convert_string(string)
     return string unless @in_b or @in_em
     chars = if @in_b then
               string.chars.map do |char| "#{char}\b#{char}" end

data/lib/rdoc/markup/to_html.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
-require 'cgi/util'
+require 'cgi/escape'
+# For CGI.unescape on earlier rubies
+require 'cgi/util' if RUBY_VERSION < '3.5'
 
 ##
 # Outputs RDoc markup as HTML.
@@ -42,7 +44,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Creates a new formatter that will output HTML
 
-  def initialize options, markup = nil
+  def initialize(options, markup = nil)
     super
 
     @code_object = nil
@@ -82,7 +84,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
     add_regexp_handling_TIDYLINK
   end
 
-  def handle_RDOCLINK url # :nodoc:
+  def handle_RDOCLINK(url) # :nodoc:
     case url
     when /^rdoc-ref:/
       CGI.escapeHTML($')
@@ -98,7 +100,15 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
 
       gen_url CGI.escapeHTML(url), CGI.escapeHTML(text)
     when /^rdoc-image:/
-      %[<img src=\"#{CGI.escapeHTML($')}\">]
+      # Split the string after "rdoc-image:" into url and alt.
+      #   "path/to/image.jpg:alt text" => ["path/to/image.jpg", "alt text"]
+      #   "http://example.com/path/to/image.jpg:alt text" => ["http://example.com/path/to/image.jpg", "alt text"]
+      url, alt = $'.split(/:(?!\/)/, 2)
+      if alt && !alt.empty?
+        %[<img src="#{CGI.escapeHTML(url)}" alt="#{CGI.escapeHTML(alt)}">]
+      else
+        %[<img src="#{CGI.escapeHTML(url)}">]
+      end
     when /\Ardoc-[a-z]+:/
       CGI.escapeHTML($')
     end
@@ -107,7 +117,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # +target+ is a <code><br></code>
 
-  def handle_regexp_HARD_BREAK target
+  def handle_regexp_HARD_BREAK(target)
     '<br>'
   end
 
@@ -138,7 +148,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   # For the +rdoc-label+ scheme the footnote and label prefixes are stripped
   # when creating a link.  All other contents will be linked verbatim.
 
-  def handle_regexp_RDOCLINK target
+  def handle_regexp_RDOCLINK(target)
     handle_RDOCLINK target.text
   end
 
@@ -187,7 +197,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Adds +block_quote+ to the output
 
-  def accept_block_quote block_quote
+  def accept_block_quote(block_quote)
     @res << "\n<blockquote>"
 
     block_quote.parts.each do |part|
@@ -200,7 +210,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Adds +paragraph+ to the output
 
-  def accept_paragraph paragraph
+  def accept_paragraph(paragraph)
     @res << "\n<p>"
     text = paragraph.text @hard_break
     text = text.gsub(/(#{SPACE_SEPARATED_LETTER_CLASS})?\K\r?\n(?=(?(1)(#{SPACE_SEPARATED_LETTER_CLASS})?))/o) {
@@ -213,7 +223,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Adds +verbatim+ to the output
 
-  def accept_verbatim verbatim
+  def accept_verbatim(verbatim)
     text = verbatim.text.rstrip
 
     klass = nil
@@ -243,7 +253,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Adds +rule+ to the output
 
-  def accept_rule rule
+  def accept_rule(rule)
     @res << "<hr>\n"
   end
 
@@ -296,7 +306,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   # Adds +heading+ to the output.  The headings greater than 6 are trimmed to
   # level 6.
 
-  def accept_heading heading
+  def accept_heading(heading)
     level = [6, heading.level].min
 
     label = heading.label @code_object
@@ -317,14 +327,14 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Adds +raw+ to the output
 
-  def accept_raw raw
+  def accept_raw(raw)
     @res << raw.parts.join("\n")
   end
 
   ##
   # Adds +table+ to the output
 
-  def accept_table header, body, aligns
+  def accept_table(header, body, aligns)
     @res << "\n<table role=\"table\">\n<thead>\n<tr>\n"
     header.zip(aligns) do |text, align|
       @res << '<th'
@@ -357,7 +367,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   # Generate a link to +url+ with content +text+.  Handles the special cases
   # for img: and link: described under handle_regexp_HYPERLINK
 
-  def gen_url url, text
+  def gen_url(url, text)
     scheme, url, id = parse_url url
 
     if %w[http https link].include?(scheme) and
@@ -431,7 +441,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Returns true if text is valid ruby syntax
 
-  def parseable? text
+  def parseable?(text)
     verbose, $VERBOSE = $VERBOSE, nil
     catch(:valid) do
       eval("BEGIN { throw :valid, true }\n#{text}")
@@ -445,7 +455,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Converts +item+ to HTML using RDoc::Text#to_html
 
-  def to_html item
+  def to_html(item)
     super convert_flow @am.flow item
   end
 

data/lib/rdoc/markup/to_html_crossref.rb

@@ -58,7 +58,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # 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, code = true, rdoc_ref: false
+  def cross_reference(name, text = nil, code = true, rdoc_ref: false)
     lookup = name
 
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
@@ -101,7 +101,7 @@ 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_regexp_HYPERLINK target
+  def handle_regexp_HYPERLINK(target)
     url = target.text
 
     case url
@@ -120,7 +120,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # All other contents are handled by
   # {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]
 
-  def handle_regexp_RDOCLINK target
+  def handle_regexp_RDOCLINK(target)
     url = target.text
 
     case url
@@ -135,7 +135,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Generates links for <tt>rdoc-ref:</tt> scheme URLs and allows
   # RDoc::Markup::ToHtml to handle other schemes.
 
-  def gen_url url, text
+  def gen_url(url, text)
     if url =~ /\Ardoc-ref:/
       name = $'
       cross_reference name, text, name == text, rdoc_ref: true
@@ -147,7 +147,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   ##
   # Creates an HTML link to +name+ with the given +text+.
 
-  def link name, text, code = true, rdoc_ref: false
+  def link(name, text, code = true, rdoc_ref: false)
     if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
       name = $1
       label = $'