markdown_exec 1.8.6 → 1.8.8

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.6'
+  VERSION = '1.8.8'
 end

data/lib/mdoc.rb

@@ -23,6 +23,7 @@ module MarkdownExec
     #
     def initialize(table = [])
       @table = table
+      # &bc '@table.count:',@table.count
     end
 
     def collect_block_code_cann(fcb)
@@ -69,28 +70,40 @@ module MarkdownExec
     # @param name [String] The name of the code block to start the retrieval from.
     # @return [Array<Hash>] An array of code blocks required by the specified code block.
     #
-    def collect_recursively_required_blocks(name)
+    def collect_block_dependencies(name)
       name_block = get_block_by_anyname(name)
       if name_block.nil? || name_block.keys.empty?
         raise "Named code block `#{name}` not found. (@#{__LINE__})"
       end
 
-      dependencies = collect_dependencies(name_block[:oname])
-      all_dependency_names = collect_unique_names(dependencies).push(name_block[:oname]).uniq
-      unmet_dependencies = all_dependency_names.dup
+      nickname = name_block[:nickname] || name_block[:oname]
+      dependencies = collect_dependencies(nickname)
+      # &bc 'dependencies.count:',dependencies.count
+      all_dependency_names = collect_unique_names(dependencies).push(nickname).uniq
+      # &bc 'all_dependency_names.count:',all_dependency_names.count
+
+      # select non-chrome blocks in order of appearance in source documents
+      #
+      blocks = @table.select do |fcb|
+        !fcb.fetch(:chrome,
+                   false) && all_dependency_names.include?(fcb.fetch(:nickname,
+                                                                     nil) || fcb.fetch(:oname))
+      end
+      # &bc 'blocks.count:',blocks.count
 
-      # in order of appearance in document (@table)
-      # insert function blocks
-      blocks = @table.select { |fcb| all_dependency_names.include? fcb[:oname] }
-                     .map do |fcb|
-        unmet_dependencies.delete(fcb[:oname]) # may not exist if block name is duplicated
+      ## add cann key to blocks, calc unmet_dependencies
+      #
+      unmet_dependencies = all_dependency_names.dup
+      blocks = blocks.map do |fcb|
+        unmet_dependencies.delete(fcb[:nickname] || fcb[:oname]) # may not exist if block name is duplicated
         if (call = fcb[:call])
-          [get_block_by_oname("[#{call.match(/^%\((\S+) |\)/)[1]}]")
+          [get_block_by_anyname("[#{call.match(/^%\((\S+) |\)/)[1]}]")
             .merge({ cann: call })]
         else
           []
         end + [fcb]
       end.flatten(1)
+      # &bc 'unmet_dependencies.count:',unmet_dependencies.count
 
       { all_dependency_names: all_dependency_names,
         blocks: blocks,
@@ -103,13 +116,15 @@ module MarkdownExec
     # @param name [String] The name of the code block to start the collection from.
     # @return [Array<String>] An array of strings containing the collected code blocks.
     #
-    def collect_recursively_required_code(name, label_body: true, label_format_above: nil,
-                                          label_format_below: nil, block_source:)
-      block_search = collect_recursively_required_blocks(name)
+    def collect_recursively_required_code(name, block_source:, label_body: true, label_format_above: nil,
+                                          label_format_below: nil)
+      block_search = collect_block_dependencies(name)
       if block_search[:blocks]
         blocks = collect_wrapped_blocks(block_search[:blocks])
+        # &bc 'blocks.count:',blocks.count
+
         block_search.merge(
-          { block_names: blocks.map { |block| block[:oname] },
+          { block_names: blocks.map { |block| block[:nickname] || block[:oname] },
             code: blocks.map do |fcb|
               if fcb[:cann]
                 collect_block_code_cann(fcb)
@@ -121,11 +136,12 @@ module MarkdownExec
               elsif fcb[:shell] == BlockType::PORT
                 collect_block_code_shell(fcb)
               elsif label_body
+                block_name_for_bash_comment = (fcb[:nickname] || fcb[:oname]).gsub(/\s+/, '_')
                 [label_format_above && format(label_format_above,
-                                              block_source.merge({ block_name: fcb[:oname] }))] +
+                                              block_source.merge({ block_name: block_name_for_bash_comment }))] +
                  fcb[:body] +
                  [label_format_below && format(label_format_below,
-                                               block_source.merge({ block_name: fcb[:oname] }))]
+                                               block_source.merge({ block_name: block_name_for_bash_comment }))]
               else # raw body
                 fcb[:body]
               end
@@ -134,6 +150,8 @@ module MarkdownExec
       else
         block_search.merge({ block_names: [], code: [] })
       end
+    rescue StandardError
+      error_handler('collect_recursively_required_code')
     end
 
     def collect_unique_names(hash)
@@ -160,6 +178,13 @@ module MarkdownExec
       end.flatten(1).compact
     end
 
+    def error_handler(name = '', opts = {})
+      Exceptions.error_handler(
+        "MDoc.#{name} -- #{$!}",
+        opts
+      )
+    end
+
     # Retrieves code blocks based on the provided options.
     #
     # @param opts [Hash] The options used for filtering code blocks.
@@ -173,9 +198,15 @@ module MarkdownExec
 
       ### hide rows correctly
 
+      if !options[:menu_include_imported_blocks]
+        selrows = selrows.reject do |block|
+          block.fetch(:depth, 0).positive?
+        end
+      end
+
       if opts[:hide_blocks_by_name]
         selrows = selrows.reject do |block|
-          hide_menu_block_per_options opts, block
+          hide_menu_block_on_name opts, block
         end
       end
 
@@ -195,19 +226,8 @@ module MarkdownExec
     #
     def get_block_by_anyname(name, default = {})
       @table.select do |fcb|
-        fcb.fetch(:dname, '') == name || fcb.fetch(:oname, '') == name
-      end.fetch(0, default)
-    end
-
-    def get_block_by_dname(name, default = {})
-      @table.select do |fcb|
-        fcb.fetch(:dname, '') == name
-      end.fetch(0, default)
-    end
-
-    def get_block_by_oname(name, default = {})
-      @table.select do |fcb|
-        fcb.fetch(:oname, '') == name
+        fcb.fetch(:nickname,
+                  '') == name || fcb.fetch(:dname, '') == name || fcb.fetch(:oname, '') == name
       end.fetch(0, default)
     end
 
@@ -218,7 +238,7 @@ module MarkdownExec
     # @return [Boolean] True if the code block should be hidden; false otherwise.
     #
     # :reek:UtilityFunction
-    def hide_menu_block_per_options(opts, block)
+    def hide_menu_block_on_name(opts, block)
       if block.fetch(:chrome, false)
         false
       else
@@ -249,7 +269,7 @@ module MarkdownExec
           next if memo.include? req
 
           memo += [req]
-          get_block_by_oname(req).fetch(:reqs, [])
+          get_block_by_anyname(req).fetch(:reqs, [])
         end
                  .compact
                  .flatten(1)
@@ -424,29 +444,29 @@ if $PROGRAM_NAME == __FILE__
       # end
 
       def test_get_block_by_name
-        result = @doc.get_block_by_oname('block1')
+        result = @doc.get_block_by_anyname('block1')
         assert_equal @table[0], result
 
-        result_missing = @doc.get_block_by_oname('missing_block')
+        result_missing = @doc.get_block_by_anyname('missing_block')
         assert_equal({}, result_missing)
       end
 
       ### broken test
-      def test_collect_recursively_required_blocks
-        result = @doc.collect_recursively_required_blocks('block3')[:blocks]
+      def test_collect_block_dependencies
+        result = @doc.collect_block_dependencies('block3')[:blocks]
         expected_result = [@table[0], @table[1], @table[2]]
         assert_equal expected_result, result
 
         assert_raises(RuntimeError) do
-          @doc.collect_recursively_required_blocks('missing_block')
+          @doc.collect_block_dependencies('missing_block')
         end
       end
 
-      def test_hide_menu_block_per_options
+      def test_hide_menu_block_on_name
         opts = { hide_blocks_by_name: true,
                  block_name_hidden_match: 'block1' }
         block = FCB.new(oname: 'block1')
-        result = @doc.hide_menu_block_per_options(opts, block)
+        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

@@ -1,10 +1,10 @@
 ---
 - :description: Show current configuration values
   :procname: show_config
-  :short_name: "0"
+  :short_name: '0'
 
 - :arg_name: BOOL
-  :default: false
+  :default: true
   :description: Display only blocks of type "bash"
   :env_var: MDE_BASH_ONLY
   :opt_name: bash_only
@@ -30,7 +30,7 @@
   :opt_name: block_name_hidden_match
   :procname: val_as_str
 
-- :default: "^[\\(\\[].*[\\)\\]]$"
+- :default: "^\\(.*\\)$"
   :description: Pattern for blocks to hide from user-selection
   :env_var: MDE_BLOCK_NAME_INCLUDE_MATCH
   :opt_name: block_name_include_match
@@ -41,6 +41,12 @@
   :opt_name: block_name_match
   :procname: val_as_str
 
+- :default: "^\\[.*\\]$"
+  :description: Pattern for block nicknames (name is not used in menu)
+  :env_var: MDE_BLOCK_NAME_NICK_MATCH
+  :opt_name: block_name_nick_match
+  :procname: val_as_str
+
 - :default: "^{.+}$"
   :description: Pattern for block names to use as wrappers
   :env_var: MDE_BLOCK_NAME_WRAPPER_MATCH
@@ -73,6 +79,13 @@
   :long_name: config
   :procname: path
 
+- :arg_name: BOOL
+  :default: true
+  :description: debounce_execution
+  :env_var: MDE_debounce_execution
+  :opt_name: debounce_execution
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Debug output
@@ -177,6 +190,68 @@
   :opt_name: exclude_expect_blocks
   :procname: val_as_bool
 
+- :default: >
+    osascript -e '
+        tell application "iTerm"
+            tell application "System Events"
+                tell application "Finder"
+                    set {posx, posy, screenWidth, screenHeight} to bounds of window of desktop
+                end tell
+                tell application process "Finder"
+                    set {missing value, menubarHeight} to the size of menu bar 1
+                end tell
+            end tell
+
+            set winHeight to (screenHeight * 2 / 3)
+            set winWidth to (screenWidth / 2)
+            set xoff to menubarHeight * %{batch_index}
+            set yoff to xoff mod (screenHeight - winHeight)
+            
+            create window with default profile
+            tell the first window
+                set bounds to {xoff, yoff, xoff + winWidth, yoff + winHeight}
+                tell the current session
+                    write text "alias cat_script=\"cat -n \\\"%{script_filespec}\\\"\""
+                    write text "alias less_script=\"less \\\"%{script_filespec}\\\"\""
+                    write text "alias run_script=\"%{script_filespec}\""
+                    write text "alias vim_script=\"vim \\\"%{script_filespec}\\\"\""
+                    delay 1
+
+                    write text "alias cat_output=\"cat -n \\\"%{output_filespec}\\\"\""
+                    write text "alias grep_output=\"read -p Pattern: pattern && grep \\\"\\$pattern\\\" \\\"%{output_filespec}\\\"\""
+                    write text "alias less_output=\"less \\\"%{output_filespec}\\\"\""
+                    delay 1
+
+                    write text "alias menu=\"select cmd in cat_script less_script run_script vim_script cat_output grep_output less_output exit; do eval \\\"\\$cmd\\\"; done\""
+                    delay 1
+
+                    write text "echo -ne \"\\033]; %{started_at} - %{document_filename} - %{block_name} \\007\""
+                    write text "cd \"%{home}\""
+                    write text "\"%{script_filename}\" | tee \"%{output_filespec}\""
+                    delay 2
+
+                    write text "menu"
+                end tell
+            end tell
+        end tell'
+  :description: execute_command_format
+  :env_var: MDE_EXECUTE_COMMAND_FORMAT
+  :opt_name: execute_command_format
+  :procname: val_as_str
+
+- :default: "%T"
+  :description: Format for time in window title
+  :env_var: MDE_EXECUTE_COMMAND_TITLE_TIME_FORMAT
+  :opt_name: execute_command_title_time_format
+  :procname: val_as_str
+
+- :arg_name: BOOL
+  :default: true
+  :description: Execute script in own window
+  :env_var: MDE_EXECUTE_IN_OWN_WINDOW
+  :opt_name: execute_in_own_window
+  :procname: val_as_bool
+
 - :default: fg_rgbh_7f_ff_00
   :description: execution_report_preview_frame_color
   :env_var: MDE_EXECUTION_REPORT_PREVIEW_FRAME_COLOR
@@ -224,31 +299,31 @@
   :short_name: f
 
 - :arg_name: FIND
-  :default: ""
+  :default: ''
   :description: Find in documents
   :long_name: find
   :procname: find
   :short_name: "?"
 
 - :arg_name: FIND_PATH
-  :default: ""
+  :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>[^#]*?) *$"
+- :default: "^# *(?<line>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
   :procname: val_as_str
 
-- :default: "^## *(?<name>[^#]*?) *$"
+- :default: "^## *(?<line>[^#]*?) *$"
   :env_var: MDE_HEADING2_MATCH
   :opt_name: heading2_match
   :procname: val_as_str
 
-- :default: "^### *(?<name>.+?) *$"
+- :default: "^### *(?<line>.+?) *$"
   :env_var: MDE_HEADING3_MATCH
   :opt_name: heading3_match
   :procname: val_as_str
@@ -278,12 +353,17 @@
   :procname: val_as_str
 
 - :arg_name: HOW
-  :default: ""
+  :default: ''
   :description: Find in YAML configuration options
   :long_name: how
   :procname: how
   :short_name: "?"
 
+- :default:
+  :env_var: MDE_IMPORT_PATHS
+  :opt_name: import_paths
+  :procname: val_as_str
+
 - :default: "^ *@import +(?<name>.+?) *$"
   :env_var: MDE_IMPORT_PATTERN
   :opt_name: import_pattern
@@ -363,7 +443,7 @@
   :procname: val_as_bool
 
 - :arg_name: BOOL
-  :default: false
+  :default: true
   :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
@@ -419,7 +499,43 @@
   :opt_name: menu_final_divider
   :procname: val_as_str
 
-- :default: "0"
+- :default: fg_rgbh_80_80_c0
+  :description: Color for heading 1 in menu
+  :env_var: MDE_MENU_HEADING1_COLOR
+  :opt_name: menu_heading1_color
+  :procname: val_as_str
+
+- :default: "# %{line}"
+  :description: format for menu heading1 in menu
+  :env_var: MDE_MENU_HEADING1_FORMAT
+  :opt_name: menu_heading1_format
+  :procname: val_as_str
+
+- :default: fg_rgbh_60_60_c0
+  :description: Color for heading 2 in menu
+  :env_var: MDE_MENU_HEADING2_COLOR
+  :opt_name: menu_heading2_color
+  :procname: val_as_str
+
+- :default: "## %{line}"
+  :description: format for menu heading2 in menu
+  :env_var: MDE_MENU_HEADING2_FORMAT
+  :opt_name: menu_heading2_format
+  :procname: val_as_str
+
+- :default: fg_rgbh_40_40_c0
+  :description: Color for heading 3 in menu
+  :env_var: MDE_MENU_HEADING3_COLOR
+  :opt_name: menu_heading3_color
+  :procname: val_as_str
+
+- :default: "### %{line}"
+  :description: format for menu heading3 in menu
+  :env_var: MDE_MENU_HEADING3_FORMAT
+  :opt_name: menu_heading3_format
+  :procname: val_as_str
+
+- :default: '0'
   :description: Import levels for blocks to appear in menu. Empty is all.
   :env_var: MDE_MENU_IMPORT_LEVEL_MATCH
   :opt_name: menu_import_level_match
@@ -440,8 +556,27 @@
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
 
+- :arg_name: BOOL
+  :default: true
+  :description: Display inherited lines at top of menu (vs bottom)
+  :env_var: MDE_MENU_INHERITED_LINES_AT_TOP
+  :opt_name: menu_inherited_lines_at_top
+  :procname: val_as_bool
+
+- :default: fg_rgbh_94_00_D3
+  :description: Color of inherited lines in menu
+  :env_var: MDE_MENU_INHERITED_LINES_COLOR
+  :opt_name: menu_inherited_lines_color
+  :procname: val_as_str
+
+- :default: "%{line}"
+  :description: format for inherited lines in menu
+  :env_var: MDE_MENU_INHERITED_LINES_FORMAT
+  :opt_name: menu_inherited_lines_format
+  :procname: val_as_str
+
 - :default:
-    :line: ""
+    :line: ''
   :description: opening demarcation for menu
   :env_var: MDE_MENU_INITIAL_DIVIDER
   :opt_name: menu_initial_divider
@@ -511,6 +646,12 @@
   :opt_name: menu_opts_set_format
   :procname: val_as_str
 
+- :default: "."
+  :description: Block name to display menu
+  :env_var: MDE_MENU_PERSIST_BLOCK_NAME
+  :opt_name: menu_persist_block_name
+  :procname: val_as_str
+
 - :default: fg_rgbh_ff_ff_ff
   :description: Color of menu task
   :env_var: MDE_MENU_TASK_COLOR
@@ -567,6 +708,13 @@
   :opt_name: menu_with_exit
   :procname: val_as_bool
 
+- :arg_name: BOOL
+  :default: true
+  :description: Display inherited lines in menu
+  :env_var: MDE_MENU_WITH_INHERITED_LINES
+  :opt_name: menu_with_inherited_lines
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Hide decorative menu entries
@@ -574,6 +722,26 @@
   :opt_name: no_chrome
   :procname: val_as_bool
 
+- :default:
+  :description: Expression to match to start collecting lines
+  :env_var: MDE_OUTPUT_ASSIGNMENT_BEGIN
+  :opt_name: output_assignment_begin
+  :procname: val_as_str
+- :default:
+  :description: Expression to match to stop collecting lines
+  :env_var: MDE_OUTPUT_ASSIGNMENT_END
+  :opt_name: output_assignment_begin
+  :procname: val_as_str
+- :default: "%{line} # !!!"
+  :description: Format for assignments from output
+  :env_var: MDE_OUTPUT_ASSIGNMENT_FORMAT
+  :opt_name: output_assignment_format
+  :procname: val_as_str
+- :default: "^ *(\\w+=.*?) *$"
+  :description: Pattern for assignments from output
+  :env_var: MDE_OUTPUT_ASSIGNMENT_MATCH
+  :opt_name: output_assignment_match
+  :procname: val_as_str
 - :arg_name: BOOL
   :default: false
   :description: Display summary for execution
@@ -638,7 +806,7 @@
   :short_name: p
 
 - :arg_name: BOOL
-  :default: true
+  :default: false
   :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
@@ -662,13 +830,19 @@
   :opt_name: prompt_color_after_script_execution
   :procname: val_as_str
 
+- :default: "\nRepeat this block?"
+  :description: Prompt to debounce
+  :env_var: MDE_PROMPT_DEBOUNCE
+  :opt_name: prompt_debounce
+  :procname: val_as_str
+
 - :default: Exit
   :description: Prompt to exit app
   :env_var: MDE_PROMPT_EXIT
   :opt_name: prompt_exit
   :procname: val_as_str
 
-- :default: "No"
+- :default: 'No'
   :description: Prompt for no
   :env_var: MDE_PROMPT_NO
   :opt_name: prompt_no
@@ -704,7 +878,13 @@
   :opt_name: prompt_select_output
   :procname: val_as_str
 
-- :default: "Yes"
+- :default: Uninterrupted
+  :description: Uninterrupted execution
+  :env_var: MDE_PROMPT_UNINTERRUPTED
+  :opt_name: prompt_uninterrupted
+  :procname: val_as_str
+
+- :default: 'Yes'
   :description: Prompt for yes
   :env_var: MDE_PROMPT_YES
   :opt_name: prompt_yes
@@ -721,7 +901,7 @@
   :procname: val_as_bool
 
 - :default: 1
-  :description: "Runtime exception error level (warn if < 0, ignore if 0, abort if > 0)"
+  :description: Runtime exception error level (warn if < 0, ignore if 0, abort if > 0)
   :env_var: MDE_RUNTIME_EXCEPTION_ERROR_LEVEL
   :opt_name: runtime_exception_error_level
   :procname: val_as_int
@@ -849,7 +1029,7 @@
   :procname: val_as_str
 
 - :default: 36
-  :description: "Maximum # of rows in select list"
+  :description: 'Maximum # of rows in select list'
   :env_var: MDE_SELECT_PAGE_HEIGHT
   :opt_name: select_page_height
   :procname: val_as_int
@@ -876,13 +1056,13 @@
   :opt_name: shell
   :procname: val_as_str
 
-- :default: "#  -^-  +%{block_name}  -o-  %{document_filename}  -^-"
+- :default: "#  -^-"
   :description: shell_code_label_format_above
   :env_var: MDE_SHELL_CODE_LABEL_FORMAT_ABOVE
   :opt_name: shell_code_label_format_above
   :procname: val_as_str
 
-- :default: "#  -v-  +%{block_name}  -v-"
+- :default: "#  -v-  +%{block_name}  -o-  %{document_filename}  -v-"
   :description: shell_code_label_format_below
   :env_var: MDE_SHELL_CODE_LABEL_FORMAT_BELOW
   :opt_name: shell_code_label_format_below
@@ -894,7 +1074,7 @@
   :procname: val_as_bool
 
 - :arg_name: BOOL
-  :default: true
+  :default: false
   :description: Requires user approval before executing a script
   :env_var: MDE_USER_MUST_APPROVE
   :long_name: user-must-approve
@@ -913,7 +1093,7 @@
   :opt_name: warning_color
   :procname: val_as_str
 
-- :default: "Error: %{error}"
+- :default: 'Error: %{error}'
   :description: Format of warning message
   :env_var: MDE_WARNING_FORMAT
   :opt_name: warning_format