markdown_exec 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34e8e9ff237ed338e50c0a03dfbb8c4bbd10e49f1f6ee54f54607ce19b96632
-  data.tar.gz: 54f0ce617360be38233ed974f2cb8d5656e1b9f7671ed9f2ac819c2d66843eb1
+  metadata.gz: 6f3c0e2ecc6da4fa81adc0876e9f37180204935fd1b666abccd7584145922d98
+  data.tar.gz: 74534fa3b85c76447dbca1affea96bb31c566826edb6484acfeb14af9ce24de7
 SHA512:
-  metadata.gz: e14f9203dd2c07b0b0fef5a71ebec355d1e1988c798bc0f5811bf6b97a0f8cd52066ff4dee2372c522248a920add287e3ac8567b3a68d7b885a3ec42266faa30
-  data.tar.gz: b843ddd2e4b7b1b8eda9b4eb19823a32f758a422e27f84a779372e22321f4b16ce3307f51abb45e7bdbf92d14311ceedd110a1999203ffcf03ccb0ffa8f93b7e
+  metadata.gz: 48c7a83d8bb1c00f947c87fc9de2c316371e538f7fb4637df0f0a58cb2385cb682e0ba65cdfd9e32f04ba5942022b50baa91dd20db17baa68162c8b531c35ab4
+  data.tar.gz: 1b343974fb86e0ff9a9775d50663ae37ccd3919d047cb9efa4291fd2d7b7fbd7b3f72325965949a11c4c999f2fba1167098452a4a52d1cd0dfd707fdabced800

data/.reek

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

data/.rubocop.yml

@@ -6,6 +6,9 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Lint/SafeNavigationChain:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -30,9 +33,24 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Minitest/MultipleAssertions:
+  Enabled: false
+ 
+Security/YAMLLoad:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
 Style/GlobalVars:
   Enabled: false
 
+Style/MixinUsage:
+  Enabled: false
+
 Style/MultilineBlockChain:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## [ToDo]
+`reek lib/markdown_exec.rb --config .reek`
 
 - user settings
 - hidden w , w/o () in names
@@ -34,9 +35,96 @@
 
 - [ ] 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
+- [ ] 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.0.1] - 2022-05-21
+- [ ] write named block, can be included
+- [ ] file type per block type
+- [ ] file name per block name or specified in quotes ("")
+- [ ] overwrite-rules for writing blocks
+- [ ] erase-rules for written blocks
+- [ ] files to create named at top of script to execute; written prior to start of script
+
+- [ ] tab completion example ascii demo
+
+- [ ] reorder help list
+
+- [ ] parameters or (env vars) in menu
+- [ ] config menu or read env vars
+- [ ] enable/disable script, output saving per file
+- [ ] keep values between runs so same env vars are not prompted
+- [ ] move menu data to required file
+
+- [ ] tab complation for short option names
+
+- [ ] option to list full menu
+
+- [ ] task confirmation block option or bash template, env names
+- [ ] decoration for menu heading items, template?
+- [ ] configuration block `mde_config` anywhere in file
+- [ ] configuration block `mde_config` anywhere in folder config file
+      ```yaml :(mde_config)```
+- [x] fix execution stdin, stdout to allow for ask function
+- [ ] fix execution stdin, stdout to allow for tty-prompt
+
+## [1.3.0] - 2022-07-16
+
+### Added
+
+- Short name `-p` for `--user-must-approve` option
+  Enable/disable pause for user to review and approve script
+- Automatic wrapping for data in blocks of yaml data eg ` ```yaml `
+  Data is written to the file named in the fenced block heading
+- Data transformations are embedded in the script at every invocation
+  with arguments to the transformation as stdin and stdout for the `yq` process
+  eg `export fruit_summary=$(yq e '[.fruit.name,.fruit.price]' fruit.yml)`
+  for invocation `%(summarize_fruits <fruit.yml >fruit_summary)`
+  and transformation `[.fruit.name,.fruit.price]`
+- Option to extract document text and display it as disabled items in-line with the blocks in the selection menu.
+  Add options for constants used in parsing.
+- [x] yaml processing
+    - ```yaml :(make_fruit_file) >fruit.yml```
+      write to: fruit.yml
+    - ```yq [summarize_fruits] +(make_fruit_file) <fruit.yml =color_price```
+      not included in linear script
+      read from: fruit.yml
+      result into var: color_price instead of stdout
+    - ```bash :show_fruit_yml +(summarize_fruits)```
+      include summarize_fruits
+      output value of var color_price
+
+### Changed
+
+- Refactoring
+    - Run-time menu in YAML file.
+    - Tap module initialization
+
+## [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
+
+- 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
 
@@ -53,14 +141,13 @@
 ### Changed
 
 - Exit option is at top of each menu.
-- Single-stage tab completion, defaut
+- 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.
-- Use 'bash' shell instead of default
 - Write STDOUT, STDERR, STDIN in sections to saved output file.
 
 ## [1.0.0] - 2022-04-26

data/Gemfile

@@ -7,6 +7,7 @@ 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.1.0)
+    markdown_exec (1.3.0)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -16,6 +16,7 @@ GEM
     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)
@@ -26,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)
@@ -69,6 +74,7 @@ DEPENDENCIES
   markdown_exec!
   minitest (~> 5.0)
   rake (~> 13.0)
+  reek
   rubocop (~> 1.21)
   rubocop-minitest
   rubocop-rake

data/README.md

@@ -49,7 +49,7 @@ Displays help information.
 
 #### `mde`
 
-Process `README.md` file in the current folder. Displays all the blocks in the file and allows you to select using [up], [down], and [return]. Press [ctrl]-c to abort selection.
+Process `README.md` file in the current folder. Displays all the blocks in the file and allows you to select using [up], [down], and [return].
 
 #### `mde my.md` or `mde -f my.md`
 
@@ -156,15 +156,28 @@ Append a command to load the completion script to your shell configuration file.
 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><TAB>`
+
+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,41 +203,35 @@ 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).
 
 # 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
+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/fareedst/markdown_exec/blob/master/CODE_OF_CONDUCT.md).
+
+
+``` :test_vars +(echo_vars)
+vars1=$(
+  echo '1'
+  whoami
+  echo '2'
+  pwd
+  echo '3'
+  stat README.md
+  echo '4'
+  /bin/ls
+  echo '5'
+  whoami
+  echo '6'
+)
+```
 
-echo "-1"
-echo $0
-echo 'AA'
-echo 'name? '
-read name
-echo 'type? '
-read type
-echo 'BB'
-echo "name: $name"
-echo "type: $type"
-echo 'CC'
+``` :(echo_vars)
+echo "vars1: ${vars1:-missing}"
 ```