rdoc 6.17.0 → 7.2.0

data/lib/rdoc/options.rb

@@ -411,7 +411,7 @@ class RDoc::Options
     @files = nil
     @force_output = false
     @force_update = true
-    @generator_name = "darkfish"
+    @generator_name = "aliki"
     @generators = RDoc::RDoc::GENERATORS
     @generator_options = []
     @hyperlink_all = false

data/lib/rdoc/parser/changelog.rb

@@ -274,6 +274,27 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
       def initialize(base, commit, author, email, date, contents)
         case contents
         when String
+          if base&.match(%r[\A([^:/]+:/+[^/]+/)[^/]+/[^/]+/])
+            repo, host = $&, $1
+            contents = contents.dup
+            # base: https://github.com/ruby/ruby/
+            #   Fix #15791 -> Fix [#15791](https://github.com/ruby/ruby/pull/15791)
+            #   GH-15791 -> [GH-15791](https://github.com/ruby/ruby/pull/15791)
+            #   (#15791) -> ([#15791](https://github.com/ruby/ruby/pull/15791))
+            contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K\#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do
+              "[#{$&}](#{repo}pull/#{$1 || $2 || $3})"
+            end
+            # repo#PR, repo@HASH
+            #   ruby/ruby#15791 -> [ruby/ruby#15791](https://github.com/ruby/ruby/pull/15791)
+            #   ruby/ruby@a8a989b6 -> [ruby/ruby@a8a989b6](https://github.com/ruby/ruby/commit/a8a989b6)
+            # ref in branckets is not extended
+            #   [ruby/net-imap#543][ruby/ruby#15791] -> [ruby/net-imap#543][ruby/ruby#15791]
+            contents.gsub!(%r[(?<![-\w#/@]|\]\[)([-\w]+/[-\w]+)(?:@(\h{8,40})|\#(\d+))(?![-\w#/@]|\]\[)]) do
+              path = defined?($2) ? "commit/#{$2}" : "pull/#{$3}"
+              "[#{$&}](#{host}#{$1}/#{path})"
+            end
+          end
+
           contents = RDoc::Markdown.parse(contents).parts.each do |body|
             case body
             when RDoc::Markup::Heading
@@ -293,6 +314,10 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
       end
 
       def aref
+        commit
+      end
+
+      def legacy_aref
         "label-#{commit}"
       end
 
@@ -300,6 +325,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/parser/prism_ruby.rb

@@ -16,7 +16,7 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
   parse_files_matching(/\.rbw?$/) if ENV['RDOC_USE_PRISM_PARSER']
 
   attr_accessor :visibility
-  attr_reader :container, :singleton
+  attr_reader :container, :singleton, :in_proc_block
 
   def initialize(top_level, content, options, stats)
     super
@@ -43,9 +43,10 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
   # example: `Module.new { include M }` `M.module_eval { include N }`
 
   def with_in_proc_block
+    in_proc_block = @in_proc_block
     @in_proc_block = true
     yield
-    @in_proc_block = false
+    @in_proc_block = in_proc_block
   end
 
   # Dive into another container
@@ -59,11 +60,6 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
     @container = container
     @singleton = singleton
     @in_proc_block = false
-    unless singleton
-      # Need to update module parent chain to emulate Module.nesting.
-      # This mechanism is inaccurate and needs to be fixed.
-      container.parent = old_container
-    end
     @module_nesting.push([container, singleton])
     yield container
   ensure
@@ -482,12 +478,14 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
     end
   end
 
+  # Adds includes/extends. Module name is resolved to full before adding.
+
   def add_includes_extends(names, rdoc_class, line_no) # :nodoc:
-    return if @in_proc_block
     comment, directives = consecutive_comment(line_no)
     handle_code_object_directives(@container, directives) if directives
     names.each do |name|
-      ie = @container.add(rdoc_class, name, '')
+      resolved_name = resolve_constant_path(name)
+      ie = @container.add(rdoc_class, resolved_name || name, '')
       ie.store = @store
       ie.line = line_no
       ie.comment = comment
@@ -510,8 +508,6 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
   # Adds a method defined by `def` syntax
 
   def add_method(method_name, receiver_name:, receiver_fallback_type:, visibility:, singleton:, params:, calls_super:, block_params:, tokens:, start_line:, args_end_line:, end_line:)
-    return if @in_proc_block
-
     receiver = receiver_name ? find_or_create_module_path(receiver_name, receiver_fallback_type) : @container
     comment, directives = consecutive_comment(start_line)
     handle_code_object_directives(@container, directives) if directives
@@ -590,7 +586,7 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
     else
       @module_nesting.reverse_each do |nesting, singleton|
         next if singleton
-        mod = nesting.find_module_named(root_name)
+        mod = nesting.get_module_named(root_name)
         break if mod
         # If a constant is found and it is not a module or class, RDoc can't document about it.
         # Return an anonymous module to avoid wrong document creation.
@@ -601,9 +597,9 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
       mod ||= add_module.call(last_nesting, root_name, :module)
     end
     path.each do |name|
-      mod = mod.find_module_named(name) || add_module.call(mod, name, :module)
+      mod = mod.get_module_named(name) || add_module.call(mod, name, :module)
     end
-    mod.find_module_named(name) || add_module.call(mod, name, create_mode)
+    mod.get_module_named(name) || add_module.call(mod, name, create_mode)
   end
 
   # Resolves constant path to a full path by searching module nesting
@@ -614,10 +610,10 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
     mod = nil
     @module_nesting.reverse_each do |nesting, singleton|
       next if singleton
-      mod = nesting.find_module_named(owner_name)
+      mod = nesting.get_module_named(owner_name)
       break if mod
     end
-    mod ||= @top_level.find_module_named(owner_name)
+    mod ||= @top_level.get_module_named(owner_name)
     [mod.full_name, path].compact.join('::') if mod
   end
 
@@ -657,7 +653,8 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
       if rhs_name =~ /^::/
         @store.find_class_or_module(rhs_name)
       else
-        @container.find_module_named(rhs_name)
+        full_name = resolve_constant_path(rhs_name)
+        @store.find_class_or_module(full_name)
       end
     if mod && constant.document_self
       a = @container.add_module_alias(mod, rhs_name, constant, @top_level)
@@ -746,11 +743,14 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
         when :extend
           _visit_call_extend(node)
         when :public
-          _visit_call_public_private_protected(node, :public) { super }
+          super
+          _visit_call_public_private_protected(node, :public)
         when :private
-          _visit_call_public_private_protected(node, :private) { super }
+          super
+          _visit_call_public_private_protected(node, :private)
         when :protected
-          _visit_call_public_private_protected(node, :protected) { super }
+          super
+          _visit_call_public_private_protected(node, :protected)
         when :private_constant
           _visit_call_private_constant(node)
         when :public_constant
@@ -760,13 +760,15 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
         when :alias_method
           _visit_call_alias_method(node)
         when :module_function
-          _visit_call_module_function(node) { super }
+          super
+          _visit_call_module_function(node)
         when :public_class_method
-          _visit_call_public_private_class_method(node, :public) { super }
+          super
+          _visit_call_public_private_class_method(node, :public)
         when :private_class_method
-          _visit_call_public_private_class_method(node, :private) { super }
+          super
+          _visit_call_public_private_class_method(node, :private)
         else
-          node.arguments&.accept(self)
           super
         end
       else
@@ -776,12 +778,14 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
 
     def visit_block_node(node)
       @scanner.with_in_proc_block do
-        # include, extend and method definition inside block are not documentable
+        # include, extend and method definition inside block are not documentable.
+        # visibility methods and attribute definition methods should be ignored inside block.
         super
       end
     end
 
     def visit_alias_method_node(node)
+      return if @scanner.in_proc_block
       @scanner.process_comments_until(node.location.start_line - 1)
       return unless node.old_name.is_a?(Prism::SymbolNode) && node.new_name.is_a?(Prism::SymbolNode)
       @scanner.add_alias_method(node.old_name.value.to_s, node.new_name.value.to_s, node.location.start_line)
@@ -860,6 +864,8 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
       end_line = node.location.end_line
       @scanner.process_comments_until(start_line - 1)
 
+      return if @scanner.in_proc_block
+
       case node.receiver
       when Prism::NilNode, Prism::TrueNode, Prism::FalseNode
         visibility = :public
@@ -997,37 +1003,39 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
     end
 
     def _visit_call_module_function(call_node)
-      yield
-      return if @scanner.singleton
+      return if @scanner.in_proc_block || @scanner.singleton
       names = visibility_method_arguments(call_node, singleton: false)&.map(&:to_s)
       @scanner.change_method_to_module_function(names) if names
     end
 
     def _visit_call_public_private_class_method(call_node, visibility)
-      yield
-      return if @scanner.singleton
+      return if @scanner.in_proc_block || @scanner.singleton
       names = visibility_method_arguments(call_node, singleton: true)
       @scanner.change_method_visibility(names, visibility, singleton: true) if names
     end
 
     def _visit_call_public_private_protected(call_node, visibility)
+      return if @scanner.in_proc_block
       arguments_node = call_node.arguments
       if arguments_node.nil? # `public` `private`
         @scanner.visibility = visibility
       else # `public :foo, :bar`, `private def foo; end`
-        yield
         names = visibility_method_arguments(call_node, singleton: false)
         @scanner.change_method_visibility(names, visibility) if names
       end
     end
 
     def _visit_call_alias_method(call_node)
+      return if @scanner.in_proc_block
+
       new_name, old_name, *rest = symbol_arguments(call_node)
       return unless old_name && new_name && rest.empty?
       @scanner.add_alias_method(old_name.to_s, new_name.to_s, call_node.location.start_line)
     end
 
     def _visit_call_include(call_node)
+      return if @scanner.in_proc_block
+
       names = constant_arguments_names(call_node)
       line_no = call_node.location.start_line
       return unless names
@@ -1040,26 +1048,30 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
     end
 
     def _visit_call_extend(call_node)
+      return if @scanner.in_proc_block
+
       names = constant_arguments_names(call_node)
       @scanner.add_extends(names, call_node.location.start_line) if names && !@scanner.singleton
     end
 
     def _visit_call_public_constant(call_node)
-      return if @scanner.singleton
+      return if @scanner.in_proc_block || @scanner.singleton
       names = symbol_arguments(call_node)
       @scanner.container.set_constant_visibility_for(names.map(&:to_s), :public) if names
     end
 
     def _visit_call_private_constant(call_node)
-      return if @scanner.singleton
+      return if @scanner.in_proc_block || @scanner.singleton
       names = symbol_arguments(call_node)
       @scanner.container.set_constant_visibility_for(names.map(&:to_s), :private) if names
     end
 
     def _visit_call_attr_reader_writer_accessor(call_node, rw)
+      return if @scanner.in_proc_block
       names = symbol_arguments(call_node)
       @scanner.add_attributes(names.map(&:to_s), rw, call_node.location.start_line) if names
     end
+
     class MethodSignatureVisitor < Prism::Visitor # :nodoc:
       class << self
         def scan_signature(def_node)

data/lib/rdoc/parser/ruby.rb

@@ -101,7 +101,7 @@ require_relative 'ripper_state_lex'
 #
 # The parser looks at the token after the identifier to determine the name, in
 # this example, :meta_method.  If a name cannot be found, a warning is printed
-# and 'unknown is used.
+# and 'unknown' is used.
 #
 # You can force the name of a method using the :method: directive:
 #

data/lib/rdoc/rubygems_hook.rb

@@ -118,7 +118,7 @@ class RDoc::RubyGemsHook
   end
 
   ##
-  # Generates documentation using the named +generator+ ("darkfish" or "ri")
+  # Generates documentation using the named +generator+ ("aliki" or "ri")
   # and following the given +options+.
   #
   # Documentation will be generated into +destination+
@@ -190,7 +190,7 @@ class RDoc::RubyGemsHook
 
     Dir.chdir @spec.full_gem_path do
       # RDoc::Options#finish must be called before parse_files.
-      # RDoc::Options#finish is also called after ri/darkfish generator setup.
+      # RDoc::Options#finish is also called after ri/aliki generator setup.
       # We need to dup the options to avoid modifying it after finish is called.
       parse_options = options.dup
       parse_options.finish
@@ -202,7 +202,7 @@ class RDoc::RubyGemsHook
     document 'ri',       options, @ri_dir if
       @generate_ri   and (@force or not File.exist? @ri_dir)
 
-    document 'darkfish', options, @rdoc_dir if
+    document 'aliki', options, @rdoc_dir if
       @generate_rdoc and (@force or not File.exist? @rdoc_dir)
   end
 

data/lib/rdoc/text.rb

@@ -193,11 +193,15 @@ module RDoc::Text
     text.gsub(/^\s+$/, empty)
   end
 
+  def to_html(text)
+    to_html_characters(text)
+  end
+
   ##
   # Converts ampersand, dashes, ellipsis, quotes, copyright and registered
   # trademark symbols in +text+ to properly encoded characters.
 
-  def to_html(text)
+  def to_html_characters(text)
     html = (''.encode text.encoding).dup
 
     encoded = RDoc::Text::TO_HTML_CHARACTERS[text.encoding]
@@ -210,15 +214,12 @@ module RDoc::Text
     until s.eos? do
       case
       when s.scan(/<(tt|code)>.*?<\/\1>/) then # skip contents of tt
-        html << s.matched.gsub('\\\\', '\\')
+        html << s.matched
       when s.scan(/<(tt|code)>.*?/) then
         warn "mismatched <#{s[1]}> tag" # TODO signal file/line
         html << s.matched
       when s.scan(/<[^>]+\/?s*>/) then # skip HTML tags
         html << s.matched
-      when s.scan(/\\(\S)/) then # unhandled suppressed crossref
-        html << s[1]
-        after_word = nil
       when s.scan(/\.\.\.(\.?)/) then
         html << s[1] << encoded[:ellipsis]
         after_word = nil
@@ -319,4 +320,42 @@ 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
+
+  ##
+  # Decodes a label that may be in legacy RDoc format where CGI.escape was
+  # applied and then '%' was replaced with '-'. Converts '+' to space,
+  # then reverses -XX hex encoding for non-alphanumeric characters.
+  #
+  # Labels in new format pass through unchanged because -XX patterns that
+  # decode to alphanumeric characters are left as-is (CGI.escape never
+  # encodes alphanumerics).
+  #
+  # Examples:
+  #   "What-27s+Here"  -> "What's Here"  (legacy: -27 is apostrophe)
+  #   "Foo-3A-3ABar"   -> "Foo::Bar"     (legacy: -3A is colon)
+  #   "Whats-Here"     -> "Whats-Here"   (new format, unchanged)
+
+  module_function def decode_legacy_label(label)
+    label = label.tr('+', ' ')
+    label.gsub!(/-([0-7][0-9A-F])/) do
+      char = [$1.hex].pack('C')
+      char.match?(/[a-zA-Z0-9]/) ? $& : char
+    end
+    label
+  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 = '6.17.0'
+  VERSION = '7.2.0'
 
 end

data/rdoc.gemspec

@@ -38,10 +38,10 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
   # for ruby core repository. It was generated by
   # `git ls-files -z`.split("\x0").each {|f| puts "    #{f.dump}," unless f.start_with?(*%W[test/ spec/ features/ .]) }
   non_lib_files = [
-    "CONTRIBUTING.rdoc",
+    "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: 6.17.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2025-12-07 00:00:00.000000000 Z
+date: 2026-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -73,10 +73,8 @@ executables:
 - ri
 extensions: []
 extra_rdoc_files:
-- CONTRIBUTING.rdoc
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
@@ -84,16 +82,16 @@ extra_rdoc_files:
 - RI.md
 - TODO.rdoc
 files:
-- CONTRIBUTING.rdoc
+- 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
@@ -152,8 +150,11 @@ files:
 - lib/rdoc/generator/template/aliki/css/rdoc.css
 - lib/rdoc/generator/template/aliki/index.rhtml
 - lib/rdoc/generator/template/aliki/js/aliki.js
+- lib/rdoc/generator/template/aliki/js/bash_highlighter.js
 - lib/rdoc/generator/template/aliki/js/c_highlighter.js
-- lib/rdoc/generator/template/aliki/js/search.js
+- lib/rdoc/generator/template/aliki/js/search_controller.js
+- lib/rdoc/generator/template/aliki/js/search_navigation.js
+- lib/rdoc/generator/template/aliki/js/search_ranker.js
 - lib/rdoc/generator/template/aliki/js/theme-toggle.js
 - lib/rdoc/generator/template/aliki/page.rhtml
 - lib/rdoc/generator/template/aliki/servlet_not_found.rhtml
@@ -225,25 +226,22 @@ files:
 - lib/rdoc/markdown/literals.kpeg
 - lib/rdoc/markdown/literals.rb
 - lib/rdoc/markup.rb
-- lib/rdoc/markup/attr_changer.rb
-- lib/rdoc/markup/attr_span.rb
-- lib/rdoc/markup/attribute_manager.rb
-- lib/rdoc/markup/attributes.rb
 - 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
 - lib/rdoc/markup/include.rb
 - lib/rdoc/markup/indented_paragraph.rb
+- lib/rdoc/markup/inline_parser.rb
 - lib/rdoc/markup/list.rb
 - lib/rdoc/markup/list_item.rb
 - lib/rdoc/markup/paragraph.rb
 - lib/rdoc/markup/parser.rb
 - lib/rdoc/markup/pre_process.rb
 - lib/rdoc/markup/raw.rb
-- lib/rdoc/markup/regexp_handling.rb
 - lib/rdoc/markup/rule.rb
 - lib/rdoc/markup/table.rb
 - lib/rdoc/markup/to_ansi.rb
@@ -322,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.3
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []