markdown_exec 1.3.0 → 1.3.2

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.3.0)
+# MDE - Markdown Executor (1.3.2)
 ---
 - :arg_name: NAME
   :compreply: false
@@ -7,19 +7,19 @@
   :long_name: block-name
   :opt_name: block_name
   :short_name: b
-  :proc1: val_as_str
+  :procname: val_as_str
 - :arg_name: PATH
   :default: "."
   :description: Read configuration file
   :long_name: config
-  :proc1: path
+  :procname: path
 - :arg_name: BOOL
   :default: false
   :description: Debug output
   :env_var: MDE_DEBUG
   :long_name: debug
   :short_name: d
-  :proc1: debug
+  :procname: debug
 - :arg_name: RELATIVE_PATH
   :compreply: "."
   :description: Name of document
@@ -27,11 +27,11 @@
   :long_name: filename
   :opt_name: filename
   :short_name: f
-  :proc1: val_as_str
+  :procname: val_as_str
 - :description: App help
   :long_name: help
   :short_name: h
-  :proc1: help
+  :procname: help
 - :arg_name: RELATIVE_PATH
   :default: "."
   :description: Path to documents
@@ -39,7 +39,7 @@
   :long_name: path
   :opt_name: path
   :short_name: p
-  :proc1: val_as_str
+  :procname: val_as_str
 - :arg_name: BOOL
   :default: true
   :description: Pause for user to approve script
@@ -47,22 +47,22 @@
   :long_name: user-must-approve
   :opt_name: user_must_approve
   :short_name: q
-  :proc1: val_as_bool
+  :procname: val_as_bool
 - :description: Print the gem's version
   :long_name: version
   :short_name: v
-  :proc1: version
+  :procname: version
 - :description: Exit app
   :long_name: exit
   :short_name: x
-  :proc1: exit
+  :procname: exit
 - :description: Show current configuration values
   :short_name: '0'
-  :proc1: show_config
+  :procname: show_config
 - :description: List blocks
   :long_name: list-blocks
   :opt_name: list_blocks
-  :proc1: val_as_bool
+  :procname: val_as_bool
 - :description: List default configuration as environment variables
   :long_name: list-default-env
   :opt_name: list_default_env
@@ -72,222 +72,293 @@
 - :description: List docs in current folder
   :long_name: list-docs
   :opt_name: list_docs
-  :proc1: val_as_bool
+  :procname: val_as_bool
 - :description: List recent saved output
   :long_name: list-recent-output
   :opt_name: list_recent_output
-  :proc1: val_as_bool
+  :procname: val_as_bool
 - :description: List recent saved scripts
   :long_name: list-recent-scripts
   :opt_name: list_recent_scripts
-  :proc1: val_as_bool
+  :procname: 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
+  :procname: 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
+  :procname: val_as_bool
 - :description: List tab completions
   :long_name: tab-completions
   :opt_name: tab_completions
-  :proc1: val_as_bool
+  :procname: val_as_bool
 - :description: Run most recently saved script
   :long_name: run-last-script
   :opt_name: run_last_script
-  :proc1: val_as_bool
+  :procname: val_as_bool
 - :description: Gem home folder
   :long_name: pwd
   :opt_name: pwd
-  :proc1: val_as_bool
-- :arg_name: INT.0-2
+  :procname: val_as_bool
+- :arg_name: INT.0-3
   :default: 1
-  :description: Output display level (0 to 2 [data, +context, +info])
+  :description: Output display level (0 to 3 [data, +context, +info])
   :env_var: MDE_DISPLAY_LEVEL
   :long_name: display-level
   :opt_name: display_level
-  :proc1: val_as_int
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :procname: 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
+  :env_var: MDE_BLOCK_NAME_HIDDEN_MATCH
+  :opt_name: block_name_hidden_match
+  :procname: val_as_str
 - :default: ":(?<title>\\S+)( |$)"
   :env_var: MDE_BLOCK_NAME_MATCH
   :opt_name: block_name_match
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: "%\\([^\\)]+\\)"
   :env_var: MDE_BLOCK_CALLS_SCAN
   :opt_name: block_calls_scan
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: "\\+\\S+"
   :env_var: MDE_BLOCK_REQUIRED_SCAN
   :opt_name: block_required_scan
-  :proc1: val_as_str
+  :procname: 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
+  :procname: 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
+  :procname: val_as_str
 - :default: "> "
   :env_var: MDE_DISPLAY_LEVEL_XBASE_PREFIX
   :opt_name: display_level_xbase_prefix
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: "^`{3,}"
   :env_var: MDE_FENCED_START_AND_END_MATCH
   :opt_name: fenced_start_and_end_match
-  :proc1: val_as_str
+  :procname: 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
+  :procname: val_as_str
 - :default: "^# *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: "^## *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING2_MATCH
   :opt_name: heading2_match
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: "^### *(?<name>.+?) *$"
   :env_var: MDE_HEADING3_MATCH
   :opt_name: heading3_match
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: "*.[Mm][Dd]"
   :env_var: MDE_MD_FILENAME_GLOB
   :opt_name: md_filename_glob
-  :proc1: val_as_str
+  :procname: val_as_str
 - :default: ".+\\.md"
   :env_var: MDE_MD_FILENAME_MATCH
   :opt_name: md_filename_match
-  :proc1: val_as_str
+  :procname: val_as_str
+- :default: "-:=   %s   =:-"
+  :description: format for menu dividers and demarcations
+  :env_var: MDE_MENU_DIVIDER_FORMAT
+  :opt_name: menu_divider_format
+  :procname: val_as_str
+- :default: magenta
+  :description: Color of menu divider
+  :env_var: MDE_MENU_DIVIDER_COLOR
+  :opt_name: menu_divider_color
+  :procname: 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
+  :procname: val_as_str
+- :default: ">"
+  :description: Symbol before each divider
+  :env_var: MDE_MENU_DIVIDER_SYMBOL
+  :opt_name: menu_divider_symbol
+  :procname: val_as_str
+- :default: "~~~"
+  :description: closing demarcations for menu
+  :env_var: MDE_MENU_FINAL_DIVIDER
+  :opt_name: menu_final_divider
+  :procname: val_as_str
+- :default: ''
+  :description: opening demarcation for menu
+  :env_var: MDE_MENU_INITIAL_DIVIDER
+  :opt_name: menu_initial_divider
+  :procname: 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
+  :procname: val_as_str
+- :default: 36
   :description: 'Maximum # of rows in select list'
   :env_var: MDE_SELECT_PAGE_HEIGHT
   :opt_name: select_page_height
-  :proc1: val_as_int
+  :procname: val_as_int
 - :default: "#!/usr/bin/env"
   :description: Shebang for saved scripts
   :env_var: MDE_SHEBANG
   :opt_name: shebang
-  :proc1: val_as_str
+  :procname: 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
+  :procname: val_as_str
+- :default: Process?
+  :description: Prompt to approve a block
+  :env_var: MDE_PROMPT_APPROVE_BLOCK
+  :opt_name: prompt_approve_block
+  :procname: val_as_str
+- :default: 'Choose a block:'
+  :description: Prompt to select a block
+  :env_var: MDE_PROMPT_SELECT_BLOCK
+  :opt_name: prompt_select_block
+  :procname: val_as_str
+- :default: 'Choose a file:'
+  :description: Prompt to select a markdown document
+  :env_var: MDE_PROMPT_SELECT_MD
+  :opt_name: prompt_select_md
+  :procname: val_as_str
+- :default: 'Choose a file:'
+  :description: Prompt to select a saved file
+  :env_var: MDE_PROMPT_SELECT_OUTPUT
+  :opt_name: prompt_select_output
+  :procname: val_as_str
+- :default: Copy script to clipboard
+  :description: Prompt to copy script to clipboard
+  :env_var: MDE_PROMPT_SCRIPT_TO_CLIPBOARD
+  :opt_name: prompt_script_to_clipboard
+  :procname: val_as_str
+- :default: Save script
+  :description: Prompt to save script
+  :env_var: MDE_PROMPT_SAVE_SCRIPT
+  :opt_name: prompt_save_script
+  :procname: val_as_str
+- :default: 'No'
+  :description: Prompt for no
+  :env_var: MDE_PROMPT_NO
+  :opt_name: prompt_no
+  :procname: val_as_str
+- :default: 'Yes'
+  :description: Prompt for yes
+  :env_var: MDE_PROMPT_YES
+  :opt_name: prompt_yes
+  :procname: val_as_str
+- :default: " #=#=#"
+  :description: Output divider
+  :env_var: MDE_OUTPUT_DIVIDER
+  :opt_name: output_divider
+  :procname: val_as_str
+- :default: yellow
+  :description: Color of output divider
+  :env_var: MDE_OUTPUT_DIVIDER_COLOR
+  :opt_name: output_divider_color
+  :procname: val_as_str

data/lib/object_present.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+# is the value empty?
+#
+class String
+  unless defined?(blank?)
+    def blank?
+      empty? || /\A[[:space:]]*\z/.freeze.match?(self)
+    end
+  end
+end
+
+# is the value non-empty?
+#
+class String
+  unless defined?(present?)
+    def present?
+      !empty?
+    end
+  end
+end
+
+# is the value a non-empty string or a binary?
+#
+# :reek:ManualDispatch ### temp
+class Object
+  unless defined?(present?)
+    def present?
+      case self.class.to_s
+      when 'FalseClass', 'TrueClass'
+        true
+      else
+        self && (!respond_to?(:blank?) || !blank?)
+      end
+    end
+  end
+end

data/lib/shared.rb

@@ -10,10 +10,11 @@ BF = 'bin'
 
 # display_level values
 DISPLAY_LEVEL_BASE = 0 # required output
-DISPLAY_LEVEL_ADMIN = 1
+DISPLAY_LEVEL_ADMIN = 1 # monit
 DISPLAY_LEVEL_DEBUG = 2
+DISPLAY_LEVEL_DUMP = 3
 DISPLAY_LEVEL_DEFAULT = DISPLAY_LEVEL_ADMIN
-DISPLAY_LEVEL_MAX = DISPLAY_LEVEL_DEBUG
+DISPLAY_LEVEL_MAX = DISPLAY_LEVEL_DUMP
 
 # @execute_files[ind] = @execute_files[ind] + [block]
 EF_STDOUT = 0
@@ -26,15 +27,3 @@ 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
-  when 'String'
-    Shellwords.escape value
-  when 'FalseClass', 'TrueClass'
-    value ? '1' : '0'
-  else
-    Shellwords.escape value.to_s
-  end
-end

data/lib/tap.rb

@@ -6,37 +6,112 @@ require 'json'
 require 'yaml'
 
 require_relative 'env'
+require_relative 'object_present'
+
 include Env
 
+# rubocop:disable Metrics/ParameterLists
+
 ## application-level debug control
 #
 module Tap
-  $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
+  DN = 'return'
+  NONE = 0x0
+  T1 = 1 # RESULT
+  T2 = 2 # CONTEXT
+  T3 = 4 # MONITOR
+  T4 = 8 # DUMP
+  ALL2 = 0x77
+  ALL = 0xFF
+  TDD = 0x11
+  TB1 = 0x22
+  TB2 = 0x44
+  TB3 = 0x88
+  TD = 0x0F
+  TD0 = 0x01
+  TD1 = 0x02
+  TD2 = 0x04
+  TP = 0xF0
+  TP0 = 0x10
+  TP1 = 0x20
+  TP2 = 0x40
+
+  # cast with message per tap_inspect type
+  # type: message
+  #
+  CVT = {
+    json: :to_json,
+    string: :to_s,
+    yaml: :to_yaml,
+    else: :inspect
+  }.freeze
+
+  $tap_enable = false
+  $tap_mask = ALL2
+
+  def tap_config(enable: true, envvar: nil, value: nil)
+    $tap_enable = false
+    if envvar
+      $tap_enable = (env_int envvar).positive?
+      $tap_mask = ALL2 if $tap_enable
+    elsif value
+      $tap_mask = value.to_i
+      $tap_enable = $tap_mask.positive?
+    elsif enable
+      $tap_mask = ALL2
+      $tap_enable = true
+    end
+    # puts "$tap_enable: #{$tap_enable}"
+    # puts "$tap_mask: #{$tap_mask.to_s(2)}"
+    self
   end
 
-  def tap_inspect(format: nil, name: 'return')
+  def tap_inspect(name_ = nil, caller0: nil, mask: TDD, name: DN, source: nil, type: nil)
     return self unless $tap_enable
+    return self unless (mask & $tap_mask).positive?
 
-    cvt = {
-      json: :to_json,
-      string: :to_s,
-      yaml: :to_yaml,
-      else: :inspect
-    }
-    fn = cvt.fetch(format, cvt[:else])
+    fn = CVT.fetch(type, CVT[:else])
+    outs = []
+    outs.push(source.to_s) if source.present?
 
-    puts "-> #{caller[0].scan(/in `?(\S+)'$/)[0][0]}()" \
-         " #{name}: #{method(fn).call}"
+    vs = (caller0 || caller[0]).scan(/in `?(\S+)'$/).fetch(0, []).fetch(0, '')
+    outs.push("#{vs}()") if vs.present?
+
+    outs.push(tap_named_value(name_ || name, method(fn).call))
+
+    $stdout.puts(outs.join(' ')) if outs.length.positive?
+    self
+  end
+
+  def tap_print(mask: TDD)
+    return self unless $tap_enable
+    return self unless (mask & $tap_mask).positive?
 
+    $stdout.print self
     self
   end
+
+  def tap_puts(name_ = nil, mask: TDD, name: nil)
+    return self unless $tap_enable
+    return self unless (mask & $tap_mask).positive?
+
+    $stdout.puts tap_named_value(name_ || name, self)
+    self
+  end
+
+  def tap_yaml(name_ = nil, caller0: nil, mask: TDD, name: DN, source: nil)
+    tap_inspect name_, caller0: (caller0 || caller[0]), mask: mask, name: name, source: source, type: :yaml
+  end
+
+  private
+
+  def tap_named_value(name, value)
+    if name.present?
+      "#{name}: #{value}"
+    else
+      value.to_s
+    end
+  end
 end
+
+# rubocop:enable Metrics/ParameterLists

data/lib/yaml_env_opts.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+require 'yaml'
+
+require_relative 'env_opts'
+require_relative 'object_present'
+require_relative 'tap'
+
+include Tap #; tap_config
+
+# read configuration YAML file during initalization
+# value priority: menu default < configuration file < environment variable < command argument
+#
+class YamlEnvOpts < EnvOpts
+  def initialize(opts_raw = {}, argv: ARGV, configuration_yaml_filespec: '', values: nil)
+    super(opts_raw || {}, nil)
+    per_values(values)
+    configure_yaml_filespec(configuration_yaml_filespec)
+    set_keys_value_per_environment_as_cast(opts_raw)
+    parse(argv)
+
+    self # rubocop:disable Lint/Void
+  end
+
+  private
+
+  def apply_configuration(settings)
+    settings.tap_inspect 'settings'
+    return if settings.nil?
+
+    settings.each do |name, value|
+      set_key_value_as_cast(name, value)
+    end.tap_inspect
+  end
+
+  def configure_yaml_filespec(configuration_yaml_filespec)
+    apply_configuration(read_configuration_yaml(configuration_yaml_filespec))
+  end
+
+  def per_values(settings)
+    settings.tap_inspect 'settings'
+    return self if settings.nil?
+    return self if settings.count.zero?
+
+    settings.each do |name, value|
+      set_key_value_as_cast(name, value)
+    end
+
+    self
+  end
+
+  def read_configuration_yaml(configuration_yaml_filespec)
+    configuration_yaml_filespec.tap_inspect 'configuration_yaml_filespec'
+    return unless configuration_yaml_filespec.present?
+
+    YAML.safe_load(File.read(configuration_yaml_filespec) || '').tap_inspect
+  end
+end