howzit 2.1.15 → 2.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801a2edf83210d0abd3cf17ab9c9259469429478c48b8245df7475bde19c6676
-  data.tar.gz: c47dd24e16f255fcbbd0ac5acadb3c57f423bda0237bbbb85b43f8c82e08b0db
+  metadata.gz: 4c4fea8cf5770f7beb101c32a4596c4a4d58006d1378c95dd482e95052b2e672
+  data.tar.gz: d0e85f76ddf1dc2f02a0bfb7dc85f5495e749aa13bdda0ed773cb8ce11ff8fb7
 SHA512:
-  metadata.gz: f8ea4385da70cb5cf7e8d66b5352f164d7cee71b050cf47a544539bf61d0ffd95b4c46f77347b8cf016fd50bd9edf6f7fe1b088fb4f8d324af9343c833334204
-  data.tar.gz: 7bc8190df842331c74ab4dc0146262b886c1174d3fcf2faef35dc536d0622fe29c2868c4db6e2067e1198c801116d8b67bb0272214cfe8a75dd210a86ec8db66
+  metadata.gz: bca6e7eb45d1c69862aa8e7ff25cd9ccf713826a61836d9d515f761eb1aee46ee6e5c90f5dfdbb120b02dcf0700023817a3fd5dd74a9538170188f8c23397eb9
+  data.tar.gz: e565bd5ff26d4788a72ecd776d39297ec11b2ffb1290b079496f4fdad3dc7faa4ccfebce8d725d9d503727cc06f4014bea34c6afff3bf70377d051594a033dfb

data/.irbrc

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
-`gem rdoc binbundle --ri`
+IRB.conf[:AUTO_INDENT] = true
+
+require "irb/completion"
+require_relative "lib/conductor"
 
 # rubocop:disable Style/MixinUsage
 include Howzit # standard:disable all
 # rubocop:enable Style/MixinUsage
+
+require "awesome_print"
+AwesomePrint.irb!

data/.rubocop.yml

@@ -22,10 +22,10 @@ Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 40
+  Max: 45
 
 Metrics/BlockLength:
-  Max: 40
+  Max: 45
   Exclude:
     - Rakefile
     - bin/howzit
@@ -34,9 +34,6 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 300
 
-Metrics/CyclomaticComplexity:
-  Max: 10
-
 Metrics/PerceivedComplexity:
   Max: 30
 
@@ -44,7 +41,7 @@ Metrics/AbcSize:
   Max: 45
 
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 20
 
 Style/RegexpLiteral:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 2.1.18
+
+2025-01-01 09:53
+
+#### IMPROVED
+
+- Include named arguments when listing runnable topics
+
+### 2.1.16
+
+2024-08-13 10:59
+
+#### IMPROVED
+
+- Add extra linebreak before @include headers
+
 ### 2.1.15
 
 2024-08-07 13:10

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bump/tasks'
+# require 'bump/tasks'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -8,6 +8,13 @@ require 'yard'
 require 'tty-spinner'
 require 'rdoc/task'
 
+module TempFixForRakeLastComment
+  def last_comment
+    last_description
+  end
+end
+Rake::Application.send :include, TempFixForRakeLastComment
+
 Rake::RDocTask.new do |rd|
   rd.main = 'README.rdoc'
   rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
@@ -70,20 +77,28 @@ task :dockertest, :version, :login do |_, args|
     file = 'docker/Dockerfile'
   end
 
-  puts `docker build . --file #{file} -t #{img}`
+  d_spinner = TTY::Spinner.new("[:spinner] Setting up Docker", hide_cursor: true, format: :dots)
+  d_spinner.auto_spin
+  `docker build . --file #{file} -t #{img} &> /dev/null`
+  d_spinner.success
+  d_spinner.stop
 
   exec "docker run -v #{File.dirname(__FILE__)}:/howzit -it #{img} /bin/bash -l" if args[:login]
 
-  spinner = TTY::Spinner.new("[:spinner] Running tests #{img}", hide_cursor: true)
+  spinner = TTY::Spinner.new("[:spinner] Running tests #{img}", hide_cursor: true, format: :dots)
 
   spinner.auto_spin
   res = `docker run --rm -v #{File.dirname(__FILE__)}:/howzit -it #{img}`
-  # commit = puts `bash -c "docker commit $(docker ps -a|grep #{img}|awk '{print $1}'|head -n 1) #{img}"`.strip
-  spinner.success
+  commit = `bash -c "docker commit $(docker ps -a|grep #{img}|awk '{print $1}'|head -n 1) #{img}"`.strip
+  if $?.exitstatus == 0
+    spinner.success
+  else
+    spinner.error
+    puts res
+  end
   spinner.stop
 
-  puts res
-  # puts commit&.empty? ? "Error commiting Docker tag #{img}" : "Committed Docker tag #{img}"
+  puts commit&.empty? ? "Error commiting Docker tag #{img}" : "Committed Docker tag #{img}"
 end
 
 desc 'Alias for build'

data/bin/howzit

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
-require 'howzit'
+$LOAD_PATH.unshift File.join(__dir__, "..", "lib")
+require "howzit"
 
 Howzit::Color.coloring = $stdout.isatty
 
@@ -13,127 +13,127 @@ Howzit.named_arguments = {}
 
 OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS] [TOPIC]"
-  opts.separator ''
-  opts.separator 'Show build notes for the current project (buildnotes.md).
-  Include a topic name to see just that topic, or no argument to display all.'
-  opts.separator ''
-  opts.separator 'Options:'
+  opts.separator ""
+  opts.separator "Show build notes for the current project (buildnotes.md).
+  Include a topic name to see just that topic, or no argument to display all."
+  opts.separator ""
+  opts.separator "Options:"
 
   opts.separator "  Behavior:\n\n" #=================================================================== BEHAVIOR
 
-  opts.on('--ask', 'Request confirmation for all tasks when running a topic') { Howzit.options[:ask] = true }
+  opts.on("--ask", "Request confirmation for all tasks when running a topic") { Howzit.options[:ask] = true }
 
-  opts.on('--default', 'Answer all prompts with default response') do
-    raise '--default cannot be used with --yes or --no' if Howzit.options[:yes] || Howzit.options[:no]
+  opts.on("--default", "Answer all prompts with default response") do
+    raise "--default cannot be used with --yes or --no" if Howzit.options[:yes] || Howzit.options[:no]
 
     Howzit.options[:default] = true
   end
 
-  opts.on('-f', '--force', 'Continue executing after an error') { Howzit.options[:force] = true }
+  opts.on("-f", "--force", "Continue executing after an error") { Howzit.options[:force] = true }
 
-  opts.on('-m', '--matching TYPE', MATCHING_OPTIONS,
-          'Topics matching type', "(#{MATCHING_OPTIONS.join(', ')})") do |c|
+  opts.on("-m", "--matching TYPE", MATCHING_OPTIONS,
+          "Topics matching type", "(#{MATCHING_OPTIONS.join(", ")})") do |c|
     Howzit.options[:matching] = c
   end
 
-  opts.on('--multiple TYPE', MULTIPLE_OPTIONS,
-          'Multiple result handling', "(#{MULTIPLE_OPTIONS.join(', ')}, default choose)") do |c|
+  opts.on("--multiple TYPE", MULTIPLE_OPTIONS,
+          "Multiple result handling", "(#{MULTIPLE_OPTIONS.join(", ")}, default choose)") do |c|
     Howzit.options[:multiple_matches] = c.to_sym
   end
 
-  opts.on('-u', '--[no-]upstream', 'Traverse up parent directories for additional build notes') do |p|
+  opts.on("-u", "--[no-]upstream", "Traverse up parent directories for additional build notes") do |p|
     Howzit.options[:include_upstream] = p
   end
 
-  opts.on('-y', '--yes', 'Answer yes to all prompts') do
-    raise '--default cannot be used with --yes' if Howzit.options[:default]
+  opts.on("-y", "--yes", "Answer yes to all prompts") do
+    raise "--default cannot be used with --yes" if Howzit.options[:default]
 
     Howzit.options[:yes] = true
   end
 
-  opts.on('-n', '--no', 'Answer no to all prompts') do
-    raise '--default cannot be used with --no' if Howzit.options[:default]
+  opts.on("-n", "--no", "Answer no to all prompts") do
+    raise "--default cannot be used with --no" if Howzit.options[:default]
 
     Howzit.options[:no] = true
   end
 
   opts.separator "\n  Listing:\n\n" #=================================================================== LISTING
 
-  opts.on('-L', '--list-completions', 'List topics (completion-compatible)') do
+  opts.on("-L", "--list-completions", "List topics (completion-compatible)") do
     Howzit.options[:list_topics] = true
     Howzit.options[:list_topic_titles] = true
   end
 
-  opts.on('-l', '--list', 'List available topics') do
+  opts.on("-l", "--list", "List available topics") do
     Howzit.options[:list_topics] = true
   end
 
-  opts.on('-R', '--list-runnable [PATTERN]', 'List topics containing @ directives (verbose)') do |pat|
+  opts.on("-R", "--list-runnable [PATTERN]", "List topics containing @ directives (verbose)") do |pat|
     Howzit.options[:for_topic] = pat
     Howzit.options[:list_runnable] = true
   end
 
-  opts.on('-T', '--task-list', 'List topics containing @ directives (completion-compatible)') do
+  opts.on("-T", "--task-list", "List topics containing @ directives (completion-compatible)") do
     Howzit.options[:list_runnable] = true
     Howzit.options[:list_runnable_titles] = true
   end
 
-  opts.on('--templates', 'List available templates') do
+  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')
+    Dir.glob("*.md").each do |file|
+      template = File.basename(file, ".md")
       out.push(Howzit::Color.template("{Mk}template:{Yk}#{template}{x}"))
-      out.push(Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}'))
+      out.push(Howzit::Color.template("{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}"))
       metadata = file.extract_metadata
       topics = Howzit::BuildNote.new(file: file).topics
       topics.each do |topic|
-        out.push(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')
-        out.push(Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}'))
-        out.push(Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}"))
+        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")
+        out.push(Howzit::Color.template("{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}"))
+        out.push(Howzit::Color.template(" {bk}│ {xw}#{meta.join(", ")}{x}"))
       end
-      out.push(Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}'))
+      out.push(Howzit::Color.template(" {bk}└───────────────────────────────────────────┘{x}"))
     end
     Howzit::Util.page out.join("\n")
     Process.exit 0
   end
 
-  opts.on('--templates-c', 'List available templates in a format for completion') do
+  opts.on("--templates-c", "List available templates in a format for completion") do
     out = []
     Dir.chdir(Howzit.config.template_folder)
-    Dir.glob('*.md').each do |file|
-      template = File.basename(file, '.md')
+    Dir.glob("*.md").each do |file|
+      template = File.basename(file, ".md")
       out.push(template)
     end
     puts out.join("\n")
     Process.exit 0
   end
 
-  opts.on('--title-only', 'Output title only') do
+  opts.on("--title-only", "Output title only") do
     Howzit.options[:output_title] = true
     Howzit.options[:title_only] = true
   end
 
   opts.separator("\n  Commands:\n\n") #=================================================================== COMMANDS
 
-  opts.on('-c', '--create', 'Create a skeleton build note in the current working directory') do
+  opts.on("-c", "--create", "Create a skeleton build note in the current working directory") do
     Howzit.buildnote.create_note
     Process.exit 0
   end
 
-  opts.on('--config-get [KEY]', 'Display the configuration settings or setting for a specific key') do |k|
+  opts.on("--config-get [KEY]", "Display the configuration settings or setting for a specific key") do |k|
     if k.nil?
       Howzit::Config::DEFAULTS.sort_by { |key, _| key }.each do |key, _|
         print "#{key}: "
         p Howzit.options[key]
       end
     else
-      k.sub!(/^:/, '')
+      k.sub!(/^:/, "")
       if Howzit.options.key?(k.to_sym)
         puts Howzit.options[k.to_sym]
       else
@@ -143,12 +143,12 @@ OptionParser.new do |opts|
     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/
+  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/
 
     parts = key.split(/=/)
-    k = parts.shift.sub(/^:/, '')
-    v = parts.join(' ')
+    k = parts.shift.sub(/^:/, "")
+    v = parts.join(" ")
 
     if Howzit.options.key?(k.to_sym)
       Howzit.options[k.to_sym] = v.to_config_value(Howzit.options[k.to_sym])
@@ -160,103 +160,103 @@ OptionParser.new do |opts|
   end
 
   desc = %(Edit buildnotes file in current working directory using default editor)
-  opts.on('-e', '--edit', desc) do
+  opts.on("-e", "--edit", desc) do
     Howzit.buildnote.edit
     Process.exit 0
   end
 
-  opts.on('--edit-config', "Edit configuration file using default editor") do
+  opts.on("--edit-config", "Edit configuration file using default editor") do
     Howzit.config.editor
     Process.exit 0
   end
 
-  opts.on('--edit-template NAME', 'Create or edit a template') do |template|
+  opts.on("--edit-template NAME", "Create or edit a template") do |template|
     Howzit.buildnote.edit_template(template)
     Process.exit 0
   end
 
-  opts.on('--grep PATTERN', 'Display sections matching a search pattern') do |pat|
+  opts.on("--grep PATTERN", "Display sections matching a search pattern") do |pat|
     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
+  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
+  opts.on("-r", "--run", "Execute @run, @open, and/or @copy commands for given topic") do
     Howzit.options[:run] = true
   end
 
-  opts.on('-s', '--select', 'Select topic from menu') do
+  opts.on("-s", "--select", "Select topic from menu") do
     Howzit.options[:choose] = true
   end
 
   opts.separator("\n  Formatting:\n\n") #=================================================================== FORMATTING
 
-  opts.on('--[no-]color', 'Colorize output (default on)') do |c|
+  opts.on("--[no-]color", "Colorize output (default on)") do |c|
     Howzit.options[:color] = c
     Howzit.options[:highlight] = false unless c
   end
 
-  opts.on('--header-format TYPE', HEADER_FORMAT_OPTIONS,
-          "Formatting style for topic titles (#{HEADER_FORMAT_OPTIONS.join(', ')})") do |t|
+  opts.on("--header-format TYPE", HEADER_FORMAT_OPTIONS,
+          "Formatting style for topic titles (#{HEADER_FORMAT_OPTIONS.join(", ")})") do |t|
     Howzit.options[:header_format] = t
   end
 
-  opts.on('--[no-]md-highlight', 'Highlight Markdown syntax (default on), requires mdless or mdcat') do |m|
+  opts.on("--[no-]md-highlight", "Highlight Markdown syntax (default on), requires mdless or mdcat") do |m|
     Howzit.options[:highlight] = Howzit.options[:color] ? m : false
   end
 
-  opts.on('--[no-]pager', 'Paginate output (default on)') do |p|
+  opts.on("--[no-]pager", "Paginate output (default on)") do |p|
     Howzit.options[:paginate] = p
   end
 
-  opts.on('--show-code', 'Display the content of fenced run blocks') do
+  opts.on("--show-code", "Display the content of fenced run blocks") do
     Howzit.options[:show_all_code] = true
   end
 
-  opts.on('-t', '--title', 'Output title with build notes') do
+  opts.on("-t", "--title", "Output title with build notes") do
     Howzit.options[:output_title] = true
   end
 
-  opts.on('-w', '--wrap COLUMNS', 'Wrap to specified width (default 80, 0 to disable)') do |w|
+  opts.on("-w", "--wrap COLUMNS", "Wrap to specified width (default 80, 0 to disable)") do |w|
     Howzit.options[:wrap] = w.to_i
   end
 
   opts.separator("\n  Logging:\n\n") #=================================================================== LOGGING
 
-  opts.on('-d', '--debug', 'Show debug messages (and all messages)') do
+  opts.on("-d", "--debug", "Show debug messages (and all messages)") do
     Howzit.options[:log_level] = 0
     Howzit.console.reset_level
   end
 
-  opts.on('-q', '--quiet', 'Silence info message') do
+  opts.on("-q", "--quiet", "Silence info message") do
     Howzit.options[:log_level] = 4
     Howzit.console.reset_level
   end
 
-  opts.on('--verbose', 'Show all messages') do
+  opts.on("--verbose", "Show all messages") do
     Howzit.options[:log_level] = 1
     Howzit.console.reset_level
   end
 
   opts.separator("\n  Misc:\n\n") #=================================================================== MISC
 
-  opts.on('-h', '--help', 'Display this screen') do
+  opts.on("-h", "--help", "Display this screen") do
     Howzit::Util.page opts.to_s
     Process.exit 0
   end
 
-  opts.on('-v', '--version', 'Display version number') do
+  opts.on("-v", "--version", "Display version number") do
     puts "#{File.basename(__FILE__)} v#{Howzit::VERSION}"
     Process.exit 0
   end
 end.parse!(args)
 
-trap('INT') do
+trap("INT") do
   puts
-  puts 'Cancelled'
+  puts "Cancelled"
   Process.exit 0
 end
 

data/howzit.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path(File.join('..', 'lib'), __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'howzit/version'
@@ -8,7 +10,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Brett Terpstra']
   spec.email         = ['me@brettterpstra.com']
   spec.description   = 'Command line project documentation and task runner'
-  spec.summary       = 'Provides a way to access Markdown project notes by topic with query capabilities and the ability to execute the tasks it describes.'
+  spec.summary       = ['Provides a way to access Markdown project notes by topic',
+                        'with query capabilities and the ability to execute the',
+                        'tasks it describes.'].join(' ')
   spec.homepage      = 'https://github.com/ttscoff/howzit'
   spec.license       = 'MIT'
 
@@ -20,28 +24,27 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_development_dependency 'bundler', '~> 2.2'
-  spec.add_development_dependency 'rake', '~> 11.2'
-  spec.add_development_dependency 'bump', '~> 0.5'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   spec.add_development_dependency 'guard', '~> 2.11'
-  spec.add_development_dependency 'guard-yard', '~> 2.1'
-  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'guard-yard', '~> 2.1'
 
-  spec.add_development_dependency 'rubocop', '~> 0.28'
-  spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'cli-test', '~> 1.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 0.28'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   # spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'fuubar', '~> 2.0'
 
-  spec.add_development_dependency 'yard', '~> 0.9.5'
-  spec.add_development_dependency 'redcarpet', '~> 3.2'
   spec.add_development_dependency 'github-markup', '~> 1.3'
+  spec.add_development_dependency 'redcarpet', '~> 3.2'
   spec.add_development_dependency 'tty-spinner', '~> 0.9'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
 
   spec.add_runtime_dependency 'mdless', '~> 1.0', '>= 1.0.28'
-  spec.add_runtime_dependency 'tty-screen', '~> 0.8'
   spec.add_runtime_dependency 'tty-box', '~> 0.7'
+  spec.add_runtime_dependency 'tty-screen', '~> 0.8'
   # spec.add_runtime_dependency 'tty-prompt', '~> 0.23'
 end

data/lib/howzit/buildnote.rb

@@ -21,7 +21,7 @@ module Howzit
       content = Util.read_file(file)
       raise "{br}No content found in build note (#{file}){x}".c if content.nil? || content.empty?
 
-      this_meta = content.split(/^#/)[0].strip.get_metadata
+      this_meta = content.split(/^#/)[0].strip.metadata
 
       @metadata = meta.nil? ? this_meta : meta.merge(this_meta)
 
@@ -57,7 +57,7 @@ module Howzit
     ## @param      template  [String] The template title
     ##
     def edit_template(template)
-      file = template.sub(/(\.md)?$/i, '.md')
+      file = template.sub(/(\.md)?$/i, ".md")
       file = File.join(Howzit.config.template_folder, file)
       edit_template_file(file)
     end
@@ -72,7 +72,7 @@ module Howzit
 
       @topics.filter do |topic|
         rx = term.to_rx
-        topic.title.downcase.sub(/ *\(.*?\) *$/, '') =~ rx
+        topic.title.downcase.sub(/ *\(.*?\) *$/, "") =~ rx
       end
     end
 
@@ -84,7 +84,7 @@ module Howzit
       title = "#{title} project notes"
       url = "[#{title}](file://#{note_file})"
       Util.os_copy(url)
-      Howzit.console.info('Link copied to clipboard.')
+      Howzit.console.info("Link copied to clipboard.")
     end
 
     ##
@@ -115,7 +115,13 @@ module Howzit
     ## @return     [Array] array of topic titles
     ##
     def list_topics
-      @topics.map(&:title)
+      @topics.map do |topic|
+        title = topic.title
+        unless topic.named_args.empty?
+          title += "(#{topic.named_args.keys.join(", ")})"
+        end
+        title
+      end
     end
 
     ##
@@ -137,7 +143,13 @@ module Howzit
     def list_runnable_completions
       output = []
       @topics.each do |topic|
-        output.push(topic.title) if topic.tasks.count.positive?
+        if topic.tasks.count.positive?
+          title = topic.title
+          unless topic.named_args.empty?
+            title += "(#{topic.named_args.keys.join(", ")})"
+          end
+          output.push(title)
+        end
       end
       output.join("\n")
     end
@@ -159,7 +171,12 @@ module Howzit
 
         next if s_out.empty?
 
-        output.push("- {bw}#{topic.title}{x}".c)
+        title = topic.title
+        unless topic.named_args.empty?
+          title += " {dy}({xy}#{topic.named_args.keys.join(", ")}{dy}){x}"
+        end
+
+        output.push("- {g}#{title}{x}".c)
         output.push(s_out.join("\n"))
       end
 
@@ -182,7 +199,7 @@ module Howzit
     ## @param      prompt  [Boolean] confirm file creation?
     ##
     def create_template_file(file, prompt: false)
-      trap('SIGINT') do
+      trap("SIGINT") do
         Howzit.console.info "\nCancelled"
         exit!
       end
@@ -194,7 +211,7 @@ module Howzit
         Process.exit 0 unless res
       end
 
-      title = File.basename(file, '.md')
+      title = File.basename(file, ".md")
 
       note = <<~EOBUILDNOTES
         # #{title}
@@ -206,12 +223,12 @@ module Howzit
       if File.exist?(file) && !default
         file = "{by}#{file}".c
         unless Prompt.yn("Are you sure you want to overwrite #{file}", default: false)
-          Howzit.console.info('Cancelled')
+          Howzit.console.info("Cancelled")
           Process.exit 0
         end
       end
 
-      File.open(file, 'w') do |f|
+      File.open(file, "w") do |f|
         f.puts note
         Howzit.console.info("{by}Template {bw}#{title}{by} written to {bw}#{file}{x}".c)
       end
@@ -226,7 +243,7 @@ module Howzit
 
     # Create a buildnotes skeleton
     def create_note(prompt: false)
-      trap('SIGINT') do
+      trap("SIGINT") do
         Howzit.console.info "\nCancelled"
         exit!
       end
@@ -234,7 +251,7 @@ module Howzit
       default = !$stdout.isatty || Howzit.options[:default]
 
       if prompt && !default
-        res = Prompt.yn('No build notes file found, create one?', default: true)
+        res = Prompt.yn("No build notes file found, create one?", default: true)
         Process.exit 0 unless res
       end
 
@@ -257,14 +274,14 @@ module Howzit
         input = $stdin.gets.chomp
         title = input unless input.empty?
       end
-      summary = ''
+      summary = ""
       unless default
-        printf '{bw}Project summary: {x}'.c
+        printf "{bw}Project summary: {x}".c
         input = $stdin.gets.chomp
         summary = input unless input.empty?
       end
 
-      fname = 'buildnotes.md'
+      fname = "buildnotes.md"
       unless default
         printf "{bw}Build notes filename (must begin with 'howzit' or 'build')\n{xg}[#{fname}]{bw}: {x}".c
         input = $stdin.gets.chomp
@@ -299,12 +316,12 @@ module Howzit
       if File.exist?(fname) && !default
         file = "{by}#{fname}".c
         unless Prompt.yn("Are you absolutely sure you want to overwrite #{file}", default: false)
-          Howzit.console.info('Canceled')
+          Howzit.console.info("Canceled")
           Process.exit 0
         end
       end
 
-      File.open(fname, 'w') do |f|
+      File.open(fname, "w") do |f|
         f.puts note
         Howzit.console.info("{by}Build notes for {bw}#{title}{by} written to {bw}#{fname}{x}".c)
       end
@@ -340,15 +357,15 @@ module Howzit
       return mtch[0] unless File.exist?(file)
 
       content = Util.read_file(file)
-      home = ENV['HOME']
-      short_path = File.dirname(file.sub(/^#{home}/, '~'))
+      home = ENV["HOME"]
+      short_path = File.dirname(file.sub(/^#{home}/, "~"))
       prefix = "#{short_path}/#{File.basename(file)}:"
       parts = content.split(/^##+/)
       parts.shift
       if parts.empty?
         content
       else
-        "## #{parts.join('## ')}".gsub(/^(##+ *)(?=\S)/, "\\1#{prefix}")
+        "## #{parts.join("## ")}".gsub(/^(##+ *)(?=\S)/, "\\1#{prefix}")
       end
     end
 
@@ -363,17 +380,17 @@ module Howzit
       t_leader = Util.read_file(template).split(/^#/)[0].strip
       return unless t_leader.length.positive?
 
-      t_meta = t_leader.get_metadata
+      t_meta = t_leader.metadata
 
-      return unless t_meta.key?('required')
+      return unless t_meta.key?("required")
 
-      required = t_meta['required'].strip.split(/\s*,\s*/)
+      required = t_meta["required"].strip.split(/\s*,\s*/)
       required.each do |req|
         next if @metadata.keys.include?(req.downcase)
 
         Howzit.console.error %({bRw}ERROR:{xbr} Missing required metadata key from template '{bw}#{File.basename(
-          template, '.md'
-        )}{xr}'{x}).c
+                               template, ".md"
+                             )}{xr}'{x}).c
         Howzit.console.error %({br}Please define {by}#{req.downcase}{xr} in build notes{x}).c
         Process.exit 1
       end
@@ -391,8 +408,8 @@ module Howzit
       subtopics = nil
 
       if template =~ /\[(.*?)\]$/
-        subtopics = Regexp.last_match[1].split(/\s*\|\s*/).map { |t| t.gsub(/\*/, '.*?') }
-        template.sub!(/\[.*?\]$/, '').strip
+        subtopics = Regexp.last_match[1].split(/\s*\|\s*/).map { |t| t.gsub(/\*/, ".*?") }
+        template.sub!(/\[.*?\]$/, "").strip
       end
 
       [template, subtopics]
@@ -412,7 +429,7 @@ module Howzit
       templates.each do |template|
         template, subtopics = detect_subtopics(template)
 
-        file = template.sub(/(\.md)?$/i, '.md')
+        file = template.sub(/(\.md)?$/i, ".md")
         file = File.join(Howzit.config.template_folder, file)
 
         next unless File.exist?(file)
@@ -476,7 +493,7 @@ module Howzit
       buildnotes = []
       filename = nil
 
-      while dir != '/' && (dir =~ %r{[A-Z]:/}).nil?
+      while dir != "/" && (dir =~ %r{[A-Z]:/}).nil?
         Dir.chdir(dir)
         filename = glob_note
         unless filename.nil?
@@ -499,7 +516,7 @@ module Howzit
     ## @return     [String] file path
     ##
     def glob_note
-      Dir.glob('*.{txt,md,markdown}').select(&:build_note?).sort[0]
+      Dir.glob("*.{txt,md,markdown}").select(&:build_note?).sort[0]
     end
 
     ##
@@ -512,9 +529,9 @@ module Howzit
     def find_note_file
       filename = glob_note
 
-      if filename.nil? && 'git'.available?
+      if filename.nil? && "git".available?
         proj_dir = `git rev-parse --show-toplevel 2>/dev/null`.strip
-        unless proj_dir == ''
+        unless proj_dir == ""
           Dir.chdir(proj_dir)
           filename = glob_note
         end
@@ -556,10 +573,10 @@ module Howzit
 
       return template_topics if leader.empty?
 
-      data = leader.get_metadata
+      data = leader.metadata
 
-      if data.key?('template')
-        templates = data['template'].strip.split(/\s*,\s*/)
+      if data.key?("template")
+        templates = data["template"].strip.split(/\s*,\s*/)
 
         template_topics.concat(gather_templates(templates))
       end
@@ -601,13 +618,13 @@ module Howzit
 
         lines = sect.split(/\n/)
         title = lines.slice!(0).strip
-        prefix = ''
+        prefix = ""
         if path && path != note_file
           if path =~ /#{Howzit.config.template_folder}/
-            short_path = File.basename(path, '.md')
+            short_path = File.basename(path, ".md")
           else
-            home = ENV['HOME']
-            short_path = File.dirname(path.sub(/^#{home}/, '~'))
+            home = ENV["HOME"]
+            short_path = File.dirname(path.sub(/^#{home}/, "~"))
             prefix = "_from #{short_path}_\n\n"
           end
           title = "#{short_path}:#{title}"
@@ -619,7 +636,7 @@ module Howzit
       end
 
       template_topics.each do |topic|
-        topics.push(topic) unless find_topic(topic.title.sub(/^.+:/, '')).count.positive?
+        topics.push(topic) unless find_topic(topic.title.sub(/^.+:/, "")).count.positive?
       end
 
       topics
@@ -638,7 +655,7 @@ module Howzit
         upstream_topics = read_upstream
 
         upstream_topics.each do |topic|
-          @topics.push(topic) unless find_topic(topic.title.sub(/^.+:/, '')).count.positive?
+          @topics.push(topic) unless find_topic(topic.title.sub(/^.+:/, "")).count.positive?
         end
         Howzit.has_read_upstream = true
       end
@@ -653,11 +670,11 @@ module Howzit
     ## Open build note in editor
     ##
     def edit_note
-      editor = Howzit.options.fetch(:editor, ENV['EDITOR'])
+      editor = Howzit.options.fetch(:editor, ENV["EDITOR"])
 
       editor = Howzit.config.update_editor if editor.nil?
 
-      raise 'No editor defined' if editor.nil?
+      raise "No editor defined" if editor.nil?
 
       raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
 
@@ -671,7 +688,7 @@ module Howzit
     ## @param      template  [String] The template name
     ##
     def create_template(template)
-      file = template.sub(/(\.md)?$/i, '.md')
+      file = template.sub(/(\.md)?$/i, ".md")
       file = File.join(Howzit.config.template_folder, file)
       create_template_file(file, prompt: false)
     end
@@ -680,11 +697,11 @@ module Howzit
     ## Open template in editor
     ##
     def edit_template_file(file)
-      editor = Howzit.options.fetch(:editor, ENV['EDITOR'])
+      editor = Howzit.options.fetch(:editor, ENV["EDITOR"])
 
       editor = Howzit.config.update_editor if editor.nil?
 
-      raise 'No editor defined' if editor.nil?
+      raise "No editor defined" if editor.nil?
 
       raise "Invalid editor (#{editor})" unless Util.valid_command?(editor)
 
@@ -705,12 +722,12 @@ module Howzit
       new_topic = topic.is_a?(String) ? find_topic(topic)[0] : topic.dup
 
       output = if run
-                 new_topic.run
-               else
-                 new_topic.print_out({ single: single })
-               end
+          new_topic.run
+        else
+          new_topic.print_out({ single: single })
+        end
 
-      output.nil? ? '' : output.join("\n\n")
+      output.nil? ? "" : output.join("\n\n")
     end
 
     ##
@@ -731,7 +748,7 @@ module Howzit
         Process.exit(0)
       elsif Howzit.options[:output_title] && !Howzit.options[:run]
         if @title && !@title.empty?
-          header = @title.format_header({ hr: "\u{2550}", color: '{bwK}' })
+          header = @title.format_header({ hr: "\u{2550}", color: "{bwK}" })
           output.push("#{header}\n")
         end
       end
@@ -770,9 +787,9 @@ module Howzit
       elsif Howzit.options[:choose]
         titles = Prompt.choose(list_topics, height: :max)
         titles.each { |title| topic_matches.push(find_topic(title)[0]) }
-      # If there are arguments use those to search for a matching topic
+        # If there are arguments use those to search for a matching topic
       elsif !Howzit.cli_args.empty?
-        search = Howzit.cli_args.join(' ').strip.downcase.split(/ *, */).map(&:strip)
+        search = Howzit.cli_args.join(" ").strip.downcase.split(/ *, */).map(&:strip)
 
         search.each do |s|
           matches = find_topic(s)
@@ -791,7 +808,7 @@ module Howzit
               titles = matches.map(&:title)
               res = Prompt.choose(titles)
               old_matching = Howzit.options[:matching]
-              Howzit.options[:matching] = 'exact'
+              Howzit.options[:matching] = "exact"
               res.each { |title| topic_matches.concat(find_topic(title)) }
               Howzit.options[:matching] = old_matching
             end

data/lib/howzit/colors.rb

@@ -5,7 +5,7 @@ module Howzit
   # Terminal output color functions.
   module Color
     # Regexp to match excape sequences
-    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/
+    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/.freeze
 
     # All available color names. Available as methods and string extensions.
     #
@@ -361,7 +361,7 @@ module Howzit
 
     # Regular expression that is used to scan for ANSI-sequences while
     # uncoloring strings.
-    COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/
+    COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/.freeze
 
     # Returns an uncolored version of the string, that is all
     # ANSI-sequences are stripped from the string.

data/lib/howzit/config.rb

@@ -132,7 +132,7 @@ module Howzit
       puts 'No $EDITOR defined, no value in config'
       editor = Prompt.read_editor
       if editor.nil?
-        'Cancelled, no editor stored.'
+        puts 'Cancelled, no editor stored.'
         Process.exit 1
       end
       update_config_option({ config_editor: editor, editor: editor })

data/lib/howzit/stringutils.rb

@@ -38,7 +38,7 @@ module Howzit
       position = 0
       in_order = 0
       chars.each do |char|
-        new_pos = self[position..] =~ /#{char}/i
+        new_pos = self[position..-1] =~ /#{char}/i
         if new_pos
           position += new_pos
           in_order += 1
@@ -350,14 +350,14 @@ module Howzit
     ##
     ## Split the content at the first top-level header and
     ## assume everything before it is metadata. Passes to
-    ## #get_metadata for processing
+    ## #metadata for processing
     ##
     ## @return     [Hash] key/value pairs
     ##
     def extract_metadata
       if File.exist?(self)
         leader = Util.read_file(self).split(/^#/)[0].strip
-        leader.length.positive? ? leader.get_metadata : {}
+        leader.length.positive? ? leader.metadata : {}
       else
         {}
       end
@@ -368,7 +368,7 @@ module Howzit
     ##
     ## @return     [Hash] The metadata as key/value pairs
     ##
-    def get_metadata
+    def metadata
       data = {}
       scan(/(?mi)^(\S[\s\S]+?): ([\s\S]*?)(?=\n\S[\s\S]*?:|\Z)/).each do |m|
         data[m[0].strip.downcase] = m[1]
@@ -453,7 +453,7 @@ module Howzit
                else
                  options[:hr] * (cols - title.uncolor.length)
                end
-        Color.template("\n\n#{title}#{tail}{x}")
+        Color.template("\n\n#{title}#{tail}{x}\n\n")
       end
     end
   end

data/lib/howzit/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.15
+  version: 2.1.18
 platform: ruby
 authors:
 - Brett Terpstra
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2025-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,28 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +52,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
-  name: guard-yard
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -95,61 +80,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: guard-yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: cli-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: cli-test
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.28'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -179,19 +164,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -207,33 +192,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: tty-spinner
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: mdless
   requirement: !ruby/object:Gem::Requirement
@@ -255,33 +240,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.28
 - !ruby/object:Gem::Dependency
-  name: tty-screen
+  name: tty-box
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: tty-box
+  name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 description: Command line project documentation and task runner
 email:
 - me@brettterpstra.com
@@ -348,7 +333,6 @@ homepage: https://github.com/ttscoff/howzit
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -363,8 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides a way to access Markdown project notes by topic with query capabilities
   and the ability to execute the tasks it describes.