hookapp 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06acc4dd72c5ca227e0cbf252542ca79e42a31d624b5e78f609cfb019220f3c3
-  data.tar.gz: 6f2f660014f3486dd80a0fd06c52aa6822844097580780b6addf247ee0ee8cee
+  metadata.gz: 477033a68381137c2a2c67a486896da5d1210fb8d261950beff09df64b0b6566
+  data.tar.gz: b3de73462923bc91c88c7ab58b3c8fc7195ffe19cb4d09bef2acd3d0e579e7d5
 SHA512:
-  metadata.gz: 4c3c57b1879c66c9ce671bf3eb7a676e9d543962a50c0647ade2d451f93207c071d34c67a93ccdde8fcf5d19e54a0bb53a056e8cba928e5c6b6cdf69868b69ab
-  data.tar.gz: 5ba08b7b5ef07d6d0062fc18cfea73957d83146194185de9e1d1cbaf8f5680f230792a919a954099b03e26c023fe204766ece2429acc9fe4de1b0e233418d76a
+  metadata.gz: c64691a5a0ddc289590408efd13936e352962838f182ec905dfd8ac706197e6f5538d2cbe2a108b1a72f7ace459d90d36d1b789cf48bc7a6871391c871698a24
+  data.tar.gz: 3b91f789621f9cf091793ac75d9d44b61c09c2c07ae34fc4e84495ee670c2016c8583b71d00c067917f12aff77e603b389773a1cf4acb8a3a12bcd9cea2ac1bb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hookapp (2.0.4)
+    hookapp (2.0.7)
       gli (~> 2.20.1)
 
 GEM

data/README.md

@@ -2,9 +2,10 @@
 
 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/>.
+    This gem includes a `hook` binary that allows interaction with the features of Hook.app.
 
-*v2.0.3*
+*v2.0.7*
 
 ## Installation
 
@@ -257,6 +258,24 @@ Generate a menu to select hook(s) for opening
 
 * * * * * *
 
+### `$ hook` <mark>`percent`</mark> ` STRING`
+
+*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
+
+##### `$ hook` <mark>`decode`</mark> ` STRING`
+
+*decode a percent-encoded string*
+
+##### `$ hook` <mark>`encode`</mark> ` STRING`
+
+*percent encode a string*
+
+* * * * * *
+
 ### `$ hook` <mark>`remove|rm`</mark> ` ITEM_1 ITEM_2`
 
 *Remove a hook between two files/urls*
@@ -271,6 +290,10 @@ Generate a menu to select hook(s) for opening
 
 Remove ALL links on files, requires confirmation
 
+##### `-f`|`--force`
+
+
+
 * * * * * *
 
 ### `$ hook` <mark>`scripts`</mark> ` SHELL`
@@ -325,5 +348,5 @@ This software is licensed under the MIT License.
 	THE SOFTWARE.
 
 
-Documentation generated 2021-09-18 12:29
+Documentation generated 2021-09-25 07:37
 

data/Rakefile

@@ -4,6 +4,7 @@ require 'rubygems/package_task'
 require 'rdoc/task'
 require 'cucumber'
 require 'cucumber/rake/task'
+require 'rake/testtask'
 Rake::RDocTask.new do |rd|
   rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
@@ -14,6 +15,7 @@ spec = eval(File.read('hookapp.gemspec'))
 
 Gem::PackageTask.new(spec) do |pkg|
 end
+
 CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 desc 'Run features'
@@ -35,10 +37,12 @@ end
 task :cucumber => :features
 task 'cucumber:wip' => 'features:wip'
 task :wip => 'features:wip'
-require 'rake/testtask'
+
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << ['test', 'test/helpers']
   t.test_files = FileList['test/*_test.rb']
+  t.verbose = ENV['VERBOSE'] =~ /(true|1)/i ? true : false
 end
 
-task :default => [:test,:features]
+# task :default => [:test,:features]
+task :default => [:test]

data/bin/hook

@@ -2,13 +2,15 @@
 # frozen_string_literal: true
 
 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,6 +21,7 @@ class App
   arguments :strict
 
   hookapp = nil
+  stdin = nil
 
   desc 'List hooks on a file or url'
   long_desc %{
@@ -215,9 +218,10 @@ If --all isn't specified, exactly two arguments (Files/URLs) are required.
   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 = hookapp.delete_hooks(args, { all: options[:a] })
+      result = hookapp.delete_hooks(args, { all: options[:all], force: options[:force] })
       puts result
     end
   end
@@ -264,12 +268,55 @@ Opens Hook.app on the specified file/URL for browsing and performing actions. Ex
     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
+          exit_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
+          exit_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
+    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,9 @@
 == 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/>.
+    This gem includes a `hook` binary that allows interaction with the features of Hook.app.
 
-v2.0.3
+v2.0.7
 
 === Global Options
 === --help
@@ -151,6 +152,19 @@ This option is a shortcut to `hook select` and overrides any other arguments.
 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>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  ITEM_1 ITEM_2</tt>
 Remove a hook between two files/urls
 
@@ -163,6 +177,11 @@ Remove ALL links on files, requires confirmation
 
 
 
+===== -f|--force
+
+
+
+
 ==== Command: <tt>scripts  SHELL</tt>
 Shell completion examples
 

data/lib/hook/hookapp.rb

@@ -171,9 +171,9 @@ class HookApp
     output = output_array(result, opts)
 
     if opts[:format] =~ /^v/
-      "Search results for: #{search}\n---------\n" + output.join("\n")
+      "Search results for: #{search}\n---------\n" + output.join("\n") if output
     else
-      output.join(separator)
+      output.join(separator) if output
     end
   end
 
@@ -334,10 +334,13 @@ class HookApp
   end
 
   # Delete all hooked files/urls from target file
-  def delete_all_hooks(url)
-    STDERR.print "Are you sure you want to delete ALL hooks from #{url} (y/N)? "
-    res = STDIN.gets.strip
-    if res =~ /^y/i
+  def delete_all_hooks(url, force: false)
+    unless force
+      STDERR.print "Are you sure you want to delete ALL hooks from #{url} (y/N)? "
+      res = STDIN.gets.strip
+    end
+
+    if res =~ /^y/i || force
       get_hooks(url).each do |hook|
         `osascript <<'APPLESCRIPT'
           tell application "Hook"
@@ -360,7 +363,7 @@ class HookApp
       urls.each_with_index do |url, i|
         raise "Invalid target: #{args[i]}" unless url
 
-        output.push(delete_all_hooks(url))
+        output.push(delete_all_hooks(url, force: opts[:force]))
       end
       return output.join("\n")
     end
@@ -431,7 +434,7 @@ class HookApp
         hooks_arr = get_hooks(url)
 
         output = output_array(hooks_arr, opts)
-        result.push({ file: filename, links: output.join(separator) })
+        result.push({ file: filename, links: output.join(separator) }) if output
       end
 
 
@@ -479,11 +482,27 @@ class HookApp
         end
       end
     else
-      output = ['No bookmarks']
+      warn 'No bookmarks'
     end
 
     output
   end
-end
 
+  def encode(string)
+    result = `osascript <<'APPLESCRIPT'
+tell application "Hook"
+  percent encode "#{string.escape_quotes}"
+end tell
+APPLESCRIPT`.strip.gsub(/'/,'%27')
+    print result
+  end
 
+  def decode(string)
+    result = `osascript <<'APPLESCRIPT'
+tell application "Hook"
+  percent decode "#{string.escape_quotes}"
+end tell
+APPLESCRIPT`.strip
+    print result
+  end
+end

data/lib/hook/string.rb

@@ -57,4 +57,8 @@ class String
 
     true
   end
+
+  def escape_quotes
+    gsub(/"/, '\\"')
+  end
 end

data/lib/hook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hook
-  VERSION = '2.0.5'
+  VERSION = '2.0.7'
 end

data/test/helpers/hook-helpers.rb

@@ -0,0 +1,76 @@
+require 'fileutils'
+require 'open3'
+
+class ::Numeric
+  def pad_to(x)
+    "%0#{x.to_i}d" % self
+  end
+end
+
+module HookHelpers
+  HOOK_EXEC = File.join(File.dirname(__FILE__), '..', '..', 'bin', 'hook')
+  HOOK_FILES_DIR = File.join(File.dirname(__FILE__), '..', 'hookfiles')
+  HOOK_COMPLETIONS_DIR = File.join(File.dirname(__FILE__), '..', '..', 'lib', 'completion')
+
+  def create_temp_files
+    FileUtils.mkdir_p HOOK_FILES_DIR
+    10.times.with_index do |i|
+      new_file = File.join(HOOK_FILES_DIR, i.pad_to(2) + '.md')
+      File.open(new_file, 'w') do |f|
+        f.puts ("Hook Test File ##{i}")
+      end
+      hook('rm', '-a', '-f', new_file)
+    end
+  end
+
+  def clean_temp_files
+    FileUtils.rm_r HOOK_FILES_DIR, force: true
+  end
+
+  def assert_count_links(file, count, msg)
+    res = hook('ls', file).strip
+
+    links = res == 'No bookmarks' ? 0 : res.split(/\n/).size
+
+    assert_equal(count, links, msg)
+  end
+
+  def assert_links_include(file, pattern, msg)
+    result = hook('ls', file).strip
+    assert_match(/#{pattern}/, result, msg)
+  end
+
+  def hook(*args)
+    hook_with_env({}, *args)
+  end
+
+  def hook_with_stdin(input, *args)
+    pread_stdin({}, input, HOOK_EXEC, *args)
+  end
+
+  def hook_with_env(env, *args)
+    pread(env, HOOK_EXEC, *args)
+  end
+
+  def pread_stdin(env, input, *cmd)
+    out, err, status = Open3.capture3(env, 'bundle', 'exec', *cmd, :stdin_data => input)
+    unless status.success?
+      raise [
+        "Error (#{status}): #{cmd.inspect} failed", "STDOUT:", out.inspect, "STDERR:", err.inspect
+      ].join("\n")
+    end
+
+    out
+  end
+
+  def pread(env, *cmd)
+    out, err, status = Open3.capture3(env, 'bundle', 'exec', *cmd)
+    unless status.success?
+      raise [
+        "Error (#{status}): #{cmd.inspect} failed", "STDOUT:", out.inspect, "STDERR:", err.inspect
+      ].join("\n")
+    end
+
+    out
+  end
+end

data/test/hook_clip_test.rb

@@ -0,0 +1,24 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class ClipTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+    @basedir = HOOK_FILES_DIR
+    create_temp_files
+  end
+
+  def teardown
+    clean_temp_files
+  end
+
+  def test_clip
+    file = Dir.glob(File.join(HOOK_FILES_DIR, '*.md'))[0]
+    # Clear clipboard
+    `echo -n | pbcopy`
+    hook('clip', file)
+    clipboard = `pbpaste`.strip
+    assert_match(/^hook:.*?#{File.basename(file)}$/, clipboard, 'Clipboard should contain link to first file')
+  end
+end

data/test/hook_clone_test.rb

@@ -0,0 +1,30 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class CloneTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+    @basedir = HOOK_FILES_DIR
+    create_temp_files
+  end
+
+  def teardown
+    clean_temp_files
+  end
+
+  def test_clone
+    count = 3
+
+    files = Dir.glob(File.join(HOOK_FILES_DIR, '*.md'))
+
+    # Link all files to last file
+    hook('link', *files[0..count - 1])
+    links = hook('ls', files[count - 1]).strip
+
+    hook('clone', files[count-1], files[count])
+    cloned_links = hook('ls', files[count]).strip
+
+    assert_match(links, cloned_links, "#{files[count - 1]} links should match #{files[count]} links")
+  end
+end

data/test/hook_encode_test.rb

@@ -0,0 +1,30 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class EncodeTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  # # FIXME: I don't know why this isn't getting output
+  # def test_encode_args
+  #   result = hook('percent', 'encode', %(here's a "string?"))
+  #   assert_match(/here%27s%20a%20%22string%3F%22/, result, 'URL encoded string should match')
+  # end
+
+  def test_encode_stdin
+    result = pread_stdin({}, %(here's a "string?"), HOOK_EXEC, 'percent', 'encode')
+    assert_match(/here%27s%20a%20%22string%3F%22/, result, 'URL encoded string should match')
+  end
+
+  def test_encode_decode_stdin
+    original_string = %(here's a "string?")
+    encoded = pread_stdin({}, original_string, HOOK_EXEC, 'percent', 'encode')
+    decoded = pread_stdin({}, encoded, HOOK_EXEC, 'percent', 'decode')
+    assert_match(decoded, original_string, 'URL encoded string should match')
+  end
+end

data/test/hook_link_test.rb

@@ -0,0 +1,39 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class LinkTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+    @basedir = HOOK_FILES_DIR
+    create_temp_files
+  end
+
+  def teardown
+    clean_temp_files
+  end
+
+  def test_link
+    count = 3
+
+    files = Dir.glob(File.join(HOOK_FILES_DIR, '*.md'))[0..(count - 1)]
+
+    # Link all files to last file
+    hook('link', *files)
+
+    assert_count_links(files[-1], count - 1, "Last file should have #{count - 1} links")
+    assert_count_links(files[0], 1, 'First file should have 1 link')
+  end
+
+  def test_bi_link
+    count = 3
+
+    files = Dir.glob(File.join(HOOK_FILES_DIR, '*.md'))[0..(count - 1)]
+
+    # Link all files bi-directionally
+    hook('link', '-a', *files)
+
+    assert_count_links(files[-1], count - 1, "Last file should have #{count - 1} links")
+    assert_count_links(files[0], count - 1, "First file should have #{count - 1} links")
+  end
+end

data/test/hook_list_test.rb

@@ -0,0 +1,25 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class ListTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+    @basedir = HOOK_FILES_DIR
+    create_temp_files
+  end
+
+  def teardown
+    clean_temp_files
+  end
+
+  def test_list
+    count = 2
+    files = Dir.glob(File.join(HOOK_FILES_DIR, '*.md'))[0..(count - 1)]
+    # Link all files to last file
+    hook('link', *files)
+
+    assert_count_links(files[-1], count - 1, "Last file should have #{count - 1} links")
+    assert_links_include(files[-1], File.basename(files[0]), 'Links on last file should include first file')
+  end
+end

data/test/hook_remove_test.rb

@@ -0,0 +1,34 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class RemoveTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+    @basedir = HOOK_FILES_DIR
+    create_temp_files
+  end
+
+  def teardown
+    clean_temp_files
+  end
+
+  def test_remove
+    count = 5
+
+    files = Dir.glob(File.join(HOOK_FILES_DIR, '*.md'))[0..(count - 1)]
+
+    # Link all files to last file
+    hook('link', *files)
+
+    assert_count_links(files[-1], count - 1, "Last file should start with #{count - 1} links")
+
+    hook('remove', files[-1], files[0])
+    
+    assert_count_links(files[-1], count - 2, "Last file should have #{count - 2} links")
+
+    hook('remove', '--all', '--force', files[-1])
+
+    assert_count_links(files[-1], 0, "Last file should end with 0 links")
+  end
+end

data/test/hook_scripts_test.rb

@@ -0,0 +1,21 @@
+require 'hook-helpers'
+require 'test_helper'
+
+class EncodeTest < Test::Unit::TestCase
+  include HookHelpers
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_shell_scripts
+    %w[bash fish zsh].each do |sh|
+      source = IO.read(File.join(HOOK_COMPLETIONS_DIR, 'hook_completion.' + sh))
+      result = hook('scripts', sh)
+    
+      assert_match(source, result, 'Script output should match')
+    end
+  end
+end