howzit 2.0.20 → 2.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22f532430daee5c4c7a1d662d959aa5141848be745940e497b0f5d5d920e0739
-  data.tar.gz: 4db5982c0f1409754cf41206b747ccc39b02ceacdaf100dc12e32185d8c13602
+  metadata.gz: aef13e763de59e83d14808c8778e5941c43b1b68669d09a9047dd53aaff60b38
+  data.tar.gz: 0f4052f07e44bbe1b9679a021abd147bc0830941351221baa61cb09f6bfe25c6
 SHA512:
-  metadata.gz: 7d57db8ee804c204c42b1b30fac02bede10a2ec1b46c31aaf33a688a3441c6338e033e568d61eecedf3ec5a0c05087106532504a4c7cfcbff6daf1ccd9efea20
-  data.tar.gz: 99d46ccfe0612d10c832e093a6b1f95fd4c48a72750e2375bc67b5bc8c1a017d15580f5806fa90fb47e8aae6db1f31c3fc931fd51d588ce1aa249bddfe875538
+  metadata.gz: 69231c5b96a7c011710787d6f47ef628286a5b7237489c6220f1bc25a9aab2d76d70f438b9d1872e2531710f100b3d09f715acabb138c7a8cfc6967d6dde9f70
+  data.tar.gz: 49c1e9266d4401d8ca863a9f107ab4e2c2722db719ab253b03db1b1c8983aeb83e3c715971d15be5ebe42d074f79b4ee521a9062a216422023c9884123555646

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 2.0.23
+
+2022-08-09 05:51
+
+#### FIXED
+
+- --grep function regression
+
+### 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

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
 
@@ -153,11 +155,9 @@ OptionParser.new do |opts|
     Howzit.options[:grep] = pat
   end
 
-  if RbConfig::CONFIG['target_os'] =~ /darwin.*/i
-    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('--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

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
 
@@ -77,9 +79,9 @@ module Howzit
     ##
     def hook
       title = Util.read_file(note_file).note_title(note_file, 20)
-      title = "#{title} build notes"
+      title = "#{title} project notes"
       url = "[#{title}](file://#{note_file})"
-      `echo #{Shellwords.escape(url)}'\\c'|pbcopy`
+      Util.os_copy(url)
       Howzit.console.info('Link copied to clipboard.')
     end
 
@@ -596,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
@@ -689,7 +691,7 @@ module Howzit
     ##                     single topic
     ##
     def process_topic(topic, run, single: false)
-      new_topic = topic.dup
+      new_topic = topic.is_a?(String) ? find_topic(topic)[0] : topic.dup
 
       # Handle variable replacement
       new_topic.content = new_topic.content.render_arguments
@@ -791,6 +793,7 @@ module Howzit
 
       if !topic_matches.empty?
         # If we found a match
+        topic_matches.map! { |topic| topic.is_a?(String) ? find_topic(topic)[0] : topic }
         topic_matches.each { |topic_match| output.push(process_topic(topic_match, Howzit.options[:run], single: true)) }
       else
         # If there's no argument or no match found, output all

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.20'
+  VERSION = '2.0.23'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.0.20
+  version: 2.0.23
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler