rdoc 6.3.4.1 → 8.0.0

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

@@ -0,0 +1,163 @@
+<meta charset="<%= @options.charset %>">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+
+<title><%= h @title %></title>
+
+<%- if defined?(klass) %>
+  <meta
+    name="keywords"
+    content="ruby,<%= h "#{klass.type},#{klass.full_name}" %>"
+  >
+  <%- if klass.comment.empty? %>
+    <meta
+      name="description"
+      content="Documentation for the <%= h "#{klass.full_name} #{klass.type}" %>"
+    >
+  <%- else %>
+    <meta
+      name="description"
+      content="<%= h "#{klass.type} #{klass.full_name}: #{excerpt(klass.comment)}" %>"
+    >
+  <%- end %>
+<%- elsif defined?(file) %>
+  <meta name="keywords" content="ruby,documentation,<%= h file.page_name %>">
+  <meta
+    name="description"
+    content="<%= h "#{file.page_name}: #{excerpt(file.comment)}" %>"
+  >
+<%- elsif @title %>
+  <meta name="keywords" content="ruby,documentation,<%= h @title %>">
+  <%- if @options.main_page and
+      main_page = @files.find { |f| f.full_name == @options.main_page } %>
+    <meta
+      name="description"
+      content="<%= h "#{@title}: #{excerpt(main_page.comment)}" %>"
+    >
+  <%- else %>
+    <meta name="description" content="Documentation for <%= h @title %>">
+  <%- end %>
+<%- end %>
+
+<%- if canonical_url = @options.canonical_root %>
+  <% canonical_url = current.canonical_url if defined?(current) %>
+  <link rel="canonical" href="<%= canonical_url %>">
+<%- end %>
+
+<!-- Open Graph / Facebook -->
+<meta property="og:type" content="website">
+<meta property="og:title" content="<%= h @title %>">
+
+<%- if defined?(klass) %>
+  <%- if klass.comment.empty? %>
+    <meta
+      property="og:description"
+      content="Documentation for <%= h klass.full_name %> <%= h klass.type %> - API reference and code examples"
+    >
+  <%- else %>
+    <meta property="og:description" content="<%= h excerpt(klass.comment) %>">
+  <%- end %>
+<%- elsif defined?(file) %>
+  <%- if file.comment.empty? %>
+    <meta
+      property="og:description"
+      content="<%= h file.page_name %> - <%= h @title %> documentation"
+    >
+  <%- else %>
+    <meta property="og:description" content="<%= h excerpt(file.comment) %>">
+  <%- end %>
+<%- else %>
+  <meta
+    property="og:description"
+    content="API documentation for <%= h @title %> - Browse classes, modules, and methods"
+  >
+<%- end %>
+
+<%- if canonical_url = @options.canonical_root %>
+  <% canonical_url = current.canonical_url if defined?(current) %>
+  <meta property="og:url" content="<%= canonical_url %>">
+<%- end %>
+
+<!-- Twitter -->
+<meta name="twitter:card" content="summary">
+<meta name="twitter:title" content="<%= h @title %>">
+
+<%- if defined?(klass) %>
+  <%- if klass.comment.empty? %>
+    <meta
+      name="twitter:description"
+      content="Documentation for <%= h klass.full_name %> <%= h klass.type %> - API reference and code examples"
+    >
+  <%- else %>
+    <meta name="twitter:description" content="<%= h excerpt(klass.comment) %>">
+  <%- end %>
+<%- elsif defined?(file) %>
+  <%- if file.comment.empty? %>
+    <meta
+      name="twitter:description"
+      content="<%= h file.page_name %> - <%= h @title %> documentation"
+    >
+  <%- else %>
+    <meta name="twitter:description" content="<%= h excerpt(file.comment) %>">
+  <%- end %>
+<%- else %>
+  <meta
+    name="twitter:description"
+    content="API documentation for <%= h @title %> - Browse classes, modules, and methods"
+  >
+<%- end %>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= h rel_prefix %>/";
+</script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/theme-toggle.js?v=<%= h RDoc::VERSION %>"
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/search_navigation.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/search_data.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/search_ranker.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/search_controller.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/c_highlighter.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/bash_highlighter.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<script
+  src="<%= h asset_rel_prefix %>/js/aliki.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
+<link
+  href="<%= h asset_rel_prefix %>/css/rdoc.css?v=<%= h RDoc::VERSION %>"
+  rel="stylesheet"
+>
+
+<%- @options.template_stylesheets.each do |stylesheet| %>
+  <link
+    href="<%= h asset_rel_prefix %>/<%= h File.basename stylesheet %>?v=<%= h RDoc::VERSION %>"
+    rel="stylesheet"
+  >
+<%- end %>

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-desktop"
+             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-desktop" aria-label="Search Results"
+          aria-busy="false" aria-expanded="false"
+          aria-atomic="false" class="initially-hidden search-results"></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-results 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/_icons.rhtml

@@ -0,0 +1,208 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
+  <!-- Chevron (right arrow) - used for expand/collapse -->
+  <symbol
+    id="icon-chevron"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <polyline points="9 18 15 12 9 6"></polyline>
+  </symbol>
+
+  <!-- File/Document - Pages section -->
+  <symbol
+    id="icon-file"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <path
+      d="M14.5 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7.5L14.5 2z"
+    ></path>
+
+    <polyline points="14 2 14 8 20 8"></polyline>
+  </symbol>
+
+  <!-- Layers/Stack - Classes and Modules section -->
+  <symbol
+    id="icon-layers"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <polygon points="12 2 2 7 12 12 22 7 12 2"></polygon>
+    <polyline points="2 17 12 22 22 17"></polyline>
+    <polyline points="2 12 12 17 22 12"></polyline>
+  </symbol>
+
+  <!-- Curly braces with C - Class Methods section -->
+  <symbol
+    id="icon-class-methods"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <path d="M6 3C3.5 3 2 4.5 2 7v3c0 1.5-1 2-1 2s1 .5 1 2v5c0 2.5 1.5 4 4 4"></path>
+    <path d="M18 3c2.5 0 4 1.5 4 4v3c0 1.5 1 2 1 2s-1 .5-1 2v5c0 2.5-1.5 4-4 4"></path>
+
+    <text
+      x="12"
+      y="17"
+      text-anchor="middle"
+      font-size="13"
+      font-weight="bold"
+      fill="currentColor"
+      stroke="none"
+    >
+      C
+    </text>
+  </symbol>
+
+  <!-- Curly braces with I - Instance Methods section -->
+  <symbol
+    id="icon-instance-methods"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <path d="M6 3C3.5 3 2 4.5 2 7v3c0 1.5-1 2-1 2s1 .5 1 2v5c0 2.5 1.5 4 4 4"></path>
+    <path d="M18 3c2.5 0 4 1.5 4 4v3c0 1.5 1 2 1 2s-1 .5-1 2v5c0 2.5-1.5 4-4 4"></path>
+
+    <text
+      x="12"
+      y="17"
+      text-anchor="middle"
+      font-size="13"
+      font-weight="bold"
+      fill="currentColor"
+      stroke="none"
+    >
+      I
+    </text>
+  </symbol>
+
+  <!-- Double chevrons up - Ancestors section -->
+  <symbol
+    id="icon-ancestors"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <polyline points="17 11 12 6 7 11"></polyline>
+    <polyline points="17 18 12 13 7 18"></polyline>
+  </symbol>
+
+  <!-- User with plus - Included Modules section -->
+  <symbol
+    id="icon-includes"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <path d="M16 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"></path>
+    <circle cx="8.5" cy="7" r="4"></circle>
+
+    <line
+      x1="20"
+      y1="8"
+      x2="20"
+      y2="14"
+    ></line>
+
+    <line
+      x1="23"
+      y1="11"
+      x2="17"
+      y2="11"
+    ></line>
+  </symbol>
+
+  <!-- User with check - Extended Modules section -->
+  <symbol
+    id="icon-extends"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <path d="M16 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"></path>
+    <circle cx="8.5" cy="7" r="4"></circle>
+    <polyline points="17 11 19 13 23 9"></polyline>
+  </symbol>
+
+  <!-- List - Sections section -->
+  <symbol
+    id="icon-list"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    stroke-width="2"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+  >
+    <line
+      x1="8"
+      y1="6"
+      x2="21"
+      y2="6"
+    ></line>
+
+    <line
+      x1="8"
+      y1="12"
+      x2="21"
+      y2="12"
+    ></line>
+
+    <line
+      x1="8"
+      y1="18"
+      x2="21"
+      y2="18"
+    ></line>
+
+    <line
+      x1="3"
+      y1="6"
+      x2="3.01"
+      y2="6"
+    ></line>
+
+    <line
+      x1="3"
+      y1="12"
+      x2="3.01"
+      y2="12"
+    ></line>
+
+    <line
+      x1="3"
+      y1="18"
+      x2="3.01"
+      y2="18"
+    ></line>
+  </symbol>
+</svg>

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

@@ -0,0 +1,16 @@
+<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? %>
+<div id="parent-class-section" class="nav-section">
+  <details class="nav-section-collapsible" open>
+    <summary class="nav-section-header">
+      <span class="nav-section-icon">
+        <svg><use href="#icon-ancestors"></use></svg>
+      </span>
+      <span class="nav-section-title">Ancestors</span>
+      <span class="nav-section-chevron">
+        <svg><use href="#icon-chevron"></use></svg>
+      </span>
+    </summary>
+    <%= generate_ancestor_list(ancestors, klass) %>
+  </details>
+</div>
+<%- end %>

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

@@ -0,0 +1,15 @@
+<div id="classindex-section" class="nav-section">
+  <details class="nav-section-collapsible" open>
+    <summary class="nav-section-header">
+      <span class="nav-section-icon">
+        <svg><use href="#icon-layers"></use></svg>
+      </span>
+      <span class="nav-section-title">Classes and Modules</span>
+      <span class="nav-section-chevron">
+        <svg><use href="#icon-chevron"></use></svg>
+      </span>
+    </summary>
+
+    <%= generate_class_index_content(@classes, rel_prefix) %>
+  </details>
+</div>

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

@@ -0,0 +1,27 @@
+<%- unless klass.extends.empty? %>
+<div id="extends-section" class="nav-section">
+  <details class="nav-section-collapsible" open>
+    <summary class="nav-section-header">
+      <span class="nav-section-icon">
+        <svg><use href="#icon-extends"></use></svg>
+      </span>
+      <span class="nav-section-title">Extended With Modules</span>
+      <span class="nav-section-chevron">
+        <svg><use href="#icon-chevron"></use></svg>
+      </span>
+    </summary>
+
+    <ul class="nav-list">
+      <%- klass.extends.each do |ext| %>
+      <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>
+  </details>
+</div>
+<%- end %>

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

@@ -0,0 +1,27 @@
+<%- unless klass.includes.empty? %>
+<div id="includes-section" class="nav-section">
+  <details class="nav-section-collapsible" open>
+    <summary class="nav-section-header">
+      <span class="nav-section-icon">
+        <svg><use href="#icon-includes"></use></svg>
+      </span>
+      <span class="nav-section-title">Included Modules</span>
+      <span class="nav-section-chevron">
+        <svg><use href="#icon-chevron"></use></svg>
+      </span>
+    </summary>
+
+    <ul class="nav-list">
+    <%- klass.includes.each do |inc| %>
+      <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>
+  </details>
+</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 %>
+      <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,41 @@
+<% if (class_methods = klass.class_method_list.sort).any? %>
+  <div class="nav-section">
+    <details class="nav-section-collapsible" open>
+      <summary class="nav-section-header">
+        <span class="nav-section-icon">
+          <svg><use href="#icon-class-methods"></use></svg>
+        </span>
+        <span class="nav-section-title">Class Methods</span>
+        <span class="nav-section-chevron">
+          <svg><use href="#icon-chevron"></use></svg>
+        </span>
+      </summary>
+      <ul class="nav-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>
+    </details>
+  </div>
+<% end %>
+
+<% if (instance_methods = klass.instance_methods.sort).any? %>
+  <div class="nav-section">
+    <details class="nav-section-collapsible" open>
+      <summary class="nav-section-header">
+        <span class="nav-section-icon">
+          <svg><use href="#icon-instance-methods"></use></svg>
+        </span>
+        <span class="nav-section-title">Instance Methods</span>
+        <span class="nav-section-chevron">
+          <svg><use href="#icon-chevron"></use></svg>
+        </span>
+      </summary>
+      <ul class="nav-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>
+    </details>
+  </div>
+<% end %>

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

@@ -0,0 +1,67 @@
+<%- simple_files = @files.select { |f| f.text? && f.full_name != @options.main_page } %>
+
+<%- if defined?(current) && current.respond_to?(:page_name) %>
+  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
+<%- end %>
+
+<%- unless simple_files.empty? %>
+  <div id="fileindex-section" class="nav-section">
+    <details class="nav-section-collapsible" <%= 'open' unless @inside_class_file %>>
+      <summary class="nav-section-header">
+        <span class="nav-section-icon">
+          <svg>
+            <use href="#icon-file"></use>
+          </svg>
+        </span>
+
+        <span class="nav-section-title">Pages</span>
+
+        <span class="nav-section-chevron">
+          <svg>
+            <use href="#icon-chevron"></use>
+          </svg>
+        </span>
+      </summary>
+
+      <ul class="nav-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>
+    </details>
+  </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-desktop"
+             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-desktop" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden search-results"></ul>
+  </form>
+</div>

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

@@ -0,0 +1,21 @@
+<%- unless klass.sections.length == 1 %>
+<div id="sections-section" class="nav-section">
+  <details class="nav-section-collapsible" open>
+    <summary class="nav-section-header">
+      <span class="nav-section-icon">
+        <svg><use href="#icon-list"></use></svg>
+      </span>
+      <span class="nav-section-title">Sections</span>
+      <span class="nav-section-chevron">
+        <svg><use href="#icon-chevron"></use></svg>
+      </span>
+    </summary>
+
+    <ul class="nav-list" role="directory">
+      <%- klass.sort_sections.each do |section| %>
+        <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+      <%- end %>
+    </ul>
+  </details>
+</div>
+<%- end %>