hookapp 2.0.5 → 2.0.9

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/prompt.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Hook
+  module PromptSTD
+    ##
+    ## Clear the terminal screen
+    ##
+    def clear_screen(msg = nil)
+      puts "\e[H\e[2J" if $stdout.tty?
+      puts msg if msg.good?
+    end
+
+    ##
+    ## Redirect STDOUT and STDERR to /dev/null or file
+    ##
+    ## @param      file  [String] a file path to redirect to
+    ##
+    def silence_std(file = '/dev/null')
+      $stdout = File.new(file, 'w')
+      $stderr = File.new(file, 'w')
+    end
+
+    ##
+    ## Restore silenced STDOUT and STDERR
+    ##
+    def restore_std
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+  end
+
+  # Methods for working installing/using FuzzyFileFinder
+  module PromptFZF
+    ##
+    ## Get path to fzf binary, installing if needed
+    ##
+    ## @return     [String] Path to fzf binary
+    ##
+    def fzf
+      @fzf ||= install_fzf
+    end
+
+    ##
+    ## Remove fzf binary
+    ##
+    def uninstall_fzf
+      fzf_bin = File.join(File.dirname(__FILE__), '../helpers/fzf/bin/fzf')
+      FileUtils.rm_f(fzf_bin) if File.exist?(fzf_bin)
+      warn 'fzf: removed #{fzf_bin}'
+    end
+
+    ##
+    ## Return the path to the fzf binary
+    ##
+    ## @return     [String] Path to fzf
+    ##
+    def which_fzf
+      fzf_dir = File.join(File.dirname(__FILE__), '../helpers/fzf')
+      fzf_bin = File.join(fzf_dir, 'bin/fzf')
+      return fzf_bin if File.exist?(fzf_bin)
+
+      TTY::Which.which('fzf')
+    end
+
+    ##
+    ## Install fzf on the current system. Installs to a
+    ## subdirectory of the gem
+    ##
+    ## @param      force  [Boolean] If true, reinstall if
+    ##                    needed
+    ##
+    ## @return     [String] Path to fzf binary
+    ##
+    def install_fzf(force: false)
+      if force
+        uninstall_fzf
+      elsif which_fzf
+        return which_fzf
+      end
+
+      fzf_dir = File.join(File.dirname(__FILE__), '../helpers/fzf')
+      FileUtils.mkdir_p(fzf_dir) unless File.directory?(fzf_dir)
+      fzf_bin = File.join(fzf_dir, 'bin/fzf')
+      return fzf_bin if File.exist?(fzf_bin)
+
+      warn 'fzf: Compiling and installing fzf -- this will only happen once'
+      warn 'fzf: fzf is copyright Junegunn Choi, MIT License <https://github.com/junegunn/fzf/blob/master/LICENSE>'
+
+      silence_std
+      `'#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null`
+      unless File.exist?(fzf_bin)
+        restore_std
+        warn 'Error installing, trying again as root'
+        silence_std
+        `sudo '#{fzf_dir}/install' --bin --no-key-bindings --no-completion --no-update-rc --no-bash --no-zsh --no-fish &> /dev/null`
+      end
+      restore_std
+      unless File.exist?(fzf_bin)
+        puts 'fzf: unable to install fzf. You can install manually and Hook CLI will use the system version.'
+        puts 'fzf: see https://github.com/junegunn/fzf#installation'
+        raise RuntimeError.new('Error installing fzf, please report at https://github.com/ttscoff/hookapp/issues')
+      end
+
+      warn "fzf: installed to #{fzf}"
+      fzf_bin
+    end
+  end
+
+  module Prompt
+    include PromptSTD
+    include PromptFZF
+  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.9'
 end

data/lib/hook.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'hook/version'
+require 'tty-which'
 require 'shellwords'
 require 'cgi'
 require 'gli'
+require 'hook/prompt'
 require 'hook/string'
 require 'hook/hookapp'
 require 'hook/hooker'

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).sub(/\./, '(%2E|\.)')}$/, 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,40 @@
+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")
+    # I think hook behavior with multi-file linking has changed...
+    # 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.5
+  version: 2.0.9
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-18 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -66,6 +66,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.20.1
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description:
 email: me@brettterpstra.com
 executables:
@@ -76,9 +96,11 @@ extra_rdoc_files:
 - hook.rdoc
 files:
 - ".gitignore"
+- AUTHORS.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - LICENSE.md
 - OVERVIEW.md
 - README.md
@@ -148,26 +170,21 @@ files:
 - lib/completion/hook_completion.bash
 - lib/completion/hook_completion.fish
 - lib/completion/hook_completion.zsh
-- lib/helpers/fuzzyfilefinder
 - lib/hook.rb
 - lib/hook/hookapp.rb
 - lib/hook/hooker.rb
 - lib/hook/markdown_document_listener.rb
+- lib/hook/prompt.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: []

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