rdoc 7.1.0 → 8.0.0

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

@@ -3,7 +3,7 @@
 <%= render '_header.rhtml' %>
 <%= render '_sidebar_toggle.rhtml' %>
 
-<nav id="navigation" role="navigation" hidden>
+<nav id="sidebar-navigation" role="navigation" hidden>
   <%= render '_sidebar_pages.rhtml' %>
   <%= render '_sidebar_classes.rhtml' %>
 </nav>

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

@@ -70,8 +70,6 @@ function createSearchInstance(input, result) {
     window.location.href = result.firstChild.firstChild.href;
   }
 
-  search.scrollIntoView = search.scrollInWindow;
-
   return search;
 }
 
@@ -96,6 +94,14 @@ function hookSearch() {
     }
   });
 
+  // Hide search results on Escape key on desktop too
+  document.addEventListener('keydown', (e) => {
+    if (e.key === 'Escape' && input.matches(":focus")) {
+      search.hide();
+      input.blur();
+    }
+  });
+
   // Show search results when focusing on input (if there's a query)
   input.addEventListener('focus', () => {
     if (input.value.trim()) {
@@ -131,32 +137,32 @@ function hookFocus() {
 /* ===== Mobile Navigation ===== */
 
 function hookSidebar() {
-  const navigation = document.querySelector('#navigation');
-  const navigationToggle = document.querySelector('#navigation-toggle');
+  const sidebarNavigation = document.querySelector('#sidebar-navigation');
+  const sidebarNavigationToggle = document.querySelector('#sidebar-navigation-toggle');
 
-  if (!navigation || !navigationToggle) return;
+  if (!sidebarNavigation || !sidebarNavigationToggle) return;
 
   const closeNav = () => {
-    navigation.hidden = true;
-    navigationToggle.ariaExpanded = 'false';
-    document.body.classList.remove('nav-open');
+    sidebarNavigation.hidden = true;
+    sidebarNavigationToggle.ariaExpanded = 'false';
+    document.body.classList.remove('sidebar-navigation-open');
   };
 
   const openNav = () => {
-    navigation.hidden = false;
-    navigationToggle.ariaExpanded = 'true';
-    document.body.classList.add('nav-open');
+    sidebarNavigation.hidden = false;
+    sidebarNavigationToggle.ariaExpanded = 'true';
+    document.body.classList.add('sidebar-navigation-open');
   };
 
   const toggleNav = () => {
-    if (navigation.hidden) {
+    if (sidebarNavigation.hidden) {
       openNav();
     } else {
       closeNav();
     }
   };
 
-  navigationToggle.addEventListener('click', (e) => {
+  sidebarNavigationToggle.addEventListener('click', (e) => {
     e.stopPropagation();
     toggleNav();
   });
@@ -168,18 +174,20 @@ function hookSidebar() {
   // This is better than the opposite approach of hiding it with JavaScript
   // because it avoids flickering the sidebar when the page is loaded, especially on mobile devices
   if (isSmallViewport) {
+    closeNav();
+
     // Close nav when clicking links inside it
     document.addEventListener('click', (e) => {
-      if (e.target.closest('#navigation a')) {
+      if (e.target.closest('#sidebar-navigation a')) {
         closeNav();
       }
     });
 
     // Close nav when clicking backdrop
     document.addEventListener('click', (e) => {
-      if (!navigation.hidden &&
-          !e.target.closest('#navigation') &&
-          !e.target.closest('#navigation-toggle')) {
+      if (!sidebarNavigation.hidden &&
+          !e.target.closest('#sidebar-navigation') &&
+          !e.target.closest('#sidebar-navigation-toggle')) {
         closeNav();
       }
     });
@@ -227,7 +235,7 @@ function generateToc() {
     tocNav.appendChild(tocList);
   } else {
     // Hide TOC if no headings found
-    const tocContainer = document.querySelector('.table-of-contents');
+    const tocContainer = document.querySelector('#table-of-contents');
     if (tocContainer) {
       tocContainer.style.display = 'none';
     }
@@ -429,8 +437,8 @@ function wrapCodeBlocksWithCopyButton() {
   //   not directly in rhtml templates
   // - Modifying the formatter would require extending RDoc's core internals
 
-  // Find all pre elements that are not already wrapped
-  const preElements = document.querySelectorAll('main pre:not(.code-block-wrapper pre)');
+  // Target code examples and source code; skip type signature blocks
+  const preElements = document.querySelectorAll('main pre:not(.method-type-signature)');
 
   preElements.forEach((pre) => {
     // Skip if already wrapped

data/lib/rdoc/generator/template/aliki/js/bash_highlighter.js

@@ -0,0 +1,167 @@
+/**
+ * Client-side shell syntax highlighter for RDoc
+ * Highlights: $ prompts, commands, options, strings, env vars, comments
+ */
+
+(function() {
+  'use strict';
+
+  function escapeHtml(text) {
+    return text
+      .replace(/&/g, '&')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;')
+      .replace(/'/g, '&#39;');
+  }
+
+  function wrap(className, text) {
+    return '<span class="' + className + '">' + escapeHtml(text) + '</span>';
+  }
+
+  function highlightLine(line) {
+    if (line.trim() === '') return escapeHtml(line);
+
+    var result = '';
+    var i = 0;
+    var len = line.length;
+
+    // Preserve leading whitespace
+    while (i < len && (line[i] === ' ' || line[i] === '\t')) {
+      result += escapeHtml(line[i++]);
+    }
+
+    // Check for $ prompt ($ followed by space or end of line)
+    if (line[i] === '$' && (line[i + 1] === ' ' || line[i + 1] === undefined)) {
+      result += wrap('sh-prompt', '$');
+      i++;
+    }
+
+    // Check for # comment at start
+    if (line[i] === '#') {
+      return result + wrap('sh-comment', line.slice(i));
+    }
+
+    var seenCommand = false;
+    var afterSpace = true;
+
+    while (i < len) {
+      var ch = line[i];
+
+      // Whitespace
+      if (ch === ' ' || ch === '\t') {
+        result += escapeHtml(ch);
+        i++;
+        afterSpace = true;
+        continue;
+      }
+
+      // Comment after whitespace
+      if (ch === '#' && afterSpace) {
+        result += wrap('sh-comment', line.slice(i));
+        break;
+      }
+
+      // Double-quoted string
+      if (ch === '"') {
+        var end = i + 1;
+        while (end < len && line[end] !== '"') {
+          if (line[end] === '\\' && end + 1 < len) end += 2;
+          else end++;
+        }
+        if (end < len) end++;
+        result += wrap('sh-string', line.slice(i, end));
+        i = end;
+        afterSpace = false;
+        continue;
+      }
+
+      // Single-quoted string
+      if (ch === "'") {
+        var end = i + 1;
+        while (end < len && line[end] !== "'") end++;
+        if (end < len) end++;
+        result += wrap('sh-string', line.slice(i, end));
+        i = end;
+        afterSpace = false;
+        continue;
+      }
+
+      // Environment variable (ALLCAPS=)
+      if (afterSpace && /[A-Z]/.test(ch)) {
+        var match = line.slice(i).match(/^[A-Z][A-Z0-9_]*=/);
+        if (match) {
+          result += wrap('sh-envvar', match[0]);
+          i += match[0].length;
+          // Read unquoted value
+          var valEnd = i;
+          while (valEnd < len && line[valEnd] !== ' ' && line[valEnd] !== '\t' && line[valEnd] !== '"' && line[valEnd] !== "'") valEnd++;
+          if (valEnd > i) {
+            result += escapeHtml(line.slice(i, valEnd));
+            i = valEnd;
+          }
+          afterSpace = false;
+          continue;
+        }
+      }
+
+      // Option (must be after whitespace)
+      if (ch === '-' && afterSpace) {
+        var match = line.slice(i).match(/^--?[a-zA-Z0-9_-]+(=[^"'\s]*)?/);
+        if (match) {
+          result += wrap('sh-option', match[0]);
+          i += match[0].length;
+          afterSpace = false;
+          continue;
+        }
+      }
+
+      // Command (first word: regular, ./path, ../path, ~/path, /abs/path, @scope/pkg)
+      if (!seenCommand && afterSpace) {
+        var isCmd = /[a-zA-Z0-9@~\/]/.test(ch) ||
+                    (ch === '.' && (line[i + 1] === '/' || (line[i + 1] === '.' && line[i + 2] === '/')));
+        if (isCmd) {
+          var end = i;
+          while (end < len && line[end] !== ' ' && line[end] !== '\t') end++;
+          result += wrap('sh-command', line.slice(i, end));
+          i = end;
+          seenCommand = true;
+          afterSpace = false;
+          continue;
+        }
+      }
+
+      // Everything else
+      result += escapeHtml(ch);
+      i++;
+      afterSpace = false;
+    }
+
+    return result;
+  }
+
+  function highlightShell(code) {
+    return code.split('\n').map(highlightLine).join('\n');
+  }
+
+  function initHighlighting() {
+    var selectors = [
+      'pre.bash', 'pre.sh', 'pre.shell', 'pre.console',
+      'pre[data-language="bash"]', 'pre[data-language="sh"]',
+      'pre[data-language="shell"]', 'pre[data-language="console"]'
+    ];
+
+    var blocks = document.querySelectorAll(selectors.join(', '));
+    blocks.forEach(function(block) {
+      if (block.getAttribute('data-highlighted') === 'true') return;
+      block.innerHTML = highlightShell(block.textContent);
+      block.setAttribute('data-highlighted', 'true');
+    });
+  }
+
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', initHighlighting);
+  } else {
+    initHighlighting();
+  }
+})();

data/lib/rdoc/generator/template/aliki/js/search_controller.js

@@ -96,7 +96,7 @@ SearchController.prototype = Object.assign({}, SearchNavigation, new function()
       this.current.classList.remove('search-selected');
       next.classList.add('search-selected');
       this.input.setAttribute('aria-activedescendant', next.getAttribute('id'));
-      this.scrollIntoView(next, this.view);
+      this.scrollInElement(next, this.result);
       this.current = next;
       this.input.value = next.firstChild.firstChild.text;
       this.input.select();

data/lib/rdoc/generator/template/aliki/page.rhtml

@@ -3,7 +3,7 @@
 <%= render '_header.rhtml' %>
 <%= render '_sidebar_toggle.rhtml' %>
 
-<nav id="navigation" role="navigation" hidden>
+<nav id="sidebar-navigation" role="navigation" hidden>
   <%= render '_sidebar_pages.rhtml' %>
   <%= render '_sidebar_classes.rhtml' %>
 </nav>

data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml

@@ -1,7 +1,7 @@
 <body role="document">
 <%= render '_sidebar_toggle.rhtml' %>
 
-<nav id="navigation" role="navigation" hidden>
+<nav id="sidebar-navigation" role="navigation" hidden>
   <%= render '_sidebar_pages.rhtml' %>
   <%= render '_sidebar_classes.rhtml' %>
 </nav>

data/lib/rdoc/generator/template/aliki/servlet_root.rhtml

@@ -1,7 +1,7 @@
 <body role="document">
 <%= render '_sidebar_toggle.rhtml' %>
 
-<nav id="navigation" role="navigation" hidden>
+<nav id="sidebar-navigation" role="navigation" hidden>
   <div id="project-navigation">
     <div id="home-section" class="nav-section">
       <h2>
@@ -42,7 +42,7 @@
 
 <%- gems = installed.select { |_, _, _, type,| type == :gem } %>
 <%- missing = gems.reject { |_, _, exists,| exists } %>
-<%- unless missing.empty? then %>
+<%- unless missing.empty? %>
   <h2>Missing Gem Documentation</h2>
 
   <p>You are missing documentation for some of your installed gems.

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

@@ -1,14 +1,16 @@
-<%- unless klass.extends.empty? then %>
+<%- unless klass.extends.empty? %>
 <div id="extends-section" class="nav-section">
   <h3>Extended With Modules</h3>
 
   <ul class="link-list">
   <%- klass.extends.each do |ext| %>
-  <%- unless String === ext.module then %>
-    <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a></li>
-  <%- else %>
-    <li><span class="extend"><%= ext.name %></span></li>
-  <%- end %>
+    <li>
+    <%- unless String === ext.module %>
+      <a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
+    <%- else %>
+      <span class="extend"><%= ext.name %></span>
+    <%- end %>
+    </li>
   <%- end %>
   </ul>
 </div>

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

@@ -1,14 +1,16 @@
-<%- unless klass.includes.empty? then %>
+<%- unless klass.includes.empty? %>
 <div id="includes-section" class="nav-section">
   <h3>Included Modules</h3>
 
   <ul class="link-list">
   <%- klass.includes.each do |inc| %>
-  <%- unless String === inc.module then %>
-    <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
-  <%- else %>
-    <li><span class="include"><%= inc.name %></span></li>
-  <%- end %>
+    <li>
+    <%- unless String === inc.module %>
+      <a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
+    <%- else %>
+      <span class="include"><%= inc.name %></span>
+    <%- end %>
+    </li>
   <%- end %>
   </ul>
 </div>

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

@@ -5,7 +5,7 @@
   <%- installed.each do |name, href, exists, type, _| %>
     <%- next if type == :extra %>
     <li class="folder">
-    <%- if exists then %>
+    <%- if exists %>
       <a href="<%= href %>"><%= h name %></a>
     <%- else %>
       <%= h name %>

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

@@ -2,7 +2,7 @@
 <%- if defined?(current) %>
   <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
 <%- end %>
-<%- unless simple_files.empty? then %>
+<%- unless simple_files.empty? %>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 

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

@@ -1,4 +1,4 @@
-<%- unless klass.sections.length == 1 then %>
+<%- unless klass.sections.length == 1 %>
 <div id="sections-section" class="nav-section">
   <h3>Sections</h3>
 

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

@@ -1,11 +1,11 @@
-<%- comment = if current.respond_to? :comment_location then
+<%- comment = if current.respond_to? :comment_location
                current.comment_location
              else
                current.comment
              end
    table = current.parse(comment).table_of_contents.dup
 
-   if table.length > 1 then %>
+   if table.length > 1 %>
 <div class="nav-section">
   <h3>Table of Contents</h3>
 
@@ -17,18 +17,18 @@
       <%- level = table.first&.level %>
       <%- while table.first && table.first.level >= level %>
         <%- heading = table.shift %>
+        <li>
         <%- if table.first.nil? || table.first.level <= heading.level %>
-          <li><% display_link.call heading %></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 %>
+        </li>
       <%- end %>
     <%- end %>
 

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

@@ -26,7 +26,7 @@
         <% if namespace[:self] %>
         <span><%= namespace[:name] %></span>
         <% else %>
-        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span>::</span>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span class="separator">::</span>
         <% end %>
       </li>
       <% end %>
@@ -45,7 +45,7 @@
   <%- klass.each_section do |section, constants, attributes| %>
   <span id="<%= section.legacy_aref %>" class="legacy-anchor"></span>
   <section id="<%= section.aref %>" class="documentation-section anchor-link">
-    <%- if section.title then %>
+    <%- if section.title %>
     <header class="documentation-section-title">
       <h2>
         <%= section.title %>
@@ -56,13 +56,13 @@
     </header>
     <%- end %>
 
-    <%- if section.comment then %>
+    <%- if section.comment %>
     <div>
       <%= section.description %>
     </div>
     <%- end %>
 
-    <%- unless constants.empty? then %>
+    <%- unless constants.empty? %>
     <section class="constants-list">
       <header>
         <h3>Constants</h3>
@@ -70,9 +70,9 @@
       <dl>
       <%- constants.each do |const| %>
         <dt id="<%= const.name %>"><%= const.name %></dt>
-        <%- if const.comment then %>
+        <%- if const.comment %>
         <dd>
-          <%- if const.mixin_from then %>
+          <%- if const.mixin_from %>
             <div class="mixin-from">
               Included from <a href="<%= klass.aref_to(const.mixin_from.path) %>"><%= const.mixin_from.full_name %></a>
             </div>
@@ -87,7 +87,7 @@
     </section>
     <%- end %>
 
-    <%- unless attributes.empty? then %>
+    <%- unless attributes.empty? %>
     <section class="attribute-method-details method-section">
       <header>
         <h3>Attributes</h3>
@@ -103,12 +103,12 @@
         </div>
 
         <div class="method-description">
-        <%- if attrib.mixin_from then %>
+        <%- if attrib.mixin_from %>
           <div class="mixin-from">
             <%= attrib.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(attrib.mixin_from.path) %>"><%= attrib.mixin_from.full_name %></a>
           </div>
         <%- end %>
-        <%- if attrib.comment then %>
+        <%- if attrib.comment %>
         <%= attrib.description.strip %>
         <%- else %>
         <p class="missing-docs">(Not documented)</p>
@@ -131,7 +131,7 @@
     <%- methods.each do |method| %>
       <div id="<%= method.aref %>" class="method-detail anchor-link <%= method.is_alias_for ? "method-alias" : '' %>">
         <div class="method-header">
-          <%- if (call_seq = method.call_seq) then %>
+          <%- if (call_seq = method.call_seq) %>
             <%- call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
               <div class="method-heading">
                 <a href="#<%= method.aref %>" title="Link to this method">
@@ -143,7 +143,7 @@
                 </a>
               </div>
             <%- end %>
-          <%- elsif method.has_call_seq? then %>
+          <%- elsif method.has_call_seq? %>
             <div class="method-heading">
               <a href="#<%= method.aref %>" title="Link to this method">
                 <span class="method-name"><%= h method.name %></span>
@@ -170,31 +170,28 @@
           </div>
         <%- end %>
 
-        <%- unless method.skip_description? then %>
+        <%- unless method.skip_description? %>
         <div class="method-description">
-          <%- if method.mixin_from then %>
+          <%- if method.mixin_from %>
             <div class="mixin-from">
               <%= method.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(method.mixin_from.path) %>"><%= method.mixin_from.full_name %></a>
             </div>
           <%- end %>
-          <%- if method.comment then %>
+          <%- if method.comment %>
           <%= method.description.strip %>
           <%- else %>
           <p class="missing-docs">(Not documented)</p>
           <%- end %>
-          <%- if method.calls_super then %>
+          <%- if method.calls_super %>
             <div class="method-calls-super">
               Calls superclass method
-              <%=
-                  method.superclass_method ?
-                  method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
-              %>
+              <%= method.superclass_method_link %>
             </div>
           <%- end %>
         </div>
         <%- end %>
 
-        <%- unless method.aliases.empty? then %>
+        <%- unless method.aliases.empty? %>
         <div class="aliases">
           Also aliased as: <%= method.aliases.map do |aka|
             if aka.parent then # HACK lib/rexml/encodings
@@ -206,7 +203,7 @@
         </div>
         <%- end %>
 
-        <%- if method.is_alias_for then %>
+        <%- if method.is_alias_for %>
         <div class="aliases">
           Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
         </div>

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

@@ -449,7 +449,6 @@ main h6 {
 .ruby-ivar       { color: #B57614; }  /* Brown */
 .ruby-operator   { color: #427B58; }  /* Dark Teal */
 .ruby-identifier { color: #076678; }  /* Deep Teal */
-.ruby-node       { color: #8F3F71; }  /* Plum */
 .ruby-comment    { color: #928374; font-style: italic; }  /* Gray */
 .ruby-regexp     { color: #8F3F71; }  /* Plum */
 .ruby-value      { color: #AF3A03; }  /* Dark Orange */

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

@@ -14,7 +14,7 @@
 <h1 class="class"><%= h @title %></h1>
 
 <%- simple_files = @files.select { |f| f.text? } %>
-<%- unless simple_files.empty? then %>
+<%- unless simple_files.empty? %>
 <h2 id="pages">Pages</h2>
 <ul>
 <%- simple_files.sort.each do |file| %>
@@ -23,7 +23,7 @@
 <%
    # HACK table_of_contents should not exist on Document
    table = file.parse(file.comment).table_of_contents
-   unless table.empty? then %>
+   unless table.empty? %>
     <ul>
     <%- table.each do |heading| %>
       <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a></li>
@@ -44,7 +44,7 @@
    table.concat klass.parse(klass.comment_location).table_of_contents
    table.concat klass.section_contents
 
-   unless table.empty? then %>
+   unless table.empty? %>
     <ul>
 <%- table.each do |item| %>
   <%- label = item.respond_to?(:label) ? item.label(klass) : item.aref %>

data/lib/rdoc/i18n/text.rb

@@ -89,9 +89,9 @@ class RDoc::I18n::Text
     case raw
     when RDoc::Comment
       raw.text.each_line(&block)
-    when Array
-      raw.each do |comment, location|
-        each_line(comment, &block)
+    when Hash
+      raw.each_value do |comments|
+        comments.each { |comment| each_line(comment, &block) }
       end
     else
       raw.each_line(&block)