rdoc 6.15.0 → 7.0.2

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

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

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

@@ -3,9 +3,9 @@
   <h3>Sections</h3>
 
   <ul class="link-list" role="directory">
-    <%- klass.sort_sections.each do |section| -%>
+    <%- klass.sort_sections.each do |section| %>
       <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
-    <%- end -%>
+    <%- end %>
   </ul>
 </div>
-<%- end -%>
+<%- end %>

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

@@ -9,31 +9,31 @@
 <div class="nav-section">
   <h3>Table of Contents</h3>
 
-    <%- display_link = proc do |heading| -%>
+    <%- display_link = proc do |heading| %>
       <a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
-    <%- end -%>
+    <%- 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 -%>
+    <%- 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 %></li>
+        <%- else %>
           <li>
             <details open>
-              <summary><%- display_link.call heading -%></summary>
+              <summary><%- display_link.call heading %></summary>
               <ul class="link-list" role="directory">
                 <% list_siblings.call %>
               </ul>
             </details>
           </li>
-        <%- end -%>
-      <%- end -%>
-    <%- end -%>
+        <%- end %>
+      <%- end %>
+    <%- end %>
 
   <ul class="link-list" role="directory">
     <% list_siblings.call %>
   </ul>
 </div>
-<%- end -%>
+<%- end %>

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

@@ -17,10 +17,10 @@
   <%= render '_footer.rhtml' %>
 </nav>
 
-<main role="main" aria-labelledby="<%=h klass.aref %>">
+<main role="main" aria-labelledby="<%= h klass.aref %>">
   <%# If nesting level is 1, breadcrumb list is not needed %>
   <% if breadcrumb.size > 1 %>
-    <ol role="navigation" aria-label="breadcrumb" class="breadcrumb">
+    <ol role="navigation" aria-label="Breadcrumb navigation" class="breadcrumb">
       <% breadcrumb.each do |namespace| %>
       <li>
         <% if namespace[:self] %>
@@ -33,7 +33,7 @@
     </ol>
   <% end %>
 
-  <h1 id="<%=h klass.aref %>" class="anchor-link <%= klass.type %>">
+  <h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
     <%= klass.type %> <%= klass.full_name %>
   </h1>
 
@@ -41,9 +41,9 @@
     <%= klass.description %>
   </section>
 
-  <%- klass.each_section do |section, constants, attributes| -%>
+  <%- klass.each_section do |section, constants, attributes| %>
   <section id="<%= section.aref %>" class="documentation-section anchor-link">
-    <%- if section.title then -%>
+    <%- if section.title then %>
     <header class="documentation-section-title">
       <h2>
         <%= section.title %>
@@ -52,45 +52,46 @@
         <a href="#top">&uarr; top</a>
       </span>
     </header>
-    <%- end -%>
+    <%- end %>
 
-    <%- if section.comment then -%>
+    <%- if section.comment then %>
     <div>
       <%= section.description %>
     </div>
-    <%- end -%>
+    <%- end %>
 
-    <%- unless constants.empty? then -%>
+    <%- unless constants.empty? then %>
     <section class="constants-list">
       <header>
         <h3>Constants</h3>
       </header>
       <dl>
-      <%- constants.each do |const| -%>
-        <dt id="<%= const.name %>"><%= const.name %>
-        <%- if const.comment then -%>
+      <%- constants.each do |const| %>
+        <dt id="<%= const.name %>"><%= const.name %></dt>
+        <%- if const.comment then %>
         <dd>
-          <%- if const.mixin_from then -%>
+          <%- if const.mixin_from then %>
             <div class="mixin-from">
-              Included from <a href="<%= klass.aref_to(const.mixin_from.path)%>"><%= const.mixin_from.full_name %></a>
+              Included from <a href="<%= klass.aref_to(const.mixin_from.path) %>"><%= const.mixin_from.full_name %></a>
             </div>
-          <%- end -%>
+          <%- end %>
           <%= const.description.strip %>
-        <%- else -%>
-        <dd class="missing-docs">(Not documented)
-        <%- end -%>
-      <%- end -%>
+        </dd>
+        <%- else %>
+        <dd class="missing-docs">(Not documented)</dd>
+        <%- end %>
+      <%- end %>
       </dl>
     </section>
-    <%- end -%>
+    <%- end %>
 
-    <%- unless attributes.empty? then -%>
-    <section class="attribute-method-details" class="method-section">
+    <%- unless attributes.empty? then %>
+    <section class="attribute-method-details method-section">
       <header>
         <h3>Attributes</h3>
       </header>
 
-      <%- attributes.each do |attrib| -%>
+      <%- attributes.each do |attrib| %>
       <div id="<%= attrib.aref %>" class="method-detail anchor-link">
         <div class="method-heading attribute-method-heading">
           <a href="#<%= attrib.aref %>" title="Link to this attribute">
@@ -100,36 +101,36 @@
         </div>
 
         <div class="method-description">
-        <%- if attrib.mixin_from then -%>
+        <%- if attrib.mixin_from then %>
           <div class="mixin-from">
-            <%= attrib.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(attrib.mixin_from.path)%>"><%= attrib.mixin_from.full_name %></a>
+            <%= 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 -%>
+        <%- end %>
+        <%- if attrib.comment then %>
         <%= attrib.description.strip %>
-        <%- else -%>
-        <p class="missing-docs">(Not documented)
-        <%- end -%>
+        <%- else %>
+        <p class="missing-docs">(Not documented)</p>
+        <%- end %>
         </div>
       </div>
-      <%- end -%>
+      <%- end %>
     </section>
-    <%- end -%>
+    <%- end %>
 
-    <%- klass.methods_by_type(section).each do |type, visibilities|
-       next if visibilities.empty?
-       visibilities.each do |visibility, methods|
-         next if methods.empty? %>
+    <%- klass.methods_by_type(section).each do |type, visibilities| %>
+    <%- next if visibilities.empty? %>
+    <%- visibilities.each do |visibility, methods| %>
+    <%- next if methods.empty? %>
      <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section anchor-link">
        <header>
          <h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
        </header>
 
-    <%- methods.each do |method| -%>
+    <%- 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 -%>
-            <%- call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
+          <%- if (call_seq = method.call_seq) then %>
+            <%- 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">
                   <span class="method-callseq">
@@ -139,49 +140,47 @@
                   </span>
                 </a>
               </div>
-            <%- end -%>
-          <%- elsif method.has_call_seq? then -%>
+            <%- end %>
+          <%- elsif method.has_call_seq? then %>
             <div class="method-heading">
               <a href="#<%= method.aref %>" title="Link to this method">
                 <span class="method-name"><%= h method.name %></span>
               </a>
             </div>
-          <%- else -%>
+          <%- else %>
             <div class="method-heading">
               <a href="#<%= method.aref %>" title="Link to this method">
                 <span class="method-name"><%= h method.name %></span>
                 <span class="method-args"><%= h method.param_seq %></span>
               </a>
             </div>
-          <%- end -%>
+          <%- end %>
         </div>
 
-        <%- if method.token_stream -%>
+        <%- if method.token_stream %>
           <div class="method-controls">
             <details class="method-source-toggle">
               <summary>Source</summary>
             </details>
           </div>
-        <%- end -%>
-
-        <%- unless method.skip_description? then -%>
-        <div class="method-description">
-          <%- if method.token_stream then -%>
           <div class="method-source-code" id="<%= method.html_name %>-source">
             <pre><%= method.markup_code %></pre>
           </div>
-          <%- end -%>
-          <%- if method.mixin_from then -%>
+        <%- end %>
+
+        <%- unless method.skip_description? then %>
+        <div class="method-description">
+          <%- if method.mixin_from then %>
             <div class="mixin-from">
-              <%= method.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(method.mixin_from.path)%>"><%= method.mixin_from.full_name %></a>
+              <%= 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 -%>
+          <%- end %>
+          <%- if method.comment then %>
           <%= method.description.strip %>
-          <%- else -%>
-          <p class="missing-docs">(Not documented)
-          <%- end -%>
-          <%- if method.calls_super then -%>
+          <%- else %>
+          <p class="missing-docs">(Not documented)</p>
+          <%- end %>
+          <%- if method.calls_super then %>
             <div class="method-calls-super">
               Calls superclass method
               <%=
@@ -189,11 +188,11 @@
                   method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
               %>
             </div>
-          <%- end -%>
+          <%- end %>
         </div>
-        <%- end -%>
+        <%- end %>
 
-        <%- unless method.aliases.empty? then -%>
+        <%- unless method.aliases.empty? then %>
         <div class="aliases">
           Also aliased as: <%= method.aliases.map do |aka|
             if aka.parent then # HACK lib/rexml/encodings
@@ -203,19 +202,20 @@
             end
           end.join ", " %>
         </div>
-        <%- end -%>
+        <%- end %>
 
-        <%- if method.is_alias_for then -%>
+        <%- if method.is_alias_for then %>
         <div class="aliases">
           Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
         </div>
-        <%- end -%>
+        <%- end %>
       </div>
 
-    <%- end -%>
+    <%- end %>
     </section>
-  <%- end
-     end %>
+  <%- end %>
+  <%- end %>
   </section>
-<%- end -%>
+<%- end %>
 </main>
+</body>

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

@@ -17,7 +17,8 @@
 <main role="main">
 <%- if @main_page %>
   <%= @main_page.description %>
-<%- else -%>
-  <p>This is the API documentation for <%= h @title %>.
-<%- end -%>
+<%- else %>
+  <p>This is the API documentation for <%= h @title %>.</p>
+<%- end %>
 </main>
+</body>

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

@@ -13,6 +13,7 @@
   <%= render '_footer.rhtml' %>
 </nav>
 
-<main role="main" aria-label="Page <%=h file.full_name%>">
+<main role="main" aria-label="Page <%= h file.full_name %>">
 <%= file.description %>
 </main>
+</body>

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

@@ -16,5 +16,6 @@
 <main role="main">
   <h1>Not Found</h1>
 
-  <p><%= message %>
+  <p><%= message %></p>
 </main>
+</body>

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

@@ -20,46 +20,46 @@
   <h1>Local RDoc Documentation</h1>
 
   <p>Here you can browse local documentation from the ruby standard library and
-  your installed gems.
+  your installed gems.</p>
 
-<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } -%>
-<%- unless extra_dirs.empty? -%>
+<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } %>
+<%- unless extra_dirs.empty? %>
   <h2>Extra Documentation Directories</h2>
 
   <p>The following additional documentation directories are available:</p>
 
   <ol>
-  <%- extra_dirs.each do |name, href, exists, _, path| -%>
+  <%- extra_dirs.each do |name, href, exists, _, path| %>
     <li>
-    <%- if exists -%>
+    <%- if exists %>
       <a href="<%= href %>"><%= h name %></a> (<%= h path %>)
-    <%- else -%>
+    <%- else %>
       <%= h name %> (<%= h path %>; <i>not available</i>)
-    <%- end -%>
+    <%- end %>
     </li>
-  <%- end -%>
+  <%- end %>
   </ol>
-<%- end -%>
+<%- end %>
 
-<%- gems = installed.select { |_, _, _, type,| type == :gem } -%>
-<%- missing = gems.reject { |_, _, exists,| exists } -%>
-<%- unless missing.empty? then -%>
+<%- gems = installed.select { |_, _, _, type,| type == :gem } %>
+<%- missing = gems.reject { |_, _, exists,| exists } %>
+<%- unless missing.empty? %>
   <h2>Missing Gem Documentation</h2>
 
   <p>You are missing documentation for some of your installed gems.
   You can install missing documentation for gems by running
   <kbd>gem rdoc --all</kbd>.  After installing the missing documentation you
   only need to reload this page.  The newly created documentation will
-  automatically appear.
+  automatically appear.</p>
 
   <p>You can also install documentation for a specific gem by running one of
-  the following commands.
+  the following commands.</p>
 
   <ul>
-  <%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq -%>
-  <%- names.each do |name| -%>
-    <li><kbd>gem rdoc <%=h name %></kbd>
-  <%- end -%>
+  <%- missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq.each do |name| %>
+    <li><kbd>gem rdoc <%= h name %></kbd></li>
+  <%- end %>
   </ul>
-<%- end -%>
+<%- end %>
 </main>
+</body>

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

@@ -13,11 +13,11 @@
 <main role="main">
 <h1 class="class"><%= h @title %></h1>
 
-<%- simple_files = @files.select { |f| f.text? } -%>
-<%- unless simple_files.empty? then -%>
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- unless simple_files.empty? then %>
 <h2 id="pages">Pages</h2>
 <ul>
-<%- simple_files.sort.each do |file| -%>
+<%- simple_files.sort.each do |file| %>
   <li class="file">
     <a href="<%= h file.path %>"><%= h file.page_name %></a>
 <%
@@ -25,19 +25,19 @@
    table = file.parse(file.comment).table_of_contents
    unless table.empty? then %>
     <ul>
-<%- table.each do |heading| -%>
-      <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
-<%-   end -%>
+    <%- table.each do |heading| %>
+      <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a></li>
+    <%- end %>
     </ul>
-<%- end -%>
+<%- end %>
   </li>
-  <%- end -%>
+  <%- end %>
 </ul>
-<%- end -%>
+<%- end %>
 
 <h2 id="classes">Classes and Modules</h2>
 <ul>
-<%- @modsort.each do |klass| -%>
+<%- @modsort.each do |klass| %>
   <li class="<%= klass.type %>">
     <a href="<%= klass.path %>"><%= klass.full_name %></a>
 <%- table = []
@@ -46,14 +46,14 @@
 
    unless table.empty? then %>
     <ul>
-<%- table.each do |item| -%>
-<%-   label = item.respond_to?(:label) ? item.label(klass) : item.aref -%>
-      <li><a href="<%= klass.path %>#<%= label %>"><%= item.plain_html %></a>
-<%- end -%>
+<%- table.each do |item| %>
+  <%- label = item.respond_to?(:label) ? item.label(klass) : item.aref %>
+      <li><a href="<%= klass.path %>#<%= label %>"><%= item.plain_html %></a></li>
+<%- end %>
     </ul>
-<%- end -%>
+<%- end %>
   </li>
-<%- end -%>
+<%- end %>
 </ul>
 
 <h2 id="methods">Methods</h2>
@@ -65,6 +65,8 @@
     <a href="<%= method.path %>"><%= h method.pretty_name %></a>
     &mdash;
     <span class="container"><%= method.parent.full_name %></span>
-<%- end -%>
+  </li>
+<%- end %>
 </ul>
 </main>
+</body>

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

@@ -29,7 +29,7 @@ Searcher.prototype = new function() {
 
       var results =
         performSearch(_this.data, regexps, queries, highlighters, state);
-      var hasMore = (state.limit > 0 && state.pass < 4);
+      var hasMore = (state.limit > 0 && state.pass < 6);
 
       triggerResults.call(_this, results, !hasMore);
       if (hasMore) {
@@ -57,10 +57,14 @@ Searcher.prototype = new function() {
   }
 
   function buildRegexps(queries) {
+    // A small minority of older browsers don't have RegExp.escape
+    // but it's not worth including a complex polyfill.
+    var escape = RegExp.escape || function(s) { return s };
+
     return queries.map(function(query) {
       var pattern = [];
       for (var i = 0; i < query.length; i++) {
-        var char = RegExp.escape(query[i]);
+        var char = escape(query[i]);
         pattern.push('([' + char + '])([^' + char + ']*?)');
       }
       return new RegExp(pattern.join(''), 'i');
@@ -85,6 +89,30 @@ Searcher.prototype = new function() {
 
   /*  ----- Mathchers ------  */
 
+  /*
+   * This record matches if both the index and longIndex exactly equal queries[0]
+   * and the record matches all of the regexps. This ensures top-level exact matches
+   * like "String" are prioritized over nested classes like "Gem::Module::String".
+   */
+  function matchPassExact(index, longIndex, queries) {
+    return index == queries[0] && longIndex == queries[0];
+  }
+
+  /*
+   * This record matches if the index without "()" exactly equals queries[0].
+   * This prioritizes methods like "attribute()" when searching for "attribute".
+   */
+  function matchPassExactMethod(index, longIndex, queries, regexps) {
+    var indexWithoutParens = index.replace(/\(\)$/, '');
+    if (indexWithoutParens != queries[0]) return false;
+    if (index === indexWithoutParens) return false; // Not a method (no parens to remove)
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
   /*
    * This record matches if the index starts with queries[0] and the record
    * matches all of the regexps
@@ -192,17 +220,26 @@ Searcher.prototype = new function() {
     var togo = CHUNK_SIZE;
     var matchFunc, hltFunc;
 
-    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+    var isLowercaseQuery = queries[0] === queries[0].toLowerCase();
+
+    while (state.pass < 6 && state.limit > 0 && togo > 0) {
+      // When query is lowercase, prioritize methods over classes
       if (state.pass == 0) {
-        matchFunc = matchPassBeginning;
+        matchFunc = isLowercaseQuery ? matchPassExactMethod : matchPassExact;
         hltFunc = highlightQuery;
       } else if (state.pass == 1) {
-        matchFunc = matchPassLongIndex;
+        matchFunc = isLowercaseQuery ? matchPassExact : matchPassExactMethod;
         hltFunc = highlightQuery;
       } else if (state.pass == 2) {
-        matchFunc = matchPassContains;
+        matchFunc = matchPassBeginning;
         hltFunc = highlightQuery;
       } else if (state.pass == 3) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 4) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 5) {
         matchFunc = matchPassRegexp;
         hltFunc = highlightRegexp;
       }

data/lib/rdoc/generator.rb

@@ -43,6 +43,7 @@ module RDoc::Generator
 
   autoload :Markup,   "#{__dir__}/generator/markup"
 
+  autoload :Aliki,     "#{__dir__}/generator/aliki"
   autoload :Darkfish,  "#{__dir__}/generator/darkfish"
   autoload :JsonIndex, "#{__dir__}/generator/json_index"
   autoload :RI,        "#{__dir__}/generator/ri"