rdoc 6.9.1 → 6.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1941dad44ac3feaeea7befa661f56a2b58052b0c3fe14186593139234a5d14ee
-  data.tar.gz: 85745f705a09ceb1039b8888fe853d617e5391949f9a5dde1d0cfa582a05c2b4
+  metadata.gz: 870fa0cb431cb2be4520001d6bceb293d36475e2d96e090d749a2ee7b91bb979
+  data.tar.gz: ea650e35d6b2fe0a33a031e8df70be62742d9046cf9ad9aca8d7ead3cac67038
 SHA512:
-  metadata.gz: 2e4a0dd698c7f469b361ee4baf9acded0c4d202df288b026dce14adc79ef44912af00bb74ea7187ac973f6b26d34ca8041bdc2498b796e281b9f9f6a45cdab64
-  data.tar.gz: 3ecac3e56d13bab06679d072813adc0091fad04a10b9a31ce12ff8137462557a1032a88ca3c42e0cc4d366ecf9e7d13002092605e202fb7dae55a286bfac18ae
+  metadata.gz: b3cc3a1797ce0a7538620e71b04f5db77eea9af380b6c8db05b283cc17f4b0504d096c33fac55f06c7004100a1d18217e154dcf4f24a7538167292746be9a16c
+  data.tar.gz: 0f52da54649752c27b2b330e6cda90aa9c478b8f4fd068b291666771d55e84db67a6c57f5261b4678260b93726eb4ec21c2728e706be0bfb37d1ad3277188330

data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml

@@ -18,6 +18,7 @@
     solo = top.one? {|klass| klass.display?}
     traverse = proc do |klasses| -%>
   <ul class="link-list">
+      <%- klasses.uniq!(&:full_name) -%>
       <%- klasses.each do |index_klass| -%>
         <%- if children = all_classes[index_klass.full_name] -%>
   <li><details<% if solo; solo = false %> open<% end %>><summary><% link.call(index_klass) %></summary>

data/lib/rdoc/generator/template/darkfish/js/darkfish.js

@@ -103,6 +103,12 @@ function hookSidebar() {
   if (isSmallViewport) {
     navigation.hidden = true;
     navigationToggle.ariaExpanded = false;
+    document.addEventListener('click', (e) => {
+      if (e.target.closest('#navigation a')) {
+        navigation.hidden = true;
+        navigationToggle.ariaExpanded = false;
+      }
+    });
   }
 }
 

data/lib/rdoc/markup/formatter.rb

@@ -195,18 +195,20 @@ class RDoc::Markup::Formatter
     @in_tt > 0
   end
 
+  def tt_tag? attr_mask, reverse = false
+    each_attr_tag(attr_mask, reverse) do |tag|
+      return true if tt? tag
+    end
+    false
+  end
+
   ##
   # Turns on tags for +item+ on +res+
 
   def on_tags res, item
-    attr_mask = item.turn_on
-    return if attr_mask.zero?
-
-    @attr_tags.each do |tag|
-      if attr_mask & tag.bit != 0 then
-        res << annotate(tag.on)
-        @in_tt += 1 if tt? tag
-      end
+    each_attr_tag(item.turn_on) do |tag|
+      res << annotate(tag.on)
+      @in_tt += 1 if tt? tag
     end
   end
 
@@ -214,13 +216,18 @@ class RDoc::Markup::Formatter
   # Turns off tags for +item+ on +res+
 
   def off_tags res, item
-    attr_mask = item.turn_off
+    each_attr_tag(item.turn_off, true) do |tag|
+      @in_tt -= 1 if tt? tag
+      res << annotate(tag.off)
+    end
+  end
+
+  def each_attr_tag attr_mask, reverse = false
     return if attr_mask.zero?
 
-    @attr_tags.reverse_each do |tag|
+    @attr_tags.public_send(reverse ? :reverse_each : :each) do |tag|
       if attr_mask & tag.bit != 0 then
-        @in_tt -= 1 if tt? tag
-        res << annotate(tag.off)
+        yield tag
       end
     end
   end

data/lib/rdoc/markup/to_html_crossref.rb

@@ -58,7 +58,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Creates a link to the reference +name+ if the name exists.  If +text+ is
   # given it is used as the link text, otherwise +name+ is used.
 
-  def cross_reference name, text = nil, code = true
+  def cross_reference name, text = nil, code = true, rdoc_ref: false
     lookup = name
 
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
@@ -70,7 +70,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       text ||= name
     end
 
-    link lookup, text, code
+    link lookup, text, code, rdoc_ref: rdoc_ref
   end
 
   ##
@@ -83,6 +83,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   def handle_regexp_CROSSREF(target)
     name = target.text
 
+    return name if @options.autolink_excluded_words&.include?(name)
+
     return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
 
     unless @hyperlink_all then
@@ -92,7 +94,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       return name if name =~ /\A[a-z]*\z/
     end
 
-    cross_reference name
+    cross_reference name, rdoc_ref: false
   end
 
   ##
@@ -100,9 +102,14 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # handle other schemes.
 
   def handle_regexp_HYPERLINK target
-    return cross_reference $' if target.text =~ /\Ardoc-ref:/
+    url = target.text
 
-    super
+    case url
+    when /\Ardoc-ref:/
+      cross_reference $', rdoc_ref: true
+    else
+      super
+    end
   end
 
   ##
@@ -117,8 +124,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     url = target.text
 
     case url
-    when /\Ardoc-ref:/ then
-      cross_reference $'
+    when /\Ardoc-ref:/
+      cross_reference $', rdoc_ref: true
     else
       super
     end
@@ -129,16 +136,18 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # RDoc::Markup::ToHtml to handle other schemes.
 
   def gen_url url, text
-    return super unless url =~ /\Ardoc-ref:/
-
-    name = $'
-    cross_reference name, text, name == text
+    if url =~ /\Ardoc-ref:/
+      name = $'
+      cross_reference name, text, name == text, rdoc_ref: true
+    else
+      super
+    end
   end
 
   ##
   # Creates an HTML link to +name+ with the given +text+.
 
-  def link name, text, code = true
+  def link name, text, code = true, rdoc_ref: false
     if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
       name = $1
       label = $'
@@ -148,6 +157,9 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
     case ref
     when String then
+      if rdoc_ref && @options.warn_missing_rdoc_ref
+        puts "#{@from_path}: `rdoc-ref:#{name}` can't be resolved for `#{text}`"
+      end
       ref
     else
       path = ref ? ref.as_href(@from_path) : +""
@@ -172,4 +184,43 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     end
   end
 
+  def convert_flow(flow)
+    res = []
+
+    i = 0
+    while i < flow.size
+      item = flow[i]
+      i += 1
+      case item
+      when RDoc::Markup::AttrChanger then
+        # Make "+Class#method+" a cross reference
+        if tt_tag?(item.turn_on) and
+          String === (str = flow[i]) and
+          RDoc::Markup::AttrChanger === flow[i+1] and
+          tt_tag?(flow[i+1].turn_off, true) and
+          (@options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP).match?(str) and
+          (text = cross_reference str) != str
+        then
+          text = yield text, res if defined?(yield)
+          res << text
+          i += 2
+          next
+        end
+        off_tags res, item
+        on_tags res, item
+      when String then
+        text = convert_string(item)
+        text = yield text, res if defined?(yield)
+        res << text
+      when RDoc::Markup::RegexpHandling then
+        text = convert_regexp_handling(item)
+        text = yield text, res if defined?(yield)
+        res << text
+      else
+        raise "Unknown flow element: #{item.inspect}"
+      end
+    end
+
+    res.join('')
+  end
 end

data/lib/rdoc/markup/to_rdoc.rb

@@ -254,7 +254,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
     end
     aligns = aligns.map do |a|
       case a
-      when nil
+      when nil, :center
         :center
       when :left
         :ljust

data/lib/rdoc/options.rb

@@ -325,6 +325,12 @@ class RDoc::Options
 
   attr_accessor :verbosity
 
+  ##
+  # Warn if rdoc-ref links can't be resolved
+  # Default is +false+
+
+  attr_accessor :warn_missing_rdoc_ref
+
   ##
   # URL of web cvs frontend
 
@@ -349,18 +355,29 @@ class RDoc::Options
   # +--[no-]embed-mixins+ (Default is +false+.)
   attr_accessor :embed_mixins
 
+  ##
+  # Exclude the default patterns as well if true.
+  attr_reader :apply_default_exclude
+
+  ##
+  # Words to be ignored in autolink cross-references
+  attr_accessor :autolink_excluded_words
+
   def initialize loaded_options = nil # :nodoc:
     init_ivars
     override loaded_options if loaded_options
   end
 
+  DEFAULT_EXCLUDE = %w[
+    ~\z \.orig\z \.rej\z \.bak\z
+    \.gemspec\z
+  ]
+
   def init_ivars # :nodoc:
+    @autolink_excluded_words = []
     @dry_run = false
     @embed_mixins = false
-    @exclude = %w[
-      ~\z \.orig\z \.rej\z \.bak\z
-      \.gemspec\z
-    ]
+    @exclude = []
     @files = nil
     @force_output = false
     @force_update = true
@@ -393,11 +410,13 @@ class RDoc::Options
     @update_output_dir = true
     @verbosity = 1
     @visibility = :protected
+    @warn_missing_rdoc_ref = true
     @webcvs = nil
     @write_options = false
     @encoding = Encoding::UTF_8
     @charset = @encoding.name
     @skip_tests = true
+    @apply_default_exclude = true
   end
 
   def init_with map # :nodoc:
@@ -424,6 +443,9 @@ class RDoc::Options
     @visibility     = map['visibility']
     @webcvs         = map['webcvs']
 
+    @apply_default_exclude   = map['apply_default_exclude']
+    @autolink_excluded_words = map['autolink_excluded_words']
+
     @rdoc_include = sanitize_path map['rdoc_include']
     @static_path  = sanitize_path map['static_path']
   end
@@ -456,6 +478,10 @@ class RDoc::Options
     @title          = map['title']          if map.has_key?('title')
     @visibility     = map['visibility']     if map.has_key?('visibility')
     @webcvs         = map['webcvs']         if map.has_key?('webcvs')
+    @autolink_excluded_words = map['autolink_excluded_words'] if map.has_key?('autolink_excluded_words')
+    @apply_default_exclude = map['apply_default_exclude'] if map.has_key?('apply_default_exclude')
+
+    @warn_missing_rdoc_ref = map['warn_missing_rdoc_ref'] if map.has_key?('warn_missing_rdoc_ref')
 
     if map.has_key?('rdoc_include')
       @rdoc_include = sanitize_path map['rdoc_include']
@@ -484,7 +510,9 @@ class RDoc::Options
       @template       == other.template       and
       @title          == other.title          and
       @visibility     == other.visibility     and
-      @webcvs         == other.webcvs
+      @webcvs         == other.webcvs         and
+      @apply_default_exclude == other.apply_default_exclude and
+      @autolink_excluded_words == other.autolink_excluded_words
   end
 
   ##
@@ -555,10 +583,12 @@ class RDoc::Options
     if @exclude.nil? or Regexp === @exclude then
       # done, #finish is being re-run
       @exclude
-    elsif @exclude.empty? then
+    elsif !@apply_default_exclude and @exclude.empty? then
       nil
     else
-      Regexp.new(@exclude.join("|"))
+      exclude = @exclude
+      exclude |= DEFAULT_EXCLUDE if @apply_default_exclude
+      Regexp.new(exclude.join("|"))
     end
   end
 
@@ -792,6 +822,11 @@ Usage: #{opt.program_name} [options] [names...]
         @exclude << value
       end
 
+      opt.on("--[no-]apply-default-exclude",
+             "Use default PATTERN to exclude.") do |value|
+        @apply_default_exclude = value
+      end
+
       opt.separator nil
 
       opt.on("--no-skipping-tests", nil,
@@ -963,6 +998,13 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
+      opt.on("--autolink-excluded-words=WORDS", Array,
+             "Words to be ignored in autolink cross-references") do |value|
+        @autolink_excluded_words.concat value
+      end
+
+      opt.separator nil
+
       opt.on("--hyperlink-all", "-A",
              "Generate hyperlinks for all words that",
              "correspond to known methods, even if they",
@@ -1104,6 +1146,13 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
+      opt.on("--warn-missing-rdoc-ref",
+             "Warn if rdoc-ref links can't be resolved") do |value|
+        @warn_missing_rdoc_ref = value
+      end
+
+      opt.separator nil
+
       opt.on("--[no-]ignore-invalid",
              "Ignore invalid options and continue",
              "(default true).") do |value|

data/lib/rdoc/parser/c.rb

@@ -405,6 +405,7 @@ class RDoc::Parser::C < RDoc::Parser
                  \s*(.*?)\s*\)\s*;
                  %xm) do |type, var_name, const_name, definition|
       var_name = "rb_cObject" if !var_name or var_name == "rb_mKernel"
+      type = "const" if type == "global_const"
       handle_constants type, var_name, const_name, definition
     end
 
@@ -760,6 +761,10 @@ class RDoc::Parser::C < RDoc::Parser
         rb_define_(?<type>\w+)\(\s*(?:\w+),\s*
                            "(?<name>\w+)"\s*,
                            .*?\)\s*;
+    | (?<doc>(?>^\s*/\*.*?\*/\s+))
+        rb_define_global_(?<type>const)\(\s*
+                           "(?<name>\w+)"\s*,
+                           .*?\)\s*;
     |  (?<doc>(?>^\s*/\*.*?\*/\s+))
         rb_file_(?<type>const)\(\s*
                            "(?<name>\w+)"\s*,

data/lib/rdoc/parser/prism_ruby.rb

@@ -642,14 +642,16 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
 
     owner, name = find_or_create_constant_owner_name(module_name)
     if is_class
-      mod = owner.classes_hash[name] || owner.add_class(RDoc::NormalClass, name, superclass_name || '::Object')
-
       # RDoc::NormalClass resolves superclass name despite of the lack of module nesting information.
       # We need to fix it when RDoc::NormalClass resolved to a wrong constant name
       if superclass_name
         superclass_full_path = resolve_constant_path(superclass_name)
         superclass = @store.find_class_or_module(superclass_full_path) if superclass_full_path
         superclass_full_path ||= superclass_name
+      end
+      # add_class should be done after resolving superclass
+      mod = owner.classes_hash[name] || owner.add_class(RDoc::NormalClass, name, superclass_name || '::Object')
+      if superclass_name
         if superclass
           mod.superclass = superclass
         elsif mod.superclass.is_a?(String) && mod.superclass != superclass_full_path

data/lib/rdoc/rubygems_hook.rb

@@ -181,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
 
@@ -310,5 +310,21 @@ module RDoc
       # 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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.9.1
+  version: 6.11.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -11,10 +11,9 @@ authors:
 - Zachary Scott
 - Hiroshi SHIBATA
 - ITOYANAGI Sakura
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -254,7 +253,6 @@ metadata:
   homepage_uri: https://ruby.github.io/rdoc
   source_code_uri: https://github.com/ruby/rdoc
   changelog_uri: https://github.com/ruby/rdoc/releases
-post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -271,8 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []