markdown_exec 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b40d575297112f5a4bb934475b84251aeeab8f43de5dae963c8d3b1711c3edc
-  data.tar.gz: 9e3d3273dc3e3a0deb326fe30e3ff70b15e73f4fd9cea06c42f099f184903fad
+  metadata.gz: 160eb660362db62302a05b8b46398c6d85357c917ee55eeb89a8ce0f739eec8a
+  data.tar.gz: 706e575c290ec56d34ad58f06ca9e30127b2c0bdacf431a4c9e3f69bc30e80dc
 SHA512:
-  metadata.gz: 65654b5af78419591c41e3b50e0697b503ddf429c83312311335dd1b16d0d645c98b4e0c19d6c69446c42823861ca8f384788aeb4c1b5664804e4feecc39a45a
-  data.tar.gz: 866360b40733e8925c173582f3c59799e241bf48f52faffa4bfb03cd4c1a11c93f5b27305344b01c4b44a1518ef1c49961c7fbfbdb713638ed8261c8d87401c0
+  metadata.gz: f540464a21a3ca2b654d89b3bc32f2172a3e610066bc64b9eae1bc29d99b8006ed3581998a50ae2327052c944656584375df55e64ffeeb77864ae05e45325e1c
+  data.tar.gz: a22c5ff757a2b5173725786bdbc399cae29f63eda891a0741149286391cb413abbcccd3799bd15ec769230ed44245b49664d434c77c12610bc2cfc138a9d3ddb

data/.reek

@@ -0,0 +1,24 @@
+---
+detectors:
+  DataClump:
+    enabled: false
+  NilCheck:
+    enabled: false
+  TooManyStatements:
+    enabled: false
+  UtilityFunction:
+    public_methods_only: true
+  ControlParameter:
+    enabled: true
+  DuplicateMethodCall:
+    enabled: true
+  FeatureEnvy:
+    enabled: false # too strict
+  InstanceVariableAssumption:
+    enabled: true
+  IrresponsibleModule:
+    enabled: true
+  LongParameterList:
+    enabled: true
+  LongYieldList:
+    enabled: true

data/CHANGELOG.md

@@ -1,29 +1,93 @@
 # Changelog
 
 ## [ToDo]
+`reek lib/markdown_exec.rb --config .reek`
 
-- 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
+
+- [ ] read file once to allow for tempdoc stream
 
 - tree display
 
-- mde options in md file or included file
+- [ ] mde options, user prompt, in md file or included file
+
+- [ ] include blocks from local md file
+
+- execute? yes/no/save/clipboard + record/edit/history
+
+- [ ] list, view saved output
+
+- completion 
+    - [ ] include blocks in md file
+
+- [ ] ruby gem data model
+
+- [ ] extract yaml block into stdout
+- [ ] extract json block into stdout
 
-- include blocks from local md file
+- [ ] import yaml, json data into environment
 
-- chmod a+x logged script
+- [ ] yq filter with imported or named yaml, json data
 
-- add shebang to saved script
+- [ ] yaml dump of options w/ detail
+
+- [ ] re-exec last script v re-run named block in last script
+- [ ] repeat to reload last doc and block
+- [ ] option to log blended, timeline; stdin, stdout, stderr; labels: prefix and blocks
+- [ ] ren logged_stdout_filename_prefix to saved_stdout_filename_prefix
+- [ ] ignore '#' in fenced code blocks
+
+## [1.2.0] - 2022-06-11
+
+### Added
+
+- Options
+    - Display document name in block selection menu
+    - Display headings (levels 1,2,3) in block selection menu
+- Trap Ctrl-C (SIGTERM) while script is executing.
+  Completes MDE processes such as saving output and reporting results.
+
+### Changed
 
-- yes/no/write/clipboard/record/edit/history
+- Refactoring
+
+## [1.1.1] - 2022-05-25
+
+### Added
+
+- Post-install instructions to add tab completions permanently to the shell.
+
+### Changed
+
+- Improve handling of threads ending while executing scripts.
+
+## [1.1.0] - 2022-05-21
+
+### Added
+
+- Display administrative output (command, save files) for executed blocks.
+- Select base, administrative output as hierarchical output (MDE_DISPLAY_LEVEL).
+- The user may select Exit, the first option, to quit the program.
+- The block-selection menu is re-displayed after an approved script is exectued.
+- Pause for and pass through standard input in scripts executed by the tool.
+- Options
+    - chmod for saved scripts
+    - shebang for saved scripts
+    - shell for executed and saved scripts
+
+### Changed
 
-- list, view saved output
+- Exit option is at top of each menu.
+- Single-stage tab completion, default
+    - Presents matching options when current word starts with `-`
+    - Presents directories and files otherwise.
+- Two-stage tab completion for option arguments.
+    - When prior word is an option and current word is empty
+    - Presents option type on first tab, eg `.BOOL.` for a boolean option.
+    - Presents option default value on second tab, eg `0` for false.
+- Write STDOUT, STDERR, STDIN in sections to saved output file.
 
 ## [1.0.0] - 2022-04-26
 

data/Gemfile

@@ -2,13 +2,15 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in markdown_exec.gemspec
 gemspec
-
-gem 'rake', '~> 13.0'
-
+gem 'clipboard'
+gem 'erb'
 gem 'minitest', '~> 5.0'
-
+gem 'rake', '~> 13.0'
+gem 'reek'
 gem 'rubocop', '~> 1.21'
 gem 'rubocop-minitest', require: false
 gem 'rubocop-rake', require: false
+gem 'shellwords'
+gem 'uri'
+gem 'yaml'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.0.0)
+    markdown_exec (1.2.0)
+      clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
@@ -11,6 +12,11 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    cgi (0.3.2)
+    clipboard (1.3.6)
+    erb (2.2.3)
+      cgi
+    kwalify (0.7.2)
     minitest (5.15.0)
     open3 (0.1.1)
     optparse (0.1.1)
@@ -21,6 +27,10 @@ GEM
       tty-color (~> 0.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    reek (6.1.1)
+      kwalify (~> 0.7.0)
+      parser (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
     rubocop (1.26.0)
@@ -39,6 +49,7 @@ GEM
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
+    shellwords (0.1.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
     tty-prompt (0.23.1)
@@ -50,6 +61,7 @@ GEM
       wisper (~> 2.0)
     tty-screen (0.8.1)
     unicode-display_width (2.1.0)
+    uri (0.11.0)
     wisper (2.0.1)
     yaml (0.2.0)
 
@@ -57,12 +69,18 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  clipboard
+  erb
   markdown_exec!
   minitest (~> 5.0)
   rake (~> 13.0)
+  reek
   rubocop (~> 1.21)
   rubocop-minitest
   rubocop-rake
+  shellwords
+  uri
+  yaml
 
 BUNDLED WITH
    2.2.32

data/README.md

@@ -150,21 +150,34 @@ Boolean options configured with environment variables:
 
 ### Install tab completion
 
-Append a command to load the completion script to your shell configuration file:
+Append a command to load the completion script to your shell configuration file. `mde` must be executable for the command to be composed correctly.
 
 ```bash :()
 echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
 ```
 
+### Behavior
+
+Press tab for completions appropriate to the current input.
+`mde <...> <prior word> <current word>`
+
+Completions are calculated based on the current word and the prior word. 
+1. If the current word starts with `-`, present matching options, eg `--version` for the current word `--v`.
+2. Else, if the current word is empty and the prior word is an option that takes an argument, present the type of the argument, eg `.BOOL.` for the option `--user-must-approve`.
+3. Else, if the current word is the type of argument, from the rule above, present the default value for the option. e.g. `1` for the type `.BOOL.` for the option `--user-must-approve`.
+4. Else, if the current word is non-empty, list matching files and folders.
+
 ### 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 --`
+In the table below, tab is indicated by `!`
+| Input | Completions |
+| :---: | :---: |
+| `mde !` | local files and folders |
+| `mde -!` | all options |
+| `mde --!` | all options |
+| `mde --v!` | `mde --version` |
+| `mde --user-must-approve !` | `mde --user-must-approve .BOOL.`|
+| `mde --user-must-approve .BOOL.!` | `mde --user-must-approve 1` |
 
 ## Example Blocks
 
@@ -190,6 +203,10 @@ export ACTIVITY=asleep
 echo "$TIME -> $ACTIVITY"
 ```
 
+``` :sleep
+sleep 10
+```
+
 # License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -2,6 +2,8 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'erb'
+require 'yaml'
 
 Rake::TestTask.new(:test) do |task|
   task.libs << 'test'
@@ -11,8 +13,13 @@ end
 
 require 'rubocop/rake_task'
 
+require_relative 'lib/shared'
+require_relative 'lib/tap'
+
+include Tap # rubocop:disable Style/MixinUsage
+
 RuboCop::RakeTask.new do |task|
-  # task.requires << 'rubocop-minitest'
+  task.requires << 'rubocop-minitest'
 end
 
 desc 'named task because minitest not included in rubocop tests'
@@ -22,12 +29,13 @@ end
 
 require_relative 'lib/markdown_exec/version'
 
-task default: %i[test rubocop rubocopminitest]
+task default: %i[test reek rubocop rubocopminitest]
 
 # task :default => :build
 
 desc 'gem build'
 task :build do
+  Rake::Task['update_tab_completion'].execute
   system "gem build #{MarkdownExec::GEM_NAME}.gemspec"
 end
 
@@ -50,3 +58,49 @@ desc 'gem build clean'
 task :clean do
   system 'rm *.gem'
 end
+
+desc 'reek'
+task :reek do
+  `reek --config .reek .`
+end
+
+private
+
+BF = 'bin'
+
+# format for use in array in bash script
+# `opts=<%= mde_tab_completions %>`
+#
+def words_list(words)
+  words.map do |word|
+    %("#{word}")
+  end.join ' '
+end
+
+# write tab_completion.sh with erb
+#
+def update_tab_completion(target)
+  words = `#{File.join BF, MarkdownExec::BIN_NAME} --tab-completions`.split("\n")
+  mde_tab_completions = "(#{words_list(words)})"
+  mde_help = `#{File.join BF, MarkdownExec::BIN_NAME} --help`.split("\n")
+  menu_export_yaml = `#{File.join BF, MarkdownExec::BIN_NAME} --menu-export`
+
+  svhs = YAML.load menu_export_yaml # rubocop:disable Security/YAMLLoad
+  svhs.each do |svh|
+    svh[:compreply] = value_for_cli(svh[:default]) if svh[:compreply].nil?
+  end.tap_inspect name: :svhs, format: :yaml
+
+  File.write target, ERB.new(File.read(File.join(BF, 'tab_completion.sh.erb'))).result(binding)
+end
+
+desc 'update tab_completion.sh'
+task :update_tab_completion do
+  update_tab_completion File.join(BF, 'tab_completion.sh')
+end
+
+desc 'update tab_completion.sh'
+task :update_installed_tab_completion do
+  update_tab_completion(fs = File.join(`mde --pwd`.chomp, BF, 'tab_completion.sh'))
+
+  puts `cat #{fs}` ###
+end

data/bin/tab_completion.sh

@@ -4,20 +4,148 @@ __filedirs()
 {
   local IFS=$'\n'
   COMPREPLY=( $(compgen -o plusdirs -f -- "${cur}") )
+  # COMPREPLY=( $(compgen -d) $(compgen -f -- "${cur}") )
+}
+
+__filedirs_all()
+{
+  COMPREPLY='.'
+}
+
+_mde_echo_version() {
+  echo "1.2.0"
 }
 
 _mde() {
   local cur prev opts
   cur="${COMP_WORDS[COMP_CWORD]}"
   prev="${COMP_WORDS[COMP_CWORD-1]}"
-  opts="$(mde --tab-completions)"
+  # printf '%s' "-;${prev}-:${cur}-"
 
+  # current word is an option type
+  # if previous word is an option name
+  #   stage 2: replace with option default value
+  #
+  if [[ "${cur}" =~ ^\..+\.$ ]] ; then
+    if [[ ${prev} == -* ]] ; then
+      case $prev in
+        
+              --config) COMPREPLY="."; return 0 ;;
+            
+              --debug) COMPREPLY="0"; return 0 ;;
+            
+              --display-level) COMPREPLY="1"; return 0 ;;
+            
+              --filename) COMPREPLY="."; return 0 ;;
+            
+              --list-count) COMPREPLY="32"; return 0 ;;
+            
+              --logged-stdout-filename-prefix) COMPREPLY="mde"; return 0 ;;
+            
+              --menu-blocks-with-docname) COMPREPLY="0"; return 0 ;;
+            
+              --menu-blocks-with-headings) COMPREPLY="0"; return 0 ;;
+            
+              --output-execution-summary) COMPREPLY="0"; return 0 ;;
+            
+              --output-script) COMPREPLY="0"; return 0 ;;
+            
+              --output-stdout) COMPREPLY="1"; return 0 ;;
+            
+              --path) COMPREPLY="."; return 0 ;;
+            
+              --save-executed-script) COMPREPLY="0"; return 0 ;;
+            
+              --save-execution-output) COMPREPLY="0"; return 0 ;;
+            
+              --saved-script-chmod) COMPREPLY="493"; return 0 ;;
+            
+              --saved-script-filename-prefix) COMPREPLY="mde"; return 0 ;;
+            
+              --saved-script-folder) COMPREPLY="logs"; return 0 ;;
+            
+              --saved-script-glob) COMPREPLY="mde_\*.sh"; return 0 ;;
+            
+              --saved-stdout-folder) COMPREPLY="logs"; return 0 ;;
+            
+              --saved-stdout-glob) COMPREPLY="mde_\*.out.txt"; return 0 ;;
+            
+              --user-must-approve) COMPREPLY="1"; return 0 ;;
+            
+      esac
+    fi
+  fi
+
+  # current word is an option name or start of
+  # present matching option names
+  #
   if [[ ${cur} == -* ]] ; then
-    COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
+    opts=("--list-blocks" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--pwd" "--run-last-script" "--select-recent-output" "--select-recent-script" "--menu-export" "--tab-completions" "--help" "--version" "--exit" "--config" "--debug" "--display-level" "--block-name" "--filename" "--list-count" "--logged-stdout-filename-prefix" "--menu-blocks-with-docname" "--menu-blocks-with-headings" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--save-executed-script" "--save-execution-output" "--saved-script-chmod" "--saved-script-filename-prefix" "--saved-script-folder" "--saved-script-glob" "--saved-stdout-folder" "--saved-stdout-glob" "--user-must-approve")
+    COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
+
     return 0
   fi
 
+  # no current word
+  # if previous word is an option name
+  #   stage 1: present option type 
+  #
+  if [[ -z ${cur} ]] ; then
+    case $prev in
+      
+          --config) COMPREPLY=".PATH."; return 0 ;;
+        
+          --debug) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --display-level) COMPREPLY=".INT.0-2."; return 0 ;;
+        
+          --block-name) COMPREPLY=".NAME."; return 0 ;;
+        
+          --filename) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
+        
+          --list-count) COMPREPLY=".INT.1-."; return 0 ;;
+        
+          --logged-stdout-filename-prefix) COMPREPLY=".PREFIX."; return 0 ;;
+        
+          --menu-blocks-with-docname) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --menu-blocks-with-headings) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --output-execution-summary) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --output-script) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --output-stdout) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --path) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
+        
+          --save-executed-script) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --save-execution-output) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --saved-script-chmod) COMPREPLY=".INT."; return 0 ;;
+        
+          --saved-script-filename-prefix) COMPREPLY=".PREFIX."; return 0 ;;
+        
+          --saved-script-folder) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
+        
+          --saved-script-glob) COMPREPLY=".GLOB."; return 0 ;;
+        
+          --saved-stdout-folder) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
+        
+          --saved-stdout-glob) COMPREPLY=".GLOB."; return 0 ;;
+        
+          --user-must-approve) COMPREPLY=".BOOL."; return 0 ;;
+        
+    esac
+  fi
+
+  # current word is unrecognized
+  # present matching directory or file names
+  #
   __filedirs
 }
 
-complete -o filenames -F _mde mde
+complete -o filenames -o nospace -F _mde mde
+# _mde_echo_version
+# echo "Updated: 2022-06-12 20:31:36 UTC"

data/bin/tab_completion.sh.erb

@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+
+__filedirs()
+{
+  local IFS=$'\n'
+  COMPREPLY=( $(compgen -o plusdirs -f -- "${cur}") )
+  # COMPREPLY=( $(compgen -d) $(compgen -f -- "${cur}") )
+}
+
+__filedirs_all()
+{
+  COMPREPLY='.'
+}
+
+_mde_echo_version() {
+  echo "<%= MarkdownExec::VERSION %>"
+}
+
+_mde() {
+  local cur prev opts
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  # printf '%s' "-;${prev}-:${cur}-"
+
+  # current word is an option type
+  # if previous word is an option name
+  #   stage 2: replace with option default value
+  #
+  if [[ "${cur}" =~ ^\..+\.$ ]] ; then
+    if [[ ${prev} == -* ]] ; then
+      case $prev in
+        <% svhs.each do |svh|
+          svn = svh[:long_name]
+          if svn && svh[:arg_name]
+            svn = '--' + svh[:long_name]
+            if svh[:compreply] == false
+              # nothing
+            elsif svh[:compreply].nil? %>
+              <%= svn + ') __filedirs_all; return 0 ;;' %>
+            <% elsif svh[:compreply].empty?
+              # nothing
+            else %>
+              <%= svn + ') COMPREPLY="' + svh[:compreply] + '"; return 0 ;;' %>
+            <% end
+          end
+        end %>
+      esac
+    fi
+  fi
+
+  # current word is an option name or start of
+  # present matching option names
+  #
+  if [[ ${cur} == -* ]] ; then
+    opts=<%= mde_tab_completions %>
+    COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
+
+    return 0
+  fi
+
+  # no current word
+  # if previous word is an option name
+  #   stage 1: present option type 
+  #
+  if [[ -z ${cur} ]] ; then
+    case $prev in
+      <% svhs.each do |svh|
+        svn = svh[:long_name]
+        if svn && svh[:arg_name]
+          svn = '--' + svh[:long_name] %>
+          <%= svn + ') COMPREPLY=".' + svh[:arg_name] + '."; return 0 ;;' %>
+        <% end
+      end %>
+    esac
+  fi
+
+  # current word is unrecognized
+  # present matching directory or file names
+  #
+  __filedirs
+}
+
+complete -o filenames -o nospace -F _mde mde
+# _mde_echo_version
+# echo "Updated: <%= Time.now.utc %>"

data/lib/colorize.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+# │0  │ to restore default    │
+# │   │ color                 │
+# ├───┼───────────────────────┤
+# │   │                       │
+# │1  │ for brighter colors   │
+# ├───┼───────────────────────┤
+# │   │                       │
+# │4  │ for underlined text   │
+# ├───┼───────────────────────┤
+# │   │                       │
+# │5  │ for flashing text
+class String
+  def black
+    "\033[30m#{self}\033[0m"
+  end
+
+  def red
+    "\033[31m#{self}\033[0m"
+  end
+
+  def bred
+    "\033[1;31m#{self}\033[0m"
+  end
+
+  def green
+    "\033[32m#{self}\033[0m"
+  end
+
+  def bgreen
+    "\033[1;32m#{self}\033[0m"
+  end
+
+  def yellow
+    "\033[33m#{self}\033[0m"
+  end
+
+  def byellow
+    "\033[1;33m#{self}\033[0m"
+  end
+
+  def blue
+    "\033[34m#{self}\033[0m"
+  end
+
+  def magenta
+    "\033[35m#{self}\033[0m"
+  end
+
+  def cyan
+    "\033[36m#{self}\033[0m"
+  end
+
+  def white
+    "\033[37m#{self}\033[0m"
+  end
+
+  def bwhite
+    "\033[1;37m#{self}\033[0m"
+  end
+end