RubyGems - rorvswild_theme_rdoc - Versions diffs - 0.1 → 0.2 - Mend

rorvswild_theme_rdoc 0.1 → 0.2

Files changed (40) hide show

data/lib/rdoc/generator/template/rorvswild/fonts/Inter-Bold.woff2 ADDED Viewed

Binary file

data/lib/rdoc/generator/template/rorvswild/fonts/Inter-Italic.woff2 ADDED Viewed

Binary file

data/lib/rdoc/generator/template/rorvswild/fonts/Inter-Regular.woff2 ADDED Viewed

Binary file

data/lib/rdoc/generator/template/rorvswild/fonts/MonaspaceNeon-Bold.woff2 ADDED Viewed

Binary file

data/lib/rdoc/generator/template/rorvswild/fonts/MonaspaceNeon-Regular.woff2 ADDED Viewed

Binary file

data/lib/rdoc/generator/template/rorvswild/index.rhtml ADDED Viewed

@@ -0,0 +1,22 @@
+<body id="top" role="document" class="file">
+  <%= render '_topbar.rhtml' %>
+  <div class="wrapper">
+    <%= render '_navigation.rhtml' %>
+    <main role="main">
+      <article>
+        <%- if @options.main_page and
+          main_page = @files.find { |f| f.full_name == @options.main_page } then %>
+          <%- current = main_page -%>
+          <%= main_page.description %>
+        <%- else -%>
+          <p>This is the API documentation for <%= h @title %>.
+        <%- end -%>
+      </article>
+      <nav class="contextual">
+      <%= render '_sidebar_table_of_contents.rhtml' if current %>
+      </nav>
+    </main>
+  </div>
+</body>

data/lib/rdoc/generator/template/rorvswild/js/darkfish.js ADDED Viewed

@@ -0,0 +1,167 @@
+/**
+ *
+ * Darkfish Page Functions
+ * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
+ *
+ * Author: Michael Granger <mgranger@laika.com>
+ *
+ */
+/* Provide console simulation for firebug-less environments */
+/*
+if (!("console" in window) || !("firebug" in console)) {
+  var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
+    "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
+  window.console = {};
+  for (var i = 0; i < names.length; ++i)
+    window.console[names[i]] = function() {};
+};
+*/
+function showSource( e ) {
+  var target = e.target;
+  while (!target.classList.contains('method-detail')) {
+    target = target.parentNode;
+  }
+  if (typeof target !== "undefined" && target !== null) {
+    target = target.querySelector('.method-source-code');
+  }
+  if (typeof target !== "undefined" && target !== null) {
+    target.classList.toggle('active-menu')
+  }
+};
+function hookSourceViews() {
+  document.querySelectorAll('.toggle-source').forEach(function (codeObject) {
+    codeObject.addEventListener('click', showSource);
+  });
+};
+function hookSearch() {
+  const searchButton = document.querySelector('button[aria-label="Search"]');
+  const searchDialog = document.getElementById('search-dialog');
+  if (searchButton && searchDialog) {
+    searchButton.addEventListener('click', function(event) {
+      event.preventDefault();
+      searchDialog.showModal();
+      searchDialog.querySelector('input[name="q"]').focus();
+    });
+  }
+  // Close dialog when clicking on the backdrop
+  searchDialog.addEventListener('click', function(event) {
+    const rect = this.getBoundingClientRect();
+    const isInDialog = (rect.top <= event.clientY && event.clientY <= rect.top + rect.height &&
+                        rect.left <= event.clientX && event.clientX <= rect.left + rect.width);
+    if (!isInDialog) {
+      this.close();
+    }
+  });
+  var input  = document.querySelector('#search-field');
+  var result = document.querySelector('#search-results');
+  result.classList.remove("initially-hidden");
+  var search_section = document.querySelector('#search-dialog');
+  search_section.classList.remove("initially-hidden");
+  var search = new Search(search_data, input, result);
+  search.renderItem = function(result) {
+    var li = document.createElement('li');
+    var html = '';
+    // TODO add relative path to <script> per-page
+    html += '<p class="search-match"><a href="' + index_rel_prefix + this.escapeHTML(result.path) + '">' + this.hlt(result.title);
+    if (result.params)
+      html += '<span class="params">' + result.params + '</span>';
+    html += '</a>';
+    if (result.namespace)
+      html += '<p class="search-namespace">' + this.hlt(result.namespace);
+    if (result.snippet)
+      html += '<div class="search-snippet">' + result.snippet + '</div>';
+    li.innerHTML = html;
+    return li;
+  }
+  search.select = function(result) {
+    window.location.href = result.firstChild.firstChild.href;
+  }
+  search.scrollIntoView = search.scrollInWindow;
+};
+function hookFocus() {
+  document.addEventListener("keydown", (event) => {
+    if (document.activeElement.tagName === 'INPUT') {
+      return;
+    }
+    if (event.key === "/") {
+      event.preventDefault();
+      document.querySelector('#search-field').focus();
+    }
+  });
+}
+function hookSidebar() {
+  var navigation = document.querySelector('#navigation');
+  var navigationToggle = document.querySelector('#navigation-toggle');
+  navigationToggle.addEventListener('click', function() {
+    navigation.hidden = !navigation.hidden;
+    navigationToggle.ariaExpanded = navigationToggle.ariaExpanded !== 'true';
+  });
+  var isSmallViewport = window.matchMedia("(max-width: 1024px)").matches;
+  if (isSmallViewport) {
+    navigation.hidden = true;
+    navigationToggle.ariaExpanded = false;
+  }
+}
+function hookScrollSpy() {
+  const anchors = document.querySelectorAll('[id]');
+  const observer = new IntersectionObserver((entries) => {
+    entries.forEach(entry => {
+      const id = entry.target.id;
+      const correspondingLi = document.querySelector(`.contextual li a[href="#${id}"]`)?.parentElement;
+      if (correspondingLi) {
+        if (entry.isIntersecting) {
+          correspondingLi.classList.add('active');
+        } else {
+          correspondingLi.classList.remove('active');
+        }
+      }
+    });
+  }, {
+    rootMargin: '-60px 0px -10% 0px',
+    threshold: 0
+  });
+  anchors.forEach(anchor => observer.observe(anchor));
+}
+function scrollToActiveLeftSidebarItem() {
+  const item = document.querySelector("#class-and-module-index .active")
+  item && item.scrollIntoView({block: "center"})
+}
+document.addEventListener('DOMContentLoaded', function() {
+  hookSourceViews();
+  hookSearch();
+  hookFocus();
+  hookSidebar();
+  hookScrollSpy();
+  scrollToActiveLeftSidebarItem();
+});

data/lib/rdoc/generator/template/rorvswild/js/search.js ADDED Viewed

@@ -0,0 +1,110 @@
+Search = function(data, input, result) {
+  this.data = data;
+  this.input = input;
+  this.result = result;
+  this.current = null;
+  this.view = this.result.parentNode;
+  this.searcher = new Searcher(data.index);
+  this.init();
+}
+Search.prototype = Object.assign({}, Navigation, new function() {
+  var suid = 1;
+  this.init = function() {
+    var _this = this;
+    var observer = function(e) {
+      switch(e.key) {
+        case 'ArrowUp':
+        case 'ArrowDown':
+          return;
+      }
+      _this.search(_this.input.value);
+    };
+    this.input.addEventListener('keyup', observer);
+    this.input.addEventListener('click', observer); // mac's clear field
+    this.searcher.ready(function(results, isLast) {
+      _this.addResults(results, isLast);
+    })
+    this.initNavigation();
+    this.setNavigationActive(false);
+  }
+  this.search = function(value, selectFirstMatch) {
+    value = value.trim().toLowerCase();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+    if (value == '') {
+      this.lastQuery = value;
+      this.result.innerHTML = '';
+      this.result.setAttribute('aria-expanded', 'false');
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.result.setAttribute('aria-busy',     'true');
+      this.result.setAttribute('aria-expanded', 'true');
+      this.firstRun = true;
+      this.searcher.find(value);
+    }
+  }
+  this.addResults = function(results, isLast) {
+    var target = this.result;
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.current = null;
+      this.result.innerHTML = '';
+    }
+    for (var i=0, l = results.length; i < l; i++) {
+      var item = this.renderItem.call(this, results[i]);
+      item.setAttribute('id', 'search-result-' + target.childElementCount);
+      target.appendChild(item);
+    };
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.current = target.firstChild;
+      this.current.classList.add('search-selected');
+    }
+    //TODO: ECMAScript
+    //if (jQuery.browser.msie) this.$element[0].className += '';
+    if (isLast) this.result.setAttribute('aria-busy', 'false');
+  }
+  this.move = function(isDown) {
+    if (!this.current) return;
+    var next = isDown ? this.current.nextElementSibling : this.current.previousElementSibling;
+    if (next) {
+      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.current = next;
+      this.input.value = next.firstChild.firstChild.text;
+      this.input.select();
+    }
+    return true;
+  }
+  this.hlt = function(html) {
+    return this.escapeHTML(html).
+      replace(/\u0001/g, '<em>').
+      replace(/\u0002/g, '</em>');
+  }
+  this.escapeHTML = function(html) {
+    return html.replace(/[&<>"`']/g, function(c) {
+      return '&#' + c.charCodeAt(0) + ';';
+    });
+  }
+});

data/lib/rdoc/generator/template/rorvswild/page.rhtml ADDED Viewed

@@ -0,0 +1,15 @@
+<body id="top" role="document" class="file">
+  <%= render '_topbar.rhtml' %>
+  <div class="wrapper">
+    <%= render '_navigation.rhtml' %>
+    <main role="main" aria-label="Page <%=h file.full_name%>">
+      <article>
+        <%= file.description %>
+      </article>
+      <nav class="contextual">
+        <%= render '_sidebar_table_of_contents.rhtml' %>
+      </nav>
+    </main>
+  </div>
+</body>

data/lib/rdoc/generator/template/rorvswild/servlet_not_found.rhtml ADDED Viewed

@@ -0,0 +1,15 @@
+<body role="document">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_footer.rhtml' %>
+</nav>
+<main role="main">
+  <h1>Not Found</h1>
+  <p><%= message %>
+</main>

data/lib/rdoc/generator/template/rorvswild/servlet_root.rhtml ADDED Viewed

@@ -0,0 +1,63 @@
+<body role="document">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" class="nav-section">
+      <h2>
+        <a href="<%= rel_prefix %>/" rel="home">Home</a>
+      </h2>
+    </div>
+  </div>
+  <%= render '_sidebar_installed.rhtml' %>
+  <%= render '_footer.rhtml' %>
+</nav>
+<main role="main">
+  <h1>Local RDoc Documentation</h1>
+  <p>Here you can browse local documentation from the ruby standard library and
+  your installed gems.
+<%- 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| -%>
+    <li>
+    <%- if exists -%>
+      <a href="<%= href %>"><%= h name %></a> (<%= h path %>)
+    <%- else -%>
+      <%= h name %> (<%= h path %>; <i>not available</i>)
+    <%- end -%>
+    </li>
+  <%- end -%>
+  </ol>
+<%- end -%>
+<%- gems = installed.select { |_, _, _, type,| type == :gem } -%>
+<%- missing = gems.reject { |_, _, exists,| exists } -%>
+<%- unless missing.empty? then -%>
+  <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.
+  <p>You can also install documentation for a specific gem by running one of
+  the following commands.
+  <ul>
+  <%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq -%>
+  <%- names.each do |name| -%>
+    <li><kbd>gem rdoc <%=h name %></kbd>
+  <%- end -%>
+  </ul>
+<%- end -%>
+</main>

data/lib/rdoc/generator/template/rorvswild/table_of_contents.rhtml ADDED Viewed

@@ -0,0 +1,63 @@
+<body id="top" class="table-of-contents">
+<nav id="navigation" role="navigation">
+  <%= render '_footer.rhtml' %>
+</nav>
+<main role="main">
+<h1 class="class"><%= h @title %></h1>
+<%- simple_files = @files.select { |f| f.text? } -%>
+<%- unless simple_files.empty? then -%>
+<h2 id="pages">Pages</h2>
+<ul>
+<%- simple_files.sort.each do |file| -%>
+  <li class="file">
+    <a href="<%= h file.path %>"><%= h file.page_name %></a>
+<%
+   # HACK table_of_contents should not exist on Document
+   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 -%>
+    </ul>
+<%- end -%>
+  </li>
+  <%- end -%>
+</ul>
+<%- end -%>
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+<%- @modsort.each do |klass| -%>
+  <li class="<%= klass.type %>">
+    <a href="<%= klass.path %>"><%= klass.full_name %></a>
+<%- table = []
+   table.concat klass.parse(klass.comment_location).table_of_contents
+   table.concat klass.section_contents
+   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 -%>
+    </ul>
+<%- end -%>
+  </li>
+<%- end -%>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+<%- @store.all_classes_and_modules.flat_map do |mod|
+     mod.method_list
+   end.sort.each do |method| %>
+  <li class="method">
+    <a href="<%= method.path %>"><%= h method.pretty_name %></a>
+    &mdash;
+    <span class="container"><%= method.parent.full_name %></span>
+<%- end -%>
+</ul>
+</main>

data/lib/rorvswild_theme_rdoc/patches/rdoc.rb ADDED Viewed

@@ -0,0 +1,14 @@
+class RDoc::ClassModule
+  ##
+  # Get all super classes of this class in an array. The last element might be
+  # a string if the name is unknown.
+  def super_classes
+    result = []
+    parent = self
+    while parent = parent.superclass
+      result << parent
+      return result if parent.is_a?(String)
+    end
+    result
+  end
+end

data/lib/rorvswild_theme_rdoc.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require "rorvswild_theme_rdoc/patches/rdoc"
+module RorVsWildThemeRdoc
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild_theme_rdoc
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Antoine Marguerie
@@ -9,17 +9,55 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies: []
 description: " RDoc theme for developers with sensitive eyes."
 email: ''
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- README.md
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/template/rorvswild/_dialog_search.rhtml
+- lib/rdoc/generator/template/rorvswild/_footer.rhtml
+- lib/rdoc/generator/template/rorvswild/_head.rhtml
+- lib/rdoc/generator/template/rorvswild/_navigation.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_VCS_info.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_classes.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_constants.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_extends.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_in_files.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_includes.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_installed.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_methods.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_pages.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_parent.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_sections.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_table_of_contents.rhtml
+- lib/rdoc/generator/template/rorvswild/_sidebar_toggle.rhtml
+- lib/rdoc/generator/template/rorvswild/_topbar.rhtml
+- lib/rdoc/generator/template/rorvswild/class.rhtml
+- lib/rdoc/generator/template/rorvswild/css/fonts.css
+- lib/rdoc/generator/template/rorvswild/css/rdoc.css
+- lib/rdoc/generator/template/rorvswild/fonts/Inter-Bold.woff2
+- lib/rdoc/generator/template/rorvswild/fonts/Inter-Italic.woff2
+- lib/rdoc/generator/template/rorvswild/fonts/Inter-Regular.woff2
+- lib/rdoc/generator/template/rorvswild/fonts/MonaspaceNeon-Bold.woff2
+- lib/rdoc/generator/template/rorvswild/fonts/MonaspaceNeon-Regular.woff2
+- lib/rdoc/generator/template/rorvswild/index.rhtml
+- lib/rdoc/generator/template/rorvswild/js/darkfish.js
+- lib/rdoc/generator/template/rorvswild/js/search.js
+- lib/rdoc/generator/template/rorvswild/page.rhtml
+- lib/rdoc/generator/template/rorvswild/servlet_not_found.rhtml
+- lib/rdoc/generator/template/rorvswild/servlet_root.rhtml
+- lib/rdoc/generator/template/rorvswild/table_of_contents.rhtml
+- lib/rorvswild_theme_rdoc.rb
+- lib/rorvswild_theme_rdoc/patches/rdoc.rb
 homepage: https://github.com/BaseSecrete/rorvswild-theme-rdoc
 licenses:
-- MIT
+- BSD-3-Clause
 metadata: {}
 post_install_message:
 rdoc_options: []