markdown_exec 2.1.0 → 2.3.0

data/lib/mdoc.rb

@@ -6,6 +6,8 @@
 require_relative 'block_types'
 require_relative 'filter'
 
+$pd = false unless defined?($pd)
+
 module MarkdownExec
   ##
   # MDoc represents an imported markdown document.
@@ -23,11 +25,11 @@ module MarkdownExec
     #
     def initialize(table = [])
       @table = table
-      # &bc '@table.count:',@table.count
+      # &bt @table.count
     end
 
     def collect_block_code_cann(fcb)
-      body = fcb[:body].join("\n")
+      body = fcb.body.join("\n")
       xcall = fcb[:cann][1..-2]
       mstdin = xcall.match(/<(?<type>\$)?(?<name>[A-Za-z_\-.\w]+)/)
       mstdout = xcall.match(/>(?<type>\$)?(?<name>[A-Za-z_\-.\w]+)/)
@@ -44,15 +46,6 @@ module MarkdownExec
       end
     end
 
-    def collect_block_code_shell(fcb)
-      # write named variables to block at top of script
-      #
-      fcb[:body].join(' ').split.compact.map do |key|
-        ### format(opts[:block_type_port_set_format], { key: key, value: ENV.fetch(key, nil) })
-        "key: #{key}, value: #{ENV.fetch(key, nil)}"
-      end
-    end
-
     # Collects and formats the shell command output to redirect script block code to a file or a variable.
     #
     # @param [Hash] fcb A hash containing information about the script block's stdout and body.
@@ -66,7 +59,7 @@ module MarkdownExec
     #   If stdout[:type] is false, the command will write the body to a file.
     def collect_block_code_stdout(fcb)
       stdout = fcb[:stdout]
-      body = fcb[:body].join("\n")
+      body = fcb.body.join("\n")
       if stdout[:type]
         %(export #{stdout[:name]}=$(cat <<"EOF"\n#{body}\nEOF\n))
       else
@@ -83,35 +76,40 @@ module MarkdownExec
     #
     def collect_block_dependencies(anyname:)
       name_block = get_block_by_anyname(anyname)
-      raise "Named code block `#{anyname}` not found. (@#{__LINE__})" if name_block.nil? || name_block.keys.empty?
+      if name_block.nil? || name_block.keys.empty?
+        raise "Named code block `#{anyname}` not found. (@#{__LINE__})"
+      end
 
       nickname = name_block.pub_name
 
       dependencies = collect_dependencies(nickname)
-      # &bc 'dependencies.count:',dependencies.count
+      # &bt dependencies.count
       all_dependency_names = collect_unique_names(dependencies).push(nickname).uniq
-      # &bc 'all_dependency_names.count:',all_dependency_names.count
+      # &bt all_dependency_names.count
 
-      # select non-chrome blocks in order of appearance in source documents
+      # select blocks in order of appearance in source documents
       #
       blocks = @table.select do |fcb|
-        !fcb.fetch(:chrome, false) && all_dependency_names.include?(fcb.pub_name)
+        # 2024-08-04 match nickname
+        all_dependency_names.include?(fcb.pub_name) || all_dependency_names.include?(fcb.nickname) || all_dependency_names.include?(fcb.oname)
       end
-      # &bc 'blocks.count:',blocks.count
+      # &bt blocks.count
 
       ## add cann key to blocks, calc unmet_dependencies
       #
       unmet_dependencies = all_dependency_names.dup
       blocks = blocks.map do |fcb|
-        unmet_dependencies.delete(fcb.pub_name) # may not exist if block name is duplicated
-        if (call = fcb[:call])
+        # 2024-08-04 match oname for long block names
+        # 2024-08-04 match nickname
+        unmet_dependencies.delete(fcb.pub_name) || unmet_dependencies.delete(fcb.nickname) || unmet_dependencies.delete(fcb.oname) # may not exist if block name is duplicated
+        if (call = fcb.call)
           [get_block_by_anyname("[#{call.match(/^%\((\S+) |\)/)[1]}]")
             .merge({ cann: call })]
         else
           []
         end + [fcb]
       end.flatten(1)
-      # &bc 'unmet_dependencies.count:',unmet_dependencies.count
+      # &bt unmet_dependencies.count
 
       { all_dependency_names: all_dependency_names,
         blocks: blocks,
@@ -129,7 +127,7 @@ module MarkdownExec
       block_search = collect_block_dependencies(anyname: anyname)
       if block_search[:blocks]
         blocks = collect_wrapped_blocks(block_search[:blocks])
-        # &bc 'blocks.count:',blocks.count
+        # &bt blocks.count
 
         block_search.merge(
           { block_names: blocks.map(&:pub_name),
@@ -138,20 +136,20 @@ module MarkdownExec
                 collect_block_code_cann(fcb)
               elsif fcb[:stdout]
                 collect_block_code_stdout(fcb)
-              elsif [BlockType::LINK, BlockType::OPTS,
-                     BlockType::VARS].include? fcb[:shell]
+              elsif [BlockType::OPTS].include? fcb.shell
+                fcb.body # entire body is returned to requesing block
+              elsif [BlockType::LINK,
+                     BlockType::VARS].include? fcb.shell
+                nil
+              elsif fcb[:chrome] # for Link blocks like History
                 nil
-              elsif fcb[:shell] == BlockType::PORT
-                collect_block_code_shell(fcb)
+              elsif fcb.shell == BlockType::PORT
+                generate_env_variable_shell_commands(fcb)
               elsif label_body
-                block_name_for_bash_comment = fcb.pub_name.gsub(/\s+/, '_')
-                [label_format_above && format(label_format_above,
-                                              block_source.merge({ block_name: block_name_for_bash_comment }))] +
-                 fcb[:body] +
-                 [label_format_below && format(label_format_below,
-                                               block_source.merge({ block_name: block_name_for_bash_comment }))]
+                generate_label_body_code(fcb, block_source, label_format_above,
+                                         label_format_below)
               else # raw body
-                fcb[:body]
+                fcb.body
               end
             end.compact.flatten(1).compact }
         )
@@ -222,10 +220,70 @@ module MarkdownExec
       # . empty chrome between code; edges are same as blanks
       #
       select_elements_with_neighbor_conditions(selrows) do |prev_element, current, next_element|
-        !(current[:chrome] && !current[:oname].present?) || !(!prev_element.nil? && prev_element[:shell].present? && !next_element.nil? && next_element[:shell].present?)
+        !(current[:chrome] && !current.oname.present?) ||
+          !(!prev_element.nil? &&
+            prev_element.shell.present? &&
+            !next_element.nil? &&
+            next_element.shell.present?)
+      end
+    end
+
+    # Generates shell code lines to set environment variables named in the body of the given object.
+    # Reads a whitespace-separated list of environment variable names from `fcb.body`,
+    # retrieves their values from the current environment, and constructs shell commands
+    # to set these environment variables.
+    #
+    # @param fcb [Object] An object with a `body` method that returns an array of strings,
+    #   where each string is a name of an environment variable.
+    # @return [Array<String>] An array of strings, each representing a shell command to
+    #   set an environment variable in the format `KEY=value`.
+    #
+    # Example:
+    #   If `fcb.body` returns ["PATH", "HOME"], and the current environment has PATH=/usr/bin
+    #   and HOME=/home/user, this method will return:
+    #     ["PATH=/usr/bin", "HOME=/home/user"]
+    #
+    def generate_env_variable_shell_commands(fcb)
+      fcb.body.join(' ').split.compact.map do |key|
+        "#{key}=#{Shellwords.escape ENV.fetch(key, '')}"
       end
     end
 
+    # Generates a formatted code block with labels above and below the main content.
+    # The labels and content are based on the provided format strings and the body of the given object.
+    #
+    # @param fcb [Object] An object with a `pub_name` method that returns a string, and a `body` method that returns an array of strings.
+    # @param block_source [Hash] A hash containing additional information to be merged into the format strings.
+    # @param label_format_above [String, nil] A format string for the label above the content, or nil if no label is needed.
+    # @param label_format_below [String, nil] A format string for the label below the content, or nil if no label is needed.
+    # @return [Array<String>] An array of strings representing the formatted code block, with optional labels above and below the main content.
+    #
+    # Example:
+    #   If `fcb.pub_name` returns "Example Block", `fcb.body` returns ["line1", "line2"],
+    #   `block_source` is { source: "source_info" }, `label_format_above` is "Start of %{block_name}",
+    #   and `label_format_below` is "End of %{block_name}", the method will return:
+    #     ["Start of Example_Block", "line1", "line2", "End of Example_Block"]
+    #
+    def generate_label_body_code(fcb, block_source, label_format_above,
+                                 label_format_below)
+      block_name_for_bash_comment = fcb.pub_name.gsub(/\s+/, '_')
+
+      label_above = if label_format_above
+                      format(label_format_above,
+                             block_source.merge({ block_name: block_name_for_bash_comment }))
+                    else
+                      nil
+                    end
+      label_below = if label_format_below
+                      format(label_format_below,
+                             block_source.merge({ block_name: block_name_for_bash_comment }))
+                    else
+                      nil
+                    end
+
+      [label_above, *fcb.body, label_below].compact
+    end
+
     # Retrieves a code block by its name.
     #
     # @param name [String] The name of the code block to retrieve.
@@ -233,10 +291,14 @@ module MarkdownExec
     # @return [Hash] The code block as a hash or the default value if not found.
     #
     def get_block_by_anyname(name, default = {})
+      # &bt name
       @table.select do |fcb|
-        fcb.fetch(:nickname,
-                  '') == name || fcb.fetch(:dname, '') == name || fcb.fetch(:oname, '') == name
-      end.fetch(0, default)
+        fcb.tap { |_ret| pp [__LINE__, 'get_block_by_anyname()', 'fcb', fcb] if $pd }
+        fcb.nickname == name ||
+          fcb.dname == name ||
+          fcb.oname == name ||
+          fcb.pub_name == name
+      end.fetch(0, default).tap { |ret| pp [__LINE__, 'get_block_by_anyname() ->', ret] if $pd }
     end
 
     # Checks if a code block should be hidden based on the given options.
@@ -250,15 +312,15 @@ module MarkdownExec
       if block.fetch(:chrome, false)
         false
       else
-        (opts[:hide_blocks_by_name] &&
-                ((opts[:block_name_hidden_match]&.present? &&
-                  block.oname&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
-                 (opts[:block_name_include_match]&.present? &&
-                  block.oname&.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?)
-        )
+        opts[:hide_blocks_by_name] &&
+          ((opts[:block_name_hidden_match]&.present? &&
+            block.oname&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
+           (opts[:block_name_include_match]&.present? &&
+            block.oname&.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?)
+
       end
     end
 
@@ -277,7 +339,7 @@ module MarkdownExec
           next if memo.include? req
 
           memo += [req]
-          get_block_by_anyname(req).fetch(:reqs, [])
+          get_block_by_anyname(req).reqs
         end
                  .compact
                  .flatten(1)
@@ -295,9 +357,11 @@ module MarkdownExec
       return memo if memo.keys.include? source
 
       block = get_block_by_anyname(source)
-      raise "Named code block `#{source}` not found. (@#{__LINE__})" if block.nil? || block.keys.empty?
+      if block.nil? || block.keys.empty?
+        raise "Named code block `#{source}` not found. (@#{__LINE__})"
+      end
 
-      memo[source] = block[:reqs]
+      memo[source] = block.reqs
       return memo unless memo[source]&.count&.positive?
 
       memo[source].each do |req|
@@ -322,11 +386,13 @@ module MarkdownExec
 
       end
 
-      return memo unless block[:reqs]
+      return memo unless block.reqs
 
-      memo[source] = block[:reqs]
+      memo[source] = block.reqs
 
-      block[:reqs].each { |req| collect_dependencies(req, memo) unless memo.key?(req) }
+      block.reqs.each do |req|
+        collect_dependencies(req, memo) unless memo.key?(req)
+      end
       memo
     end
 
@@ -364,7 +430,7 @@ module MarkdownExec
     #     next_element = array[index + 1]
 
     #     # Check the conditions for property A on the current element and property B on adjacent elements
-    #     unless element[:chrome] && !element[:oname].present? && prev_element[:shell].present? && next_element[:shell].present?
+    #     unless element[:chrome] && !element[:oname].present? && prev_element.shell.present? && next_element.shell.present?
     #       selected_elements << element
     #     # else
     # # pp 'SKIPPING', element
@@ -395,7 +461,9 @@ if $PROGRAM_NAME == __FILE__
 
       if false # must raise error
         def test_collect_dependencies_with_nonexistent_source
-          assert_raises(RuntimeError) { @mdoc.collect_dependencies('nonexistent') }
+          assert_raises(RuntimeError) do
+            @mdoc.collect_dependencies('nonexistent')
+          end
         end
       end
 
@@ -512,12 +580,6 @@ if $PROGRAM_NAME == __FILE__
         # Test case 1: blocks with wraps
         OpenStruct.new(oname: 'block1')
 
-        assert_equal(%w[{wrap1} a],
-                     @mdoc.collect_wrapped_blocks(
-                       [OpenStruct.new(oname: 'a',
-                                       wraps: ['{wrap1}'])]
-                     ).map(&:oname))
-
         assert_equal(%w[{wrap2-before} {wrap2} b {wrap2-after}],
                      @mdoc.collect_wrapped_blocks(
                        [OpenStruct.new(oname: 'b',

data/lib/menu.src.yml

@@ -275,8 +275,10 @@
   :default: false
   :description: Execute script in own window
   :env_var: MDE_EXECUTE_IN_OWN_WINDOW
+  :long_name: execute_in_own_window
   :opt_name: execute_in_own_window
   :procname: val_as_bool
+  :short_name: w
 
 - :default: fg_rgbh_7f_ff_00
   :description: execution_report_preview_frame_color
@@ -303,13 +305,13 @@
 
 ## match fenced code indented by spaces
 #
-- :default: "^(?<indent> *)`{3,}"
+- :default: "^(?<indent>[ \t]*)`{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>.*) *$"
+- :default: "^(?<indent>[ \t]*)`{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
@@ -380,7 +382,7 @@
 
 - :arg_name: HOW
   :default: ''
-  :description: Find in YAML configuration options
+  :description: Find keyword in YAML configuration options
   :long_name: how
   :procname: how
   :short_name: "?"
@@ -395,6 +397,43 @@
   :opt_name: import_pattern
   :procname: val_as_str
 
+- :default:
+    - :color_method: :bold_underline
+      :pattern: '\*\*_([^_]{0,64})_\*\*'
+
+    - :color_method: :bold_italic
+      :pattern: '\*\*~([^~]{0,64})~\*\*'
+
+    - :color_method: :bold
+      :pattern: '\*\*([^*]{0,64})\*\*'
+    - :color_method: :bold
+      :pattern: '__([^_]{0,64})__'
+
+    - :color_method: :underline
+      :pattern: '\*([^*]{0,64})\*'
+
+    - :color_method: :underline_italic
+      :pattern: '_~([^_]{0,64})~_'
+
+    - :color_method: strikethrough
+      :pattern: '~~([^~]{0,64})~~'
+  :description: Line-oriented text decoration (Main)
+  :env_var: MDE_LINE_DECOR_MAIN
+  :opt_name: line_decor_main
+  :procname: val_as_str
+
+- :default: []
+  :description: Line-oriented text decoration (Post)
+  :env_var: MDE_LINE_DECOR_POST
+  :opt_name: line_decor_post
+  :procname: val_as_str
+
+- :default: []
+  :description: Line-oriented text decoration (Pre)
+  :env_var: MDE_LINE_DECOR_PRE
+  :opt_name: line_decor_pre
+  :procname: val_as_str
+
 - :description: List blocks
   :long_name: list-blocks
   :opt_name: list_blocks
@@ -438,6 +477,7 @@
   :long_name: load-code
   :opt_name: load_code
   :procname: val_as_str
+  :short_name: l
 
 - :arg_name: PREFIX
   :default: mde
@@ -507,7 +547,7 @@
   :opt_name: menu_divider_format
   :procname: val_as_str
 
-- :default: "^:::(?<line>(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+- :default: "^(?<indent>[ \t]*):::(?<line>(?<text>.*?)(?<trailing>[ \t]*))?$"
   :description: Pattern for topics/dividers in block selection menu
   :env_var: MDE_MENU_DIVIDER_MATCH
   :opt_name: menu_divider_match
@@ -651,7 +691,8 @@
   :procname: val_as_str
 
 ## lines that start with "/" are comments (hidden), not notes (visible)
-- :default: "^(?<line>(?!/)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+# - :default: "^(?<indent>[ \t]*)(?<line>(?!/)(?<text>.*?)(?<trailing>[ \t]*))?$"
+- :default: "^(?<line>(?![ \t]*/)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :description: Pattern for notes in block selection menu
   :env_var: MDE_MENU_NOTE_MATCH
   :opt_name: menu_note_match
@@ -965,13 +1006,19 @@
   :procname: val_as_str
 
 - :default: Back
-  :description: Quit prompt
-  :env_var: MDE_PROMPT_FILESPEC_OTHER
+  :description: User wants out of menu
+  :env_var: MDE_PROMPT_FILESPEC_BACK
   :opt_name: prompt_filespec_back
   :procname: val_as_str
 
+- :default: Facet
+  :description: User wants to tailor the menu
+  :env_var: MDE_PROMPT_FILESPEC_FACET
+  :opt_name: prompt_filespec_facet
+  :procname: val_as_str
+
 - :default: Other
-  :description: Prompt for a custom file name
+  :description: User wants a custom file name
   :env_var: MDE_PROMPT_FILESPEC_OTHER
   :opt_name: prompt_filespec_other
   :procname: val_as_str
@@ -1042,7 +1089,7 @@
   :opt_name: prompt_yes
   :procname: val_as_str
 
-- :description: Gem home folder
+- :description: Print the gem's home directory
   :long_name: pwd
   :opt_name: pwd
   :procname: val_as_bool
@@ -1059,13 +1106,13 @@
   :procname: val_as_int
 
 - :default: '%{prefix}%{join}%{time}%{join}%{filename}%{join}%{mark}%{join}%{blockname}%{join}%{exts}'
-  :description: saved_asset_format
+  :description: Format for script and log file names
   :env_var: MDE_SAVED_ASSET_FORMAT
   :opt_name: saved_asset_format
   :procname: val_as_str
 
 - :default: "^(?<prefix>.+)(?<join>_)(?<time>[0-9\\-]+)\\g'join'(?<filename>.+)\\g'join'(?<mark>~)\\g'join'(?<blockname>.+)\\g'join'(?<exts>\\..+)$"
-  :description: saved_asset_match
+  :description: Regexp for script and log file names
   :env_var: MDE_SAVED_ASSET_MATCH
   :opt_name: saved_asset_match
   :procname: val_as_str
@@ -1096,6 +1143,12 @@
   :opt_name: saved_filename_replacement
   :procname: val_as_str
 
+- :default: '%{time}  %{blockname}  %{exts}'
+  :description: Format for each row displayed in history
+  :env_var: MDE_SAVED_HISTORY_FORMAT
+  :opt_name: saved_history_format
+  :procname: val_as_str
+
 - :arg_name: INT
   :default: 493
   :description: chmod for saved scripts
@@ -1194,16 +1247,6 @@
   :opt_name: select_page_height
   :procname: val_as_int
 
-- :description: Select and execute a recently saved output
-  :long_name: select-recent-output
-  :opt_name: select_recent_output
-  :procname: val_as_bool
-
-- :description: Select and execute a recently saved script
-  :long_name: select-recent-script
-  :opt_name: select_recent_script
-  :procname: val_as_bool
-
 - :default: "#!/usr/bin/env"
   :description: Shebang for saved scripts
   :env_var: MDE_SHEBANG
@@ -1234,6 +1277,13 @@
   :opt_name: shell_code_label_time_format
   :procname: val_as_str
 
+- :arg_name: BOOL
+  :default: true
+  :description: Whether saved file names include shell parameter expansion
+  :env_var: MDE_SHELL_PARAMETER_EXPANSION
+  :opt_name: shell_parameter_expansion
+  :procname: val_as_bool
+
 - :description: List tab completions
   :long_name: tab-completions
   :opt_name: tab_completions