howzit 2.1.24 → 2.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9539bebf0157985ac2d5a035923c1e7f78e942961f79a0729d20920d78c38f3a
-  data.tar.gz: 0f16b31308c0e78f7d13e140363d2f62cd8da38658c5d1a9e29721ea0e6dda5f
+  metadata.gz: 19fc185635709d53c4d7dcf0b437d4ec6b00cdd341d734e4655ef4e8e1dbfd3a
+  data.tar.gz: 9305e6edf7a8c4f7bf6d2d6a4a1aed14313aac73b658595a877314e929c15c8b
 SHA512:
-  metadata.gz: bb8ddc83529c66ddbcc1a71be7bdcdbf118427f08a206d7bc5a02e0b5b1a363d01f321e8865eab8f44a8b871dd8a8134e20e4d1bbd3a880cbbdc7c87f688062c
-  data.tar.gz: 3a8501d2c2c7b7a35ac82701353b8b3162eb6b6b5890c98c5b171eb8be56bdaf9fc8cd841ef8610ca95482c2fe820964aae98c0945be8eaae6e2a1eb0b3432de
+  metadata.gz: a35475dfaf7aa381157964466046ff8c94b0a4282bd9bbb8c067b7d344527d8ba95a296934ce935375111c4c255122cd3c684829d761b4962c517ea6dfadc14b
+  data.tar.gz: 41ae72b53d9602fb9b6df8231a4d1db8d9f134b78460e2243e8afaf616528279d0e7b08d68820a330994935579186058838a5d5e5c288b809aa46d0670b71b0f

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 2.1.26
+
+2025-12-26 04:53
+
+#### FIXED
+
+- Bash script variables in run blocks now preserve ${VAR} syntax when the variable is not defined by howzit, allowing bash to handle them normally instead of being replaced with empty strings.
+
+### 2.1.25
+
+2025-12-19 07:41
+
+#### NEW
+
+- Added default metadata support to automatically run topics when executing `howzit --run` with no arguments. Supports multiple comma-separated topics with optional bracketed arguments (e.g., `default: Build Project, Run Tests[verbose]`).
+
+#### FIXED
+
+- Task titles are now correctly displayed in run reports and "Running" messages instead of showing the command. When a title is provided after @run or @include directives (e.g., `@run(ls) List directory`), the title is used throughout.
+- Fixed color code interpretation issues when task or topic names contain dollar signs or braces. These characters are now properly escaped to prevent them from being interpreted as color template codes.
+- Fixed issue where task titles containing braces would show literal `{x}` in output due to color template parsing.
+
 ### 2.1.24
 
 2025-12-13 07:11

data/lib/howzit/buildnote.rb

@@ -955,18 +955,32 @@ module Howzit
         titles.each { |title| topic_matches.push(find_topic(title)[0]) }
         process_topic_matches(topic_matches, output)
       elsif !Howzit.cli_args.empty?
-        # Collect all topic matches first (showing menus as needed)
-        search = topic_search_terms_from_cli
-        topic_matches = collect_topic_matches(search, output)
-        process_topic_matches(topic_matches, output)
+        # Check if first arg is "default"
+        if Howzit.options[:run] && Howzit.cli_args[0].downcase == 'default'
+          process_default_metadata(output)
+        else
+          # Collect all topic matches first (showing menus as needed)
+          search = topic_search_terms_from_cli
+          topic_matches = collect_topic_matches(search, output)
+          process_topic_matches(topic_matches, output)
+        end
       else
-        # No arguments - show all topics
+        # No arguments
         if Howzit.options[:run]
-          Howzit.run_log = []
-          Howzit.multi_topic_run = topics.length > 1
+          # Check for default metadata when running with no args
+          if @metadata.key?('default')
+            process_default_metadata(output)
+          else
+            Howzit.run_log = []
+            Howzit.multi_topic_run = topics.length > 1
+            topics.each { |k| output.push(process_topic(k, false, single: false)) }
+            finalize_output(output)
+          end
+        else
+          # Show all topics
+          topics.each { |k| output.push(process_topic(k, false, single: false)) }
+          finalize_output(output)
         end
-        topics.each { |k| output.push(process_topic(k, false, single: false)) }
-        finalize_output(output)
       end
     end
 
@@ -1060,6 +1074,77 @@ module Howzit
       finalize_output(output)
     end
 
+    ##
+    ## Process default metadata and run the specified topics
+    ##
+    ## @param      output  [Array] Output array
+    ##
+    def process_default_metadata(output)
+      default_value = @metadata['default']
+      return if default_value.nil? || default_value.strip.empty?
+
+      Howzit.run_log = []
+      default_topics = parse_default_metadata(default_value)
+      Howzit.multi_topic_run = default_topics.length > 1
+
+      topic_specs = []
+      default_topics.each do |topic_spec|
+        topic_name, args = parse_topic_with_args(topic_spec)
+        matches = find_topic(topic_name)
+        if matches.empty?
+          output.push(%({bR}ERROR:{xr} No topic match found for {bw}#{topic_name}{x}\n).c)
+        else
+          # Store topic and its arguments together (take first match, like @include does)
+          topic_specs << [matches[0], args]
+        end
+      end
+
+      if topic_specs.empty?
+        Util.show(output.join("\n"), { color: true, highlight: false, paginate: false, wrap: 0 })
+        Process.exit 1
+      end
+
+      # Run each topic with its specific arguments
+      topic_specs.each do |topic_match, args|
+        # Set arguments if provided, otherwise clear them
+        if args && !args.empty?
+          Howzit.arguments = args.split(/ *, */).map(&:render_arguments)
+        else
+          Howzit.arguments = []
+        end
+        output.push(process_topic(topic_match, Howzit.options[:run], single: true))
+      end
+      finalize_output(output)
+    end
+
+    ##
+    ## Parse default metadata value into individual topic specifications
+    ##
+    ## @param      default_value  [String] The default metadata value
+    ##
+    ## @return     [Array] Array of topic specification strings
+    ##
+    def parse_default_metadata(default_value)
+      default_value.strip.split(/\s*,\s*/).map(&:strip).reject(&:empty?)
+    end
+
+    ##
+    ## Parse a topic specification that may include bracketed arguments
+    ##
+    ## @param      topic_spec  [String] Topic specification like "Run Snippet[document.md]"
+    ##
+    ## @return     [Array] [topic_name, args_string]
+    ##
+    def parse_topic_with_args(topic_spec)
+      if topic_spec =~ /\[(.*?)\]$/
+        args = Regexp.last_match(1)
+        topic_name = topic_spec.sub(/\[.*?\]$/, '').strip
+        [topic_name, args]
+      else
+        [topic_spec.strip, nil]
+      end
+    end
+
     ##
     ## Finalize and display output with run summary if applicable
     ##

data/lib/howzit/colors.rb

@@ -272,7 +272,7 @@ module Howzit
       def template(input)
         input = input.join(' ') if input.is_a? Array
         fmt = input.gsub(/%/, '%%')
-        fmt = fmt.gsub(/(?<!\\u|\$)\{(\w+)\}/i) do
+        fmt = fmt.gsub(/(?<!\\u|\$|\\\\)\{(\w+)\}/i) do
           m = Regexp.last_match(1)
           if m =~ /^[wkglycmrWKGLYCMRdbuix]+$/
             m.split('').map { |c| "%<#{c}>s" }.join('')
@@ -287,7 +287,9 @@ module Howzit
                    Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
                    d: dark, b: bold, u: underline, i: italic, x: reset }
 
-        fmt.empty? ? input : format(fmt, colors)
+        result = fmt.empty? ? input : format(fmt, colors)
+        # Unescape braces that were escaped to prevent color code interpretation
+        result.gsub(/\\\{/, '{').gsub(/\\\}/, '}')
       end
     end
 

data/lib/howzit/run_report.rb

@@ -29,8 +29,14 @@ module Howzit
     def format_line(entry, prefix_topic)
       symbol = entry[:success] ? '✅' : '❌'
       parts = ["#{symbol} "]
-      parts << "{bw}#{entry[:topic]}{x}: " if prefix_topic && entry[:topic] && !entry[:topic].empty?
-      parts << "{by}#{entry[:task]}{x}"
+      if prefix_topic && entry[:topic] && !entry[:topic].empty?
+        # Escape braces in topic name to prevent color code interpretation
+        topic_escaped = entry[:topic].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
+        parts << "{bw}#{topic_escaped}{x}: "
+      end
+      # Escape braces in task name to prevent color code interpretation
+      task_escaped = entry[:task].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
+      parts << "{by}#{task_escaped}{x}"
       unless entry[:success]
         reason = entry[:exit_status] ? "exit code #{entry[:exit_status]}" : 'failed'
         parts << " {br}(#{reason}){x}"
@@ -61,7 +67,7 @@ module Howzit
       table_lines.join("\n")
     end
 
-    def table_row_colored(status, task, task_plain, status_width, task_width)
+    def table_row_colored(status, task, task_plain, _status_width, task_width)
       task_padding = task_width - task_plain.length
 
       "|  #{status}  | #{task}#{' ' * task_padding} |"
@@ -76,11 +82,15 @@ module Howzit
       task_parts_plain = []
 
       if prefix_topic && entry[:topic] && !entry[:topic].empty?
-        task_parts << "{bw}#{entry[:topic]}{x}: "
+        # Escape braces in topic name to prevent color code interpretation
+        topic_escaped = entry[:topic].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
+        task_parts << "{bw}#{topic_escaped}{x}: "
         task_parts_plain << "#{entry[:topic]}: "
       end
 
-      task_parts << "{by}#{entry[:task]}{x}"
+      # Escape braces in task name to prevent color code interpretation
+      task_escaped = entry[:task].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
+      task_parts << "{by}#{task_escaped}{x}"
       task_parts_plain << entry[:task]
 
       unless entry[:success]

data/lib/howzit/stringutils.rb

@@ -337,7 +337,14 @@ module Howzit
       gsub!(/\$\{(?<name>[A-Z0-9_]+(?::.*?)?)\}/i) do
         m = Regexp.last_match
         arg, default = m['name'].split(/:/).map(&:strip)
-        Howzit.named_arguments.key?(arg) && !Howzit.named_arguments[arg].nil? ? Howzit.named_arguments[arg] : default
+        if Howzit.named_arguments && Howzit.named_arguments.key?(arg) && !Howzit.named_arguments[arg].nil?
+          Howzit.named_arguments[arg]
+        elsif default
+          default
+        else
+          # Preserve the original ${VAR} syntax if variable is not defined and no default provided
+          m[0]
+        end
       end
     end
 

data/lib/howzit/task.rb

@@ -26,7 +26,7 @@ module Howzit
       @arguments = attributes[:arguments] || []
 
       @type = attributes[:type] || :run
-      @title = attributes[:title] || nil
+      @title = attributes[:title].nil? ? nil : attributes[:title].to_s
       @parent = attributes[:parent] || nil
 
       @action = attributes[:action].render_arguments || nil
@@ -98,8 +98,19 @@ module Howzit
     ## Execute a run task
     ##
     def run_run
-      title = Howzit.options[:show_all_code] ? @action : @title
-      Howzit.console.info("#{@prefix}{bg}Running {bw}#{title}{x}".c)
+      # If a title was explicitly provided (different from action), always use it
+      # Otherwise, use action (or respect show_all_code if no title)
+      display_title = if @title && !@title.empty? && @title != @action
+                        # Title was explicitly provided, use it
+                        @title
+                      elsif Howzit.options[:show_all_code]
+                        # No explicit title, show code if requested
+                        @action
+                      else
+                        # No explicit title, use title if available (might be same as action), otherwise action
+                        @title && !@title.empty? ? @title : @action
+                      end
+      Howzit.console.info("#{@prefix}{bg}Running {bw}#{display_title}{x}".c)
       ENV['HOWZIT_SCRIPTS'] = File.expand_path('~/.config/howzit/scripts')
       res = system(@action)
       update_last_status(res ? 0 : 1)
@@ -110,8 +121,19 @@ module Howzit
     ## Execute a copy task
     ##
     def run_copy
-      title = Howzit.options[:show_all_code] ? @action : @title
-      Howzit.console.info("#{@prefix}{bg}Copied {bw}#{title}{bg} to clipboard{x}".c)
+      # If a title was explicitly provided (different from action), always use it
+      # Otherwise, use action (or respect show_all_code if no title)
+      display_title = if @title && !@title.empty? && @title != @action
+                        # Title was explicitly provided, use it
+                        @title
+                      elsif Howzit.options[:show_all_code]
+                        # No explicit title, show code if requested
+                        @action
+                      else
+                        # No explicit title, use title if available (might be same as action), otherwise action
+                        @title && !@title.empty? ? @title : @action
+                      end
+      Howzit.console.info("#{@prefix}{bg}Copied {bw}#{display_title}{bg} to clipboard{x}".c)
       Util.os_copy(@action)
       @last_status = 0
       true

data/lib/howzit/topic.rb

@@ -288,11 +288,18 @@ module Howzit
     def define_task_args(keys)
       cmd = keys[:cmd]
       obj = keys[:action]
-      title = keys[:title].nil? ? obj : keys[:title].strip
-      title = Howzit.options[:show_all_code] ? obj : title
+      # Extract and clean the title
+      raw_title = keys[:title]
+      # Determine the title: use provided title if available, otherwise use action
+      title = if raw_title.nil? || raw_title.to_s.strip.empty?
+                obj
+              else
+                raw_title.to_s.strip
+              end
+      # Store the actual title (not overridden by show_all_code - that's only for display)
       task_args = { type: :include,
                     arguments: nil,
-                    title: title,
+                    title: title.dup,  # Make a copy to avoid reference issues
                     action: obj,
                     parent: self }
       case cmd
@@ -303,6 +310,7 @@ module Howzit
           Howzit.arguments = args
           arguments
           title.sub!(/ *\[.*?\] *$/, '')
+          task_args[:title] = title
         end
 
         task_args[:type] = :include

data/lib/howzit/version.rb

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

data/spec/stringutils_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'StringUtils' do
+  describe '#render_named_placeholders' do
+    before do
+      Howzit.named_arguments = {}
+    end
+
+    it 'preserves ${VAR} syntax when variable is not defined' do
+      str = 'echo ${MY_VAR}'.dup
+      str.render_named_placeholders
+      expect(str).to eq('echo ${MY_VAR}')
+    end
+
+    it 'preserves ${VAR} syntax for multiple undefined variables' do
+      str = 'echo ${VAR1} and ${VAR2}'.dup
+      str.render_named_placeholders
+      expect(str).to eq('echo ${VAR1} and ${VAR2}')
+    end
+
+    it 'replaces ${VAR} with value when variable is defined' do
+      Howzit.named_arguments = { 'MY_VAR' => 'hello' }
+      str = 'echo ${MY_VAR}'.dup
+      str.render_named_placeholders
+      expect(str).to eq('echo hello')
+    end
+
+    it 'uses default value when variable is not defined but default is provided' do
+      str = 'echo ${MY_VAR:default_value}'.dup
+      str.render_named_placeholders
+      expect(str).to eq('echo default_value')
+    end
+
+    it 'replaces variable when defined even if default is provided' do
+      Howzit.named_arguments = { 'MY_VAR' => 'actual_value' }
+      str = 'echo ${MY_VAR:default_value}'.dup
+      str.render_named_placeholders
+      expect(str).to eq('echo actual_value')
+    end
+
+    it 'preserves ${VAR} in bash script blocks' do
+      script = <<~SCRIPT
+        #!/bin/bash
+        echo "The value is ${ENV_VAR}"
+        echo "Another ${OTHER_VAR}"
+      SCRIPT
+      str = script.dup
+      str.render_named_placeholders
+      expect(str).to eq(script)
+    end
+
+    it 'handles mixed defined and undefined variables' do
+      Howzit.named_arguments = { 'DEFINED_VAR' => 'value1' }
+      str = 'echo ${DEFINED_VAR} and ${UNDEFINED_VAR}'.dup
+      str.render_named_placeholders
+      expect(str).to eq('echo value1 and ${UNDEFINED_VAR}')
+    end
+
+    it 'handles nil named_arguments gracefully' do
+      Howzit.named_arguments = nil
+      str = 'echo ${MY_VAR}'.dup
+      expect { str.render_named_placeholders }.not_to raise_error
+      expect(str).to eq('echo ${MY_VAR}')
+    end
+  end
+
+  describe '#render_arguments' do
+    before do
+      Howzit.named_arguments = {}
+      Howzit.arguments = nil
+    end
+
+    it 'preserves ${VAR} syntax through render_arguments' do
+      str = 'echo ${BASH_VAR}'.dup
+      result = str.render_arguments
+      expect(result).to eq('echo ${BASH_VAR}')
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.24
+  version: 2.1.26
 platform: ruby
 authors:
 - Brett Terpstra
@@ -315,6 +315,7 @@ files:
 - spec/ruby_gem_spec.rb
 - spec/run_report_spec.rb
 - spec/spec_helper.rb
+- spec/stringutils_spec.rb
 - spec/task_spec.rb
 - spec/topic_spec.rb
 - spec/util_spec.rb
@@ -349,6 +350,7 @@ test_files:
 - spec/ruby_gem_spec.rb
 - spec/run_report_spec.rb
 - spec/spec_helper.rb
+- spec/stringutils_spec.rb
 - spec/task_spec.rb
 - spec/topic_spec.rb
 - spec/util_spec.rb