rdoc 6.9.0 → 6.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8d7aec4fc5f30f9f33ef7dccb85f885775137d9fdea7993823ac93c322a6214
-  data.tar.gz: 5f3636164c89b6a183e9d6598a4633148b8e311f1344a04c6f331c17b8b5b3fb
+  metadata.gz: 59a2919a713acb30b6faff04d96186d25a5e7ab06b76fdfb0df2d42b086b4517
+  data.tar.gz: 78cb25012a74e585bf9deb1cb0829404cd568d098eac337048a04170f3a7df61
 SHA512:
-  metadata.gz: 6d6744cd8cce25be176b36df564646a41656c60ff0a4f6d581748b8300ca8960a14c46f3f14e478c4b6fa9c9c1cfbd12a3fcb25f624637b01473e885a51127bc
-  data.tar.gz: e4f917825bbed2f768ed8ad28db175b67d37a9919fde1fe4e4383f150ff83d22a49c180874506fecab223e5b892d88a066b327d7edb4bf699e6295adb56adf69
+  metadata.gz: 26d8df27e608c4f1d07d3c5f20996514523636447136ec9726ddd0cfdf64ee6c28cd9362e9b1c9747ba41076672c21a8e05c54d934de16f3bebed39bd95ebfc6
+  data.tar.gz: bfb38f2b3baecd464e36da81caf477de2096ab7c5c059a52167dc0f84bc00b579261b37bf18f63a1ae34953ad1d10699043e1c881166e7c11f17736edb2627e8

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

@@ -292,6 +292,14 @@ main {
   main {
     margin-left: var(--sidebar-width);
   }
+
+  .table-of-contents main {
+    margin-left: 20em;
+  }
+
+  #navigation-toggle {
+    display: none;
+  }
 }
 
 main h1[class] {
@@ -311,12 +319,6 @@ main h6 {
   color: var(--highlight-color);
 }
 
-@media (min-width: 1024px) {
-  .table-of-contents main {
-    margin-left: 20em;
-  }
-}
-
 /* Search */
 #search-section {
   padding: 1em;
@@ -514,18 +516,6 @@ main header h3 {
 .hide { display: none !important; }
 .initially-hidden { display: none; }
 
-/* Media Queries */
-@media (min-width: 1024px) {
-  /* Styles for larger screens */
-  .table-of-contents main {
-    margin-left: 20em;
-  }
-}
-
-@media print {
-  /* Print-specific styles */
-}
-
 /* Table of Contents */
 .table-of-contents ul {
   margin: 1em;

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

@@ -99,10 +99,16 @@ function hookSidebar() {
     navigationToggle.ariaExpanded = navigationToggle.ariaExpanded !== 'true';
   });
 
-  var isSmallViewport = window.matchMedia("(max-width: 1024px)").matches;
+  var isSmallViewport = window.matchMedia("(max-width: 1023px)").matches;
   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
 
   ##
@@ -92,7 +92,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 +100,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 +122,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 +134,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 +155,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 +182,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
 
@@ -393,6 +399,7 @@ class RDoc::Options
     @update_output_dir = true
     @verbosity = 1
     @visibility = :protected
+    @warn_missing_rdoc_ref = false
     @webcvs = nil
     @write_options = false
     @encoding = Encoding::UTF_8
@@ -457,6 +464,8 @@ class RDoc::Options
     @visibility     = map['visibility']     if map.has_key?('visibility')
     @webcvs         = map['webcvs']         if map.has_key?('webcvs')
 
+    @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']
     end
@@ -1104,6 +1113,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/rubygems_hook.rb

@@ -271,7 +271,7 @@ end
 module RDoc
   class RubygemsHook
 
-    attr_accessor :generate_rdoc, :generate_ri
+    attr_accessor :generate_rdoc, :generate_ri, :force
 
     def self.default_gem?
       !File.exist?(File.join(__dir__, "..", "rubygems_plugin.rb"))
@@ -281,6 +281,7 @@ module RDoc
       @spec = spec
       @generate_rdoc = generate_rdoc
       @generate_ri   = generate_ri
+      @force = false
     end
 
     def generate
@@ -288,7 +289,9 @@ module RDoc
       return unless self.class.default_gem?
 
       # Generate document for compatibility if this is a default gem.
-      RubyGemsHook.new(@spec, @generate_rdoc, @generate_ri).generate
+      hook = RubyGemsHook.new(@spec, @generate_rdoc, @generate_ri)
+      hook.force = @force
+      hook.generate
     end
 
     def remove

data/lib/rdoc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.9.0
+  version: 6.10.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -271,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects