hookapp 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69d899b79ca15a4966ce811c6bc083f93a1152f4a6c70611c090dbfc01d6003b
-  data.tar.gz: '066122764283adadf0a9929659d0f9f87b136c2f3b65312a6afda34606aaa5d9'
+  metadata.gz: a875858589f000f0828cf170f68c6b0f13db7f3d2a10965fc08a76ee4fceb848
+  data.tar.gz: f2cff5c74c4dd9599d83faaa0f0723c5106b13f3bcb7c2726c9c750035fdf783
 SHA512:
-  metadata.gz: bebe816553c3b5783a5628ea4e7140f742decc5cb394e64b4d13643ba0493016c0fb9c75b98fecc9d5b069f238e22f8e9b627c282d64d4f5566c1bb39df3a7e4
-  data.tar.gz: 01114bbe9cfb43a1d0d7573c51d041a8027bc1d98e21c96638fd3ce6fd25919d26ae0cdcab121671c09b82be2eb77db2cf462a762f9aaa6350b9a784dbc78b78
+  metadata.gz: 977e7ddc4b1a2d5a99a9d7df21a614439c29cab22bdf1835d7e3ab68d819f7e69b06035a1d6064669dda7fe30f4af1d57d6c553e1bdf3cc8a2d4bebd329f45ce
+  data.tar.gz: 8eb0ee4b2cf9117133b04a0cbc3847f090365adac5b13ee79a38eb3e55e4e28eba5d1d37905ac82a478fa9b3f3d984e95343372706405eb98891281299163bfe

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+#### 0.0.6
+
+- Fix missing variable in clipboard functions
+- Mv `cp` alias to mean `clip` instead of `clone`
+
+#### 0.0.5
+
+- `hook from APP_NAME` command
+- General code cleanup
+
+#### 0.0.4
+
+- Fix "conversion of nil into string" error
+
+#### 0.0.3
+
+- Fix to handle all url types, not just hook: and http:
+

data/Gemfile.lock

@@ -1,12 +1,18 @@
 PATH
   remote: .
   specs:
-    hookapp (0.0.2)
+    hookapp (0.0.7)
       gli (= 2.19.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     aruba (0.14.14)
       childprocess (>= 0.6.3, < 4.0.0)
       contracts (~> 0.9)
@@ -14,48 +20,76 @@ GEM
       ffi (~> 1.9)
       rspec-expectations (>= 2.99)
       thor (>= 0.19, < 2.0)
-    backports (3.17.0)
     builder (3.2.4)
     childprocess (3.0.0)
+    concurrent-ruby (1.1.6)
     contracts (0.16.0)
-    cucumber (3.1.2)
-      builder (>= 2.1.2)
-      cucumber-core (~> 3.2.0)
-      cucumber-expressions (~> 6.0.1)
-      cucumber-wire (~> 0.0.1)
-      diff-lcs (~> 1.3)
-      gherkin (~> 5.1.0)
-      multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.2)
-    cucumber-core (3.2.1)
-      backports (>= 3.8.0)
-      cucumber-tag_expressions (~> 1.1.0)
-      gherkin (~> 5.0)
-    cucumber-expressions (6.0.1)
-    cucumber-tag_expressions (1.1.1)
-    cucumber-wire (0.0.1)
+    cucumber (4.1.0)
+      builder (~> 3.2, >= 3.2.3)
+      cucumber-core (~> 7.1, >= 7.1.0)
+      cucumber-create-meta (~> 1.0.0, >= 1.0.0)
+      cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
+      cucumber-gherkin (~> 14.0, >= 14.0.1)
+      cucumber-html-formatter (~> 7.0, >= 7.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      cucumber-wire (~> 3.1, >= 3.1.0)
+      diff-lcs (~> 1.3, >= 1.3, < 1.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.0, >= 1.0.2)
+    cucumber-core (7.1.0)
+      cucumber-gherkin (~> 14.0, >= 14.0.1)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (1.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.2.1)
+    cucumber-gherkin (14.0.1)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+    cucumber-html-formatter (7.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+    cucumber-messages (12.2.0)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (3.1.0)
+      cucumber-core (~> 7.1, >= 7.1.0)
+      cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
     diff-lcs (1.3)
-    ffi (1.12.2)
-    gherkin (5.1.0)
+    ffi (1.13.1)
     gli (2.19.0)
-    multi_json (1.14.1)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    middleware (0.1.0)
+    minitest (5.14.1)
     multi_test (0.1.2)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
     rake (13.0.1)
-    rdoc (6.2.0)
-    rspec-expectations (3.9.0)
+    rdoc (6.1.2)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
+    sys-uname (1.2.1)
+      ffi (>= 1.0.0)
     thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba
+  aruba (~> 0.14.14)
   hookapp!
-  rake
-  rdoc
+  rake (~> 13.0.1)
+  rdoc (~> 6.1.2)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -4,11 +4,13 @@ A CLI for Hook.app on macOS.
 
 ## Installation
 
-`gem install hookapp`
+`gem install hookapp`. 
+
+If you're on a stock Ruby install (i.e. have never installed `rvm` or `rbenv`), you may need sudo and your system password: `sudo gem install hookapp`.
 
 ## Usage
 
-Run `hook help` for usage:
+Run `hook help` for usage.
 
 	NAME
 	    hook - CLI interface for Hook.app (macOS)
@@ -24,8 +26,9 @@ Run `hook help` for usage:
 	    --version - Display the program version
 
     COMMANDS
-        clip       - Copy Hook URL for file/url to clipboard
-        clone, cp  - Clone all hooks from one file or url onto another
+        clip, cp   - Copy Hook URL for file/url to clipboard
+        clone      - Clone all hooks from one file or url onto another
+        from       - Get a Hook URL for the frontmost window of an app
         help       - Shows a list of commands or help for one command
         link, ln   - Create bidirectional hooks between two or more files/urls
         list, ls   - List hooks on a file or url
@@ -41,8 +44,25 @@ Run `hook help COMMAND` on any of the commands for more details.
 
 The `link` command always creates bidirectional hooks. Give it two or more files or urls and it will create links between them. By default it links all files to the last file in the list. Add the `--all` flag to link all files to every other file in the list. This can be abbreviated as `hook ln -a file1.md file2.pdf "https://brettterpstra.com"`.
 
-### Listing and opening hooked files/URLs
+Similar to the way you would use the GUI, you can use `hook clip file1.md` to copy a Hook URL to the clipboard (aliased as `cp`), and then use `hook ln -p file2.pdf` to create a link from the clipboard to `file2.pdf`.
+
+You can also clone all of the links on one file to another, great for adding a new file to a group that's fully crosslinked. Just use `hook clone file1.md file2.pdf`.
+
+### Listing hooks
 
 Use the `list` (aliased as `ls`) command to list all attached hooks for a file. With no output format specified, `ls` will show the paths to all hooks, or the hook url if the hook doesn't have a file path (e.g. a URL). You can specify an output format using `--output_format` (abbreviated as `-o`) with one of "markdown", "hooks", "paths", or "verbose". Formats can be abbreviated to their first letter, so to display a Markdown list of all hooked files, use `hook ls -o m file1.md`.
 
-You can select a hook from a menu using `hook select file1.md`, and the resulting selection will be opened in the default application for its filetype.
+### Removing hooks
+
+Use `hook remove file1.md file2.pdf` to remove the bidirectional link between `file1.md` and `file2.pdf`. Add the `--all` flag (abbr. `-a`) with one or more files to remove ALL the hooks on them. This option requires confirmation.
+
+#### Super nerdy scripting trick
+
+The `--output_format=paths` option (abbr. `-o p`) combined with the `--files_only` flag (abbr. `-f`) will list just the paths and only include hooks that have file paths (i.e. exclude web, email, and other URLs). This can be combined with `--null` to output the list using a NULL separator, perfect for use with `xargs` or other command line tools.
+
+### Acting on hooks
+
+You can open a hooked file or URL by running `hook select file1.md`. This will display a menu of all the hooks on `file1.md`, and entering the number of a selection will open that file in its default application.
+
+You can also open a file in the Hook GUI using `hook open file1.md`.
+

data/bin/hook

@@ -17,16 +17,8 @@ class App
 
   hooker = nil
 
-  # desc 'Describe some switch here'
-  # switch [:s,:switch]
-
-  # desc 'Describe some flag here'
-  # default_value 'the default'
-  # arg_name 'The name of the argument'
-  # flag [:f,:flagname]
-
   desc 'List hooks on a file or url'
-  arg_name 'FILE_OR_URL [FILE_OR_URL, ...]'
+  arg_name 'FILE_OR_URL [FILE_OR_URL...]'
   command %i[list ls] 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 }
@@ -52,7 +44,7 @@ class App
   end
 
   desc 'Create bidirectional hooks between two or more files/urls'
-  arg_name 'SOURCE [SOURCE, ...] TARGET'
+  arg_name 'SOURCE [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 }
@@ -79,13 +71,37 @@ class App
 
   desc 'Copy Hook URL for file/url to clipboard'
   arg_name 'FILE_OR_URL'
-  command %i[clip] do |c|
+  command %i[clip cp] do |c|
     c.desc 'Copy as Markdown'
-    c.switch %i[m markdown]
+    c.switch %i[m markdown], { negatable: false, default_value: false }
+
+    c.desc 'Copy from application'
+    c.flag %i[a app], { arg_name: 'APP_NAME' }
 
     c.action do |_global_options, options, args|
-      result = hooker.copy_bookmark(args[0], { markdown: options[:m] })
-      puts result
+      raise 'Wrong number of arguments. Requires a path/url or -a APP_NAME' if args.length != 1 && !options[:a]
+
+      if options[:a]
+        puts hooker.bookmark_from_app(options[:a], { copy: true, markdown: options[:m] })
+      else
+        puts hooker.clip_bookmark(args[0], { markdown: options[:m] })
+      end
+    end
+  end
+
+  desc 'Get a Hook URL for the frontmost window of an app'
+  arg_name 'APPLICATION_NAME'
+  command %i[from] do |c|
+    c.desc 'Output as Markdown'
+    c.switch %i[m markdown], { negatable: false, default_value: false }
+
+    c.desc 'Copy to clipboard'
+    c.switch %i[c copy], { negatable: false, default_value: false }
+
+    c.action do |_global_options, options, args|
+      raise "Wrong number of arguments (1 expected, #{args.length} given)" if args.length != 1
+
+      puts hooker.bookmark_from_app(args[0], { copy: options[:c], markdown: options[:m] })
     end
   end
 
@@ -103,7 +119,7 @@ class App
 
   desc 'Clone all hooks from one file or url onto another'
   arg_name 'SOURCE TARGET'
-  command %i[clone cp] do |c|
+  command %i[clone] do |c|
     c.action do |_global_options, _options, args|
       raise "Wrong number of arguments. Two file paths or urls required (#{args.length} given)" if args.length != 2
 

data/hook.rdoc

@@ -1,6 +1,6 @@
 == hook - CLI interface for Hook.app (macOS)
 
-v0.0.2
+v0.0.5
 
 === Global Options
 === --help
@@ -14,20 +14,42 @@ Display the program version
 
 
 === Commands
-==== Command: <tt>clip  FILE_OR_URL</tt>
+==== Command: <tt>clip|cp  FILE_OR_URL</tt>
 Copy Hook URL for file/url to clipboard
 
 
 ===== Options
-===== -m|--[no-]markdown
+===== -a|--app APP_NAME
+
+Copy from application
+
+[Default Value] None
+
+
+===== -m|--markdown
 Copy as Markdown
 
 
 
-==== Command: <tt>clone|cp  SOURCE TARGET</tt>
+==== Command: <tt>clone  SOURCE TARGET</tt>
 Clone all hooks from one file or url onto another
 
 
+==== Command: <tt>from  APPLICATION_NAME</tt>
+Get a Hook URL for the frontmost window of an app
+
+
+===== Options
+===== -c|--copy
+Copy to clipboard
+
+
+
+===== -m|--markdown
+Output as Markdown
+
+
+
 ==== Command: <tt>help  command</tt>
 Shows a list of commands or help for one command
 
@@ -38,7 +60,7 @@ List commands one per line, to assist with shell completion
 
 
 
-==== Command: <tt>link|ln  SOURCE [SOURCE, ...] TARGET</tt>
+==== Command: <tt>link|ln  SOURCE [SOURCE...] TARGET</tt>
 Create bidirectional hooks between two or more files/urls
 
 
@@ -53,7 +75,7 @@ Paste URL from clipboard
 
 
 
-==== Command: <tt>list|ls  FILE_OR_URL [FILE_OR_URL, ...]</tt>
+==== Command: <tt>list|ls  FILE_OR_URL [FILE_OR_URL...]</tt>
 List hooks on a file or url
 
 

data/hookapp.gemspec

@@ -15,8 +15,8 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options << '--title' << 'hook' << '--main' << 'README.rdoc' << '-ri'
   s.bindir = 'bin'
   s.executables << 'hook'
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rdoc')
-  s.add_development_dependency('aruba')
+  s.add_development_dependency('rake','~> 13.0.1')
+  s.add_development_dependency('rdoc','~> 6.1.2')
+  s.add_development_dependency('aruba','~> 0.14.14')
   s.add_runtime_dependency('gli','2.19.0')
 end

data/lib/hook/hooker.rb

@@ -18,21 +18,37 @@ class String
   def valid_hook
     if File.exist?(self)
       File.expand_path(self)
-    elsif self =~ /^(hook|http)/
-      self
+    elsif self =~ /^\[.*?\]\((.*?)\)$/
+      mdlink = $1
+      mdlink.valid_hook
     else
-      if self =~ /^\[.*?\]\((.*?)\)$/
-        mdlink = $1
-        mdlink.valid_hook
-      else
-        false
-      end
+      self
     end
   end
 
   def valid_hook!
     replace valid_hook
   end
+
+  # Capitalize only if no uppercase
+  def cap
+    unless self =~ /[A-Z]/
+      capitalize
+    else
+      self
+    end
+  end
+
+  def cap!
+    replace cap
+  end
+
+  def clip
+    res = `/bin/echo -n #{Shellwords.escape(self)} | pbcopy`.strip
+    raise "Failed to copy to clipboard" unless res.empty?
+
+    true
+  end
 end
 
 # Hook.app CLI interface
@@ -42,15 +58,16 @@ class Hooker
   end
 
   def validate_format(fmt, options)
-    valid_format_rx = options.map { |fmt| fmt.sub(/^(.)(.*)$/, '^\1(\2)?$') }
+    valid_format_rx = options.map { |format| format.sub(/^(.)(.*)$/, '^\1(\2)?$') }
     valid_format = false
     valid_format_rx.each_with_index do |rx, i|
       cmp = Regexp.new(rx, 'i')
       next unless fmt =~ cmp
+
       valid_format = options[i]
       break
     end
-    return valid_format
+    valid_format
   end
 
   def bookmark_for(url)
@@ -88,15 +105,39 @@ class Hooker
     hooks.split_hooks
   end
 
-  def copy_bookmark(url, opts)
+  def bookmark_from_app(app, opts)
+    mark = `osascript <<'APPLESCRIPT'
+      tell application "System Events" to set front_app to name of first application process whose frontmost is true
+      tell application "#{app}" to activate
+      delay 2
+      tell application "Hook"
+        set _hook to (bookmark from active window)
+        set _output to (title of _hook & "||" & address of _hook & "||" & path of _hook)
+      end tell
+      tell application front_app to activate
+      return _output
+    APPLESCRIPT`.strip.split_hook
+    title = mark[:name].empty? ? "#{app.cap} link" : mark[:name]
+    output = opts[:markdown] ? "[#{title}](#{mark[:url]})" : mark[:url]
+
+    if opts[:copy]
+      "Copied Markdown link for '#{title}' to clipboard" if output.clip
+    else
+      output
+    end
+  end
+
+  def clip_bookmark(url, opts)
     mark = bookmark_for(url)
-    output = if opts[:markdown]
-               "[#{mark[:name]}](#{mark[:url]})"
-             else
-               mark[:url]
-             end
-    `/bin/echo -n #{Shellwords.escape(output)} | pbcopy`
-    %(Copied #{opts[:markdown] ? 'Markdown link' : 'Hook URL'} for '#{mark[:name]}' to clipboard)
+    copy_bookmark(mark[:name], mark[:url], opts)
+  end
+
+  def copy_bookmark(title, url, opts)
+    raise "No URL found" if url.empty?
+    title = title.empty? ? 'No title' : title
+    output = opts[:markdown] ? "[#{title}](#{url})" : url
+    output.clip
+    %(Copied #{opts[:markdown] ? 'Markdown link' : 'Hook URL'} for '#{title}' to clipboard)
   end
 
   def select_hook(marks)
@@ -106,12 +147,9 @@ class Hooker
     end
     STDERR.print 'Open which bookmark: '
     sel = STDIN.gets.strip.to_i
-    if sel.positive? && sel <= marks.length
-      marks[sel - 1]
-    else
-      warn 'Invalid selection'
-      Process.exit 1
-    end
+    raise 'Invalid selection' unless sel.positive? && sel <= marks.length
+
+    marks[sel - 1]
   end
 
   def open_gui(url)
@@ -218,9 +256,9 @@ class Hooker
           return true
         end tell
       APPLESCRIPT`
-      return "Hook removed between #{source} and #{target}"
+      "Hook removed between #{source} and #{target}"
     else
-      raise "Invalid number of URLs or files specified"
+      raise 'Invalid number of URLs or files specified'
 
     end
   end
@@ -228,9 +266,7 @@ class Hooker
   def link_all(args)
     args.each do |file|
       source = file.valid_hook
-      link_to = args.dup.map(&:valid_url).reject { |url|
-        url == source
-      }
+      link_to = args.dup.map(&:valid_hook).reject { |url| url == source }
       link_to.each do |url|
         `osascript <<'APPLESCRIPT'
           tell application "Hook"

data/lib/hook/version.rb

@@ -1,3 +1,3 @@
 module Hook
-  VERSION = '0.0.2'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: hookapp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Brett Terpstra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.2
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.14
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.19.0
-description: 
+description:
 email: me@brettterpstra.com
 executables:
 - hook
@@ -76,6 +76,7 @@ extra_rdoc_files:
 - hook.rdoc
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -107,7 +108,7 @@ files:
 homepage: https://brettterpstra.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - hook
@@ -128,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A CLI for Hook.app (macOS)
 test_files: []