rdoc 6.3.4.1 → 8.0.0

data/lib/rdoc/markup/to_html_crossref.rb

@@ -8,9 +8,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
   # :stopdoc:
   ALL_CROSSREF_REGEXP = RDoc::CrossReference::ALL_CROSSREF_REGEXP
-  CLASS_REGEXP_STR    = RDoc::CrossReference::CLASS_REGEXP_STR
   CROSSREF_REGEXP     = RDoc::CrossReference::CROSSREF_REGEXP
-  METHOD_REGEXP_STR   = RDoc::CrossReference::METHOD_REGEXP_STR
   # :startdoc:
 
   ##
@@ -29,47 +27,53 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # references are removed unless +show_hash+ is true.  Only method names
   # preceded by '#' or '::' are linked, unless +hyperlink_all+ is true.
 
-  def initialize(options, from_path, context, markup = nil)
+  def initialize(from_path, context, pipe: false, output_decoration: true,
+                 hyperlink_all: false, show_hash: false,
+                 autolink_excluded_words: [], warn_missing_rdoc_ref: true)
     raise ArgumentError, 'from_path cannot be nil' if from_path.nil?
 
-    super options, markup
+    super(pipe: pipe, output_decoration: output_decoration)
 
     @context       = context
     @from_path     = from_path
-    @hyperlink_all = @options.hyperlink_all
-    @show_hash     = @options.show_hash
+    @hyperlink_all = hyperlink_all
+    @show_hash     = show_hash
+    @autolink_excluded_words = autolink_excluded_words
+    @warn_missing_rdoc_ref = warn_missing_rdoc_ref
 
     @cross_reference = RDoc::CrossReference.new @context
   end
 
+  # :nodoc:
   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
+    crossref_re = @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.
+  # Returns +nil+ if the link target could not be resolved.
 
-  def cross_reference name, text = nil, code = true
-    lookup = name
-
-    name = name[1..-1] unless @show_hash if name[0, 1] == '#'
+  def cross_reference(name, text = nil, code = true, rdoc_ref: false)
+    # Strip '#' for link display text (e.g. #method shows as "method" in links)
+    display = !@show_hash && name.start_with?('#') ? name[1..] : name
 
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
-      text ||= "#{CGI.unescape $'} at <code>#{$1}</code>"
+    if !display.end_with?('+@', '-@') && match = display.match(/(.*[^#:])?@(.*)/)
+      context_name = match[1]
+      label = convert_string(RDoc::Text.decode_legacy_label(match[2]))
+      text ||= "#{label} at <code>#{convert_string(context_name)}</code>" if context_name
+      text ||= label
       code = false
     else
-      text ||= name
+      text ||= convert_string(display)
     end
 
-    link lookup, text, code
+    link(name, text, code, rdoc_ref: rdoc_ref)
   end
 
   ##
@@ -79,8 +83,9 @@ 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_regexp_CROSSREF(target)
-    name = target.text
+  def handle_regexp_CROSSREF(name)
+    return convert_string(name) if in_tidylink_label?
+    return name if @autolink_excluded_words&.include?(name)
 
     return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
 
@@ -90,18 +95,23 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       # cross-references to "new" in text, for instance)
       return name if name =~ /\A[a-z]*\z/
     end
-
-    cross_reference name
+    cross_reference(name, rdoc_ref: false) || convert_string(name)
   end
 
   ##
   # Handles <tt>rdoc-ref:</tt> scheme links and allows RDoc::Markup::ToHtml to
   # handle other schemes.
 
-  def handle_regexp_HYPERLINK target
-    return cross_reference $' if target.text =~ /\Ardoc-ref:/
+  def handle_regexp_HYPERLINK(url)
+    return convert_string(url) if in_tidylink_label?
 
-    super
+    case url
+    when /\Ardoc-ref:/
+      ref = $'
+      cross_reference(ref, rdoc_ref: true) || convert_string(ref)
+    else
+      super
+    end
   end
 
   ##
@@ -112,12 +122,15 @@ 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
-    url = target.text
-
+  def handle_regexp_RDOCLINK(url)
     case url
-    when /\Ardoc-ref:/ then
-      cross_reference $'
+    when /\Ardoc-ref:/
+      if in_tidylink_label?
+        convert_string(url)
+      else
+        ref = $'
+        cross_reference(ref, rdoc_ref: true) || convert_string(ref)
+      end
     else
       super
     end
@@ -127,50 +140,122 @@ 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
-    return super unless url =~ /\Ardoc-ref:/
-
-    name = $'
-    cross_reference name, text, name == text
+  def gen_url(url, text)
+    if url =~ /\Ardoc-ref:/
+      name = $'
+      cross_reference(name, text, name == text, rdoc_ref: true) || text
+    else
+      super
+    end
   end
 
   ##
-  # Creates an HTML link to +name+ with the given +text+.
+  # Creates an HTML link to +name+ with the given +html_string+.
+  # +html_string+ should be already escaped and may contain HTML tags.
+  # Returns the link HTML string, or +nil+ if the reference could not be resolved.
 
-  def link name, text, code = true
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
+  def link(name, html_string, code = true, rdoc_ref: false)
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
       name = $1
       label = $'
     end
 
-    ref = @cross_reference.resolve name, text
+    ref = @cross_reference.resolve name if name
 
-    case ref
-    when String then
-      ref
-    else
-      path = ref.as_href @from_path
+    # Non-text source files (C, Ruby, etc.) don't get HTML pages generated,
+    # so don't auto-link to them. Explicit rdoc-ref: links are still allowed.
+    if !rdoc_ref && RDoc::TopLevel === ref && !ref.text?
+      return
+    end
+
+    if ref
+      path = ref.as_href(@from_path)
 
       if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
-        text = "<code>#{CGI.escapeHTML text}</code>"
+        html_string = "<code>#{html_string}</code>"
       end
+    elsif name
+      if rdoc_ref && @warn_missing_rdoc_ref
+        puts "#{@from_path}: `rdoc-ref:#{name}` can't be resolved for `#{html_string}`"
+      end
+      return
+    else
+      # A bare label reference like @foo still produces a valid anchor link
+      return unless label
+      path = +""
+    end
 
-      if path =~ /#/ then
-        path << "-label-#{label}"
-      elsif ref.sections and
-            ref.sections.any? { |section| label == section.title } then
-        path << "##{label}"
+    if label
+      # Decode legacy labels (e.g., "What-27s+Here" -> "What's Here")
+      # then convert to GitHub-style anchor format
+      decoded_label = RDoc::Text.decode_legacy_label(label)
+      formatted_label = RDoc::Text.to_anchor(decoded_label)
+
+      # Case 1: Path already has an anchor (e.g., method link)
+      #   Input:  C1#method@label -> path="C1.html#method-i-m"
+      #   Output: C1.html#method-i-m-label
+      if path =~ /#/
+        path << "-#{formatted_label}"
+
+      # Case 2: Label matches a section title
+      #   Input:  C1@Section -> path="C1.html", section "Section" exists
+      #   Output: C1.html#section (uses section.aref for GitHub-style)
+      elsif (section = ref&.sections&.find { |s| decoded_label == s.title })
+        path << "##{section.aref}"
+
+      # Case 3: Ref has an aref (class/module context)
+      #   Input:  C1@heading -> path="C1.html", ref=C1 class
+      #   Output: C1.html#class-c1-heading
+      elsif ref.respond_to?(:aref)
+        path << "##{ref.aref}-#{formatted_label}"
+
+      # Case 4: No context, just the label (e.g., TopLevel/file)
+      #   Input:  README@section -> path="README_md.html"
+      #   Output: README_md.html#section
       else
-        if ref.respond_to?(:aref)
-          path << "##{ref.aref}-label-#{label}"
-        else
-          path << "#label-#{label}"
-        end
-      end if label
-
-      "<a href=\"#{path}\">#{text}</a>"
+        path << "##{formatted_label}"
+      end
     end
+
+    "<a href=\"#{path}\">#{html_string}</a>"
   end
 
-end
+  def handle_TT(code)
+    emit_inline(tt_cross_reference(code) || "<code>#{convert_string(code)}</code>")
+  end
+
+  # Applies additional special handling on top of the one defined in ToHtml.
+  # When a tidy link is <tt>{Foo}[rdoc-ref:Foo]</tt>, the label part is surrounded by <tt><code></code></tt>.
+  # TODO: reconsider this workaround.
+  def apply_tidylink_label_special_handling(label, url)
+    if url == "rdoc-ref:#{label}" && cross_reference(label)&.include?('<code>')
+      "<code>#{convert_string(label)}</code>"
+    else
+      super
+    end
+  end
 
+  # Handles cross-reference and suppressed-crossref inside tt tag.
+  # Returns nil if code is not an existing cross-reference nor a suppressed-crossref.
+  def tt_cross_reference(code)
+    return if in_tidylink_label?
+
+    crossref_regexp = @hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
+    # REGEXP sometimes matches a string that starts with a backslash but is not a
+    # suppressed cross-reference (for example, `\+`), so the backslash-removed
+    # part needs to be checked against crossref_regexp.
+    match = crossref_regexp.match(code.delete_prefix('\\'))
+    return unless match && match.begin(1).zero?
+    return unless match.post_match.match?(/\A[[:punct:]\s]*\z/)
+
+    # cross_reference(file_page) may return a link without code tag.
+    # We need to check it because this method shouldn't return an html text without code tag.
+    if code.start_with?('\\')
+      # Remove leading backslash if crossref exists
+      "<code>#{convert_string(code[1..])}</code>" if cross_reference(code[1..])&.include?('<code>')
+    else
+      html = cross_reference(code)
+      html if html&.include?('<code>')
+    end
+  end
+end

data/lib/rdoc/markup/to_html_snippet.rb

@@ -34,8 +34,8 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   # next word boundary after the given number of +characters+ or +paragraphs+
   # of text have been encountered.
 
-  def initialize options, characters = 100, paragraphs = 3, markup = nil
-    super options, markup
+  def initialize(characters = 100, paragraphs = 3)
+    super()
 
     @character_limit = characters
     @paragraph_limit = paragraphs
@@ -50,7 +50,7 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   ##
   # Adds +heading+ to the output as a paragraph
 
-  def accept_heading heading
+  def accept_heading(heading)
     @res << "<p>#{to_html heading.text}\n"
 
     add_paragraph
@@ -66,7 +66,10 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
 
   alias accept_rule ignore
 
-  def accept_paragraph paragraph
+  ##
+  # Adds +paragraph+ to the output
+
+  def accept_paragraph(paragraph)
     para = @in_list_entry.last || "<p>"
 
     text = paragraph.text @hard_break
@@ -79,20 +82,20 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   ##
   # Finishes consumption of +list_item+
 
-  def accept_list_item_end list_item
+  def accept_list_item_end(list_item)
   end
 
   ##
   # Prepares the visitor for consuming +list_item+
 
-  def accept_list_item_start list_item
+  def accept_list_item_start(list_item)
     @res << list_item_start(list_item, @list.last)
   end
 
   ##
   # Prepares the visitor for consuming +list+
 
-  def accept_list_start list
+  def accept_list_start(list)
     @list << list.type
     @res << html_list_name(list.type, true)
     @in_list_entry.push ''
@@ -101,12 +104,12 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   ##
   # Adds +verbatim+ to the output
 
-  def accept_verbatim verbatim
+  def accept_verbatim(verbatim)
     throw :done if @characters >= @character_limit
     input = verbatim.text.rstrip
-
-    text = truncate input
-    text << ' ...' unless text == input
+    text = truncate(input, @character_limit - @characters)
+    @characters += input.length
+    text << " #{TO_HTML_CHARACTERS[text.encoding][:ellipsis]}" unless text == input
 
     super RDoc::Markup::Verbatim.new text
 
@@ -125,22 +128,14 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   ##
   # Removes escaping from the cross-references in +target+
 
-  def handle_regexp_CROSSREF target
-    target.text.sub(/\A\\/, '')
-  end
-
-  ##
-  # +target+ is a <code><br></code>
-
-  def handle_regexp_HARD_BREAK target
-    @characters -= 4
-    '<br>'
+  def handle_regexp_CROSSREF(text)
+    text.sub(/\A\\/, '')
   end
 
   ##
   # Lists are paragraphs, but notes and labels have a separator
 
-  def list_item_start list_item, list_type
+  def list_item_start(list_item, list_type)
     throw :done if @characters >= @character_limit
 
     case list_type
@@ -165,7 +160,7 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   # Returns just the text of +link+, +url+ is only used to determine the link
   # type.
 
-  def gen_url url, text
+  def gen_url(url, text)
     if url =~ /^rdoc-label:([^:]*)(?::(.*))?/ then
       type = "link"
     elsif url =~ /([A-Za-z]+):(.*)/ then
@@ -185,7 +180,7 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   ##
   # In snippets, there are no lists
 
-  def html_list_name list_type, open_tag
+  def html_list_name(list_type, open_tag)
     ''
   end
 
@@ -201,7 +196,7 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   ##
   # Marks up +content+
 
-  def convert content
+  def convert(content)
     catch :done do
       return super
     end
@@ -209,77 +204,84 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
     end_accepting
   end
 
-  ##
-  # Converts flow items +flow+
+  def handle_PLAIN_TEXT(text) # :nodoc:
+    return if inline_limit_reached?
 
-  def convert_flow flow
-    throw :done if @characters >= @character_limit
+    truncated = truncate(text, @inline_character_limit)
+    @inline_character_limit -= text.size
+    emit_inline(convert_string(truncated))
+  end
 
-    res = []
-    @mask = 0
-
-    flow.each do |item|
-      case item
-      when RDoc::Markup::AttrChanger then
-        off_tags res, item
-        on_tags  res, item
-      when String then
-        text = convert_string item
-        res << truncate(text)
-      when RDoc::Markup::RegexpHandling then
-        text = convert_regexp_handling item
-        res << truncate(text)
-      else
-        raise "Unknown flow element: #{item.inspect}"
-      end
-
-      if @characters >= @character_limit then
-        off_tags res, RDoc::Markup::AttrChanger.new(0, @mask)
-        break
-      end
-    end
+  def handle_REGEXP_HANDLING_TEXT(text) # :nodoc:
+    return if inline_limit_reached?
 
-    res << ' ...' if @characters >= @character_limit
+    # We can't truncate text including html tags.
+    # Just emit as is, and count all characters including html tag part.
+    emit_inline(text)
+    @inline_character_limit -= text.size
+  end
 
-    res.join
+  def handle_BOLD(nodes)
+    super unless inline_limit_reached?
   end
 
-  ##
-  # Maintains a bitmask to allow HTML elements to be closed properly.  See
-  # RDoc::Markup::Formatter.
+  def handle_BOLD_WORD(word)
+    super unless inline_limit_reached?
+  end
+
+  def handle_EM(nodes)
+    super unless inline_limit_reached?
+  end
 
-  def on_tags res, item
-    @mask ^= item.turn_on
+  def handle_EM_WORD(word)
+    super unless inline_limit_reached?
+  end
 
-    super
+  def handle_TT(code)
+    super unless inline_limit_reached?
   end
 
-  ##
-  # Maintains a bitmask to allow HTML elements to be closed properly.  See
-  # RDoc::Markup::Formatter.
+  def handle_STRIKE(nodes)
+    super unless inline_limit_reached?
+  end
 
-  def off_tags res, item
-    @mask ^= item.turn_off
+  def handle_HARD_BREAK
+    super unless inline_limit_reached?
+  end
 
-    super
+  def handle_TIDYLINK(label_part, url)
+    traverse_inline_nodes(label_part) unless inline_limit_reached?
   end
 
-  ##
-  # Truncates +text+ at the end of the first word after the character_limit.
+  def inline_limit_reached?
+    @inline_character_limit <= 0
+  end
 
-  def truncate text
-    length = text.length
-    characters = @characters
-    @characters += length
+  def handle_inline(text)
+    limit = @character_limit - @characters
+    return ['', 0] if limit <= 0
+    @inline_character_limit = limit
+    res = super
+    res << " #{TO_HTML_CHARACTERS[text.encoding][:ellipsis]}" if @inline_character_limit <= 0
+    @characters += limit - @inline_character_limit
+    res
+  end
 
-    return text if @characters < @character_limit
+  def to_html(item)
+    throw :done if @characters >= @character_limit
+    handle_inline(item)
+  end
 
-    remaining = @character_limit - characters
+  ##
+  # Truncates +text+ at the end of the first word after the limit.
+
+  def truncate(text, limit)
+    return text if limit >= text.size
+    return '' if limit <= 0
 
-    text =~ /\A(.{#{remaining},}?)(\s|$)/m # TODO word-break instead of \s?
+    text =~ /\A(.{#{limit},}?)(\s|$)/m # TODO word-break instead of \s?
 
     $1
   end
 
 end
-

data/lib/rdoc/markup/to_joined_paragraph.rb

@@ -8,11 +8,6 @@
 # other markup syntax items will not work.
 
 class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
-
-  def initialize # :nodoc:
-    super nil
-  end
-
   def start_accepting # :nodoc:
   end
 
@@ -22,12 +17,12 @@ class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
   ##
   # Converts the parts of +paragraph+ to a single entry.
 
-  def accept_paragraph paragraph
+  def accept_paragraph(paragraph)
     parts = paragraph.parts.chunk do |part|
       String === part
-    end.map do |string, chunk|
+    end.flat_map do |string, chunk|
       string ? chunk.join.rstrip : chunk
-    end.flatten
+    end
 
     paragraph.parts.replace parts
   end
@@ -44,4 +39,3 @@ class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
   alias accept_table           ignore
 
 end
-

data/lib/rdoc/markup/to_label.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'cgi'
+require 'cgi/escape'
+require 'cgi/util' unless defined?(CGI::EscapeExt)
 
 ##
 # Creates HTML-safe labels suitable for use in id attributes.  Tidylinks are
@@ -13,47 +14,57 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   ##
   # Creates a new formatter that will output HTML-safe labels
 
-  def initialize markup = nil
-    super nil, markup
+  def initialize
+    super
 
     @markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
-    @markup.add_regexp_handling(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)
-
-    add_tag :BOLD, '', ''
-    add_tag :TT,   '', ''
-    add_tag :EM,   '', ''
 
     @res = []
   end
 
-  ##
-  # Converts +text+ to an HTML-safe label
+  def handle_PLAIN_TEXT(text)
+    @res << text
+  end
 
-  def convert text
-    label = convert_flow @am.flow text
+  def handle_REGEXP_HANDLING_TEXT(text)
+    @res << text
+  end
 
-    CGI.escape(label).gsub('%', '-').sub(/^-/, '')
+  def handle_TT(text)
+    @res << text
+  end
+
+  def extract_plaintext(text)
+    @res = []
+    handle_inline(text)
+    @res.join
   end
 
   ##
-  # Converts the CROSSREF +target+ to plain text, removing the suppression
-  # marker, if any
+  # Converts +text+ to an HTML-safe label using GitHub-style anchor formatting.
 
-  def handle_regexp_CROSSREF target
-    text = target.text
+  def convert(text)
+    label = extract_plaintext(text)
 
-    text.sub(/^\\/, '')
+    RDoc::Text.to_anchor(label)
   end
 
   ##
-  # Converts the TIDYLINK +target+ to just the text part
+  # Converts +text+ to an HTML-safe label using legacy RDoc formatting.
+  # Used for generating backward-compatible anchor aliases.
 
-  def handle_regexp_TIDYLINK target
-    text = target.text
+  def convert_legacy(text)
+    label = extract_plaintext(text)
 
-    return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
+    CGI.escape(label).gsub('%', '-').sub(/^-/, '')
+  end
 
-    $1
+  ##
+  # Converts the CROSSREF +target+ to plain text, removing the suppression
+  # marker, if any
+
+  def handle_regexp_CROSSREF(text)
+    text.sub(/^\\/, '')
   end
 
   alias accept_blank_line         ignore
@@ -68,8 +79,6 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   alias accept_rule               ignore
   alias accept_verbatim           ignore
   alias end_accepting             ignore
-  alias handle_regexp_HARD_BREAK  ignore
   alias start_accepting           ignore
 
 end
-