hookapp 2.0.3 → 2.0.8

data/lib/hook/hookapp.rb

@@ -3,7 +3,7 @@
 require 'shellwords'
 require 'uri'
 # Hook.app functions
-module HookApp
+class HookApp
   # Create a single regex for validation of an
   # array by first char or full match.
   def format_regex(options)
@@ -171,9 +171,9 @@ module 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
 
@@ -233,7 +233,8 @@ module HookApp
     raise "Error processing available hooks" if options.empty?
 
     args = ['--layout=reverse-list',
-            '--header="esc: cancel, tab: multi-select, return: open > "',
+            '--header="esc: cancel, tab: multi-select, ctrl-a: select all, return: open"',
+            '--bind ctrl-a:select-all',
             '--prompt="  Select hooks > "',
             '--multi',
             '--tabstop=4',
@@ -246,16 +247,12 @@ module HookApp
     fzf = File.join(File.dirname(__FILE__), '../helpers/fuzzyfilefinder')
 
     sel = `echo #{Shellwords.escape(options.join("\n"))} | '#{fzf}' #{args.join(' ')}`.chomp
-    res = sel.split(/\n/).map { |s|
+    res = sel.split(/\n/).map do |s|
       ps = s.split(/\t/)
       { name: ps[0], path: ps[1], url: ps[2] }
-    }
-
-    if res.size == 0
-      raise 'Cancelled (empty response)'
     end
 
-    res
+    res || []
   end
 
   # Open the Hook GUI for browsing/performing actions on a file or url
@@ -281,9 +278,11 @@ module HookApp
       warn "No hooks found for #{url}"
     else
       res = select_hook(marks)
-      res.each {|mark|
-        `open '#{mark[:url]}'`
-      }
+      unless res.empty?
+        res.each {|mark|
+          `open '#{mark[:url]}'`
+        }
+      end
     end
   end
 
@@ -334,10 +333,13 @@ module 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 +362,7 @@ module 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 +433,7 @@ module 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 +481,27 @@ module 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/hooker.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 # Hook.app CLI interface
-class Hooker
-  include HookApp
+class Hooker < HookApp
+  def initialize
+    super
+    warn "Using Hooker class is deprecated, update to use HookApp instead"
+  end
 end

data/lib/hook/markdown_document_listener.rb

@@ -15,6 +15,7 @@ module GLI
         @io = File.new('README.md', 'w')
         @nest = '#'
         @arg_name_formatter = GLI::Commands::HelpModules::ArgNameFormatter.new
+        @parent_command = []
       end
 
       def beginning
@@ -26,6 +27,12 @@ module GLI
           @io.puts IO.read('CREDITS.md')
           @io.puts
         end
+
+        if File.exist?('AUTHORS.md')
+          @io.puts IO.read('AUTHORS.md')
+          @io.puts
+        end
+
         if File.exist?('LICENSE.md')
           @io.puts IO.read('LICENSE.md')
           @io.puts
@@ -89,7 +96,7 @@ module GLI
           name = "[no-]#{name}" if name.to_s.length > 1
           aliases = aliases.map { |_|  _.to_s.length > 1 ? "[no-]#{_}" : _ }
         end
-        invocations = ([name] + aliases).map { |_| "`" + add_dashes(_) + "`" }.join('|')
+        invocations = ([name] + aliases).map { |_| "`" + add_dashes(_).strip + "`" }.join('|')
         @io.puts header("#{invocations}", 2)
         @io.puts
         @io.puts String(desc).strip
@@ -109,8 +116,10 @@ module GLI
 
       # Gives you a command in the current context and creates a new context of this command
       def command(name, aliases, desc, long_desc, arg_name, arg_options)
+        @parent_command.push ([name] + aliases).join('|')
         arg_name_fmt = @arg_name_formatter.format(arg_name, arg_options, [])
-        @io.puts header("`$ #{@exe}` <mark>`#{([name] + aliases).join('|')}`</mark> `#{arg_name_fmt}`", 1)
+        arg_name_fmt = " `#{arg_name_fmt.strip}`" if arg_name_fmt
+        @io.puts header("`$ #{@exe}` <mark>`#{@parent_command.join(' ')}`</mark>#{arg_name_fmt}", 1)
         @io.puts
         @io.puts "*#{String(desc).strip}*"
         @io.puts
@@ -121,6 +130,7 @@ module GLI
 
       # Ends a command, and "pops" you back up one context
       def end_command(_name)
+        @parent_command.pop
         decrement_nest
         @io.puts "* * * * * *\n\n" unless @nest.size > 2
       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.3'
+  VERSION = '2.0.8'
 end

data/lib/hook.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'hook/version.rb'
+require 'hook/version'
 require 'shellwords'
 require 'cgi'
-require 'hook/string.rb'
-require 'hook/hookapp.rb'
-require 'hook/hooker.rb'
+require 'gli'
+require 'hook/string'
+require 'hook/hookapp'
+require 'hook/hooker'
 require 'hook/markdown_document_listener'

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 ScriptsTest < 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hookapp
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.8
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.2
+        version: 6.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.2
+        version: 6.3.2
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: 2.20.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: 2.20.1
 description:
 email: me@brettterpstra.com
 executables:
@@ -76,9 +76,11 @@ extra_rdoc_files:
 - hook.rdoc
 files:
 - ".gitignore"
+- AUTHORS.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - LICENSE.md
 - OVERVIEW.md
 - README.md
@@ -155,19 +157,14 @@ files:
 - lib/hook/markdown_document_listener.rb
 - lib/hook/string.rb
 - lib/hook/version.rb
-- test/default_test.rb
-- test/hookfiles/01.test
-- test/hookfiles/02.test
-- test/hookfiles/03.test
-- test/hookfiles/04.test
-- test/hookfiles/05.test
-- test/hookfiles/06.test
-- test/hookfiles/07.test
-- test/hookfiles/08.test
-- test/hookfiles/09.test
-- test/hookfiles/10.test
-- test/hookfiles/11.test
-- test/hookfiles/12.test
+- test/helpers/hook-helpers.rb
+- test/hook_clip_test.rb
+- test/hook_clone_test.rb
+- test/hook_encode_test.rb
+- test/hook_link_test.rb
+- test/hook_list_test.rb
+- test/hook_remove_test.rb
+- test/hook_scripts_test.rb
 - test/test_helper.rb
 homepage: https://brettterpstra.com
 licenses: []
@@ -193,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: A CLI for Hook.app (macOS)

data/test/default_test.rb

@@ -1,14 +0,0 @@
-require 'test_helper'
-
-class DefaultTest < Test::Unit::TestCase
-
-  def setup
-  end
-
-  def teardown
-  end
-
-  def test_the_truth
-    assert true
-  end
-end