howzit 1.2.13 → 1.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a27d1566deff8857d39035c0e40f696a29d78b7ae24274a73ceacc54541321
-  data.tar.gz: 7b13d6644bf397e10f629689b159102a33dd5aa2c3610f368819de3dc8736007
+  metadata.gz: 3858dec6b009f75173d3d72067a94c330cb826b0e367109c7416b2db19065fa8
+  data.tar.gz: 2e05520b1ff9d5da82aba03b1af3ed31ee0a635f3fe42c50b3a515c45337c38b
 SHA512:
-  metadata.gz: 9da1ea212df950e75a34006a44b0ade09c02fd4fe7c02ea0fddfffcf2936e6ca5db0d7f0c9e6cc44aac3d65eb4544aa9d4c03c156487f9311f39f08ee12199d4
-  data.tar.gz: 99f9be58ff9184a2f96e7db6fed83e3fc19f0945e31c9d58daa32db022b175a8c99a329a9c023528af52100f46583ac892091eb04ed5d9e9e791087fe8f8c82d
+  metadata.gz: 90cb7e647c7956823e73eac6e4884a1ffe26875acd531cc70be6a1b334aa9653213cafbf0830cd69a634579c7fa61553585bbbc95f997a02b0192d093a85be1b
+  data.tar.gz: bfba515bc66d5f15ae33d967866e83e2e9e4c887160d0c66269542ee909acf8383742fd0e64f5639013a1ccdc16253664a3c90cd150fd5a67529280473ed1a88

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 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

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,7 @@ 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
 
 If `:color:` is false, output will not be colored, and markdown highlighting will be bypassed.
 
@@ -272,6 +280,8 @@ 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.
+
 ### Matching
 
 All matching is case insensitive. This setting can be overridden by the `--matching TYPE` flag on the command line.

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)
@@ -356,7 +356,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.
@@ -382,12 +384,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])
 
@@ -449,7 +451,7 @@ module Howzit
                else
                  output_topic(key, {single: single})
                end
-      output.nil? ? '' : output.join("\n")
+      output.nil? ? '' : output.join("\n").strip
     end
 
     # Output a list of topic titles
@@ -700,7 +702,8 @@ module Howzit
         choose: false,
         quiet: false,
         verbose: false,
-        default: false
+        default: false,
+        grep: nil
       }
 
       defaults = {
@@ -715,7 +718,7 @@ module Howzit
         show_all_on_error: false,
         include_upstream: false,
         show_all_code: false,
-        grep: nil,
+        multiple_matches: 'choose',
         log_level: 1 # 0: debug, 1: info, 2: warn, 3: error
       }
 
@@ -767,6 +770,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
@@ -808,6 +816,39 @@ module Howzit
           @options[:wrap] = w.to_i
         end
 
+        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
@@ -869,6 +910,8 @@ module Howzit
         end
       end.parse!(args)
 
+      @options[:multiple_matches] = @options[:multiple_matches].to_sym
+
       @cli_args = args
     end
 
@@ -1001,12 +1044,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]
@@ -1107,7 +1158,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}' })
@@ -1136,33 +1187,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/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.13'.freeze
+  VERSION = '1.2.14'.freeze
 end

data/lib/howzit.rb

@@ -16,3 +16,4 @@ 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

data/spec/ruby_gem_spec.rb

@@ -23,14 +23,14 @@ describe Howzit::BuildNotes do
   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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 1.2.13
+  version: 1.2.14
 platform: ruby
 authors:
 - Brett Terpstra