RubyGems - docspring - Versions diffs - 3.0.0 → 3.1.0 - Mend

docspring 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (523) hide show

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/ruby.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/tag_blue.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/tag_green.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/transparent.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/wrench.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/wrench_orange.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/images/zoom.png ADDED Viewed

Binary file

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/index.rhtml ADDED Viewed

@@ -0,0 +1,23 @@
+<body id="top" role="document" class="file">
+<%= 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' if defined?(current) %>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_footer.rhtml' %>
+</nav>
+<main role="main">
+<%- if @main_page %>
+  <%= @main_page.description %>
+<%- else -%>
+  <p>This is the API documentation for <%= h @title %>.
+<%- end -%>
+</main>

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/js/darkfish.js ADDED Viewed

@@ -0,0 +1,120 @@
+/**
+ *
+ * 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('.method-source-toggle').forEach(function (codeObject) {
+    codeObject.addEventListener('click', showSource);
+  });
+};
+function hookSearch() {
+  var input  = document.querySelector('#search-field');
+  var result = document.querySelector('#search-results');
+  result.classList.remove("initially-hidden");
+  var search_section = document.querySelector('#search-section');
+  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: 1023px)").matches;
+  if (isSmallViewport) {
+    navigation.hidden = true;
+    navigationToggle.ariaExpanded = false;
+    document.addEventListener('click', (e) => {
+      if (e.target.closest('#navigation a')) {
+        navigation.hidden = true;
+        navigationToggle.ariaExpanded = false;
+      }
+    });
+  }
+}
+document.addEventListener('DOMContentLoaded', function() {
+  hookSourceViews();
+  hookSearch();
+  hookFocus();
+  hookSidebar();
+});

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/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/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/page.rhtml ADDED Viewed

@@ -0,0 +1,18 @@
+<body id="top" role="document" class="file">
+<%= 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_pages.rhtml' %>
+  <%= render '_footer.rhtml' %>
+</nav>
+<main role="main" aria-label="Page <%=h file.full_name%>">
+<%= file.description %>
+</main>

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml ADDED Viewed

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

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/servlet_root.rhtml ADDED Viewed

@@ -0,0 +1,65 @@
+<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>
+    <%= render '_sidebar_search.rhtml' %>
+  </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/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml ADDED Viewed

@@ -0,0 +1,70 @@
+<body id="top" class="table-of-contents">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
+  </div>
+  <%= 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/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/generator/template/json_index/js/navigation.js ADDED Viewed

@@ -0,0 +1,105 @@
+/*
+ * Navigation allows movement using the arrow keys through the search results.
+ *
+ * When using this library you will need to set scrollIntoView to the
+ * appropriate function for your layout.  Use scrollInWindow if the container
+ * is not scrollable and scrollInElement if the container is a separate
+ * scrolling region.
+ */
+Navigation = new function() {
+  this.initNavigation = function() {
+    var _this = this;
+    document.addEventListener('keydown', function(e) {
+      _this.onkeydown(e);
+    });
+    this.navigationActive = true;
+  }
+  this.setNavigationActive = function(state) {
+    this.navigationActive = state;
+  }
+  this.onkeydown = function(e) {
+    if (!this.navigationActive) return;
+    switch(e.key) {
+      case 'ArrowLeft':
+        if (this.moveLeft()) e.preventDefault();
+        break;
+      case 'ArrowUp':
+        if (e.key == 'ArrowUp' || e.ctrlKey) {
+          if (this.moveUp()) e.preventDefault();
+        }
+        break;
+      case 'ArrowRight':
+        if (this.moveRight()) e.preventDefault();
+        break;
+      case 'ArrowDown':
+        if (e.key == 'ArrowDown' || e.ctrlKey) {
+          if (this.moveDown()) e.preventDefault();
+        }
+        break;
+      case 'Enter':
+        if (this.current) e.preventDefault();
+        this.select(this.current);
+        break;
+    }
+    if (e.ctrlKey && e.shiftKey) this.select(this.current);
+  }
+  this.moveRight = function() {
+  }
+  this.moveLeft = function() {
+  }
+  this.move = function(isDown) {
+  }
+  this.moveUp = function() {
+    return this.move(false);
+  }
+  this.moveDown = function() {
+    return this.move(true);
+  }
+  /*
+   * Scrolls to the given element in the scrollable element view.
+   */
+  this.scrollInElement = function(element, view) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = view.offsetHeight;
+    viewScroll = view.scrollTop;
+    if (offset - viewScroll + height > viewHeight) {
+      view.scrollTop = offset - viewHeight + height;
+    }
+    if (offset < viewScroll) {
+      view.scrollTop = offset;
+    }
+  }
+  /*
+   * Scrolls to the given element in the window.  The second argument is
+   * ignored
+   */
+  this.scrollInWindow = function(element, ignored) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = window.innerHeight;
+    viewScroll = window.scrollY;
+    if (offset - viewScroll + height > viewHeight) {
+      window.scrollTo(window.scrollX, offset - viewHeight + height);
+    }
+    if (offset < viewScroll) {
+      window.scrollTo(window.scrollX, offset);
+    }
+  }
+}