rdoc 6.4.1.1 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49008d6c7dd9f558a850b2d80fe1070967a339e882e0e7a8fed1f09d4ae7c2ef
-  data.tar.gz: 55456a22866aa32b5dddc56810d4c0791746faa07a8adcb33a6db88e055b350a
+  metadata.gz: acfa378032b35ef7563cf5255d5d3127b1fa8066dd5c5255088d7d13fdabb757
+  data.tar.gz: 0bbc31e7348fcc5227a9b4319dc48cfb5e40143eeaeeb471921a5b2c6b098220
 SHA512:
-  metadata.gz: 7d9d8b2fea44099845005a7dff2401a5a62b86999c4d952fbaeb5ee455e735593b856aa1748614cbfb9a158948861e664eb7265195130045d5390feee1ddade7
-  data.tar.gz: cc985c578b51d3deaa107da47885db422e5b90c4fdc685a4c5bf2f6d8ad20cd2e25b4494136a751978fc275edf026bd7f6edd96c39f356de8da43bc124dc4f36
+  metadata.gz: 7ad2f4cdcf3e7ffa7f81bc8d5795b1481d9c8f7feeba0f2a6455555cecbee603c5fb24e4e612929a7ff314ff027f69b561a0d8cf343c4099ea554db216ad3078
+  data.tar.gz: 93bf81edf3cd84b35db94038b5978abd548042919a1dd3cd039431a681736a3aafe098135c86abe0701dbf3f242bae8af64b293d2f908b2a258ce5075f1519b3

data/CONTRIBUTING.rdoc

@@ -34,8 +34,7 @@ RDoc uses bundler for development.  To get ready to work on RDoc run:
 This will install all the necessary dependencies for development with rake,
 generate documentation and run the tests for the first time.
 
-If the tests don't pass on the first run check the {Travis CI page for
-RDoc}[https://travis-ci.org/ruby/rdoc] to see if there are any known failures
+If the tests don't pass on the first run check the {GitHub Actions page}[https://github.com/ruby/rdoc/actions] to see if there are any known failures
 (there shouldn't be).
 
 You can now use `rake` and `autotest` to run the tests.

data/LEGAL.rdoc

@@ -5,7 +5,7 @@
 The files in this distribution are covered by the Ruby license (see LICENSE) except the features mentioned below:
 
 Darkfish::
-  Darkfish was written by Michael Granger and is included under the MIT
+  Darkfish was written by Michael Granger and is included under the BSD 3-Clause
   license.  Darkfish contains images from the Silk Icons set by Mark James.
 
   See lib/rdoc/generator/darkfish.rb for license information.

data/exe/rdoc

@@ -41,4 +41,3 @@ rescue Exception => e
 
   exit 1
 end
-

data/lib/rdoc/any_method.rb

@@ -350,12 +350,12 @@ class RDoc::AnyMethod < RDoc::MethodAttr
       ignore << is_alias_for.name
       ignore.concat is_alias_for.aliases.map(&:name)
     end
-    ignore.map! { |n| n =~ /\A\[/ ? n[0, 1] : n}
+    ignore.map! { |n| n =~ /\A\[/ ? /\[.*\]/ : n}
     ignore.delete(method_name)
     ignore = Regexp.union(ignore)
 
     matching = entries.reject do |entry|
-      entry =~ /^\w*\.?#{ignore}/ or
+      entry =~ /^\w*\.?#{ignore}[$\(\s]/ or
         entry =~ /\s#{ignore}\s/
     end
 

data/lib/rdoc/code_objects.rb

@@ -2,5 +2,4 @@
 # This file was used to load all the RDoc::CodeObject subclasses at once.  Now
 # autoload handles this.
 
-require 'rdoc'
-
+require_relative '../rdoc'

data/lib/rdoc/context/section.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'cgi/util'
+
 ##
 # A section of documentation like:
 #

data/lib/rdoc/context.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'cgi'
-
 ##
 # A Context is something that can hold modules, classes, methods, attributes,
 # aliases, requires, and includes. Classes, modules, and files are all
@@ -1261,6 +1259,6 @@ class RDoc::Context < RDoc::CodeObject
     klass
   end
 
-  autoload :Section, 'rdoc/context/section'
+  autoload :Section, "#{__dir__}/context/section"
 
 end

data/lib/rdoc/cross_reference.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require_relative 'markup/attribute_manager' # for PROTECT_ATTR
+
 ##
 # RDoc::CrossReference is a reusable way to create cross references for names.
 
@@ -14,12 +17,25 @@ class RDoc::CrossReference
 
   CLASS_REGEXP_STR = '\\\\?((?:\:{2})?[A-Z]\w*(?:\:\:\w+)*)'
 
+  ##
+  # Regular expression to match a single method argument.
+
+  METHOD_ARG_REGEXP_STR = '[\w.+*/=<>-]+'
+
+  ##
+  # Regular expression to match method arguments.
+
+  METHOD_ARGS_REGEXP_STR = /(?:\((?:#{METHOD_ARG_REGEXP_STR}(?:,\s*#{METHOD_ARG_REGEXP_STR})*)?\))?/.source
+
   ##
   # Regular expression to match method references.
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([A-Za-z]\w*[!?=]?|%|===?|\[\]=?|<<|>>|\+@|-@|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = /(
+    (?!\d)[\w#{RDoc::Markup::AttributeManager::PROTECT_ATTR}]+[!?=]?|
+    %|=(?:==?|~)|![=~]|\[\]=?|<(?:<|=>?)?|>[>=]?|[-+!]@?|\*\*?|[\/%\`|&^~]
+  )#{METHOD_ARGS_REGEXP_STR}/.source.delete("\n ").freeze
 
   ##
   # Regular expressions matching text that should potentially have

data/lib/rdoc/generator/markup.rb

@@ -109,7 +109,7 @@ class RDoc::MethodAttr
     lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
     lines.each do |line|
       if line =~ /^ *(?=\S)/
-        n = $&.length
+        n = $~.end(0)
         indent = n if n < indent
         break if n == 0
       end

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

@@ -3,18 +3,18 @@
 <title><%= h @title %></title>
 
 <script type="text/javascript">
-  var rdoc_rel_prefix = "<%= asset_rel_prefix %>/";
-  var index_rel_prefix = "<%= rel_prefix %>/";
+  var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= h rel_prefix %>/";
 </script>
 
-<script src="<%= asset_rel_prefix %>/js/navigation.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/search.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/search_index.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/searcher.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/darkfish.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/navigation.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/search.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/search_index.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/searcher.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/darkfish.js" defer></script>
 
-<link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
-<link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
 <%- @options.template_stylesheets.each do |stylesheet| -%>
-<link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
 <%- end -%>

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

@@ -1,9 +1,33 @@
 <div id="classindex-section" class="nav-section">
   <h3>Class and Module Index</h3>
 
+  <%-
+  all_classes = @classes.group_by do |klass|
+    klass.full_name[/\A[^:]++(?:::[^:]++(?=::))*+(?=::[^:]*+\z)/]
+  end.delete_if do |_, klasses|
+    !klasses.any?(&:display?)
+  end
+  link = proc do |index_klass, display = index_klass.display?|
+    if display
+      -%><code><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.name %></a></code><%-
+    else
+      -%><code><%= index_klass.name %></code><%-
+    end
+  end
+  if top = all_classes[nil]
+    solo = top.one? {|klass| klass.display?}
+    traverse = proc do |klasses| -%>
   <ul class="link-list">
-  <%- @modsort.each do |index_klass| -%>
-    <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
+      <%- 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>
+          <%- traverse.call(children) -%>
+  </ul></details>
+        <%- elsif index_klass.display? -%>
+  <li><% link.call(index_klass, true) %>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    <%- traverse.call(top) -%>
   <%- end -%>
-  </ul>
 </div>

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

@@ -1,11 +1,31 @@
 <%- simple_files = @files.select { |f| f.text? } %>
+<%- if defined?(current) -%>
+  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name -%>
+<%- end -%>
 <%- unless simple_files.empty? then -%>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  <%- simple_files.each do |f| -%>
-    <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
+  <%- simple_files.group_by do |f| -%>
+    <%- f.full_name[%r{\A[^/]+(?=/)}] || f.page_name -%>
+  <%- end.each do |n, files| -%>
+    <%- f = files.shift -%>
+    <%- if files.empty? -%>
+    <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
+      <%- next -%>
+    <%- end -%>
+    <li><details<% if dir == n %> open<% end %>><summary><%
+    if n == f.page_name
+      %><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a><%
+    else
+      %><%= h n %><% files.unshift(f)
+    end %></summary>
+    <ul class="link-list">
+    <%- files.each do |f| -%>
+      <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
+    <%- end -%>
+    </ul></details>
   <%- end -%>
   </ul>
 </div>

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

@@ -3,16 +3,37 @@
              else
                current.comment
              end
-   table = current.parse(comment).table_of_contents
+   table = current.parse(comment).table_of_contents.dup
 
    if table.length > 1 then %>
 <div class="nav-section">
   <h3>Table of Contents</h3>
 
+    <%- display_link = proc do |heading| -%>
+      <a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
+    <%- end -%>
+
+    <%- list_siblings = proc do -%>
+      <%- level = table.first&.level -%>
+      <%- while table.first && table.first.level >= level -%>
+        <%- heading = table.shift -%>
+        <%- if table.first.nil? || table.first.level <= heading.level -%>
+          <li><% display_link.call heading -%>
+        <%- else -%>
+          <li>
+            <details open>
+              <summary><%- display_link.call heading -%></summary>
+              <ul class="link-list" role="directory">
+                <% list_siblings.call %>
+              </ul>
+            </details>
+          </li>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+
   <ul class="link-list" role="directory">
-<%-   table.each do |heading| -%>
-    <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
-<%-   end -%>
+    <% list_siblings.call %>
   </ul>
 </div>
 <%- end -%>

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

@@ -98,28 +98,30 @@
 
     <%- methods.each do |method| -%>
       <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-        <%- if (call_seq = method.call_seq) then -%>
-        <%-   call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
-        <div class="method-heading">
-          <span class="method-callseq">
-            <%= h(call_seq.strip.
-                  gsub( /^\w+\./m, '')).
-                  gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
-          </span>
-          <%- if i == 0 and method.token_stream then -%>
-          <span class="method-click-advice">click to toggle source</span>
-          <%- end -%>
-        </div>
-        <%-   end -%>
-        <%- else -%>
-        <div class="method-heading">
-          <span class="method-name"><%= h method.name %></span><span
-            class="method-args"><%= h method.param_seq %></span>
-          <%- if method.token_stream then -%>
-          <span class="method-click-advice">click to toggle source</span>
+        <div class="method-header">
+          <%- if (call_seq = method.call_seq) then -%>
+          <%-   call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
+          <div class="method-heading">
+            <span class="method-callseq">
+              <%= h(call_seq.strip.
+                    gsub( /^\w+\./m, '')).
+                    gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+            </span>
+            <%- if i == 0 and method.token_stream then -%>
+            <span class="method-click-advice">click to toggle source</span>
+            <%- end -%>
+          </div>
+          <%-   end -%>
+          <%- else -%>
+          <div class="method-heading">
+            <span class="method-name"><%= h method.name %></span><span
+              class="method-args"><%= h method.param_seq %></span>
+            <%- if method.token_stream then -%>
+            <span class="method-click-advice">click to toggle source</span>
+            <%- end -%>
+          </div>
           <%- end -%>
         </div>
-        <%- end -%>
 
         <div class="method-description">
           <%- if method.comment then -%>

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

@@ -186,6 +186,10 @@ nav {
   font-family: Helvetica, sans-serif;
   font-size: 14px;
   border-right: 1px solid #ccc;
+  position: sticky;
+  top: 0;
+  overflow: auto;
+  height: calc(100vh - 100px); /* reduce the footer height */
 }
 
 main {
@@ -305,6 +309,25 @@ dl.note-list dt {
   background: url(../images/arrow_up.png) no-repeat right center;
 }
 
+.nav-section details summary {
+  display: block;
+}
+
+.nav-section details summary::-webkit-details-marker {
+  display: none;
+}
+
+.nav-section details summary:before {
+  content: "";
+}
+
+.nav-section details summary:after {
+  content: "  \25B6"; /* BLACK RIGHT-POINTING TRIANGLE */
+}
+.nav-section details[open] > summary:after {
+  content: "  \25BD"; /* WHITE DOWN-POINTING TRIANGLE */
+}
+
 /* @end */
 
 /* @group Documentation Section */
@@ -482,7 +505,7 @@ main header h3 {
 
 main .method-source-code {
   max-height: 0;
-  overflow: hidden;
+  overflow: auto;
   transition-duration: 200ms;
   transition-delay: 0ms;
   transition-property: all;

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

@@ -17,6 +17,6 @@
       main_page = @files.find { |f| f.full_name == @options.main_page } then %>
 <%= main_page.description %>
 <%- else -%>
-<p>This is the API documentation for <%= @title %>.
+<p>This is the API documentation for <%= h @title %>.
 <%- end -%>
 </main>

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

@@ -54,7 +54,7 @@ function hookSearch() {
     var html = '';
 
     // TODO add relative path to <script> per-page
-    html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
+    html += '<p class="search-match"><a href="' + index_rel_prefix + this.escapeHTML(result.path) + '">' + this.hlt(result.title);
     if (result.params)
       html += '<span class="params">' + result.params + '</span>';
     html += '</a>';

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

@@ -101,7 +101,7 @@ Search.prototype = Object.assign({}, Navigation, new function() {
   }
 
   this.escapeHTML = function(html) {
-    return html.replace(/[&<>]/g, function(c) {
+    return html.replace(/[&<>"`']/g, function(c) {
       return '&#' + c.charCodeAt(0) + ';';
     });
   }

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

@@ -8,14 +8,14 @@
 <ul>
 <%- simple_files.sort.each do |file| -%>
   <li class="file">
-    <a href="<%= file.path %>"><%= h file.page_name %></a>
+    <a href="<%= h file.path %>"><%= h file.page_name %></a>
 <%
    # HACK table_of_contents should not exist on Document
    table = file.parse(file.comment).table_of_contents
    unless table.empty? then %>
     <ul>
 <%- table.each do |heading| -%>
-      <li><a href="<%= file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
+      <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
 <%-   end -%>
     </ul>
 <%- end -%>

data/lib/rdoc/generator.rb

@@ -41,11 +41,11 @@
 
 module RDoc::Generator
 
-  autoload :Markup,   'rdoc/generator/markup'
+  autoload :Markup,   "#{__dir__}/generator/markup"
 
-  autoload :Darkfish,  'rdoc/generator/darkfish'
-  autoload :JsonIndex, 'rdoc/generator/json_index'
-  autoload :RI,        'rdoc/generator/ri'
-  autoload :POT,       'rdoc/generator/pot'
+  autoload :Darkfish,  "#{__dir__}/generator/darkfish"
+  autoload :JsonIndex, "#{__dir__}/generator/json_index"
+  autoload :RI,        "#{__dir__}/generator/ri"
+  autoload :POT,       "#{__dir__}/generator/pot"
 
 end

data/lib/rdoc/i18n.rb

@@ -4,7 +4,7 @@
 
 module RDoc::I18n
 
-  autoload :Locale, 'rdoc/i18n/locale'
+  autoload :Locale, "#{__dir__}/i18n/locale"
   require_relative 'i18n/text'
 
 end

data/lib/rdoc/known_classes.rb

@@ -25,6 +25,7 @@ module RDoc
     "rb_cObject"           => "Object",
     "rb_cProc"             => "Proc",
     "rb_cRange"            => "Range",
+    "rb_cRefinement"       => "Refinement",
     "rb_cRegexp"           => "Regexp",
     "rb_cRubyVM"           => "RubyVM",
     "rb_cSocket"           => "Socket",
@@ -35,7 +36,7 @@ module RDoc
     "rb_cTime"             => "Time",
     "rb_cTrueClass"        => "TrueClass",
 
-    "rb_eArgError"         => "ArgError",
+    "rb_eArgError"         => "ArgumentError",
     "rb_eEOFError"         => "EOFError",
     "rb_eException"        => "Exception",
     "rb_eFatal"            => "fatal",
@@ -45,8 +46,8 @@ module RDoc
     "rb_eInterrupt"        => "Interrupt",
     "rb_eLoadError"        => "LoadError",
     "rb_eNameError"        => "NameError",
-    "rb_eNoMemError"       => "NoMemError",
-    "rb_eNotImpError"      => "NotImpError",
+    "rb_eNoMemError"       => "NoMemoryError",
+    "rb_eNotImpError"      => "NotImplementedError",
     "rb_eRangeError"       => "RangeError",
     "rb_eRuntimeError"     => "RuntimeError",
     "rb_eScriptError"      => "ScriptError",
@@ -57,7 +58,7 @@ module RDoc
     "rb_eSystemCallError"  => "SystemCallError",
     "rb_eSystemExit"       => "SystemExit",
     "rb_eTypeError"        => "TypeError",
-    "rb_eZeroDivError"     => "ZeroDivError",
+    "rb_eZeroDivError"     => "ZeroDivisionError",
 
     "rb_mComparable"       => "Comparable",
     "rb_mEnumerable"       => "Enumerable",