rdoc 6.7.0 → 6.11.0

data/lib/rdoc/rubygems_hook.rb

@@ -3,13 +3,19 @@ require 'rubygems/user_interaction'
 require 'fileutils'
 require_relative '../rdoc'
 
-##
-# Gem::RDoc provides methods to generate RDoc and ri data for installed gems
-# upon gem installation.
+# We define the following two similar name classes in this file:
 #
-# This file is automatically required by RubyGems 1.9 and newer.
+# - RDoc::RubyGemsHook
+# - RDoc::RubygemsHook
+#
+# RDoc::RubyGemsHook is the main class that has real logic.
+#
+# RDoc::RubygemsHook is a class that is only for
+# compatibility. RDoc::RubygemsHook is used by RubyGems directly. We
+# can remove this when all maintained RubyGems remove
+# `rubygems/rdoc.rb`.
 
-class RDoc::RubygemsHook
+class RDoc::RubyGemsHook
 
   include Gem::UserInteraction
   extend  Gem::UserInteraction
@@ -45,7 +51,7 @@ class RDoc::RubygemsHook
   # Post installs hook that generates documentation for each specification in
   # +specs+
 
-  def self.generation_hook installer, specs
+  def self.generate installer, specs
     start = Time.now
     types = installer.document
 
@@ -64,6 +70,10 @@ class RDoc::RubygemsHook
     say "Done installing documentation for #{names} after #{duration} seconds"
   end
 
+  def self.remove uninstaller
+    new(uninstaller.spec).remove
+  end
+
   ##
   # Loads the RDoc generator
 
@@ -171,10 +181,10 @@ class RDoc::RubygemsHook
       options = ::RDoc::Options.new
       options.default_title = "#{@spec.full_name} Documentation"
       options.parse args
+      options.quiet = !Gem.configuration.really_verbose
+      options.finish
     end
 
-    options.quiet = !Gem.configuration.really_verbose
-
     @rdoc = new_rdoc
     @rdoc.options = options
 
@@ -246,3 +256,75 @@ class RDoc::RubygemsHook
   end
 
 end
+
+# This class is referenced by RubyGems to create documents.
+# All implementations are moved to the above RubyGemsHook.
+#
+# This class does nothing when this RDoc is installed as a normal gem
+# or a bundled gem.
+#
+# This class does generate/remove documents for compatibility when
+# this RDoc is installed as a default gem.
+#
+# We can remove this when all maintained RubyGems remove
+# `rubygems/rdoc.rb`.
+module RDoc
+  class RubygemsHook
+
+    attr_accessor :generate_rdoc, :generate_ri, :force
+
+    def self.default_gem?
+      !File.exist?(File.join(__dir__, "..", "rubygems_plugin.rb"))
+    end
+
+    def initialize(spec, generate_rdoc = false, generate_ri = true)
+      @spec = spec
+      @generate_rdoc = generate_rdoc
+      @generate_ri   = generate_ri
+      @force = false
+    end
+
+    def generate
+      # Do nothing if this is NOT a default gem.
+      return unless self.class.default_gem?
+
+      # Generate document for compatibility if this is a default gem.
+      hook = RubyGemsHook.new(@spec, @generate_rdoc, @generate_ri)
+      hook.force = @force
+      hook.generate
+    end
+
+    def remove
+      # Do nothing if this is NOT a default gem.
+      return unless self.class.default_gem?
+
+      # Remove generated document for compatibility if this is a
+      # default gem.
+      RubyGemsHook.new(@spec).remove
+    end
+
+    def self.generation_hook installer, specs
+      # Do nothing if this is NOT a default gem.
+      return unless default_gem?
+
+      # Generate document for compatibility if this is a default gem.
+      RubyGemsHook.generate(installer, specs)
+    end
+
+    def self.load_rdoc
+      RubyGemsHook.load_rdoc
+    end
+
+    def self.rdoc_version
+      RubyGemsHook.rdoc_version
+    end
+
+    def rdoc_installed?
+      RubyGemsHook.new(@spec).rdoc_installed?
+    end
+
+    def ri_installed?
+      RubyGemsHook.new(@spec).ri_installed?
+    end
+  end
+end

data/lib/rdoc/store.rb

@@ -197,6 +197,18 @@ class RDoc::Store
     top_level
   end
 
+  ##
+  # Make sure any references to C variable names are resolved to the corresponding class.
+  #
+
+  def resolve_c_superclasses
+    @classes_hash.each_value do |klass|
+      if klass.superclass.is_a?(String) && (candidate = find_c_enclosure(klass.superclass))
+        klass.superclass = candidate
+      end
+    end
+  end
+
   ##
   # Sets the parser of +absolute_name+, unless it from a source code file.
 

data/lib/rdoc/task.rb

@@ -104,9 +104,8 @@ class RDoc::Task < Rake::TaskLib
   attr_accessor :name
 
   ##
-  # Comment markup format.  rdoc, rd and tomdoc are supported.  (default is
-  # 'rdoc')
-
+  # The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
+  # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
   attr_accessor :markup
 
   ##

data/lib/rdoc/tom_doc.rb

@@ -3,13 +3,7 @@
 
 # A parser for TomDoc based on TomDoc 1.0.0-rc1 (02adef9b5a)
 #
-# The TomDoc specification can be found at:
-#
-# http://tomdoc.org
-#
-# The latest version of the TomDoc specification can be found at:
-#
-# https://github.com/mojombo/tomdoc/blob/master/tomdoc.md
+# The TomDoc specification can be found at http://tomdoc.org.
 #
 # To choose TomDoc as your only default format see RDoc::Options@Saved+Options
 # for instructions on setting up a <code>.rdoc_options</code> file to store

data/lib/rdoc/version.rb

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

data/lib/rdoc.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 $DEBUG_RDOC = nil
 
-# :main: README.rdoc
-
 ##
 # RDoc produces documentation for Ruby source files by parsing the source and
 # extracting the definition for classes, modules, methods, includes and
@@ -21,7 +19,7 @@ $DEBUG_RDOC = nil
 # see RDoc::Markup and refer to <tt>rdoc --help</tt> for command line usage.
 #
 # If you want to set the default markup format see
-# RDoc::Markup@Supported+Formats
+# RDoc::Markup@Markup+Formats
 #
 # If you want to store rdoc configuration in your gem (such as the default
 # markup format) see RDoc::Options@Saved+Options
@@ -188,26 +186,26 @@ module RDoc
   # programs: classes, modules, methods, and so on.
   autoload :CodeObject,     "#{__dir__}/rdoc/code_object"
 
-  autoload :Context,        "#{__dir__}/rdoc/context"
-  autoload :TopLevel,       "#{__dir__}/rdoc/top_level"
-
-  autoload :AnonClass,      "#{__dir__}/rdoc/anon_class"
-  autoload :ClassModule,    "#{__dir__}/rdoc/class_module"
-  autoload :NormalClass,    "#{__dir__}/rdoc/normal_class"
-  autoload :NormalModule,   "#{__dir__}/rdoc/normal_module"
-  autoload :SingleClass,    "#{__dir__}/rdoc/single_class"
-
-  autoload :Alias,          "#{__dir__}/rdoc/alias"
-  autoload :AnyMethod,      "#{__dir__}/rdoc/any_method"
-  autoload :MethodAttr,     "#{__dir__}/rdoc/method_attr"
-  autoload :GhostMethod,    "#{__dir__}/rdoc/ghost_method"
-  autoload :MetaMethod,     "#{__dir__}/rdoc/meta_method"
-  autoload :Attr,           "#{__dir__}/rdoc/attr"
-
-  autoload :Constant,       "#{__dir__}/rdoc/constant"
-  autoload :Mixin,          "#{__dir__}/rdoc/mixin"
-  autoload :Include,        "#{__dir__}/rdoc/include"
-  autoload :Extend,         "#{__dir__}/rdoc/extend"
-  autoload :Require,        "#{__dir__}/rdoc/require"
+  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"
+  autoload :SingleClass,    "#{__dir__}/rdoc/code_object/single_class"
+
+  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"
+  autoload :Mixin,          "#{__dir__}/rdoc/code_object/mixin"
+  autoload :Include,        "#{__dir__}/rdoc/code_object/include"
+  autoload :Extend,         "#{__dir__}/rdoc/code_object/extend"
+  autoload :Require,        "#{__dir__}/rdoc/code_object/require"
 
 end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# If this file is exist, RDoc generates and removes documents by rubygems plugins.
+#
+# In follwing cases,
+# RubyGems directly exectute RDoc::RubygemsHook.generation_hook and RDoc::RubygemsHook#remove to generate and remove documents.
+#
+# - RDoc is used as a default gem.
+# - RDoc is a old version that doesn't have rubygems_plugin.rb.
+
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 6.11.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -53,7 +53,7 @@ extra_rdoc_files:
 - LEGAL.rdoc
 - LICENSE.rdoc
 - README.rdoc
-- RI.rdoc
+- RI.md
 - TODO.rdoc
 files:
 - CONTRIBUTING.rdoc
@@ -64,27 +64,37 @@ files:
 - LEGAL.rdoc
 - LICENSE.rdoc
 - README.rdoc
-- RI.rdoc
+- RI.md
 - TODO.rdoc
 - exe/rdoc
 - exe/ri
 - lib/rdoc.rb
-- lib/rdoc/alias.rb
-- lib/rdoc/anon_class.rb
-- lib/rdoc/any_method.rb
-- lib/rdoc/attr.rb
-- lib/rdoc/class_module.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
+- lib/rdoc/code_object/constant.rb
+- 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
+- lib/rdoc/code_object/normal_module.rb
+- lib/rdoc/code_object/require.rb
+- lib/rdoc/code_object/single_class.rb
+- lib/rdoc/code_object/top_level.rb
 - lib/rdoc/code_objects.rb
 - lib/rdoc/comment.rb
-- lib/rdoc/constant.rb
-- lib/rdoc/context.rb
-- lib/rdoc/context/section.rb
 - lib/rdoc/cross_reference.rb
 - lib/rdoc/encoding.rb
 - lib/rdoc/erb_partial.rb
 - lib/rdoc/erbio.rb
-- lib/rdoc/extend.rb
 - lib/rdoc/generator.rb
 - lib/rdoc/generator/darkfish.rb
 - lib/rdoc/generator/json_index.rb
@@ -94,7 +104,6 @@ files:
 - lib/rdoc/generator/pot/po.rb
 - lib/rdoc/generator/pot/po_entry.rb
 - lib/rdoc/generator/ri.rb
-- lib/rdoc/generator/template/darkfish/.document
 - lib/rdoc/generator/template/darkfish/_footer.rhtml
 - lib/rdoc/generator/template/darkfish/_head.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
@@ -110,6 +119,7 @@ files:
 - lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
+- lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml
 - lib/rdoc/generator/template/darkfish/class.rhtml
 - lib/rdoc/generator/template/darkfish/css/fonts.css
 - lib/rdoc/generator/template/darkfish/css/rdoc.css
@@ -151,14 +161,11 @@ files:
 - lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
 - lib/rdoc/generator/template/darkfish/servlet_root.rhtml
 - lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
-- lib/rdoc/generator/template/json_index/.document
 - lib/rdoc/generator/template/json_index/js/navigation.js
 - lib/rdoc/generator/template/json_index/js/searcher.js
-- lib/rdoc/ghost_method.rb
 - lib/rdoc/i18n.rb
 - lib/rdoc/i18n/locale.rb
 - lib/rdoc/i18n/text.rb
-- lib/rdoc/include.rb
 - lib/rdoc/known_classes.rb
 - lib/rdoc/markdown.kpeg
 - lib/rdoc/markdown.rb
@@ -200,16 +207,12 @@ files:
 - lib/rdoc/markup/to_test.rb
 - lib/rdoc/markup/to_tt_only.rb
 - lib/rdoc/markup/verbatim.rb
-- lib/rdoc/meta_method.rb
-- lib/rdoc/method_attr.rb
-- lib/rdoc/mixin.rb
-- lib/rdoc/normal_class.rb
-- lib/rdoc/normal_module.rb
 - lib/rdoc/options.rb
 - lib/rdoc/parser.rb
 - lib/rdoc/parser/c.rb
 - lib/rdoc/parser/changelog.rb
 - lib/rdoc/parser/markdown.rb
+- lib/rdoc/parser/prism_ruby.rb
 - lib/rdoc/parser/rd.rb
 - lib/rdoc/parser/ripper_state_lex.rb
 - lib/rdoc/parser/ruby.rb
@@ -223,7 +226,6 @@ files:
 - lib/rdoc/rd/inline_parser.rb
 - lib/rdoc/rd/inline_parser.ry
 - lib/rdoc/rdoc.rb
-- lib/rdoc/require.rb
 - lib/rdoc/ri.rb
 - lib/rdoc/ri/driver.rb
 - lib/rdoc/ri/formatter.rb
@@ -232,7 +234,6 @@ files:
 - lib/rdoc/ri/task.rb
 - lib/rdoc/rubygems_hook.rb
 - lib/rdoc/servlet.rb
-- lib/rdoc/single_class.rb
 - lib/rdoc/stats.rb
 - lib/rdoc/stats/normal.rb
 - lib/rdoc/stats/quiet.rb
@@ -242,8 +243,8 @@ files:
 - lib/rdoc/text.rb
 - lib/rdoc/token_stream.rb
 - lib/rdoc/tom_doc.rb
-- lib/rdoc/top_level.rb
 - lib/rdoc/version.rb
+- lib/rubygems_plugin.rb
 - man/ri.1
 homepage: https://ruby.github.io/rdoc
 licenses:
@@ -268,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

data/RI.rdoc

@@ -1,57 +0,0 @@
-= RI
-
-+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
-
-You can use +ri+ to look up information from either the command line or
-interactively.  When you run +ri+ without any arguments it will launch in
-interactive mode.  In interactive mode you can tab-complete class and method
-names.
-
-== Usage
-
-To see information for a class, do:
-  ri ClassName
-
-For example, for the Array class, do:
-  ri Array
-
-To see information on a method on a class, do:
-  ri ClassName.method
-
-This will show both instance and class methods.  For example, the IO
-class defines both IO::read and IO#read:
-  ri IO.read
-
-To see information for an instance method, do:
-  ri ClassName#method_name
-
-For example, for Array's +join+ method, do:
-  ri Array#join
-
-To see information for a class method, do:
-  ri ClassName::method_name
-
-For example, for Module's +private+ method, do:
-  ri Module::private
-
-To read documentation for all +read+ methods, do:
-  ri read
-
-== Options
-
-+ri+ supports a variety of options, all of which can be viewed via +--help+.
-Of particular interest, are:
-
-[<tt>-f</tt>]
-  Outputs ri data using the selected formatter.  You can see the available
-  formatters in <tt>ri --help</tt>
-[<tt>-T</tt>]
-  Send output to stdout, rather than to a pager.
-
-All options also can be specified through the +RI+ environment variable.
-Command-line options always override those specified in the +RI+ environment
-variable.
-
-The +RI_PAGER+ environment variable allows you to choose a particular pager or
-particular options for your pager.
-

data/lib/rdoc/generator/template/json_index/.document

@@ -1 +0,0 @@
-# ignore all files in this directory