markdown_exec 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2336bb2091df5bf018181e832fb9c5e7a5b7ee542b6f71cde38a3afb3aa88ab4
-  data.tar.gz: '072654942ddf5897784c71724a7f9fa6fb5bea9b395d54ca18a3f3fd9b02c5af'
+  metadata.gz: 95d097cfcf93e09ba3bf487989923d4be03dd9fde0521854ea0660850b157d01
+  data.tar.gz: 22bc0e8bc8cd35d0d1dd52b6275c1609fb4cb95d69bd125064f0ca16f2f931f7
 SHA512:
-  metadata.gz: 2f28a18aea943a7fec92b16d232b8c3722a30f6960fbd32bf84e95762b4ac322f0fb53f75563118a15136da72e49f16c580a8c7fbf05d2001857e068403834ef
-  data.tar.gz: 8bb762715d790e37906d61cf8834e86dfe7e4f9611b8f7477da508d2ff658d496c6e1e0c89fc42e9e5f2cf937e29dae3cddf062cabda867f3a5bb1466986f2c3
+  metadata.gz: 591c09a221c0f5a34f8523d99d8e416bb022219fee38a7a05e3541600b03132e5ae3cc6aee02048eda2170a408d9e86090dedadff7c16f1f79ea98469826c27a
+  data.tar.gz: 74a76b6a6b10b165f8e79e59d25db78bcba173d730fd1a696e73c2012794bcfedd7c1b648cabe6b15d4d0a70995e5303b02c58d0b16c35a03ffbfea0b4efc5f4

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## [ToDo]
+
+- pipe stdin to script
+- yes/no/write/clipboard/record/edit/history
+- present timestamp, result of last exec for each command
+- user settings
+- hidden w , w/o () in names
+- fix regexp in pathnames
+- tab completion from md file
+- read file once to allow for tempdoc stream
+- include md or blocks file
+
+- tree display
+
+- mde options in md file or included file
+
+- include blocks from local md file
+
+- chmod a+x logged script
+
+- add shebang to saved script
+
+## [0.2.5] - 2022-04
+
+### 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
+
+- Composition of menu to facilitate reports.
+- List default values in menu help.
 
 ## [0.2.4] - 2022-04-01
 
@@ -11,7 +45,7 @@
 
 | YAML Name | Environment Variable | Option Name | Default | Purpose |
 | :--- | :--- | :--- | :--- | :--- |
-| list_count | MDE_LIST_COUNT | `--list_count` | `16` | Max. items to return in list |
+| 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 |

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (0.2.4)
+    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.4'
+  VERSION = '0.2.5'
 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,44 +101,17 @@ module MarkdownExec
     # options necessary to start, parse input, defaults for cli options
 
     def base_options
-      {
-        # commands
-        list_blocks: false, # command
-        list_docs: false, # command
-        list_recent_scripts: false, # command
-        run_last_script: false, # command
-        select_recent_script: false, # command
-
-        # command options
-        filename: env_str('MDE_FILENAME', default: nil), # option Filename to open
-        list_count: 16,
-        logged_stdout_filename_prefix: 'mde',
-        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
-        save_execution_output: env_bool('MDE_SAVE_EXECUTION_OUTPUT', default: false), # option
-        saved_script_filename_prefix: 'mde',
-        saved_script_folder: env_str('MDE_SAVED_SCRIPT_FOLDER', default: 'logs'), # option
-        saved_script_glob: 'mde_*.sh',
-        saved_stdout_folder: env_str('MDE_SAVED_STDOUT_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
@@ -248,11 +228,21 @@ module MarkdownExec
         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_default_env]
+        fout_list list_default_env
+        return
+      end
+
       if @options[:list_recent_scripts]
         fout_list list_recent_scripts
         return
@@ -376,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)
@@ -462,6 +475,92 @@ module MarkdownExec
       end.compact.tap_inspect
     end
 
+    def menu_data
+      proc_self = ->(value) { value }
+      proc_to_i = ->(value) { value.to_i != 0 }
+      proc_true = ->(_) { true }
+
+      summary_head = [
+        ['config', nil, nil, 'PATH', 'Read configuration file',
+         nil, '.', ->(value) { read_configuration_file! options, value }],
+        ['debug', 'd', 'MDE_DEBUG', 'BOOL', 'Debug output',
+         nil, false, ->(value) { $pdebug = value.to_i != 0 }]
+      ]
+
+      summary_body = [
+        ['filename', 'f', 'MDE_FILENAME', 'RELATIVE', 'Name of document',
+         :filename, nil, proc_self],
+        ['list-blocks', nil, nil, nil, 'List blocks',
+         :list_blocks, nil, proc_true],
+        ['list-default-env', nil, nil, nil, 'List default configuration as environment variables',
+         :list_default_env, nil, proc_true],
+        ['list-default-yaml', nil, nil, nil, 'List default configuration as YAML',
+         :list_default_yaml, nil, proc_true],
+        ['list-docs', nil, nil, nil, 'List docs in current folder',
+         :list_docs, nil, proc_true],
+        ['list-recent-scripts', nil, nil, nil, 'List recent saved scripts',
+         :list_recent_scripts, nil, proc_true],
+        ['output-execution-summary', nil, 'MDE_OUTPUT_EXECUTION_SUMMARY', 'BOOL', 'Display summary for execution',
+         :output_execution_summary, false, proc_to_i],
+        ['output-script', nil, 'MDE_OUTPUT_SCRIPT', 'BOOL', 'Display script prior to execution',
+         :output_script, false, proc_to_i],
+        ['output-stdout', nil, 'MDE_OUTPUT_STDOUT', 'BOOL', 'Display standard output from execution',
+         :output_stdout, true, proc_to_i],
+        ['path', 'p', 'MDE_PATH', 'PATH', 'Path to documents',
+         :path, nil, proc_self],
+        ['run-last-script', nil, nil, nil, 'Run most recently saved script',
+         :run_last_script, nil, proc_true],
+        ['select-recent-script', nil, nil, nil, 'Select and execute a recently saved script',
+         :select_recent_script, nil, proc_true],
+        ['save-execution-output', nil, 'MDE_SAVE_EXECUTION_OUTPUT', 'BOOL', 'Save execution output',
+         :save_execution_output, false, proc_to_i],
+        ['save-executed-script', nil, 'MDE_SAVE_EXECUTED_SCRIPT', 'BOOL', 'Save executed script',
+         :save_executed_script, false, proc_to_i],
+        ['saved-script-folder', nil, 'MDE_SAVED_SCRIPT_FOLDER', 'SPEC', 'Saved script folder',
+         :saved_script_folder, 'logs', proc_self],
+        ['saved-stdout-folder', nil, 'MDE_SAVED_STDOUT_FOLDER', 'SPEC', 'Saved stdout folder',
+         :saved_stdout_folder, 'logs', proc_self],
+        ['user-must-approve', nil, 'MDE_USER_MUST_APPROVE', 'BOOL', 'Pause for user to approve script',
+         :user_must_approve, true, proc_to_i]
+      ]
+
+      # 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[:hide_blocks_by_name]
@@ -471,6 +570,26 @@ module MarkdownExec
       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
@@ -495,6 +614,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)
 
@@ -526,19 +653,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}" \
@@ -546,67 +665,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],
-          ['list-recent-scripts', nil, nil, nil, 'List recent saved scripts',
-           :list_recent_scripts, 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],
-          ['run-last-script', nil, nil, nil, 'Run most recently saved script',
-           :run_last_script, proc_true],
-          ['select-recent-script', nil, nil, nil, 'Select and execute a recently saved script',
-           :select_recent_script, proc_true],
-          ['save-execution-output', nil, 'MDE_SAVE_EXECUTION_OUTPUT', 'BOOL', 'Save execution output',
-           :save_execution_output, proc_to_i],
-          ['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],
-          ['saved-stdout-folder', nil, 'MDE_SAVED_STDOUT_FOLDER', 'SPEC', 'Saved stdout folder',
-           :saved_stdout_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 sorted_keys(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
+        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
@@ -618,27 +686,9 @@ 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
-
-      ## 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
+      options_finalize rest
 
-      ## position 1: block name (optional)
-      #
-      block_name = rest.fetch(1, nil)
-
-      exec_block options, block_name
+      exec_block options, options[:block_name]
     end
 
     def run_last_script
@@ -667,6 +717,12 @@ module MarkdownExec
       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)
@@ -680,7 +736,9 @@ 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] = @options[:block_name] = label_block[:name]
       end
@@ -694,13 +752,15 @@ 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.select @options[:prompt_select_md].to_s, list_recent_scripts,
-                                per_page: @options[:select_page_height]
+      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]
@@ -728,7 +788,50 @@ module MarkdownExec
       else
         @options.merge! opts
       end
-      @options
+      @options.tap_inspect format: :yaml
+    end
+
+    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?
+
+      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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-04-04 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: []