howzit 2.1.47 → 2.1.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477bc94918f7906d52412423ee73992f2d255279d757f36d0feed85f74c1f454
-  data.tar.gz: 926727bfe69e059367fa75d4b55b095786663487cdc8f311b13ee92dd44d15e0
+  metadata.gz: 2a6dffed9d9ce31f4704b3388bbf330f87d86f054067444073ea34b8cba13a54
+  data.tar.gz: 87cdb843c109e8f0b88e482634d0f35b676ffcd6e2732009f5a7aa60932f7fff
 SHA512:
-  metadata.gz: 8f4c4228bc522c7608f77d0ab4e7f4f802753e71c7f37d2f41d9f81e01764a8b0b285aaed8bc5bad6a9ccaa0544d83007bde4c7aea7c0e41bc2fc834bb8304d7
-  data.tar.gz: a24505c7b3f22f7d4bb52eb91372f44d0ef200285faf4006bb8a93588bdb63318063d26b5571026374f8f67b648678d0bd4edf4223c5561c39ad625ec2a08a69
+  metadata.gz: 4e278c055f9647bb784cfac2f1fe00616dde57023a5cd08e714097ccc3f32181ad67898da2507fe23c5496a235cdee5143c29918149a0a15d1e70574e3d535d8
+  data.tar.gz: 409df1fe83a7e46ba317d2c9cceb8346ea94c7578376f1836b7d9bb6cb17b83b51020955470d1371a27abb46150ec6af49da1e5b15ac8108eff9b9fccb625cc9

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 2.1.48
+
+2026-10-09 07:20
+
+#### CHANGED
+
+- **@before blocks** from a topic, its subtopics, and any included topics are shown together in one box before anything runs, with a single confirmation prompt instead of one prompt per topic
+- **@after blocks** from a topic, its subtopics, and any included topics are shown together in one box at the end of the run instead of after each topic finishes
+
+#### IMPROVED
+
+- **Collected notes** appear in document order: the topic's own block, then included topics in @include order, then subtopics
+- **@after notes from subtopics skipped after a failure** are still shown in the final box
+- **Notes from included topics** render variables with the bracketed arguments passed via @include(Topic [args])
+- **@before blocks** now render ${variables}, matching @after
+- **Topics included more than once** only contribute their notes once
+
 ### 2.1.47
 
 2026-09-27 13:20

data/lib/howzit/task.rb

@@ -6,7 +6,7 @@ module Howzit
   # Task object
   class Task
     attr_reader :type, :title, :action, :arguments, :parent, :optional, :default, :last_status, :log_level, :source_file,
-                :include_results
+                :include_results, :include_args
 
     ##
     ## Initialize a Task object

data/lib/howzit/topic.rb

@@ -165,34 +165,58 @@ module Howzit
     ## @return     [Array] output lines
     ##
     def run(nested: false, as_subtopic: false)
-      @results = { total: 0, success: 0, errors: 0, message: ''.c }
-      output = []
-      cols = check_cols
-
-      confirm_prereqs(cols) if !@prereqs.empty? && (all_tasks.any? || sequential?)
-
-      if sequential?
-        run_sequential(output: output)
-      elsif @tasks.any?
-        run_tasks(output)
-      elsif all_tasks.empty? && !as_subtopic && !directives?
-        Howzit.console.warn "{r}--run: No {br}@directive{xr} found in {bw}#{@title}{x}".c
-      end
+      # The outermost run shows @before/@after notes for the whole tree
+      return run_topic(nested: nested, as_subtopic: as_subtopic) if Howzit.topic_run_active
 
-      if halted?
-        log_skipped_tasks(@subtopics.flat_map(&:all_tasks))
-      else
-        run_subtopics(output)
+      Howzit.topic_run_active = true
+      begin
+        cols = check_cols
+        confirm_prereqs(cols) if all_tasks.any? || sequential?
+        output = run_topic(nested: nested, as_subtopic: as_subtopic)
+        show_postreqs(cols)
+        output
+      ensure
+        Howzit.topic_run_active = false
       end
+    end
 
-      if @results[:total].positive? || (all_tasks.any? && !sequential?)
-        @results[:message] += results_message
-        output.push(@results[:message]) if Howzit.options[:log_level] < 2 && !nested && !Howzit.options[:run]
-      end
+    ##
+    ## @before notes for this topic, the topics it includes, and its
+    ## subtopics, in document order
+    ##
+    ## @return     [Array] rendered notes
+    ##
+    def all_prereqs
+      collect_notes(:prereqs)
+    end
 
-      show_postreqs(cols)
+    ##
+    ## @after notes for this topic, the topics it includes, and its
+    ## subtopics, in document order
+    ##
+    ## @return     [Array] rendered notes
+    ##
+    def all_postreqs
+      collect_notes(:postreqs)
+    end
 
-      output
+    ##
+    ## Gather notes recursively through @include tasks and subtopics
+    ##
+    ## @param      kind  [Symbol] :prereqs or :postreqs
+    ## @param      args  [Array] Bracketed arguments from an @include
+    ## @param      seen  [Array] Titles of topics already collected
+    ##
+    def collect_notes(kind, args = nil, seen = [])
+      return [] if seen.include?(@title)
+
+      seen << @title
+      notes = render_notes(kind == :prereqs ? @prereqs : @postreqs, args)
+      @tasks.select { |task| task.type == :include }.each do |task|
+        topic = Howzit.buildnote.find_topic(task.action.sub(/ *\[.*?\] *$/, ''))[0]
+        notes.concat(topic.collect_notes(kind, task.include_args, seen)) if topic
+      end
+      notes + @subtopics.flat_map { |sub| sub.collect_notes(kind, nil, seen) }
     end
 
     ##
@@ -215,8 +239,11 @@ module Howzit
     end
 
     def confirm_prereqs(cols)
+      prereqs = all_prereqs
+      return if prereqs.empty?
+
       begin
-        puts TTY::Box.frame("{by}#{@prereqs.join("\n\n").wrap(cols - 4)}{x}".c, width: cols)
+        puts TTY::Box.frame("{by}#{prereqs.join("\n\n").wrap(cols - 4)}{x}".c, width: cols)
       rescue Errno::EPIPE
         # Pipe closed, ignore
       end
@@ -225,11 +252,11 @@ module Howzit
     end
 
     def show_postreqs(cols)
-      return if @postreqs.empty?
+      postreqs = all_postreqs
+      return if postreqs.empty?
 
-      # Apply variable substitution to postreqs content, then wrap each line individually to preserve structure
-      postreqs_content = @postreqs.join("\n\n").render_arguments
-      wrapped_content = postreqs_content.split(/\n/).map { |line| line.wrap(cols - 4) }.join("\n")
+      # Wrap each line individually to preserve structure
+      wrapped_content = postreqs.join("\n\n").split(/\n/).map { |line| line.wrap(cols - 4) }.join("\n")
       puts TTY::Box.frame("{bw}#{wrapped_content}{x}".c, width: cols)
     rescue Errno::EPIPE
       # Pipe closed, ignore
@@ -593,6 +620,55 @@ module Howzit
 
     private
 
+    def run_topic(nested:, as_subtopic:)
+      @results = { total: 0, success: 0, errors: 0, message: ''.c }
+      output = []
+
+      if sequential?
+        run_sequential(output: output)
+      elsif @tasks.any?
+        run_tasks(output)
+      elsif all_tasks.empty? && !as_subtopic && !directives?
+        Howzit.console.warn "{r}--run: No {br}@directive{xr} found in {bw}#{@title}{x}".c
+      end
+
+      if halted?
+        log_skipped_tasks(@subtopics.flat_map(&:all_tasks))
+      else
+        run_subtopics(output)
+      end
+
+      if @results[:total].positive? || (all_tasks.any? && !sequential?)
+        @results[:message] += results_message
+        output.push(@results[:message]) if Howzit.options[:log_level] < 2 && !nested && !Howzit.options[:run]
+      end
+
+      output
+    end
+
+    ##
+    ## Render notes with this topic's variables, plus any bracketed
+    ## @include arguments bound to its title parameters
+    ##
+    def render_notes(notes, args)
+      return [] if notes.empty?
+
+      previous = Howzit.named_arguments
+      begin
+        Howzit.named_arguments = (previous || {}).merge(@named_args.compact).merge(bound_arguments(args))
+        notes.map(&:render_arguments)
+      ensure
+        Howzit.named_arguments = previous
+      end
+    end
+
+    def bound_arguments(args)
+      return {} if args.nil? || args.empty?
+
+      names = @arg_definitions.map { |definition| definition.split(':', 2).first }
+      names.zip(args).to_h.compact
+    end
+
     ##
     ## Collect all directives in the topic content
     ##

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -60,7 +60,8 @@ require 'tty/box'
 # Main module for howzit
 module Howzit
   class << self
-    attr_accessor :arguments, :named_arguments, :cli_topic_positional_args, :cli_args, :run_log, :multi_topic_run
+    attr_accessor :arguments, :named_arguments, :cli_topic_positional_args, :cli_args, :run_log, :multi_topic_run,
+                  :topic_run_active
 
     ##
     ## Holds a Configuration object with methods and a @settings hash

data/spec/collected_notes_spec.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'fileutils'
+require 'tmpdir'
+require 'stringio'
+
+describe 'collected @before/@after notes' do
+  let(:temp_dir) { File.expand_path(Dir.mktmpdir('howzit_notes_test')) }
+  let(:out_file) { File.join(temp_dir, 'out.txt') }
+  let(:child_two_command) { 'false' }
+  let(:buildnote) do
+    note = Howzit::BuildNote.new
+    allow(note).to receive(:finalize_output)
+    note
+  end
+
+  before do
+    File.write(
+      File.join(temp_dir, 'buildnotes.md'),
+      <<~NOTE
+        # Notes Project
+
+        ## Parent
+
+        @before
+        Parent before
+        @end
+
+        @run(echo "parent" >> "#{out_file}") Parent task
+
+        @include(Shared [prod])
+
+        @after
+        Parent after
+        @end
+
+        ### Child One
+
+        @before
+        Child before
+        @end
+
+        @run(echo "child" >> "#{out_file}") Child task
+
+        @after
+        Child after
+        @end
+
+        ### Child Two
+
+        @run(#{child_two_command}) Child two task
+
+        ### Child Three
+
+        @run(echo "three" >> "#{out_file}") Three task
+
+        @after
+        Three after
+        @end
+
+        ## Shared (target)
+
+        @run(echo "shared ${target}" >> "#{out_file}") Shared task
+
+        @after
+        Shared after ${target}
+        @end
+      NOTE
+    )
+
+    Dir.chdir(temp_dir)
+    Howzit.instance_variable_set(:@buildnote, buildnote)
+    Howzit.options[:stack] = false
+    Howzit.options[:include_upstream] = false
+    Howzit.options[:run] = true
+    Howzit.options[:force] = false
+    Howzit.options[:log_level] = 3
+    Howzit.cli_args = ['parent']
+    Howzit.run_log = []
+    allow(Howzit::Prompt).to receive(:yn).and_return(true)
+  end
+
+  after do
+    Howzit.options[:run] = false
+    Howzit.options[:log_level] = 1
+    Howzit.cli_args = []
+    Howzit.run_log = []
+    Dir.chdir(Dir.tmpdir)
+    FileUtils.rm_rf(temp_dir) if Dir.exist?(temp_dir)
+    Howzit.instance_variable_set(:@buildnote, nil)
+  end
+
+  def run_and_capture
+    original = $stdout
+    $stdout = StringIO.new
+    buildnote.run
+    $stdout.string.gsub(/\e\[[\d;]*m/, '')
+  ensure
+    $stdout = original
+  end
+
+  def positions(text, notes)
+    notes.map { |note| text.index(note) }
+  end
+
+  it 'asks once for all prerequisites before running anything' do
+    text = run_and_capture
+
+    expect(Howzit::Prompt).to have_received(:yn).once
+    expect(positions(text, ['Parent before', 'Child before'])).to all(be_a(Integer))
+    expect(text.scan('Parent before').count).to eq 1
+  end
+
+  it 'shows all @after notes together in document order, including included topics' do
+    text = run_and_capture
+
+    notes = ['Parent after', 'Shared after prod', 'Child after', 'Three after']
+    found = positions(text, notes)
+    expect(found).to all(be_a(Integer))
+    expect(found).to eq(found.sort)
+    expect(text.scan('Child after').count).to eq 1
+  end
+
+  it 'shows notes from subtopics skipped after a failure' do
+    text = run_and_capture
+
+    expect(File.read(out_file).lines.map(&:strip)).to eq(['parent', 'shared prod', 'child'])
+    expect(text).to include('Three after')
+  end
+
+  context 'when nothing fails' do
+    let(:child_two_command) { 'true' }
+
+    it 'shows the combined @after box after all tasks have run' do
+      text = run_and_capture
+
+      expect(File.read(out_file).lines.map(&:strip)).to eq(['parent', 'shared prod', 'child', 'three'])
+      expect(text.scan('Parent after').count).to eq 1
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.47
+  version: 2.1.48
 platform: ruby
 authors:
 - Brett Terpstra
@@ -317,6 +317,7 @@ files:
 - scripts/runtests.sh
 - spec/buildnote_spec.rb
 - spec/cli_spec.rb
+- spec/collected_notes_spec.rb
 - spec/condition_evaluator_spec.rb
 - spec/conditional_blocks_integration_spec.rb
 - spec/conditional_content_spec.rb
@@ -367,6 +368,7 @@ summary: Provides a way to access Markdown project notes by topic with query cap
 test_files:
 - spec/buildnote_spec.rb
 - spec/cli_spec.rb
+- spec/collected_notes_spec.rb
 - spec/condition_evaluator_spec.rb
 - spec/conditional_blocks_integration_spec.rb
 - spec/conditional_content_spec.rb