markdown_exec 2.0.8.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858c301950e3ca7d43bc8c8c9a87f1c340b75710c28743a02ed0811a649b46ba
-  data.tar.gz: 4c7445f2d0e05e974cadd163894772b865bd7f94717f6f070fda6b2db2a0ef8c
+  metadata.gz: f49177c09809e5635f448181166f2fe60dffe9b942f1c23eeb29b2ecd43b55a8
+  data.tar.gz: 43488e384c44c757e1c7b95ad68e755a60a5bd617f3532c4e3213604984097e5
 SHA512:
-  metadata.gz: c157d1ec261a140205eabe4d2ec8a30839e8b8f1c716c2d24710d3630c587e03282b11a5f27e269e02b8e1a568fbca7bf2e37537cc04d4b9d4cfce9ef1ab4803
-  data.tar.gz: d991a308e029da9078adb996d8735951e3100eb117bc5a1f196db040513d4e20c715c6a4a805dcd528a93bd98d1a7b125eb2d88c4d9fea7449af1ad04add67be
+  metadata.gz: 9c923456c84259f80f53a839d48d4ed54c91f3bdc3ddb06fb96a1014b79a4640f21eed0bdb1f58635869fa70a5fb786259745a6e2a46cba2780a0093b81bc3e9
+  data.tar.gz: fbccdda04147b4a9ac0c9dd31bff501a626c60112fd70d0554aa89d2e005494e755abc0f63714c417e25461da23de3a960478cc1dd65fef9c126e927b6bbf037

data/CHANGELOG.md

@@ -1,14 +1,23 @@
 # Changelog
 
-Pass-through arguments after "--" to the script
-M       Gemfile.lock
-M       bin/tab_completion.sh
-M       examples/pass-through.md
-M       lib/hash_delegator.rb
-M       lib/markdown_exec.rb
-M       lib/markdown_exec/version.rb
-M       lib/menu.src.yml
-M       lib/menu.yml
+## [2.1.0] - 2024-07-15
+
+### Added
+
+- Option to toggle the output of an execution report.
+- Option to toggle a menu entry to view saved script and output files.
+- Options for formatting and parsing saved script and output file names.
+
+### Changed
+
+- Fix handling of output streams for executed scripts to improve logging out output and addition to inherited code.
+- YAML blocks are not executable from the menu.
+- Fix collection of output of Link blocks.
+- Pass-through arguments after "--" to the script.
+- Remove app info from menu.yml.
+- Remove test for unwanted arguments.
+- Fix Link next_block_name when filename is used.
+- In example doc, use nicknames to allow block content to be displayed.
 
 ## [2.0.8] - 2024-06-05
 

data/Gemfile.lock

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

data/examples/data-files.md

@@ -0,0 +1,50 @@
+# Demonstrate data blocks
+
+```opts :(document_options)
+pause_after_script_execution: true
+```
+
+## Create a data file by requiring a YAML block.
+::: YAML into a file
+/ YAML block that loads data into a file.
+```yaml :(test1) >test1.yml
+a: species
+b: genus
+```
+This is a Bash block that
+- requires a hidden YAML block (that creates a file), and
+- displays the file.
+```bash +(test1)
+echo "- The data file created"
+ls -al *.yml
+echo -e "\n- Contents of the file"
+cat -n test1.yml
+echo -e "\n- Remove the data file"
+rm test1.yml
+```
+
+## Load data by requiring a yaml block.
+::: YAML into a shell variable
+/ YAML block that loads data into a variable.
+```yaml :(test2) >$test2
+c: family
+d: order
+```
+This is a Bash block that
+- requires a hidden YAML block (that sets a variable), and
+- displays the variable.
+```bash +(test2)
+echo 'data:'
+echo "$test2"
+```
+
+## Visible YAML block that is not executable.
+::: Non-interactive data
+```yaml
+e: class
+f: phylum
+```
+
+# Related MDE options
+block_stdin_scan  | Match to place block body into a file or a variable
+block_stdout_scan | Match to place block body into a file or a variable

data/examples/opts_output_execution.md

@@ -0,0 +1,46 @@
+# Demo options: output_execution_report, output_execution_summary
+
+::: Options are initially True
+```opts :(document_options) +[document_options]
+output_execution_report: true
+output_execution_summary: true
+pause_after_script_execution: true
+```
+```bash
+whoami
+pwd >&2
+date >&1 1>&2
+```
+
+## output_execution_report
+### Example
+		 -^-
+		Command: mde ./examples/opt_output_execution_summary.md
+		StdOut: logs/mde_2024-07-08-03-21-59_opt_output_execution_summary_,_whoami___pwd__&2___date__&1_1_&2_.out.txt
+		 -v-
+### Toggle
+```opts
+output_execution_report: false
+```
+```opts
+output_execution_report: true
+```
+
+## output_execution_summary
+### Example (edited)
+		:execute_aborted_at:
+		:execute_completed_at: 2024-07-08 03:21:59.988451000 Z
+		:execute_error:
+		:execute_error_message:
+		:execute_options: { ... }
+		:execute_started_at: 2024-07-08 03:21:59.864442000 Z
+		:saved_filespec:
+		:script_block_name:
+		:streamed_lines: { ... }
+### Toggle
+```opts
+output_execution_summary: false
+```
+```opts
+output_execution_summary: true
+```

data/examples/save.md

@@ -0,0 +1,7 @@
+```opts :(document_options)
+execute_in_own_window: false
+save_execution_output: true
+```
+```bash :test
+echo "$(date -u)"
+```

data/lib/constants.rb

@@ -48,6 +48,7 @@ class MenuState
   CONTINUE = :continue
   EDIT = :edit
   EXIT = :exit
+  HISTORY = :history
   LOAD = :load
   SAVE = :save
   SHELL = :shell

data/lib/hash_delegator.rb

@@ -34,6 +34,7 @@ require_relative 'mdoc'
 require_relative 'regexp'
 require_relative 'resize_terminal'
 require_relative 'std_out_err_logger'
+require_relative 'streams_out'
 require_relative 'string_util'
 
 class String
@@ -163,15 +164,6 @@ module HashDelegatorSelf
   #   end.join("\n")
   # end
 
-  # Formats and returns the execution streams (like stdin, stdout, stderr) for a given key.
-  # It concatenates the array of strings found under the specified key in the run_state's files.
-  #
-  # @param key [Symbol] The key corresponding to the desired execution stream.
-  # @return [String] A concatenated string of the execution stream's contents.
-  def format_execution_streams(key, files = {})
-    (files || {}).fetch(key, []).join
-  end
-
   # Indents all lines in a given string with a specified indentation string.
   # @param body [String] A multi-line string to be indented.
   # @param indent [String] The string used for indentation (default is an empty string).
@@ -266,16 +258,6 @@ module HashDelegatorSelf
     exit 1
   end
 
-  # # Evaluates the given string as Ruby code and rescues any StandardErrors.
-  # # If an error occurs, it calls the error_handler method with 'safeval'.
-  # # @param str [String] The string to be evaluated.
-  # # @return [Object] The result of evaluating the string.
-  # def safeval(str)
-  #   eval(str)
-  # rescue StandardError # catches NameError, StandardError
-  #   error_handler('safeval')
-  # end
-
   def set_file_permissions(file_path, chmod_value)
     File.chmod(chmod_value, file_path)
   end
@@ -309,21 +291,6 @@ module HashDelegatorSelf
                                                       &block)
   end
 
-  def write_execution_output_to_file(files, filespec)
-    FileUtils.mkdir_p File.dirname(filespec)
-
-    File.write(
-      filespec,
-      ["-STDOUT-\n",
-       format_execution_streams(ExecutionStreams::STD_OUT, files),
-       "-STDERR-\n",
-       format_execution_streams(ExecutionStreams::STD_ERR, files),
-       "-STDIN-\n",
-       format_execution_streams(ExecutionStreams::STD_IN, files),
-       "\n"].join
-    )
-  end
-
   # Yields a line as a new block if the selected message type includes :line.
   # @param [String] line The line to be processed.
   # @param [Array<Symbol>] selected_messages A list of message types to check.
@@ -587,6 +554,9 @@ module MarkdownExec
       when MenuState::EXIT
         option_name = @delegate_object[:menu_option_exit_name]
         insert_at_top = @delegate_object[:menu_exit_at_top]
+      when MenuState::HISTORY
+        option_name = @delegate_object[:menu_option_history_name]
+        insert_at_top = @delegate_object[:menu_load_at_top]
       when MenuState::LOAD
         option_name = @delegate_object[:menu_option_load_name]
         insert_at_top = @delegate_object[:menu_load_at_top]
@@ -599,6 +569,8 @@ module MarkdownExec
       when MenuState::VIEW
         option_name = @delegate_object[:menu_option_view_name]
         insert_at_top = @delegate_object[:menu_load_at_top]
+      else
+        raise "Missing MenuState: #{menu_state}"
       end
 
       formatted_name = format(@delegate_object[:menu_link_format],
@@ -726,11 +698,12 @@ module MarkdownExec
       return unless @delegate_object[:saved_stdout_folder]
 
       @delegate_object[:logged_stdout_filename] =
-        SavedAsset.stdout_name(blockname: block_name,
-                               filename: File.basename(@delegate_object[:filename],
-                                                       '.*'),
-                               prefix: @delegate_object[:logged_stdout_filename_prefix],
-                               time: Time.now.utc)
+        SavedAsset.new(blockname: block_name,
+                       filename: @delegate_object[:filename],
+                       prefix: @delegate_object[:logged_stdout_filename_prefix],
+                       time: Time.now.utc,
+                       exts: '.out.txt',
+                       saved_asset_format: @delegate_object[:saved_asset_format]).generate_name
 
       @logged_stdout_filespec =
         @delegate_object[:logged_stdout_filespec] =
@@ -793,7 +766,7 @@ module MarkdownExec
     end
 
     def command_execute(command, args: [])
-      run_state_reset_stream_logs
+      @run_state.files = StreamsOut.new
       @run_state.options = @delegate_object
       @run_state.started_at = Time.now.utc
 
@@ -820,14 +793,14 @@ module MarkdownExec
       @run_state.aborted_at = Time.now.utc
       @run_state.error_message = err.message
       @run_state.error = err
-      @run_state.files[ExecutionStreams::STD_ERR] += [@run_state.error_message]
+      @run_state.files.append_stream_line(ExecutionStreams::STD_ERR, @run_state.error_message)
       @fout.fout "Error ENOENT: #{err.inspect}"
     rescue SignalException => err
       # Handle SignalException
       @run_state.aborted_at = Time.now.utc
       @run_state.error_message = 'SIGTERM'
       @run_state.error = err
-      @run_state.files[ExecutionStreams::STD_ERR] += [@run_state.error_message]
+      @run_state.files.append_stream_line(ExecutionStreams::STD_ERR, @run_state.error_message)
       @fout.fout "Error ENOENT: #{err.inspect}"
     end
 
@@ -1080,8 +1053,7 @@ module MarkdownExec
       return unless @delegate_object[:save_execution_output]
       return if @run_state.in_own_window
 
-      HashDelegator.write_execution_output_to_file(@run_state.files,
-                                                   @delegate_object[:logged_stdout_filespec])
+      @run_state.files.write_execution_output_to_file(@delegate_object[:logged_stdout_filespec])
     end
 
     # Select and execute a code block from a Markdown document.
@@ -1117,12 +1089,14 @@ module MarkdownExec
         pop_add_current_code_to_head_and_trigger_load(@dml_link_state, inherited_block_names, code_lines, inherited_dependencies, selected)
       end
 
-      item_back = format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_back_name]))
-      item_edit = format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_edit_name]))
-      item_load = format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_load_name]))
-      item_save = format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_save_name]))
-      item_shell = format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_shell_name]))
-      item_view = format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_view_name]))
+      fdo = ->(mo) { format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[mo])) }
+      item_back = fdo.call(:menu_option_back_name)
+      item_edit = fdo.call(:menu_option_edit_name)
+      item_history = fdo.call(:menu_option_history_name)
+      item_load = fdo.call(:menu_option_load_name)
+      item_save = fdo.call(:menu_option_save_name)
+      item_shell = fdo.call(:menu_option_shell_name)
+      item_view = fdo.call(:menu_option_view_name)
 
       @run_state.batch_random = Random.new.rand
       @run_state.batch_index = 0
@@ -1136,6 +1110,12 @@ module MarkdownExec
           # puts "@ - parse document #{data}"
           inpseq_parse_document(data)
 
+          if @delegate_object[:menu_for_history]
+            history_files.tap do |files|
+              menu_enable_option(item_history, files.count, 'files', menu_state: MenuState::HISTORY) if files.count.positive?
+            end
+          end
+
           if @delegate_object[:menu_for_saved_lines] && @delegate_object[:document_saved_lines_glob].present?
 
             sf = document_name_in_glob_as_file_name(@dml_link_state.document_filename, @delegate_object[:document_saved_lines_glob])
@@ -1146,11 +1126,11 @@ module MarkdownExec
 
             # add menu items (glob, load, save) and enable selectively
             menu_add_disabled_option(sf) if files.count.positive? || lines_count.positive?
-            menu_enable_option(format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_load_name])), files.count, 'files', menu_state: MenuState::LOAD) if files.count.positive?
-            menu_enable_option(format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_edit_name])), lines_count, 'lines', menu_state: MenuState::EDIT) if lines_count.positive?
-            menu_enable_option(format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_save_name])), 1, '', menu_state: MenuState::SAVE) if lines_count.positive?
-            menu_enable_option(format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_view_name])), 1, '', menu_state: MenuState::VIEW) if lines_count.positive?
-            menu_enable_option(format(@delegate_object[:menu_link_format], HashDelegator.safeval(@delegate_object[:menu_option_shell_name])), 1, '', menu_state: MenuState::SHELL) if @delegate_object[:menu_with_shell]
+            menu_enable_option(item_load, files.count, 'files', menu_state: MenuState::LOAD) if files.count.positive?
+            menu_enable_option(item_edit, lines_count, 'lines', menu_state: MenuState::EDIT) if lines_count.positive?
+            menu_enable_option(item_save, 1, '', menu_state: MenuState::SAVE) if lines_count.positive?
+            menu_enable_option(item_view, 1, '', menu_state: MenuState::VIEW) if lines_count.positive?
+            menu_enable_option(item_shell, 1, '', menu_state: MenuState::SHELL) if @delegate_object[:menu_with_shell]
           end
 
         when :display_menu
@@ -1195,6 +1175,42 @@ module MarkdownExec
             debounce_reset
             edited = edit_text(@dml_link_state.inherited_lines.join("\n"))
             @dml_link_state.inherited_lines = edited.split("\n") if edited
+
+            return :break if pause_user_exit
+
+            InputSequencer.next_link_state(prior_block_was_link: true)
+
+          when item_history
+            debounce_reset
+            files = history_files
+            files_table_rows = files.map do |file|
+              if Regexp.new(@delegate_object[:saved_asset_match]) =~ file
+                OpenStruct.new(file: file, row: [$~[:time], $~[:blockname], $~[:exts]].join('  '))
+              else
+                warn "Cannot parse name: #{file}"
+                next
+              end
+            end.compact
+
+            case (name = prompt_select_code_filename(
+              [@delegate_object[:prompt_filespec_back]] +
+               files_table_rows.map(&:row),
+              string: @delegate_object[:prompt_select_history_file],
+              color_sym: :prompt_color_after_script_execution
+            ))
+            when @delegate_object[:prompt_filespec_back]
+              # do nothing
+            else
+              file = files_table_rows.select { |ftr| ftr.row == name }&.first
+              info = file_info(file.file)
+              warn "#{file.file} - #{info[:lines]} lines / #{info[:size]} bytes"
+              warn(File.readlines(file.file, chomp: false).map.with_index do |line, ind|
+                     format(' %s.  %s', format('% 4d', ind).violet, line)
+                   end)
+            end
+
+            return :break if pause_user_exit
+
             InputSequencer.next_link_state(prior_block_was_link: true)
 
           when item_load
@@ -1205,6 +1221,9 @@ module MarkdownExec
               @dml_link_state.inherited_lines ||= []
               @dml_link_state.inherited_lines += File.readlines(load_filespec, chomp: true)
             end
+
+            return :break if pause_user_exit
+
             InputSequencer.next_link_state(prior_block_was_link: true)
 
           when item_save
@@ -1218,6 +1237,7 @@ module MarkdownExec
               return :break
 
             end
+
             InputSequencer.next_link_state(prior_block_was_link: true)
 
           when item_shell
@@ -1236,11 +1256,17 @@ module MarkdownExec
                 warn "#{'ERR'.bred} #{exit_status}"
               end
             end
+
+            return :break if pause_user_exit
+
             InputSequencer.next_link_state(prior_block_was_link: true)
 
           when item_view
             debounce_reset
             warn @dml_link_state.inherited_lines.join("\n")
+
+            return :break if pause_user_exit
+
             InputSequencer.next_link_state(prior_block_was_link: true)
 
           else
@@ -1558,6 +1584,21 @@ module MarkdownExec
       string_send_color(data_string, color_sym)
     end
 
+    # size of a file in bytes and the number of lines
+    def file_info(file_path)
+      file_size = 0
+      line_count = 0
+
+      File.open(file_path, 'r') do |file|
+        file.each_line do |_line|
+          line_count += 1
+        end
+        file_size = file.size
+      end
+
+      { size: file_size, lines: line_count }
+    end
+
     def format_and_execute_command(code_lines:)
       formatted_command = code_lines.flatten.join("\n")
       @fout.fout fetch_color(data_sym: :script_execution_head,
@@ -1654,7 +1695,7 @@ module MarkdownExec
         Thread.new do
           stream.each_line do |line|
             line.strip!
-            @run_state.files[file_type] << line if @run_state.files
+            @run_state.files.append_stream_line(file_type, line) if @run_state.files.streams
 
             if @delegate_object[:output_stdout]
               # print line
@@ -1671,6 +1712,16 @@ module MarkdownExec
       end
     end
 
+    def history_files
+      Dir.glob(
+        File.join(
+          @delegate_object[:saved_script_folder],
+          SavedAsset.new(filename: @delegate_object[:filename],
+                         saved_asset_format: @delegate_object[:saved_asset_format]).generate_name
+        )
+      )
+    end
+
     # Initializes variables for regex and other states
     def initial_state
       {
@@ -1752,7 +1803,7 @@ module MarkdownExec
         file.rewind
 
         if link_block_data.fetch(LinkKeys::EXEC, false)
-          run_state_reset_stream_logs
+          @run_state.files = StreamsOut.new
           execute_command_with_streams([cmd]) do |_stdin, stdout, stderr, _thread|
             line = stdout || stderr
             output_lines.push(line) if line
@@ -1876,6 +1927,7 @@ module MarkdownExec
         expanded_expression
       end
     end
+
     # Handle expression with wildcard characters
     def load_filespec_wildcard_expansion(expr, auto_load_single: false)
       files = find_files(expr)
@@ -1886,7 +1938,11 @@ module MarkdownExec
       else
         ## user selects from existing files or other
         #
-        case (name = prompt_select_code_filename([@delegate_object[:prompt_filespec_back]] + files))
+        case (name = prompt_select_code_filename(
+          [@delegate_object[:prompt_filespec_back]] + files,
+          string: @delegate_object[:prompt_select_code_file],
+          color_sym: :prompt_color_after_script_execution
+        ))
         when @delegate_object[:prompt_filespec_back]
           # do nothing
         else
@@ -2053,16 +2109,16 @@ module MarkdownExec
     def output_execution_summary
       return unless @delegate_object[:output_execution_summary]
 
-      fout_section 'summary', {
+      @fout.fout_section 'summary', {
         execute_aborted_at: @run_state.aborted_at,
         execute_completed_at: @run_state.completed_at,
         execute_error: @run_state.error,
         execute_error_message: @run_state.error_message,
-        execute_files: @run_state.files,
         execute_options: @run_state.options,
         execute_started_at: @run_state.started_at,
+        saved_filespec: @run_state.saved_filespec,
         script_block_name: @run_state.script_block_name,
-        saved_filespec: @run_state.saved_filespec
+        streamed_lines: @run_state.files.streams
       }
     end
 
@@ -2075,6 +2131,11 @@ module MarkdownExec
       ), level: level
     end
 
+    def pause_user_exit
+      @delegate_object[:pause_after_script_execution] &&
+        prompt_select_continue == MenuState::EXIT
+    end
+
     def pop_add_current_code_to_head_and_trigger_load(link_state, block_names, code_lines,
                                                       dependencies, selected, next_block_name: nil)
       pop = @link_history.pop # updatable
@@ -2301,10 +2362,9 @@ module MarkdownExec
 
     # public
 
-    def prompt_select_code_filename(filenames)
+    def prompt_select_code_filename(filenames, string: @delegate_object[:prompt_select_code_file], color_sym: :prompt_color_after_script_execution)
       @prompt.select(
-        string_send_color(@delegate_object[:prompt_select_code_file],
-                          :prompt_color_after_script_execution),
+        string_send_color(string, color_sym),
         filter: true,
         quiet: true
       ) do |menu|
@@ -2445,7 +2505,7 @@ module MarkdownExec
     end
 
     # Registers console attributes by modifying the options hash.
-    # This method handles terminal resizing and adjusts the console dimensions 
+    # This method handles terminal resizing and adjusts the console dimensions
     # and pagination settings based on the current terminal size.
     #
     # @param opts [Hash] a hash containing various options for the console settings.
@@ -2462,19 +2522,15 @@ module MarkdownExec
     #   register_console_attributes(opts)
     #   # opts will be updated with the current console dimensions and pagination settings.
     def register_console_attributes(opts)
-      begin
-        if (resized = @delegate_object[:menu_resize_terminal])
-          resize_terminal
-        end
+      if (resized = @delegate_object[:menu_resize_terminal])
+        resize_terminal
+      end
 
-        if resized || !opts[:console_width]
-          opts[:console_height], opts[:console_width] = opts[:console_winsize] = IO.console.winsize
-        end
+      opts[:console_height], opts[:console_width] = opts[:console_winsize] = IO.console.winsize if resized || !opts[:console_width]
 
-        opts[:per_page] = opts[:select_page_height] = [opts[:console_height] - 3, 4].max unless opts[:select_page_height]&.positive?
-      rescue StandardError
-        HashDelegator.error_handler('register_console_attributes', { abort: true })
-      end
+      opts[:per_page] = opts[:select_page_height] = [opts[:console_height] - 3, 4].max unless opts[:select_page_height]&.positive?
+    rescue StandardError
+      HashDelegator.error_handler('register_console_attributes', { abort: true })
     end
 
     # Check if the delegate object responds to a given method.
@@ -2493,13 +2549,6 @@ 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(', ') }
@@ -2543,8 +2592,11 @@ module MarkdownExec
         ## user selects from existing files or other
         # input into path with wildcard for easy entry
         #
-        name = prompt_select_code_filename([@delegate_object[:prompt_filespec_back], @delegate_object[:prompt_filespec_other]] + files)
-        case name
+        case (name = prompt_select_code_filename(
+          [@delegate_object[:prompt_filespec_back], @delegate_object[:prompt_filespec_other]] + files,
+          string: @delegate_object[:prompt_select_code_file],
+          color_sym: :prompt_color_after_script_execution
+        ))
         when @delegate_object[:prompt_filespec_back]
           # do nothing
         when @delegate_object[:prompt_filespec_other]
@@ -2811,12 +2863,12 @@ module MarkdownExec
 
       time_now = Time.now.utc
       @run_state.saved_script_filename =
-        SavedAsset.script_name(
-          blockname: selected.pub_name,
-          filename: @delegate_object[:filename],
-          prefix: @delegate_object[:saved_script_filename_prefix],
-          time: time_now
-        )
+        SavedAsset.new(blockname: selected.pub_name,
+                       exts: '.sh',
+                       filename: @delegate_object[:filename],
+                       prefix: @delegate_object[:saved_script_filename_prefix],
+                       saved_asset_format: @delegate_object[:saved_asset_format],
+                       time: time_now).generate_name
       @run_state.saved_filespec =
         File.join(@delegate_object[:saved_script_folder],
                   @run_state.saved_script_filename)
@@ -3416,25 +3468,27 @@ module MarkdownExec
         @hd.instance_variable_set(:@run_state, mock('run_state'))
       end
 
-      def test_format_execution_streams_with_valid_key
-        result = HashDelegator.format_execution_streams(ExecutionStreams::STD_OUT,
-                                                        { stdout: %w[output1 output2] })
+      def test_format_execution_stream_with_valid_key
+        result = HashDelegator.format_execution_stream(
+          { stdout: %w[output1 output2] },
+          ExecutionStreams::STD_OUT
+        )
 
-        assert_equal 'output1output2', result
+        assert_equal "output1\noutput2", result
       end
 
-      def test_format_execution_streams_with_empty_key
+      def test_format_execution_stream_with_empty_key
         @hd.instance_variable_get(:@run_state).stubs(:files).returns({})
 
-        result = HashDelegator.format_execution_streams(ExecutionStreams::STD_ERR)
+        result = HashDelegator.format_execution_stream(nil, ExecutionStreams::STD_ERR)
 
         assert_equal '', result
       end
 
-      def test_format_execution_streams_with_nil_files
+      def test_format_execution_stream_with_nil_files
         @hd.instance_variable_get(:@run_state).stubs(:files).returns(nil)
 
-        result = HashDelegator.format_execution_streams(:stdin)
+        result = HashDelegator.format_execution_stream(nil, :stdin)
 
         assert_equal '', result
       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.4'
+  VERSION = '2.1.0'
 end

data/lib/menu.src.yml

@@ -127,6 +127,13 @@
   :opt_name: menu_for_saved_lines
   :procname: val_as_bool
 
+- :arg_name: BOOL
+  :default: true
+  :description: Add menu options for history
+  :env_var: MDE_menu_for_history
+  :opt_name: menu_for_history
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Dump @delegate_object
@@ -643,8 +650,8 @@
   :opt_name: menu_note_format
   :procname: val_as_str
 
-## all lines that do not start with "/ " are notes
-- :default: "^(?<line>(?!/ )(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+## lines that start with "/" are comments (hidden), not notes (visible)
+- :default: "^(?<line>(?!/)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :description: Pattern for notes in block selection menu
   :env_var: MDE_MENU_NOTE_MATCH
   :opt_name: menu_note_match
@@ -671,6 +678,13 @@
   :opt_name: menu_option_exit_name
   :procname: val_as_str
 
+- :default:
+    :line: "* History"
+  :description: Text for History option
+  :env_var: MDE_MENU_OPTION_HISTORY_NAME
+  :opt_name: menu_option_history_name
+  :procname: val_as_str
+
 - :default:
     :line: "* Load"
   :description: Text for Load option
@@ -992,6 +1006,12 @@
   :opt_name: prompt_select_code_file
   :procname: val_as_str
 
+- :default: "\nView file:"
+  :description: Prompt to select a saved asset
+  :env_var: MDE_PROMPT_SELECT_HISTORY_FILE
+  :opt_name: prompt_select_history_file
+  :procname: val_as_str
+
 - :default: "\nChoose a file:"
   :description: Prompt to select a markdown document
   :env_var: MDE_PROMPT_SELECT_MD
@@ -1038,6 +1058,18 @@
   :opt_name: runtime_exception_error_level
   :procname: val_as_int
 
+- :default: '%{prefix}%{join}%{time}%{join}%{filename}%{join}%{mark}%{join}%{blockname}%{join}%{exts}'
+  :description: saved_asset_format
+  :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
+  :env_var: MDE_SAVED_ASSET_MATCH
+  :opt_name: saved_asset_match
+  :procname: val_as_str
+
 - :arg_name: BOOL
   :default: false
   :description: Whether to save an executed script

data/lib/menu.yml

@@ -106,6 +106,12 @@
   :env_var: MDE_MENU_FOR_SAVED_LINES
   :opt_name: menu_for_saved_lines
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: Add menu options for history
+  :env_var: MDE_menu_for_history
+  :opt_name: menu_for_history
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Dump @delegate_object
@@ -542,7 +548,7 @@
   :env_var: MDE_MENU_NOTE_FORMAT
   :opt_name: menu_note_format
   :procname: val_as_str
-- :default: "^(?<line>(?!/ )(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+- :default: "^(?<line>(?!/)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :description: Pattern for notes in block selection menu
   :env_var: MDE_MENU_NOTE_MATCH
   :opt_name: menu_note_match
@@ -565,6 +571,12 @@
   :env_var: MDE_MENU_OPTION_EXIT_NAME
   :opt_name: menu_option_exit_name
   :procname: val_as_str
+- :default:
+    :line: "* History"
+  :description: Text for History option
+  :env_var: MDE_MENU_OPTION_HISTORY_NAME
+  :opt_name: menu_option_history_name
+  :procname: val_as_str
 - :default:
     :line: "* Load"
   :description: Text for Load option
@@ -848,6 +860,13 @@
   :procname: val_as_str
 - :default: |2-
 
+    View file:
+  :description: Prompt to select a saved asset
+  :env_var: MDE_PROMPT_SELECT_HISTORY_FILE
+  :opt_name: prompt_select_history_file
+  :procname: val_as_str
+- :default: |2-
+
     Choose a file:
   :description: Prompt to select a markdown document
   :env_var: MDE_PROMPT_SELECT_MD
@@ -889,6 +908,16 @@
   :env_var: MDE_RUNTIME_EXCEPTION_ERROR_LEVEL
   :opt_name: runtime_exception_error_level
   :procname: val_as_int
+- :default: "%{prefix}%{join}%{time}%{join}%{filename}%{join}%{mark}%{join}%{blockname}%{join}%{exts}"
+  :description: saved_asset_format
+  :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
+  :env_var: MDE_SAVED_ASSET_MATCH
+  :opt_name: saved_asset_match
+  :procname: val_as_str
 - :arg_name: BOOL
   :default: false
   :description: Whether to save an executed script

data/lib/saved_assets.rb

@@ -12,23 +12,57 @@ module MarkdownExec
   # method derives a name for stdout redirection.
   #
   class SavedAsset
-    FNR11 = %r{[^!#%&()\+,\-0-9=A-Z_a-z~]}.freeze
+    FNR11 = %r{[^!#%\+\-0-9=@A-Z_a-z]}.freeze # characters than can be used in a file name without quotes or escaping
+    # except '.', ',', '~' reserved for tokenization
     # / !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
     FNR12 = '_'
     DEFAULT_FTIME = '%F-%H-%M-%S'
+    FILE_BLOCK_SEP = ','
+    JOIN_STR = '_'
+    MARK_STR = '~'
 
-    # Generates a formatted script name based on the provided parameters.
-    def self.script_name(filename:, prefix:, time:, blockname:, ftime: DEFAULT_FTIME, join_str: '_', pattern: FNR11, replace: FNR12, exts: '.sh')
-      fne = filename.gsub(pattern, replace)
-      bne = blockname.gsub(pattern, replace)
-      "#{[prefix, time.strftime(ftime), fne, ',', bne].join(join_str)}#{exts}"
+    # @param filename [String] the name of the file
+    # @param prefix [String] the prefix to use
+    # @param time [Time] the time object for formatting
+    # @param blockname [String] the block name to include
+    # @param ftime [String] the time format (default: DEFAULT_FTIME)
+    # @param pattern [Regexp] the pattern to search (default: FNR11)
+    # @param replace [String] the string to replace the pattern (default: FNR12)
+    # @param exts [String] the extension to append (default: '.sh')
+    def initialize(
+      saved_asset_format:, filename: nil, prefix: nil, time: nil, blockname: nil,
+      ftime: DEFAULT_FTIME, pattern: FNR11, replace: FNR12, exts: nil,
+      mark: nil, join_str: nil
+    )
+      @filename = filename ? filename.gsub(pattern, replace) : '*' # [String] the name of the file
+      @prefix = prefix || '*' # [String] the prefix to use
+      @time = time ? time.strftime(ftime) : '*' # [Time] the time object for formatting
+      @blockname = blockname ? blockname.gsub(pattern, replace) : '*' # [String] the block name to include
+      # @ftime = ftime # [String] the time format (default: DEFAULT_FTIME)
+      # @pattern = pattern # [Regexp] the pattern to search (default: FNR11)
+      # @replace = replace # [String] the string to replace the pattern (default: FNR12)
+      @exts = exts || '.*' # [String] the extension to append (default: '.sh')
+      @mark = mark || MARK_STR
+      @join_str = join_str || JOIN_STR
+      @saved_asset_format = saved_asset_format
     end
 
-    # Generates a formatted stdout name based on the provided parameters.
-    def self.stdout_name(filename:, prefix:, time:, blockname:, ftime: DEFAULT_FTIME, join_str: '_', pattern: FNR11, replace: FNR12, exts: '.out.txt')
-      fne = filename.gsub(pattern, replace)
-      bne = blockname.gsub(pattern, replace)
-      "#{[prefix, time.strftime(ftime), fne, ',', bne].join(join_str)}#{exts}"
+    # Generates a formatted name based on the provided parameters.
+    #
+    # @return [String] the generated formatted name
+    def generate_name
+      format(
+        @saved_asset_format,
+        {
+          blockname: @blockname,
+          exts: @exts,
+          filename: @filename,
+          join: @join_str,
+          mark: @mark,
+          prefix: @prefix,
+          time: @time
+        }
+      )
     end
   end
 end
@@ -61,4 +95,76 @@ class SavedAssetTest < Minitest::Test
       filename: filename, prefix: prefix, time: time, blockname: blockname
     )
   end
+
+  def test_wildcard_name_with_all_parameters
+    filename = 'sample.txt'
+    prefix = 'test'
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = 'block/1:2'
+    expected_wildcard = 'test_2023-01-01-12-00-00_sample_txt_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_time
+    filename = 'sample.txt'
+    prefix = 'test'
+    time = nil
+    blockname = 'block/1:2'
+    expected_wildcard = 'test_*_sample_txt_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_filename
+    filename = nil
+    prefix = 'test'
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = 'block/1:2'
+    expected_wildcard = 'test_2023-01-01-12-00-00_*_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_prefix
+    filename = 'sample.txt'
+    prefix = nil
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = 'block/1:2'
+    expected_wildcard = '*_2023-01-01-12-00-00_sample_txt_,_block_1_2.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_missing_blockname
+    filename = 'sample.txt'
+    prefix = 'test'
+    time = Time.new(2023, 1, 1, 12, 0, 0)
+    blockname = nil
+    expected_wildcard = 'test_2023-01-01-12-00-00_sample_txt_,_*.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
+
+  def test_wildcard_name_with_all_missing
+    filename = nil
+    prefix = nil
+    time = nil
+    blockname = nil
+    expected_wildcard = '*_*_*_,_*.sh'
+
+    assert_equal expected_wildcard, MarkdownExec::SavedAsset.wildcard_name(
+      filename: filename, prefix: prefix, time: time, blockname: blockname
+    )
+  end
 end

data/lib/streams_out.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+class StreamsOut
+  attr_accessor :streams
+
+  def initialize
+    @streams = []
+  end
+
+  def append_stream_line(stream, line)
+    @streams << { stream: stream, line: line, timestamp: Time.now }
+  end
+
+  def write_execution_output_to_file(filespec)
+    FileUtils.mkdir_p File.dirname(filespec)
+
+    output = @streams.map do |entry|
+      case entry[:stream]
+      when ExecutionStreams::STD_OUT
+        entry[:line]
+        # "OUT: #{entry[:line]}"
+      when ExecutionStreams::STD_ERR
+        entry[:line]
+        # "ERR: #{entry[:line]}"
+      when ExecutionStreams::STD_IN
+        entry[:line]
+        # " IN: #{entry[:line]}"
+      end
+    end.join("\n")
+
+    File.write(filespec, output)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.0.8.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -115,6 +115,7 @@ files:
 - bin/tab_completion.sh.erb
 - examples/block_names.md
 - examples/colors.md
+- examples/data-files.md
 - examples/document_options.md
 - examples/duplicate_block.md
 - examples/import0.md
@@ -135,10 +136,12 @@ files:
 - examples/load_code.md
 - examples/nickname.md
 - examples/opts.md
+- examples/opts_output_execution.md
 - examples/pass-through.md
 - examples/pause-after-execution.md
 - examples/plant.md
 - examples/port.md
+- examples/save.md
 - examples/search.md
 - examples/vars.md
 - examples/wrap.md
@@ -179,6 +182,7 @@ files:
 - lib/saved_files_matcher.rb
 - lib/shared.rb
 - lib/std_out_err_logger.rb
+- lib/streams_out.rb
 - lib/string_util.rb
 - lib/tap.rb
 homepage: https://rubygems.org/gems/markdown_exec