rdoc 7.2.0 → 8.0.0

data/lib/rdoc/text.rb

@@ -29,34 +29,6 @@ module RDoc::Text
 
   MARKUP_FORMAT.default = RDoc::Markup
 
-  ##
-  # Maps an encoding to a Hash of characters properly transcoded for that
-  # encoding.
-  #
-  # See also encode_fallback.
-
-  TO_HTML_CHARACTERS = Hash.new do |h, encoding|
-    h[encoding] = {
-      :close_dquote => encode_fallback('”', encoding, '"'),
-      :close_squote => encode_fallback('’', encoding, '\''),
-      :copyright    => encode_fallback('©', encoding, '(c)'),
-      :ellipsis     => encode_fallback('…', encoding, '...'),
-      :em_dash      => encode_fallback('—', encoding, '---'),
-      :en_dash      => encode_fallback('–', encoding, '--'),
-      :open_dquote  => encode_fallback('“', encoding, '"'),
-      :open_squote  => encode_fallback('‘', encoding, '\''),
-      :trademark    => encode_fallback('®', encoding, '(r)'),
-    }
-  end
-
-  ##
-  # Transcodes +character+ to +encoding+ with a +fallback+ character.
-
-  def self.encode_fallback(character, encoding, fallback)
-    character.encode(encoding, :fallback => { character => fallback },
-                     :undef => :replace, :replace => fallback)
-  end
-
   ##
   # Expands tab characters in +text+ to eight spaces
 
@@ -149,7 +121,7 @@ module RDoc::Text
   def snippet(text, limit = 100)
     document = parse text
 
-    RDoc::Markup::ToHtmlSnippet.new(options, limit).convert document
+    RDoc::Markup::ToHtmlSnippet.new(limit).convert document
   end
 
   ##
@@ -193,95 +165,6 @@ 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_characters(text)
-    html = (''.encode text.encoding).dup
-
-    encoded = RDoc::Text::TO_HTML_CHARACTERS[text.encoding]
-
-    s = StringScanner.new text
-    insquotes = false
-    indquotes = false
-    after_word = nil
-
-    until s.eos? do
-      case
-      when s.scan(/<(tt|code)>.*?<\/\1>/) then # skip contents of tt
-        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(/\.\.\.(\.?)/) then
-        html << s[1] << encoded[:ellipsis]
-        after_word = nil
-      when s.scan(/\(c\)/i) then
-        html << encoded[:copyright]
-        after_word = nil
-      when s.scan(/\(r\)/i) then
-        html << encoded[:trademark]
-        after_word = nil
-      when s.scan(/---/) then
-        html << encoded[:em_dash]
-        after_word = nil
-      when s.scan(/--/) then
-        html << encoded[:en_dash]
-        after_word = nil
-      when s.scan(/&quot;|"/) then
-        html << encoded[indquotes ? :close_dquote : :open_dquote]
-        indquotes = !indquotes
-        after_word = nil
-      when s.scan(/``/) then # backtick double quote
-        html << encoded[:open_dquote]
-        after_word = nil
-      when s.scan(/(?:&#39;|'){2}/) then # tick double quote
-        html << encoded[:close_dquote]
-        after_word = nil
-      when s.scan(/`/) then # backtick
-        if insquotes or after_word
-          html << '`'
-          after_word = false
-        else
-          html << encoded[:open_squote]
-          insquotes = true
-        end
-      when s.scan(/&#39;|'/) then # single quote
-        if insquotes
-          html << encoded[:close_squote]
-          insquotes = false
-        elsif after_word
-          # Mary's dog, my parents' house: do not start paired quotes
-          html << encoded[:close_squote]
-        else
-          html << encoded[:open_squote]
-          insquotes = true
-        end
-
-        after_word = nil
-      else # advance to the next potentially significant character
-        match = s.scan(/.+?(?=[<\\.("'`&-])/) #"
-
-        if match then
-          html << match
-          after_word = match =~ /\w$/
-        else
-          html << s.rest
-          break
-        end
-      end
-    end
-
-    html
-  end
-
   ##
   # Wraps +txt+ to +line_len+
 

data/lib/rdoc/token_stream.rb

@@ -15,47 +15,25 @@ module RDoc::TokenStream
   # with the given class names. Other token types are not wrapped in spans.
 
   def self.to_html(token_stream)
-    starting_title = false
-
     token_stream.map do |t|
       next unless t
 
       style = case t[:kind]
-              when :on_const   then 'ruby-constant'
-              when :on_kw      then 'ruby-keyword'
-              when :on_ivar    then 'ruby-ivar'
-              when :on_cvar    then 'ruby-identifier'
-              when :on_gvar    then 'ruby-identifier'
-              when '=' != t[:text] && :on_op
-                               then 'ruby-operator'
-              when :on_tlambda then 'ruby-operator'
-              when :on_ident   then 'ruby-identifier'
-              when :on_label   then 'ruby-value'
-              when :on_backref, :on_dstring
-                               then 'ruby-node'
-              when :on_comment then 'ruby-comment'
-              when :on_embdoc  then 'ruby-comment'
-              when :on_regexp  then 'ruby-regexp'
-              when :on_tstring then 'ruby-string'
-              when :on_int, :on_float,
-                   :on_rational, :on_imaginary,
-                   :on_heredoc,
-                   :on_symbol, :on_CHAR then 'ruby-value'
-              when :on_heredoc_beg, :on_heredoc_end
-                               then 'ruby-identifier'
+              when :operator   then 'ruby-operator'
+              when :keyword    then 'ruby-keyword'
+              when :constant   then 'ruby-constant'
+              when :ivar       then 'ruby-ivar'
+              when :comment    then 'ruby-comment'
+              when :value      then 'ruby-value'
+              when :string     then 'ruby-string'
+              when :symbol     then 'ruby-value'
+              when :x_string   then 'ruby-string'
+              when :regexp     then 'ruby-regexp'
+              when :identifier then 'ruby-identifier'
               end
 
       text = t[:text]
 
-      if :on_ident == t[:kind] && starting_title
-        starting_title = false
-        style = 'ruby-identifier ruby-title'
-      end
-
-      if :on_kw == t[:kind] and 'def' == t[:text]
-        starting_title = true
-      end
-
       text = CGI.escapeHTML text
 
       if style then

data/lib/rdoc/version.rb

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

data/lib/rdoc.rb

@@ -100,7 +100,14 @@ module RDoc
     %w[arg args yield yields notnew not-new not_new doc]
 
   ##
-  # Loads the best available YAML library.
+  # Loads the YAML backend used for <tt>.rdoc_options</tt>.
+  #
+  # Psych is preferred and used whenever it can be required. Requiring +yaml+
+  # is not attempted as a fallback because +yaml+ is merely a thin wrapper that
+  # loads Psych anyway. When Psych is genuinely unavailable, a minimal
+  # serializer shipped with RubyGems or Bundler is loaded instead, so that RDoc
+  # does not need a runtime dependency on Psych. Callers branch on whether
+  # Psych is defined and use ::yaml_serializer otherwise.
 
   def self.load_yaml
     begin
@@ -113,11 +120,25 @@ module RDoc
     begin
       require 'psych'
     rescue ::LoadError
-    ensure
-      require 'yaml'
+      # Psych is unavailable; load the stub serializer shipped with RubyGems,
+      # or Bundler's copy on RubyGems older than 3.5 (Ruby 3.2) where
+      # rubygems/yaml_serializer does not exist yet.
+      begin
+        require 'rubygems/yaml_serializer'
+      rescue ::LoadError
+        require 'bundler/yaml_serializer'
+      end
     end
   end
 
+  ##
+  # The minimal YAML serializer module loaded by ::load_yaml as a fallback.
+  # Only meaningful when Psych is not defined.
+
+  def self.yaml_serializer
+    defined?(Gem::YAMLSerializer) ? Gem::YAMLSerializer : Bundler::YAMLSerializer
+  end
+
   ##
   # Searches and returns the directory for settings.
   #
@@ -151,6 +172,16 @@ module RDoc
     end
   end
 
+  ##
+  # Returns +File.mtime(file)+, or +nil+ if the file cannot be stat'd
+  # (missing, permission denied, etc.).
+
+  def self.safe_mtime(file)
+    File.mtime(file)
+  rescue SystemCallError
+    nil
+  end
+
   autoload :RDoc,           "#{__dir__}/rdoc/rdoc"
 
   autoload :CrossReference, "#{__dir__}/rdoc/cross_reference"
@@ -160,7 +191,7 @@ module RDoc
   autoload :Generator,      "#{__dir__}/rdoc/generator"
   autoload :Options,        "#{__dir__}/rdoc/options"
   autoload :Parser,         "#{__dir__}/rdoc/parser"
-  autoload :Servlet,        "#{__dir__}/rdoc/servlet"
+  autoload :Server,         "#{__dir__}/rdoc/server"
   autoload :RI,             "#{__dir__}/rdoc/ri"
   autoload :Stats,          "#{__dir__}/rdoc/stats"
   autoload :Store,          "#{__dir__}/rdoc/store"
@@ -189,7 +220,6 @@ module RDoc
   autoload :Context,        "#{__dir__}/rdoc/code_object/context"
   autoload :TopLevel,       "#{__dir__}/rdoc/code_object/top_level"
 
-  autoload :AnonClass,      "#{__dir__}/rdoc/code_object/anon_class"
   autoload :ClassModule,    "#{__dir__}/rdoc/code_object/class_module"
   autoload :NormalClass,    "#{__dir__}/rdoc/code_object/normal_class"
   autoload :NormalModule,   "#{__dir__}/rdoc/code_object/normal_module"
@@ -198,8 +228,6 @@ module RDoc
   autoload :Alias,          "#{__dir__}/rdoc/code_object/alias"
   autoload :AnyMethod,      "#{__dir__}/rdoc/code_object/any_method"
   autoload :MethodAttr,     "#{__dir__}/rdoc/code_object/method_attr"
-  autoload :GhostMethod,    "#{__dir__}/rdoc/code_object/ghost_method"
-  autoload :MetaMethod,     "#{__dir__}/rdoc/code_object/meta_method"
   autoload :Attr,           "#{__dir__}/rdoc/code_object/attr"
 
   autoload :Constant,       "#{__dir__}/rdoc/code_object/constant"

data/lib/rubygems_plugin.rb

@@ -10,14 +10,5 @@
 
 require_relative 'rdoc/rubygems_hook'
 
-# To install dependency libraries of RDoc, you need to run bundle install.
-# At that time, rdoc/markdown is not generated.
-# If generate and remove are executed at that time, an error will occur.
-# So, we can't register generate and remove to Gem at that time.
-begin
-  require_relative 'rdoc/markdown'
-rescue LoadError
-else
-  Gem.done_installing(&RDoc::RubyGemsHook.method(:generate))
-  Gem.pre_uninstall(&RDoc::RubyGemsHook.method(:remove))
-end
+Gem.done_installing(&RDoc::RubyGemsHook.method(:generate))
+Gem.pre_uninstall(&RDoc::RubyGemsHook.method(:remove))

data/rdoc-logo.svg

@@ -0,0 +1,43 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="168" height="198" viewBox="298 140 712 840" role="img" aria-labelledby="title desc">
+  <title id="title">RDoc</title>
+  <desc id="desc">A red document outline with a folded corner and a Ruby gem.</desc>
+  <style>
+    .surface {
+      fill: transparent;
+    }
+
+    .stroke {
+      stroke: url(#rdoc-red);
+    }
+
+    .solid {
+      fill: url(#rdoc-red);
+    }
+  </style>
+  <defs>
+    <linearGradient id="rdoc-red" x1="338" y1="178" x2="973" y2="938" gradientUnits="userSpaceOnUse">
+      <stop id="rdoc-red-start" offset="0" stop-color="#e62923"/>
+      <stop id="rdoc-red-mid" offset="0.56" stop-color="#e62923"/>
+      <stop id="rdoc-red-end" offset="1" stop-color="#e62923"/>
+    </linearGradient>
+    <filter id="soft-red-shadow" x="-10%" y="-10%" width="120%" height="120%">
+      <feDropShadow dx="0" dy="5" stdDeviation="5" flood-color="#e62923" flood-opacity="0.1"/>
+    </filter>
+  </defs>
+
+  <g filter="url(#soft-red-shadow)" fill="none" class="stroke" stroke-linecap="round" stroke-linejoin="round">
+    <path class="surface" d="M382 178h326l149 149v499c0 24-20 44-44 44H382c-24 0-44-20-44-44V222c0-24 20-44 44-44Z" stroke="none"/>
+    <path d="M685 870H382c-24 0-44-20-44-44V222c0-24 20-44 44-44h326l149 149v246" stroke-width="26"/>
+    <path class="solid" d="M708 178v126c0 24 19 43 43 43h106" stroke="none"/>
+    <path d="M708 178 857 327" stroke-width="26"/>
+
+    <path d="M440 411h216" stroke-width="26"/>
+    <path d="M440 506h216" stroke-width="26"/>
+    <path d="M440 605h145" stroke-width="26"/>
+
+    <path class="surface" d="M668 609h224l81 97-195 232-191-232 81-97Z" stroke-width="26"/>
+    <path d="M668 609 700 706 778 609 858 706 892 609" stroke-width="20"/>
+    <path d="M587 706h386" stroke-width="20"/>
+    <path d="M700 706 778 938 858 706" stroke-width="20"/>
+  </g>
+</svg>

data/rdoc.gemspec

@@ -26,7 +26,7 @@ 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.
   DESCRIPTION
   s.homepage = "https://ruby.github.io/rdoc"
-  s.licenses = ["Ruby"]
+  s.licenses = ["Ruby", "GPL-2.0-only"]
 
   s.metadata["homepage_uri"] = s.homepage
   s.metadata["source_code_uri"] = "https://github.com/ruby/rdoc"
@@ -51,6 +51,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "exe/rdoc",
     "exe/ri",
     "man/ri.1",
+    "rdoc-logo.svg",
     "rdoc.gemspec",
   ]
   base = __dir__
@@ -60,13 +61,14 @@ 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.md"]
+  s.rdoc_options = ["--main", "README.md", "--copy-files", "rdoc-logo.svg"]
   s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z])
 
-  s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
   s.required_rubygems_version = Gem::Requirement.new(">= 2.2")
 
-  s.add_dependency 'psych', '>= 4.0.0'
   s.add_dependency 'erb'
   s.add_dependency 'tsort'
+  s.add_dependency 'prism', '>= 1.6.0'
+  s.add_dependency 'rbs', '>= 4.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,24 +13,24 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2026-02-09 00:00:00.000000000 Z
+date: 2026-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: erb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: erb
+  name: tsort
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -44,19 +44,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tsort
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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.
@@ -97,7 +111,6 @@ files:
 - lib/rdoc.rb
 - lib/rdoc/code_object.rb
 - lib/rdoc/code_object/alias.rb
-- lib/rdoc/code_object/anon_class.rb
 - lib/rdoc/code_object/any_method.rb
 - lib/rdoc/code_object/attr.rb
 - lib/rdoc/code_object/class_module.rb
@@ -105,9 +118,7 @@ files:
 - lib/rdoc/code_object/context.rb
 - lib/rdoc/code_object/context/section.rb
 - lib/rdoc/code_object/extend.rb
-- lib/rdoc/code_object/ghost_method.rb
 - lib/rdoc/code_object/include.rb
-- lib/rdoc/code_object/meta_method.rb
 - lib/rdoc/code_object/method_attr.rb
 - lib/rdoc/code_object/mixin.rb
 - lib/rdoc/code_object/normal_class.rb
@@ -131,6 +142,7 @@ files:
 - lib/rdoc/generator/pot/po.rb
 - lib/rdoc/generator/pot/po_entry.rb
 - lib/rdoc/generator/ri.rb
+- lib/rdoc/generator/template/aliki/DESIGN.md
 - lib/rdoc/generator/template/aliki/_aside_toc.rhtml
 - lib/rdoc/generator/template/aliki/_footer.rhtml
 - lib/rdoc/generator/template/aliki/_head.rhtml
@@ -262,13 +274,13 @@ files:
 - lib/rdoc/parser/c.rb
 - lib/rdoc/parser/changelog.rb
 - lib/rdoc/parser/markdown.rb
-- lib/rdoc/parser/prism_ruby.rb
+- lib/rdoc/parser/rbs.rb
 - lib/rdoc/parser/rd.rb
-- lib/rdoc/parser/ripper_state_lex.rb
 - lib/rdoc/parser/ruby.rb
-- lib/rdoc/parser/ruby_tools.rb
+- lib/rdoc/parser/ruby_colorizer.rb
 - lib/rdoc/parser/simple.rb
 - lib/rdoc/parser/text.rb
+- lib/rdoc/rbs_helper.rb
 - lib/rdoc/rd.rb
 - lib/rdoc/rd/block_parser.rb
 - lib/rdoc/rd/block_parser.ry
@@ -280,10 +292,11 @@ files:
 - lib/rdoc/ri/driver.rb
 - lib/rdoc/ri/formatter.rb
 - lib/rdoc/ri/paths.rb
+- lib/rdoc/ri/servlet.rb
 - lib/rdoc/ri/store.rb
 - lib/rdoc/ri/task.rb
 - lib/rdoc/rubygems_hook.rb
-- lib/rdoc/servlet.rb
+- lib/rdoc/server.rb
 - lib/rdoc/stats.rb
 - lib/rdoc/stats/normal.rb
 - lib/rdoc/stats/quiet.rb
@@ -296,10 +309,12 @@ files:
 - lib/rdoc/version.rb
 - lib/rubygems_plugin.rb
 - man/ri.1
+- rdoc-logo.svg
 - rdoc.gemspec
 homepage: https://ruby.github.io/rdoc
 licenses:
 - Ruby
+- GPL-2.0-only
 metadata:
   homepage_uri: https://ruby.github.io/rdoc
   source_code_uri: https://github.com/ruby/rdoc
@@ -307,20 +322,22 @@ metadata:
 rdoc_options:
 - "--main"
 - README.md
+- "--copy-files"
+- rdoc-logo.svg
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

data/lib/rdoc/code_object/anon_class.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-##
-# An anonymous class like:
-#
-#   c = Class.new do end
-#
-# AnonClass is currently not used.
-
-class RDoc::AnonClass < RDoc::ClassModule
-end

data/lib/rdoc/code_object/ghost_method.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-##
-# GhostMethod represents a method referenced only by a comment
-
-class RDoc::GhostMethod < RDoc::AnyMethod
-end

data/lib/rdoc/code_object/meta_method.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-##
-# MetaMethod represents a meta-programmed method
-
-class RDoc::MetaMethod < RDoc::AnyMethod
-end