markdown_exec 2.8.1 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d752af0db5e1c1a770b64f9341c3d08e1e9bc8612230a9cb44ddc7fddc4c3051
-  data.tar.gz: 5ba8524b3323bd8333b82a5d0607fbb9db59a5157a1c7ae0564b3f624f26addd
+  metadata.gz: 066c72f2f85462a89163b7834669dee6526e516ee3ebfe4be2e8b269cb4ece36
+  data.tar.gz: 48c2bce9ac82cda2cbecca5bea4564b28013cdbab7005e249e8a856d0280afa0
 SHA512:
-  metadata.gz: 29b210e56b46a1edf099c02267e2b3c7cdae6701f7ee99d5a946d06eea7272da3534765110ec36a6de017a10d0f4833c9075c27dacb0cec8b050192d3892d748
-  data.tar.gz: e73cd906ce9035c8c78d2e301866af4a76bc7a730c5109fc8cc59ecf64679cb578fb04b324e700df064886d250c394c441f77850b9e21230d346d08bd92a9a5f
+  metadata.gz: fe1270b8cf11efc8ad9e81cb43052bc75cfc217e362c7d6e30acb6981a6d0be749f290b9b15ce1a2655d6a7e157177c4cd975aa61de22a6f6bafe2a835285228
+  data.tar.gz: 9445285db86af55fe5ba0b784a24d30dd418ac3d1dc551183a5a1b3b865df27a6b314ddc08b4a013de5e926e023439753fe08cd4ea8d6c6da0c0d9547e4a9546

data/.rubocop.yml

@@ -76,6 +76,9 @@ Security/YAMLLoad:
 Style/ClassVars:
   Enabled: false
 
+Style/CombinableLoops:
+  Enabled: false
+
 Style/CommentedKeyword:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## [2.8.2] - 2025-02-19
+
+### Added
+
+- UX blocks can add preconditions. Preconditions are variable names that must be set before the UX block is executed. If any preconditions are not set, a warning is displayed, and the sequence is aborted.
+- UX blocks can require shell an other UX blocks.
+- UX blocks are evaluated in order and calculation can depend on prior variables in the same sequence.
+
+### Changed
+
+- Hide all blocks per their initial title instead of `oname`.
+- Make menu blocks for list of files found to fix crash.
+- Use a block ID to recall the selected block.
+- UX blocks are hidden similar to the rest.
+
+## [2.8.1] - 2025-02-13
+
+### Added
+
+- BATS tests for UX block type.
+
+### Changed
+
+- Improve persistence of position in menu on reload
+- Update block-type-ux-exec BATS test.
+- Refactor menu for selecting items with facets.
+
 ## [2.8.0] - 2025-02-10
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.8.1)
+    markdown_exec (2.8.2)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)

data/bats/block-hide.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'hide blocks' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-hide.md \
+   'visible'
+}

data/bats/block-type-ux-require.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Output of executed commands as initial value' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-require.md \
+   'SPECIES=Pongo tapanuliensis_GENUS=Pongo_NAME=Pongo tapanuliensis - Pongo_NAME2=Pongo tapanuliensis - Pongo'
+}

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "2.8.1"
+  echo "2.8.2"
 }
 
 _mde() {

data/docs/dev/block-hide.md

@@ -0,0 +1,18 @@
+``` :(hidden)
+```
+``` :visible
+```
+/ ux block is displayed differently than other types
+```ux :()
+name: name
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+# Pattern for blocks to hide from user-selection
+block_name_include_match:
+  ^\(.*\)$
+
+# Pattern for the block name in the line defining the block
+block_name_match: |
+  :(?<title>\S+)( |$)
+```

data/docs/dev/block-type-ux-require.md

@@ -0,0 +1,28 @@
+/ an automatic UX block requires a shell block and another UX block
+``` :(shell)
+ENTITY='Pongo tapanuliensis,Pongo'
+```
+```ux :[document_ux_SPECIES] +(shell) +[ux_GENUS]
+default: :exec
+exec: printf "${ENTITY%%,*}"
+name: SPECIES
+```
+/ required ux block requires another
+```ux :[ux_GENUS] +[ux_NAME]
+default: :exec
+exec: printf "${ENTITY##*,}"
+name: GENUS
+```
+/ executed in context of prior ux blocks, uses their initial values
+```ux :[ux_NAME]
+default: :exec
+exec: printf "$SPECIES - $GENUS"
+name: NAME
+```
+/ executed after other ux blocks, uses their initial values
+```ux :[document_ux_NAME2]
+default: :exec
+exec: printf "$NAME"
+name: NAME2
+```
+@import bats-document-configuration.md

data/lib/fcb.rb

@@ -14,7 +14,8 @@ def parse_yaml_of_ux_block(
   export = data['export']
   export = data if export.nil?
   name = export['name']
-  raise "Invalid data: #{data.inspect}" unless name.present?
+
+  raise "Name is missing in UX block: #{data.inspect}" unless name.present?
 
   OpenStruct.new(
     allowed: export['allowed'],
@@ -22,6 +23,7 @@ def parse_yaml_of_ux_block(
     exec: export['exec'],
     menu_format: export['menu_format'] || menu_format,
     name: name,
+    preconditions: export['preconditions'],
     prompt: export['prompt'] || prompt,
     transform: export['transform'],
     validate: export['validate'] || validate
@@ -136,6 +138,7 @@ module MarkdownExec
           @attrs[:center] = table_center
           oname = @attrs[:oname] = format(export.menu_format, export.to_h)
         else
+          # triggered by an empty block
           raise "Invalid data type: #{data.inspect}"
         end
       end

data/lib/hash_delegator.rb

@@ -306,7 +306,7 @@ module HashDelegatorSelf
       table__hs.each do |table_hs|
         table_hs.substrings.each do |substrings|
           substrings.each do |node|
-            next unless node[:text].class == TrackedString
+            next unless node[:text].instance_of?(TrackedString)
 
             exceeded_table_cell ||= node[:text].exceeded
             truncated_table_cell = node[:text].truncated
@@ -606,6 +606,9 @@ module MarkdownExec
 
       @process_mutex = Mutex.new
       @process_cv = ConditionVariable.new
+      @dml_link_state = Struct.new(:document_filename, :inherited_lines)
+                              .new(@delegate_object[:filename], [])
+      @dml_menu_blocks = []
 
       @p_all_arguments = []
       @p_options_parsed = []
@@ -1022,25 +1025,11 @@ module MarkdownExec
       ]
     end
 
-    def neval(export_exec, inherited_code)
-      # ww0 export_exec
-      # ww0 inherited_code
-      code = (inherited_code || []) + [export_exec]
-      filespec = generate_temp_filename
-      File.write filespec, HashDelegator.join_code_lines(code)
-      File.chmod 0o755, filespec
-      # ww0 File.read(filespec)
-      ret = `#{filespec}`
-      File.delete filespec
-      ret
-    end
-
-    # sets ENV
+    # parse YAML body defining the UX for a single variable
+    # set ENV value for the variable and return code lines for the same
     def code_from_ux_block_to_set_environment_variables(
       selected, mdoc, inherited_code: nil, force: true, only_default: false
     )
-      # ww0 inherited_code
-      # ww0 mdoc
       exit_prompt = @delegate_object[:prompt_filespec_back]
 
       required = mdoc.collect_recursively_required_code(
@@ -1050,105 +1039,106 @@ module MarkdownExec
         block_source: block_source
       )
 
+      # process each ux block in sequence, setting ENV and collecting lines
       code_lines = []
-      case data = YAML.load(selected.body.join("\n"))
-      when Hash
-        export = parse_yaml_of_ux_block(
-          data,
-          prompt: @delegate_object[:prompt_ux_enter_a_value],
-          validate: '^(?<name>[^ ].*)$'
-        )
-
-        exportable = true
-        if only_default
-          value = case export.default
-                  # exec > default
-                  when :exec
-                    raise unless export.exec.present?
+      required[:blocks].each do |block|
+        next unless block.type == BlockType::UX
+
+        case data = YAML.load(block.body.join("\n"))
+        when Hash
+          export = parse_yaml_of_ux_block(
+            data,
+            prompt: @delegate_object[:prompt_ux_enter_a_value],
+            validate: '^(?<name>[^ ].*)$'
+          )
 
-                    n1 = neval(export.exec,
-                               (inherited_code || []) + required[:code])
+          # preconditions are variable names that must be set before the UX block is executed.
+          # if any precondition is not set, the sequence is aborted.
+          export.preconditions&.each do |precondition|
+            code_lines.push "[[ -z $#{precondition} ]] && exit 1"
+          end
 
-                    if export.transform.present?
-                      if export.transform.is_a? Symbol
-                        n1.send(export.transform)
-                      else
-                        format(
-                          export.transform,
-                          NamedCaptureExtractor.extract_named_groups(
-                            n1, export.validate
-                          )
-                        )
+          exportable = true
+          if only_default
+            value = case export.default
+                    # exec > default
+                    when :exec
+                      raise unless export.exec.present?
+
+                      output = export_exec_with_code(
+                        export, inherited_code, code_lines, required
+                      )
+                      if output == :invalidated
+                        return :ux_exec_prohibited
                       end
+
+                      transform_export_value(output, export)
+                    # default
                     else
-                      n1
+                      export.default.to_s
                     end
+          else
+            value = nil
 
-                  # default
-                  else
-                    export.default.to_s
-                  end
-        else
-          caps = nil
-          value = nil
-
-          # exec > allowed
-          if export.exec
-            value = neval(export.exec, (inherited_code || []) + required[:code])
-            caps = NamedCaptureExtractor.extract_named_groups(value,
-                                                              export.validate)
-
-          # allowed > prompt
-          elsif export.allowed && export.allowed.count.positive?
-            case (choice = prompt_select_code_filename(
-              [exit_prompt] + export.allowed,
-              string: export.prompt,
-              color_sym: :prompt_color_after_script_execution
-            ))
-            when exit_prompt
-              exportable = false
-            else
-              value = choice
-              caps = NamedCaptureExtractor.extract_named_groups(value,
-                                                                export.validate)
-            end
-
-          # prompt > default
-          elsif export.prompt.present?
-            begin
-              while true
-                print "#{export.prompt} [#{export.default}]: "
-                value = gets.chomp
-                value = export.default.to_s if value.empty?
-                caps = NamedCaptureExtractor.extract_named_groups(value,
-                                                                  export.validate)
-                break if caps
+            # exec > allowed
+            if export.exec
+              value = export_exec_with_code(
+                export, inherited_code, code_lines, required
+              )
+              if value == :invalidated
+                return :ux_exec_prohibited
+              end
 
-                # invalid input, retry
+            # allowed > prompt
+            elsif export.allowed && export.allowed.count.positive?
+              case (choice = prompt_select_code_filename(
+                [exit_prompt] + export.allowed,
+                string: export.prompt,
+                color_sym: :prompt_color_after_script_execution
+              ))
+              when exit_prompt
+                exportable = false
+              else
+                value = choice
+              end
 
+            # prompt > default
+            elsif export.prompt.present?
+              begin
+                loop do
+                  print "#{export.prompt} [#{export.default}]: "
+                  value = gets.chomp
+                  value = export.default.to_s if value.empty?
+                  caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                                    export.validate)
+                  break if caps
+
+                  # invalid input, retry
+                end
+              rescue Interrupt
+                exportable = false
               end
-            rescue Interrupt
-              exportable = false
+
+            # default
+            else
+              value = export.default
             end
 
-          # default
-          else
-            value = export.default
+            if exportable
+              value = transform_export_value(value, export)
+            end
           end
 
-          if exportable && export.transform.present?
-            value = format(export.transform, caps)
+          if exportable
+            ENV[export.name] = value.to_s
+            code_lines.push code_line_safe_assign(export.name, value,
+                                                  force: force)
           end
+        else
+          raise "Invalid data type: #{data.inspect}"
         end
-
-        if exportable
-          ENV[export.name] = value.to_s
-          code_lines.push code_line_safe_assign(export.name, value,
-                                                force: force)
-        end
-      else
-        raise "Invalid data type: #{data.inspect}"
       end
+
       code_lines
     end
 
@@ -1221,7 +1211,8 @@ module MarkdownExec
         command_execute_in_process(
           args: args, command: command,
           erls: erls,
-          filename: @delegate_object[:filename], shell: shell
+          filename: @delegate_object[:filename],
+          shell: shell
         )
       end
 
@@ -1285,7 +1276,8 @@ module MarkdownExec
     )
       execute_command_with_streams(
         [shell, '-c', command,
-         @delegate_object[:filename], *args]
+         @delegate_object[:filename],
+         *args]
       )
     end
 
@@ -1987,9 +1979,7 @@ module MarkdownExec
       )
 
       # dname is not fixed for some block types, use block id
-      if lfls.load_file != LoadFile::LOAD &&
-         [BlockType::HEADING, BlockType::TEXT,
-          BlockType::UX].include?(selected.type)
+      if lfls.load_file != LoadFile::LOAD
         block_selection = BlockSelection.new(selected.id)
       end
 
@@ -2173,24 +2163,24 @@ module MarkdownExec
         else
           warn 'No matching file found.'
         end
-      elsif selected_option = select_option_with_metadata(
+      elsif (selected_option = select_option_with_metadata(
         prompt_title,
         [exit_prompt] + dirs.map do |file|
-          { name: format(
-            block_data['view'] || view,
-            NamedCaptureExtractor.extract_named_group_match_data(
-              file.match(
-                Regexp.new(block_data['filename_pattern'] ||
-                           filename_pattern)
-              )
-            )
-          ),
+          { 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
         )
-      )
+      ))
         if selected_option.dname != exit_prompt
           File.readlines(selected_option.oname, chomp: true)
         end
@@ -2341,7 +2331,7 @@ module MarkdownExec
 
       interactive_menu_with_display_modes(
         files_table_rows,
-        display_formats: [:row, :file],
+        display_formats: %i[row file],
         display_mode_option: @delegate_object[:prompt_filespec_facet],
         exit_option: exit_prompt,
         menu_title: @delegate_object[:prompt_select_history_file],
@@ -2364,9 +2354,9 @@ module MarkdownExec
     def execute_inherited_save(
       code_lines: @dml_link_state.inherited_lines
     )
-      return unless save_filespec = save_filespec_from_expression(
-        document_name_in_glob_as_file_name
-      )
+      return unless (save_filespec = save_filespec_from_expression)
+
+      document_name_in_glob_as_file_name
 
       unless write_file_with_directory_creation(
         content: HashDelegator.join_code_lines(code_lines),
@@ -2422,6 +2412,27 @@ module MarkdownExec
       post_execution_process
     end
 
+    def execute_temporary_script(script_code, additional_code = [])
+      full_code = (additional_code || []) + [script_code]
+
+      Tempfile.create('script_exec') do |temp_file|
+        temp_file.write(HashDelegator.join_code_lines(full_code))
+        temp_file.flush
+        File.chmod(0o755, temp_file.path)
+
+        output = `#{temp_file.path}`
+
+        if $?.exitstatus != 0
+          return :invalidated
+        end
+
+        output
+      end
+    rescue StandardError => err
+      warn "Error executing script: #{err.message}"
+      nil
+    end
+
     def expand_blocks_with_replacements(
       menu_blocks, replacements, exclude_types: [BlockType::SHELL]
     )
@@ -2468,6 +2479,18 @@ module MarkdownExec
       expand_blocks_with_replacements(blocks, replacements)
     end
 
+    def export_exec_with_code(export, inherited_code, code_lines, required)
+      value = execute_temporary_script(
+        export.exec,
+        (inherited_code || []) +
+         code_lines + required[:code]
+      )
+      if value == :invalidated
+        warn "A value must exist for: #{export.preconditions.join(', ')}"
+      end
+      value
+    end
+
     # Retrieves a specific data symbol from the delegate object,
     # converts it to a string, and applies a color style
     # based on the specified color symbol.
@@ -2580,7 +2603,7 @@ module MarkdownExec
       # commands to echo variables
       #
       commands = {}
-      variable_counts.each do |variable, _count|
+      variable_counts.each_key do |variable|
         command = format(echo_format, variable)
         commands[variable] = command
       end
@@ -2637,7 +2660,6 @@ module MarkdownExec
     end
 
     def history_files(
-      link_state,
       direction: :reverse,
       filename: nil,
       home: Dir.pwd,
@@ -2950,19 +2972,24 @@ module MarkdownExec
       @ux_most_recent_filename = @delegate_object[:filename]
 
       (blocks.each.with_object([]) do |block, merged_options|
-        merged_options.push(
-          code_from_ux_block_to_set_environment_variables(
-            block,
-            mdoc,
-            force: @delegate_object[:ux_auto_load_force_default],
-            only_default: true
-          )
+        code = code_from_ux_block_to_set_environment_variables(
+          block,
+          mdoc,
+          force: @delegate_object[:ux_auto_load_force_default],
+          only_default: true
         )
+        if code == :ux_exec_prohibited
+          merged_options
+        else
+          merged_options.push(code)
+        end
       end).to_a
     end
 
-    def load_auto_vars_block(all_blocks,
-                             block_name: @delegate_object[:document_load_vars_block_name])
+    def load_auto_vars_block(
+      all_blocks,
+      block_name: @delegate_object[:document_load_vars_block_name]
+    )
       unless block_name.present? &&
              @vars_most_recent_filename != @delegate_object[:filename]
         return
@@ -3103,7 +3130,7 @@ module MarkdownExec
 
       # load document shell block
       #
-      if code_lines = load_document_shell_block(all_blocks, mdoc: mdoc)
+      if (code_lines = load_document_shell_block(all_blocks, mdoc: mdoc))
         next_state_set_code(nil, link_state, code_lines)
         link_state.inherited_lines = code_lines
         reload_blocks = true
@@ -3111,7 +3138,7 @@ module MarkdownExec
 
       # load document ux block
       #
-      if code_lines = load_auto_ux_block(all_blocks, mdoc)
+      if (code_lines = load_auto_ux_block(all_blocks, mdoc))
         new_code = HashDelegator.code_merge(link_state.inherited_lines,
                                             code_lines)
         next_state_set_code(nil, link_state, new_code)
@@ -3121,7 +3148,7 @@ module MarkdownExec
 
       # load document vars block
       #
-      if code_lines = load_auto_vars_block(all_blocks)
+      if (code_lines = load_auto_vars_block(all_blocks))
         new_code = HashDelegator.code_merge(link_state.inherited_lines,
                                             code_lines)
         next_state_set_code(nil, link_state, new_code)
@@ -3267,7 +3294,10 @@ module MarkdownExec
       next_state_set_code(
         selected,
         link_state,
-        HashDelegator.code_merge(link_state&.inherited_lines, code_lines)
+        HashDelegator.code_merge(
+          link_state&.inherited_lines,
+          code_lines.is_a?(Array) ? code_lines : [] # no code for :ux_exec_prohibited
+        )
       )
     end
 
@@ -3409,8 +3439,8 @@ module MarkdownExec
     #
     # @param all_blocks [Array<Hash>] The list of blocks from the file.
     def select_blocks(menu_blocks)
-      menu_blocks.select do |fcb|
-        !Filter.prepared_not_in_menu?(
+      menu_blocks.reject do |fcb|
+        Filter.prepared_not_in_menu?(
           @delegate_object,
           fcb,
           %i[block_name_include_match block_name_wrapper_match]
@@ -3659,16 +3689,16 @@ module MarkdownExec
 
       case @delegate_object[:publish_document_file_mode]
       when 'append'
-        File.write(pipe_path, message + "\n", mode: 'a')
+        File.write(pipe_path, "#{message}\n", mode: 'a')
       when 'fifo'
         unless @vux_pipe_open
           unless File.exist?(pipe_path)
-            FileUtils.mkfifo(pipe_path)
+            File.mkfifo(pipe_path)
             @vux_pipe_created = pipe_path
           end
           @vux_pipe_open = File.open(pipe_path, 'w')
         end
-        @vux_pipe_open.puts(message + "\n")
+        @vux_pipe_open.puts("#{message}\n")
         @vux_pipe_open.flush
       when 'write'
         File.write(pipe_path, message)
@@ -3695,7 +3725,6 @@ module MarkdownExec
       regexp: @delegate_object[:saved_asset_match]
     )
       history_files(
-        @dml_link_state,
         filename:
           if asset.present?
             saved_asset_filename(asset, @dml_link_state)
@@ -3710,7 +3739,8 @@ module MarkdownExec
         end
 
         saved_asset = saved_asset_for_history(
-          file: file, form: form,
+          file: file,
+          form: form,
           match_info: $LAST_MATCH_INFO
         )
         saved_asset == :break ? nil : saved_asset
@@ -3959,7 +3989,7 @@ module MarkdownExec
 
     def screen_width
       width = @delegate_object[:screen_width]
-      if width && width.positive?
+      if width&.positive?
         width
       else
         @delegate_object[:console_width]
@@ -3976,7 +4006,7 @@ module MarkdownExec
     end
 
     def select_document_if_multiple(options, files, prompt:)
-      return files if files.class == String
+      return files if files.instance_of?(String)
       return files[0] if (count = files.count) == 1
 
       return unless count >= 2
@@ -3994,7 +4024,11 @@ module MarkdownExec
 
     # Presents a TTY prompt to select an option or exit,
     #  returns metadata including option and selected
-    def select_option_with_metadata(prompt_text, menu_items, opts = {})
+    def select_option_with_metadata(
+      prompt_text, menu_items, opts = {}, menu_blocks: nil
+    )
+      @dml_menu_blocks = menu_blocks if menu_blocks
+
       ## configure to environment
       #
       register_console_attributes(opts)
@@ -4039,23 +4073,16 @@ module MarkdownExec
         return
       end
 
-      selected = menu_items.find do |item|
+      selected = @dml_menu_blocks.find do |item|
         if item.instance_of?(Hash)
           [item[:id], item[:name], item[:dname]].include?(selection)
         elsif item.instance_of?(MarkdownExec::FCB)
-          item.dname == selection || item.id == selection
+          item.id == selection
         else
           item == selection
         end
       end
 
-      # new FCB if selected is not an object
-      if selected.instance_of?(String)
-        selected = FCB.new(dname: selected)
-      elsif selected.instance_of?(Hash)
-        selected = FCB.new(selected)
-      end
-
       unless selected
         HashDelegator.error_handler('select_option_with_metadata',
                                     error: 'menu item not found')
@@ -4206,6 +4233,21 @@ module MarkdownExec
       HashDelegator.apply_color_from_hash(string, @delegate_object, color_sym)
     end
 
+    def transform_export_value(value, export)
+      return value unless export.transform.present?
+
+      if export.transform.is_a? Symbol
+        value.send(export.transform)
+      else
+        format(
+          export.transform,
+          NamedCaptureExtractor.extract_named_groups(
+            value, export.validate
+          )
+        )
+      end
+    end
+
     ##
     # Processes an individual line within a loop, updating headings
     #  and handling fenced code blocks.
@@ -4372,7 +4414,7 @@ module MarkdownExec
 
       when formatted_choice_ostructs[:history].pub_name
         debounce_reset
-        return :break unless files_table_rows = vux_history_files_table_rows
+        return :break unless (files_table_rows = vux_history_files_table_rows)
 
         execute_history_select(files_table_rows, stream: $stderr)
         return :break if pause_user_exit
@@ -4498,9 +4540,9 @@ module MarkdownExec
     end
 
     def vux_load_inherited
-      return unless filespec = load_filespec_from_expression(
+      return unless (filespec = load_filespec_from_expression(
         document_name_in_glob_as_file_name
-      )
+      ))
 
       @dml_link_state.inherited_lines_append(
         File.readlines(filespec, chomp: true)
@@ -4619,7 +4661,6 @@ module MarkdownExec
     )
       if @delegate_object[:menu_for_history]
         history_files(
-          @dml_link_state,
           filename: saved_asset_filename(@delegate_object[:filename],
                                          @dml_link_state),
           path: @delegate_object[:saved_script_folder]
@@ -4818,15 +4859,17 @@ module MarkdownExec
                           menu_blocks.find do |block|
                             block.dname.include?(prior_answer)
                           end&.name
-                        when Struct
+                        when Struct, MarkdownExec::FCB
                           if prior_answer.id
-                            menu_items.find_index do |block|
+                            # when switching documents, the prior answer will not be found
+                            (menu_blocks.find_index do |block|
                               block[:id] == prior_answer.id
-                            end + 1
+                            end || 0) + 1
                           else
                             prior_answer.index || prior_answer.name
                           end
                         end
+
       # prior_answer value may not match if color is different from
       # originating menu (opts changed while processing)
       selection_opts = if selected_answer
@@ -5157,13 +5200,12 @@ module MarkdownExec
 
   class TestHashDelegatorAppendDivider < Minitest::Test
     def setup
-      @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {
-                                  menu_divider_format: 'Format',
-                                  menu_initial_divider: 'Initial Divider',
-                                  menu_final_divider: 'Final Divider',
-                                  menu_divider_color: :color
-                                })
+      @hd = HashDelegator.new(
+        menu_divider_color: :color,
+        menu_divider_format: 'Format',
+        menu_final_divider: 'Final Divider',
+        menu_initial_divider: 'Initial Divider'
+      )
       @hd.stubs(:string_send_color).returns('Formatted Divider')
       HashDelegator.stubs(:safeval).returns('Safe Value')
     end
@@ -5185,7 +5227,7 @@ module MarkdownExec
     end
 
     def test_append_divider_without_format
-      @hd.instance_variable_set(:@delegate_object, {})
+      @hd = HashDelegator.new
       menu_blocks = []
       @hd.append_divider(menu_blocks: menu_blocks, position: :initial)
 
@@ -5223,7 +5265,6 @@ module MarkdownExec
       @hd = HashDelegator.new
       @hd.stubs(:iter_blocks_from_nested_files).yields(:blocks, FCB.new)
       @hd.stubs(:create_and_add_chrome_blocks)
-      @hd.instance_variable_set(:@delegate_object, {})
       HashDelegator.stubs(:error_handler)
     end
 
@@ -5234,7 +5275,7 @@ module MarkdownExec
     end
 
     def test_blocks_from_nested_files_with_no_chrome
-      @hd.instance_variable_set(:@delegate_object, { no_chrome: true })
+      @hd = HashDelegator.new(no_chrome: true)
       @hd.expects(:create_and_add_chrome_blocks).never
 
       result = @hd.blocks_from_nested_files
@@ -5246,7 +5287,6 @@ module MarkdownExec
   class TestHashDelegatorCollectRequiredCodeLines < Minitest::Test
     def setup
       @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {})
       @mdoc = mock('YourMDocClass')
       @selected = FCB.new(
         body: ['key: value'],
@@ -5272,15 +5312,13 @@ module MarkdownExec
   class TestHashDelegatorCommandOrUserSelectedBlock < Minitest::Test
     def setup
       @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {})
       HashDelegator.stubs(:error_handler)
       @hd.stubs(:wait_for_user_selected_block)
     end
 
     def test_command_selected_block
       all_blocks = [{ oname: 'block1' }, { oname: 'block2' }]
-      @hd.instance_variable_set(:@delegate_object,
-                                { block_name: 'block1' })
+      @hd = HashDelegator.new(block_name: 'block1')
 
       result = @hd.load_cli_or_user_selected_block(all_blocks: all_blocks)
 
@@ -5309,10 +5347,10 @@ module MarkdownExec
 
   class TestHashDelegatorCountBlockInFilename < Minitest::Test
     def setup
-      @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object,
-                                { fenced_start_and_end_regex: '^```',
-                                  filename: '/path/to/file' })
+      @hd = HashDelegator.new(
+        fenced_start_and_end_regex: '^```',
+        filename: '/path/to/file'
+      )
       @hd.stubs(:cfile).returns(mock('cfile'))
     end
 
@@ -5421,7 +5459,6 @@ module MarkdownExec
     def setup
       @hd = HashDelegator.new
       @hd.instance_variable_set(:@fout, mock('fout'))
-      @hd.instance_variable_set(:@delegate_object, {})
       @hd.stubs(:string_send_color)
     end
 
@@ -5443,7 +5480,6 @@ module MarkdownExec
   class TestHashDelegatorFetchColor < Minitest::Test
     def setup
       @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {})
     end
 
     def test_fetch_color_with_valid_data
@@ -5476,7 +5512,6 @@ module MarkdownExec
   class TestHashDelegatorFormatReferencesSendColor < Minitest::Test
     def setup
       @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {})
     end
 
     def test_format_references_send_color_with_valid_data
@@ -5581,7 +5616,6 @@ module MarkdownExec
     # )
 
     # def history_files(
-    #   link_state,
     #   direction: :reverse,
     #   filename: nil,
     #   home: Dir.pwd,
@@ -5590,9 +5624,10 @@ module MarkdownExec
     # )
 
     def test_call
-      @hd.expects(:history_files).with(nil, filename: '*', path: nil).once
-      @hd.execute_block_type_history_ux(filename: '*', link_state: LinkState.new,
-                                        selected: FCB.new(body: []))
+      @hd.expects(:history_files).with(filename: '*', path: nil).once
+      @hd.execute_block_type_history_ux(
+        filename: '*', link_state: LinkState.new, selected: FCB.new(body: [])
+      )
     end
   end
 
@@ -5677,11 +5712,9 @@ module MarkdownExec
 
   class TestHashDelegatorHandleStream < Minitest::Test
     def setup
-      @hd = HashDelegator.new
+      @hd = HashDelegator.new(output_stdout: true)
       @hd.instance_variable_set(:@run_state,
                                 OpenStruct.new(files: StreamsOut.new))
-      @hd.instance_variable_set(:@delegate_object,
-                                { output_stdout: true })
     end
 
     def test_handle_stream
@@ -5713,9 +5746,7 @@ module MarkdownExec
 
   class TestHashDelegatorIterBlocksFromNestedFiles < Minitest::Test
     def setup
-      @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object,
-                                { filename: 'test.md' })
+      @hd = HashDelegator.new(filename: 'test.md')
       @hd.stubs(:check_file_existence).with('test.md').returns(true)
       @hd.stubs(:initial_state).returns({})
       @hd.stubs(:cfile).returns(Minitest::Mock.new)
@@ -5744,12 +5775,11 @@ module MarkdownExec
 
   class TestHashDelegatorMenuChromeColoredOption < Minitest::Test
     def setup
-      @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {
-                                  menu_option_back_name: 'Back',
-                                  menu_chrome_color: :red,
-                                  menu_chrome_format: '-- %s --'
-                                })
+      @hd = HashDelegator.new(
+        menu_chrome_color: :red,
+        menu_chrome_format: '-- %s --',
+        menu_option_back_name: 'Back'
+      )
       @hd.stubs(:menu_chrome_formatted_option)
          .with(:menu_option_back_name).returns('-- Back --')
       @hd.stubs(:string_send_color)
@@ -5763,8 +5793,9 @@ module MarkdownExec
     end
 
     def test_menu_chrome_colored_option_without_color
-      @hd.instance_variable_set(:@delegate_object,
-                                { menu_option_back_name: 'Back' })
+      @hd = HashDelegator.new(menu_option_back_name: 'Back')
+      @hd.stubs(:menu_chrome_formatted_option)
+         .with(:menu_option_back_name).returns('-- Back --')
       assert_equal '-- Back --',
                    @hd.menu_chrome_colored_option(:menu_option_back_name)
     end
@@ -5772,11 +5803,10 @@ module MarkdownExec
 
   class TestHashDelegatorMenuChromeOption < Minitest::Test
     def setup
-      @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object, {
-                                  menu_option_back_name: "'Back'",
-                                  menu_chrome_format: '-- %s --'
-                                })
+      @hd = HashDelegator.new(
+        menu_chrome_format: '-- %s --',
+        menu_option_back_name: "'Back'"
+      )
       HashDelegator.stubs(:safeval).with("'Back'").returns('Back')
     end
 
@@ -5786,8 +5816,7 @@ module MarkdownExec
     end
 
     def test_menu_chrome_formatted_option_without_format
-      @hd.instance_variable_set(:@delegate_object,
-                                { menu_option_back_name: "'Back'" })
+      @hd = HashDelegator.new(menu_option_back_name: "'Back'")
       assert_equal 'Back',
                    @hd.menu_chrome_formatted_option(:menu_option_back_name)
     end
@@ -5795,10 +5824,12 @@ module MarkdownExec
 
   class TestHashDelegatorStartFencedBlock < Minitest::Test
     def setup
-      @hd = HashDelegator.new({
-                                block_name_wrapper_match: 'WRAPPER_REGEX',
-                                block_calls_scan: 'CALLS_REGEX'
-                              })
+      @hd = HashDelegator.new(
+        {
+          block_calls_scan: 'CALLS_REGEX',
+          block_name_wrapper_match: 'WRAPPER_REGEX'
+        }
+      )
     end
 
     def test_start_fenced_block
@@ -5816,9 +5847,7 @@ module MarkdownExec
 
   class TestHashDelegatorStringSendColor < Minitest::Test
     def setup
-      @hd = HashDelegator.new
-      @hd.instance_variable_set(:@delegate_object,
-                                { red: 'red', green: 'green' })
+      @hd = HashDelegator.new(red: 'red', green: 'green')
     end
 
     def test_string_send_color

data/lib/markdown_exec/version.rb

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

data/lib/markdown_exec.rb

@@ -656,32 +656,6 @@ module MarkdownExec
       @options.merge(@options.run_state.to_h)
     end
 
-    def iter_source_blocks(source, &block)
-      case source
-      when 1
-        HashDelegator.new(@options).blocks_from_nested_files.each(&block)
-      when 2
-        blocks_in_file, menu_blocks, mdoc =
-          HashDelegator.new(@options)
-                       .mdoc_menu_and_blocks_from_nested_files(LinkState.new)
-        blocks_in_file.each(&block)
-      when 3
-        blocks_in_file, menu_blocks, mdoc =
-          HashDelegator.new(@options)
-                       .mdoc_menu_and_blocks_from_nested_files(LinkState.new)
-        menu_blocks.each(&block)
-      else
-        @options.iter_blocks_from_nested_files do |btype, fcb|
-          case btype
-          when :blocks
-            yield fcb
-          when :filter
-            %i[blocks]
-          end
-        end
-      end
-    end
-
     ##
     # Returns a lambda expression based on the given procname.
     # @param procname [String] The name of the process to generate a lambda for.
@@ -916,7 +890,7 @@ module MarkdownExec
         # save value to options hash if option is named
         #
         lambda { |value|
-          name = item[:long_name]&.present? ? '--' + item[:long_name].to_s : '-' + item[:short_name].to_s
+          name = item[:long_name]&.present? ? "--#{item[:long_name]}" : "-#{item[:short_name]}"
           options_parsed << item.merge(name: name, value: value)
           (item[:proccode] ? item[:proccode].call(value) : value).tap do |converted|
             options[item[:opt_name]] = converted if item[:opt_name]
@@ -1013,7 +987,16 @@ module MarkdownExec
     # Presents a TTY prompt to select an option or exit, returns selected option or nil
     def select_option_or_exit(prompt_text, strings, opts = {})
       @options.select_option_with_metadata(
-        prompt_text, strings, opts
+        prompt_text,
+        strings,
+        opts,
+        menu_blocks: strings.map do |string|
+          FCB.new(
+            chrome: true,
+            dname: string,
+            id: string
+          )
+        end
       )&.fetch(:selected)
     end
 

data/lib/mdoc.rb

@@ -355,13 +355,12 @@ module MarkdownExec
       else
         opts[:hide_blocks_by_name] &&
           ((opts[:block_name_hidden_match]&.present? &&
-            block.oname&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
+            block.s2title&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
            (opts[:block_name_include_match]&.present? &&
-            block.oname&.match(Regexp.new(opts[:block_name_include_match]))) ||
+            block.s2title&.match(Regexp.new(opts[:block_name_include_match]))) ||
            (opts[:block_name_wrapper_match]&.present? &&
-            block.oname&.match(Regexp.new(opts[:block_name_wrapper_match])))) &&
-          (block.oname&.present? || block[:label]&.present?)
-
+            block.s2title&.match(Regexp.new(opts[:block_name_wrapper_match])))) &&
+          (block.s2title&.present? || block[:label]&.present?)
       end
     end
 
@@ -555,7 +554,7 @@ if $PROGRAM_NAME == __FILE__
       def test_hide_menu_block_on_name
         opts = { hide_blocks_by_name: true,
                  block_name_hidden_match: 'block1' }
-        block = FCB.new(oname: 'block1')
+        block = FCB.new(s2title: 'block1')
         result = @doc.hide_menu_block_on_name(opts, block)
         assert result # this should be true based on the given logic
       end

data/lib/menu.src.yml

@@ -54,6 +54,7 @@
 
 - :opt_name: block_name_match
   :env_var: MDE_BLOCK_NAME_MATCH
+  :description: Pattern for the block name in the line defining the block
   :default: ":(?<title>\\S+)( |$)"
   :procname: val_as_str
 

data/lib/menu.yml

@@ -44,6 +44,7 @@
   :procname: val_as_str
 - :opt_name: block_name_match
   :env_var: MDE_BLOCK_NAME_MATCH
+  :description: Pattern for the block name in the line defining the block
   :default: ":(?<title>\\S+)( |$)"
   :procname: val_as_str
 - :opt_name: block_name_nick_match

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.8.2
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -107,9 +107,11 @@ files:
 - assets/select_a_block.png
 - assets/select_a_file.png
 - bats/bats.bats
+- bats/block-hide.bats
 - bats/block-type-opts.bats
 - bats/block-type-ux-auto.bats
 - bats/block-type-ux-exec.bats
+- bats/block-type-ux-require.bats
 - bats/block-type-ux-row-format.bats
 - bats/block-type-ux-transform.bats
 - bats/block-type-vars.bats
@@ -140,11 +142,13 @@ files:
 - bin/tab_completion.sh
 - bin/tab_completion.sh.erb
 - docs/dev/bats-document-configuration.md
+- docs/dev/block-hide.md
 - docs/dev/block-type-bash.md
 - docs/dev/block-type-opts.md
 - docs/dev/block-type-port.md
 - docs/dev/block-type-ux-auto.md
 - docs/dev/block-type-ux-exec.md
+- docs/dev/block-type-ux-require.md
 - docs/dev/block-type-ux-row-format.md
 - docs/dev/block-type-ux-transform.md
 - docs/dev/block-type-vars.md