hookapp 2.0.3 → 2.0.8

data/bin/hook

@@ -1,15 +1,17 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W1
 # frozen_string_literal: true
 
-require 'gli'
 require 'hook'
+require 'shellwords'
 
 # Main class for GLI app
 class App
   extend GLI::App
 
   program_desc 'CLI interface for Hook.app (macOS)'
-  program_long_desc 'Hook.app is a productivity tool for macOS <https://hookproductivity.com/>. This gem includes a `hook` binary that allows interaction with the features of Hook.app.'
+  program_long_desc 'Hook.app is a productivity tool for macOS <https://hookproductivity.com/>.
+
+This gem includes a `hook` binary that allows interaction with the features of Hook.app.'
   default_command 'help'
   autocomplete_commands = true
   synopsis_format(:terminal)
@@ -19,15 +21,14 @@ class App
   subcommand_option_handling :normal
   arguments :strict
 
-  hooker = nil
+  hookapp = nil
+  stdin = nil
 
   desc 'List hooks on a file or url'
-  long_desc %{
-Output a list of all hooks attached to given url(s) or file(s) in the specified format (default "paths").
-
-Run `hook list` with no file/url argument to list all bookmarks.}
+  long_desc %(Output a list of all hooks attached to given url(s) or file(s) in the specified format (default "paths").
 
-  arg_name 'FILE_OR_URL [FILE_OR_URL...]'
+Run `hook list` with no file/url argument to list all bookmarks.)
+  arg_name 'FILE_OR_URL', [:optional, :multiple]
   command %i[list ls] do |c|
     c.desc 'Generate a menu to select hook(s) for opening'
     c.long_desc 'This option is a shortcut to `hook select` and overrides any other arguments.'
@@ -42,20 +43,22 @@ Run `hook list` with no file/url argument to list all bookmarks.}
     valid_formats = %w[hooks paths markdown verbose]
     fmt_list = valid_formats.map { |fmt| fmt.sub(/^(.)(.*?)$/, '(\1)\2') }.join(', ')
     c.desc "Output format [#{fmt_list}]"
-    c.flag %i[o output_format], { arg_name: 'format', default_value: 'paths' }
+    c.arg_name 'FORMAT'
+    c.flag %i[o output_format], { arg_name: 'FORMAT', default_value: 'paths' }
 
     c.action do |_global_options, options, args|
       if options[:s]
-        return hooker.open_linked(args[0])
-      end
-      valid_format = hooker.validate_format(options[:o], valid_formats)
-      exit_now!("Invalid output format: \"#{options[:o]}\"", 6) unless valid_format
+        hookapp.open_linked(args[0])
+      else
+        valid_format = hookapp.validate_format(options[:o], valid_formats)
+        help_now!("Invalid output format: \"#{options[:o]}\"", 6) unless valid_format
 
-      result = hooker.linked_bookmarks(args, { files_only: options[:f],
-                                               format: valid_format,
-                                               null_separator: options[:null] })
+        result = hookapp.linked_bookmarks(args, { files_only: options[:f],
+                                                 format: valid_format,
+                                                 null_separator: options[:null] })
 
-      puts result
+        puts result
+      end
     end
   end
 
@@ -63,25 +66,21 @@ Run `hook list` with no file/url argument to list all bookmarks.}
   # the full shell name as the extension, e.g. "hook_completion.bash".
   desc 'Shell completion examples'
   valid_shells = %w[bash zsh fish]
-  long_desc %{
-Output completion script example for the specified shell (#{valid_shells.join(', ')})
-  }
+  long_desc %(Output completion script example for the specified shell (#{valid_shells.join(', ')}))
   arg_name 'SHELL'
   command %i[scripts] do |c|
     c.action do |_global_options, _options, args|
       if args.length > 1
-        exit_now!("Invalid number of arguments, (expected 1)", 5)
+        help_now!('Invalid number of arguments, (expected 1)', 5)
       elsif args.nil? || args.empty?
-        exit_now!("Specify a shell (#{valid_shells.join(', ')})", 0)
+        help_now!("Specify a shell (#{valid_shells.join(', ')})", 0)
+      elsif valid_shells.include?(args[0])
+        base_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib/completion'))
+        completion = File.join(base_dir, "hook_completion.#{args[0]}")
+        script = IO.read(completion)
+        $stdout.puts script
       else
-        if valid_shells.include?(args[0])
-          base_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib/completion'))
-          completion = File.join(base_dir, "hook_completion.#{args[0]}")
-          script = IO.read(completion)
-          $stdout.puts script
-        else
-          exit_now!("Invalid shell name, must be one of #{valid_shells.join(', ')}", 1)
-        end
+        help_now!("Invalid shell name, must be one of #{valid_shells.join(', ')}", 1)
       end
     end
   end
@@ -89,11 +88,10 @@ Output completion script example for the specified shell (#{valid_shells.join(',
 
 
   desc 'Search bookmarks'
-  long_desc %{
-Search bookmark urls and names for a string and output in specified format (default "paths").
+  long_desc %(Search bookmark urls and names for a string and output in specified format (default "paths").
 
-Run `hook find` with no search argument to list all bookmarks.}
-  arg_name 'SEARCH_STRING'
+Run `hook find` with no search argument to list all bookmarks.)
+  arg_name 'SEARCH_STRING', :optional
   command %i[find search] do |c|
     c.desc 'Output only bookmarks with file paths (exclude e.g. emails)'
     c.switch %i[f files_only], { negatable: false, default_value: false }
@@ -105,16 +103,16 @@ Run `hook find` with no search argument to list all bookmarks.}
     fmt_list = valid_formats.map { |fmt| fmt.sub(/^(.)(.*?)$/, '(\1)\2') }.join(', ')
 
     c.desc "Output format [#{fmt_list}]"
-    c.flag %i[o output_format], { arg_name: 'format', default_value: 'paths' }
+    c.flag %i[o output_format], { arg_name: 'FORMAT', default_value: 'paths' }
 
     c.desc "Search only bookmark names"
     c.switch %i[n names_only], { negatable: false, default_value: false }
 
     c.action do |_global_options, options, args|
-      valid_format = hooker.validate_format(options[:o], valid_formats)
+      valid_format = hookapp.validate_format(options[:o], valid_formats)
       exit_now!("Invalid output format: \"#{options[:o]}\"", 6) unless valid_format
 
-      result = hooker.search_bookmarks(args.join(" "), { files_only: options[:f],
+      result = hookapp.search_bookmarks(args.join(" "), { files_only: options[:f],
                                                format: valid_format,
                                                null_separator: options[:null],
                                                names_only: options[:n] })
@@ -124,16 +122,15 @@ Run `hook find` with no search argument to list all bookmarks.}
   end
 
   desc 'Create bidirectional hooks between two or more files/urls'
-  long_desc %{
-If two files/urls are provided, links will be bi-directional.
+  long_desc '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.
 
 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.
-  }
-  arg_name 'SOURCE [SOURCE...] TARGET'
+  '
+  arg_name 'SOURCE... TARGET'
   command %i[link ln] do |c|
     c.desc 'Link every listed file or url to every other'
     c.switch %i[a all],  { negatable: false, default_value: false }
@@ -151,20 +148,18 @@ to be combined with one or more file/url arguments.
         exit_now!('Wrong number of arguments. At least 2 files must be specified, or one file with --paste', 5)
       end
       if options[:a]
-        puts hooker.link_all(args)
+        puts hookapp.link_all(args)
       else
-        puts hooker.link_files(args)
+        puts hookapp.link_files(args)
       end
     end
   end
 
   desc 'Copy Hook URL for file/url to clipboard'
-  long_desc %{
-Creates a bookmark for the specified file or URL and copies its Hook URL to the clipboard.
+  long_desc %{Creates a bookmark for the specified file or URL and copies its Hook URL to the clipboard.
 
-The copied Hook 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.
-  }
+The copied Hook 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.}
   arg_name 'FILE_OR_URL'
   command %i[clip cp] do |c|
     c.desc 'Copy as Markdown'
@@ -177,20 +172,18 @@ or to paste into another app as a link. Use the -m flag to copy a full Markdown
       exit_now!('Wrong number of arguments. Requires a path/url or -a APP_NAME', 5) if args.length != 1 && !options[:a]
 
       if options[:a]
-        puts hooker.bookmark_from_app(options[:a], { copy: true, markdown: options[:m] })
+        puts hookapp.bookmark_from_app(options[:a], { copy: true, markdown: options[:m] })
       else
-        puts hooker.clip_bookmark(args[0], { markdown: options[:m] })
+        puts hookapp.clip_bookmark(args[0], { markdown: options[:m] })
       end
     end
   end
 
   desc 'Get a Hook URL for the frontmost window of an app'
-  long_desc %{
-Specify an application by name (without '.app') to bring that app to the foreground and create a bookmark
+  long_desc %(Specify an application by name (without '.app') to bring that app to the foreground and create a bookmark
 for the active document, note, task, etc., returning a Hook URL.
 
-Use -m to get the response as Markdown, and/or -c to copy the result directly to the clipboard.
-  }
+Use -m to get the response as Markdown, and/or -c to copy the result directly to the clipboard.)
   arg_name 'APPLICATION_NAME'
   command %i[from] do |c|
     c.desc 'Output as Markdown'
@@ -202,76 +195,119 @@ Use -m to get the response as Markdown, and/or -c to copy the result directly to
     c.action do |_global_options, options, args|
       exit_now!("Wrong number of arguments (1 expected, #{args.length} given)", 5) if args.length != 1
 
-      puts hooker.bookmark_from_app(args[0], { copy: options[:c], markdown: options[:m] })
+      puts hookapp.bookmark_from_app(args[0], { copy: options[:c], markdown: options[:m] })
     end
   end
 
   desc 'Remove a hook between two files/urls'
-  long_desc %{
-Remove a hook between two files or URLs. If you use --all, all hooks on a given file will be removed.
+  long_desc %(Remove a hook between two files or URLs. If you use --all, all hooks on a given file will be removed.
 
-If --all isn't specified, exactly two arguments (Files/URLs) are required.
-  }
-  arg_name 'ITEM_1 ITEM_2'
+If --all isn't specified, exactly two arguments (Files/URLs) are required.)
+  arg_name 'FILE_OR_URL', :multiple
   command %i[remove rm] do |c|
     c.desc 'Remove ALL links on files, requires confirmation'
     c.switch %i[a all], { negatable: false, default_value: false }
+    c.switch %i[f force], { negatable: false, default_value: false }
 
     c.action do |_global_options, options, args|
-      result = hooker.delete_hooks(args, { all: options[:a] })
+      result = hookapp.delete_hooks(args, { all: options[:all], force: options[:force] })
       puts result
     end
   end
 
   desc 'Clone all hooks from one file or url onto another'
-  long_desc %{
-Copy all the files and urls that the first file is hooked to onto another file. Exactly two arguments (SOURCE, TARGET) required.
-  }
+  long_desc 'Copy all the files and urls that the first file is hooked to onto another file.
+
+Exactly two arguments (SOURCE, TARGET) required.'
   arg_name 'SOURCE TARGET'
   command %i[clone] do |c|
     c.action do |_global_options, _options, args|
       exit_now!("Wrong number of arguments. Two file paths or urls required (#{args.length} given)", 5) if args.length != 2
 
-      result = hooker.clone_hooks(args)
+      result = hookapp.clone_hooks(args)
       puts result
     end
   end
 
   desc 'Select from hooks on a file/url and open in default application'
-  long_desc %{
-If the target file/URL has hooked items, a menu will be provided. Selecting one or more files
+  long_desc %(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.
-}
+filetype by macOS. Allows multiple selections with tab key, and type-ahead fuzzy filtering of results.)
   arg_name 'FILE_OR_URL'
   command %i[select] do |c|
     c.action do |_global_options, _options, args|
-      exit_now!("Wrong number of arguments. One file path or url required (#{args.length} given)", 5) if args.length != 1
+      help_now!("Wrong number of arguments. One file path or url required (#{args.length} given)", 5) if args.length != 1
 
-      hooker.open_linked(args[0])
+      hookapp.open_linked(args[0])
     end
   end
 
   desc 'Open the specified file or url in Hook GUI'
-  long_desc %{
-Opens Hook.app on the specified file/URL for browsing and performing actions. Exactly one argument (File/URL) required.
-  }
+  long_desc 'Opens Hook.app on the specified file/URL for browsing and performing actions.
+
+Exactly one argument (File/URL) required.'
   arg_name 'FILE_OR_URL'
   command %i[open gui] do |c|
     c.action do |_global_options, _options, args|
-      exit_now!("Wrong number of arguments. One file path or url required (#{args.length} given)", 5) if args.length != 1
+      if args.length != 1
+        help_now!("Wrong number of arguments. One file path
+                or url required (#{args.length} given)", 5)
+      end
 
-      hooker.open_gui(args[0])
+      hookapp.open_gui(args[0])
     end
   end
 
+  desc 'Percent encode/decode a string'
+  long_desc %(Use encode or decode to apply Hook's url encoding to a string argument. Use '-' to read input from STDIN.)
+  arg_name 'STRING'
+  command :percent do |c|
+    c.desc 'percent encode a string'
+    c.arg_name 'STRING'
+    c.command :encode do |enc|
+      enc.action do |_global_options, _options, args|
+        if stdin
+          string = stdin
+        else
+          help_now!('No string provided') unless args.size.positive?
+
+          string = args.join(' ').strip
+        end
+
+        print hookapp.encode(string)
+      end
+    end
+
+    c.desc 'decode a percent-encoded string'
+    c.arg_name 'STRING'
+    c.command :decode do |dec|
+      dec.action do |_global_options, _options, args|
+        if stdin
+          string = stdin
+        else
+          help_now!('no string provided') unless args.size.positive?
+
+          string = args.join(' ').strip
+        end
+
+        print hookapp.decode(string)
+      end
+    end
+
+    # c.default_command :encode
+  end
+
   pre do |global, _command, _options, _args|
     # Pre logic here
     # Return true to proceed; false to abort and not call the
     # chosen command
     # Use skips_pre before a command to skip this block
     # on that command only
-    hooker = Hooker.new
+    if !STDIN.tty?
+      stdin = STDIN.read.strip
+    end
+
+    hookapp = HookApp.new
     true
   end
 

data/buildnotes.md

@@ -27,3 +27,33 @@ Helpers and main classes are in `lib/`.
 Update the docs with `bundle exec bin/hook _doc --format=markdown` and `bundle exec bin/hook _doc --format=rdoc`, then run `rake rerdoc`
 
 @run(bundle exec bin/hook _doc --format=rdoc && bundle exec bin/hook _doc --format=markdown && rake rerdoc)
+
+## Test
+
+Run all tests using `rake test`.
+
+Run verbose using `rake test TESTOPT="-v"`
+
+Run a single test using `rake test TEST=test/TEST_FILE.rb`
+
+This howzit task accepts an optional argument pointing to a specific test (just the test part of the filename, e.g. archive runs `test/doing_archive_test.rb`).
+
+`howzit -r test -- archive` (or `bld test archive` with the Fish function)
+
+```run
+#!/bin/bash
+if [[ -n $1 ]]; then
+    rake test TESTOPT="-v" TEST=test/hook_$1_test.rb
+    if [[ $? != 0 ]]; then
+        echo "Available tests"
+        echo -e "\033[1;32;40m"
+        FILES="test/hook_*_test.rb"
+        for file in $FILES; do
+            echo $(basename $file ".rb") | sed -E 's/hook_(.*)_test/- \1/'
+        done
+        echo -e "\033[0m"
+    fi
+else
+    rake test TESTOPT="-v"
+fi
+```

data/hook.rdoc

@@ -1,8 +1,10 @@
 == hook - CLI interface for Hook.app (macOS)
 
-Hook.app is a productivity tool for macOS <https://hookproductivity.com/>. This gem includes a `hook` binary that allows interaction with the features of Hook.app.
+Hook.app is a productivity tool for macOS <https://hookproductivity.com/>.
 
-v2.0.3
+This gem includes a `hook` binary that allows interaction with the features of Hook.app.
+
+v2.0.7
 
 === Global Options
 === --help
@@ -21,7 +23,7 @@ Copy Hook URL for file/url to clipboard
 
 Creates a bookmark for the specified file or URL and copies its Hook URL to the clipboard.
 
-The copied Hook URL can be used to link to other files (use `hook link --paste FILE/URL),
+The copied Hook 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.
 ===== Options
 ===== -a|--app APP_NAME
@@ -39,15 +41,17 @@ Copy as Markdown
 ==== Command: <tt>clone  SOURCE TARGET</tt>
 Clone all hooks from one file or url onto another
 
-Copy all the files and urls that the first file is hooked to onto another file. Exactly two arguments (SOURCE, TARGET) required.
-==== Command: <tt>find|search  SEARCH_STRING</tt>
+Copy all the files and urls that the first file is hooked to onto another file.
+
+Exactly two arguments (SOURCE, TARGET) required.
+==== Command: <tt>find|search  [SEARCH_STRING]</tt>
 Search bookmarks
 
 Search bookmark urls and names for a string and output in specified format (default "paths").
 
 Run `hook find` with no search argument to list all bookmarks.
 ===== Options
-===== -o|--output_format format
+===== -o|--output_format FORMAT
 
 Output format [(h)ooks, (p)aths, (m)arkdown, (v)erbose]
 
@@ -97,7 +101,7 @@ List commands one per line, to assist with shell completion
 
 
 
-==== Command: <tt>link|ln  SOURCE [SOURCE...] TARGET</tt>
+==== Command: <tt>link|ln  SOURCE... TARGET</tt>
 Create bidirectional hooks between two or more files/urls
 
 If two files/urls are provided, links will be bi-directional.
@@ -118,14 +122,14 @@ Paste URL from clipboard
 
 
 
-==== Command: <tt>list|ls  FILE_OR_URL [FILE_OR_URL...]</tt>
+==== Command: <tt>list|ls  [FILE_OR_URL]...</tt>
 List hooks on a file or url
 
 Output a list of all hooks attached to given url(s) or file(s) in the specified format (default "paths").
 
 Run `hook list` with no file/url argument to list all bookmarks.
 ===== Options
-===== -o|--output_format format
+===== -o|--output_format FORMAT
 
 Output format [(h)ooks, (p)aths, (m)arkdown, (v)erbose]
 
@@ -150,8 +154,23 @@ This option is a shortcut to `hook select` and overrides any other arguments.
 ==== Command: <tt>open|gui  FILE_OR_URL</tt>
 Open the specified file or url in Hook GUI
 
-Opens Hook.app on the specified file/URL for browsing and performing actions. Exactly one argument (File/URL) required.
-==== Command: <tt>remove|rm  ITEM_1 ITEM_2</tt>
+Opens Hook.app on the specified file/URL for browsing and performing actions.
+
+Exactly one argument (File/URL) required.
+==== Command: <tt>percent  STRING</tt>
+Percent encode/decode a string
+
+Use encode or decode to apply Hook's url encoding to a string argument. Use '-' to read input from STDIN.
+===== Commands
+====== Command: <tt>decode  STRING</tt>
+decode a percent-encoded string
+
+
+====== Command: <tt>encode  STRING</tt>
+percent encode a string
+
+
+==== Command: <tt>remove|rm  FILE_OR_URL...</tt>
 Remove a hook between two files/urls
 
 Remove a hook between two files or URLs. If you use --all, all hooks on a given file will be removed.
@@ -163,6 +182,11 @@ Remove ALL links on files, requires confirmation
 
 
 
+===== -f|--force
+
+
+
+
 ==== Command: <tt>scripts  SHELL</tt>
 Shell completion examples
 

data/hookapp.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.executables << 'hook'
   s.add_development_dependency('aruba', '~> 0.14.14')
   s.add_development_dependency('rake', '~> 13.0.1')
-  s.add_development_dependency('rdoc', '~> 6.1.2')
-  s.add_runtime_dependency('gli', '2.19.0')
+  s.add_development_dependency('rdoc', '~> 6.3.2')
+  s.add_runtime_dependency('gli', '~> 2.20.1')
 end

data/html/App.html

@@ -21,8 +21,6 @@
 <link href="./css/rdoc.css" rel="stylesheet">
 
 
-
-
 <body id="top" role="document" class="class">
 <nav role="navigation">
   <div id="project-navigation">
@@ -59,24 +57,20 @@
 
   <div id="class-metadata">
     
-    <div id="parent-class-section" class="nav-section">
+    
+<div id="parent-class-section" class="nav-section">
   <h3>Parent</h3>
 
-  
   <p class="link">Object
-  
 </div>
 
     
-    <div id="extends-section" class="nav-section">
+    
+<div id="extends-section" class="nav-section">
   <h3>Extended With Modules</h3>
 
   <ul class="link-list">
-    
-  
     <li><span class="extend">GLI::App</span>
-  
-  
   </ul>
 </div>
 
@@ -95,25 +89,19 @@
 
   </section>
 
-  
   <section id="5Buntitled-5D" class="documentation-section">
-    
 
-    
 
-    
 
-    
 
-    
-  </section>
 
+  </section>
 </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>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
   <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/GLI/Commands/Doc.html

@@ -21,8 +21,6 @@
 <link href="../../css/rdoc.css" rel="stylesheet">
 
 
-
-
 <body id="top" role="document" class="module">
 <nav role="navigation">
   <div id="project-navigation">
@@ -75,25 +73,19 @@
     
   </section>
 
-  
   <section id="5Buntitled-5D" class="documentation-section">
-    
 
-    
 
-    
 
-    
 
-    
-  </section>
 
+  </section>
 </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>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>