rdoc 6.5.0 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfa378032b35ef7563cf5255d5d3127b1fa8066dd5c5255088d7d13fdabb757
-  data.tar.gz: 0bbc31e7348fcc5227a9b4319dc48cfb5e40143eeaeeb471921a5b2c6b098220
+  metadata.gz: 7b5120e82f653957d49d069e88f361f338a2db7f40bdc0756ffcea7d3bd3c4f2
+  data.tar.gz: a0f09a9246684a22992f2deff120c238b24fbe59a20dfdfa87b340fecc9ce297
 SHA512:
-  metadata.gz: 7ad2f4cdcf3e7ffa7f81bc8d5795b1481d9c8f7feeba0f2a6455555cecbee603c5fb24e4e612929a7ff314ff027f69b561a0d8cf343c4099ea554db216ad3078
-  data.tar.gz: 93bf81edf3cd84b35db94038b5978abd548042919a1dd3cd039431a681736a3aafe098135c86abe0701dbf3f242bae8af64b293d2f908b2a258ce5075f1519b3
+  metadata.gz: e0391b650362cb28f505eaf1d258b259debc4d828ad98643e3a27c1a16811d2bf126b40dd3f9872f4d50536e6875a4691e52c4e6d3732850150710866baf0f69
+  data.tar.gz: c8a40bfeedd964ce6b42781c1ee6c93dda1917a3333b79ebe8b886cd26a8fe49b32522a156c39c99811134fa8bd60612aface400f06641bea155d07a9de6ec2a

data/CONTRIBUTING.rdoc

@@ -40,7 +40,7 @@ If the tests don't pass on the first run check the {GitHub Actions page}[https:/
 You can now use `rake` and `autotest` to run the tests.
 
 Note: the `rake` command must be used first before running any tests, because
-its used to generate various parsers implemented in RDoc. Also `rake clean` is
+it's used to generate various parsers implemented in RDoc. Also `rake clean` is
 helpful to delete these generated files.
 
 == Glossary

data/README.rdoc

@@ -3,7 +3,7 @@
 home :: https://github.com/ruby/rdoc
 rdoc :: https://ruby.github.io/rdoc
 bugs :: https://github.com/ruby/rdoc/issues
-code quality :: {<img src="https://codeclimate.com/github/ruby/rdoc/badges/gpa.svg" alt="Code Climate">}[https://codeclimate.com/github/ruby/rdoc]
+code quality :: https://codeclimate.com/github/ruby/rdoc
 
 == Description
 
@@ -46,7 +46,7 @@ contain just Markup-style markup (with or without leading '#' comment
 markers).  If directory names are passed to RDoc, they are scanned
 recursively for C and Ruby source files only.
 
-To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDocTask.html].
+To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDoc/Task.html].
 
 To generate documentation programmatically:
 

data/TODO.rdoc

@@ -26,7 +26,7 @@ Nice to have:
 * Global variable support
 * Provide the code_object to directive handlers
 
-=== 4
+=== More Future
 
 API changes to RDoc
 

data/lib/rdoc/alias.rb

@@ -109,4 +109,3 @@ class RDoc::Alias < RDoc::CodeObject
   end
 
 end
-

data/lib/rdoc/anon_class.rb

@@ -8,4 +8,3 @@
 
 class RDoc::AnonClass < RDoc::ClassModule
 end
-

data/lib/rdoc/any_method.rb

@@ -115,6 +115,13 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     @call_seq = call_seq
   end
 
+  ##
+  # Whether the method has a call-seq.
+
+  def has_call_seq?
+    !!(@call_seq || is_alias_for&._call_seq)
+  end
+
   ##
   # Loads is_alias_for from the internal name.  Returns nil if the alias
   # cannot be found.
@@ -296,6 +303,14 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     params
   end
 
+  ##
+  # Whether to skip the method description, true for methods that have
+  # aliases with a call-seq that doesn't include the method name.
+
+  def skip_description?
+    has_call_seq? && call_seq.nil? && !!(is_alias_for || !aliases.empty?)
+  end
+
   ##
   # Sets the store for this method and its referenced code objects.
 

data/lib/rdoc/attr.rb

@@ -173,4 +173,3 @@ class RDoc::Attr < RDoc::MethodAttr
   end
 
 end
-

data/lib/rdoc/class_module.rb

@@ -799,4 +799,3 @@ class RDoc::ClassModule < RDoc::Context
   end
 
 end
-

data/lib/rdoc/comment.rb

@@ -6,8 +6,8 @@
 # Each comment may have a different markup format set by #format=.  By default
 # 'rdoc' is used.  The :markup: directive tells RDoc which format to use.
 #
-# See RDoc::Markup@Other+directives for instructions on adding an alternate
-# format.
+# See RDoc::MarkupReference@Directive+for+Specifying+RDoc+Source+Format.
+
 
 class RDoc::Comment
 
@@ -97,42 +97,26 @@ class RDoc::Comment
     # comment.  The difficulty is to make sure not to match lines starting
     # with ARGF at the same indent, but that are after the first description
     # paragraph.
-    if @text =~ /^\s*:?call-seq:(.*?(?:\S).*?)^\s*$/m then
+    if /^(?<S> ((?!\n)\s)*+        (?# whitespaces except newline))
+         :?call-seq:
+           (?<B> \g<S>(?<N>\n|\z)  (?# trailing spaces))?
+         (?<seq>
+           (\g<S>(?!\w)\S.*\g<N>)*
+           (?>
+             (?<H> \g<S>\w+        (?# ' #   ARGF' in the example above))
+             .*\g<N>)?
+           (\g<S>\S.*\g<N>         (?# other non-blank line))*+
+           (\g<B>+(\k<H>.*\g<N>    (?# ARGF.to_a lines))++)*+
+         )
+         (?m:^\s*$|\z)
+        /x =~ @text
+      seq = $~[:seq]
+
       all_start, all_stop = $~.offset(0)
-      seq_start, seq_stop = $~.offset(1)
-
-      # we get the following lines that start with the leading word at the
-      # same indent, even if they have blank lines before
-      if $1 =~ /(^\s*\n)+^(\s*\w+)/m then
-        leading = $2 # ' *    ARGF' in the example above
-        re = %r%
-          \A(
-             (^\s*\n)+
-             (^#{Regexp.escape leading}.*?\n)+
-            )+
-          ^\s*$
-        %xm
-
-        if @text[seq_stop..-1] =~ re then
-          all_stop = seq_stop + $~.offset(0).last
-          seq_stop = seq_stop + $~.offset(1).last
-        end
-      end
-
-      seq = @text[seq_start..seq_stop]
-      seq.gsub!(/^\s*(\S|\n)/m, '\1')
       @text.slice! all_start...all_stop
 
-      method.call_seq = seq.chomp
-
-    else
-      regexp = /^\s*:?call-seq:(.*?)(^\s*$|\z)/m
-      if regexp =~ @text then
-        @text = @text.sub(regexp, '')
-        seq = $1
-        seq.gsub!(/^\s*/, '')
-        method.call_seq = seq
-      end
+      seq.gsub!(/^\s*/, '')
+      method.call_seq = seq
     end
 
     method
@@ -149,12 +133,7 @@ class RDoc::Comment
   # HACK dubious
 
   def encode! encoding
-    # TODO: Remove this condition after Ruby 2.2 EOL
-    if RUBY_VERSION < '2.3.0'
-      @text = @text.force_encoding encoding
-    else
-      @text = String.new @text, encoding: encoding
-    end
+    @text = String.new @text, encoding: encoding
     self
   end
 

data/lib/rdoc/constant.rb

@@ -184,4 +184,3 @@ class RDoc::Constant < RDoc::CodeObject
   end
 
 end
-

data/lib/rdoc/context/section.rb

@@ -231,4 +231,3 @@ class RDoc::Context::Section
   end
 
 end
-

data/lib/rdoc/context.rb

@@ -710,7 +710,7 @@ class RDoc::Context < RDoc::CodeObject
   # This method exists to make it easy to work with Context subclasses that
   # aren't part of RDoc.
 
-  def each_ancestor # :nodoc:
+  def each_ancestor(&_) # :nodoc:
   end
 
   ##

data/lib/rdoc/cross_reference.rb

@@ -131,6 +131,9 @@ class RDoc::CrossReference
     @seen = {}
   end
 
+  ##
+  # Returns a method reference to +name+.
+
   def resolve_method name
     ref = nil
 
@@ -223,4 +226,3 @@ class RDoc::CrossReference
   end
 
 end
-

data/lib/rdoc/encoding.rb

@@ -86,17 +86,6 @@ module RDoc::Encoding
     nil
   end
 
-  def self.remove_frozen_string_literal string
-    string =~ /\A(?:#!.*\n)?(.*\n)/
-    first_line = $1
-
-    if first_line =~ /\A# +frozen[-_]string[-_]literal[=:].+$/i
-      string = string.sub first_line, ''
-    end
-
-    string
-  end
-
   ##
   # Detects the encoding of +string+ based on the magic comment
 
@@ -124,12 +113,7 @@ module RDoc::Encoding
     if text.kind_of? RDoc::Comment
       text.encode! encoding
     else
-      # TODO: Remove this condition after Ruby 2.2 EOL
-      if RUBY_VERSION < '2.3.0'
-        text.force_encoding encoding
-      else
-        String.new text, encoding: encoding
-      end
+      String.new text, encoding: encoding
     end
   end
 

data/lib/rdoc/erb_partial.rb

@@ -16,4 +16,3 @@ class RDoc::ERBPartial < ERB
   end
 
 end
-

data/lib/rdoc/erbio.rb

@@ -20,12 +20,8 @@ class RDoc::ERBIO < ERB
   ##
   # Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize
 
-  def initialize str, safe_level = nil, legacy_trim_mode = nil, legacy_eoutvar = 'io', trim_mode: nil, eoutvar: 'io'
-    if RUBY_VERSION >= '2.6'
-      super(str, trim_mode: trim_mode, eoutvar: eoutvar)
-    else
-      super(str, safe_level, legacy_trim_mode, legacy_eoutvar)
-    end
+  def initialize str, trim_mode: nil, eoutvar: 'io'
+    super(str, trim_mode: trim_mode, eoutvar: eoutvar)
   end
 
   ##
@@ -39,4 +35,3 @@ class RDoc::ERBIO < ERB
   end
 
 end
-

data/lib/rdoc/extend.rb

@@ -7,4 +7,3 @@
 class RDoc::Extend < RDoc::Mixin
 
 end
-

data/lib/rdoc/generator/darkfish.rb

@@ -610,7 +610,7 @@ class RDoc::Generator::Darkfish
 
     @classes = @store.all_classes_and_modules.sort
     @files   = @store.all_files.sort
-    @methods = @classes.map { |m| m.method_list }.flatten.sort
+    @methods = @classes.flat_map { |m| m.method_list }.sort
     @modsort = get_sorted_module_list @classes
   end
 
@@ -778,11 +778,7 @@ class RDoc::Generator::Darkfish
       erbout = "_erbout_#{file_var}"
     end
 
-    if RUBY_VERSION >= '2.6'
-      template = klass.new template, trim_mode: '-', eoutvar: erbout
-    else
-      template = klass.new template, nil, '-', erbout
-    end
+    template = klass.new template, trim_mode: '-', eoutvar: erbout
     @template_cache[file] = template
     template
   end

data/lib/rdoc/generator/json_index.rb

@@ -230,9 +230,9 @@ class RDoc::Generator::JsonIndex
   def index_methods
     debug_msg "  generating method search index"
 
-    list = @classes.uniq.map do |klass|
+    list = @classes.uniq.flat_map do |klass|
       klass.method_list
-    end.flatten.sort_by do |method|
+    end.sort_by do |method|
       [method.name, method.parent.full_name]
     end
 

data/lib/rdoc/generator/markup.rb

@@ -157,4 +157,3 @@ class RDoc::TopLevel
   end
 
 end
-

data/lib/rdoc/generator/pot.rb

@@ -81,6 +81,7 @@ class RDoc::Generator::POT
     end
   end
 
+  # :nodoc:
   def class_dir
     nil
   end

data/lib/rdoc/generator/ri.rb

@@ -28,4 +28,3 @@ class RDoc::Generator::RI
   end
 
 end
-

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

@@ -3,7 +3,7 @@
     <div id="search-field-wrapper">
       <input id="search-field" role="combobox" aria-label="Search"
              aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
              title="Type to search, Up and Down to navigate, Enter to load">
     </div>
 

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

@@ -112,6 +112,10 @@
             <%- end -%>
           </div>
           <%-   end -%>
+          <%- elsif method.has_call_seq? then -%>
+          <div class="method-heading">
+            <span class="method-name"><%= h method.name %></span>
+          </div>
           <%- else -%>
           <div class="method-heading">
             <span class="method-name"><%= h method.name %></span><span
@@ -123,6 +127,7 @@
           <%- end -%>
         </div>
 
+        <%- unless method.skip_description? then -%>
         <div class="method-description">
           <%- if method.comment then -%>
           <%= method.description.strip %>
@@ -145,6 +150,7 @@
           </div>
           <%- end -%>
         </div>
+        <%- end -%>
 
         <%- unless method.aliases.empty? then -%>
         <div class="aliases">

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

@@ -17,6 +17,14 @@ body {
   background: #fafafa;
   font-family: Lato, sans-serif;
   font-weight: 300;
+
+  /* Layout */
+  display: grid;
+  grid-template-columns: auto 1fr;
+}
+
+body > :last-child {
+  grid-column: 1 / 3;
 }
 
 h1 span,
@@ -79,6 +87,17 @@ pre {
   border-radius: 0.2em;
 }
 
+em {
+  text-decoration-color: rgba(52, 48, 64, 0.25);
+  text-decoration-line: underline;
+  text-decoration-style: dotted;
+}
+
+strong,
+em {
+  background-color: rgba(158, 178, 255, 0.1);
+}
+
 table {
   margin: 0;
   border-spacing: 0;
@@ -181,21 +200,25 @@ table tr:nth-child(even) td {
 /* @group Top-Level Structure */
 
 nav {
-  float: left;
-  width: 260px;
   font-family: Helvetica, sans-serif;
   font-size: 14px;
   border-right: 1px solid #ccc;
   position: sticky;
   top: 0;
   overflow: auto;
+
+  /* Layout */
+  width: 260px; /* fallback */
+  width: max(50px, 20vw);
+  min-width: 50px;
+  max-width: 80vw;
   height: calc(100vh - 100px); /* reduce the footer height */
+  resize: horizontal;
 }
 
 main {
   display: block;
-  margin: 0 2em 5em 260px;
-  padding-left: 20px;
+  margin: 1em;
   min-width: 340px;
   font-size: 16px;
 }
@@ -214,7 +237,6 @@ main h6 {
 }
 
 #validator-badges {
-  clear: both;
   margin: 1em 1em 2em;
   font-size: smaller;
 }
@@ -309,23 +331,26 @@ dl.note-list dt {
   background: url(../images/arrow_up.png) no-repeat right center;
 }
 
-.nav-section details summary {
+.nav-section details > summary {
   display: block;
 }
 
-.nav-section details summary::-webkit-details-marker {
+.nav-section details > summary::-webkit-details-marker {
   display: none;
 }
 
-.nav-section details summary:before {
+.nav-section details > summary::before {
   content: "";
 }
 
-.nav-section details summary:after {
-  content: "  \25B6"; /* BLACK RIGHT-POINTING TRIANGLE */
+.nav-section details > summary::after {
+  content: "\25B6"; /* BLACK RIGHT-POINTING TRIANGLE */
+  font-size: 0.8em;
+  margin-left: 0.4em;
 }
-.nav-section details[open] > summary:after {
-  content: "  \25BD"; /* WHITE DOWN-POINTING TRIANGLE */
+
+.nav-section details[open] > summary::after {
+  content: "\25BD"; /* WHITE DOWN-POINTING TRIANGLE */
 }
 
 /* @end */
@@ -553,7 +578,7 @@ main .method-click-advice {
   line-height: 20px;
   background: url(../images/zoom.png) no-repeat right top;
 }
-main .method-heading:hover .method-click-advice {
+main .method-header:hover .method-click-advice {
   visibility: visible;
 }
 

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

@@ -78,7 +78,20 @@ function hookSearch() {
   search.scrollIntoView = search.scrollInWindow;
 };
 
+function hookFocus() {
+  document.addEventListener("keydown", (event) => {
+    if (document.activeElement.tagName === 'INPUT') {
+      return;
+    }
+    if (event.key === "/") {
+      event.preventDefault();
+      document.querySelector('#search-field').focus();
+    }
+  });
+}
+
 document.addEventListener('DOMContentLoaded', function() {
   hookSourceViews();
   hookSearch();
+  hookFocus();
 });

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

@@ -15,9 +15,9 @@ Search.prototype = Object.assign({}, Navigation, new function() {
   this.init = function() {
     var _this = this;
     var observer = function(e) {
-      switch(e.keyCode) {
-        case 38: // Event.KEY_UP
-        case 40: // Event.KEY_DOWN
+      switch(e.key) {
+        case 'ArrowUp':
+        case 'ArrowDown':
           return;
       }
       _this.search(_this.input.value);

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

@@ -36,8 +36,9 @@
    unless table.empty? then %>
     <ul>
 <%- table.each do |item| -%>
-      <li><a href="<%= klass.path %>#<%= item.aref %>"><%= item.plain_html %></a>
-<%-   end -%>
+<%-   label = item.respond_to?(:label) ? item.label(klass) : item.aref -%>
+      <li><a href="<%= klass.path %>#<%= label %>"><%= item.plain_html %></a>
+<%- end -%>
     </ul>
 <%- end -%>
   </li>
@@ -46,9 +47,9 @@
 
 <h2 id="methods">Methods</h2>
 <ul>
-<%- @store.all_classes_and_modules.map do |mod|
+<%- @store.all_classes_and_modules.flat_map do |mod|
      mod.method_list
-   end.flatten.sort.each do |method| %>
+   end.sort.each do |method| %>
   <li class="method">
     <a href="<%= method.path %>"><%= h method.pretty_name %></a>
     &mdash;

data/lib/rdoc/generator/template/json_index/js/navigation.js

@@ -23,24 +23,24 @@ Navigation = new function() {
 
   this.onkeydown = function(e) {
     if (!this.navigationActive) return;
-    switch(e.keyCode) {
-      case 37: //Event.KEY_LEFT:
+    switch(e.key) {
+      case 'ArrowLeft':
         if (this.moveLeft()) e.preventDefault();
         break;
-      case 38: //Event.KEY_UP:
-        if (e.keyCode == 38 || e.ctrlKey) {
+      case 'ArrowUp':
+        if (e.key == 'ArrowUp' || e.ctrlKey) {
           if (this.moveUp()) e.preventDefault();
         }
         break;
-      case 39: //Event.KEY_RIGHT:
+      case 'ArrowRight':
         if (this.moveRight()) e.preventDefault();
         break;
-      case 40: //Event.KEY_DOWN:
-        if (e.keyCode == 40 || e.ctrlKey) {
+      case 'ArrowDown':
+        if (e.key == 'ArrowDown' || e.ctrlKey) {
           if (this.moveDown()) e.preventDefault();
         }
         break;
-      case 13: //Event.KEY_RETURN:
+      case 'Enter':
         if (this.current) e.preventDefault();
         this.select(this.current);
         break;

data/lib/rdoc/ghost_method.rb

@@ -4,4 +4,3 @@
 
 class RDoc::GhostMethod < RDoc::AnyMethod
 end
-

data/lib/rdoc/include.rb

@@ -7,4 +7,3 @@
 class RDoc::Include < RDoc::Mixin
 
 end
-

data/lib/rdoc/markdown/entities.rb

@@ -2129,4 +2129,3 @@ RDoc::Markdown::HTML_ENTITIES = {
   "zwj" => [0x0200D],
   "zwnj" => [0x0200C],
 }
-

data/lib/rdoc/markdown/literals.kpeg

@@ -6,7 +6,6 @@
 # :markup: markdown
 
 ##
-#--
 # This set of literals is for Ruby 1.9 regular expressions and gives full
 # unicode support.
 #
@@ -20,4 +19,3 @@ BOM               = "\uFEFF"
 Newline           = /\n|\r\n?|\p{Zl}|\p{Zp}/
 NonAlphanumeric   = /\p{^Word}/
 Spacechar         = /\t|\p{Zs}/
-