howzit 2.1.25 → 2.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330829109ccbd73e32ce82690327d2776c1a2f4e60004165fbcde80bdb2b68d6
-  data.tar.gz: 402805ec02154f4ed0f219bc8975be8b1f24e5ca8726e2eb6040f905f32854c7
+  metadata.gz: cfddcd9969d36eaa46a5441a912b60a0d4622c7536ffd34c6aebe83cc3c840a3
+  data.tar.gz: 9e5d7fee17c7931fc03b455eebe411f1490e1c27d70545f5e5a3d62f492a2f50
 SHA512:
-  metadata.gz: 6f6f3ad81b25dc520f43a4ba1ca063a093dece43129c5ba86ed4364ecc4de5d9222f86ba64dbc91220d73197586846d92ff7f7b98251739881a3d140f453c0ea
-  data.tar.gz: 7b5eef5eb1cca9c57e3f7fa7af222911d43790b15bfb30b682c1c6f521cd1c54f8995a357141f1533830c888b91d79b107f3ec295b6238360719e1a6f2bb6032
+  metadata.gz: '019b3813e1f3ed8a79f70711a0f2dae38a83f0cfca205a32d9ab14794ba9815ce8d971d26f6bed0afbb90ce9d4ffd5d0d926cf50ef965cf806ffa45565203611'
+  data.tar.gz: c77fdeea70957604027d8152517498e8fe6df7043f36e139f8a81b23daca958d701a2dda786385921a6d9bf5c01acaca068375e7d3b9bd680091a3e988275069

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### 2.1.27
+
+2025-12-26 08:59
+
+#### IMPROVED
+
+- Task titles now support variable substitution using ${VAR} syntax, so titles like "@run(echo test) Title with ${var}" will replace ${var} with its value from topic metadata. This applies to all task types (run, copy, open, include) and code block titles.
+
+#### FIXED
+
+- Task and topic names containing dollar signs (like $text$ or ${VAR}) now display correctly in run report output without causing color code interpretation issues. Dollar signs are properly escaped during formatting and unescaped in the final output.
+
+### 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

data/lib/howzit/colors.rb

@@ -288,8 +288,8 @@ module Howzit
                    d: dark, b: bold, u: underline, i: italic, x: reset }
 
         result = fmt.empty? ? input : format(fmt, colors)
-        # Unescape braces that were escaped to prevent color code interpretation
-        result.gsub(/\\\{/, '{').gsub(/\\\}/, '}')
+        # Unescape braces and dollar signs that were escaped to prevent color code interpretation
+        result.gsub(/\\\{/, '{').gsub(/\\\}/, '}').gsub(/\\\$/, '$')
       end
     end
 

data/lib/howzit/run_report.rb

@@ -30,13 +30,13 @@ module Howzit
       symbol = entry[:success] ? '✅' : '❌'
       parts = ["#{symbol} "]
       if prefix_topic && entry[:topic] && !entry[:topic].empty?
-        # Escape braces in topic name to prevent color code interpretation
-        topic_escaped = entry[:topic].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
+        # Escape braces and dollar signs in topic name to prevent color code interpretation
+        topic_escaped = entry[:topic].gsub(/\{/, '\\{').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}"
+      # Escape braces and dollar signs in task name to prevent color code interpretation
+      task_escaped = entry[:task].gsub(/\{/, '\\{').gsub(/\}/, '\\}').gsub(/\$/, '\\$')
+      parts << "{by}#{task_escaped} {x}"
       unless entry[:success]
         reason = entry[:exit_status] ? "exit code #{entry[:exit_status]}" : 'failed'
         parts << " {br}(#{reason}){x}"
@@ -82,15 +82,15 @@ module Howzit
       task_parts_plain = []
 
       if prefix_topic && entry[:topic] && !entry[:topic].empty?
-        # Escape braces in topic name to prevent color code interpretation
-        topic_escaped = entry[:topic].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
+        # Escape braces and dollar signs in topic name to prevent color code interpretation
+        topic_escaped = entry[:topic].gsub(/\{/, '\\{').gsub(/\}/, '\\}').gsub(/\$/, '\\$')
         task_parts << "{bw}#{topic_escaped}{x}: "
         task_parts_plain << "#{entry[:topic]}: "
       end
 
-      # Escape braces in task name to prevent color code interpretation
-      task_escaped = entry[:task].gsub(/\{/, '\\{').gsub(/\}/, '\\}')
-      task_parts << "{by}#{task_escaped}{x}"
+      # Escape braces and dollar signs in task name to prevent color code interpretation
+      task_escaped = entry[:task].gsub(/\{/, '\\{').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/topic.rb

@@ -302,26 +302,31 @@ module Howzit
                     title: title.dup,  # Make a copy to avoid reference issues
                     action: obj,
                     parent: self }
+      # Set named_arguments before processing titles for variable substitution
+      Howzit.named_arguments = @named_args
       case cmd
       when /include/i
         if title =~ /\[(.*?)\] *$/
-          Howzit.named_arguments = @named_args
           args = Regexp.last_match(1).split(/ *, */).map(&:render_arguments)
           Howzit.arguments = args
           arguments
           title.sub!(/ *\[.*?\] *$/, '')
-          task_args[:title] = title
         end
+        # Apply variable substitution to title after bracket processing
+        task_args[:title] = title.render_arguments
 
         task_args[:type] = :include
         task_args[:arguments] = Howzit.named_arguments
       when /run/i
         task_args[:type] = :run
+        task_args[:title] = title.render_arguments
       when /copy/i
         task_args[:type] = :copy
         task_args[:action] = Shellwords.escape(obj)
+        task_args[:title] = title.render_arguments
       when /open|url/i
         task_args[:type] = :open
+        task_args[:title] = title.render_arguments
       end
 
       task_args
@@ -373,6 +378,8 @@ module Howzit
         if c[:cmd].nil?
           optional, default = define_optional(c[:optional2])
           title = c[:title2].nil? ? '' : c[:title2].strip
+          # Apply variable substitution to block title
+          title = title.render_arguments if title && !title.empty?
           block = c[:block]&.strip
           runnable << Howzit::Task.new({ type: :block,
                                          title: title,

data/lib/howzit/version.rb

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

data/spec/run_report_spec.rb

@@ -47,5 +47,25 @@ describe Howzit::RunReport do
     # Second line should be separator
     expect(lines[1]).to match(/^\|[\s:-]+\|[\s:-]+\|$/)
   end
+
+  it 'preserves dollar signs in task names without interfering with color codes' do
+    Howzit::RunReport.log({ topic: 'Test Topic', task: '$text$', success: true, exit_status: 0 })
+    Howzit::RunReport.log({ topic: 'Test', task: 'echo ${VAR}', success: true, exit_status: 0 })
+    plain = Howzit::RunReport.format.uncolor
+    expect(plain).to include('$text$')
+    expect(plain).to include('${VAR}')
+    # Verify dollar signs are preserved and not causing color code issues
+    expect(plain).not_to include('{x}')
+    expect(plain.scan(/\$\{x\}/).length).to eq(0)
+  end
+
+  it 'preserves dollar signs in topic names without interfering with color codes' do
+    Howzit.multi_topic_run = true
+    Howzit::RunReport.log({ topic: '$dollar$ Topic', task: 'Some Task', success: true, exit_status: 0 })
+    plain = Howzit::RunReport.format.uncolor
+    expect(plain).to include('$dollar$ Topic')
+    expect(plain).not_to include('{x}')
+    expect(plain.scan(/\$\{x\}/).length).to eq(0)
+  end
 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
+

data/spec/topic_spec.rb

@@ -101,4 +101,33 @@ describe Howzit::Topic do
       expect(topic.print_out({ single: true, header: true }).join("\n").uncolor).to match(/▶ ls -1/)
     end
   end
+
+
+  describe '.arguments' do
+    before do
+      Howzit.arguments = []
+    end
+
+    it 'extracts named arguments from topic title with defaults' do
+      topic = Howzit::Topic.new('Test Topic (var1:default1, var2:default2)', 'Content')
+      expect(topic.named_args['var1']).to eq('default1')
+      expect(topic.named_args['var2']).to eq('default2')
+    end
+
+    it 'does nothing when title has no arguments' do
+      topic = Howzit::Topic.new('Test Topic', 'Content')
+      expect(topic.named_args).to eq({})
+    end
+
+    it 'cleans title after extracting arguments' do
+      topic = Howzit::Topic.new('Test Topic (var:val)', 'Content')
+      expect(topic.title).to eq('Test Topic')
+    end
+
+    it 'uses provided arguments over defaults' do
+      Howzit.arguments = ['provided_value']
+      topic = Howzit::Topic.new('Test Topic (var:default_value)', 'Content')
+      expect(topic.named_args['var']).to eq('provided_value')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.25
+  version: 2.1.27
 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