bunchcli 1.0.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '064668e5dae28ec08fe4a939dc270e9b1880116f68f8ad39fc3c2252cd7609fa'
-  data.tar.gz: be7be6b0cf5404ae193aec36d50b4efa4b6672b03be4e875f60cd89fcf3a07b9
+  metadata.gz: c85d1416d51d972ef7c577b1f143b2b646e9fcd4bb1871253b6ed5f98c5bbb4c
+  data.tar.gz: 5986ff8fdd90521530e7b10c5a151eb0144074fdbed534f869ca03345f8f1988
 SHA512:
-  metadata.gz: 59abf612ddfe2eff6f5b54bf7952e08f67cad5bc7c2ec06ca9eb6d15aa097798c6bfaf6686292041fba6dd4fd34e3dc013ef3ffdff60c271a85b0fa99b64b144
-  data.tar.gz: e888ed65aef4791420808cc5220f275c9e3c9c618ba931d273f4b118f3ffdcecb978b641e298ba0d18024758977ba3e883095daca71859af25e381291f903ce9
+  metadata.gz: d93fa5c16bc0e49dd24ead5c7d33ba786024e115b71c290142afc520118fc99a601de1bb0b35205aa102317a1a9af430f16d379ff803816ebe92c4fef4ad72af
+  data.tar.gz: 24bb5364188045b58253836044a9980ff1e99adb716841c5af206b08074467eb154a7e29484ad7f311528037eb61463711be43dcdcc7a9d873727670d802a057

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 1.1.4
+
+- Add `--show-config-key KEY` query for specific keys (dir, toggle, method)
+
+### 1.1.3
+
+- Add --prefs option
+
+### 1.1.2
+
+- Allow app name in x-success if bundle id can't be found
+
+### 1.1
+
+- Add interactive URL builder
+- Snippet handling
+
 ### 1.0
 
 - Initial release

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    bunchcli (1.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  bunchcli!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.2.4

data/README.md

@@ -10,14 +10,21 @@ A CLI for [Bunch.app](https://brettterpstra.com/projects/bunch).
 
     $ bunch -h  
     CLI for Bunch.app
-    -h, --help                       Display this screen
-    -f, --force-refresh              Force refresh cached preferences
     -l, --list                       List available Bunches
+    -s, --show BUNCH                 Show contents of Bunch
     -o, --open                       Open Bunch ignoring "Toggle Bunches" preference
     -c, --close                      Close Bunch ignoring "Toggle Bunches" preference
     -t, --toggle                     Toggle Bunch ignoring "Toggle Bunches" preference
-    -s, --show BUNCH                 Show contents of Bunch
+        --snippet                    Load as snippet
+        --fragment=FRAGMENT          Run a specific section
+        --vars=VARS                  Variables to pass to a snippet, comma-separated
+        --pref                       Set a preference. Run without argument to list available preferences.
+    -u, --url                        Output URL instead of opening
+    -i, --interactive                Interactively generate a Bunch url
         --show-config                Display configuration values
+    -f, --force-refresh              Force refresh cached preferences
+    -h, --help                       Display this screen
+    -v, --version                    Display Bunch version
 
 Usage: `bunch [options] BUNCH_NAME|PATH_TO_FILE`
 

data/bin/bunch

@@ -6,25 +6,25 @@ require 'bunch'
 def help
   puts "\nUsage: #{File.basename(__FILE__)} [options] BUNCH_NAME|PATH_TO_FILE"
   puts "\nBunch names are case insensitive and will execute first match"
+  puts "Use 'bunch -h' to display options"
+end
+
+def version
+  puts "Bunch CLI v#{BunchCLI::VERSION}"
 end
 
 bunch = Bunch.new
 
 optparse = OptionParser.new do |opts|
-  opts.banner = 'CLI for Bunch.app'
+  opts.banner = "CLI for Bunch.app v#{BunchCLI::VERSION}"
 
-  opts.on('-h', '--help', 'Display this screen') do |_opt|
-    puts opts
-    help
+  opts.on('-l', '--list', 'List available Bunches') do |_opt|
+    bunch.list_bunches
     Process.exit 0
   end
 
-  opts.on('-f', '--force-refresh', 'Force refresh cached preferences') do |opt|
-    bunch.update_cache
-  end
-
-  opts.on('-l', '--list', 'List available Bunches') do |_opt|
-    bunch.list_bunches
+  opts.on('-s', '--show BUNCH', 'Show contents of Bunch') do |opt|
+    bunch.show(opt)
     Process.exit 0
   end
 
@@ -40,15 +40,55 @@ optparse = OptionParser.new do |opts|
     bunch.url_method = 'toggle'
   end
 
-  opts.on('-s', '--show BUNCH', 'Show contents of Bunch') do |opt|
-    bunch.show(opt)
+  opts.on('--snippet', 'Load as snippet') do |opt|
+    bunch.url_method = 'snippet'
+  end
+
+  opts.on('--fragment=FRAGMENT', 'Run a specific section') do |opt|
+    bunch.fragment = opt
+  end
+
+  opts.on('--vars=VARS', 'Variables to pass to a snippet, comma-separated') do |opt|
+    bunch.variables = opt
+  end
+
+  opts.on('--pref', 'Set a preference. Run without argument to list available preferences.') do |opt|
+    bunch.url_method = 'setPref'
+  end
+
+  opts.on('-u', '--url', 'Output URL instead of opening') do |_opt|
+    bunch.show_url = true
+  end
+
+  opts.on('-i','--interactive', 'Interactively generate a Bunch url') do |opt|
+    BunchURLGenerator.new.generate
     Process.exit 0
   end
 
-  opts.on('--show-config', 'Display configuration values') do |opt|
+  opts.on('--show-config', 'Display all configuration values') do |opt|
     bunch.show_config
     Process.exit 0
   end
+
+  opts.on('--show-config-key KEY', 'Display a config value [dir, toggle, method]') do |opt|
+    bunch.show_config(opt)
+    Process.exit 0
+  end
+
+  opts.on('-f', '--force-refresh', 'Force refresh cached preferences') do |opt|
+    bunch.update_cache
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do |_opt|
+    puts opts
+    help
+    Process.exit 0
+  end
+
+  opts.on('-v', '--version', 'Display Bunch version') do |_opt|
+    version
+    Process.exit 0
+  end
 end
 
 optparse.parse!
@@ -57,6 +97,8 @@ unless ARGV.length > 0
   if STDIN.stat.size > 0
     bunch.url_method = 'raw'
     bunch.open(CGI.escape(STDIN.read))
+  elsif bunch.url_method == 'setPref'
+    bunch.list_preferences
   else
     puts "CLI for Bunches.app"
     help

data/lib/bunch.rb

@@ -4,4 +4,5 @@ CACHE_FILE = "~/.bunch_cli_cache"
 require "bunch/version"
 require 'yaml'
 require 'cgi'
+require 'bunch/url_generator'
 require 'bunch/bunchCLI'

data/lib/bunch/bunchCLI.rb

@@ -1,13 +1,26 @@
 class Bunch
-  attr_writer :url_method
+  include Util
+  attr_writer :url_method, :fragment, :variables, :show_url
 
   def initialize
     @bunch_dir = nil
     @url_method = nil
     @bunches = nil
+    @fragment = nil
+    @variables = nil
+    @success = nil
+    @show_url = false
     get_cache
   end
 
+  def launch_if_needed
+    pid = `ps ax | grep 'MacOS/Bunch'|grep -v grep`.strip
+    if pid == ""
+      `open -a Bunch`
+      sleep 2
+    end
+  end
+
   def update_cache
     @bunch_dir = nil
     @url_method = nil
@@ -41,6 +54,18 @@ class Bunch
     @bunches = settings['bunches'] || generate_bunch_list
   end
 
+  def variable_query
+    vars = @variables.split(/,/).map { |v| v.strip }
+    query = []
+    vars.each { |v|
+      parts = v.split(/=/).map { |v| v.strip }
+      k = parts[0]
+      v = parts[1]
+      query << "#{k}=#{CGI.escape(v)}"
+    }
+    query
+  end
+
   # items.push({title: 0})
   def generate_bunch_list
     items = []
@@ -69,12 +94,17 @@ class Bunch
   end
 
   def url(bunch)
+    params = "&x-success=#{@success}" if @success
     if url_method == 'file'
-      %(x-bunch://raw?file=#{bunch})
+      %(x-bunch://raw?file=#{bunch}#{params})
     elsif url_method == 'raw'
-      %(x-bunch://raw?txt=#{bunch})
+      %(x-bunch://raw?txt=#{bunch}#{params})
+    elsif url_method == 'snippet'
+      %(x-bunch://snippet?file=#{bunch}#{params})
+    elsif url_method == 'setPref'
+      %(x-bunch://setPref?#{bunch})
     else
-      %(x-bunch://#{url_method}?bunch=#{bunch[:title]})
+      %(x-bunch://#{url_method}?bunch=#{bunch[:title]}#{params})
     end
   end
 
@@ -104,31 +134,83 @@ class Bunch
     (url_method.gsub(/e$/, '') + 'ing').capitalize
   end
 
+  def list_preferences
+    prefs =<<EOF
+toggleBunches=[0,1]        Allow Bunches to be both opened and closed
+configDir=[path]           Absolute path to Bunches folder
+singleBunchMode=[0,1]      Close open Bunch when opening new one
+preserveOpenBunches=[0,1]  Restore Open Bunches on Launch
+debugLevel=[0-4]           Set the logging level for the Bunch Log
+EOF
+    puts prefs
+  end
+
+
   def open(str)
+    launch_if_needed
     # get front app
     front_app = %x{osascript -e 'tell application "System Events" to return name of first application process whose frontmost is true'}.strip
+    bid = bundle_id(front_app)
+    @success = bid if (bid)
+
     if @url_method == 'raw'
       warn 'Running raw string'
-      `open '#{url(str)}'`
+      if @show_url
+        $stdout.puts url(str)
+      else
+        `open '#{url(str)}'`
+      end
+    elsif @url_method == 'snippet'
+      _url = url(str)
+      params = []
+      params << "fragment=#{CGI.escape(@fragment)}" if @fragment
+      params.concat(variable_query) if @variables
+      _url += '&' + params.join('&')
+      if @show_url
+        $stdout.puts _url
+      else
+        warn "Opening snippet"
+        `open '#{_url}'`
+      end
+    elsif @url_method == 'setPref'
+      if str =~ /^(\w+)=([^= ]+)$/
+        _url = url(str)
+        if @show_url
+          $stdout.puts _url
+        else
+          warn "Setting preference #{str}"
+          `open '#{_url}'`
+        end
+      else
+        warn "Invalid key=value pair"
+        Process.exit 1
+      end
     else
       bunch = find_bunch(str)
       unless bunch
         if File.exists?(str)
           @url_method = 'file'
-          warn "Opening file"
-          `open '#{url(str)}'`
+          if @show_url
+            $stdout.puts url(str)
+          else
+            warn "Opening file"
+            `open '#{url(str)}'`
+          end
         else
           warn 'No matching Bunch found'
           Process.exit 1
         end
       else
-        warn "#{human_action} #{bunch[:title]}"
-
-        `open "#{url(bunch)}"`
+        if @show_url
+          $stdout.puts url(str)
+        else
+          warn "#{human_action} #{bunch[:title]}"
+          `open '#{url(bunch)}'`
+        end
       end
     end
     # attempt to restore front app
-    %x{osascript -e 'delay 2' -e 'tell application "#{front_app}" to activate'}
+    # %x{osascript -e 'delay 2' -e 'tell application "#{front_app}" to activate'}
   end
 
   def show(str)
@@ -137,12 +219,21 @@ class Bunch
     puts output
   end
 
-  def show_config
-    puts "Bunches Folder: #{bunch_dir}"
-    puts "Default URL Method: #{url_method}"
-    puts "Cached Bunches"
-    bunches.each {|b|
-      puts "    - #{b[:title]}"
-    }
+  def show_config(key=nil)
+    case key
+    when /(folder|dir)/
+      puts bunch_dir
+    when /toggle/
+      puts url_method == 'toggle' ? 'true' : 'false'
+    when /method/
+      puts url_method
+    else
+      puts "Bunches Folder: #{bunch_dir}"
+      puts "Default URL Method: #{url_method}"
+      puts "Cached Bunches"
+      bunches.each {|b|
+        puts "    - #{b[:title]}"
+      }
+    end
   end
 end

data/lib/bunch/url_generator.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+require 'readline'
+require 'cgi'
+
+# String additions
+class String
+  def text?
+    res = `file "#{self}"`
+    res =~ /text/
+  end
+end
+
+# misc utils
+module Util
+  def bundle_id(app)
+    shortname = app.sub(/\.app$/, '')
+    apps = `mdfind -onlyin /Applications -onlyin /Applications/Setapp -onlyin /Applications/Utilities -onlyin ~/Applications -onlyin /Developer/Applications 'kMDItemKind==Application'`
+
+    foundapp = apps.split(/\n/).select! { |line| line.chomp =~ /#{shortname}\.app$/i }[0]
+
+    if foundapp
+      bid = `mdls -name kMDItemCFBundleIdentifier -r "#{foundapp}"`.chomp
+    else
+      # warn "Could not locate bundle id for #{shortname}, using provided app name"
+      bid = app
+    end
+    bid
+  end
+end
+
+# CLI Prompt utilities
+module Prompt
+  def choose_number(query = '->', max)
+    stty_save = `stty -g`.chomp
+    sel = nil
+    begin
+      while !sel =~ /^\d+$/ || sel.to_i <= 0 || sel.to_i > max
+        sel = Readline.readline("#{query}", true)
+        return nil if sel =~ /^\s*$/
+      end
+    rescue Interrupt
+      system('stty', stty_save) # Restore
+      exit
+    end
+    sel ? sel.to_i : nil
+  end
+
+  def get_line(query = '->')
+    stty_save = `stty -g`.chomp
+    begin
+      line = Readline.readline("#{query}: ", true)
+    rescue Interrupt
+      system('stty', stty_save) # Restore
+      exit
+    end
+    line.chomp
+  end
+
+  def get_text(query = 'Enter text, ^d to end')
+    stty_save = `stty -g`.chomp
+    lines = []
+    puts query
+    begin
+      while (line = Readline.readline)
+        lines << line
+      end
+    rescue Interrupt
+      system('stty', stty_save) # Restore
+      exit
+    end
+    lines.join("\n").chomp
+  end
+
+  def url_encode_text
+    text = get_text
+    puts
+    CGI.escape(text)
+  end
+end
+
+# Single menu item
+class MenuItem
+  attr_accessor :id, :title, :value
+
+  def initialize(id, title, value)
+    @id = id
+    @title = title
+    @value = value
+  end
+end
+
+# Collection of menu items
+class Menu
+  include Prompt
+  attr_accessor :items
+
+  def initialize(items)
+    @items = items
+  end
+
+  def choose(query = 'Select an item')
+    throw 'No items initialized' if @items.nil?
+    STDERR.puts
+    STDERR.puts "┌#{("─" * 74)}┐"
+    intpad = Math::log10(@items.length).to_i + 1
+    @items.each_with_index do |item, idx|
+      idxstr = "%#{intpad}d" % (idx + 1)
+      line = "#{idxstr}: #{item.title}"
+      pad = 74 - line.length
+      STDERR.puts "│#{line}#{" " * pad}│"
+    end
+    STDERR.puts "└┤ #{query} ├#{"─" * (70 - query.length)}┘"
+    sel = choose_number("> ", @items.length)
+    sel ? @items[sel.to_i - 1] : nil
+  end
+end
+
+class Snippet
+  attr_accessor :fragments, :contents
+
+  def initialize(file)
+    if File.exist?(File.expand_path(file))
+      @contents = IO.read(File.expand_path(file))
+      @fragments = fragments
+    else
+      throw ('Tried to initialize snippet with invalid file')
+    end
+  end
+
+  def fragments
+    rx = /(?i-m)(?:[-#]+)\[([\s\S]*?)\][-# ]*\n([\s\S]*?)(?=\n(?:-+\[|#+\[|$))/
+    matches = @contents.scan(rx)
+    fragments = {}
+    matches.each do |m|
+      key = m[0]
+      value = m[1]
+
+      fragments[key] = value
+    end
+    fragments
+  end
+
+  def choose_fragment
+    unless @fragments.empty?
+      items = []
+      @fragments.each { |k, v| items << MenuItem.new(k, k, v) }
+      menu = Menu.new(items)
+      return menu.choose('Select fragment')
+    end
+    nil
+  end
+end
+
+# File search functions
+class BunchFinder
+  include Prompt
+  attr_accessor :config_dir
+
+  def initialize
+    config_dir = `defaults read com.brettterpstra.bunch configDir`.strip
+    config_dir = File.expand_path(config_dir)
+    if File.directory?(config_dir)
+      @config_dir = config_dir
+    else
+      throw 'Unable to retrieve Bunches Folder'
+    end
+  end
+
+  def files_to_items(dir, pattern)
+    Dir.chdir(dir)
+    items = []
+    Dir.glob(pattern) do |f|
+      if f.text?
+        filename = File.basename(f)
+        items << MenuItem.new(filename, filename, filename)
+      end
+    end
+    items
+  end
+
+  def choose_bunch
+    items = files_to_items(@config_dir, '*.bunch')
+    items.map! do |item|
+      item.title = File.basename(item.title, '.bunch')
+      item.value = File.basename(item.title, '.bunch')
+      item
+    end
+    menu = Menu.new(items)
+    menu.choose('Select a Bunch')
+  end
+
+  def choose_snippet
+    items = files_to_items(@config_dir, '*')
+    menu = Menu.new(items)
+    menu.choose('Select a Snippet')
+  end
+
+  def expand_path(file)
+    File.join(@config_dir, file)
+  end
+
+  def contents(snippet)
+    IO.read(File.join(@config_dir, snippet))
+  end
+
+  def variables(content)
+    matches = content.scan(/\$\{(\S+)(:.*?)?\}/)
+    variables = []
+    matches.each { |m| variables << m[0].sub(/:\S+$/, '') }
+    variables.uniq
+  end
+
+  def fill_variables(text)
+    vars = variables(text)
+    output = []
+    unless vars.empty?
+      puts 'Enter values for variables'
+      vars.each do |var|
+        res = get_line(var)
+        output << [var, CGI.escape(res)] unless res.empty?
+      end
+    end
+    output
+  end
+end
+
+class BunchURLGenerator
+  include Prompt
+  include Util
+
+  def generate
+    menu_items = [
+      MenuItem.new('open', 'Open a Bunch', 'open'),
+      MenuItem.new('close', 'Close a Bunch', 'close'),
+      MenuItem.new('toggle', 'Toggle a Bunch', 'toggle'),
+      MenuItem.new('snippet', 'Load a Snippet', 'snippet'),
+      MenuItem.new('raw', 'Load raw text', 'raw')
+    ]
+
+    menu = Menu.new(menu_items)
+    finder = BunchFinder.new
+
+    selection = menu.choose
+    Process.exit 0 unless selection
+    url = "x-bunch://#{selection.value}"
+    parameters = []
+    case selection.id
+    when /(open|close|toggle)/
+      parameters << ['bunch', CGI.escape(finder.choose_bunch.value)]
+    when /snippet/
+      filename = finder.choose_snippet.value
+      parameters << ['file', filename]
+      filename = finder.expand_path(filename)
+      snippet = Snippet.new(filename)
+      fragment = snippet.choose_fragment
+      if fragment
+        parameters << ['fragment', CGI.escape(fragment.title)]
+        contents = fragment.value
+      else
+        contents = snippet.contents
+      end
+      variables = finder.fill_variables(contents)
+      parameters.concat(variables) if variables.length
+    when /raw/
+      parameters << ['text', menu.url_encode_text]
+    else
+      Process.exit 0
+    end
+
+    menu.items = [
+      MenuItem.new('app', 'Application', 'find_bid'),
+      MenuItem.new('url', 'URL', 'get_line(')
+    ]
+
+    selection = menu.choose('Add success action? (Enter to skip)')
+
+    if selection
+      case selection.id
+      when /app/
+        app = get_line('Application name')
+        value = bundle_id(app)
+      when /url/
+        value = get_line('URL')
+      end
+
+      parameters << ['x-success', value] if value
+
+      delay = get_line('Delay for success action')
+      parameters << ['x-delay', delay.to_s] if delay =~ /^\d+$/
+    end
+
+    query_string = parameters.map { |param| "#{param[0]}=#{param[1]}" }.join('&')
+
+    puts url + '?' + query_string
+  end
+end

data/lib/bunch/version.rb

@@ -1,3 +1,3 @@
 module BunchCLI
-  VERSION = "1.0.0"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunchcli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.4
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-19 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -21,6 +21,7 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -28,6 +29,7 @@ files:
 - bunchcli.gemspec
 - lib/bunch.rb
 - lib/bunch/bunchCLI.rb
+- lib/bunch/url_generator.rb
 - lib/bunch/version.rb
 homepage: https://brettterpstra.com/projects/bunch
 licenses: