howzit 2.0.19 → 2.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c08d6ceea211cc4e603a59c5e2f1ac7c2db806d55a8eaa1f260e1f0994bdf45
-  data.tar.gz: c5b6c284c725a8f1edabc07723a18d0e9d9c56204be0b7fb50e0d3bb1b5efccf
+  metadata.gz: 7e00517a83b13075c8af7884b3a5afd683f62008f6ccc8b50015044e7625a6b7
+  data.tar.gz: 1918ceb4965f7a5fe127581c1dd602dfa387d8e310654f5ac7ca643ab5dd4c8d
 SHA512:
-  metadata.gz: 8c456e2c7f820777d6e07a26fcc677bfa8ac09a12bd409e870c37dbaa431f186ac551575b6eead585d446a02b533b5c729eba4dfac40b2caa876ff9f63400c9b
-  data.tar.gz: 03717f2b209cf812b31e5da66ab57000e7e54cd52efa08b8bc7e4c2840e30581509af401e76e8ccef9e5cd0b232d04601eb6d5723b49cc1e6ae3bb7e760bff29
+  metadata.gz: 549952e3e175d9fcd5df9d85400a8abc3279ff76862e172029e974920ba85aa8ef1dfb84fcdbaff94a260a5630f49c462cd58d5a97f359735978c074b9742c2d
+  data.tar.gz: acb315d65c7cb1f9cf3e1ee6ef9044a1f7584b23f4bc1a7d58b39acda4851a62e58d55fe53fa227807c84f01093f3f07c6ad18070ceffda92ba05fe72f137573

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+### 2.0.22
+
+2022-08-08 13:49
+
+#### IMPROVED
+
+- Paginate output of --templates
+
+#### FIXED
+
+- --templates attempting to create new build note
+- Fix handling of paths when the same as note_file
+
+### 2.0.21
+
+2022-08-08 13:16
+
+#### IMPROVED
+
+- Use os-agnostic copy function for --hook
+- Rename link title for --hook
+
+### 2.0.20
+
+2022-08-08 11:38
+
+#### NEW
+
+- --hook command for macOS to copy a link to the build note to clipboard
+
+#### FIXED
+
+- Error on --edit-config
+- Fzf preview empty
+
 ### 2.0.19
 
 2022-08-08 06:18

data/README.md

@@ -1,7 +1,7 @@
 # Howzit
 
 [![Gem](https://img.shields.io/gem/v/howzit.svg)](https://rubygems.org/gems/howzit)
-[![Travis](https://img.shields.io/travis/makenew/ruby-gem.svg)](https://travis-ci.org/makenew/ruby-gem)
+[![Travis](https://api.travis-ci.com/ttscoff/howzit.svg?branch=main)](https://travis-ci.org/makenew/ruby-gem)
 [![GitHub license](https://img.shields.io/github/license/ttscoff/howzit.svg)](./LICENSE.txt)
 
 A command-line reference tool for tracking project build systems

data/bin/howzit

@@ -64,25 +64,27 @@ OptionParser.new do |opts|
   end
 
   opts.on('--templates', 'List available templates') do
+    out = []
     Dir.chdir(Howzit.config.template_folder)
     Dir.glob('*.md').each do |file|
       template = File.basename(file, '.md')
-      puts Howzit::Color.template("{Mk}template:{Yk}#{template}{x}")
-      puts Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}')
+      out.push(Howzit::Color.template("{Mk}template:{Yk}#{template}{x}"))
+      out.push(Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}'))
       metadata = file.extract_metadata
-      topics = Howzit.buildnote.read_file(file)
+      topics = Howzit::BuildNote.new(file: file).topics
       topics.each do |topic|
-        puts Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}")
+        out.push(Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}"))
       end
       unless metadata.empty?
         meta = []
         meta << metadata['required'].split(/\s*,\s*/).map { |m| "*{bw}#{m}{xw}" } if metadata.key?('required')
         meta << metadata['optional'].split(/\s*,\s*/).map(&:to_s) if metadata.key?('optional')
-        puts Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}')
-        puts Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}")
+        out.push(Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}'))
+        out.push(Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}"))
       end
-      puts Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}')
+      out.push(Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}'))
     end
+    Howzit::Util.page out.join("\n")
     Process.exit 0
   end
 
@@ -131,13 +133,15 @@ OptionParser.new do |opts|
     Process.exit 0
   end
 
-  desc = %(Edit buildnotes file in current working directory using editor (#{File.basename(Howzit.options[:config_editor])}))
+  editor = File.basename(Howzit.options[:editor])
+  desc = %(Edit buildnotes file in current working directory using editor (#{editor}))
   opts.on('-e', '--edit', desc) do
     Howzit.buildnote.edit
     Process.exit 0
   end
 
-  opts.on('--edit-config', "Edit configuration file using editor (#{File.basename(Howzit.options[:editor])})") do
+  config_editor = File.basename(Howzit.options[:config_editor])
+  opts.on('--edit-config', "Edit configuration file using editor (#{config_editor})") do
     Howzit.config.editor
     Process.exit 0
   end
@@ -151,6 +155,11 @@ OptionParser.new do |opts|
     Howzit.options[:grep] = pat
   end
 
+  opts.on('--hook', 'Copy a link to the build note file, ready for pasting into Hook.app or other notes') do
+    Howzit.buildnote.hook
+    Process.exit 0
+  end
+
   opts.on('-r', '--run', 'Execute @run, @open, and/or @copy commands for given topic') do
     Howzit.options[:run] = true
   end

data/fish/completions/howzit.fish

@@ -12,6 +12,7 @@ complete -c howzit -l templates -d "List available templates"
 complete -c howzit -l title-only -d "Output title only"
 complete -c howzit -s c -l create -d "Create a skeleton build note in the current working directory"
 complete -c howzit -f -l config-get -d "Display the configuration settings or setting for a specific key"
+complete -c howzit -f -l hook -d "Copy a link to the build notes file (macOS)"
 complete -c howzit -f -l config-set -d "Set a config value (must be a valid key)"
 complete -c howzit -l edit-config -d "Edit configuration file using editor (subl)"
 complete -c howzit -s e -l edit -d "Edit buildnotes file in current working directory using editor (subl)"

data/lib/howzit/buildnote.rb

@@ -13,11 +13,13 @@ module Howzit
     ## @param      file  [String] The path to the build note file
     ##
     def initialize(file: nil)
+      file ||= note_file
+
       @topics = []
-      create_note(prompt: true) if note_file.nil?
+      create_note(prompt: true) if file.nil?
 
-      content = Util.read_file(note_file)
-      raise "{br}No content found in build note (#{note_file}){x}".c if content.nil? || content.empty?
+      content = Util.read_file(file)
+      raise "{br}No content found in build note (#{file}){x}".c if content.nil? || content.empty?
 
       @metadata = content.split(/^#/)[0].strip.get_metadata
 
@@ -72,6 +74,17 @@ module Howzit
       end
     end
 
+    ##
+    ## Copy a link to the main build note file to clipboard (macOS only)
+    ##
+    def hook
+      title = Util.read_file(note_file).note_title(note_file, 20)
+      title = "#{title} project notes"
+      url = "[#{title}](file://#{note_file})"
+      Util.os_copy(url)
+      Howzit.console.info('Link copied to clipboard.')
+    end
+
     ##
     ## Call grep on all topics, filtering out those that don't match
     ##
@@ -585,7 +598,7 @@ module Howzit
         lines = sect.split(/\n/)
         title = lines.slice!(0).strip
         prefix = ''
-        if path
+        if path && path != note_file
           if path =~ /#{Howzit.config.template_folder}/
             short_path = File.basename(path, '.md')
           else

data/lib/howzit/config.rb

@@ -74,7 +74,7 @@ module Howzit
     ## Initiate the editor for the config
     ##
     def editor
-      edit_config(DEFAULTS)
+      edit_config
     end
 
     private

data/lib/howzit/prompt.rb

@@ -100,7 +100,7 @@ module Howzit
             "--height=#{height}",
             '--header="Use tab to mark multiple selections, enter to display/run"',
             '--prompt="Select a section > "',
-            '--preview="howzit {}"'
+            %(--preview="howzit --no-pager --header-format block --no-color --default --multiple first {}")
           ]
           res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf #{settings.join(' ')}`.strip
           if res.nil? || res.empty?

data/lib/howzit/task.rb

@@ -94,62 +94,7 @@ module Howzit
     def run_copy
       title = Howzit.options[:show_all_code] ? @action : @title
       Howzit.console.info("{bg}Copied {bw}#{title}{bg} to clipboard{x}".c)
-      os_copy(@action)
-    end
-
-    ##
-    ## Platform-agnostic copy-to-clipboard
-    ##
-    ## @param      string  [String] The string to copy
-    ##
-    def os_copy(string)
-      os = RbConfig::CONFIG['target_os']
-      out = "{bg}Copying {bw}#{string}".c
-      case os
-      when /darwin.*/i
-        Howzit.console.debug("#{out} (macOS){x}".c)
-        `echo #{Shellwords.escape(string)}'\\c'|pbcopy`
-      when /mingw|mswin/i
-        Howzit.console.debug("#{out} (Windows){x}".c)
-        `echo #{Shellwords.escape(string)} | clip`
-      else
-        if 'xsel'.available?
-          Howzit.console.debug("#{out} (Linux, xsel){x}".c)
-          `echo #{Shellwords.escape(string)}'\\c'|xsel -i`
-        elsif 'xclip'.available?
-          Howzit.console.debug("#{out} (Linux, xclip){x}".c)
-          `echo #{Shellwords.escape(string)}'\\c'|xclip -i`
-        else
-          Howzit.console.debug(out)
-          Howzit.console.warn('Unable to determine executable for clipboard.')
-        end
-      end
-    end
-
-    ##
-    ## Platform-agnostic open command
-    ##
-    ## @param      command  [String] The command
-    ##
-    def os_open(command)
-      os = RbConfig::CONFIG['target_os']
-      out = "{bg}Opening {bw}#{command}".c
-      case os
-      when /darwin.*/i
-        Howzit.console.debug "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
-        `open #{Shellwords.escape(command)}`
-      when /mingw|mswin/i
-        Howzit.console.debug "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
-        `start #{Shellwords.escape(command)}`
-      else
-        if 'xdg-open'.available?
-          Howzit.console.debug "#{out} (Linux){x}".c if Howzit.options[:log_level] < 2
-          `xdg-open #{Shellwords.escape(command)}`
-        else
-          Howzit.console.debug out if Howzit.options[:log_level] < 2
-          Howzit.console.debug 'Unable to determine executable for `open`.'
-        end
-      end
+      Util.os_copy(@action)
     end
 
     ##
@@ -169,7 +114,7 @@ module Howzit
         when :copy
           run_copy
         when :open
-          os_open(@action)
+          Util.os_open(@action)
         end
       end
 

data/lib/howzit/util.rb

@@ -179,6 +179,61 @@ module Howzit
           puts output
         end
       end
+
+      ##
+      ## Platform-agnostic copy-to-clipboard
+      ##
+      ## @param      string  [String] The string to copy
+      ##
+      def os_copy(string)
+        os = RbConfig::CONFIG['target_os']
+        out = "{bg}Copying {bw}#{string}".c
+        case os
+        when /darwin.*/i
+          Howzit.console.debug("#{out} (macOS){x}".c)
+          `echo #{Shellwords.escape(string)}'\\c'|pbcopy`
+        when /mingw|mswin/i
+          Howzit.console.debug("#{out} (Windows){x}".c)
+          `echo #{Shellwords.escape(string)} | clip`
+        else
+          if 'xsel'.available?
+            Howzit.console.debug("#{out} (Linux, xsel){x}".c)
+            `echo #{Shellwords.escape(string)}'\\c'|xsel -i`
+          elsif 'xclip'.available?
+            Howzit.console.debug("#{out} (Linux, xclip){x}".c)
+            `echo #{Shellwords.escape(string)}'\\c'|xclip -i`
+          else
+            Howzit.console.debug(out)
+            Howzit.console.warn('Unable to determine executable for clipboard.')
+          end
+        end
+      end
+
+      ##
+      ## Platform-agnostic open command
+      ##
+      ## @param      command  [String] The command
+      ##
+      def os_open(command)
+        os = RbConfig::CONFIG['target_os']
+        out = "{bg}Opening {bw}#{command}".c
+        case os
+        when /darwin.*/i
+          Howzit.console.debug "#{out} (macOS){x}".c if Howzit.options[:log_level] < 2
+          `open #{Shellwords.escape(command)}`
+        when /mingw|mswin/i
+          Howzit.console.debug "#{out} (Windows){x}".c if Howzit.options[:log_level] < 2
+          `start #{Shellwords.escape(command)}`
+        else
+          if 'xdg-open'.available?
+            Howzit.console.debug "#{out} (Linux){x}".c if Howzit.options[:log_level] < 2
+            `xdg-open #{Shellwords.escape(command)}`
+          else
+            Howzit.console.debug out if Howzit.options[:log_level] < 2
+            Howzit.console.debug 'Unable to determine executable for `open`.'
+          end
+        end
+      end
     end
   end
 end

data/lib/howzit/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '2.0.19'
+  VERSION = '2.0.22'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.19
+  version: 2.0.22
 platform: ruby
 authors:
 - Brett Terpstra