rdoc 6.14.2 → 6.16.1

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

@@ -0,0 +1,56 @@
+<header class="top-navbar">
+  <a href="<%= rel_prefix %>/index.html" class="navbar-brand">
+    <%= h @options.title %>
+  </a>
+
+  <!-- Desktop search bar -->
+  <div class="navbar-search navbar-search-desktop" role="search">
+    <form action="#" method="get" accept-charset="utf-8">
+      <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">
+      <ul id="search-results" aria-label="Search Results"
+          aria-busy="false" aria-expanded="false"
+          aria-atomic="false" class="initially-hidden"></ul>
+    </form>
+  </div>
+
+  <!-- Mobile search icon button -->
+  <button id="search-toggle" class="navbar-search-mobile" aria-label="Open search" type="button">
+    <span aria-hidden="true">🔍</span>
+  </button>
+
+  <!-- Theme toggle button -->
+  <button id="theme-toggle" class="theme-toggle" aria-label="Switch to dark mode" type="button">
+    <span class="theme-toggle-icon" aria-hidden="true">🌙</span>
+  </button>
+</header>
+
+<!-- Search Modal (Mobile) -->
+<div id="search-modal" class="search-modal" hidden aria-modal="true" role="dialog" aria-label="Search">
+  <div class="search-modal-backdrop"></div>
+  <div class="search-modal-content">
+    <div class="search-modal-header">
+      <form class="search-modal-form" action="#" method="get" accept-charset="utf-8">
+        <span class="search-modal-icon" aria-hidden="true">🔍</span>
+        <input id="search-field-mobile" role="combobox" aria-label="Search"
+               aria-autocomplete="list" aria-controls="search-results-mobile"
+               type="text" name="search" placeholder="Search documentation"
+               spellcheck="false" autocomplete="off">
+        <button type="button" class="search-modal-close" aria-label="Close search" id="search-modal-close">
+          <span aria-hidden="true">esc</span>
+        </button>
+      </form>
+    </div>
+    <div class="search-modal-body">
+      <ul id="search-results-mobile" aria-label="Search Results"
+          aria-busy="false" aria-expanded="false"
+          aria-atomic="false" class="search-modal-results initially-hidden"></ul>
+      <div class="search-modal-empty">
+        <p>No recent searches</p>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,6 @@
+<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? %>
+<div id="parent-class-section" class="nav-section">
+  <h3>Ancestors</h3>
+  <%= generate_ancestor_list(ancestors, klass) %>
+</div>
+<%- end %>

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

@@ -0,0 +1,5 @@
+<div id="classindex-section" class="nav-section">
+  <h3>Class and Module Index</h3>
+
+  <%= generate_class_index_content(@classes, rel_prefix) %>
+</div>

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

@@ -0,0 +1,15 @@
+<%- unless klass.extends.empty? then %>
+<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 %>
+  <%- end %>
+  </ul>
+</div>
+<%- end %>

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

@@ -0,0 +1,15 @@
+<%- unless klass.includes.empty? then %>
+<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 %>
+  <%- end %>
+  </ul>
+</div>
+<%- end %>

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

@@ -0,0 +1,16 @@
+<div id="home-section" class="nav-section">
+  <h3>Documentation</h3>
+
+  <ul>
+  <%- installed.each do |name, href, exists, type, _| %>
+    <%- next if type == :extra %>
+    <li class="folder">
+    <%- if exists then %>
+      <a href="<%= href %>"><%= h name %></a>
+    <%- else %>
+      <%= h name %>
+    <%- end %>
+    </li>
+  <%- end %>
+  </ul>
+</div>

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

@@ -0,0 +1,21 @@
+<% if (class_methods = klass.class_method_list.sort).any? %>
+  <div class="nav-section">
+    <h3>Class Methods</h3>
+    <ul class="link-list" role="directory">
+      <%- class_methods.each do |meth| %>
+      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
+      <%- end %>
+    </ul>
+  </div>
+<% end %>
+
+<% if (instance_methods = klass.instance_methods.sort).any? %>
+  <div class="nav-section">
+    <h3>Instance Methods</h3>
+    <ul class="link-list" role="directory">
+      <%- instance_methods.each do |meth| %>
+      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
+      <%- end %>
+    </ul>
+  </div>
+<% end %>

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

@@ -0,0 +1,37 @@
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- if defined?(current) && current.respond_to?(:page_name) %>
+  <%- 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">
+    <%- grouped_files = simple_files.group_by { |f| f.full_name[%r{\A[^/]+(?=/)}] || f.page_name } %>
+    <%- grouped_files.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 <%= dir == n ? ' open' : '' %>>
+          <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 %>

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

@@ -0,0 +1,15 @@
+<div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-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 (/) for a class, method, ..." spellcheck="false"
+             autocomplete="off"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>

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

@@ -0,0 +1,11 @@
+<%- unless klass.sections.length == 1 then %>
+<div id="sections-section" class="nav-section">
+  <h3>Sections</h3>
+
+  <ul class="link-list" role="directory">
+    <%- klass.sort_sections.each do |section| %>
+      <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+    <%- end %>
+  </ul>
+</div>
+<%- end %>

data/lib/rdoc/generator/template/aliki/_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/aliki/class.rhtml

@@ -0,0 +1,219 @@
+<body role="document" class="<%= klass.type %> has-toc">
+<%= render '_header.rhtml' %>
+<%= render '_sidebar_toggle.rhtml' %>
+
+<nav id="navigation" role="navigation">
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_sections.rhtml' %>
+  <%= render '_sidebar_ancestors.rhtml' %>
+  <%= render '_sidebar_includes.rhtml' %>
+  <%= render '_sidebar_extends.rhtml' %>
+  <%= render '_sidebar_methods.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+</nav>
+
+<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>::</span>
+        <% end %>
+      </li>
+      <% end %>
+    </ol>
+  <% end %>
+
+  <h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
+    <%= klass.type %> <%= klass.full_name %>
+  </h1>
+
+  <section class="description">
+    <%= klass.description %>
+  </section>
+
+  <%- klass.each_section do |section, constants, attributes| %>
+  <section id="<%= section.aref %>" class="documentation-section anchor-link">
+    <%- if section.title then %>
+    <header class="documentation-section-title">
+      <h2>
+        <a href="#<%= section.aref %>"><%= section.title %></a>
+      </h2>
+    </header>
+    <%- end %>
+
+    <%- if section.comment then %>
+    <div>
+      <%= section.description %>
+    </div>
+    <%- end %>
+
+    <%- unless constants.empty? then %>
+    <section class="constants-list">
+      <header>
+        <h3 id="constants"><a href="#constants">Constants</a></h3>
+      </header>
+      <dl>
+      <%- constants.each do |const| %>
+        <dt id="<%= const.name %>"><%= const.name %></dt>
+        <%- if const.comment then %>
+        <dd>
+          <%- 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>
+            </div>
+          <%- end %>
+          <%= const.description.strip %>
+        </dd>
+        <%- else %>
+        <dd class="missing-docs">(Not documented)</dd>
+        <%- end %>
+      <%- end %>
+      </dl>
+    </section>
+    <%- end %>
+
+    <%- unless attributes.empty? then %>
+    <section class="attribute-method-details method-section">
+      <header>
+        <h3 id="attributes"><a href="#attributes">Attributes</a></h3>
+      </header>
+
+      <%- 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">
+            <span class="method-name"><%= h attrib.name %></span>
+            <span class="attribute-access-type">[<%= attrib.rw %>]</span>
+          </a>
+        </div>
+
+        <div class="method-description">
+        <%- 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>
+          </div>
+        <%- end %>
+        <%- if attrib.comment then %>
+        <%= attrib.description.strip %>
+        <%- else %>
+        <p class="missing-docs">(Not documented)</p>
+        <%- end %>
+        </div>
+      </div>
+      <%- end %>
+    </section>
+    <%- 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 anchor-link">
+       <header>
+         <h3 id="<%= visibility %>-<%= type %>-methods"><a href="#<%= visibility %>-<%= type %>-methods"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</a></h3>
+       </header>
+
+    <%- 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| %>
+              <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? 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 %>
+            <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>
+
+        <%- 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 class="<%= method.source_language %>" data-language="<%= method.source_language %>"><%= method.markup_code %></pre>
+          </div>
+          <%- end %>
+          <%- 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>
+            </div>
+          <%- end %>
+          <%- if method.comment then %>
+          <%= method.description.strip %>
+          <%- else %>
+          <p class="missing-docs">(Not documented)</p>
+          <%- end %>
+          <%- if method.calls_super then %>
+            <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
+              %>
+            </div>
+          <%- end %>
+        </div>
+        <%- end %>
+
+        <%- unless method.aliases.empty? then %>
+        <div class="aliases">
+          Also aliased as: <%= method.aliases.map do |aka|
+            if aka.parent then # HACK lib/rexml/encodings
+              %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
+            else
+              h aka.name
+            end
+          end.join ", " %>
+        </div>
+        <%- end %>
+
+        <%- 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 %>
+      </div>
+
+    <%- end %>
+    </section>
+  <%- end
+     end %>
+  </section>
+<%- end %>
+</main>
+
+<%= render '_aside_toc.rhtml' %>
+
+<%= render '_footer.rhtml' %>
+</body>