markdown_exec 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ec074d1854ef0150cf60852fd39d7db7bc88461f7d9f5ae6547fe009142ffb4
-  data.tar.gz: 8d6eb3c7759bf180b996f8a68ec8b52d0e52a230365b163f06528e9c11627e42
+  metadata.gz: c8baa6b01b9d965c3a8856d08a86225457c09106c366ecd174f7f0e547f43f4a
+  data.tar.gz: bd0348f31ddb1bb0cda0328e5c7dd3187e6692269e8b132849833ce1d44f5b0f
 SHA512:
-  metadata.gz: '095584193734695c29729060ca4ccd424088ca59cdd8bf539dda5a6b914d7fd71d373304f071e46b49072bf01b09ae2a1f0cf86bf314f3d79ace9acd166a3531'
-  data.tar.gz: c8e55fa064fe9bc8c170c9431dd1a5dc9fd3f20f1fe42925c00c4f2ed5113d597f457ecdba225cf4533563cd0c3f14f35ebc1ad096e8a89f8ec654a5cd87cd8c
+  metadata.gz: e6f8028d4fe4dea45bacb14e8cb12306d0ee975ac729c04d0f8db990a6ce92758b13400329358656d5902c85dd5411aef717210b0151de4ae2cec375f51b0b98
+  data.tar.gz: 390dd965fe49ab4ac1651996fc7500ff971fbe71ce580ff807d8652b62aff5b50768ce971920e9f93682d5adb692cd5bcf99834b8b022c41734dc24f61cf940c

data/CHANGELOG.md

@@ -4,11 +4,9 @@
 
 - pipe stdin to script
 - yes/no/write/clipboard/record/edit/history
-- add confirm block to generated file
 - present timestamp, result of last exec for each command
 - user settings
 - hidden w , w/o () in names
-- exit in menus
 - fix regexp in pathnames
 - tab completion from md file
 - read file once to allow for tempdoc stream
@@ -20,18 +18,53 @@
 
 - include blocks from local md file
 
-- save outputs, errors
-
 - chmod a+x logged script
 
-- exec most recent logged scripts
+- add shebang to saved script
+
+## [0.2.6] - 2022-04-07
+
+### Changed
+
+- Fixed default values for command line options.
+
+## [0.2.5] - 2022-04-03
 
-- cmd to list last n
-- cmd to repeat last
+### Added
+
+- Command `--list-default-env` to show default configuration as environment variables.
+- Command `--list-default-yaml` to show default configuration as YAML.
+- Option to exit program when selecting files or blocks.
+
+### Changed
 
-## [Unreleased]
+- Composition of menu to facilitate reports.
+- List default values in menu help.
 
-## [0.2.3] - 2022-03
+## [0.2.4] - 2022-04-01
+
+### Added
+
+- Command `--list-recent-scripts` to list the last *N* saved scripts.
+- Command `--run-last-script` to re-run the last saved script.
+- Command `--select-recent-script` to select and execute a recently saved script.
+
+| YAML Name | Environment Variable | Option Name | Default | Purpose |
+| :--- | :--- | :--- | :--- | :--- |
+| list_count | MDE_LIST_COUNT | `--list-count` | `16` | Max. items to return in list |
+| logged_stdout_filename_prefix | MDE_LOGGED_STDOUT_FILENAME_PREFIX | | `mde` | Name prefix for stdout files |
+| save_execution_output | MDE_SAVE_EXECUTION_OUTPUT | `--save-execution-output` | False | Save standard output of the executed script |
+| saved_script_filename_prefix | MDE_SAVED_SCRIPT_FILENAME_PREFIX | | `mde` | Name prefix for saved scripts |
+| saved_script_folder | MDE_SAVED_SCRIPT_FOLDER | `--saved-script-folder` | `logs` | Saved script folder |
+| saved_script_glob | MDE_SAVED_SCRIPT_GLOB | | `mde_*.sh` | Glob matching saved scripts |
+| saved_stdout_folder | MDE_SAVED_STDOUT_FOLDER | `--saved-stdout-folder` | `logs` | Saved stdout folder |
+
+### Changed
+
+- Fix saving of executed script.
+- Sort configuration keys output by `-0` (Show configuration.)
+
+## [0.2.3] - 2022-03-29
 
 ### Added
 
@@ -45,9 +78,7 @@
 ### Changed
 
 - Naming saved script files: The file name contains the time stamp, document name, and block name.
-
 - Renamed folder with fixtures.
-
 - Command options:
 
 | YAML Name | Environment Variable | Option Name | Default | Purpose |
@@ -70,8 +101,8 @@
 | block_name_excluded_match | MDE_BLOCK_NAME_EXCLUDED_MATCH  | `^\(.+\)$` |
 | block_name_match | MDE_BLOCK_NAME_MATCH  | `:(?<title>\S+)( \|$)` |
 | block_required_scan | MDE_BLOCK_REQUIRED_SCAN  | `\+\S+` |
-| fenced_start_and_end_match | MDE_FENCED_START_AND_END_MATCH  | `^\`{3,}` |
-| fenced_start_ex_match | MDE_FENCED_START_EX_MATCH  | `^\`{3,}(?<shell>[^\`\s]*) *(?<name>.*)$` |
+| fenced_start_and_end_match | MDE_FENCED_START_AND_END_MATCH  | ``^`{3,}`` |
+| fenced_start_ex_match | MDE_FENCED_START_EX_MATCH  | ``^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$`` |
 | heading1_match | MDE_HEADING1_MATCH  | `^# *(?<name>[^#]*?) *$` |
 | heading2_match | MDE_HEADING2_MATCH  | `^## *(?<name>[^#]*?) *$` |
 | heading3_match | MDE_HEADING3_MATCH  | `^### *(?<name>.+?) *$` |

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (0.2.3)
+    markdown_exec (0.2.5)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)

data/README.md

@@ -1,30 +1,35 @@
 # MarkdownExec
 
-Interactively select and execute fenced code blocks in markdown files. Build complex scripts by naming and requiring blocks.
+Interactively select and execute fenced code blocks in markdown files. Build complex scripts by naming and requiring blocks. Log resulting scripts and output. Re-run scripts.
 
-* Code blocks may be named.
+* Code blocks may be named. Named blocks can be required by other blocks.
 
-* Named blocks can be required by other blocks.
+* The user-selected code block, and all required blocks, are arranged into a script in the order they appear in the markdown file. The script can be presented for approval prior to execution.
 
-* The user-selected code block, and all required blocks, are arranged in the order they appear in the markdown file.
+* Executed scripts can be saved. Saved scripts can be listed, selected, and executed.
 
-* The code is presented for approval prior to execution.
+* Output from executed scripts can be saved.
 
 ## Screenshots
 
 ### Select a file
+
 ![Select a file](/assets/select_a_file.png)
 
 ### Select a block
+
 ![Select a block](/assets/select_a_block.png)
 
 ### Approve code
+
 ![Approve code](/assets/approve_code.png)
 
 ### Output
+
 ![Output of execution](/assets/output_of_execution.png)
 
 ### Example blocks
+
 ![Example blocks](/assets/example_blocks.png)
 
 ## Installation
@@ -34,39 +39,111 @@ Install:
 
 ## Usage
 
-### `mde --help`
+### Help
+
+#### `mde --help`
+
 Displays help information.
 
-### `mde`
+### Basic
+
+#### `mde`
+
 Process `README.md` file in the current folder. Displays all the blocks in the file and allows you to select using [up], [down], and [return]. Press [ctrl]-c to abort selection.
 
-### `mde my.md` or `mde -f my.md`
+#### `mde my.md` or `mde -f my.md`
+
 Select a block to execute from `my.md`.
 
-### `mde .` or `mde -p .`
+#### `mde .` or `mde -p .`
 
 Select a markdown file in the current folder. Select a block to execute from that file.
 
-### `mde --list-blocks`
+### Report documents and blocks
+
+#### `mde --list-blocks`
+
 List all blocks in the all the markdown documents in the current folder.
 
-### `mde --list-docs`
+#### `mde --list-docs`
+
 List all markdown documents in the current folder.
 
+### Configuration
+
+#### `mde --list-default-env` or `mde --list-default-yaml`
+
+List default values that can be set in configuration file, environment, and command line.
+
+#### `mde -0`
+
+Show current configuation values that will be applied to the current run. Does not interrupt processing.
+
+### Save scripts
+
+#### `mde --save-executed-script 1`
+
+Save executed script in saved script folder.
+
+#### `mde --list-recent-scripts`
+
+List recent saved scripts in saved script folder.
+
+#### `mde --select-recent-script`
+
+Select and execute a recently saved script in saved script folder.
+
+### Save output
+
+#### `mde --save-execution-output 1`
+
+Save execution output in saved output folder.
+
 ## Behavior
+
 * If no file and no folder are specified, blocks within `./README.md` are presented.
 * If a file is specified, its blocks are presented.
 * If a folder is specified, its files are presented. When a file is selected, its blocks are presented.
 
 ## Configuration
-While starting up, reads the YAML configuration file `.mde.yml` in the current folder if it exists.
 
-e.g. Use to set the default file for the current folder.
+### Environment Variables
+
+When executed, `mde` reads the current environment.
+* Configuration in current and children shells, e.g. `export MDE_SAVE_EXECUTED_SCRIPT=1`.
+* Configuration for the current command, e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`.
+
+### Configuration Files
+
+* Configuration in all shells, e.g. environment variables set in your user's `~/.bashrc` or `~/.bash_profile` files.
+* Configuration in the optional file `.mde.yml` in the current folder. .e.g. `save_executed_script: true`
+* Configuration in a YAML file and read while parsing the inputs, e.g. `--config my_path/my_file.yml`
 
-* `filename: CHANGELOG.md` sets the file to open.
-* `folder: documents` sets the folder to search for default or specified files.
+### Program Arguments
+
+* Configuration in command options, e.g. `mde --save-executed-script 1`
+
+## Representing boolean values
+
+Boolean values expressed as strings are interpreted as:
+| String | Boolean |
+| :---: | :---: |
+| *empty string* | False |
+| `0` | False |
+| `1` | True |
+| *anything else* | True |
+
+E.g. `opt1=1` will set option `opt1` to True.
+
+Boolean options configured with environment variables:
+- Set to `1` or non-empty value to save executed scripts; empty or `0` to disable saving.
+  e.g. `export MDE_SAVE_EXECUTED_SCRIPT=1`
+  e.g. `export MDE_SAVE_EXECUTED_SCRIPT=`
+- Specify variable on command line.
+  e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`
 
 # Example blocks
+
 When prompted, select either the `awake` or `asleep` block.
 
 ``` :(day)
@@ -89,6 +166,17 @@ export ACTIVITY=asleep
 echo "$TIME -> $ACTIVITY"
 ```
 
+``` :missing_command
+fail
+```
+
+``` :exit_value
+echo "a"
+echo "b"
+echo "c" >>/dev/stderr
+grep nx Gemfile
+```
+
 # License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/markdown_exec/version.rb

@@ -2,7 +2,7 @@
 
 module MarkdownExec
   APP_NAME = 'MDE'
-  APP_DESC = 'Markdown block executor'
+  APP_DESC = 'Markdown Executor'
   GEM_NAME = 'markdown_exec'
-  VERSION = '0.2.3'
+  VERSION = '0.2.6'
 end

data/lib/markdown_exec.rb

@@ -14,21 +14,23 @@ require 'yaml'
 # else true
 
 def env_bool(name, default: false)
-  return default if (val = ENV[name]).nil?
+  return default if name.nil? || (val = ENV[name]).nil?
   return false if val.empty? || val == '0'
 
   true
 end
 
 def env_int(name, default: 0)
-  return default if (val = ENV[name]).nil?
+  return default if name.nil? || (val = ENV[name]).nil?
   return default if val.empty?
 
   val.to_i
 end
 
 def env_str(name, default: '')
-  ENV[name] || default
+  return default if name.nil? || (val = ENV[name]).nil?
+
+  val || default
 end
 
 $pdebug = env_bool 'MDE_DEBUG'
@@ -42,7 +44,12 @@ BLOCK_SIZE = 1024
 
 class Object # rubocop:disable Style/Documentation
   def present?
-    self && !blank?
+    case self.class.to_s
+    when 'FalseClass', 'TrueClass'
+      true
+    else
+      self && (!respond_to?(:blank?) || !blank?)
+    end
   end
 end
 
@@ -94,45 +101,28 @@ module MarkdownExec
     # options necessary to start, parse input, defaults for cli options
 
     def base_options
-      {
-        # commands
-        list_blocks: false, # command
-        list_docs: false, # command
-
-        # command options
-        filename: env_str('MDE_FILENAME', default: nil), # option Filename to open
-        output_execution_summary: env_bool('MDE_OUTPUT_EXECUTION_SUMMARY', default: false), # option
-        output_script: env_bool('MDE_OUTPUT_SCRIPT', default: false), # option
-        output_stdout: env_bool('MDE_OUTPUT_STDOUT', default: true), # option
-        path: env_str('MDE_PATH', default: nil), # option Folder to search for files
-        save_executed_script: env_bool('MDE_SAVE_EXECUTED_SCRIPT', default: false), # option
-        saved_script_folder: env_str('MDE_SAVED_SCRIPT_FOLDER', default: 'logs'), # option
-        user_must_approve: env_bool('MDE_USER_MUST_APPROVE', default: true), # option Pause for user to approve script
-
-        # configuration options
-        block_name_excluded_match: env_str('MDE_BLOCK_NAME_EXCLUDED_MATCH', default: '^\(.+\)$'),
-        block_name_match: env_str('MDE_BLOCK_NAME_MATCH', default: ':(?<title>\S+)( |$)'),
-        block_required_scan: env_str('MDE_BLOCK_REQUIRED_SCAN', default: '\+\S+'),
-        fenced_start_and_end_match: env_str('MDE_FENCED_START_AND_END_MATCH', default: '^`{3,}'),
-        fenced_start_ex_match: env_str('MDE_FENCED_START_EX_MATCH', default: '^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$'),
-        heading1_match: env_str('MDE_HEADING1_MATCH', default: '^# *(?<name>[^#]*?) *$'),
-        heading2_match: env_str('MDE_HEADING2_MATCH', default: '^## *(?<name>[^#]*?) *$'),
-        heading3_match: env_str('MDE_HEADING3_MATCH', default: '^### *(?<name>.+?) *$'),
-        md_filename_glob: env_str('MDE_MD_FILENAME_GLOB', default: '*.[Mm][Dd]'),
-        md_filename_match: env_str('MDE_MD_FILENAME_MATCH', default: '.+\\.md'),
-        mdheadings: true, # use headings (levels 1,2,3) in block lable
-        select_page_height: env_int('MDE_SELECT_PAGE_HEIGHT', default: 12)
-      }
+      menu_data
+        .map do |_long_name, _short_name, env_var, _arg_name, _description, opt_name, default, _proc1| # rubocop:disable Metrics/ParameterLists
+        next unless opt_name.present?
+
+        [opt_name, env_bool(env_var, default: value_for_hash(default))]
+      end.compact.to_h.merge(
+        {
+          mdheadings: true, # use headings (levels 1,2,3) in block lable
+          menu_with_exit: true
+        }
+      ).tap_inspect format: :yaml
     end
 
     def default_options
       {
         bash: true, # bash block parsing in get_block_summary()
         exclude_expect_blocks: true,
-        exclude_matching_block_names: true, # exclude hidden blocks
+        hide_blocks_by_name: true,
         output_saved_script_filename: false,
-        prompt_select_block: 'Choose a block:', # in select_and_approve_block()
-        prompt_select_md: 'Choose a file:', # in select_md_file()
+        prompt_approve_block: 'Process?',
+        prompt_select_block: 'Choose a block:',
+        prompt_select_md: 'Choose a file:',
         saved_script_filename: nil, # calculated
         struct: true # allow get_block_summary()
       }
@@ -149,7 +139,7 @@ module MarkdownExec
       display_command(opts, required_blocks) if opts[:output_script] || opts[:user_must_approve]
 
       allow = true
-      allow = @prompt.yes? 'Process?' if opts[:user_must_approve]
+      allow = @prompt.yes? opts[:prompt_approve_block] if opts[:user_must_approve]
       opts[:ir_approve] = allow
       selected = get_block_by_name blocks_in_file, opts[:block_name]
 
@@ -171,6 +161,7 @@ module MarkdownExec
     end
 
     def command_execute(opts, cmd2)
+      @execute_files = Hash.new([])
       @execute_options = opts
       @execute_started_at = Time.now.utc
       Open3.popen3(cmd2) do |stdin, stdout, stderr|
@@ -186,7 +177,6 @@ module MarkdownExec
             # readable = ready[0]
             # # writable = ready[1]
             # # exceptions = ready[2]
-            @execute_files = Hash.new([])
             ready.each.with_index do |readable, ind|
               readable.each do |f|
                 block = f.read_nonblock(BLOCK_SIZE)
@@ -203,9 +193,11 @@ module MarkdownExec
         @execute_completed_at = Time.now.utc
       end
     rescue Errno::ENOENT => e
+      # error triggered by missing command in script
       @execute_aborted_at = Time.now.utc
       @execute_error_message = e.message
       @execute_error = e
+      @execute_files[1] = e.message
       fout "Error ENOENT: #{e.inspect}"
     end
 
@@ -222,37 +214,60 @@ module MarkdownExec
       required_blocks.each { |cb| fout cb }
     end
 
-    def exec_block(options, block_name = '')
+    def exec_block(options, _block_name = '')
       options = default_options.merge options
       update_options options, over: false
 
       # document and block reports
       #
       files = list_files_per_options(options)
+      if @options[:list_blocks]
+        fout_list (files.map do |file|
+                     make_block_labels(filename: file, struct: true)
+                   end).flatten(1)
+        return
+      end
+
+      if @options[:list_default_yaml]
+        fout_list list_default_yaml
+        return
+      end
+
       if @options[:list_docs]
         fout_list files
         return
       end
 
-      if @options[:list_blocks]
-        fout_list (files.map do |file|
-                     make_block_labels(filename: file, struct: true)
-                   end).flatten(1)
+      if @options[:list_default_env]
+        fout_list list_default_env
+        return
+      end
+
+      if @options[:list_recent_scripts]
+        fout_list list_recent_scripts
+        return
+      end
+
+      if @options[:run_last_script]
+        run_last_script
+        return
+      end
+
+      if @options[:select_recent_script]
+        select_recent_script
         return
       end
 
       # process
       #
+      @options[:filename] = select_md_file(files)
       select_and_approve_block(
         bash: true,
-        block_name: block_name,
-        filename: select_md_file(files),
         struct: true
       )
-
       fout "saved_filespec: #{@execute_script_filespec}" if @options[:output_saved_script_filename]
-
-      output_execution_summary if @options[:output_execution_summary]
+      save_execution_output
+      output_execution_summary
     end
 
     # standard output; not for debug
@@ -351,14 +366,37 @@ module MarkdownExec
       blocks.tap_inspect
     end
 
+    def list_default_env
+      menu_data
+        .map do |_long_name, _short_name, env_var, _arg_name, description, _opt_name, default, _proc1| # rubocop:disable Metrics/ParameterLists
+        next unless env_var.present?
+
+        [
+          "#{env_var}=#{value_for_cli default}",
+          description.present? ? description : nil
+        ].compact.join('      # ')
+      end.compact.sort
+    end
+
+    def list_default_yaml
+      menu_data
+        .map do |_long_name, _short_name, _env_var, _arg_name, description, opt_name, default, _proc1| # rubocop:disable Metrics/ParameterLists
+        next unless opt_name.present? && default.present?
+
+        [
+          "#{opt_name}: #{value_for_yaml default}",
+          description.present? ? description : nil
+        ].compact.join('      # ')
+      end.compact.sort
+    end
+
     def list_files_per_options(options)
-      default_filename = 'README.md'
-      default_folder = '.'
-      if options[:filename]&.present?
-        list_files_specified(options[:filename], options[:path], default_filename, default_folder)
-      else
-        list_files_specified(nil, options[:path], default_filename, default_folder)
-      end.tap_inspect
+      list_files_specified(
+        options[:filename]&.present? ? options[:filename] : nil,
+        options[:path],
+        'README.md',
+        '.'
+      ).tap_inspect
     end
 
     def list_files_specified(specified_filename, specified_folder, default_filename, default_folder, filetree = nil)
@@ -394,7 +432,7 @@ module MarkdownExec
       opts = optsmerge call_options, options_block
       block_name_excluded_match = Regexp.new opts[:block_name_excluded_match]
       list_blocks_in_file(opts).map do |block|
-        next if opts[:exclude_matching_block_names] && block[:name].match(block_name_excluded_match)
+        next if opts[:hide_blocks_by_name] && block[:name].match(block_name_excluded_match)
 
         block
       end.compact.tap_inspect
@@ -413,6 +451,11 @@ module MarkdownExec
            .tap_inspect
     end
 
+    def list_recent_scripts
+      Dir.glob(File.join(@options[:saved_script_folder],
+                         @options[:saved_script_glob])).sort[0..(options[:list_count] - 1)].reverse.tap_inspect
+    end
+
     def make_block_label(block, call_options = {})
       opts = options.merge(call_options)
       if opts[:mdheadings]
@@ -426,21 +469,117 @@ module MarkdownExec
     def make_block_labels(call_options = {})
       opts = options.merge(call_options)
       list_blocks_in_file(opts).map do |block|
-        # next if opts[:exclude_matching_block_names] && block[:name].match(%r{^:\(.+\)$})
+        # next if opts[:hide_blocks_by_name] && block[:name].match(%r{^:\(.+\)$})
 
         make_block_label block, opts
       end.compact.tap_inspect
     end
 
+    def menu_data
+      val_as_bool = ->(value) { value.to_i != 0 }
+      val_as_int = ->(value) { value.to_i }
+      val_as_str = ->(value) { value.to_s }
+      val_true = ->(_) { true }
+
+      summary_head = [
+        ['config', nil, nil, 'PATH', 'Read configuration file', nil, '.', lambda { |value|
+                                                                            read_configuration_file! options, value
+                                                                          }],
+        ['debug', 'd', 'MDE_DEBUG', 'BOOL', 'Debug output', nil, false, ->(value) { $pdebug = value.to_i != 0 }]
+      ]
+
+      # rubocop:disable Layout/LineLength
+      summary_body = [
+        ['filename', 'f', 'MDE_FILENAME', 'RELATIVE', 'Name of document', :filename, nil, val_as_str],
+        ['list-blocks', nil, nil, nil, 'List blocks', :list_blocks, nil, val_true],
+        ['list-count', nil, 'MDE_LIST_COUNT', 'NUM', 'Max. items to return in list', :list_count, 16, val_as_int],
+        ['list-default-env', nil, nil, nil, 'List default configuration as environment variables', :list_default_env, nil, val_true],
+        ['list-default-yaml', nil, nil, nil, 'List default configuration as YAML', :list_default_yaml, nil, val_true],
+        ['list-docs', nil, nil, nil, 'List docs in current folder', :list_docs, nil, val_true],
+        ['list-recent-scripts', nil, nil, nil, 'List recent saved scripts', :list_recent_scripts, nil, val_true],
+        ['logged-stdout-filename-prefix', nil, 'MDE_LOGGED_STDOUT_FILENAME_PREFIX', 'NAME', 'Name prefix for stdout files', :logged_stdout_filename_prefix, 'mde', val_as_str],
+        ['output-execution-summary', nil, 'MDE_OUTPUT_EXECUTION_SUMMARY', 'BOOL', 'Display summary for execution', :output_execution_summary, false, val_as_bool],
+        ['output-script', nil, 'MDE_OUTPUT_SCRIPT', 'BOOL', 'Display script prior to execution', :output_script, false, val_as_bool],
+        ['output-stdout', nil, 'MDE_OUTPUT_STDOUT', 'BOOL', 'Display standard output from execution', :output_stdout, true, val_as_bool],
+        ['path', 'p', 'MDE_PATH', 'PATH', 'Path to documents', :path, nil, val_as_str],
+        ['run-last-script', nil, nil, nil, 'Run most recently saved script', :run_last_script, nil, val_true],
+        ['select-recent-script', nil, nil, nil, 'Select and execute a recently saved script', :select_recent_script, nil, val_true],
+        ['save-executed-script', nil, 'MDE_SAVE_EXECUTED_SCRIPT', 'BOOL', 'Save executed script', :save_executed_script, false, val_as_bool],
+        ['save-execution-output', nil, 'MDE_SAVE_EXECUTION_OUTPUT', 'BOOL', 'Save standard output of the executed script', :save_execution_output, false, val_as_bool],
+        ['saved-script-filename-prefix', nil, 'MDE_SAVED_SCRIPT_FILENAME_PREFIX', 'NAME', 'Name prefix for saved scripts', :saved_script_filename_prefix, 'mde', val_as_str],
+        ['saved-script-folder', nil, 'MDE_SAVED_SCRIPT_FOLDER', 'SPEC', 'Saved script folder', :saved_script_folder, 'logs', val_as_str],
+        ['saved-script-glob', nil, 'MDE_SAVED_SCRIPT_GLOB', 'SPEC', 'Glob matching saved scripts', :saved_script_glob, 'mde_*.sh', val_as_str],
+        ['saved-stdout-folder', nil, 'MDE_SAVED_STDOUT_FOLDER', 'SPEC', 'Saved stdout folder', :saved_stdout_folder, 'logs', val_as_str],
+        ['user-must-approve', nil, 'MDE_USER_MUST_APPROVE', 'BOOL', 'Pause for user to approve script', :user_must_approve, true, val_as_bool]
+      ]
+      # rubocop:enable Layout/LineLength
+
+      # rubocop:disable Style/Semicolon
+      summary_tail = [
+        [nil, '0', nil, nil, 'Show current configuration values',
+         nil, nil, ->(_) { options_finalize options; fout sorted_keys(options).to_yaml }],
+        ['help', 'h', nil, nil, 'App help',
+         nil, nil, ->(_) { fout menu_help; exit }],
+        ['version', 'v', nil, nil, 'App version',
+         nil, nil, ->(_) { fout MarkdownExec::VERSION; exit }],
+        ['exit', 'x', nil, nil, 'Exit app',
+         nil, nil, ->(_) { exit }]
+      ]
+      # rubocop:enable Style/Semicolon
+
+      env_vars = [
+        [nil, nil, 'MDE_BLOCK_NAME_EXCLUDED_MATCH', nil, 'Pattern for blocks to hide from user-selection',
+         :block_name_excluded_match, '^\(.+\)$', nil],
+        [nil, nil, 'MDE_BLOCK_NAME_MATCH', nil, '', :block_name_match, ':(?<title>\S+)( |$)', nil],
+        [nil, nil, 'MDE_BLOCK_REQUIRED_SCAN', nil, '', :block_required_scan, '\+\S+', nil],
+        [nil, nil, 'MDE_FENCED_START_AND_END_MATCH', nil, '', :fenced_start_and_end_match, '^`{3,}', nil],
+        [nil, nil, 'MDE_FENCED_START_EX_MATCH', nil, '', :fenced_start_ex_match,
+         '^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$', nil],
+        [nil, nil, 'MDE_HEADING1_MATCH', nil, '', :heading1_match, '^# *(?<name>[^#]*?) *$', nil],
+        [nil, nil, 'MDE_HEADING2_MATCH', nil, '', :heading2_match, '^## *(?<name>[^#]*?) *$', nil],
+        [nil, nil, 'MDE_HEADING3_MATCH', nil, '', :heading3_match, '^### *(?<name>.+?) *$', nil],
+        [nil, nil, 'MDE_MD_FILENAME_GLOB', nil, '', :md_filename_glob, '*.[Mm][Dd]', nil],
+        [nil, nil, 'MDE_MD_FILENAME_MATCH', nil, '', :md_filename_match, '.+\\.md', nil],
+        [nil, nil, 'MDE_SELECT_PAGE_HEIGHT', nil, '', :select_page_height, 12, nil]
+        # [nil, nil, 'MDE_', nil, '', nil, '', nil],
+      ]
+
+      summary_head + summary_body + summary_tail + env_vars
+    end
+
+    def menu_help
+      @option_parser.help
+    end
+
     def option_exclude_blocks(opts, blocks)
       block_name_excluded_match = Regexp.new opts[:block_name_excluded_match]
-      if opts[:exclude_matching_block_names]
+      if opts[:hide_blocks_by_name]
         blocks.reject { |block| block[:name].match(block_name_excluded_match) }
       else
         blocks
       end
     end
 
+    ## post-parse options configuration
+    #
+    def options_finalize(rest)
+      ## position 0: file or folder (optional)
+      #
+      if (pos = rest.fetch(0, nil))&.present?
+        if Dir.exist?(pos)
+          @options[:path] = pos
+        elsif File.exist?(pos)
+          @options[:filename] = pos
+        else
+          raise "Invalid parameter: #{pos}"
+        end
+      end
+
+      ## position 1: block name (optional)
+      #
+      @options[:block_name] = rest.fetch(1, nil)
+    end
+
     def optsmerge(call_options = {}, options_block = nil)
       class_call_options = @options.merge(call_options || {})
       if options_block
@@ -451,6 +590,8 @@ module MarkdownExec
     end
 
     def output_execution_summary
+      return unless @options[:output_execution_summary]
+
       fout_section 'summary', {
         execute_aborted_at: @execute_aborted_at,
         execute_completed_at: @execute_completed_at,
@@ -463,6 +604,14 @@ module MarkdownExec
       }
     end
 
+    def prompt_with_quit(prompt_text, items, opts = {})
+      exit_option = '* Exit'
+      sel = @prompt.select prompt_text,
+                           items + (@options[:menu_with_exit] ? [exit_option] : []),
+                           opts
+      sel == exit_option ? nil : sel
+    end
+
     def read_configuration_file!(options, configuration_path)
       return unless File.exist?(configuration_path)
 
@@ -494,19 +643,11 @@ module MarkdownExec
       #
       @options = base_options
 
-      ## post-parse options configuration
-      #
-      options_finalize = ->(_options) {}
-
-      proc_self = ->(value) { value }
-      proc_to_i = ->(value) { value.to_i != 0 }
-      proc_true = ->(_) { true }
-
-      # read local configuration file
+      ## read local configuration file
       #
       read_configuration_file! @options, ".#{MarkdownExec::APP_NAME.downcase}.yml"
 
-      option_parser = OptionParser.new do |opts|
+      @option_parser = option_parser = OptionParser.new do |opts|
         executable_name = File.basename($PROGRAM_NAME)
         opts.banner = [
           "#{MarkdownExec::APP_NAME}" \
@@ -514,55 +655,16 @@ module MarkdownExec
           "Usage: #{executable_name} [path] [filename] [options]"
         ].join("\n")
 
-        summary_head = [
-          ['config', nil, nil, 'PATH', 'Read configuration file',
-           nil, ->(value) { read_configuration_file! options, value }],
-          ['debug', 'd', 'MDE_DEBUG', 'BOOL', 'Debug output',
-           nil, ->(value) { $pdebug = value.to_i != 0 }]
-        ]
-
-        summary_body = [
-          ['filename', 'f', 'MDE_FILENAME', 'RELATIVE', 'Name of document',
-           :filename, proc_self],
-          ['list-blocks', nil, nil, nil, 'List blocks',
-           :list_blocks, proc_true],
-          ['list-docs', nil, nil, nil, 'List docs in current folder',
-           :list_docs, proc_true],
-          ['output-execution-summary', nil, 'MDE_OUTPUT_EXECUTION_SUMMARY', 'BOOL', 'Display summary for execution',
-           :output_execution_summary, proc_to_i],
-          ['output-script', nil, 'MDE_OUTPUT_SCRIPT', 'BOOL', 'Display script',
-           :output_script, proc_to_i],
-          ['output-stdout', nil, 'MDE_OUTPUT_STDOUT', 'BOOL', 'Display standard output from execution',
-           :output_stdout, proc_to_i],
-          ['path', 'p', 'MDE_PATH', 'PATH', 'Path to documents',
-           :path, proc_self],
-          ['save-executed-script', nil, 'MDE_SAVE_EXECUTED_SCRIPT', 'BOOL', 'Save executed script',
-           :save_executed_script, proc_to_i],
-          ['saved-script-folder', nil, 'MDE_SAVED_SCRIPT_FOLDER', 'SPEC', 'Saved script folder',
-           :saved_script_folder, proc_self],
-          ['user-must-approve', nil, 'MDE_USER_MUST_APPROVE', 'BOOL', 'Pause to approve execution',
-           :user_must_approve, proc_to_i]
-        ]
-
-        # rubocop:disable Style/Semicolon
-        summary_tail = [
-          [nil, '0', nil, nil, 'Show configuration',
-           nil, ->(_) { options_finalize.call options; fout options.to_yaml }],
-          ['help', 'h', nil, nil, 'App help',
-           nil, ->(_) { fout option_parser.help; exit }],
-          ['version', 'v', nil, nil, 'App version',
-           nil, ->(_) { fout MarkdownExec::VERSION; exit }],
-          ['exit', 'x', nil, nil, 'Exit app',
-           nil, ->(_) { exit }]
-        ]
-        # rubocop:enable Style/Semicolon
-
-        (summary_head + summary_body + summary_tail)
-          .map do |long_name, short_name, env_var, arg_name, description, opt_name, proc1| # rubocop:disable Metrics/ParameterLists
-          opts.on(*[long_name.present? ? "--#{long_name}#{arg_name.present? ? (' ' + arg_name) : ''}" : nil,
+        menu_data
+          .map do |long_name, short_name, _env_var, arg_name, description, opt_name, default, proc1| # rubocop:disable Metrics/ParameterLists
+          next unless long_name.present? || short_name.present?
+
+          opts.on(*[if long_name.present?
+                      "--#{long_name}#{arg_name.present? ? " #{arg_name}" : ''}"
+                    end,
                     short_name.present? ? "-#{short_name}" : nil,
                     [description,
-                     env_var.present? ? "env: #{env_var}" : nil].compact.join(' - '),
+                     default.present? ? "[#{value_for_cli default}]" : nil].compact.join('  '),
                     lambda { |value|
                       ret = proc1.call(value)
                       options[opt_name] = ret if opt_name
@@ -574,27 +676,43 @@ module MarkdownExec
       option_parser.environment # env defaults to the basename of the program.
       rest = option_parser.parse! # (into: options)
 
-      ## finalize configuration
-      #
-      options_finalize.call options
+      options_finalize rest
 
-      ## position 0: file or folder (optional)
-      #
-      if (pos = rest.fetch(0, nil))&.present?
-        if Dir.exist?(pos)
-          options[:path] = pos
-        elsif File.exist?(pos)
-          options[:filename] = pos
-        else
-          raise "Invalid parameter: #{pos}"
-        end
-      end
+      exec_block options, options[:block_name]
+    end
 
-      ## position 1: block name (optional)
-      #
-      block_name = rest.fetch(1, nil)
+    def run_last_script
+      filename = Dir.glob(File.join(@options[:saved_script_folder],
+                                    @options[:saved_script_glob])).sort[0..(options[:list_count] - 1)].last
+      filename.tap_inspect name: filename
+      mf = filename.match(/#{@options[:saved_script_filename_prefix]}_(?<time>[0-9\-]+)_(?<file>.+)_(?<block>.+)\.sh/)
 
-      exec_block options, block_name
+      @options[:block_name] = mf[:block]
+      @options[:filename] = "#{mf[:file]}.md" ### other extensions
+      @options[:save_executed_script] = false
+      select_and_approve_block
+      save_execution_output
+      output_execution_summary
+    end
+
+    def save_execution_output
+      return unless @options[:save_execution_output]
+
+      fne = File.basename(@options[:filename], '.*')
+      @options[:logged_stdout_filename] =
+        "#{[@options[:logged_stdout_filename_prefix], Time.now.utc.strftime('%F-%H-%M-%S'), fne,
+            @options[:block_name]].join('_')}.out.txt"
+      @options[:logged_stdout_filespec] = File.join @options[:saved_stdout_folder], @options[:logged_stdout_filename]
+      @logged_stdout_filespec = @options[:logged_stdout_filespec]
+      dirname = File.dirname(@options[:logged_stdout_filespec])
+      Dir.mkdir dirname unless File.exist?(dirname)
+      File.write(@options[:logged_stdout_filespec], @execute_files&.fetch(0, ''))
+      # @options[:logged_stderr_filename] =
+      #   "#{[@options[:logged_stdout_filename_prefix], Time.now.utc.strftime('%F-%H-%M-%S'), fne,
+      #       @options[:block_name]].join('_')}.err.txt"
+      # @options[:logged_stderr_filespec] = File.join @options[:saved_stdout_folder], @options[:logged_stderr_filename]
+      # @logged_stderr_filespec = @options[:logged_stderr_filespec]
+      # File.write(@options[:logged_stderr_filespec], @execute_files&.fetch(1, ''))
     end
 
     def select_and_approve_block(call_options = {}, &options_block)
@@ -608,9 +726,11 @@ module MarkdownExec
 
         return nil if block_labels.count.zero?
 
-        sel = @prompt.select(pt, block_labels, per_page: opts[:select_page_height])
+        sel = prompt_with_quit pt, block_labels, per_page: opts[:select_page_height]
+        return nil if sel.nil?
+
         label_block = blocks_in_file.select { |block| block[:label] == sel }.fetch(0, nil)
-        opts[:block_name] = label_block[:name]
+        opts[:block_name] = @options[:block_name] = label_block[:name]
       end
 
       approve_block opts, blocks_in_file
@@ -622,10 +742,32 @@ module MarkdownExec
       if files.count == 1
         files[0]
       elsif files.count >= 2
-        @prompt.select(opts[:prompt_select_md].to_s, files, per_page: opts[:select_page_height])
+        prompt_with_quit opts[:prompt_select_md].to_s, files, per_page: opts[:select_page_height]
       end
     end
 
+    def select_recent_script
+      filename = prompt_with_quit @options[:prompt_select_md].to_s, list_recent_scripts,
+                                  per_page: @options[:select_page_height]
+      return if filename.nil?
+
+      mf = filename.match(/#{@options[:saved_script_filename_prefix]}_(?<time>[0-9\-]+)_(?<file>.+)_(?<block>.+)\.sh/)
+
+      @options[:block_name] = mf[:block]
+      @options[:filename] = "#{mf[:file]}.md" ### other extensions
+      select_and_approve_block(
+        bash: true,
+        save_executed_script: false,
+        struct: true
+      )
+      save_execution_output
+      output_execution_summary
+    end
+
+    def sorted_keys(hash1)
+      hash1.keys.sort.to_h { |k| [k, hash1[k]] }
+    end
+
     def summarize_block(headings, title)
       { headings: headings, name: title, title: title }
     end
@@ -636,16 +778,57 @@ module MarkdownExec
       else
         @options.merge! opts
       end
-      @options
+      @options.tap_inspect format: :yaml
     end
 
-    def write_command_file(opts, required_blocks)
-      return unless opts[:saved_script_filename].present?
+    def value_for_cli(value)
+      case value.class.to_s
+      when 'String'
+        "'#{value}'"
+      when 'FalseClass', 'TrueClass'
+        value ? '1' : '0'
+      when 'Integer'
+        value
+      else
+        value.to_s
+      end
+    end
+
+    def value_for_hash(value, default = nil)
+      return default if value.nil?
 
-      fne = File.basename(opts[:filename], '.*').gsub(/[^a-z0-9]/i, '-') # scan(/[a-z0-9]/i).join
-      bne = opts[:block_name].gsub(/[^a-z0-9]/i, '-') # scan(/[a-z0-9]/i).join
-      opts[:saved_script_filename] = "mde_#{Time.now.utc.strftime '%F-%H-%M-%S'}_#{fne}_#{bne}.sh"
+      case value.class.to_s
+      when 'String', 'Integer', 'FalseClass', 'TrueClass'
+        value
+      when value.empty?
+        default
+      else
+        value.to_s
+      end
+    end
 
+    def value_for_yaml(value)
+      return default if value.nil?
+
+      case value.class.to_s
+      when 'String'
+        "'#{value}'"
+      when 'Integer'
+        value
+      when 'FalseClass', 'TrueClass'
+        value ? true : false
+      when value.empty?
+        default
+      else
+        value.to_s
+      end
+    end
+
+    def write_command_file(opts, required_blocks)
+      fne = File.basename(opts[:filename], '.*')
+      opts[:saved_script_filename] =
+        "#{[opts[:saved_script_filename_prefix], Time.now.utc.strftime('%F-%H-%M-%S'), fne,
+            opts[:block_name]].join('_')}.sh"
       @options[:saved_filespec] = File.join opts[:saved_script_folder], opts[:saved_script_filename]
       @execute_script_filespec = @options[:saved_filespec]
       dirname = File.dirname(@options[:saved_filespec])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -67,7 +67,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0
 description: Interactively select and execute fenced code blocks in markdown files.
-  Build complex scripts by naming and requiring blocks.
+  Build complex scripts by naming and requiring blocks. Log resulting scripts and
+  output. Re-run scripts.
 email:
 - fareed@phomento.com
 executables:
@@ -127,5 +128,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Execute shell blocks in markdown files.
+summary: Interactively select and execute fenced code blocks in markdown files.
 test_files: []