RubyGems - hookapp - Versions diffs - 0.0.7 → 2.0.3 - Mend

@@ -0,0 +1,308 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>hookapp</title>
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+<body id="top" role="document" class="file">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+    <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" spellcheck="false"
+             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>
+  </div>
+  <div id="project-metadata">
+    <div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+  <ul class="link-list">
+    <li><a href="./README_rdoc.html">README</a>
+  </ul>
+</div>
+    <div id="classindex-section" class="nav-section">
+  <h3>Class and Module Index</h3>
+  <ul class="link-list">
+    <li><a href="./App.html">App</a>
+    <li><a href="./GLI.html">GLI</a>
+    <li><a href="./GLI/Commands.html">GLI::Commands</a>
+    <li><a href="./GLI/Commands/Doc.html">GLI::Commands::Doc</a>
+    <li><a href="./GLI/Commands/MarkdownDocumentListener.html">GLI::Commands::MarkdownDocumentListener</a>
+    <li><a href="./Hook.html">Hook</a>
+    <li><a href="./HookApp.html">HookApp</a>
+    <li><a href="./Hooker.html">Hooker</a>
+    <li><a href="./String.html">String</a>
+  </ul>
+</div>
+  </div>
+</nav>
+<main role="main">
+<h1 id="label-hookapp">hookapp<span><a href="#label-hookapp">&para;</a> <a href="#top">&uarr;</a></span></h1>
+<p>A CLI for Hook.app on macOS.</p>
+<h2 id="label-hook+-+CLI+interface+for+Hook.app+-28macOS-29">hook - CLI interface for Hook.app (macOS)<span><a href="#label-hook+-+CLI+interface+for+Hook.app+-28macOS-29">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<p>Hook.app is a productivity tool for macOS &lt;<a href="https://hookproductivity.com">hookproductivity.com</a>/&gt;. This gem includes a `hook` binary that allows interaction with the features of Hook.app.</p>
+<p>v2.0.3</p>
+<h3 id="label-Global+Options">Global Options<span><a href="#label-Global+Options">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<h3 id="label--help">–help<span><a href="#label--help">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<p>Show this message</p>
+<h3 id="label--version">–version<span><a href="#label--version">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<p>Display the program version</p>
+<h3 id="label-Commands">Commands<span><a href="#label-Commands">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<h4 id="label-Command-3A+clip-7Ccp++FILE_OR_URL">Command: <code>clip|cp  FILE_OR_URL</code><span><a href="#label-Command-3A+clip-7Ccp++FILE_OR_URL">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Copy <a href="Hook.html"><code>Hook</code></a> URL for file/url to clipboard</p>
+<p>Creates a bookmark for the specified file or URL and copies its <a href="Hook.html"><code>Hook</code></a> URL to the clipboard.</p>
+<p>The copied <a href="Hook.html"><code>Hook</code></a> URL can be used to link to other files (use `hook link –paste FILE/URL), or to paste into another app as a link. Use the -m flag to copy a full Markdown link.</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-a-7C--app+APP_NAME">-a|–app APP_NAME<span><a href="#label-a-7C--app+APP_NAME">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Copy from application</p>
+<dl class="rdoc-list label-list"><dt>Default Value
+<dd>
+<p>None</p>
+</dd></dl>
+<h5 id="label-m-7C--markdown">-m|–markdown<span><a href="#label-m-7C--markdown">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Copy as Markdown</p>
+<h4 id="label-Command-3A+clone++SOURCE+TARGET">Command: <code>clone  SOURCE TARGET</code><span><a href="#label-Command-3A+clone++SOURCE+TARGET">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Clone all hooks from one file or url onto another</p>
+<p>Copy all the files and urls that the first file is hooked to onto another file. Exactly two arguments (SOURCE, TARGET) required.</p>
+<h4 id="label-Command-3A+find-7Csearch++SEARCH_STRING">Command: <code>find|search  SEARCH_STRING</code><span><a href="#label-Command-3A+find-7Csearch++SEARCH_STRING">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Search bookmarks</p>
+<p>Search bookmark urls and names for a string and output in specified format (default “paths”).</p>
+<p>Run `hook find` with no search argument to list all bookmarks.</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-o-7C--output_format+format">-o|–output_format format<span><a href="#label-o-7C--output_format+format">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Output format [(h)ooks, (p)aths, (m)arkdown, (v)erbose]</p>
+<dl class="rdoc-list label-list"><dt>Default Value
+<dd>
+<p>paths</p>
+</dd></dl>
+<h5 id="label-f-7C--files_only">-f|–files_only<span><a href="#label-f-7C--files_only">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Output only bookmarks with file paths (exclude e.g. emails)</p>
+<h5 id="label-n-7C--names_only">-n|–names_only<span><a href="#label-n-7C--names_only">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Search only bookmark names</p>
+<h5 id="label--null">–null<span><a href="#label--null">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Separate results with NULL separator, only applies with “paths” output for single file argument</p>
+<h4 id="label-Command-3A+from++APPLICATION_NAME">Command: <code>from  APPLICATION_NAME</code><span><a href="#label-Command-3A+from++APPLICATION_NAME">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Get a <a href="Hook.html"><code>Hook</code></a> URL for the frontmost window of an app</p>
+<p>Specify an application by name (without &#39;.app&#39;) to bring that app to the foreground and create a bookmark for the active document, note, task, etc., returning a <a href="Hook.html"><code>Hook</code></a> URL.</p>
+<p>Use -m to get the response as Markdown, and/or -c to copy the result directly to the clipboard.</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-c-7C--copy">-c|–copy<span><a href="#label-c-7C--copy">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Copy to clipboard</p>
+<h5 id="label-m-7C--markdown">-m|–markdown<span><a href="#label-m-7C--markdown">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Output as Markdown</p>
+<h4 id="label-Command-3A+help++command">Command: <code>help  command</code><span><a href="#label-Command-3A+help++command">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Shows a list of commands or help for one command</p>
+<p>Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-c">-c<span><a href="#label-c">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>List commands one per line, to assist with shell completion</p>
+<h4 id="label-Command-3A+link-7Cln++SOURCE+-5BSOURCE...-5D+TARGET">Command: <code>link|ln  SOURCE [SOURCE...] TARGET</code><span><a href="#label-Command-3A+link-7Cln++SOURCE+-5BSOURCE...-5D+TARGET">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Create bidirectional hooks between two or more files/urls</p>
+<p>If two files/urls are provided, links will be bi-directional. If three or more are provided, `link` defaults to creating bi-directional links between each file and the last file in the list. Use `-a` to create bi-directional links between every file in the list.</p>
+<p>If using `–paste`, the URL/hook link in the clipboard will be used as one argument, to be combined with one or more file/url arguments.</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-a-7C--all">-a|–all<span><a href="#label-a-7C--all">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Link every listed file or url to every other</p>
+<h5 id="label-p-7C--paste">-p|–paste<span><a href="#label-p-7C--paste">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Paste URL from clipboard</p>
+<h4 id="label-Command-3A+list-7Cls++FILE_OR_URL+-5BFILE_OR_URL...-5D">Command: <code>list|ls  FILE_OR_URL [FILE_OR_URL...]</code><span><a href="#label-Command-3A+list-7Cls++FILE_OR_URL+-5BFILE_OR_URL...-5D">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>List hooks on a file or url</p>
+<p>Output a list of all hooks attached to given url(s) or file(s) in the specified format (default “paths”).</p>
+<p>Run `hook list` with no file/url argument to list all bookmarks.</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-o-7C--output_format+format">-o|–output_format format<span><a href="#label-o-7C--output_format+format">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Output format [(h)ooks, (p)aths, (m)arkdown, (v)erbose]</p>
+<dl class="rdoc-list label-list"><dt>Default Value
+<dd>
+<p>paths</p>
+</dd></dl>
+<h5 id="label-f-7C--files_only">-f|–files_only<span><a href="#label-f-7C--files_only">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Output only bookmarks with file paths (exclude e.g. emails)</p>
+<h5 id="label--null">–null<span><a href="#label--null">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Separate results with NULL separator, only applies with “paths” output for single file argument</p>
+<h5 id="label-s-7C--select">-<a href="no-">s|–</a>select<span><a href="#label-s-7C--select">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Generate a menu to select hook(s) for opening</p>
+<p>This option is a shortcut to `hook select` and overrides any other arguments.</p>
+<h4 id="label-Command-3A+open-7Cgui++FILE_OR_URL">Command: <code>open|gui  FILE_OR_URL</code><span><a href="#label-Command-3A+open-7Cgui++FILE_OR_URL">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Open the specified file or url in <a href="Hook.html"><code>Hook</code></a> GUI</p>
+<p>Opens Hook.app on the specified file/URL for browsing and performing actions. Exactly one argument (File/URL) required.</p>
+<h4 id="label-Command-3A+remove-7Crm++ITEM_1+ITEM_2">Command: <code>remove|rm  ITEM_1 ITEM_2</code><span><a href="#label-Command-3A+remove-7Crm++ITEM_1+ITEM_2">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Remove a hook between two files/urls</p>
+<p>Remove a hook between two files or URLs. If you use –all, all hooks on a given file will be removed.</p>
+<p>If –all isn&#39;t specified, exactly two arguments (Files/URLs) are required.</p>
+<h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<h5 id="label-a-7C--all">-a|–all<span><a href="#label-a-7C--all">&para;</a> <a href="#top">&uarr;</a></span></h5>
+<p>Remove ALL links on files, requires confirmation</p>
+<h4 id="label-Command-3A+scripts++SHELL">Command: <code>scripts  SHELL</code><span><a href="#label-Command-3A+scripts++SHELL">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Shell completion examples</p>
+<p>Output completion script example for the specified shell (bash, zsh, fish)</p>
+<h4 id="label-Command-3A+select++FILE_OR_URL">Command: <code>select  FILE_OR_URL</code><span><a href="#label-Command-3A+select++FILE_OR_URL">&para;</a> <a href="#top">&uarr;</a></span></h4>
+<p>Select from hooks on a file/url and open in default application</p>
+<p>If the target file/URL has hooked items, a menu will be provided. Selecting one or more files from this menu will open the item(s) using the default application assigned to the filetype by macOS. Allows multiple selections with tab key, and type-ahead fuzzy filtering of results.</p>
+<dl class="rdoc-list label-list"><dt>Default Command
+<dd>
+<p>help</p>
+</dd></dl>
+</main>
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>

data/html/js/darkfish.js ADDED

@@ -0,0 +1,84 @@
+/**
+ *
+ * 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-heading').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 + 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;
+};
+document.addEventListener('DOMContentLoaded', function() {
+  hookSourceViews();
+  hookSearch();
+});