rdoc 6.3.4.1 → 8.0.0

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

@@ -1,12 +1,32 @@
 <%- simple_files = @files.select { |f| f.text? } %>
-<%- unless simple_files.empty? then -%>
+<%- if defined?(current) %>
+  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
+<%- end %>
+<%- unless simple_files.empty? %>
 <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>
-  <%- end -%>
+  <%- 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></li>
+      <%- next -%>
+    <%- end %>
+    <li><details<%= ' open' if dir == n %>><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></li>
+    <%- end %>
+    </ul></details></li>
+  <%- end %>
   </ul>
 </div>
-<%- end -%>
+<%- end %>

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

@@ -1,11 +1,6 @@
-<%- if klass.type == 'class' then %>
+<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? %>
 <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-
-  <%- if klass.superclass and not String === klass.superclass then -%>
-  <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
-  <%- else -%>
-  <p class="link"><%= klass.superclass %>
-  <%- end -%>
+  <h3>Ancestors</h3>
+  <%= generate_ancestor_list(ancestors, klass) %>
 </div>
-<%- end -%>
+<%- end %>

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

@@ -3,7 +3,8 @@
     <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"
+             autocomplete="off"
              title="Type to search, Up and Down to navigate, Enter to load">
     </div>
 

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

@@ -1,11 +1,11 @@
-<%- unless klass.sections.length == 1 then %>
+<%- unless klass.sections.length == 1 %>
 <div id="sections-section" class="nav-section">
   <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

@@ -1,18 +1,39 @@
-<%- 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
+   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>
 
+    <%- 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 %>
+        <li>
+        <%- if table.first.nil? || table.first.level <= heading.level %>
+          <% display_link.call heading %>
+        <%- else %>
+            <details open>
+              <summary><%- display_link.call heading %></summary>
+              <ul class="link-list" role="directory">
+                <% list_siblings.call %>
+              </ul>
+            </details>
+        <%- end %>
+        </li>
+      <%- 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 -%>
+<%- end %>

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

@@ -0,0 +1,3 @@
+<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
+  <span aria-hidden="true">&#9776;</span>
+</div>

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

@@ -1,23 +1,40 @@
 <body id="top" role="document" class="<%= klass.type %>">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <%= render '_sidebar_navigation.rhtml' %>
     <%= render '_sidebar_search.rhtml' %>
   </div>
 
   <%= render '_sidebar_table_of_contents.rhtml' %>
+  <%= render '_sidebar_sections.rhtml' %>
+  <%= render '_sidebar_parent.rhtml' %>
+  <%= render '_sidebar_includes.rhtml' %>
+  <%= render '_sidebar_extends.rhtml' %>
+  <%= render '_sidebar_methods.rhtml' %>
 
-  <div id="class-metadata">
-    <%= render '_sidebar_sections.rhtml' %>
-    <%= render '_sidebar_parent.rhtml' %>
-    <%= render '_sidebar_includes.rhtml' %>
-    <%= render '_sidebar_extends.rhtml' %>
-    <%= render '_sidebar_methods.rhtml' %>
-  </div>
+  <%= render '_footer.rhtml' %>
 </nav>
 
-<main role="main" aria-labelledby="<%=h klass.aref %>">
-  <h1 id="<%=h klass.aref %>" class="<%= klass.type %>">
+<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 navigation" class="breadcrumb">
+      <% breadcrumb.each do |namespace| %>
+      <li>
+        <% if namespace[:self] %>
+        <span><%= namespace[:name] %></span>
+        <% else %>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span class="separator">::</span>
+        <% end %>
+      </li>
+      <% end %>
+    </ol>
+  <% end %>
+
+  <span id="<%= h klass.legacy_aref %>" class="legacy-anchor"></span>
+  <h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
     <%= klass.type %> <%= klass.full_name %>
   </h1>
 
@@ -25,9 +42,10 @@
     <%= klass.description %>
   </section>
 
-  <%- klass.each_section do |section, constants, attributes| -%>
-  <section id="<%= section.aref %>" class="documentation-section">
-    <%- if section.title then -%>
+  <%- 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 %>
     <header class="documentation-section-title">
       <h2>
         <%= section.title %>
@@ -36,115 +54,144 @@
         <a href="#top">&uarr; top</a>
       </span>
     </header>
-    <%- end -%>
+    <%- end %>
 
-    <%- if section.comment then -%>
+    <%- if section.comment %>
     <div>
       <%= section.description %>
     </div>
-    <%- end -%>
+    <%- end %>
 
-    <%- unless constants.empty? then -%>
+    <%- unless constants.empty? %>
     <section class="constants-list">
       <header>
         <h3>Constants</h3>
       </header>
       <dl>
-      <%- constants.each do |const| -%>
-        <dt id="<%= const.name %>"><%= const.name %>
-        <%- if const.comment then -%>
-        <dd><%= const.description.strip %>
-        <%- else -%>
-        <dd class="missing-docs">(Not documented)
-        <%- end -%>
-      <%- end -%>
+      <%- constants.each do |const| %>
+        <dt id="<%= const.name %>"><%= const.name %></dt>
+        <%- if const.comment %>
+        <dd>
+          <%- 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>
+          <%- end %>
+          <%= const.description.strip %>
+        </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? %>
+    <section class="attribute-method-details method-section">
       <header>
         <h3>Attributes</h3>
       </header>
 
-      <%- attributes.each do |attrib| -%>
-      <div id="<%= attrib.aref %>" class="method-detail">
+      <%- attributes.each do |attrib| %>
+      <div id="<%= attrib.aref %>" class="method-detail anchor-link">
         <div class="method-heading attribute-method-heading">
-          <span class="method-name"><%= h attrib.name %></span><span
-            class="attribute-access-type">[<%= attrib.rw %>]</span>
+          <a href="#<%= attrib.aref %>" title="Link to this attribute">
+            <span class="method-name"><%= h attrib.name %></span>
+            <span class="attribute-access-type">[<%= attrib.rw %>]</span>
+          </a>
         </div>
 
         <div class="method-description">
-        <%- if attrib.comment 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 %>
         <%= 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? %>
-     <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section">
+    <%- 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| -%>
-      <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>
-          <%- end -%>
+    <%- 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) %>
+            <%- 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">
+                    <%= h(call_seq.strip.
+                        gsub( /^\w+\./m, '')).
+                        gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+                  </span>
+                </a>
+              </div>
+            <%- end %>
+          <%- 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>
+              </a>
+            </div>
+          <%- 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 %>
         </div>
-        <%- end -%>
 
+        <%- if method.token_stream %>
+          <div class="method-controls">
+            <details class="method-source-toggle">
+              <summary>Source</summary>
+            </details>
+          </div>
+          <div class="method-source-code" id="<%= method.html_name %>-source">
+            <pre><%= method.markup_code %></pre>
+          </div>
+        <%- end %>
+
+        <%- unless method.skip_description? %>
         <div class="method-description">
-          <%- if method.comment 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 %>
           <%= 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 %>
             <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 -%>
-
-          <%- if method.token_stream then -%>
-          <div class="method-source-code" id="<%= method.html_name %>-source">
-            <pre><%= method.markup_code %></pre>
-          </div>
-          <%- end -%>
+          <%- 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
@@ -154,19 +201,20 @@
             end
           end.join ", " %>
         </div>
-        <%- end -%>
+        <%- 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>
-        <%- end -%>
+        <%- end %>
       </div>
 
-    <%- end -%>
+    <%- end %>
     </section>
-  <%- end
-     end %>
+  <%- end %>
+  <%- end %>
   </section>
-<%- end -%>
+<%- end %>
 </main>
+</body>