markdown_exec 1.2.0 → 1.3.0

data/lib/menu.yml

@@ -0,0 +1,293 @@
+# MDE - Markdown Executor (1.3.0)
+---
+- :arg_name: NAME
+  :compreply: false
+  :description: Name of block
+  :env_var: MDE_BLOCK_NAME
+  :long_name: block-name
+  :opt_name: block_name
+  :short_name: b
+  :proc1: val_as_str
+- :arg_name: PATH
+  :default: "."
+  :description: Read configuration file
+  :long_name: config
+  :proc1: path
+- :arg_name: BOOL
+  :default: false
+  :description: Debug output
+  :env_var: MDE_DEBUG
+  :long_name: debug
+  :short_name: d
+  :proc1: debug
+- :arg_name: RELATIVE_PATH
+  :compreply: "."
+  :description: Name of document
+  :env_var: MDE_FILENAME
+  :long_name: filename
+  :opt_name: filename
+  :short_name: f
+  :proc1: val_as_str
+- :description: App help
+  :long_name: help
+  :short_name: h
+  :proc1: help
+- :arg_name: RELATIVE_PATH
+  :default: "."
+  :description: Path to documents
+  :env_var: MDE_PATH
+  :long_name: path
+  :opt_name: path
+  :short_name: p
+  :proc1: val_as_str
+- :arg_name: BOOL
+  :default: true
+  :description: Pause for user to approve script
+  :env_var: MDE_USER_MUST_APPROVE
+  :long_name: user-must-approve
+  :opt_name: user_must_approve
+  :short_name: q
+  :proc1: val_as_bool
+- :description: Print the gem's version
+  :long_name: version
+  :short_name: v
+  :proc1: version
+- :description: Exit app
+  :long_name: exit
+  :short_name: x
+  :proc1: exit
+- :description: Show current configuration values
+  :short_name: '0'
+  :proc1: show_config
+- :description: List blocks
+  :long_name: list-blocks
+  :opt_name: list_blocks
+  :proc1: val_as_bool
+- :description: List default configuration as environment variables
+  :long_name: list-default-env
+  :opt_name: list_default_env
+- :description: List default configuration as YAML
+  :long_name: list-default-yaml
+  :opt_name: list_default_yaml
+- :description: List docs in current folder
+  :long_name: list-docs
+  :opt_name: list_docs
+  :proc1: val_as_bool
+- :description: List recent saved output
+  :long_name: list-recent-output
+  :opt_name: list_recent_output
+  :proc1: val_as_bool
+- :description: List recent saved scripts
+  :long_name: list-recent-scripts
+  :opt_name: list_recent_scripts
+  :proc1: val_as_bool
+- :description: Select and execute a recently saved output
+  :long_name: select-recent-output
+  :opt_name: select_recent_output
+  :proc1: val_as_bool
+- :description: Select and execute a recently saved script
+  :long_name: select-recent-script
+  :opt_name: select_recent_script
+  :proc1: val_as_bool
+- :description: List tab completions
+  :long_name: tab-completions
+  :opt_name: tab_completions
+  :proc1: val_as_bool
+- :description: Run most recently saved script
+  :long_name: run-last-script
+  :opt_name: run_last_script
+  :proc1: val_as_bool
+- :description: Gem home folder
+  :long_name: pwd
+  :opt_name: pwd
+  :proc1: val_as_bool
+- :arg_name: INT.0-2
+  :default: 1
+  :description: Output display level (0 to 2 [data, +context, +info])
+  :env_var: MDE_DISPLAY_LEVEL
+  :long_name: display-level
+  :opt_name: display_level
+  :proc1: val_as_int
+- :arg_name: INT.1-
+  :default: 32
+  :description: Max. items to return in list
+  :env_var: MDE_LIST_COUNT
+  :long_name: list-count
+  :opt_name: list_count
+  :proc1: val_as_int
+- :arg_name: PREFIX
+  :default: mde
+  :description: Name prefix for stdout files
+  :env_var: MDE_LOGGED_STDOUT_FILENAME_PREFIX
+  :opt_name: logged_stdout_filename_prefix
+  :proc1: val_as_str
+- :arg_name: BOOL
+  :default: false
+  :description: Display document name in block selection menu
+  :env_var: MDE_MENU_BLOCKS_WITH_DOCNAME
+  :opt_name: menu_blocks_with_docname
+  :proc1: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Display headings (levels 1,2,3) in block selection menu
+  :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS
+  :opt_name: menu_blocks_with_headings
+  :proc1: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Display summary for execution
+  :env_var: MDE_OUTPUT_EXECUTION_SUMMARY
+  :long_name: output-execution-summary
+  :opt_name: output_execution_summary
+  :proc1: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Display script prior to execution
+  :env_var: MDE_OUTPUT_SCRIPT
+  :long_name: output-script
+  :opt_name: output_script
+  :proc1: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: Display standard output from execution
+  :env_var: MDE_OUTPUT_STDOUT
+  :long_name: output-stdout
+  :opt_name: output_stdout
+  :proc1: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Save executed script
+  :env_var: MDE_SAVE_EXECUTED_SCRIPT
+  :long_name: save-executed-script
+  :opt_name: save_executed_script
+  :proc1: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Save standard output of the executed script
+  :env_var: MDE_SAVE_EXECUTION_OUTPUT
+  :long_name: save-execution-output
+  :opt_name: save_execution_output
+  :proc1: val_as_bool
+- :arg_name: INT
+  :default: 493
+  :description: chmod for saved scripts
+  :env_var: MDE_SAVED_SCRIPT_CHMOD
+  :opt_name: saved_script_chmod
+  :proc1: val_as_int
+- :arg_name: PREFIX
+  :default: mde
+  :description: Name prefix for saved scripts
+  :env_var: MDE_SAVED_SCRIPT_FILENAME_PREFIX
+  :opt_name: saved_script_filename_prefix
+  :proc1: val_as_str
+- :arg_name: RELATIVE_PATH
+  :default: logs
+  :description: Saved script folder
+  :env_var: MDE_SAVED_SCRIPT_FOLDER
+  :long_name: saved-script-folder
+  :opt_name: saved_script_folder
+  :proc1: val_as_str
+- :arg_name: GLOB
+  :default: mde_*.sh
+  :description: Glob matching saved scripts
+  :env_var: MDE_SAVED_SCRIPT_GLOB
+  :opt_name: saved_script_glob
+  :proc1: val_as_str
+- :arg_name: RELATIVE_PATH
+  :default: logs
+  :description: Saved stdout folder
+  :env_var: MDE_SAVED_STDOUT_FOLDER
+  :long_name: saved-stdout-folder
+  :opt_name: saved_stdout_folder
+  :proc1: val_as_str
+- :arg_name: GLOB
+  :default: mde_*.out.txt
+  :description: Glob matching saved outputs
+  :env_var: MDE_SAVED_STDOUT_GLOB
+  :opt_name: saved_stdout_glob
+  :proc1: val_as_str
+- :default: "^[\\(\\[].*[\\)\\]]$"
+  :description: Pattern for blocks to hide from user-selection
+  :env_var: MDE_BLOCK_NAME_EXCLUDED_MATCH
+  :opt_name: block_name_excluded_match
+  :proc1: val_as_str
+- :default: ":(?<title>\\S+)( |$)"
+  :env_var: MDE_BLOCK_NAME_MATCH
+  :opt_name: block_name_match
+  :proc1: val_as_str
+- :default: "%\\([^\\)]+\\)"
+  :env_var: MDE_BLOCK_CALLS_SCAN
+  :opt_name: block_calls_scan
+  :proc1: val_as_str
+- :default: "\\+\\S+"
+  :env_var: MDE_BLOCK_REQUIRED_SCAN
+  :opt_name: block_required_scan
+  :proc1: val_as_str
+- :default: "<(?<full>(?<type>\\$)?(?<name>[A-Za-z]\\S*))"
+  :env_var: MDE_BLOCK_STDIN_SCAN
+  :opt_name: block_stdin_scan
+  :proc1: val_as_str
+- :default: ">(?<full>(?<type>\\$)?(?<name>[A-Za-z]\\S*))"
+  :env_var: MDE_BLOCK_STDOUT_SCAN
+  :opt_name: block_stdout_scan
+  :proc1: val_as_str
+- :default: "> "
+  :env_var: MDE_DISPLAY_LEVEL_XBASE_PREFIX
+  :opt_name: display_level_xbase_prefix
+  :proc1: val_as_str
+- :default: "^`{3,}"
+  :env_var: MDE_FENCED_START_AND_END_MATCH
+  :opt_name: fenced_start_and_end_match
+  :proc1: val_as_str
+- :default: "^`{3,}(?<shell>[^`\\s]*) *(?<name>.*)$"
+  :env_var: MDE_FENCED_START_EX_MATCH
+  :opt_name: fenced_start_ex_match
+  :proc1: val_as_str
+- :default: "^# *(?<name>[^#]*?) *$"
+  :env_var: MDE_HEADING1_MATCH
+  :opt_name: heading1_match
+  :proc1: val_as_str
+- :default: "^## *(?<name>[^#]*?) *$"
+  :env_var: MDE_HEADING2_MATCH
+  :opt_name: heading2_match
+  :proc1: val_as_str
+- :default: "^### *(?<name>.+?) *$"
+  :env_var: MDE_HEADING3_MATCH
+  :opt_name: heading3_match
+  :proc1: val_as_str
+- :default: "*.[Mm][Dd]"
+  :env_var: MDE_MD_FILENAME_GLOB
+  :opt_name: md_filename_glob
+  :proc1: val_as_str
+- :default: ".+\\.md"
+  :env_var: MDE_MD_FILENAME_MATCH
+  :opt_name: md_filename_match
+  :proc1: val_as_str
+- :default: "^::: +(?<name>.+?)$"
+  :description: Pattern for topics/dividers in block selection menu
+  :env_var: MDE_MENU_DIVIDER_MATCH
+  :opt_name: menu_divider_match
+  :proc1: val_as_str
+- :description: Options for viewing saved output file
+  :env_var: MDE_OUTPUT_VIEWER_OPTIONS
+  :opt_name: output_viewer_options
+  :proc1: val_as_str
+- :default: 24
+  :description: 'Maximum # of rows in select list'
+  :env_var: MDE_SELECT_PAGE_HEIGHT
+  :opt_name: select_page_height
+  :proc1: val_as_int
+- :default: "#!/usr/bin/env"
+  :description: Shebang for saved scripts
+  :env_var: MDE_SHEBANG
+  :opt_name: shebang
+  :proc1: val_as_str
+- :default: bash
+  :description: Shell for launched scripts
+  :env_var: MDE_SHELL
+  :opt_name: shell
+  :proc1: val_as_str
+- :default: "- - %s - -"
+  :env_var: MDE_MENU_DIVIDER_FORMAT
+  :opt_name: menu_divider_format
+  :proc1: val_as_str

data/lib/shared.rb

@@ -6,6 +6,27 @@ require 'shellwords'
 
 public
 
+BF = 'bin'
+
+# display_level values
+DISPLAY_LEVEL_BASE = 0 # required output
+DISPLAY_LEVEL_ADMIN = 1
+DISPLAY_LEVEL_DEBUG = 2
+DISPLAY_LEVEL_DEFAULT = DISPLAY_LEVEL_ADMIN
+DISPLAY_LEVEL_MAX = DISPLAY_LEVEL_DEBUG
+
+# @execute_files[ind] = @execute_files[ind] + [block]
+EF_STDOUT = 0
+EF_STDERR = 1
+EF_STDIN = 2
+
+LOCAL_YML = 'menu.yml'
+MENU_YML = "lib/#{LOCAL_YML}"
+
+def menu_from_yaml
+  YAML.load File.open(File.join(File.expand_path(__dir__), LOCAL_YML))
+end
+
 # skip :reek:UtilityFunction
 def value_for_cli(value)
   case value.class.to_s

data/lib/tap.rb

@@ -6,19 +6,25 @@ require 'json'
 require 'yaml'
 
 require_relative 'env'
-include Env # rubocop:disable Style/MixinUsage
+include Env
 
-# add function for in-line tap
+## application-level debug control
 #
 module Tap
-  $pdebug = env_bool 'MDE_DEBUG'
-
-  def tap_config(enable)
-    $pdebug = enable
+  $tap_enable = env_bool 'TAP_DEBUG'
+
+  def tap_config(enable: nil, envvar: nil, value: nil)
+    $tap_enable = if envvar
+                    env_bool envvar
+                  elsif value
+                    value.to_i != 0
+                  elsif enable
+                    enable
+                  end
   end
 
   def tap_inspect(format: nil, name: 'return')
-    return self unless $pdebug
+    return self unless $tap_enable
 
     cvt = {
       json: :to_json,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-12 00:00:00.000000000 Z
+date: 2022-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -112,8 +112,10 @@ files:
 - bin/tab_completion.sh.erb
 - lib/colorize.rb
 - lib/env.rb
+- lib/globfiles.rb
 - lib/markdown_exec.rb
 - lib/markdown_exec/version.rb
+- lib/menu.yml
 - lib/shared.rb
 - lib/tap.rb
 homepage: https://rubygems.org/gems/markdown_exec