rdoc 7.0.1 → 7.1.0

data/lib/rdoc/markup/to_html.rb

@@ -221,10 +221,15 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
 
   def accept_verbatim(verbatim)
     text = verbatim.text.rstrip
+    format = verbatim.format
 
     klass = nil
 
-    content = if verbatim.ruby? or parseable? text then
+    # Apply Ruby syntax highlighting if
+    # - explicitly marked as Ruby (via ruby? which accepts :ruby or :rb)
+    # - no format specified but the text is parseable as Ruby
+    # Otherwise, add language class when applicable and skip Ruby highlighting
+    content = if verbatim.ruby? || (format.nil? && parseable?(text))
                 begin
                   tokens = RDoc::Parser::RipperStateLex.parse text
                   klass  = ' class="ruby"'
@@ -236,6 +241,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
                   CGI.escapeHTML text
                 end
               else
+                klass = " class=\"#{format}\"" if format
                 CGI.escapeHTML text
               end
 
@@ -306,6 +312,13 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
     level = [6, heading.level].min
 
     label = heading.label @code_object
+    legacy_label = heading.legacy_label @code_object
+
+    # Add legacy anchor before the heading for backward compatibility.
+    # This allows old links with label- prefix to still work.
+    if @options.output_decoration && !@options.pipe
+      @res << "\n<span id=\"#{legacy_label}\" class=\"legacy-anchor\"></span>"
+    end
 
     @res << if @options.output_decoration
               "\n<h#{level} id=\"#{label}\">"
@@ -362,14 +375,18 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   end
 
   ##
-  # Generate a link to +url+ with content +text+.  Handles the special cases
-  # for img: and link: described under handle_regexp_HYPERLINK
+  # Generates an HTML link or image tag for the given +url+ and +text+.
+  #
+  # - Image URLs (http/https/link ending in .gif, .png, .jpg, .jpeg, .bmp)
+  #   become <img> tags
+  # - File references (.rb, .rdoc, .md) are converted to .html paths
+  # - Anchor URLs (#foo) pass through unchanged for GitHub-style header linking
+  # - Footnote links get wrapped in <sup> tags
 
   def gen_url(url, text)
     scheme, url, id = parse_url url
 
-    if %w[http https link].include?(scheme) and
-       url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
+    if %w[http https link].include?(scheme) && url =~ /\.(gif|png|jpg|jpeg|bmp)\z/
       "<img src=\"#{url}\" />"
     else
       if scheme != 'link' and %r%\A((?!https?:)(?:[^/#]*/)*+)([^/#]+)\.(rb|rdoc|md)(?=\z|#)%i =~ url
@@ -381,9 +398,11 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
 
       link = "<a#{id} href=\"#{url}\">#{text}</a>"
 
-      link = "<sup>#{link}</sup>" if /"foot/ =~ id
-
-      link
+      if /"foot/.match?(id)
+        "<sup>#{link}</sup>"
+      else
+        link
+      end
     end
   end
 
@@ -400,9 +419,10 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   # Maps attributes to HTML tags
 
   def init_tags
-    add_tag :BOLD, "<strong>", "</strong>"
-    add_tag :TT,   "<code>",   "</code>"
-    add_tag :EM,   "<em>",     "</em>"
+    add_tag :BOLD,   "<strong>", "</strong>"
+    add_tag :TT,     "<code>",   "</code>"
+    add_tag :EM,     "<em>",     "</em>"
+    add_tag :STRIKE, "<del>",    "</del>"
   end
 
   ##

data/lib/rdoc/markup/to_html_crossref.rb

@@ -169,14 +169,33 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       end
 
       if label
+        # Convert label to GitHub-style anchor format
+        # First convert + to space (URL encoding), then apply GitHub-style rules
+        formatted_label = RDoc::Text.to_anchor(label.tr('+', ' '))
+
+        # 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 << "-label-#{label}"
-        elsif ref&.sections&.any? { |section| label == section.title }
-          path << "##{label}"
+          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| label.tr('+', ' ') == 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}-label-#{label}"
+          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
-          path << "#label-#{label}"
+          path << "##{formatted_label}"
         end
       end
 

data/lib/rdoc/markup/to_label.rb

@@ -28,11 +28,21 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   end
 
   ##
-  # Converts +text+ to an HTML-safe label
+  # Converts +text+ to an HTML-safe label using GitHub-style anchor formatting.
 
   def convert(text)
     label = convert_flow @am.flow text
 
+    RDoc::Text.to_anchor(label)
+  end
+
+  ##
+  # Converts +text+ to an HTML-safe label using legacy RDoc formatting.
+  # Used for generating backward-compatible anchor aliases.
+
+  def convert_legacy(text)
+    label = convert_flow @am.flow text
+
     CGI.escape(label).gsub('%', '-').sub(/^-/, '')
   end
 

data/lib/rdoc/markup/verbatim.rb

@@ -70,7 +70,7 @@ class RDoc::Markup::Verbatim < RDoc::Markup::Raw
 
   def ruby?
     @format ||= nil # TODO for older ri data, switch the tree to marshal_dump
-    @format == :ruby
+    @format == :ruby || @format == :rb
   end
 
   ##

data/lib/rdoc/markup.rb

@@ -16,7 +16,7 @@
 #
 # - +rdoc+:
 #   the +RDoc+ markup format;
-#   see RDoc::MarkupReference.
+#   see {RDoc Markup Reference}[rdoc-ref:doc/markup_reference/rdoc.rdoc]
 # - +markdown+:
 #   The +markdown+ markup format as described in
 #   the {Markdown Guide}[https://www.markdownguide.org];
@@ -102,7 +102,7 @@
 #
 # = \RDoc Markup Reference
 #
-# See RDoc::MarkupReference.
+# See {RDoc Markup Reference}[rdoc-ref:doc/markup_reference/rdoc.rdoc]
 #
 #--
 # Original Author:: Dave Thomas,  dave@pragmaticprogrammer.com
@@ -210,6 +210,7 @@ https://github.com/ruby/rdoc/issues
   autoload :BlankLine,             "#{__dir__}/markup/blank_line"
   autoload :BlockQuote,            "#{__dir__}/markup/block_quote"
   autoload :Document,              "#{__dir__}/markup/document"
+  autoload :Element,               "#{__dir__}/markup/element"
   autoload :HardBreak,             "#{__dir__}/markup/hard_break"
   autoload :Heading,               "#{__dir__}/markup/heading"
   autoload :Include,               "#{__dir__}/markup/include"

data/lib/rdoc/parser/changelog.rb

@@ -293,6 +293,10 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
       end
 
       def aref
+        commit
+      end
+
+      def legacy_aref
         "label-#{commit}"
       end
 
@@ -300,6 +304,10 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
         aref
       end
 
+      def legacy_label(context = nil)
+        legacy_aref
+      end
+
       def text
         case base
         when nil

data/lib/rdoc/text.rb

@@ -319,4 +319,19 @@ module RDoc::Text
 
   SPACE_SEPARATED_LETTER_CLASS = /[\p{Nd}\p{Lc}\p{Pc}]|[!-~&&\W]/
 
+  ##
+  # Converts +text+ to a GitHub-style anchor ID:
+  # - Lowercase
+  # - Remove characters that aren't alphanumeric, space, or hyphen
+  # - Replace spaces with hyphens
+  #
+  # Examples:
+  #   "Hello World"  -> "hello-world"
+  #   "Foo::Bar"     -> "foobar"
+  #   "What's New?"  -> "whats-new"
+
+  module_function def to_anchor(text)
+    text.downcase.gsub(/[^a-z0-9 \-]/, '').gsub(' ', '-')
+  end
+
 end

data/lib/rdoc/token_stream.rb

@@ -45,13 +45,7 @@ module RDoc::TokenStream
                                then 'ruby-identifier'
               end
 
-      comment_with_nl = false
-      if :on_comment == t[:kind] or :on_embdoc == t[:kind] or :on_heredoc_end == t[:kind]
-        comment_with_nl = true if "\n" == t[:text][-1]
-        text = t[:text].rstrip
-      else
-        text = t[:text]
-      end
+      text = t[:text]
 
       if :on_ident == t[:kind] && starting_title
         starting_title = false
@@ -65,7 +59,9 @@ module RDoc::TokenStream
       text = CGI.escapeHTML text
 
       if style then
-        "<span class=\"#{style}\">#{text}</span>#{"\n" if comment_with_nl}"
+        end_with_newline = text.end_with?("\n")
+        text = text.chomp if end_with_newline
+        "<span class=\"#{style}\">#{text}</span>#{"\n" if end_with_newline}"
       else
         text
       end

data/lib/rdoc/version.rb

@@ -5,6 +5,6 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '7.0.1'
+  VERSION = '7.1.0'
 
 end

data/rdoc.gemspec

@@ -40,8 +40,8 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
   non_lib_files = [
     "CONTRIBUTING.md",
     "CVE-2013-0256.rdoc",
-    "ExampleMarkdown.md",
-    "ExampleRDoc.rdoc",
+    "doc/markup_reference/markdown.md",
+    "doc/markup_reference/rdoc.rdoc",
     "History.rdoc",
     "LEGAL.rdoc",
     "LICENSE.rdoc",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.1.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2025-12-18 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -75,8 +75,6 @@ extensions: []
 extra_rdoc_files:
 - CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
@@ -86,14 +84,14 @@ extra_rdoc_files:
 files:
 - CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
 - README.md
 - RI.md
 - TODO.rdoc
+- doc/markup_reference/markdown.md
+- doc/markup_reference/rdoc.rdoc
 - exe/rdoc
 - exe/ri
 - lib/rdoc.rb
@@ -234,6 +232,7 @@ files:
 - lib/rdoc/markup/blank_line.rb
 - lib/rdoc/markup/block_quote.rb
 - lib/rdoc/markup/document.rb
+- lib/rdoc/markup/element.rb
 - lib/rdoc/markup/formatter.rb
 - lib/rdoc/markup/hard_break.rb
 - lib/rdoc/markup/heading.rb
@@ -324,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

data/ExampleMarkdown.md

@@ -1,39 +0,0 @@
-# Example Markdown
-
-This document contains example output to show RDoc styling.  This file was
-created from a Markdown file.
-
-For the following styles, see ExampleRDoc.rdoc for style examples:
-
-* Headings
-* Paragraphs
-* Code blocks (verbatim sections)
-* Definition lists
-* Ordered lists
-* Unordered lists
-
-These items all use the same styles as RDoc format files.
-
-## Footnotes
-
-Footnotes are rendered at the bottom of the documentation section[^1].  For
-pages this will be at the bottom of the page.  For method documentation this
-will be at the end of the current method.
-
-[^1]: Here is the footnote content.  As you can see it is at the bottom of the
-page.
-
-## Blockquotes
-
-Here is how a blockquote looks.
-
-> We finished our first sensor sweep of the neutral zone. Now, how the hell do
-> we defeat an enemy that knows us better than we know ourselves? and attack
-> the Romulans.
->
-> > Sorry, Data. I guess it's better to be lucky than good. The unexpected is
-> > our normal routine. Could someone survive inside a transporter buffer for
-> > 75 years?
-
-This text is from [Riker Ipsum](http://rikeripsum.com)
-

data/ExampleRDoc.rdoc

@@ -1,210 +0,0 @@
-= Example \RDoc
-
-This document contains example output to show RDoc styling.  This file was
-created from a RDoc Markup file.
-
-== Headings
-
-You should not use headings beyond level 3, it is a sign of poor organization
-of your code or documentation.  It also becomes difficult for the user to
-figure out what you are attempting to explain to them as they have to track
-the multiple layers of nesting.
-
-= Heading level 1
-
-Above is a level one heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-== Heading level 2
-
-Above is a level two heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-=== Heading level 3
-
-Above is a level three heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-==== Heading level 4
-
-Above is a level four heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-===== Heading level 5
-
-Above is a level five heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-====== Heading level 6
-
-Above is a level six heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-== Paragraphs
-
-This is how a paragraph looks.  Since it is difficult to generate good content
-for paragraphs I have chosen to use {Riker Ipsum}[http://rikeripsum.com] for
-nonsense filler content.  In the previous sentence you can see how a link is
-formatted.
-
-Here is an example of *bold* and _emphasis_ styling.  Try not to combine the
-two or use them too often.  Here is an example of <code>inline verbatim
-text</code>.  That should be enough of a taste of inline markup in paragraphs.
-The Riker Ipsum filler follows:
-
-Shields up! Rrrrred alert! Well, I'll say this for him - he's sure of himself.
-and attack the Romulans. Worf, It's better than music. It's jazz. This should
-be interesting. When has justice ever been as simple as a rule book? Flair is
-what marks the difference between artistry and mere competence.
-
-Sorry, Data. I think you've let your personal feelings cloud your judgement. We
-finished our first sensor sweep of the neutral zone. Yes, absolutely, I do
-indeed concur, wholeheartedly! Mr. Worf, you do remember how to fire phasers? A
-lot of things can change in twelve years, Admiral. Your shields were failing,
-sir.
-
-== Verbatim sections
-
-A verbatim section typically contains source code or example output.  This is
-how verbatim blocks of code looks:
-
-  def local responder
-    responder.ping do |value|
-      return value
-    end
-  end
-  
-  def ping uri
-    @uri = uri
-    @remote = DRb::DRbObject.new_with_uri @uri
-  
-    @remote.ping do |value|
-      return value
-    end
-  end
-
-This is a paragraph following the verbatim block so you can see how leading and trailing paragraphs interact with it.
-
-== Unordered lists
-
-Here is an unordered list.  As you can see it uses non-numeral markers for each list item:
-
-* This is the top-most item in the list.
-* This is a second item in the list.
-
-  Unlike the first item, this item has more than one paragraph so you can see
-  how they interact.
-* This is a third item in the list.  Like the item before it, this item has a
-  second paragraph.
-
-  Here is the second paragraph in the list item.
-* A final list item.
-
-== Ordered lists
-
-Here is an ordered list.  As you can see it uses numeral markers for each list
-item:
-
-1. This is the first item in the list.
-1. This is the second item in the list.
-
-   Unlike the first item, this item has more than one paragraph so you can see
-   how they interact.
-1. This is the third item in the list.  Like the item before it, this item has
-   a second paragraph.
-
-   Here is the second paragraph in the third list item.
-1. The fourth and final list item.
-
-== Definition lists
-
-=== "Note" list
-
-The "note" syntax can be used to create a definition list:
-
-  note::
-    description
-
-Here is such a definition list:
-
-cat::
-  A cat is a small mammal that is commonly kept as a pet.
-
-dog::
-  A dog is a mammal that is also kept as a pet.  A dog may range in size from
-  smaller than a cat to larger than a human.
-
-  Typically dogs are easier to train to respond to commands than cats.
-
-rabbit::
-  Rabbits are also mammals, but are infrequently kept as pets.  Most rabbits
-  are wild.
-
-=== "Label" list
-
-The "label" syntax can be used to create a definition list:
-
-  [label]
-    description
-
-Here is such a definition list:
-
-[cat]
-  A cat is a small mammal that is commonly kept as a pet.
-
-[dog]
-  A dog is a mammal that is also kept as a pet.  A dog may range in size from
-  smaller than a cat to larger than a human.
-
-  Typically dogs are easier to train to respond to commands than cats.
-
-[rabbit]
-  Rabbits are also mammals, but are infrequently kept as pets.  Most rabbits
-  are wild.
-
-== Rule
-
-A rule is a horizontal divider between two paragraphs.  Following this
-paragraph is a rule.
-
----
-
-In historic versions of RDoc you could control the height of the rule in HTML
-output.  This is no longer true as HTML 5 does not support this.
-