markdown_exec 3.0.9 → 3.1.0

data/lib/hash_delegator.rb

@@ -978,8 +978,8 @@ module MarkdownExec
       end
       OpenStruct.new(blocks: blocks, results: results)
     rescue StandardError
-      ww $@, $!, caller.deref
-      HashDelegator.error_handler('blocks_from_nested_files')
+      wwe 'link_state:', link_state, 'source_id:', source_id, 'btype:', btype,
+          'fcb:', fcb
     end
 
     def build_menu_options(exit_option, display_mode_option,
@@ -1110,6 +1110,7 @@ module MarkdownExec
       selected, mdoc, inherited_code: nil, force: true, only_default: false,
       silent:
     )
+      wwt :fcb, 'ux block with code', selected
       ret_command_result = nil
       exit_prompt = @delegate_object[:prompt_filespec_back]
 
@@ -1119,13 +1120,16 @@ module MarkdownExec
         label_format_below: @delegate_object[:shell_code_label_format_below],
         block_source: block_source
       )
+      wwt :required, required
 
       # process each ux block in sequence, setting ENV and collecting lines
       required_lines = []
       required[:blocks].each do |block|
         next unless block.type == BlockType::UX
 
-        case data = YAML.load(block.body.join("\n"))
+        wwt :fcb, 'a required block', block
+
+        case data = safe_yaml_load(block.body.join("\n"))
         when Hash
           export = parse_yaml_of_ux_block(
             data,
@@ -1175,10 +1179,12 @@ module MarkdownExec
         end
       end
 
-      ret_command_result || CommandResult.new(stdout: required_lines)
+      (ret_command_result || CommandResult.new(stdout: required_lines)).tap do |ret|
+        wwt :cr, ret
+      end
     rescue StandardError
-      ww $@, $!, caller.deref
-      HashDelegator.error_handler('code_from_ux_block_to_set_environment_variables')
+      wwe 'selected:', selected, 'required:', required, 'block:', block,
+          'data:', data
     end
 
     # sets ENV
@@ -1199,9 +1205,14 @@ module MarkdownExec
         end
       end
       code_lines
+    rescue StandardError
+      wwe 'selected:', selected, 'data:', data, 'key:', key, 'value:', value,
+          'code_lines:', code_lines, 'formatted_string:', formatted_string
     end
 
-    def code_line_safe_assign(name, value, force:)
+    # make a single line of shell code to assign an escaped value to a variable
+    # force/default
+    def code_line_to_assign_a_variable(name, value, force:)
       if force
         "#{name}=#{Shellwords.escape(value)}"
       else
@@ -1213,11 +1224,15 @@ module MarkdownExec
       extract_patterns = lambda do |key|
         return [] unless delegate_object[key].present?
 
-        HashDelegator.safeval(delegate_object[key]).map do |pc|
-          {
-            color_method: pc[:color_method].to_sym,
-            pattern: Regexp.new(pc[:pattern])
-          }
+        begin
+          (value = HashDelegator.safeval(delegate_object[key])).map do |pc|
+            {
+              color_method: pc[:color_method].to_sym,
+              pattern: Regexp.new(pc[:pattern])
+            }
+          end
+        rescue StandardError
+          wwe({ error: $!, callback: $@[0], key: key, value: value })
         end
       end
 
@@ -1958,8 +1973,9 @@ module MarkdownExec
 
       elsif selected.type == BlockType::LOAD
         debounce_reset
-        code_lines = execute_block_type_load_code_lines(selected)
-        next_state_append_code(selected, link_state, code_lines)
+        load_result = execute_block_type_load_code_lines(selected)
+        next_state_append_code(selected, link_state, load_result.code,
+                               mode: load_result.mode)
 
       elsif selected.type == BlockType::SAVE
         debounce_reset
@@ -2246,38 +2262,54 @@ module MarkdownExec
       )
       dirs.sort_by! { |f| File.mtime(f) }.reverse!
 
-      if !contains_glob?(block_data['directory']) &&
-         !contains_glob?(block_data['glob'])
-        if dirs[0]
-          File.readlines(dirs[0], chomp: true)
-        else
-          warn 'No matching file found.'
-        end
-      elsif (selected_option = select_option_with_metadata(
-        prompt_title,
-        [exit_prompt] + dirs.map do |file| # tty_menu_items
-          { name:
-              format(
-                block_data['view'] || view,
-                NamedCaptureExtractor.extract_named_group_match_data(
-                  file.match(
-                    Regexp.new(block_data['filename_pattern'] || filename_pattern)
-                  )
-                )
-              ),
-            oname: file }
-        end,
-        menu_options.merge(
-          cycle: true,
-          match_dml: false
-        )
-      ))
-        if selected_option.dname != exit_prompt
-          File.readlines(selected_option.oname, chomp: true)
+      code = if !contains_glob?(block_data['directory']) &&
+                !contains_glob?(block_data['glob'])
+               if dirs[0]
+                 File.readlines(dirs[0], chomp: true)
+               else
+                 warn 'No matching file found.'
+               end
+             elsif (selected_option = select_option_with_metadata(
+               prompt_title,
+               [exit_prompt] + dirs.map do |file| # tty_menu_items
+                 { name:
+                     format(
+                       block_data['view'] || view,
+                       NamedCaptureExtractor.extract_named_group_match_data(
+                         file.match(
+                           Regexp.new(block_data['filename_pattern'] || filename_pattern)
+                         )
+                       )
+                     ),
+                   oname: file }
+               end,
+               menu_options.merge(
+                 cycle: true,
+                 match_dml: false
+               )
+             ))
+               if selected_option.dname != exit_prompt
+                 File.readlines(selected_option.oname, chomp: true)
+               end
+             else
+               warn 'No matching files found.'
+             end
+
+      if (mode = block_data['mode']&.to_sym)
+        reason = 'specified Load mode'
+        unless [LoadMode::APPEND, LoadMode::REPLACE].include? mode
+          wwe 'Invalid mode', 'block_data:', block_data
         end
       else
-        warn 'No matching files found.'
+        reason = 'default Load mode'
+        mode = LoadMode::APPEND
       end
+
+      OpenStruct.new(
+        code: code,
+        mode: mode,
+        reason: reason
+      )
     end
 
     # Collects required code lines based on the selected block and
@@ -2521,6 +2553,7 @@ module MarkdownExec
     end
 
     def expand_references!(fcb, link_state)
+      # options expansions
       expand_variable_references!(
         blocks: [fcb],
         echo_formatter: method(:format_echo_command),
@@ -2591,17 +2624,20 @@ module MarkdownExec
     def export_echo_with_code(
       bash_script_lines, export, force:, silent:, string: nil
     )
+      wwp
       exportable = true
       command_result = nil
       new_lines = []
       export_string = string.nil? ? export.echo : string
       case export_string
       when String, Integer, Float, TrueClass, FalseClass
-        command_result, exportable, new_lines = output_from_adhoc_bash_script_file(
+        command_result, exportable, = output_from_adhoc_bash_script_file(
           join_array_of_arrays(
             bash_script_lines,
             %(printf '%s' "#{export_string}")
-          )
+          ),
+          export,
+          force: force
         )
         if command_result.exit_status == EXIT_STATUS_REQUIRED_EMPTY
           exportable = false
@@ -2619,7 +2655,9 @@ module MarkdownExec
             join_array_of_arrays(
               bash_script_lines,
               %(printf '%s' "#{expression}")
-            )
+            ),
+            export,
+            force: force
           )
           if command_result.exit_status == EXIT_STATUS_REQUIRED_EMPTY
             command_result.warning = warning_required_empty(export) unless silent
@@ -3524,12 +3562,13 @@ module MarkdownExec
       list[(index + 1) % list.size] # Get the next item, wrap around if at the end
     end
 
-    def next_state_append_code(selected, link_state, code_lines)
+    def next_state_append_code(selected, link_state, code_lines,
+                               mode: LoadMode::APPEND)
       next_state_set_code(
         selected,
         link_state,
         HashDelegator.flatten_and_compact_arrays(
-          link_state&.inherited_lines,
+          mode == LoadMode::APPEND ? link_state&.inherited_lines : [],
           code_lines.is_a?(Array) ? code_lines : [] # no code for :ux_exec_prohibited
         )
       )
@@ -3591,7 +3630,8 @@ module MarkdownExec
 
     def output_from_adhoc_bash_script_file(
       bash_script_lines,
-      export = nil
+      export = nil,
+      force:
     )
       Tempfile.create('script_exec') do |temp_file|
         temp_file.write(
@@ -3612,26 +3652,22 @@ module MarkdownExec
 
         output = `#{shell} #{temp_file.path}`
 
-        exportable = export ? export.exportable : false
+        exportable = if export&.exportable.nil?
+                       true
+                     else
+                       (export ? export.exportable : false)
+                     end
         new_lines = []
         # new_lines << { comment: 'output_from_adhoc_bash_script_file' }
-        if export
-          new_lines << "#{export.name}="
-          export_value = output
-          ### transform?
 
-          command_result, exportable, new_lines = export_echo_with_code(
-            [assign_key_value_in_bash(export.name, export_value)],
-            export,
-            force: force,
-            silent: silent,
-            string: export_value
-          )
-        else
-          command_result = CommandResult.new(
-            stdout: output,
-            exit_status: $?.exitstatus
-          )
+        command_result = CommandResult.new(
+          stdout: output,
+          exit_status: $?.exitstatus
+        )
+        exportable &&= command_result.success?
+        if exportable
+          new_lines << { name: export.name, force: force,
+                         text: command_result.stdout }
         end
 
         [
@@ -3641,6 +3677,7 @@ module MarkdownExec
         ]
       end
     rescue StandardError => err
+      # wwe 'bash_script_lines:', bash_script_lines, 'export:', export
       warn "Error executing script: #{err.message}"
       nil
     end
@@ -3792,7 +3829,9 @@ module MarkdownExec
       command_result_w_e_t_nl.new_lines.map do |name_force|
         comment = name_force.fetch(:comment, '')
         name = name_force.fetch(:name, '')
-        if !name.empty?
+        if name.empty?
+          "# #{comment}" unless comment.empty?
+        else
           transformed = if command_result_w_e_t_nl.transformable
                           transform_export_value(name_force[:text], export)
                         else
@@ -3802,13 +3841,11 @@ module MarkdownExec
           # store the transformed value in ENV
           EnvInterface.set(name, transformed)
 
-          set = code_line_safe_assign(
+          set = code_line_to_assign_a_variable(
             name, transformed, force: name_force[:force]
           )
 
           comment.empty? ? set : "#{set} # #{comment}"
-        else
-          "# #{comment}" if comment.empty?
         end
       end
     rescue StandardError
@@ -4584,7 +4621,6 @@ module MarkdownExec
       return value unless export.transform.present?
 
       if export.transform.is_a? Symbol
-        ### TBD validate for symbol
         value.send(export.transform)
       else
         format(
@@ -4722,7 +4758,9 @@ module MarkdownExec
 
         when :exec, UxActSource::EXEC
           command_result, = output_from_adhoc_bash_script_file(
-            join_array_of_arrays(bash_script_lines, export.exec)
+            join_array_of_arrays(bash_script_lines, export.exec),
+            export,
+            force: force
           )
 
           if command_result.exit_status == EXIT_STATUS_REQUIRED_EMPTY
@@ -4748,6 +4786,7 @@ module MarkdownExec
         end
 
       when :echo, UxActSource::ECHO
+        wwp
         command_result, exportable, new_lines = export_echo_with_code(
           bash_script_lines,
           export,
@@ -4756,7 +4795,7 @@ module MarkdownExec
         )
 
       when :edit, UxActSource::EDIT
-        output = nil
+        output = ''
         begin
           loop do
             print "#{export.prompt} [#{export.default}]: "
@@ -4777,13 +4816,14 @@ module MarkdownExec
           EnvInterface.set(export.name, output)
           new_lines << { name: export.name, force: force,
                          text: output }
-          command_result = CommandResult.new(stdout: output)
         end
+        command_result = CommandResult.new(stdout: output)
 
       when :exec, UxActSource::EXEC
         command_result, exportable, new_lines = output_from_adhoc_bash_script_file(
           join_array_of_arrays(bash_script_lines, export.exec),
-          export
+          export,
+          force: force
         )
 
       else
@@ -4829,7 +4869,8 @@ module MarkdownExec
               bash_script_lines,
               %(printf '%s' "#{export.echo}")
             ),
-            export
+            export,
+            force: force
           )
           export_init = cr_echo.stdout.split("\n").first
           command_result, exportable, new_lines = export_echo_with_code(
@@ -4844,7 +4885,8 @@ module MarkdownExec
           # extract first line from 'exec' output
           command_result, exportable, new_lines = output_from_adhoc_bash_script_file(
             join_array_of_arrays(bash_script_lines, export.exec),
-            export
+            export,
+            force: force
           )
           unless command_result.failure?
             export_init = command_result.stdout.split("\n").first
@@ -4883,12 +4925,14 @@ module MarkdownExec
           force: force,
           silent: silent
         )
+
       when :exec, UxActSource::EXEC
         raise unless export.exec.present?
 
         command_result, exportable, new_lines = output_from_adhoc_bash_script_file(
           join_array_of_arrays(bash_script_lines, export.exec),
-          export
+          export,
+          force: force
         )
 
       else
@@ -5554,6 +5598,16 @@ module MarkdownExec
         link_block_data[LinkKeys::FILE] || @delegate_object[:filename]
       end
     end
+
+    def safe_yaml_load(body)
+      return {} unless body&.present?
+
+      YAML.load(body.to_s)
+    rescue Psych::SyntaxError => err
+      wwe 'YAML parsing error', { body: body, error: err.message }
+    rescue StandardError => err
+      wwe 'YAML loading error', { body: body, error: err.message }
+    end
   end
 
   class HashDelegator < HashDelegatorParent

data/lib/markdown_exec/version.rb

@@ -7,5 +7,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '3.0.9'
+  VERSION = '3.1.0'
 end

data/lib/menu.src.yml

@@ -580,7 +580,8 @@
 
 - :opt_name: import_pattern
   :env_var: MDE_IMPORT_PATTERN
-  :default: "^(?<indention> *)@import +(?<name>.+?) *$"
+  :default: >-
+    ^(?<indention> *)@import +(?<name>\S+)(?<params>(?: +[A-Za-z_]\w*=(?:"[^"]*"|'[^']*'|\S+))*) *$
   :procname: val_as_str
 
 - :opt_name: line_decor_main

data/lib/menu.yml

@@ -490,7 +490,8 @@
   :procname: val_as_str
 - :opt_name: import_pattern
   :env_var: MDE_IMPORT_PATTERN
-  :default: "^(?<indention> *)@import +(?<name>.+?) *$"
+  :default: '^(?<indention> *)@import +(?<name>\S+)(?<params>(?: +[A-Za-z_]\w*=(?:"[^"]*"|''[^'']*''|\S+))*)
+    *$'
   :procname: val_as_str
 - :opt_name: line_decor_main
   :env_var: MDE_LINE_DECOR_MAIN

data/lib/ww.rb

@@ -22,6 +22,30 @@ def ww(*objs, **kwargs)
   ww0(*objs, **kwargs.merge(locations: caller_locations))
 end
 
+# select enabled, for exceptions
+# print a data object for the error, and the failing line
+def wwe(*objs, **kwargs)
+  ww0(*objs, **kwargs.merge(locations: caller_locations[0..0]))
+
+  raise StandardError, objs.first[:error]
+end
+
+# selectively enabled, for process tracking
+# print the failing line
+def wwp(*objs, **kwargs)
+  ww(*objs, **kwargs.merge(locations: caller_locations[0..0]))
+end
+
+# selectively enabled, for tagged
+# print the failing line
+# eg wwt :line, 'data:', data
+def wwt(*objs, **kwargs)
+  # return if [:line].include? objs.first
+
+  formatted = ['Tagged', objs.first] + objs[1..]
+  ww(*formatted, **kwargs.merge(locations: caller_locations[0..0]))
+end
+
 def ww0(*objs,
         category: nil,
         full_backtrace: false,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.1.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-12 00:00:00.000000000 Z
+date: 2025-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -139,11 +139,13 @@ files:
 - bats/history.bats
 - bats/import-conflict.bats
 - bats/import-duplicates.bats
+- bats/import-with-text-substitution.bats
 - bats/import.bats
 - bats/indented-block-type-vars.bats
 - bats/indented-multi-line-output.bats
 - bats/line-decor-dynamic.bats
 - bats/line-wrapping.bats
+- bats/load-vars-state-demo.bats
 - bats/markup.bats
 - bats/mde.bats
 - bats/option-expansion.bats
@@ -197,12 +199,25 @@ files:
 - docs/dev/import-duplicates-0.md
 - docs/dev/import-duplicates-1.md
 - docs/dev/import-missing.md
+- docs/dev/import-substitution-basic.md
+- docs/dev/import-substitution-compare.md
+- docs/dev/import-substitution-export.md
+- docs/dev/import-substitution-long.md
+- docs/dev/import-substitution-mixed.md
+- docs/dev/import-substitution-plant.md
+- docs/dev/import-substitution-quotes.md
+- docs/dev/import-substitution-research.md
+- docs/dev/import-substitution-simple.md
+- docs/dev/import-substitution-special.md
+- docs/dev/import-substitution-taxonomy.md
+- docs/dev/import-with-text-substitution.md
 - docs/dev/import.md
 - docs/dev/indented-block-type-vars.md
 - docs/dev/indented-multi-line-output.md
 - docs/dev/line-decor-dynamic.md
 - docs/dev/line-wrapping.md
 - docs/dev/linked-file.md
+- docs/dev/load-mode-demo.md
 - docs/dev/load1.sh
 - docs/dev/load_code.md
 - docs/dev/manage-saved-documents.md
@@ -236,6 +251,11 @@ files:
 - examples/example-document-opts.md
 - examples/import0.md
 - examples/import1.md
+- examples/import_with_substitution_demo.md
+- examples/imports/mixed_template.md
+- examples/imports/organism_template.md
+- examples/imports/template_mustache.md
+- examples/imports/template_vars.md
 - examples/include.md
 - examples/indent.md
 - examples/index.md
@@ -259,9 +279,12 @@ files:
 - examples/pause-after-execution.md
 - examples/plant.md
 - examples/port-blocks.md
+- examples/raw_replacement_demo.md
+- examples/recent_discoveries_demo.md
 - examples/save.md
 - examples/search.md
 - examples/table-markup.md
+- examples/template_syntax_demo.md
 - examples/text-markup.md
 - examples/title.md
 - examples/variable-expansion-save-block.md