markdown_exec 1.7 → 1.8

data/lib/mdoc.rb

@@ -21,7 +21,7 @@ module MarkdownExec
     #
     # @param table [Array<Hash>] An array of hashes representing markdown sections.
     #
-    def initialize(table)
+    def initialize(table = [])
       @table = table
     end
 
@@ -47,8 +47,8 @@ module MarkdownExec
       # write named variables to block at top of script
       #
       fcb[:body].join(' ').split.compact.map do |key|
-        format(opts[:block_type_port_set_format],
-               { key: key, value: ENV.fetch(key, nil) })
+        ### format(opts[:block_type_port_set_format], { key: key, value: ENV.fetch(key, nil) })
+        "key: #{key}, value: #{ENV.fetch(key, nil)}"
       end
     end
 
@@ -72,22 +72,30 @@ module MarkdownExec
     def collect_recursively_required_blocks(name)
       name_block = get_block_by_anyname(name)
       if name_block.nil? || name_block.keys.empty?
-        raise "Named code block `#{name}` not found."
+        raise "Named code block `#{name}` not found. (@#{__LINE__})"
       end
 
-      all = [name_block.oname] + recursively_required(name_block[:reqs])
+      # all_dependency_names = [name_block.oname] + recursively_required(name_block[:reqs])
+      dependencies = collect_dependencies(name_block[:oname])
+      all_dependency_names = collect_unique_names(dependencies).push(name_block[:oname]).uniq
+      unmet_dependencies = all_dependency_names.dup
 
-      # in order of appearance in document
+      # in order of appearance in document (@table)
       # insert function blocks
-      @table.select { |fcb| all.include? fcb.oname }
-            .map do |fcb|
+      blocks = @table.select { |fcb| all_dependency_names.include? fcb[:oname] }
+                     .map do |fcb|
+        unmet_dependencies.delete(fcb[:oname]) # may not exist if block name is duplicated
         if (call = fcb[:call])
           [get_block_by_oname("[#{call.match(/^%\((\S+) |\)/)[1]}]")
             .merge({ cann: call })]
         else
           []
         end + [fcb]
-      end.flatten(1)
+      end.flatten(1) #.tap { rbp }
+      { all_dependency_names: all_dependency_names, 
+        blocks: blocks, 
+        dependencies: dependencies, 
+        unmet_dependencies: unmet_dependencies }
     end
 
     # Collects recursively required code blocks and returns them as an array of strings.
@@ -95,10 +103,9 @@ module MarkdownExec
     # @param name [String] The name of the code block to start the collection from.
     # @return [Array<String>] An array of strings containing the collected code blocks.
     #
-    def collect_recursively_required_code(name, opts: {})
-      code = collect_wrapped_blocks(
-        blocks = collect_recursively_required_blocks(name)
-      ).map do |fcb|
+    def collect_recursively_required_code(name, label_body: true, label_format_above: nil, label_format_below: nil)
+      block_search = collect_recursively_required_blocks(name)
+      block_search.merge({ code: collect_wrapped_blocks(block_search[:blocks]).map do |fcb|
         if fcb[:cann]
           collect_block_code_cann(fcb)
         elsif fcb[:stdout]
@@ -108,11 +115,18 @@ module MarkdownExec
           nil
         elsif fcb[:shell] == BlockType::PORT
           collect_block_code_shell(fcb)
-        else
+        elsif label_body
+          [label_format_above && format(label_format_above, { name: fcb[:oname] })] + 
+           fcb[:body] + 
+           [label_format_below && format(label_format_below, { name: fcb[:oname] })]
+        else # raw body
           fcb[:body]
         end
-      end.compact.flatten(1)
-      { blocks: blocks, code: code }
+      end.compact.flatten(1).compact })
+    end
+
+    def collect_unique_names(hash)
+      hash.values.flatten.uniq
     end
 
     # Retrieves code blocks that are wrapped
@@ -209,6 +223,7 @@ module MarkdownExec
       end
     end
 
+    # if tr   ue
     # Recursively fetches required code blocks for a given list of requirements.
     #
     # @param reqs [Array<String>] An array of requirements to start the recursion from.
@@ -219,7 +234,7 @@ module MarkdownExec
 
       rem = reqs
       memo = []
-      while rem.count.positive?
+      while rem && rem.count.positive?
         rem = rem.map do |req|
           next if memo.include? req
 
@@ -232,6 +247,57 @@ module MarkdownExec
       memo
     end
 
+    # else
+    # Recursively fetches required code blocks for a given list of requirements.
+    #
+    # @param source [String] The name of the code block to start the recursion from.
+    # @return [Hash] A list of code blocks required by each source code block.
+    #
+    def recursively_required_hash(source, memo = Hash.new([]))
+      return memo unless source
+      return memo if memo.keys.include? source
+
+      block = get_block_by_anyname(source)
+      if block.nil? || block.keys.empty?
+        raise "Named code block `#{source}` not found. (@#{__LINE__})"
+      end
+
+      memo[source] = block[:reqs]
+      return memo unless memo[source]&.count&.positive?
+
+      memo[source].each do |req|
+        next if memo.keys.include? req
+
+        recursively_required_hash(req, memo)
+      end
+      memo
+    end
+
+    # end
+
+    # Recursively collects dependencies of a given source.
+    # @param source [String] The name of the initial source block.
+    # @param memo [Hash] A memoization hash to store resolved dependencies.
+    # @return [Hash] A hash mapping sources to their respective dependencies.
+    def collect_dependencies(source, memo = {})
+      return memo unless source
+
+      if (block = get_block_by_anyname(source)).nil? || block.keys.empty?
+        if true
+          return memo
+        else
+          raise "Named code block `#{source}` not found. (@#{__LINE__})"
+        end
+      end
+
+      return memo unless block[:reqs]
+
+      memo[source] = block[:reqs]
+
+      block[:reqs].each { |req| collect_dependencies(req, memo) unless memo.key?(req) }
+      memo
+    end
+
     def select_elements_with_neighbor_conditions(array,
                                                  last_selected_placeholder = nil, next_selected_placeholder = nil)
       selected_elements = []
@@ -283,16 +349,64 @@ if $PROGRAM_NAME == __FILE__
   Bundler.require(:default)
 
   require 'minitest/autorun'
+  require 'mocha/minitest'
 
   module MarkdownExec
+    class TestMDocCollectDependencies < Minitest::Test
+      def setup
+        @mdoc = MDoc.new
+      end
+
+      def test_collect_dependencies_with_no_source
+        assert_empty @mdoc.collect_dependencies(nil)
+      end
+
+      if false # must raise error
+        def test_collect_dependencies_with_nonexistent_source
+          assert_raises(RuntimeError) { @mdoc.collect_dependencies('nonexistent') }
+        end
+      end
+
+      def test_collect_dependencies_with_valid_source
+        @mdoc.stubs(:get_block_by_anyname).with('source1').returns({ reqs: ['source2'] })
+        @mdoc.stubs(:get_block_by_anyname).with('source2').returns({ reqs: [] })
+
+        expected = { 'source1' => ['source2'], 'source2' => [] }
+        assert_equal expected, @mdoc.collect_dependencies('source1')
+      end
+    end
+
+    class TestCollectUniqueNames < Minitest::Test
+      def setup
+        @mdoc = MDoc.new
+      end
+
+      def test_empty_hash
+        assert_empty @mdoc.collect_unique_names({})
+      end
+
+      def test_single_key
+        input = { group1: %w[Alice Bob Charlie] }
+        assert_equal %w[Alice Bob Charlie], @mdoc.collect_unique_names(input)
+      end
+
+      def test_multiple_keys
+        input = { group1: %w[Alice Bob], group2: %w[Charlie Alice] }
+        assert_equal %w[Alice Bob Charlie], @mdoc.collect_unique_names(input)
+      end
+
+      def test_no_unique_names
+        input = { group1: ['Alice'], group2: ['Alice'] }
+        assert_equal ['Alice'], @mdoc.collect_unique_names(input)
+      end
+    end
+
     class TestMDoc < Minitest::Test
       def setup
         @table = [
-          { oname: 'block1', body: ['code for block1'],
-            reqs: ['block2'] },
+          { oname: 'block1', body: ['code for block1'], reqs: ['block2'] },
           { oname: 'block2', body: ['code for block2'], reqs: nil },
-          { oname: 'block3', body: ['code for block3'],
-            reqs: ['block1'] }
+          { oname: 'block3', body: ['code for block3'], reqs: ['block1'] }
         ]
         @doc = MDoc.new(@table)
       end
@@ -312,15 +426,15 @@ if $PROGRAM_NAME == __FILE__
       end
 
       ### broken test
-      # def test_collect_recursively_required_blocks
-      #   result = @doc.collect_recursively_required_blocks('block3')
-      #   expected_result = [@table[0], @table[1], @table[2]]
-      #   assert_equal expected_result, result
+      def test_collect_recursively_required_blocks
+        result = @doc.collect_recursively_required_blocks('block3')[:blocks]
+        expected_result = [@table[0], @table[1], @table[2]]
+        assert_equal expected_result, result
 
-      #   assert_raises(RuntimeError) do
-      #     @doc.collect_recursively_required_blocks('missing_block')
-      #   end
-      # end
+        assert_raises(RuntimeError) do
+          @doc.collect_recursively_required_blocks('missing_block')
+        end
+      end
 
       def test_hide_menu_block_per_options
         opts = { hide_blocks_by_name: true,
@@ -338,11 +452,12 @@ if $PROGRAM_NAME == __FILE__
       # end
 
       def test_recursively_required
-        result = @doc.recursively_required(['block3'])
-        assert_equal %w[block3 block1 block2], result
+        result = @doc.recursively_required_hash('block3')
+        assert_equal ({ 'block3' => ['block1'], 'block1' => ['block2'], 'block2' => nil }),
+                     result
 
-        result_no_reqs = @doc.recursively_required(nil)
-        assert_equal [], result_no_reqs
+        result_no_reqs = @doc.recursively_required_hash(nil)
+        assert_equal ({}), result_no_reqs
       end
     end
 

data/lib/menu.src.yml

@@ -92,6 +92,51 @@
   :opt_name: document_load_opts_block_name
   :procname: val_as_str
 
+- :arg_name: BOOL
+  :default: false
+  :description: Dump BlocksInFile (stage 1)
+  :env_var: MDE_DUMP_BLOCKS_IN_FILE
+  :opt_name: dump_blocks_in_file
+  :procname: val_as_bool
+
+- :arg_name: BOOL
+  :default: false
+  :description: Dump MenuBlocks (stage 2)
+  :env_var: MDE_DUMP_MENU_BLOCKS
+  :opt_name: dump_menu_blocks
+  :procname: val_as_bool
+
+- :arg_name: BOOL
+  :default: false
+  :description: Dump selected block
+  :env_var: MDE_DUMP_SELECTED_BLOCK
+  :opt_name: dump_selected_block
+  :procname: val_as_bool
+
+- :default: fg_rgbh_E0_E0_20 # Y
+  :description: Color of exception detail
+  :env_var: MDE_EXCEPTION_COLOR_DETAIL
+  :opt_name: exception_color_detail
+  :procname: val_as_str
+
+- :default: " - %{detail}\n"
+  :description: Format for exception detail
+  :env_var: MDE_EXCEPTION_FORMAT_DETAIL
+  :opt_name: exception_format_detail
+  :procname: val_as_str
+
+- :default: fg_rgbh_E0_20_20 # R
+  :description: Color of exception name
+  :env_var: MDE_EXCEPTION_COLOR_NAME
+  :opt_name: exception_color_name
+  :procname: val_as_str
+
+- :default: "\n%{name}"
+  :description: Format for exception name
+  :env_var: MDE_EXCEPTION_FORMAT_NAME
+  :opt_name: exception_format_name
+  :procname: val_as_str
+
 - :arg_name: REGEX
   :default:
   :description: Exclude blocks with name matching
@@ -113,7 +158,7 @@
   :opt_name: exclude_expect_blocks
   :procname: val_as_bool
 
-- :default: magenta
+- :default: fg_rgbh_20_80_80
   :description: execution_report_preview_frame_color
   :env_var: MDE_EXECUTION_REPORT_PREVIEW_FRAME_COLOR
   :opt_name: execution_report_preview_frame_color
@@ -157,6 +202,13 @@
   :procname: val_as_str
   :short_name: f
 
+- :arg_name: FIND
+  :default: ""
+  :description: Find in documents
+  :long_name: find
+  :procname: find
+  :short_name: "?"
+
 - :default: "^# *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
@@ -196,6 +248,13 @@
   :opt_name: history_property_separator
   :procname: val_as_str
 
+- :arg_name: HOW
+  :default: ""
+  :description: Find in YAML configuration options
+  :long_name: how
+  :procname: how
+  :short_name: "?"
+
 - :default: "^ *@import +(?<name>.+?) *$"
   :env_var: MDE_IMPORT_PATTERN
   :opt_name: import_pattern
@@ -261,7 +320,7 @@
   :opt_name: menu_back_at_top
   :procname: val_as_bool
 
-- :default: plain
+- :default: fg_rgbh_40_c0_f0
   :description: Color of menu bash
   :env_var: MDE_MENU_BASH_COLOR
   :opt_name: menu_bash_color
@@ -281,7 +340,7 @@
   :opt_name: menu_blocks_with_headings
   :procname: val_as_bool
 
-- :default: fg_rgbh_aa_bb_aa
+- :default: fg_rgbh_80_80_20
   :description: Color of menu chrome
   :env_var: MDE_MENU_CHROME_COLOR
   :opt_name: menu_chrome_color
@@ -293,7 +352,7 @@
   :opt_name: menu_chrome_format
   :procname: val_as_str
 
-- :default: magenta
+- :default: fg_rgbh_20_98_80
   :description: Color of menu divider
   :env_var: MDE_MENU_DIVIDER_COLOR
   :opt_name: menu_divider_color
@@ -358,7 +417,7 @@
   :opt_name: menu_initial_divider
   :procname: val_as_str
 
-- :default: red
+- :default: fg_rgbh_20_E0_20 # G
   :description: Color of menu link
   :env_var: MDE_MENU_LINK_COLOR
   :opt_name: menu_link_color
@@ -370,7 +429,7 @@
   :opt_name: menu_link_format
   :procname: val_as_str
 
-- :default: fg_rgbh_88_88_88
+- :default: fg_rgbh_40_a0_a0
   :description: Color of menu note
   :env_var: MDE_MENU_NOTE_COLOR
   :opt_name: menu_note_color
@@ -404,13 +463,13 @@
   :opt_name: menu_option_exit_name
   :procname: val_as_str
 
-- :default: blue
+- :default: fg_rgbh_E0_60_E0 # R
   :description: Color of menu opts
   :env_var: MDE_MENU_OPTS_COLOR
   :opt_name: menu_opts_color
   :procname: val_as_str
 
-- :default: cyan
+- :default: fg_rgbh_E0_20_20
   :description: Color of menu opts
   :env_var: MDE_MENU_OPTS_SET_COLOR
   :opt_name: menu_opts_set_color
@@ -422,7 +481,7 @@
   :opt_name: menu_opts_set_format
   :procname: val_as_str
 
-- :default: cyan
+- :default: fg_rgbh_A0_20_D0 # V
   :description: Color of menu task
   :env_var: MDE_MENU_TASK_COLOR
   :opt_name: menu_task_color
@@ -446,13 +505,13 @@
   :opt_name: menu_task_symbol
   :procname: val_as_str
 
-- :default: blue
+- :default: fg_rgbh_E0_80_20
   :description: Color of menu vars
   :env_var: MDE_MENU_VARS_COLOR
   :opt_name: menu_vars_color
   :procname: val_as_str
 
-- :default: cyan
+- :default: fg_rgbh_E0_80_20
   :description: Color of menu vars
   :env_var: MDE_MENU_VARS_SET_COLOR
   :opt_name: menu_vars_set_color
@@ -499,13 +558,13 @@
   :opt_name: output_execution_label_format
   :procname: val_as_str
 
-- :default: yellow
+- :default: fg_rgbh_20_D8_80
   :description: Color of output_execution_label_name
   :env_var: MDE_OUTPUT_EXECUTION_LABEL_NAME_COLOR
   :opt_name: output_execution_label_name_color
   :procname: val_as_str
 
-- :default: plain
+- :default: fg_rgbh_20_E0_80
   :description: Color of output_execution_label_value
   :env_var: MDE_OUTPUT_EXECUTION_LABEL_VALUE_COLOR
   :opt_name: output_execution_label_value_color
@@ -567,7 +626,7 @@
   :opt_name: prompt_approve_block
   :procname: val_as_str
 
-- :default: cyan
+- :default: fg_rgbh_20_E8_80
   :description: Color of prompt after script execution
   :env_var: MDE_PROMPT_COLOR_AFTER_SCRIPT_EXECUTION
   :opt_name: prompt_color_after_script_execution
@@ -631,6 +690,12 @@
   :opt_name: run_last_script
   :procname: val_as_bool
 
+- :default: 1
+  :description: "Runtime exception error level (warn if < 0, ignore if 0, abort if > 0)"
+  :env_var: MDE_RUNTIME_EXCEPTION_ERROR_LEVEL
+  :opt_name: runtime_exception_error_level
+  :procname: val_as_int
+
 - :arg_name: BOOL
   :default: false
   :description: Save executed script
@@ -703,7 +768,7 @@
   :opt_name: saved_stdout_glob
   :procname: val_as_str
 
-- :default: green
+- :default: fg_rgbh_20_80_80
   :description: script_execution_frame_color
   :env_var: MDE_SCRIPT_EXECUTION_FRAME_COLOR
   :opt_name: script_execution_frame_color
@@ -721,7 +786,7 @@
   :opt_name: script_execution_tail
   :procname: val_as_str
 
-- :default: yellow
+- :default: fg_rgbh_20_80_80
   :description: Color of output divider
   :env_var: MDE_OUTPUT_DIVIDER_COLOR
   :opt_name: script_preview_frame_color
@@ -781,6 +846,18 @@
   :opt_name: shell
   :procname: val_as_str
 
+- :default: "#  -^-  +%{name}  -^-"
+  :description: shell_code_label_format_above
+  :env_var: MDE_SHELL_CODE_LABEL_FORMAT_ABOVE
+  :opt_name: shell_code_label_format_above
+  :procname: val_as_str
+
+- :default: "#  -v-  +%{name}  -v-"
+  :description: shell_code_label_format_below
+  :env_var: MDE_SHELL_CODE_LABEL_FORMAT_BELOW
+  :opt_name: shell_code_label_format_below
+  :procname: val_as_str
+
 - :description: List tab completions
   :long_name: tab-completions
   :opt_name: tab_completions
@@ -800,7 +877,7 @@
   :procname: version
   :short_name: v
 
-- :default: red
+- :default: fg_rgbh_E0_E0_20 # Y
   :description: Color of warning message
   :env_var: MDE_WARNING_COLOR
   :opt_name: warning_color