markdown_exec 1.8.5 → 1.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e802d2af4a779aad7091b20ab189a4c324f15f53643880758b7aac76549ba49
-  data.tar.gz: 2d6f910706bd10232f8bb87313364f671d3871e06382d57dd6248f07c4e497f2
+  metadata.gz: 44e42ccdbdf5eed7e6ee36add8a5dcdcfe62d6cd3fb6fd531daf960c6ce7c9b7
+  data.tar.gz: 753076d46e44f5d17698be53a0421212d8f2c804368f9737591dc92a7d5457d6
 SHA512:
-  metadata.gz: c0e4b6ff95bccd281e078eb934d3660c52c28530ae12694c81030b3254de468b24d1d93e2e4d68b4d1163be68de029750930f3de0c3034154b05afde6ac9b42a
-  data.tar.gz: 85e260930e3d097e7028ae16cfeb7905fa702accd1fe2bb5b27fdb817d301be10259069be7c7e99f4af5258efbc7be5867d82834cee68bdc8d4e6485592f821e
+  metadata.gz: 84d952fcfafed40a5e3949783760aec570448de48293fdae536b5386b95d8080d2c9c41f0149861686d2fd4985a59ebea6794e7953d7b4dc1185340d790e68a2
+  data.tar.gz: 9db0c523154e32c3094046084594564c9114fbd2519f6ff5d9a8fcc5feb0d31b76dc3ccd1d6c4e2625507b81b4f70f9b6fdf31e250d132a5fdf2fa54d3cb8c77

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [1.8.6] - 2023-12-25
+
+### Added
+
+- Default path for find command
+
+### Changed
+
+- Refactor command-line processing
+
 ## [1.8.5] - 2023-12-22
 
 ### Added

data/Gemfile.lock

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

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.8.5"
+  echo "1.8.6"
 }
 
 _mde() {
@@ -54,6 +54,8 @@ _mde() {
             
               -?) COMPREPLY="''"; return 0 ;;
             
+              --find-path) COMPREPLY="''"; return 0 ;;
+            
               --how) COMPREPLY="''"; return 0 ;;
             
               -?) COMPREPLY="''"; return 0 ;;
@@ -92,7 +94,7 @@ _mde() {
   # present matching option names
   #
   if [[ ${cur} == -* ]] ; then
-    opts=("--block-name" "--config" "--debug" "--dump-dump-delegate-object" "--dump-blocks-in-file" "--dump-dump-inherited-lines" "--dump-menu-blocks" "--dump-selected-block" "--exit" "--filename" "--find" "--help" "--how" "--list-blocks" "--list-count" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--pwd" "--run-last-script" "--save-executed-script" "--save-execution-output" "--saved-script-folder" "--saved-stdout-folder" "--select-recent-output" "--select-recent-script" "--tab-completions" "--user-must-approve" "--version" "--display-level")
+    opts=("--block-name" "--config" "--debug" "--dump-dump-delegate-object" "--dump-blocks-in-file" "--dump-dump-inherited-lines" "--dump-menu-blocks" "--dump-selected-block" "--exit" "--filename" "--find" "--find-path" "--help" "--how" "--list-blocks" "--list-count" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--pwd" "--run-last-script" "--save-executed-script" "--save-execution-output" "--saved-script-folder" "--saved-stdout-folder" "--select-recent-output" "--select-recent-script" "--tab-completions" "--user-must-approve" "--version" "--display-level")
     COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
 
     return 0
@@ -133,6 +135,8 @@ _mde() {
         
           -?) COMPREPLY=".FIND."; return 0 ;;
         
+          --find-path) COMPREPLY=".FIND_PATH."; return 0 ;;
+        
           --how) COMPREPLY=".HOW."; return 0 ;;
         
           -?) COMPREPLY=".HOW."; return 0 ;;
@@ -174,4 +178,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2023-12-22 22:55:35 UTC"
+# echo "Updated: 2023-12-26 00:07:49 UTC"

data/examples/linked.md

@@ -1,6 +1,7 @@
 Demonstrate setting a variable interactively for use in generated scripts.
 
 ```opts :(document_options)
+dump_inherited_lines: true
 pause_after_script_execution: false
 user_must_approve: false
 ```
@@ -15,6 +16,15 @@ block: display_variable
 VARIABLE=A
 ```
 
+```link :set_to_A_eval +(set_to_A_eval)
+block: display_variable
+eval: true
+```
+
+```bash :(set_to_A_eval)
+echo VARIABLE=A
+```
+
 ::: Set VARIABLE to "B"
 
 ```link :set_to_B +(set_to_B)
@@ -25,6 +35,15 @@ block: display_variable
 VARIABLE=B
 ```
 
+```link :set_to_B_eval +(set_to_B_eval)
+block: display_variable
+eval: true
+```
+
+```bash :(set_to_B_eval)
+echo VARIABLE=B
+```
+
 ::: Display value of VARIABLE
 
 ```bash :display_variable

data/examples/linked1.md

@@ -1,5 +1,11 @@
 # Demo document linking
 
+```opts :(document_options)
+dump_inherited_lines: true
+pause_after_script_execution: false
+user_must_approve: false
+```
+
 ::: * This is document 1 *
 ::: This document links to a matching document to demonstrate navigation between documents.
 
@@ -15,6 +21,10 @@ colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environme
 PAGE2_VAR_VIA_INHERIT=for_page2_from_page1_via_inherited_code_blocks
 ```
 
+```link :linked2 +(vars2)
+file: examples/linked2.md
+```
+
 ```link :(linked2) +(vars2)
 file: examples/linked2.md
 ```

data/examples/linked2.md

@@ -20,6 +20,10 @@ colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environme
 PAGE3_VAR_VIA_INHERIT=for_page3_from_page2_via_inherited_code_blocks
 ```
 
+```link :linked3 +(vars3)
+file: examples/linked3.md
+```
+
 ```link :(linked3) +(vars3)
 file: examples/linked3.md
 ```

data/examples/opts.md

@@ -2,13 +2,15 @@
 
 ::: These Opts blocks set the color of a couple of menu options to demonstrate the live update of options.
 
-```opts :opts1
+```opts
+# color scheme 1
 menu_divider_color: yellow
 menu_note_match: "^ *(?<line>.+?) *$"
 menu_task_color: fg_rgb_255_63_255
 ```
 
-```opts :opts2
+```opts
+# color scheme 2
 menu_divider_color: red
 menu_note_color: yellow
 menu_note_match: "^\\+ +(?<line>.+?) *$"
@@ -27,3 +29,21 @@ note 1
 note 2 ends with /
  / note 3 starts with /
 note 4
+
+::: These options toggle the dump of debug information.
+
+```opts
+dump_blocks_in_file: true      # Dump BlocksInFile (stage 1)
+dump_delegate_object: true     # Dump @delegate_object
+dump_inherited_lines: true     # Dump inherited lines
+dump_menu_blocks: true         # Dump MenuBlocks (stage 2)
+dump_selected_block: true      # Dump selected block
+```
+
+```opts
+dump_blocks_in_file: false     # Dump BlocksInFile (stage 1)
+dump_delegate_object: false    # Dump @delegate_object
+dump_inherited_lines: false    # Dump inherited lines
+dump_menu_blocks: false        # Dump MenuBlocks (stage 2)
+dump_selected_block: false     # Dump selected block
+```

data/lib/cached_nested_file_reader.rb

@@ -6,15 +6,9 @@
 # version 2023-10-03
 
 require 'fileutils'
+require_relative 'constants'
 require_relative 'exceptions'
 
-# a struct to hold the data for a single line
-NestedLine = Struct.new(:text, :depth) do
-  def to_s
-    text
-  end
-end
-
 ##
 # The CachedNestedFileReader class provides functionality to read file lines with the ability
 # to process '#import filename' directives. When such a directive is encountered in a file,

data/lib/constants.rb

@@ -3,12 +3,20 @@
 
 # encoding=utf-8
 
+require_relative 'block_types'
+
 class ExecutionStreams
   StdErr = :stderr
   StdIn  = :stdin
   StdOut = :stdout
 end
 
+IndexedLine = Struct.new(:index, :line) do
+  def to_s
+    line
+  end
+end
+
 class LoadFile
   Load = true
   Reuse = false
@@ -34,6 +42,13 @@ class MenuState
   EXIT = :exit
 end
 
+# a struct to hold the data for a single line
+NestedLine = Struct.new(:text, :depth) do
+  def to_s
+    text
+  end
+end
+
 # selected block and subsequent menu state
 #
 SelectedBlockMenuState = Struct.new(:block, :state)
@@ -44,3 +59,5 @@ SHELL_COLOR_OPTIONS = {
   BlockType::OPTS => :menu_opts_color,
   BlockType::VARS => :menu_vars_color
 }.freeze
+
+### Struct.new(:state, :block)

data/lib/directory_searcher.rb

@@ -4,6 +4,7 @@
 # encoding=utf-8
 
 require 'find'
+require_relative 'constants'
 
 def format_and_highlight_hash(
   data,
@@ -89,12 +90,6 @@ def format_and_highlight_lines(
                                      highlight_color_sym)}#{line_postfix}\n" + formatted_deps.join("\n")
 end
 
-IndexedLine = Struct.new(:index, :line) do
-  def to_s
-    line
-  end
-end
-
 # Class DirectorySearcher
 # This class provides methods to search for a specified pattern
 # in directory names, file names, and contents of files within given paths.

data/lib/hash_delegator.rb

@@ -359,7 +359,7 @@ module MarkdownExec
       @fout.fout "Error ENOENT: #{err.inspect}"
     end
 
-    def command_or_user_selected_block(all_blocks, menu_blocks, default)
+    def load_cli_or_user_selected_block(all_blocks, menu_blocks, default)
       if @delegate_object[:block_name].present?
         block = all_blocks.find do |item|
           item[:oname] == @delegate_object[:block_name]
@@ -373,7 +373,7 @@ module MarkdownExec
 
       SelectedBlockMenuState.new(block, state)
     rescue StandardError
-      error_handler('command_or_user_selected_block')
+      error_handler('load_cli_or_user_selected_block')
     end
 
     # This method is responsible for handling the execution of generic blocks in a markdown document.
@@ -383,8 +383,7 @@ module MarkdownExec
     # @param mdoc [Object] The markdown document object containing code blocks.
     # @param selected [Hash] The selected item from the menu to be executed.
     # @return [LoadFileLinkState] An object indicating whether to load the next block or reuse the current one.
-    def compile_execute_bash_and_special_blocks_and_trigger_reuse(mdoc, selected,
-                                                                  link_state = nil, block_source:)
+    def compile_execute_and_trigger_reuse(mdoc, selected, link_state = nil, block_source:)
       required_lines = collect_required_code_lines(mdoc, selected, link_state,
                                                    block_source: block_source)
       output_or_approval = @delegate_object[:output_script] || @delegate_object[:user_must_approve]
@@ -602,8 +601,8 @@ module MarkdownExec
     # @param opts [Hash] Options hash containing configuration settings.
     # @param mdoc [YourMDocClass] An instance of the MDoc class.
     #
-    def execute_bash_and_special_blocks(selected, mdoc, link_state = LinkState.new,
-                                        block_source:)
+    def execute_shell_type(selected, mdoc, link_state = LinkState.new,
+                           block_source:)
       if selected.fetch(:shell, '') == BlockType::LINK
         push_link_history_and_trigger_load(selected.fetch(:body, ''), mdoc, selected,
                                            link_state)
@@ -618,8 +617,8 @@ module MarkdownExec
         options_state.load_file_link_state
 
       else
-        compile_execute_bash_and_special_blocks_and_trigger_reuse(mdoc, selected, link_state,
-                                                                  block_source: block_source)
+        compile_execute_and_trigger_reuse(mdoc, selected, link_state,
+                                          block_source: block_source)
       end
     end
 
@@ -922,10 +921,12 @@ module MarkdownExec
       end
     end
 
-    def pop_cli_argument!
-      return false unless @delegate_object[:input_cli_rest].present?
+    def shift_cli_argument!
+      return false unless @menu_base_options[:input_cli_rest].present?
 
-      @cli_block_name = @delegate_object[:input_cli_rest].pop
+      @cli_block_name = @menu_base_options[:input_cli_rest].shift
+      # @delegate_object[:input_cli_rest].shift
+      # p [__LINE__, @cli_block_name, @menu_base_options[:input_cli_rest]]
       true
     end
 
@@ -1272,102 +1273,208 @@ module MarkdownExec
     # Markdown document, obtain approval, and execute the chosen block of code.
     #
     # @return [Nil] Returns nil if no code block is selected or an error occurs.
-    def select_execute_bash_and_special_blocks(_execute: true)
+    def document_menu_loop
       @menu_base_options = @delegate_object
+      link_state, block_name_from_cli, now_using_cli = initialize_selection_states
+      menu_default_dname = nil
+
+      loop do
+        # @bsp 'loop',block_name_from_cli,@cli_block_name
+        block_name_from_cli, now_using_cli, blocks_in_file, menu_blocks, mdoc = \
+          set_delobj_menu_loop_vars(block_name_from_cli, now_using_cli, link_state)
+
+        # cli or user selection
+        #
+        block_state = load_cli_or_user_selected_block(blocks_in_file, menu_blocks,
+                                                      menu_default_dname)
+        if block_state.state == MenuState::EXIT
+          # @bsp 'MenuState::EXIT -> break'
+          break
+        end
+
+        dump_and_warn_block_state(block_state.block)
+        link_state, menu_default_dname = exec_bash_next_state(block_state.block, mdoc,
+                                                              link_state)
+        if prompt_user_exit(block_name_from_cli, block_state.block)
+          # @bsp 'prompt_user_exit -> break'
+          break
+        end
+
+        link_state.block_name, block_name_from_cli, cli_break = \
+          next_state_from_cli(now_using_cli, block_state)
+
+        if cli_break
+          # @bsp 'read_block_name_from_cli + next_link_state -> break'
+          break
+        end
+      end
+    rescue StandardError
+      error_handler('document_menu_loop',
+                    { abort: true })
+    end
+
+    def next_state_from_cli(now_using_cli, block_state)
+      was_using_cli = now_using_cli
+      block_name_from_cli, = read_block_name_from_cli(now_using_cli)
+      block_name, block_name_from_cli, cli_break = \
+        next_link_state(block_name_from_cli, was_using_cli, block_state)
+
+      [block_name, block_name_from_cli, cli_break]
+    end
+
+    def exec_bash_next_state(block_state_block, mdoc, link_state)
+      lfls = execute_shell_type(
+        block_state_block,
+        mdoc,
+        link_state,
+        block_source: { document_filename: @delegate_object[:filename] }
+      )
+
+      # if the same menu is being displayed, collect the display name of the selected menu item for use as the default item
+      [lfls.link_state,
+       lfls.load_file == LoadFile::Load ? nil : block_state_block[:dname]]
+    end
+
+    def set_delobj_menu_loop_vars(block_name_from_cli, now_using_cli, link_state)
+      block_name_from_cli, now_using_cli = \
+        manage_cli_selection_state(block_name_from_cli, now_using_cli, link_state)
+      set_delob_filename_block_name(link_state, block_name_from_cli)
+
+      # update @delegate_object and @menu_base_options in auto_load
+      #
+      blocks_in_file, menu_blocks, mdoc = mdoc_menu_and_blocks_from_nested_files
+      dump_delobj(blocks_in_file, menu_blocks, link_state)
+
+      [block_name_from_cli, now_using_cli, blocks_in_file, menu_blocks, mdoc]
+    end
+
+    # user prompt to exit if the menu will be displayed again
+    #
+    def prompt_user_exit(block_name_from_cli, block_state_block)
+      !block_name_from_cli &&
+        block_state_block[:shell] == BlockType::BASH &&
+        @delegate_object[:pause_after_script_execution] &&
+        prompt_select_continue == MenuState::EXIT
+    end
+
+    def manage_cli_selection_state(block_name_from_cli, now_using_cli, link_state)
+      if block_name_from_cli && @cli_block_name == '.'
+        # @bsp 'pause cli control, allow user to select block'
+        block_name_from_cli = false
+        now_using_cli = false
+        @menu_base_options[:block_name] = \
+          @delegate_object[:block_name] = \
+            link_state.block_name = \
+              @cli_block_name = nil
+      end
+
+      @delegate_object = @menu_base_options.dup
+      @menu_user_clicked_back_link = false
+      [block_name_from_cli, now_using_cli]
+    end
+
+    def next_link_state(block_name_from_cli, was_using_cli, block_state)
+      # @bsp 'next_link_state',block_name_from_cli, was_using_cli, block_state
+      # Set block_name based on block_name_from_cli
+      block_name = block_name_from_cli ? @cli_block_name : nil
+
+      # Determine the state of breaker based on was_using_cli and the block type
+      breaker = !block_name_from_cli && was_using_cli && block_state.block[:shell] == BlockType::BASH
+
+      # Reset block_name_from_cli if the conditions are not met
+      block_name_from_cli ||= false
+
+      [block_name, block_name_from_cli, breaker]
+    end
+
+    # Initialize the selection states for the execution loop.
+    def initialize_selection_states
       link_state = LinkState.new(
         block_name: @delegate_object[:block_name],
         document_filename: @delegate_object[:filename]
       )
-      block_name_from_cli = link_state.block_name.present?
-      @cli_block_name = link_state.block_name
-      load_file = nil
-      menu_default_dname = nil
+      block_name_from_cli, now_using_cli = handle_cli_block_name(link_state)
+      [link_state, block_name_from_cli, now_using_cli]
+    end
 
-      loop do
-        loop do
-          @delegate_object = @menu_base_options.dup
-          @menu_user_clicked_back_link = false
-          @delegate_object[:filename] = link_state.document_filename
-          link_state.block_name = @delegate_object[:block_name] =
-            block_name_from_cli ? @cli_block_name : link_state.block_name
-
-          # update @delegate_object and @menu_base_options in auto_load
-          #
-          blocks_in_file, menu_blocks, mdoc = mdoc_menu_and_blocks_from_nested_files
+    # Update the state related to CLI block name.
+    #
+    # This method updates the flags indicating whether a CLI block name is being used
+    # and if it was being used previously.
+    #
+    # @param block_name_from_cli [Boolean] Indicates if the block name is from CLI.
+    # @return [Array] Returns the updated state of block name from CLI and its usage.
+    def read_block_name_from_cli(block_name_from_cli)
+      # was_using_cli = block_name_from_cli
+      block_name_from_cli = shift_cli_argument!
+      now_using_cli = block_name_from_cli
 
-          if @delegate_object[:dump_delegate_object]
-            warn format_and_highlight_hash(
-              @delegate_object,
-              label: '@delegate_object'
-            )
-          end
+      [block_name_from_cli, now_using_cli]
+    end
 
-          if @delegate_object[:dump_blocks_in_file]
-            warn format_and_highlight_dependencies(
-              compact_and_index_hash(blocks_in_file),
-              label: 'blocks_in_file'
-            )
-          end
-          if @delegate_object[:dump_menu_blocks]
-            warn format_and_highlight_dependencies(
-              compact_and_index_hash(menu_blocks),
-              label: 'menu_blocks'
-            )
-          end
-          if @delegate_object[:dump_inherited_lines]
-            warn format_and_highlight_lines(
-              link_state.inherited_lines,
-              label: 'inherited_lines'
-            )
-          end
+    # Update the block name in the link state and delegate object.
+    #
+    # This method updates the block name based on whether it was specified
+    # through the CLI or derived from the link state.
+    #
+    # @param link_state [LinkState] The current link state object.
+    # @param block_name_from_cli [Boolean] Indicates if the block name is from CLI.
+    def set_delob_filename_block_name(link_state, block_name_from_cli)
+      @delegate_object[:filename] = link_state.document_filename
+      link_state.block_name = @delegate_object[:block_name] =
+        block_name_from_cli ? @cli_block_name : link_state.block_name
+    end
 
-          block_state = command_or_user_selected_block(blocks_in_file,
-                                                       menu_blocks, menu_default_dname)
-          return if block_state.state == MenuState::EXIT
+    # Handle CLI block name and determine the current CLI usage state.
+    #
+    # This method processes the CLI block name from the link state and sets
+    # the initial state for CLI usage.
+    #
+    # @param link_state [LinkState] The current link state object.
+    # @return [Array] Returns the state of block name from CLI and current usage of CLI.
+    def handle_cli_block_name(link_state)
+      block_name_from_cli = link_state.block_name.present?
+      @cli_block_name = link_state.block_name
+      now_using_cli = block_name_from_cli
 
-          if block_state.block.nil?
-            warn_format('select_execute_bash_and_special_blocks', "Block not found -- #{@delegate_object[:block_name]}",
-                        { abort: true })
-            # error_handler("Block not found -- #{opts[:block_name]}", { abort: true })
-          end
+      [block_name_from_cli, now_using_cli]
+    end
 
-          if @delegate_object[:dump_selected_block]
-            warn block_state.block.to_yaml.sub(/^(?:---\n)?/, "Block:\n")
-          end
+    # Outputs warnings based on the delegate object's configuration
+    #
+    # @param delegate_object [Hash] The delegate object containing configuration flags.
+    # @param blocks_in_file [Hash] Hash of blocks present in the file.
+    # @param menu_blocks [Hash] Hash of menu blocks.
+    # @param link_state [LinkState] Current state of the link.
+    def dump_delobj(blocks_in_file, menu_blocks, link_state)
+      if @delegate_object[:dump_delegate_object]
+        warn format_and_highlight_hash(@delegate_object, label: '@delegate_object')
+      end
 
-          load_file_link_state = execute_bash_and_special_blocks(
-            block_state.block,
-            mdoc,
-            link_state,
-            block_source: { document_filename: @delegate_object[:filename] }
-          )
-          load_file = load_file_link_state.load_file
-          link_state = load_file_link_state.link_state
+      if @delegate_object[:dump_blocks_in_file]
+        warn format_and_highlight_dependencies(compact_and_index_hash(blocks_in_file),
+                                               label: 'blocks_in_file')
+      end
 
-          # if the same menu is being displayed, collect the display name of the selected menu item for use as the default item
-          menu_default_dname = load_file == LoadFile::Load ? nil : block_state.block[:dname]
+      if @delegate_object[:dump_menu_blocks]
+        warn format_and_highlight_dependencies(compact_and_index_hash(menu_blocks),
+                                               label: 'menu_blocks')
+      end
 
-          # user prompt to exit if the menu will be displayed again
-          #
-          if !block_name_from_cli &&
-             block_state.block[:shell] == BlockType::BASH &&
-             @delegate_object[:pause_after_script_execution] &&
-             prompt_select_continue == MenuState::EXIT
-            return
-          end
+      return unless @delegate_object[:dump_inherited_lines]
 
-          # exit current document/menu if loading next document or single block_name was specified
-          #
-          break if block_state.state == MenuState::CONTINUE && load_file == LoadFile::Load
-          break if block_name_from_cli
-        end
-        break if load_file == LoadFile::Reuse
+      warn format_and_highlight_lines(link_state.inherited_lines, label: 'inherited_lines')
+    end
 
-        block_name_from_cli = pop_cli_argument!
+    def dump_and_warn_block_state(block_state_block)
+      if block_state_block.nil?
+        Exceptions.warn_format("Block not found -- name: #{@delegate_object[:block_name]}",
+                               { abort: true })
       end
-    rescue StandardError
-      error_handler('select_execute_bash_and_special_blocks',
-                    { abort: true })
+
+      return unless @delegate_object[:dump_selected_block]
+
+      warn block_state_block.to_yaml.sub(/^(?:---\n)?/, "Block:\n")
     end
 
     # Presents a TTY prompt to select an option or exit, returns metadata including option and selected
@@ -1561,7 +1668,7 @@ module MarkdownExec
         yield_line_if_selected(line, selected_messages, &block)
 
       else
-        # 'rejected'
+        # @bsp 'line is not recognized for block state'
 
       end
     end
@@ -1988,7 +2095,7 @@ if $PROGRAM_NAME == __FILE__
           @hd.instance_variable_set(:@delegate_object,
                                     { block_name: 'block1' })
 
-          result = @hd.command_or_user_selected_block(all_blocks, [], nil)
+          result = @hd.load_cli_or_user_selected_block(all_blocks, [], nil)
 
           assert_equal all_blocks.first, result.block
           assert_nil result.state
@@ -1999,7 +2106,7 @@ if $PROGRAM_NAME == __FILE__
                                                    :some_state)
           @hd.stubs(:wait_for_user_selected_block).returns(block_state)
 
-          result = @hd.command_or_user_selected_block([], [], nil)
+          result = @hd.load_cli_or_user_selected_block([], [], nil)
 
           assert_equal block_state.block, result.block
           assert_equal :some_state, result.state
@@ -2291,7 +2398,7 @@ if $PROGRAM_NAME == __FILE__
           @selected_item = mock('FCB')
         end
 
-        def test_compile_execute_bash_and_special_blocks_and_trigger_reuse_without_user_approval
+        def test_compile_execute_and_trigger_reuse_without_user_approval
           # Mock the delegate object configuration
           @hd.instance_variable_set(:@delegate_object,
                                     { output_script: false,
@@ -2301,7 +2408,7 @@ if $PROGRAM_NAME == __FILE__
           # Expectations and assertions go here
         end
 
-        def test_compile_execute_bash_and_special_blocks_and_trigger_reuse_with_user_approval
+        def test_compile_execute_and_trigger_reuse_with_user_approval
           # Mock the delegate object configuration
           @hd.instance_variable_set(:@delegate_object,
                                     { output_script: false,
@@ -2311,7 +2418,7 @@ if $PROGRAM_NAME == __FILE__
           # Expectations and assertions go here
         end
 
-        def test_compile_execute_bash_and_special_blocks_and_trigger_reuse_with_output_script
+        def test_compile_execute_and_trigger_reuse_with_output_script
           # Mock the delegate object configuration
           @hd.instance_variable_set(:@delegate_object,
                                     { output_script: true,

data/lib/markdown_exec/version.rb

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

data/lib/markdown_exec.rb

@@ -41,6 +41,8 @@ tap_config envvar: MarkdownExec::TAP_DEBUG
 $stderr.sync = true
 $stdout.sync = true
 
+ARGV_SEP = '--'
+
 # custom error: file specified is missing
 #
 class FileMissingError < StandardError; end
@@ -136,10 +138,11 @@ module MarkdownExec
       )
     end
 
-    # return arguments before `--`
+    # return arguments before ARGV_SEP
+    # arguments after ARGV_SEP are passed to the generatede script
     #
     def arguments_for_mde(argv = ARGV)
-      case ind = argv.find_index('--')
+      case ind = argv.find_index(ARGV_SEP)
       when nil
         argv
       when 0
@@ -205,14 +208,13 @@ module MarkdownExec
     # Reports and executes block logic
     def execute_block_logic(files)
       @options[:filename] = select_document_if_multiple(files)
-      @options.select_execute_bash_and_special_blocks
+      @options.document_menu_loop
     end
 
     ## Executes the block specified in the options
     #
     def execute_block_with_error_handling
       finalize_cli_argument_processing
-      @options[:input_cli_rest] = @rest
       execute_code_block_based_on_options(@options)
     rescue FileMissingError
       warn "File missing: #{$!}"
@@ -293,6 +295,7 @@ module MarkdownExec
       #
       block_name = rest.shift
       @options[:block_name] = block_name if block_name.present?
+      @options[:input_cli_rest] = @rest
     rescue FileMissingError
       warn_format('finalize_cli_argument_processing',
                   "File missing -- #{$!}", { abort: true })
@@ -346,10 +349,11 @@ module MarkdownExec
         ->(_) { exit }
       when 'find'
         ->(value) {
+          find_path = @options[:find_path].present? ? @options[:find_path] : @options[:path]
           @fout.fout 'Searching in: ' \
-                     "#{HashDelegator.new(@options).string_send_color(@options[:path],
+                     "#{HashDelegator.new(@options).string_send_color(find_path,
                                                                       :menu_chrome_color)}"
-          searcher = DirectorySearcher.new(value, [@options[:path]])
+          searcher = DirectorySearcher.new(value, [find_path])
 
           @fout.fout 'In file contents'
           hash = searcher.search_in_file_contents
@@ -546,7 +550,7 @@ module MarkdownExec
 
       saved_name_split filename
       @options[:save_executed_script] = false
-      @options.select_execute_bash_and_special_blocks
+      @options.document_menu_loop
     rescue StandardError
       error_handler('run_last_script')
     end
@@ -613,7 +617,7 @@ module MarkdownExec
 
       saved_name_split(filename)
 
-      @options.select_execute_bash_and_special_blocks ### ({ save_executed_script: false })
+      @options.document_menu_loop ### ({ save_executed_script: false })
     end
 
     public

data/lib/menu.src.yml

@@ -17,7 +17,7 @@
 
 - :arg_name: NAME
   :compreply: false
-  :description: Name of block
+  :description: Name of block to execute
   :env_var: MDE_BLOCK_NAME
   :long_name: block-name
   :opt_name: block_name
@@ -203,18 +203,20 @@
 ## match fenced code indented by spaces
 #
 - :default: "^(?<indent> *)`{3,}"
+  :description: Matches the start and end of a fenced code block
   :env_var: MDE_FENCED_START_AND_END_REGEX
   :opt_name: fenced_start_and_end_regex
   :procname: val_as_str
 
 - :default: "^(?<indent> *)`{3,}(?<shell>[^`\\s]*) *:?(?<name>[^\\s]*) *(?<rest>.*) *$"
+  :description: Match the start of a fenced block
   :env_var: MDE_FENCED_START_EXTENDED_REGEX
   :opt_name: fenced_start_extended_regex
   :procname: val_as_str
 
 - :arg_name: RELATIVE_PATH
   :compreply: "."
-  :description: Name of document
+  :description: Name of the document to load
   :env_var: MDE_FILENAME
   :long_name: filename
   :opt_name: filename
@@ -228,6 +230,14 @@
   :procname: find
   :short_name: "?"
 
+- :arg_name: FIND_PATH
+  :default: ""
+  :description: Path for find (uses PATH if empty)
+  :env_var: MDE_FIND_PATH
+  :long_name: find-path
+  :opt_name: find_path
+  :procname: val_as_str
+
 - :default: "^# *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
@@ -354,7 +364,7 @@
 
 - :arg_name: BOOL
   :default: false
-  :description: Display headings (levels 1,2,3) in block selection menu
+  :description: Controls whether headings(levels 1,2,3) are displayed in the block selection menu
   :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS
   :opt_name: menu_blocks_with_headings
   :procname: val_as_bool
@@ -424,7 +434,8 @@
 
 - :arg_name: BOOL
   :default: false
-  :description: Include imported notes in menu
+  # :description: Include imported notes in menu
+  :description: Whether imported blocks should be included in the menu
   :env_var: MDE_MENU_INCLUDE_IMPORTED_NOTES
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
@@ -606,7 +617,7 @@
 
 - :arg_name: BOOL
   :default: true
-  :description: Display standard output from execution
+  :description: Whether standard output from execution is displayed
   :env_var: MDE_OUTPUT_STDOUT
   :long_name: output-stdout
   :opt_name: output_stdout
@@ -628,14 +639,14 @@
 
 - :arg_name: BOOL
   :default: true
-  :description: Pause afte executing a BASH block
-  :env_var: MDE_PAUSE_after_script_execution
+  :description: Wheter to pause after manually executing a block and the next menu
+  :env_var: MDE_PAUSE_AFTER_SCRIPT_EXECUTION
   :opt_name: pause_after_script_execution
   :procname: val_as_bool
 
 - :default: "\nContinue?"
-  :description: Prompt after script execution
-  :env_var: MDE_PROMPT_after_script_execution
+  :description: Prompt after manually executing a block and the next menu
+  :env_var: MDE_PROMPT_AFTER_SCRIPT_EXECUTION
   :opt_name: prompt_after_script_execution
   :procname: val_as_str
 
@@ -717,7 +728,7 @@
 
 - :arg_name: BOOL
   :default: false
-  :description: Save executed script
+  :description: Wheter to save an executed script`
   :env_var: MDE_SAVE_EXECUTED_SCRIPT
   :long_name: save-executed-script
   :opt_name: save_executed_script
@@ -759,7 +770,7 @@
 
 - :arg_name: RELATIVE_PATH
   :default: logs
-  :description: Saved script folder
+  :description: Folder where saved scripts are stored
   :env_var: MDE_SAVED_SCRIPT_FOLDER
   :long_name: saved-script-folder
   :opt_name: saved_script_folder
@@ -884,7 +895,7 @@
 
 - :arg_name: BOOL
   :default: true
-  :description: Pause for user to approve script
+  :description: Requires user approval before executing a script
   :env_var: MDE_USER_MUST_APPROVE
   :long_name: user-must-approve
   :opt_name: user_must_approve

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.8.5)
+# MDE - Markdown Executor (1.8.6)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -15,7 +15,7 @@
   :procname: val_as_str
 - :arg_name: NAME
   :compreply: false
-  :description: Name of block
+  :description: Name of block to execute
   :env_var: MDE_BLOCK_NAME
   :long_name: block-name
   :opt_name: block_name
@@ -174,17 +174,19 @@
   :procname: exit
   :short_name: x
 - :default: "^(?<indent> *)`{3,}"
+  :description: Matches the start and end of a fenced code block
   :env_var: MDE_FENCED_START_AND_END_REGEX
   :opt_name: fenced_start_and_end_regex
   :procname: val_as_str
 - :default: "^(?<indent> *)`{3,}(?<shell>[^`\\s]*) *:?(?<name>[^\\s]*) *(?<rest>.*)
     *$"
+  :description: Match the start of a fenced block
   :env_var: MDE_FENCED_START_EXTENDED_REGEX
   :opt_name: fenced_start_extended_regex
   :procname: val_as_str
 - :arg_name: RELATIVE_PATH
   :compreply: "."
-  :description: Name of document
+  :description: Name of the document to load
   :env_var: MDE_FILENAME
   :long_name: filename
   :opt_name: filename
@@ -196,6 +198,13 @@
   :long_name: find
   :procname: find
   :short_name: "?"
+- :arg_name: FIND_PATH
+  :default: ''
+  :description: Path for find (uses PATH if empty)
+  :env_var: MDE_FIND_PATH
+  :long_name: find-path
+  :opt_name: find_path
+  :procname: val_as_str
 - :default: "^# *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
@@ -300,7 +309,8 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
-  :description: Display headings (levels 1,2,3) in block selection menu
+  :description: Controls whether headings(levels 1,2,3) are displayed in the block
+    selection menu
   :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS
   :opt_name: menu_blocks_with_headings
   :procname: val_as_bool
@@ -359,7 +369,7 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
-  :description: Include imported notes in menu
+  :description: Whether imported blocks should be included in the menu
   :env_var: MDE_MENU_INCLUDE_IMPORTED_NOTES
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
@@ -511,7 +521,7 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: true
-  :description: Display standard output from execution
+  :description: Whether standard output from execution is displayed
   :env_var: MDE_OUTPUT_STDOUT
   :long_name: output-stdout
   :opt_name: output_stdout
@@ -530,15 +540,15 @@
   :short_name: p
 - :arg_name: BOOL
   :default: true
-  :description: Pause afte executing a BASH block
-  :env_var: MDE_PAUSE_after_script_execution
+  :description: Wheter to pause after manually executing a block and the next menu
+  :env_var: MDE_PAUSE_AFTER_SCRIPT_EXECUTION
   :opt_name: pause_after_script_execution
   :procname: val_as_bool
 - :default: |2-
 
     Continue?
-  :description: Prompt after script execution
-  :env_var: MDE_PROMPT_after_script_execution
+  :description: Prompt after manually executing a block and the next menu
+  :env_var: MDE_PROMPT_AFTER_SCRIPT_EXECUTION
   :opt_name: prompt_after_script_execution
   :procname: val_as_str
 - :default: |2-
@@ -615,7 +625,7 @@
   :procname: val_as_int
 - :arg_name: BOOL
   :default: false
-  :description: Save executed script
+  :description: Wheter to save an executed script`
   :env_var: MDE_SAVE_EXECUTED_SCRIPT
   :long_name: save-executed-script
   :opt_name: save_executed_script
@@ -651,7 +661,7 @@
   :procname: val_as_str
 - :arg_name: RELATIVE_PATH
   :default: logs
-  :description: Saved script folder
+  :description: Folder where saved scripts are stored
   :env_var: MDE_SAVED_SCRIPT_FOLDER
   :long_name: saved-script-folder
   :opt_name: saved_script_folder
@@ -760,7 +770,7 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: true
-  :description: Pause for user to approve script
+  :description: Requires user approval before executing a script
   :env_var: MDE_USER_MUST_APPROVE
   :long_name: user-must-approve
   :opt_name: user_must_approve

data/lib/regexp_replacer.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+require 'find'
+
+class RegexpReplacer
+  # Constructor to initialize with file path
+  def initialize(file_path)
+    @file_path = file_path
+  end
+
+  # Perform the replacement based on the specified option
+  def perform_replacement(option)
+    content = File.read(@file_path)
+    modified_content = case option
+                       when 1
+                         replace_pattern1(content)
+                       when 2
+                         replace_pattern2(content)
+                       else
+                         raise "Invalid option. Please choose 1 or 2."
+                       end
+    File.write(@file_path, modified_content)
+  end
+
+  private
+
+  # Replacement for pattern 1
+  def replace_pattern1(content)
+    regexp = /^( *)# (@\w+) ('.+)/
+    substitution = '\1;;pp __LINE__,\3 #\2'
+    content.gsub(regexp, substitution)
+  end
+
+  # Replacement for pattern 2
+  def replace_pattern2(content)
+    regexp = /^( *);;pp __LINE__,(.+) #(@\w+)/
+    substitution = '\1# \3 \2'
+    content.gsub(regexp, substitution)
+  end
+end
+
+# Running the script with command line arguments
+if ARGV.length != 2
+  puts "Usage: ruby regexp_replacer.rb [file_path] [option (1 or 2)]"
+  exit
+end
+
+file_path, option = ARGV
+replacer = RegexpReplacer.new(file_path)
+begin
+  replacer.perform_replacement(option.to_i)
+  puts "Replacement performed successfully."
+rescue StandardError => e
+  puts "Error: #{e.message}"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 1.8.6
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -157,6 +157,7 @@ files:
 - lib/option_value.rb
 - lib/pty1.rb
 - lib/regexp.rb
+- lib/regexp_replacer.rb
 - lib/rspec_helpers.rb
 - lib/saved_assets.rb
 - lib/saved_files_matcher.rb