markdown_exec 0.2.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8baa6b01b9d965c3a8856d08a86225457c09106c366ecd174f7f0e547f43f4a
-  data.tar.gz: bd0348f31ddb1bb0cda0328e5c7dd3187e6692269e8b132849833ce1d44f5b0f
+  metadata.gz: 0f8bb9f8a7a903a6b221ed8d04a5acb445e294be4c134202b9a71ba9e9f7c7ac
+  data.tar.gz: d26a89ae33f1aeaac70b40f3e31b3090fb50c6eb48874eeba435ce89825123fc
 SHA512:
-  metadata.gz: e6f8028d4fe4dea45bacb14e8cb12306d0ee975ac729c04d0f8db990a6ce92758b13400329358656d5902c85dd5411aef717210b0151de4ae2cec375f51b0b98
-  data.tar.gz: 390dd965fe49ab4ac1651996fc7500ff971fbe71ce580ff807d8652b62aff5b50768ce971920e9f93682d5adb692cd5bcf99834b8b022c41734dc24f61cf940c
+  metadata.gz: f177057c231ef950012abc922b6c3d9611e0b423df57cee07e6ac0e68864c18ce9b6a7cf640e165dbd8409d6ecefb199a3bb31643a7c5e31d5c241f17682545e
+  data.tar.gz: 9fb1a5d4274d2443e1ed9680978cfb12c76b46416a3ba76483addd19b61238446dce86793a039cfede131bdd11a4436ae693640ad279add82e24415a544b7b53

data/CHANGELOG.md

@@ -2,31 +2,97 @@
 
 ## [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
+
+- [ ] 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
+
+- [ ] import yaml, json data into environment
 
-- include blocks from local md file
+- [ ] yq filter with imported or named yaml, json data
 
-- chmod a+x logged 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
+
+## [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
+
+- 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
+
+### 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
 
-- add shebang to saved script
+- File names for saved scripts.
+- Hide blocks with empty names, e.g. `:()`.
 
 ## [0.2.6] - 2022-04-07
 
 ### Changed
 
-- Fixed default values for command line options.
+- Default values for command line options.
 
 ## [0.2.5] - 2022-04-03
 

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 'mrdialog', '~> 1.0.3'
+gem 'rake', '~> 13.0'
 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,9 @@
 PATH
   remote: .
   specs:
-    markdown_exec (0.2.5)
+    markdown_exec (1.1.1)
+      clipboard (~> 1.3.6)
+      mrdialog (~> 1.0.3)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
@@ -11,7 +13,12 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    cgi (0.3.2)
+    clipboard (1.3.6)
+    erb (2.2.3)
+      cgi
     minitest (5.15.0)
+    mrdialog (1.0.3)
     open3 (0.1.1)
     optparse (0.1.1)
     parallel (1.21.0)
@@ -39,6 +46,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 +58,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 +66,18 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  clipboard
+  erb
   markdown_exec!
   minitest (~> 5.0)
+  mrdialog (~> 1.0.3)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-minitest
   rubocop-rake
+  shellwords
+  uri
+  yaml
 
 BUNDLED WITH
    2.2.32

data/README.md

@@ -55,6 +55,10 @@ Process `README.md` file in the current folder. Displays all the blocks in the f
 
 Select a block to execute from `my.md`.
 
+#### `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.
@@ -142,7 +146,40 @@ Boolean options configured with environment variables:
 - Specify variable on command line.
   e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`
 
-# Example blocks
+## Tab Completion
+
+### Install tab completion
+
+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
+
+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
 
 When prompted, select either the `awake` or `asleep` block.
 
@@ -166,17 +203,6 @@ 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/Rakefile

@@ -2,6 +2,10 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'erb'
+require 'yaml'
+
+require_relative 'lib/shared'
 
 Rake::TestTask.new(:test) do |task|
   task.libs << 'test'
@@ -12,7 +16,7 @@ end
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |task|
-  # task.requires << 'rubocop-minitest'
+  task.requires << 'rubocop-minitest'
 end
 
 desc 'named task because minitest not included in rubocop tests'
@@ -50,3 +54,33 @@ desc 'gem build clean'
 task :clean do
   system 'rm *.gem'
 end
+
+private
+
+BF = 'bin'
+
+def update_tab_completion(target)
+  words = `#{File.join BF, MarkdownExec::BIN_NAME} --tab-completions`.split("\n")
+  mde_tab_completions = '(' + (words.map { |s| "\"#{s}\"" }).join(' ') + ')'
+  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

@@ -0,0 +1,143 @@
+#!/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 "1.1.1"
+}
+
+_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
+        
+              --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 ;;
+            
+              --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
+    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" "--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 ;;
+        
+          --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 -o nospace -F _mde mde
+# _mde_echo_version
+# echo "Updated: 2022-05-26 01:40:10 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/markdown_exec/version.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module MarkdownExec
-  APP_NAME = 'MDE'
   APP_DESC = 'Markdown Executor'
+  APP_NAME = 'MDE'
+  BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
-  VERSION = '0.2.6'
+  VERSION = '1.1.1'
 end