markdown_exec 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2336bb2091df5bf018181e832fb9c5e7a5b7ee542b6f71cde38a3afb3aa88ab4
-  data.tar.gz: '072654942ddf5897784c71724a7f9fa6fb5bea9b395d54ca18a3f3fd9b02c5af'
+  metadata.gz: 9b40d575297112f5a4bb934475b84251aeeab8f43de5dae963c8d3b1711c3edc
+  data.tar.gz: 9e3d3273dc3e3a0deb326fe30e3ff70b15e73f4fd9cea06c42f099f184903fad
 SHA512:
-  metadata.gz: 2f28a18aea943a7fec92b16d232b8c3722a30f6960fbd32bf84e95762b4ac322f0fb53f75563118a15136da72e49f16c580a8c7fbf05d2001857e068403834ef
-  data.tar.gz: 8bb762715d790e37906d61cf8834e86dfe7e4f9611b8f7477da508d2ff658d496c6e1e0c89fc42e9e5f2cf937e29dae3cddf062cabda867f3a5bb1466986f2c3
+  metadata.gz: 65654b5af78419591c41e3b50e0697b503ddf429c83312311335dd1b16d0d645c98b4e0c19d6c69446c42823861ca8f384788aeb4c1b5664804e4feecc39a45a
+  data.tar.gz: 866360b40733e8925c173582f3c59799e241bf48f52faffa4bfb03cd4c1a11c93f5b27305344b01c4b44a1518ef1c49961c7fbfbdb713638ed8261c8d87401c0

data/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Changelog
 
+## [ToDo]
+
+- pipe stdin to script
+- 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
+
+- yes/no/write/clipboard/record/edit/history
+
+- list, view saved output
+
+## [1.0.0] - 2022-04-26
+
+### Added
+
+- Command `--pwd` to print the gem's home folder.
+- Command `--select-recent-output` to select and open a recent output log file.
+e.g. `MDE_OUTPUT_VIEWER_OPTIONS="-a '/Applications/Sublime Text.app'" mde --select-recent-output`
+- Command `--tab-completions` to list the application options.
+- Tab completion script for Bash shell.
+
+### Changed
+
+- File names for saved scripts.
+- Hide blocks with empty names, e.g. `:()`.
+
+## [0.2.6] - 2022-04-07
+
+### Changed
+
+- Default values for command line options.
+
+## [0.2.5] - 2022-04-03
+
+### 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 +69,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 (1.0.0)
       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,135 @@ 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 my.md myblock`
+
+Execute the block named `myblock` from `my.md`.
+
+#### `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`
+
+### 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`
+
+## Tab Completion
+
+### Install tab completion
+
+Append a command to load the completion script to your shell configuration file:
+
+```bash :()
+echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
+```
+
+### Example Completions
+
+Type tab at end of any of the following commands to see the options.
+- `mde `
+- `mde -`
+- `mde --`
+- `mde --o`
+- `mde --filename my.md -`
+- `mde --filename my.md --`
 
-* `filename: CHANGELOG.md` sets the file to open.
-* `folder: documents` sets the folder to search for default or specified files.
+## Example Blocks
 
-# Example blocks
 When prompted, select either the `awake` or `asleep` block.
 
 ``` :(day)

data/bin/tab_completion.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+__filedirs()
+{
+  local IFS=$'\n'
+  COMPREPLY=( $(compgen -o plusdirs -f -- "${cur}") )
+}
+
+_mde() {
+  local cur prev opts
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  opts="$(mde --tab-completions)"
+
+  if [[ ${cur} == -* ]] ; then
+    COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
+    return 0
+  fi
+
+  __filedirs
+}
+
+complete -o filenames -F _mde mde

data/fixtures/exclude2.md

@@ -7,3 +7,6 @@ b
 ``` :three
 c
 ```
+``` :()
+d
+```

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 = '1.0.0'
 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
 
@@ -60,16 +67,13 @@ public
 def tap_inspect(format: nil, name: 'return')
   return self unless $pdebug
 
-  fn = case format
-       when :json
-         :to_json
-       when :string
-         :to_s
-       when :yaml
-         :to_yaml
-       else
-         :inspect
-       end
+  cvt = {
+    json: :to_json,
+    string: :to_s,
+    yaml: :to_yaml,
+    else: :inspect
+  }
+  fn = cvt.fetch(format, cvt[:else])
 
   puts "-> #{caller[0].scan(/in `?(\S+)'$/)[0][0]}()" \
        " #{name}: #{method(fn).call}"
@@ -94,44 +98,18 @@ 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?
+
+        value = env_str(env_var, default: value_for_hash(default))
+        [opt_name, proc1 ? proc1.call(value) : value]
+      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
@@ -143,6 +121,7 @@ module MarkdownExec
         prompt_approve_block: 'Process?',
         prompt_select_block: 'Choose a block:',
         prompt_select_md: 'Choose a file:',
+        prompt_select_output: 'Choose a file:',
         saved_script_filename: nil, # calculated
         struct: true # allow get_block_summary()
       }
@@ -164,8 +143,10 @@ module MarkdownExec
       selected = get_block_by_name blocks_in_file, opts[:block_name]
 
       if opts[:ir_approve]
-        write_command_file(opts, required_blocks) if opts[:save_executed_script]
+        write_command_file opts, required_blocks
         command_execute opts, required_blocks.flatten.join("\n")
+        save_execution_output
+        output_execution_summary
       end
 
       selected[:name]
@@ -241,31 +222,30 @@ module MarkdownExec
       # 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_docs]
-        fout_list files
-        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
+      simple_commands = {
+        doc_glob: -> { fout options[:md_filename_glob] },
+        list_blocks: lambda do
+                       fout_list (files.map do |file|
+                                    make_block_labels(filename: file, struct: true)
+                                  end).flatten(1)
+                     end,
+        list_default_yaml: -> { fout_list list_default_yaml },
+        list_docs: -> { fout_list files },
+        list_default_env: -> { fout_list list_default_env },
+        list_recent_output: -> { fout_list list_recent_output },
+        list_recent_scripts: -> { fout_list list_recent_scripts },
+        pwd: -> { fout File.expand_path('..', __dir__) },
+        run_last_script: -> { run_last_script },
+        select_recent_output: -> { select_recent_output },
+        select_recent_script: -> { select_recent_script },
+        tab_completions: -> { fout tab_completions }
+      }
+      simple_commands.each_key do |key|
+        if @options[key]
+          simple_commands[key].call
+          return # rubocop:disable Lint/NonLocalExitFromIterator
+        end
       end
 
       # process
@@ -276,8 +256,6 @@ module MarkdownExec
         struct: true
       )
       fout "saved_filespec: #{@execute_script_filespec}" if @options[:output_saved_script_filename]
-      save_execution_output
-      output_execution_summary
     end
 
     # standard output; not for debug
@@ -322,6 +300,11 @@ module MarkdownExec
         exit 1
       end
 
+      unless File.exist? opts[:filename]
+        fout 'Document is missing.'
+        exit 1
+      end
+
       fenced_start_and_end_match = Regexp.new opts[:fenced_start_and_end_match]
       fenced_start_ex = Regexp.new opts[:fenced_start_ex_match]
       block_title = ''
@@ -376,14 +359,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)
@@ -438,9 +444,28 @@ module MarkdownExec
            .tap_inspect
     end
 
+    def most_recent(arr)
+      return unless arr
+      return if arr.count < 1
+
+      arr.max.tap_inspect
+    end
+
+    def most_recent_list(arr)
+      return unless arr
+      return if (ac = arr.count) < 1
+
+      arr.sort[-[ac, options[:list_count]].min..].reverse.tap_inspect
+    end
+
+    def list_recent_output
+      most_recent_list(Dir.glob(File.join(@options[:saved_stdout_folder],
+                                          @options[:saved_stdout_glob]))).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
+      most_recent_list(Dir.glob(File.join(@options[:saved_script_folder],
+                                          @options[:saved_script_glob]))).tap_inspect
     end
 
     def make_block_label(block, call_options = {})
@@ -462,6 +487,89 @@ module MarkdownExec
       end.compact.tap_inspect
     end
 
+    def menu_data
+      val_as_bool = ->(value) { value.class.to_s == 'String' ? (value.chomp != '0') : value }
+      val_as_int = ->(value) { value.to_i }
+      val_as_str = ->(value) { value.to_s }
+
+      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 = [
+        ['block-name', 'f', 'MDE_BLOCK_NAME', 'RELATIVE', 'Name of block', :block_name, nil, val_as_str],
+        ['filename', 'f', 'MDE_FILENAME', 'RELATIVE', 'Name of document', :filename, nil, val_as_str],
+        ['list-blocks', nil, nil, nil, 'List blocks', :list_blocks, false, val_as_bool],
+        ['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, false, val_as_bool],
+        ['list-default-yaml', nil, nil, nil, 'List default configuration as YAML', :list_default_yaml, false, val_as_bool],
+        ['list-docs', nil, nil, nil, 'List docs in current folder', :list_docs, false, val_as_bool],
+        ['list-recent-output', nil, nil, nil, 'List recent saved output', :list_recent_output, false, val_as_bool],
+        ['list-recent-scripts', nil, nil, nil, 'List recent saved scripts', :list_recent_scripts, false, val_as_bool],
+        ['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],
+        ['pwd', nil, nil, nil, 'Gem home folder', :pwd, false, val_as_bool],
+        ['run-last-script', nil, nil, nil, 'Run most recently saved script', :run_last_script, false, val_as_bool],
+        ['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],
+        ['saved-stdout-glob', nil, 'MDE_SAVED_STDOUT_GLOB', 'SPEC', 'Glob matching saved outputs', :saved_stdout_glob, 'mde_*.out.txt', val_as_str],
+        ['select-recent-output', nil, nil, nil, 'Select and execute a recently saved output', :select_recent_output, false, val_as_bool],
+        ['select-recent-script', nil, nil, nil, 'Select and execute a recently saved script', :select_recent_script, false, val_as_bool],
+        ['tab-completions', nil, nil, nil, 'List tab completions', :tab_completions, false, val_as_bool],
+        ['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, "Print the gem's 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, '^\(.*\)$', val_as_str],
+        [nil, nil, 'MDE_BLOCK_NAME_MATCH', nil, '', :block_name_match, ':(?<title>\S+)( |$)', val_as_str],
+        [nil, nil, 'MDE_BLOCK_REQUIRED_SCAN', nil, '', :block_required_scan, '\+\S+', val_as_str],
+        [nil, nil, 'MDE_FENCED_START_AND_END_MATCH', nil, '', :fenced_start_and_end_match, '^`{3,}', val_as_str],
+        [nil, nil, 'MDE_FENCED_START_EX_MATCH', nil, '', :fenced_start_ex_match,
+         '^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$', val_as_str],
+        [nil, nil, 'MDE_HEADING1_MATCH', nil, '', :heading1_match, '^# *(?<name>[^#]*?) *$', val_as_str],
+        [nil, nil, 'MDE_HEADING2_MATCH', nil, '', :heading2_match, '^## *(?<name>[^#]*?) *$', val_as_str],
+        [nil, nil, 'MDE_HEADING3_MATCH', nil, '', :heading3_match, '^### *(?<name>.+?) *$', val_as_str],
+        [nil, nil, 'MDE_MD_FILENAME_GLOB', nil, '', :md_filename_glob, '*.[Mm][Dd]', val_as_str],
+        [nil, nil, 'MDE_MD_FILENAME_MATCH', nil, '', :md_filename_match, '.+\\.md', val_as_str],
+        [nil, nil, 'MDE_OUTPUT_VIEWER_OPTIONS', nil, 'Options for viewing saved output file', :output_viewer_options,
+         '', val_as_str],
+        [nil, nil, 'MDE_SELECT_PAGE_HEIGHT', nil, '', :select_page_height, 12, val_as_int]
+        # [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 +579,27 @@ 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)
+      #
+      block_name = rest.fetch(1, nil)
+      @options[:block_name] = block_name if block_name.present?
+    end
+
     def optsmerge(call_options = {}, options_block = nil)
       class_call_options = @options.merge(call_options || {})
       if options_block
@@ -495,6 +624,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,87 +663,28 @@ 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}" \
           " - #{MarkdownExec::APP_DESC} (#{MarkdownExec::VERSION})",
-          "Usage: #{executable_name} [path] [filename] [options]"
+          "Usage: #{executable_name} [(path | filename [block_name])] [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,47 +696,44 @@ 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)
+    FNR11 = '/'
+    FNR12 = ',;'
+
+    def saved_name_make(opts)
+      fne = opts[:filename].gsub(FNR11, FNR12)
+      "#{[opts[:saved_script_filename_prefix], Time.now.utc.strftime('%F-%H-%M-%S'), fne,
+          ',', opts[:block_name]].join('_')}.sh"
+    end
+
+    def saved_name_split(name)
+      mf = name.match(/#{@options[:saved_script_filename_prefix]}_(?<time>[0-9\-]+)_(?<file>.+)_,_(?<block>.+)\.sh/)
+      return unless mf
 
-      exec_block options, block_name
+      @options[:block_name] = mf[:block].tap_inspect name: :options_block_name
+      @options[:filename] = mf[:file].gsub(FNR12, FNR11).tap_inspect name: :options_filename
     end
 
     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/)
+      filename = most_recent Dir.glob(File.join(@options[:saved_script_folder],
+                                                @options[:saved_script_glob]))
+      return unless filename
 
-      @options[:block_name] = mf[:block]
-      @options[:filename] = "#{mf[:file]}.md" ### other extensions
+      filename.tap_inspect name: filename
+      saved_name_split filename
       @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"
@@ -680,7 +755,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,24 +771,29 @@ 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_output
+      filename = prompt_with_quit @options[:prompt_select_output].to_s, list_recent_output,
+                                  per_page: @options[:select_page_height]
+      return unless filename.present?
+
+      `open #{filename} #{options[:output_viewer_options]}`
+    end
+
     def select_recent_script
-      filename = @prompt.select @options[:prompt_select_md].to_s, list_recent_scripts,
-                                per_page: @options[:select_page_height]
-      mf = filename.match(/#{@options[:saved_script_filename_prefix]}_(?<time>[0-9\-]+)_(?<file>.+)_(?<block>.+)\.sh/)
+      filename = prompt_with_quit @options[:prompt_select_md].to_s, list_recent_scripts,
+                                  per_page: @options[:select_page_height]
+      return if filename.nil?
 
-      @options[:block_name] = mf[:block]
-      @options[:filename] = "#{mf[:file]}.md" ### other extensions
+      saved_name_split filename
       select_and_approve_block(
         bash: true,
         save_executed_script: false,
         struct: true
       )
-      save_execution_output
-      output_execution_summary
     end
 
     def sorted_keys(hash1)
@@ -722,22 +804,72 @@ module MarkdownExec
       { headings: headings, name: title, title: title }
     end
 
+    def tab_completions(data = menu_data)
+      data.map do |item|
+        "--#{item[0]}" if item[0]
+      end.compact
+    end
+
     def update_options(opts = {}, over: true)
       if over
         @options = @options.merge opts
       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)
-      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]
+      return unless opts[:save_executed_script]
+
+      opts[:saved_script_filename] = saved_name_make(opts)
+      @execute_script_filespec =
+        @options[:saved_filespec] =
+          File.join opts[:saved_script_folder], opts[:saved_script_filename]
+
       dirname = File.dirname(@options[:saved_filespec])
       Dir.mkdir dirname unless File.exist?(dirname)
       File.write(@options[:saved_filespec], "#!/usr/bin/env bash\n" \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -67,11 +67,13 @@ 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:
 - mde
+- tab_completion.sh
 extensions: []
 extra_rdoc_files: []
 files:
@@ -91,6 +93,7 @@ files:
 - bin/console
 - bin/mde
 - bin/setup
+- bin/tab_completion.sh
 - fixtures/bash1.md
 - fixtures/bash2.md
 - fixtures/exclude1.md
@@ -127,5 +130,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: []