markdown_exec 0.2.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95d097cfcf93e09ba3bf487989923d4be03dd9fde0521854ea0660850b157d01
-  data.tar.gz: 22bc0e8bc8cd35d0d1dd52b6275c1609fb4cb95d69bd125064f0ca16f2f931f7
+  metadata.gz: d34e8e9ff237ed338e50c0a03dfbb8c4bbd10e49f1f6ee54f54607ce19b96632
+  data.tar.gz: 54f0ce617360be38233ed974f2cb8d5656e1b9f7671ed9f2ac819c2d66843eb1
 SHA512:
-  metadata.gz: 591c09a221c0f5a34f8523d99d8e416bb022219fee38a7a05e3541600b03132e5ae3cc6aee02048eda2170a408d9e86090dedadff7c16f1f79ea98469826c27a
-  data.tar.gz: 74a76b6a6b10b165f8e79e59d25db78bcba173d730fd1a696e73c2012794bcfedd7c1b648cabe6b15d4d0a70995e5303b02c58d0b16c35a03ffbfea0b4efc5f4
+  metadata.gz: e14f9203dd2c07b0b0fef5a71ebec355d1e1988c798bc0f5811bf6b97a0f8cd52066ff4dee2372c522248a920add287e3ac8567b3a68d7b885a3ec42266faa30
+  data.tar.gz: b843ddd2e4b7b1b8eda9b4eb19823a32f758a422e27f84a779372e22321f4b16ce3307f51abb45e7bdbf92d14311ceedd110a1999203ffcf03ccb0ffa8f93b7e

data/CHANGELOG.md

@@ -2,27 +2,89 @@
 
 ## [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
+
+- [ ] yq filter with imported or named yaml, json data
+
+- [ ] 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 output mixed stdin, stdout, stderr; labels: prefix and blocks
+
+## [1.0.1] - 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
 
-- include blocks from local md file
+- Exit option is at top of each menu.
+- Single-stage tab completion, defaut
+    - 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.
+- Use 'bash' shell instead of default
+- Write STDOUT, STDERR, STDIN in sections to saved output file.
+
+## [1.0.0] - 2022-04-26
+
+### Added
 
-- chmod a+x logged script
+- 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
 
-- add shebang to saved script
+- Default values for command line options.
 
-## [0.2.5] - 2022-04
+## [0.2.5] - 2022-04-03
 
 ### Added
 

data/Gemfile

@@ -2,13 +2,14 @@
 
 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 '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 (0.2.5)
+    markdown_exec (1.1.0)
+      clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
       tty-prompt (~> 0.23.1)
@@ -11,6 +12,10 @@ 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)
     open3 (0.1.1)
     optparse (0.1.1)
@@ -39,6 +44,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 +56,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 +64,17 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  clipboard
+  erb
   markdown_exec!
   minitest (~> 5.0)
   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,27 @@ 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
+```
+
+### 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 --`
+
+## Example Blocks
 
 When prompted, select either the `awake` or `asleep` block.
 
@@ -166,17 +190,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).
@@ -184,3 +197,34 @@ The gem is available as open source under the terms of the [MIT License](https:/
 # Code of Conduct
 
 Everyone interacting in the MarkdownExec project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/markdown_exec/blob/master/CODE_OF_CONDUCT.md).
+
+###
+i made a tool to help me execute shell commands for ansible, aws, etc.
+
+normally the scripts have a base configuration followed by one or more blocks of commands that must be executed with the base configuration.
+
+by storing the shell scripts in a markdown file, there is room for both code and explanatory text. the tool provides the interface that names all the code blocks in the file and allows the the user to select and preview the code to execute.
+
+i use it regularly to manage deployment processes that require dozens of steps with ease and re-playablity.
+
+the gem is hosted at `https://github.com/fareedst/markdown_exec`.
+
+please install the Ruby gem with `gem install markdown_exec` and let me know how the installation goes for you. i would like to see if your current deployment scripts can fit into this model.
+
+```bash :test1
+files="$(ls -A .)"
+PS3='?'
+select filename in ${files}; do echo "You selected ${filename}"; break; done
+
+echo "-1"
+echo $0
+echo 'AA'
+echo 'name? '
+read name
+echo 'type? '
+read type
+echo 'BB'
+echo "name: $name"
+echo "type: $type"
+echo 'CC'
+```

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.0"
+}
+
+_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-21 16:42: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.5'
+  VERSION = '1.1.0'
 end