howzit 2.1.27 → 2.1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfddcd9969d36eaa46a5441a912b60a0d4622c7536ffd34c6aebe83cc3c840a3
-  data.tar.gz: 9e5d7fee17c7931fc03b455eebe411f1490e1c27d70545f5e5a3d62f492a2f50
+  metadata.gz: 3c70619dce51a18faa84ba9516cf1e48bb2b3028f88e22397a8690e75ae65fff
+  data.tar.gz: 5f28a55772ca45c4f7a755b545c7fbf532460fee20533ff0714a304ea87d6799
 SHA512:
-  metadata.gz: '019b3813e1f3ed8a79f70711a0f2dae38a83f0cfca205a32d9ab14794ba9815ce8d971d26f6bed0afbb90ce9d4ffd5d0d926cf50ef965cf806ffa45565203611'
-  data.tar.gz: c77fdeea70957604027d8152517498e8fe6df7043f36e139f8a81b23daca958d701a2dda786385921a6d9bf5c01acaca068375e7d3b9bd680091a3e988275069
+  metadata.gz: 73247bd6dfbc7dc0b777f88825673dc1fa36575582d29b57c8d3a2a1996d985ad01e72917b8ac3e6626119e9a1182cddad2a166850d9e1cb5bb7aa01e68ffb93
+  data.tar.gz: 53aa254ba30a35a78880dcb7e9431d354ee4304e8244b290fb6d046dc29c60eb2becb023565ad4072e17c6af69ed5ec6faf062a15a407d87a293d7a67a14ad84

data/CHANGELOG.md

@@ -1,3 +1,74 @@
+### 2.1.29
+
+2026-01-01 06:55
+
+#### CHANGED
+
+- Updated rubocop from version 0.93.1 to 1.82.1 for Ruby 3.4.4 compatibility
+- Updated .rubocop.yml to use plugins syntax instead of require for rubocop extensions
+- Updated .rubocop.yml to inherit from .rubocop_todo.yml and removed Max settings that were overriding todo file limits
+- Added Security/YAMLLoad exception to .rubocop.yml to allow YAML.load usage (intentionally not using safe_load)
+- Added Layout/LineLength exceptions for files with intentionally long lines (bin/howzit, task.rb, util.rb, stringutils.rb, buildnote.rb)
+
+#### NEW
+
+- Scripts can now communicate back to Howzit by writing to a communication file specified in HOWZIT_COMM_FILE environment variable, allowing scripts to send log messages (LOG:level:message) and set variables (VAR:KEY=value) that are available for subsequent tasks and conditional logic
+- Added ScriptComm module to handle bidirectional communication between scripts and Howzit
+- Added @if and @unless conditional blocks that allow content and tasks to be conditionally included or excluded based on evaluated conditions, with support for nested blocks
+- Conditional blocks support string comparisons (==, =~ /regex/, *= contains, ^= starts with, $= ends with) and numeric comparisons (==, !=, >, >=, <, <=)
+- Conditions can test against metadata keys, environment variables, positional arguments ($1, $2, etc.), named arguments, and script-set variables
+- Added special condition checks: git dirty/clean, file exists <path>, dir exists <path>, topic exists <name>, and cwd/working directory
+- Conditions support negation with 'not' or '!' prefix
+- Added @elsif directive for alternative conditions in @if/@unless blocks, allowing multiple conditional branches
+- Added @else directive for fallback branches in conditional blocks when all previous conditions are false
+- Conditional blocks now support chaining multiple @elsif statements between @if/@unless and @else
+- @elsif and @else work correctly with nested conditional blocks
+- Added **= fuzzy match operator for string comparisons that matches if search string characters appear in order within the target string (e.g., "fluffy" **= "ffy" matches)
+- Added file contents condition that reads file contents and performs string comparisons using any comparison operator (e.g., file contents VERSION.txt ^= 0.)
+- File contents condition supports file paths as variables from metadata, named arguments, or environment variables
+
+#### IMPROVED
+
+- Auto-corrected rubocop style offenses including string literals, redundant self, parentheses, and other correctable issues
+- Fixed Lint/Void issue in buildnote.rb by simplifying conditional logic
+- Cwd and working directory can now be used with string comparison operators (==, =~, *=, ^=, $=) to check the current directory path
+- Conditions now support ${var} syntax in addition to var for consistency with variable substitution syntax
+- String comparison operators (*=, ^=, $=) now treat unquoted strings that aren't found as variables as literal strings, allowing simpler syntax like template *= gem instead of template *= "gem"
+
+#### FIXED
+
+- Resolved NameError for 'white' color method by generating escape codes directly from configured_colors hash instead of calling dynamically generated methods
+- Fixed infinite recursion in ConsoleLogger by using $stderr.puts directly instead of calling warn method recursively
+- Color template method now properly respects coloring? setting and returns empty strings when coloring is disabled
+- Resolved test failures caused by Howzit.buildnote caching stale instances by resetting @buildnote in spec_helper before each test
+- Fixed bug where @end statements failed to close conditional blocks when conditions evaluated to false, preventing subsequent conditional blocks from working correctly
+- Fixed issue where named arguments from topic titles were not available when evaluating conditions in conditional blocks
+- Suppressed EPIPE errors that occur when writing to stdout/stderr after pipes are closed, preventing error messages from appearing in terminal output
+
+### 2.1.28
+
+2025-12-31 10:21
+
+#### CHANGED
+
+- Refactored code to use more concise unless statement syntax
+
+#### NEW
+
+- Added "token" matching mode for multi-word searches that matches words in order
+
+#### IMPROVED
+
+- Enhanced fuzzy matching to use token-based approach for multi-word searches
+- Default partial matching now uses token-based matching for better multi-word search results
+
+#### FIXED
+
+- Improved error handling when topics are not found or invalid
+- Fixed topic selection when using interactive choose mode with topics that have named arguments
+- Added nil checks to prevent errors when arguments array is nil
+- Improved handling of empty search terms to prevent matching all topics
+
 ### 2.1.27
 
 2025-12-26 08:59

data/Rakefile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # require 'bump/tasks'
+require 'English'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -13,7 +14,7 @@ module TempFixForRakeLastComment
     last_description
   end
 end
-Rake::Application.send :include, TempFixForRakeLastComment
+Rake::Application.include TempFixForRakeLastComment
 
 Rake::RDocTask.new do |rd|
   rd.main = 'README.rdoc'
@@ -77,7 +78,7 @@ task :dockertest, :version, :login do |_, args|
     file = 'docker/Dockerfile'
   end
 
-  d_spinner = TTY::Spinner.new("[:spinner] Setting up Docker", hide_cursor: true, format: :dots)
+  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
@@ -90,7 +91,7 @@ task :dockertest, :version, :login do |_, args|
   spinner.auto_spin
   res = `docker run --rm -v #{File.dirname(__FILE__)}:/howzit -it #{img}`
   commit = `bash -c "docker commit $(docker ps -a|grep #{img}|awk '{print $1}'|head -n 1) #{img}"`.strip
-  if $?.exitstatus == 0
+  if $CHILD_STATUS.exitstatus.zero?
     spinner.success
   else
     spinner.error

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 ''
   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 '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(", ").sub(/#{Howzit.options[:matching]}/, "*#{Howzit.options[:matching]}")})") do |c|
+  opts.on('-m', '--matching TYPE', MATCHING_OPTIONS,
+          'Topics matching type', "(#{MATCHING_OPTIONS.join(', ').sub(/#{Howzit.options[:matching]}/, "*#{Howzit.options[:matching]}")})") do |c|
     Howzit.options[:matching] = c
   end
 
-  opts.on("--multiple TYPE", MULTIPLE_OPTIONS,
-          "Multiple result handling", "(#{MULTIPLE_OPTIONS.join(", ").sub(/#{Howzit.options[:multiple_matches]}/, "*#{Howzit.options[:multiple_matches]}")}, default choose)") do |c|
+  opts.on('--multiple TYPE', MULTIPLE_OPTIONS,
+          'Multiple result handling', "(#{MULTIPLE_OPTIONS.join(', ').sub(/#{Howzit.options[:multiple_matches]}/, "*#{Howzit.options[:multiple_matches]}")}, 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

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
 
   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 'rubocop', '~> 1.60'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   # spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'fuubar', '~> 2.0'