rdoc 6.14.2 → 7.1.0

data/lib/rdoc/parser/ruby.rb

@@ -120,7 +120,7 @@ require_relative 'ripper_state_lex'
 #   # :singleton-method: some_method!
 #
 # You can define arguments for metaprogrammed methods via either the
-# :call-seq:, :arg: or :args: directives.
+# \:call-seq:, :arg: or :args: directives.
 #
 # Additionally you can mark a method as an attribute by
 # using :attr:, :attr_reader:, :attr_writer: or :attr_accessor:.  Just like
@@ -1088,7 +1088,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
   ##
   # Generates an RDoc::Method or RDoc::Attr from +comment+ by looking for
-  # :method: or :attr: directives in +comment+.
+  # \:method: or :attr: directives in +comment+.
 
   def parse_comment(container, tk, comment)
     return parse_comment_tomdoc container, tk, comment if @markup == 'tomdoc'
@@ -1137,7 +1137,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     meth = RDoc::GhostMethod.new get_tkread, name
     record_location meth
 
-    meth.start_collecting_tokens
+    meth.start_collecting_tokens(:ruby)
     indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
     position_comment = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
     position_comment[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
@@ -1180,7 +1180,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     record_location meth
     meth.line      = line_no
 
-    meth.start_collecting_tokens
+    meth.start_collecting_tokens(:ruby)
     indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
     position_comment = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
     position_comment[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
@@ -1344,7 +1344,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     column  = tk[:char_no]
     line_no = tk[:line_no]
 
-    start_collecting_tokens
+    start_collecting_tokens(:ruby)
     add_token tk
     add_token_listener self
 
@@ -1363,7 +1363,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
     remove_token_listener self
 
-    meth.start_collecting_tokens
+    meth.start_collecting_tokens(:ruby)
     indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
     position_comment = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
     position_comment[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
@@ -1448,7 +1448,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     column  = tk[:char_no]
     line_no = tk[:line_no]
 
-    start_collecting_tokens
+    start_collecting_tokens(:ruby)
     add_token tk
 
     token_listener self do
@@ -1471,7 +1471,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     record_location meth
     meth.line   = line_no
 
-    meth.start_collecting_tokens
+    meth.start_collecting_tokens(:ruby)
     indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
     token = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
     token[:text] = "# File #{@top_level.relative_name}, line #{line_no}"

data/lib/rdoc/parser/ruby_tools.rb

@@ -20,7 +20,7 @@ module RDoc::Parser::RubyTools
 
     if @tokens.empty? then
       if @scanner_point >= @scanner.size
-        return nil
+        return
       else
         tk = @scanner[@scanner_point]
         @scanner_point += 1
@@ -31,16 +31,14 @@ module RDoc::Parser::RubyTools
       tk = @tokens.shift
     end
 
-    if tk == nil || :on___end__ == tk[:kind]
-      tk = nil
+    if tk.nil? || :on___end__ == tk[:kind]
+      return
     end
 
-    return nil unless tk
-
     # inform any listeners of our shiny new token
-    @token_listeners.each do |obj|
+    @token_listeners&.each do |obj|
       obj.add_token(tk)
-    end if @token_listeners
+    end
 
     tk
   end

data/lib/rdoc/parser/simple.rb

@@ -19,17 +19,17 @@ class RDoc::Parser::Simple < RDoc::Parser
 
     preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
 
-    @content = preprocess.handle @content, @top_level
+    content = RDoc::Text.expand_tabs(@content)
+    @content, = preprocess.run_pre_processes(content, @top_level, 1, :simple)
   end
 
   ##
   # Extract the file contents and attach them to the TopLevel as a comment
 
   def scan
-    comment = remove_coding_comment @content
-    comment = remove_private_comment comment
+    content = remove_coding_comment @content
 
-    comment = RDoc::Comment.new comment, @top_level
+    comment = RDoc::Comment.new content, @top_level
 
     @top_level.comment = comment
     @top_level
@@ -41,21 +41,4 @@ class RDoc::Parser::Simple < RDoc::Parser
   def remove_coding_comment(text)
     text.sub(/\A# .*coding[=:].*$/, '')
   end
-
-  ##
-  # Removes private comments.
-  #
-  # Unlike RDoc::Comment#remove_private this implementation only looks for two
-  # dashes at the beginning of the line.  Three or more dashes are considered
-  # to be a rule and ignored.
-
-  def remove_private_comment(comment)
-    # Workaround for gsub encoding for Ruby 1.9.2 and earlier
-    empty = ''
-    empty = RDoc::Encoding.change_encoding empty, comment.encoding
-
-    comment = comment.gsub(%r%^--\n.*?^\+\+\n?%m, empty)
-    comment.sub(%r%^--\n.*%m, empty)
-  end
-
 end

data/lib/rdoc/rdoc.rb

@@ -547,5 +547,6 @@ end
 
 # require built-in generators after discovery in case they've been replaced
 require_relative 'generator/darkfish'
+require_relative 'generator/aliki'
 require_relative 'generator/ri'
 require_relative 'generator/pot'

data/lib/rdoc/ri/task.rb

@@ -26,8 +26,8 @@ require_relative '../task'
 #   require 'rdoc/ri/task'
 #
 #   RDoc::RI::Task.new do |ri|
-#     ri.main = 'README.rdoc'
-#     ri.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
+#     ri.main = 'README.md'
+#     ri.rdoc_files.include 'README.md', 'lib/**/*.rb'
 #   end
 #
 # For further configuration details see RDoc::Task.

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/store.rb

@@ -720,10 +720,10 @@ class RDoc::Store
   end
 
   ##
-  # Returns the RDoc::TopLevel that is a text file and has the given +name+
+  # Returns the RDoc::TopLevel that is a file and has the given +name+
 
   def page(name)
-    @text_files_hash.each_value.find do |file|
+    @files_hash.each_value.find do |file|
       file.page_name == name or file.base_name == name
     end
   end

data/lib/rdoc/task.rb

@@ -58,8 +58,8 @@ require 'rake/tasklib'
 #   require 'rdoc/task'
 #
 #   RDoc::Task.new do |rdoc|
-#     rdoc.main = "README.rdoc"
-#     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+#     rdoc.main = "README.md"
+#     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
 #   end
 #
 # The +rdoc+ object passed to the block is an RDoc::Task object. See the
@@ -74,8 +74,8 @@ require 'rake/tasklib'
 #   require 'rdoc/task'
 #
 #   RDoc::Task.new :rdoc_dev do |rdoc|
-#     rdoc.main = "README.rdoc"
-#     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+#     rdoc.main = "README.md"
+#     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
 #     rdoc.options << "--all"
 #   end
 #

data/lib/rdoc/text.rb

@@ -60,7 +60,7 @@ module RDoc::Text
   ##
   # Expands tab characters in +text+ to eight spaces
 
-  def expand_tabs(text)
+  module_function def expand_tabs(text)
     expanded = []
 
     text.each_line do |line|
@@ -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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ##
 # A TokenStream is a list of tokens, gathered during the parse of some entity
 # (say a method). Entities populate these streams by being registered with the
@@ -44,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
@@ -64,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
@@ -87,9 +84,11 @@ module RDoc::TokenStream
 
   ##
   # Starts collecting tokens
+  #
 
-  def collect_tokens
+  def collect_tokens(language)
     @token_stream = []
+    @token_stream_language = language
   end
 
   alias start_collecting_tokens collect_tokens
@@ -115,4 +114,13 @@ module RDoc::TokenStream
     (token_stream or return '').compact.map { |token| token[:text] }.join ''
   end
 
+  ##
+  # Returns the source language of the token stream as a string
+  #
+  # Returns 'c' or 'ruby'
+
+  def source_language
+    @token_stream_language == :c ? 'c' : 'ruby'
+  end
+
 end

data/lib/rdoc/tom_doc.rb

@@ -49,7 +49,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
       next unless code_object and
                   RDoc::Comment === comment and comment.format == 'tomdoc'
 
-      comment.text.gsub!(/(\A\s*# )(Public|Internal|Deprecated):\s+/) do
+      comment.text.gsub!(/\A(\s*# |)(Public|Internal|Deprecated):\s+/) do
         section = code_object.add_section $2
         code_object.temporary_section = section
 

data/lib/rdoc/version.rb

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

data/rdoc.gemspec

@@ -38,14 +38,14 @@ 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",
-    "README.rdoc",
+    "README.md",
     "RI.md",
     "TODO.rdoc",
     "exe/rdoc",
@@ -60,7 +60,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
 
   s.files = (non_lib_files + template_files + lib_files).uniq
 
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.rdoc_options = ["--main", "README.md"]
   s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z])
 
   s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
@@ -68,4 +68,5 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
 
   s.add_dependency 'psych', '>= 4.0.0'
   s.add_dependency 'erb'
+  s.add_dependency 'tsort'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.14.2
+  version: 7.1.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2025-07-03 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -43,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   RDoc produces HTML and command-line documentation for Ruby projects.
   RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
@@ -59,27 +73,25 @@ executables:
 - ri
 extensions: []
 extra_rdoc_files:
-- CONTRIBUTING.rdoc
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - RI.md
 - TODO.rdoc
 files:
-- CONTRIBUTING.rdoc
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - RI.md
 - TODO.rdoc
+- doc/markup_reference/markdown.md
+- doc/markup_reference/rdoc.rdoc
 - exe/rdoc
 - exe/ri
 - lib/rdoc.rb
@@ -110,6 +122,7 @@ files:
 - lib/rdoc/erb_partial.rb
 - lib/rdoc/erbio.rb
 - lib/rdoc/generator.rb
+- lib/rdoc/generator/aliki.rb
 - lib/rdoc/generator/darkfish.rb
 - lib/rdoc/generator/json_index.rb
 - lib/rdoc/generator/markup.rb
@@ -118,6 +131,33 @@ files:
 - lib/rdoc/generator/pot/po.rb
 - lib/rdoc/generator/pot/po_entry.rb
 - lib/rdoc/generator/ri.rb
+- lib/rdoc/generator/template/aliki/_aside_toc.rhtml
+- lib/rdoc/generator/template/aliki/_footer.rhtml
+- lib/rdoc/generator/template/aliki/_head.rhtml
+- lib/rdoc/generator/template/aliki/_header.rhtml
+- lib/rdoc/generator/template/aliki/_icons.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_search.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml
+- lib/rdoc/generator/template/aliki/class.rhtml
+- 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/c_highlighter.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
+- lib/rdoc/generator/template/aliki/servlet_root.rhtml
 - lib/rdoc/generator/template/darkfish/_footer.rhtml
 - lib/rdoc/generator/template/darkfish/_head.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
@@ -192,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
@@ -268,7 +309,7 @@ metadata:
   changelog_uri: https://github.com/ruby/rdoc/releases
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -282,7 +323,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: []