markdown_exec 2.0.8.2 → 2.0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39b3a2b14b7efe82967efab04742281a8233a24daebf7c68f11fec661c8cd80e
-  data.tar.gz: 16586313129a6c66cced3e45b6c94c758eba0fa0ea7fccce47a848366435ff11
+  metadata.gz: 858c301950e3ca7d43bc8c8c9a87f1c340b75710c28743a02ed0811a649b46ba
+  data.tar.gz: 4c7445f2d0e05e974cadd163894772b865bd7f94717f6f070fda6b2db2a0ef8c
 SHA512:
-  metadata.gz: b7bcb0cb4ffdf2979ccc749a9abe1aaf86314b7a4ecd8fa34f9d6bfac7ae7d8a62f1981dcbdf7f0e7dd211e193392f009865b2adcd5eb5aa9d15610cd60559bb
-  data.tar.gz: 5ab77246617cec9bb918a44e51d40ba1ef4d1215c57de9541538f2f10aa60e61144fad31e7bd7901d7985b95064863783258ddec35dea48fe1a86faf4dbd15f2
+  metadata.gz: c157d1ec261a140205eabe4d2ec8a30839e8b8f1c716c2d24710d3630c587e03282b11a5f27e269e02b8e1a568fbca7bf2e37537cc04d4b9d4cfce9ef1ab4803
+  data.tar.gz: d991a308e029da9078adb996d8735951e3100eb117bc5a1f196db040513d4e20c715c6a4a805dcd528a93bd98d1a7b125eb2d88c4d9fea7449af1ad04add67be

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.0.8.2)
+    markdown_exec (2.0.8.4)
       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 "2.0.8.2"
+  echo "2.0.8.4"
 }
 
 _mde() {
@@ -178,4 +178,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2024-06-07 23:43:21 UTC"
+# echo "Updated: 2024-06-24 04:53:41 UTC"

data/examples/linked.md

@@ -1,6 +1,7 @@
 Demonstrate setting variable values interactively for use in generated scripts.
 
 ```opts :(document_options)
+menu_with_inherited_lines: true
 pause_after_script_execution: false
 user_must_approve: false
 ```
@@ -40,7 +41,7 @@ vars:
 ::: Set variable ALPHA in a Vars block
 For each environment variable named in block,
  append an inherited line that assigns the variable the specified value.
-```vars :set_ALPHA_to_1_via_vars_block
+```vars :[set_ALPHA_to_1_via_vars_block]
 ALPHA: 1
 ```
 
@@ -48,7 +49,7 @@ ALPHA: 1
 For each environment variable in `vars`,
  append an inherited line that assigns the variable the specified value.
 Subsequently, run the `display_variable_ALPHA` block.
-```link :set_ALPHA_to_2_via_link_block_and_display
+```link :[set_ALPHA_to_2_via_link_block_and_display]
 block: display_variable_ALPHA
 vars:
   ALPHA: 2
@@ -59,14 +60,14 @@ Subsequently, run the `display_variable_ALPHA` block.
 ```bash :(bash_set_to_3)
 ALPHA=3
 ```
-```link :set_ALPHA_to_3_via_required_block_and_display +(bash_set_to_3)
+```link :[set_ALPHA_to_3_via_required_block_and_display] +(bash_set_to_3)
 block: display_variable_ALPHA
 ```
 
 Evaluate the code in the required block `(bash_eval_set_to_4)` and
  save (transformed) output into inherited lines.
 Subsequently, run the `display_variable_ALPHA` block.
-```link :set_ALPHA_to_4_via_evaluated_required_block_and_display +(bash_eval_set_to_4)
+```link :[set_ALPHA_to_4_via_evaluated_required_block_and_display] +(bash_eval_set_to_4)
 eval: true
 next_block: display_variable_ALPHA
 ```

data/lib/hash_delegator.rb

@@ -793,7 +793,7 @@ module MarkdownExec
     end
 
     def command_execute(command, args: [])
-      @run_state.files = Hash.new([])
+      run_state_reset_stream_logs
       @run_state.options = @delegate_object
       @run_state.started_at = Time.now.utc
 
@@ -807,7 +807,6 @@ module MarkdownExec
             command_execute_in_own_window_format_arguments(rest: args ? args.join(' ') : '')
           )
         )
-
       else
         @run_state.in_own_window = false
         execute_command_with_streams(
@@ -1097,7 +1096,6 @@ module MarkdownExec
         block_name: @delegate_object[:block_name],
         document_filename: @delegate_object[:filename]
       )
-      # @dml_link_state_block_name_from_cli = @dml_link_state.block_name.present? ###
       @run_state.block_name_from_cli = @dml_link_state.block_name.present?
       @cli_block_name = @dml_link_state.block_name
       @dml_now_using_cli = @run_state.block_name_from_cli
@@ -1620,11 +1618,6 @@ module MarkdownExec
       bm = extract_named_captures_from_option(titlexcall,
                                               @delegate_object[:block_name_match])
 
-      fcb.stdin = extract_named_captures_from_option(titlexcall,
-                                                     @delegate_object[:block_stdin_scan])
-      fcb.stdout = extract_named_captures_from_option(titlexcall,
-                                                      @delegate_object[:block_stdout_scan])
-
       shell_color_option = SHELL_COLOR_OPTIONS[fcb[:shell]]
 
       if @delegate_object[:block_name_nick_match].present? && fcb.oname =~ Regexp.new(@delegate_object[:block_name_nick_match])
@@ -1695,7 +1688,6 @@ module MarkdownExec
 
     def inpseq_execute_block(block_name)
       @dml_block_state = block_state_for_name_from_cli(block_name)
-
       dump_and_warn_block_state(selected: @dml_block_state.block)
       @dml_link_state, @dml_menu_default_dname = \
         exec_bash_next_state(
@@ -1760,8 +1752,11 @@ module MarkdownExec
         file.rewind
 
         if link_block_data.fetch(LinkKeys::EXEC, false)
-          @run_state.files = Hash.new([])
-          execute_command_with_streams([cmd])
+          run_state_reset_stream_logs
+          execute_command_with_streams([cmd]) do |_stdin, stdout, stderr, _thread|
+            line = stdout || stderr
+            output_lines.push(line) if line
+          end
 
           ## select output_lines that look like assignment or match other specs
           #
@@ -1828,7 +1823,6 @@ module MarkdownExec
         document_filename: File.basename(@delegate_object[:filename]),
         document_filespec: @delegate_object[:filename],
         home: Dir.pwd,
-        # rest: '',
         started_at: Time.now.utc.strftime(@delegate_object[:execute_command_title_time_format])
       }
     end
@@ -1882,44 +1876,6 @@ module MarkdownExec
         expanded_expression
       end
     end
-
-    # private
-
-    # def read_block_name(line)
-    #   bm = extract_named_captures_from_option(line, @delegate_object[:block_name_match])
-    #   name = bm[:title]
-
-    #   if @delegate_object[:block_name_nick_match].present? && line =~ Regexp.new(@delegate_object[:block_name_nick_match])
-    #     name = $~[0]
-    #   else
-    #     name = bm && bm[1] ? bm[:title] : name
-    #   end
-    #   name
-    # end
-
-    #     # Loads auto link block.
-    #     def load_auto_link_block(all_blocks, link_state, mdoc, block_source:)
-    #       block_name = @delegate_object[:document_load_link_block_name]
-    #       return unless block_name.present? && @most_recent_loaded_filename != @delegate_object[:filename]
-
-    #       block = HashDelegator.block_find(all_blocks, :oname, block_name)
-    #       return unless block
-
-    #       if block.fetch(:shell, '') != BlockType::LINK
-    #         HashDelegator.error_handler('must be Link block type', { abort: true })
-
-    #       else
-    #         # debounce_reset
-    #         push_link_history_and_trigger_load(
-    #           link_block_body: block.fetch(:body, ''),
-    #           mdoc: mdoc,
-    #           selected: block,
-    #           link_state: link_state,
-    #           block_source: block_source
-    #         )
-    #       end
-    #     end
-
     # Handle expression with wildcard characters
     def load_filespec_wildcard_expansion(expr, auto_load_single: false)
       files = find_files(expr)
@@ -1955,7 +1911,6 @@ module MarkdownExec
       # recreate menu with new options
       #
       all_blocks, mdoc = mdoc_and_blocks_from_nested_files if load_auto_opts_block(all_blocks)
-      # load_auto_link_block(all_blocks, link_state, mdoc, block_source: {})
 
       menu_blocks = mdoc.fcbs_per_options(@delegate_object)
       add_menu_chrome_blocks!(menu_blocks: menu_blocks, link_state: link_state)
@@ -2074,7 +2029,7 @@ module MarkdownExec
       @fout.fout formatted_string
     end
 
-    def output_execution_result
+    def fout_execution_report
       @fout.fout fetch_color(data_sym: :execution_report_preview_head,
                              color_sym: :execution_report_preview_frame_color)
       [
@@ -2121,7 +2076,7 @@ module MarkdownExec
     end
 
     def pop_add_current_code_to_head_and_trigger_load(link_state, block_names, code_lines,
-                                                      dependencies, selected)
+                                                      dependencies, selected, next_block_name: nil)
       pop = @link_history.pop # updatable
       if pop.document_filename
         next_state = LinkState.new(
@@ -2146,7 +2101,7 @@ module MarkdownExec
           inherited_block_names: ((link_state&.inherited_block_names || []) + block_names).sort.uniq,
           inherited_dependencies: (link_state&.inherited_dependencies || {}).merge(dependencies || {}), ### merge, not replace, key data
           inherited_lines: HashDelegator.code_merge(link_state&.inherited_lines, code_lines),
-          next_block_name: '', # not link_block_data[LinkKeys::BLOCK] || ''
+          next_block_name: next_block_name,
           next_document_filename: @delegate_object[:filename], # not next_document_filename
           next_load_file: LoadFile::REUSE # not next_document_filename == @delegate_object[:filename] ? LoadFile::REUSE : LoadFile::LOAD
         )
@@ -2172,7 +2127,7 @@ module MarkdownExec
     def post_execution_process
       do_save_execution_output
       output_execution_summary
-      output_execution_result
+      fout_execution_report if @delegate_object[:output_execution_report]
     end
 
     # Prepare the blocks menu by adding labels and other necessary details.
@@ -2424,7 +2379,7 @@ module MarkdownExec
         end
       end
 
-      ## append blocks loaded, apply LinkKeys::EVAL
+      ## append blocks loaded
       #
       if (load_expr = link_block_data.fetch(LinkKeys::LOAD, '')).present?
         load_filespec = load_filespec_from_expression(load_expr)
@@ -2439,10 +2394,11 @@ module MarkdownExec
       end
 
       next_document_filename = write_inherited_lines_to_file(link_state, link_block_data)
+      next_block_name = link_block_data.fetch(LinkKeys::NEXT_BLOCK, nil) || link_block_data.fetch(LinkKeys::BLOCK, nil) || ''
 
       if link_block_data[LinkKeys::RETURN]
         pop_add_current_code_to_head_and_trigger_load(link_state, block_names, code_lines,
-                                                      dependencies, selected)
+                                                      dependencies, selected, next_block_name: next_block_name)
 
       else
         link_history_push_and_next(
@@ -2451,8 +2407,7 @@ module MarkdownExec
           inherited_block_names: ((link_state&.inherited_block_names || []) + block_names).sort.uniq,
           inherited_dependencies: (link_state&.inherited_dependencies || {}).merge(dependencies || {}), ### merge, not replace, key data
           inherited_lines: HashDelegator.code_merge(link_state&.inherited_lines, code_lines),
-          next_block_name: link_block_data.fetch(LinkKeys::NEXT_BLOCK,
-                                                 nil) || link_block_data[LinkKeys::BLOCK] || '',
+          next_block_name: next_block_name,
           next_document_filename: next_document_filename,
           next_load_file: next_document_filename == @delegate_object[:filename] ? LoadFile::REUSE : LoadFile::LOAD
         )
@@ -2538,6 +2493,13 @@ module MarkdownExec
       end
     end
 
+    def run_state_reset_stream_logs
+        @run_state.files = Hash.new()
+        @run_state.files[ExecutionStreams::STD_ERR] = []
+        @run_state.files[ExecutionStreams::STD_IN] = []
+        @run_state.files[ExecutionStreams::STD_OUT] = []
+    end
+
     def runtime_exception(exception_sym, name, items)
       if @delegate_object[exception_sym] != 0
         data = { name: name, detail: items.join(', ') }
@@ -2709,9 +2671,13 @@ module MarkdownExec
         dname = oname = title = fcb_title_groups.fetch(:name, '')
       end
 
+      # disable fcb for data blocks
+      disabled = fcb_title_groups.fetch(:shell, '') == 'yaml' ? '' : nil
+
       MarkdownExec::FCB.new(
         body: [],
         call: rest.match(Regexp.new(@delegate_object[:block_calls_scan]))&.to_a&.first,
+        disabled: disabled,
         dname: dname,
         headings: headings,
         indent: fcb_title_groups.fetch(:indent, ''),
@@ -2939,21 +2905,6 @@ module MarkdownExec
 
     def self.next_link_state(*args, **kwargs, &block)
       super
-      # result = super
-
-      # @logger ||= StdOutErrLogger.new
-      # @logger.unknown(
-      #   HashDelegator.clean_hash_recursively(
-      #     { "HashDelegator.next_link_state":
-      #         { 'args': args,
-      #           'at': Time.now.strftime('%FT%TZ'),
-      #           'for': /[^\/]+:\d+/.match(caller.first)[0],
-      #           'kwargs': kwargs,
-      #           'return': result } }
-      #   )
-      # )
-
-      # result
     end
   end
 end
@@ -3466,7 +3417,7 @@ module MarkdownExec
       end
 
       def test_format_execution_streams_with_valid_key
-        result = HashDelegator.format_execution_streams(:stdout,
+        result = HashDelegator.format_execution_streams(ExecutionStreams::STD_OUT,
                                                         { stdout: %w[output1 output2] })
 
         assert_equal 'output1output2', result
@@ -3475,7 +3426,7 @@ module MarkdownExec
       def test_format_execution_streams_with_empty_key
         @hd.instance_variable_get(:@run_state).stubs(:files).returns({})
 
-        result = HashDelegator.format_execution_streams(:stderr)
+        result = HashDelegator.format_execution_streams(ExecutionStreams::STD_ERR)
 
         assert_equal '', result
       end
@@ -3598,19 +3549,19 @@ module MarkdownExec
 
       def test_handle_stream
         stream = StringIO.new("line 1\nline 2\n")
-        file_type = :stdout
+        file_type = ExecutionStreams::STD_OUT
 
         Thread.new { @hd.handle_stream(stream: stream, file_type: file_type) }
 
         @hd.wait_for_stream_processing
 
         assert_equal ['line 1', 'line 2'],
-                     @hd.instance_variable_get(:@run_state).files[:stdout]
+                     @hd.instance_variable_get(:@run_state).files[ExecutionStreams::STD_OUT]
       end
 
       def test_handle_stream_with_io_error
         stream = StringIO.new("line 1\nline 2\n")
-        file_type = :stdout
+        file_type = ExecutionStreams::STD_OUT
         stream.stubs(:each_line).raises(IOError)
 
         Thread.new { @hd.handle_stream(stream: stream, file_type: file_type) }
@@ -3618,7 +3569,7 @@ module MarkdownExec
         @hd.wait_for_stream_processing
 
         assert_equal [],
-                     @hd.instance_variable_get(:@run_state).files[:stdout]
+                     @hd.instance_variable_get(:@run_state).files[ExecutionStreams::STD_OUT]
       end
     end
 

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.0.8.2'
+  VERSION = '2.0.8.4'
 end

data/lib/mdoc.rb

@@ -53,6 +53,17 @@ module MarkdownExec
       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.
+    #   @option fcb [Hash] :stdout A hash specifying the stdout details.
+    #     @option stdout [Boolean] :type Indicates whether to export to a variable (true) or to write to a file (false).
+    #     @option stdout [String] :name The name of the variable or file to which the body will be output.
+    #   @option fcb [Array<String>] :body An array of strings representing the lines of the script block's body.
+    #
+    # @return [String] A string containing the formatted shell command to output the script block's body.
+    #   If stdout[:type] is true, the command will export the body to a shell variable.
+    #   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")

data/lib/menu.src.yml

@@ -64,6 +64,7 @@
   :procname: val_as_str
 
 - :default: ">(?<full>(?<type>\\$)?(?<name>[A-Za-z_\\-\\.\\w]+))"
+  :description: Match to place block body into a file or a variable
   :env_var: MDE_BLOCK_STDOUT_SCAN
   :opt_name: block_stdout_scan
   :procname: val_as_str
@@ -106,12 +107,6 @@
   :opt_name: display_level_xbase_prefix
   :procname: val_as_str
 
-# - :default: "(document_link)"
-#   :description: Name of Link block to load with the document
-#   :env_var: MDE_DOCUMENT_LOAD_LINK_BLOCK_NAME
-#   :opt_name: document_load_link_block_name
-#   :procname: val_as_str
-
 - :default: "(document_options)"
   :description: Name of Opts block to load with the document
   :env_var: MDE_DOCUMENT_LOAD_OPTS_BLOCK_NAME
@@ -868,6 +863,13 @@
   :opt_name: output_execution_label_value_color
   :procname: val_as_str
 
+- :arg_name: BOOL
+  :default: true
+  :description: Output execution report at end of execution
+  :env_var: MDE_OUTPUT_EXECUTION_REPORT
+  :opt_name: output_execution_report
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Output saved script filename at end of execution

data/lib/menu.yml

@@ -53,6 +53,7 @@
   :opt_name: block_stdin_scan
   :procname: val_as_str
 - :default: ">(?<full>(?<type>\\$)?(?<name>[A-Za-z_\\-\\.\\w]+))"
+  :description: Match to place block body into a file or a variable
   :env_var: MDE_BLOCK_STDOUT_SCAN
   :opt_name: block_stdout_scan
   :procname: val_as_str
@@ -726,6 +727,12 @@
   :env_var: MDE_OUTPUT_EXECUTION_LABEL_VALUE_COLOR
   :opt_name: output_execution_label_value_color
   :procname: val_as_str
+- :arg_name: BOOL
+  :default: true
+  :description: Output execution report at end of execution
+  :env_var: MDE_OUTPUT_EXECUTION_REPORT
+  :opt_name: output_execution_report
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Output saved script filename at end of execution

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.0.8.2
+  version: 2.0.8.4
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-07 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard