howzit 1.2.12 → 1.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875d039552876588bf298e4297ffec3955a6a73da6c2f89f608f7d11ed9d4e93
-  data.tar.gz: ecd7f0dd8f67999de4e223745f79096cc06ebd84e867400bc729f2323e8f8360
+  metadata.gz: c2df5a80f8f5ab2a265c424015adbcda29a16050e28411a194cb7b4c7eecdf6f
+  data.tar.gz: fe974160b092d27f9901e91ddaf5d83b6f1b0c494108e1bd12d23a865e05e56a
 SHA512:
-  metadata.gz: bfcad0fc1a4fbf0140dc91ae5cf03e52c3d42aed4a404c91fab642db05d9849b92c0c73d4f87d79ca0b58d1583a6a0ab5ef0ef9936812913567aeb3f24508a93
-  data.tar.gz: db44b03b2f2c25c84187692a9d46a328a22d4a7dce0adc20304ab31fe58e91b6ca4bef6848ab69efcce5e0c60e9c8955501f4232d5643f664d35cb81da9bcbdf
+  metadata.gz: d71faacd4a0d7ae0ce10e089302c2ef8d32ece37479c718690b48b3d969d6725018665299a63d787b36419131ccc8642e94a638580aa38030ec51191a1e29d45
+  data.tar.gz: 997f94412dd2f580ca712aead5d8609fa71044744c5ed0d4437d161331ae9ff58ad5f28f61ed8b969eca158551e131b730285b7e920c5f6347e4641db816385e

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 1.2.15
+
+2022-08-02 11:59
+
+#### NEW
+
+- Option to set :header_format: to block for alternate topic title appearance
+
+#### FIXED
+
+- Missing spacing around topic titles when displaying multiple topics
+
+### 1.2.14
+
+2022-08-02 11:01
+
+#### NEW
+
+- Config option and flag to determine how to handle multiple results (first, best, all, choose)
+- --config-get and --config-set flags for working with config options
+
+#### IMPROVED
+
+- Allow multiple selections when using fzf
+- Clean up newlines in output
+
+### 1.2.13
+
+2022-08-01 20:50
+
 ### 1.2.12
 
 2022-08-01 16:23

data/README.md

@@ -24,11 +24,10 @@ Howzit is a tool that allows you to keep Markdown-formatted notes about a projec
 
 ## Getting Started
 
-Howzit is a simple, self-contained script (at least until I get stupid and make a gem out of it).
-
 ### Prerequisites
 
 - Ruby 2.4+ (It probably works on older Rubys, but is untested prior to 2.4.1.)
+- Optional: if [`fzf`](https://github.com/junegunn/fzf) is available, it will be used for handling multiple choice selections
 - Optional: if [`bat`](https://github.com/sharkdp/bat) is available it will page with that
 - Optional: [`mdless`](https://github.com/ttscoff/mdless) or [`mdcat`](https://github.com/lunaryorn/mdcat) for formatting output
 
@@ -200,6 +199,10 @@ Include a topic name to see just that topic, or no argument to display all.
 
     howzit build
 
+You can combine multiple topic searches by separating with a comma. When multiple results are returned, the `:multiple_results:` configuration determines how they're handled.
+
+    howzit build,deploy
+
 Use `-l` to list all topics.
 
     howzit -l
@@ -216,12 +219,15 @@ Other options:
 
     Options:
         -c, --create                     Create a skeleton build note in the current working directory
-        -e, --edit                       Edit buildnotes file in current working directory using editor.sh
+        -e, --edit                       Edit buildnotes file in current working directory
+                    using $EDITOR
             --grep PATTERN               Display sections matching a search pattern
         -L, --list-completions           List topics for completion
         -l, --list                       List available topics
         -m, --matching TYPE              Topics matching type
                                          (partial, exact, fuzzy, beginswith)
+            --multiple TYPE              Multiple result handling
+                                         (first, all, choose)
         -R, --list-runnable              List topics containing @ directives (verbose)
         -r, --run                        Execute @run, @open, and/or @copy commands for given topic
         -s, --select                     Select topic from menu
@@ -229,10 +235,10 @@ Other options:
         -t, --title                      Output title with build notes
         -q, --quiet                      Silence info message
             --verbose                    Show all messages
-        -u, --upstream                   Traverse up parent directories for additional build notes
+        -u, --[no-]upstream              Traverse up parent directories for additional build notes
             --show-code                  Display the content of fenced run blocks
         -w, --wrap COLUMNS               Wrap to specified width (default 80, 0 to disable)
-            --edit-config                Edit configuration file using editor.sh
+            --edit-config                Edit configuration file using default $EDITOR
             --title-only                 Output title only
             --templates                  List available templates
             --[no-]color                 Colorize output (default on)
@@ -240,6 +246,7 @@ Other options:
             --[no-]pager                 Paginate output (default on)
         -h, --help                       Display this screen
         -v, --version                    Display version number
+            --default                    Answer all prompts with default response
 
 
 ## Configuration
@@ -257,6 +264,8 @@ Some of the command line options can be set as defaults. The first time you run
     :matching: partial
     :include_upstream: false
     :log_level: 1
+    :multiple_matches: choose
+    :header_format: border
 
 If `:color:` is false, output will not be colored, and markdown highlighting will be bypassed.
 
@@ -272,6 +281,10 @@ If `:include_upstream:` is true, build note files in parent directories will be
 
 Set `:log_level:` to 0 for debug messages, or 3 to suppress superfluous info messages.
 
+`:multiple_matches:` determines how howzit will handle cases where a search results in multiple matches. It can be set to "first" (first match in notes), "best" (shortest topic match), "all" (display all results), or "choose" (displays a menu of results). Default is "choose." When grepping for results, only "all" or "choose" are valid, if the default is something else, "choose" will be used. Can be overridden with the `--multiple TYPE` flag.
+
+`:header_format:` changes the way topic titles are displayed. Setting it to "border" will add a horizontal rule and brackets around the title. Setting it to "block" will mark topic titles with a unicode block instead.
+
 ### Matching
 
 All matching is case insensitive. This setting can be overridden by the `--matching TYPE` flag on the command line.

data/Rakefile

@@ -29,3 +29,8 @@ task :ver do
   puts "version.rb: #{version}"
   puts "changelog: #{cver}"
 end
+
+desc 'Changelog version check'
+task :cver do
+  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+end

data/lib/howzit/buildnotes.rb

@@ -124,7 +124,7 @@ module Howzit
         pipes = "|#{hl}" if hl
       end
 
-      output = `echo #{Shellwords.escape(string.strip)}#{pipes}`
+      output = `echo #{Shellwords.escape(string.strip)}#{pipes}`.strip
 
       if @options[:paginate]
         page(output)
@@ -160,30 +160,40 @@ module Howzit
         warn "\nCanceled"
         exit!
       end
+      default = !$stdout.isatty || @options[:default]
       # First make sure there isn't already a buildnotes file
       if note_file
         fname = Color.template("{by}#{note_file}{bw}")
-        res = yn("#{fname} exists and appears to be a build note, continue anyway?", false)
-        unless res
-          puts 'Canceled'
-          Process.exit 0
+        unless default
+          res = yn("#{fname} exists and appears to be a build note, continue anyway?", false)
+          unless res
+            puts 'Canceled'
+            Process.exit 0
+          end
         end
       end
 
       title = File.basename(Dir.pwd)
-      printf Color.template("{bw}Project name {xg}[#{title}]{bw}: {x}")
-      input = $stdin.gets.chomp
-      title = input unless input.empty?
-
+      if default
+        input = title
+      else
+        printf Color.template("{bw}Project name {xg}[#{title}]{bw}: {x}")
+        input = $stdin.gets.chomp
+        title = input unless input.empty?
+      end
       summary = ''
-      printf Color.template('{bw}Project summary: {x}')
-      input = $stdin.gets.chomp
-      summary = input unless input.empty?
+      unless default
+        printf Color.template('{bw}Project summary: {x}')
+        input = $stdin.gets.chomp
+        summary = input unless input.empty?
+      end
 
       fname = 'buildnotes.md'
-      printf Color.template("{bw}Build notes filename (must begin with 'howzit' or 'build')\n{xg}[#{fname}]{bw}: {x}")
-      input = $stdin.gets.chomp
-      fname = input unless input.empty?
+      unless default
+        printf Color.template("{bw}Build notes filename (must begin with 'howzit' or 'build')\n{xg}[#{fname}]{bw}: {x}")
+        input = $stdin.gets.chomp
+        fname = input unless input.empty?
+      end
 
       note = <<~EOBUILDNOTES
         # #{title}
@@ -210,7 +220,7 @@ module Howzit
 
       EOBUILDNOTES
 
-      if File.exist?(fname)
+      if File.exist?(fname) && !default
         file = Color.template("{by}#{fname}")
         res = yn("Are you absolutely sure you want to overwrite #{file}", false)
 
@@ -237,17 +247,22 @@ module Howzit
 
       options.merge!(opts)
 
-      cols = TTY::Screen.columns
+      case @options[:header_format]
+      when :block
+        Color.template("#{options[:color]}\u{258C}#{title}#{should_mark_iterm? && options[:mark] ? iterm_marker : ''}{x}")
+      else
+        cols = TTY::Screen.columns
 
-      cols = @options[:wrap] if (@options[:wrap]).positive? && cols > @options[:wrap]
-      title = Color.template("#{options[:border]}#{options[:hr] * 2}( #{options[:color]}#{title}#{options[:border]} )")
+        cols = @options[:wrap] if (@options[:wrap]).positive? && cols > @options[:wrap]
+        title = Color.template("#{options[:border]}#{options[:hr] * 2}( #{options[:color]}#{title}#{options[:border]} )")
 
-      tail = if should_mark_iterm?
-               "#{options[:hr] * (cols - title.uncolor.length - 15)}#{options[:mark] ? iterm_marker : ''}"
-             else
-               options[:hr] * (cols - title.uncolor.length)
-             end
-      Color.template("#{title}#{tail}{x}")
+        tail = if should_mark_iterm?
+                 "#{options[:hr] * (cols - title.uncolor.length - 15)}#{options[:mark] ? iterm_marker : ''}"
+               else
+                 options[:hr] * (cols - title.uncolor.length)
+               end
+        Color.template("#{title}#{tail}{x}")
+      end
     end
 
     def os_open(command)
@@ -346,7 +361,9 @@ module Howzit
       end
       output.push("Ran #{tasks} #{tasks == 1 ? 'task' : 'tasks'}") if @options[:log_level] < 2
 
-      puts postreqs.join("\n\n")
+      puts postreqs.join("\n\n") unless postreqs.empty?
+
+      output
     end
 
     # Output a topic with fancy title and bright white text.
@@ -372,12 +389,12 @@ module Howzit
           unless matches.empty?
             if opt[:single]
               title = "From #{matches[0]}:"
-              color = '{yK}'
-              rule = '{kK}'
+              color = '{Kyd}'
+              rule = '{kKd}'
             else
               title = "Include #{matches[0]}"
-              color = '{yK}'
-              rule = '{x}'
+              color = '{Kyd}'
+              rule = '{kKd}'
             end
             output.push(format_header("#{'> ' * @nest_level}#{title}", { color: color, hr: '.', border: rule })) unless @included.include?(matches[0])
 
@@ -689,7 +706,9 @@ module Howzit
         title_only: false,
         choose: false,
         quiet: false,
-        verbose: false
+        verbose: false,
+        default: false,
+        grep: nil
       }
 
       defaults = {
@@ -704,7 +723,8 @@ module Howzit
         show_all_on_error: false,
         include_upstream: false,
         show_all_code: false,
-        grep: nil,
+        multiple_matches: 'choose',
+        header_format: 'border',
         log_level: 1 # 0: debug, 1: info, 2: warn, 3: error
       }
 
@@ -733,7 +753,7 @@ module Howzit
         end
 
         opts.on('-e', '--edit', "Edit buildnotes file in current working directory
-                using #{File.basename(ENV['EDITOR'])}") do
+                using $EDITOR") do
           edit_note
           Process.exit 0
         end
@@ -756,6 +776,11 @@ module Howzit
           @options[:matching] = c
         end
 
+        opts.on('--multiple TYPE', MULTIPLE_OPTIONS,
+                'Multiple result handling', "(#{MULTIPLE_OPTIONS.join(', ')}, default choose)") do |c|
+          @options[:multiple_matches] = c.to_sym
+        end
+
         opts.on('-R', '--list-runnable', 'List topics containing @ directives (verbose)') do
           @options[:list_runnable] = true
         end
@@ -797,7 +822,40 @@ module Howzit
           @options[:wrap] = w.to_i
         end
 
-        opts.on('--edit-config', "Edit configuration file using #{File.basename(ENV['EDITOR'])}") do
+        opts.on('--config-get [KEY]', 'Display the configuration settings or setting for a specific key') do |k|
+
+          if k.nil?
+            config.sort_by { |key, _| key }.each do |key, val|
+              print "#{key}: "
+              p val
+            end
+          else
+            k.sub!(/^:/, '')
+            if config.key?(k.to_sym)
+              puts config[k.to_sym]
+            else
+              puts "Key #{k} not found"
+            end
+          end
+          Process.exit 0
+        end
+
+        opts.on('--config-set KEY=VALUE', 'Set a config value (must be a valid key)') do |key|
+          raise 'Argument must be KEY=VALUE' unless key =~ /\S=\S/
+
+          k, v = key.split(/=/)
+          k.sub!(/^:/, '')
+
+          if config.key?(k.to_sym)
+            config[k.to_sym] = v.to_config_value(config[k.to_sym])
+          else
+            puts "Key #{k} not found"
+          end
+          write_config(config)
+          Process.exit 0
+        end
+
+        opts.on('--edit-config', "Edit configuration file using default $EDITOR") do
           edit_config(defaults)
           Process.exit 0
         end
@@ -830,6 +888,11 @@ module Howzit
           Process.exit 0
         end
 
+        opts.on('--header-format TYPE', HEADER_FORMAT_OPTIONS,
+                "Formatting style for topic titles (#{HEADER_FORMAT_OPTIONS.join(', ')})") do |t|
+          @options[:header_format] = t
+        end
+
         opts.on('--[no-]color', 'Colorize output (default on)') do |c|
           @options[:color] = c
           @options[:highlight] = false unless c
@@ -852,8 +915,15 @@ module Howzit
           puts "Howzit v#{VERSION}"
           Process.exit 0
         end
+
+        opts.on('--default', 'Answer all prompts with default response') do
+          @options[:default] = true
+        end
       end.parse!(args)
 
+      @options[:multiple_matches] = @options[:multiple_matches].to_sym
+      @options[:header_format] = @options[:header_format].to_sym
+
       @cli_args = args
     end
 
@@ -986,12 +1056,20 @@ module Howzit
 
     def choose(matches)
       if command_exist?('fzf')
-        res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf -0 -1 --height #{matches.count + 2} --prompt 'Select a section > '`.strip
+        settings = [
+          '-0',
+          '-1',
+          '-m',
+          "--height=#{matches.count + 2}",
+          '--header="Use tab to mark multiple selections, enter to display/run"',
+          '--prompt="Select a section > "'
+        ]
+        res = `echo #{Shellwords.escape(matches.join("\n"))} | fzf #{settings.join(' ')}`.strip
         if res.nil? || res.empty?
           warn 'Cancelled'
           Process.exit 0
         end
-        return res
+        return res.split(/\n/)
       end
 
       res = matches[0..9]
@@ -1040,7 +1118,7 @@ module Howzit
       File.join(config_dir, 'templates')
     end
 
-    def create_config
+    def create_config(defaults)
       dir, file = [config_dir, config_file]
       unless File.directory?(dir)
         warn "Creating config directory at #{dir}"
@@ -1055,7 +1133,7 @@ module Howzit
     end
 
     def load_config(defaults)
-      file = create_config
+      file = create_config(defaults)
       config = YAML.load(IO.read(file))
       newconfig = config ? defaults.merge(config) : defaults
       write_config(newconfig)
@@ -1092,7 +1170,7 @@ module Howzit
         out = get_note_title(20)
         $stdout.print(out.strip)
         Process.exit(0)
-      elsif @options[:output_title]
+      elsif @options[:output_title] && !@options[:run]
         title = get_note_title
         if title && !title.empty?
           header = format_header(title, { hr: "\u{2550}", color: '{bwK}' })
@@ -1121,33 +1199,49 @@ module Howzit
         Process.exit(0)
       end
 
-      topic_match = nil
+      topic_matches = []
       if @options[:grep]
-        topic_match = choose(grep_topics(@options[:grep]))
+        matches = grep_topics(@options[:grep])
+        case @options[:multiple_matches]
+        when :all
+          topic_matches.concat(matches.sort)
+        else
+          topic_matches.concat(choose(matches))
+        end
       elsif @options[:choose]
-        topic_match = choose(topics.keys)
+        topic_matches.concat(choose(topics.keys))
       # If there are arguments use those to search for a matching topic
       elsif !@cli_args.empty?
+        search = @cli_args.join(' ').strip.downcase.split(/ *, */).map(&:strip)
 
-        search = @cli_args.join(' ').strip.downcase
-        matches = match_topic(search)
+        search.each do |s|
+          matches = match_topic(s)
 
-        if matches.empty?
-          output.push(Color.template(%({bR}ERROR:{xr} No topic match found for {bw}#{search}{x}\n)))
-          unless @options[:show_all_on_error]
-            show(output.join("\n"), { color: true, highlight: false, paginate: false, wrap: 0 })
-            Process.exit 1
+          if matches.empty?
+            output.push(Color.template(%({bR}ERROR:{xr} No topic match found for {bw}#{s}{x}\n)))
+          else
+            case @options[:multiple_matches]
+            when :first
+              topic_matches.push(matches[0])
+            when :best
+              topic_matches.push(matches.sort.min_by(&:length))
+            when :all
+              topic_matches.concat(matches)
+            else
+              topic_matches.concat(choose(matches))
+            end
           end
-        elsif matches.length == 1
-          topic_match = matches[0]
-        else
-          topic_match = choose(matches)
+        end
+
+        if topic_matches.empty? && !@options[:show_all_on_error]
+          show(output.join("\n"), { color: true, highlight: false, paginate: false, wrap: 0 })
+          Process.exit 1
         end
       end
 
-      if topic_match
+      if !topic_matches.empty?
         # If we found a match
-        output.push(process_topic(topic_match, @options[:run], true))
+        topic_matches.each { |topic_match| output.push(process_topic(topic_match, @options[:run], true)) }
       else
         # If there's no argument or no match found, output all
         topics.each_key { |k| output.push(process_topic(k, false, false)) }

data/lib/howzit/colors.rb

@@ -232,7 +232,7 @@ module Howzit
                    y: yellow, c: cyan, m: magenta, r: red,
                    W: bgwhite, K: bgblack, G: bggreen, L: bgblue,
                    Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
-                   b: bold, u: underline, i: italic, x: reset }
+                   d: dark, b: bold, u: underline, i: italic, x: reset }
 
         format(fmt, colors)
       end

data/lib/howzit/prompt.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module Howzit
+  # Command line prompt utils
   module Prompt
   	def yn(prompt, default = true)
+      return default if !$stdout.isatty
+
     	system 'stty cbreak'
     	yn = color_single_options(default ? %w[Y n] : %w[y N])
     	$stdout.syswrite "\e[1;37m#{prompt} #{yn}\e[1;37m? \e[0m"

data/lib/howzit/stringutils.rb

@@ -3,6 +3,31 @@
 module Howzit
   # String Extensions
   module StringUtils
+    # Convert a string to a valid YAML value
+    def to_config_value(orig_value = nil)
+      if orig_value
+        case orig_value.class.to_s
+        when /Integer/
+          to_i
+        when /(True|False)Class/
+          self =~ /^(t(rue)?|y(es)?|1)$/i ? true : false
+        else
+          self
+        end
+      else
+        case self
+        when /^[0-9]+$/
+          to_i
+        when /^(t(rue)?|y(es)?)$/i
+          true
+        when /^(f(alse)?|n(o)?)$/i
+          false
+        else
+          self
+        end
+      end
+    end
+
     # Just strip out color codes when requested
     def uncolor
       gsub(/\e\[[\d;]+m/, '').gsub(/\e\]1337;SetMark/,'')

data/lib/howzit/version.rb

@@ -2,5 +2,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '1.2.12'.freeze
+  VERSION = '1.2.15'.freeze
 end

data/lib/howzit.rb

@@ -16,3 +16,5 @@ CONFIG_DIR = '~/.config/howzit'
 CONFIG_FILE = 'howzit.yaml'
 IGNORE_FILE = 'ignore.yaml'
 MATCHING_OPTIONS = %w[partial exact fuzzy beginswith].freeze
+MULTIPLE_OPTIONS = %w[first best all choose].freeze
+HEADER_FORMAT_OPTIONS = %w[border block].freeze

data/spec/ruby_gem_spec.rb

@@ -12,7 +12,9 @@ end
 
 describe Howzit::BuildNotes do
   Dir.chdir('spec')
-  subject { Howzit::BuildNotes.new(['--no-upstream']) }
+  how = Howzit::BuildNotes.new(['--no-upstream', '--default'])
+  how.create_note
+  subject { how }
 
   describe ".note_file" do
     it "locates a build note file" do
@@ -20,21 +22,15 @@ describe Howzit::BuildNotes do
     end
   end
 
-  describe ".get_note_title" do
-    it "is named howzit test" do
-      expect(subject.get_note_title).to match(/howzit test/)
-    end
-  end
-
   describe ".grep_topics" do
-    it "found editable" do
+    it "finds editable" do
       expect(subject.grep_topics('editable')).to include('File Structure')
       expect(subject.grep_topics('editable')).not_to include('Build')
     end
   end
 
   describe ".list_topic_titles" do
-    it "found 4 topics" do
+    it "finds 4 topics" do
       expect(subject.topics.keys.count).to eq 4
     end
     it "outputs a newline-separated string" do

metadata

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