markdown_exec 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 160eb660362db62302a05b8b46398c6d85357c917ee55eeb89a8ce0f739eec8a
-  data.tar.gz: 706e575c290ec56d34ad58f06ca9e30127b2c0bdacf431a4c9e3f69bc30e80dc
+  metadata.gz: e0c996cc59c02f9cfff6948467f4714bfb7e010ec61f886b9508b4af1a80dbc6
+  data.tar.gz: 9cd5bbe3d4b59c5d272ae42bd58ef228132a4af6471ee7d31867a69742c8b9ea
 SHA512:
-  metadata.gz: f540464a21a3ca2b654d89b3bc32f2172a3e610066bc64b9eae1bc29d99b8006ed3581998a50ae2327052c944656584375df55e64ffeeb77864ae05e45325e1c
-  data.tar.gz: a22c5ff757a2b5173725786bdbc399cae29f63eda891a0741149286391cb413abbcccd3799bd15ec769230ed44245b49664d434c77c12610bc2cfc138a9d3ddb
+  metadata.gz: d2a005d3d3d4550644d470ea734902fb3ba796de73d115a041dccbcdee85a675956427ee20e8a6fb68df91c8a5b96cc820458f61120e71ab64f568563145689a
+  data.tar.gz: 3eadd9f350b5138f808b7ce986f2b6a5b8f747c650788c36b7d46b1ed17eccde6b018862c1334e1277fe29a27f617fe08d44b45e2bed6f182888713df813c04f

data/.reek

@@ -11,7 +11,7 @@ detectors:
   ControlParameter:
     enabled: true
   DuplicateMethodCall:
-    enabled: true
+    enabled: false # too strict
   FeatureEnvy:
     enabled: false # too strict
   InstanceVariableAssumption:
@@ -22,3 +22,8 @@ detectors:
     enabled: true
   LongYieldList:
     enabled: true
+  TooManyStatements:
+    enabled: false # too strict
+
+exclude_paths:
+  - vendor/

data/.rubocop.yml

@@ -6,6 +6,12 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Lint/SafeNavigationChain:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -30,9 +36,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

@@ -7,8 +7,6 @@
 - hidden w , w/o () in names
 - fix regexp in pathnames
 
-- [ ] read file once to allow for tempdoc stream
-
 - tree display
 
 - [ ] mde options, user prompt, in md file or included file
@@ -39,6 +37,92 @@
 - [ ] ren logged_stdout_filename_prefix to saved_stdout_filename_prefix
 - [ ] ignore '#' in fenced code blocks
 
+- [ ] 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
+
+- [ ] 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
+
+- [ ] option to list full menu
+
+- [ ] task confirmation block option or bash template, env names
+
+- [ ] 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
+- [ ] accept stdin as filename `-`
+- [ ] fix
+        $ bin/mde
+        Choose a file: * Exit
+        No blocks found.
+        Choose a block: * Exit
+
+- [ ] accept `!` shell execute command at prompt
+- [ ] menu response: re-exec last saved script (like mde --select-recent-script)
+
+- [ ] process shebang in markdown
+- [ ] ignore shebang in markdown in rest of processing
+- [! ] search for document in path
+- [! ] search for document in custom path
+- [ ] doc use of `#!/usr/bin/env mde`
+- [ ] command to export each command to file, menu for list
+- [ ] list of fenced code blocks to ignore, eg ```expect or ```mermaid
+
+## [1.3.1] - 2022-10-29
+
+### Added
+
+- Delay to allow all command output to be received
+- Display an error message when the specified document file is missing
+- Options to display, format and colorize menu dividers and demarcations
+- Tab completion for short option names
+
+### Changed
+
+- Fix handling of document supplied by process substitution
+
+## [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
@@ -180,7 +264,7 @@ e.g. `MDE_OUTPUT_VIEWER_OPTIONS="-a '/Applications/Sublime Text.app'" mde --sele
 
 | YAML Name | Environment Variable | Default |
 | :--- | :--- | :--- |
-| block_name_excluded_match | MDE_BLOCK_NAME_EXCLUDED_MATCH  | `^\(.+\)$` |
+| block_name_hidden_match | MDE_BLOCK_NAME_HIDDEN_MATCH  | `^\(.+\)$` |
 | block_name_match | MDE_BLOCK_NAME_MATCH  | `:(?<title>\S+)( \|$)` |
 | block_required_scan | MDE_BLOCK_REQUIRED_SCAN  | `\+\S+` |
 | fenced_start_and_end_match | MDE_FENCED_START_AND_END_MATCH  | ``^`{3,}`` |

data/Gemfile

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# echo "gem: --no-document" >> ~/.gemrc
+# bundle install --path vendor/bundle
+
 source 'https://rubygems.org'
 
 gemspec
@@ -8,9 +11,11 @@ gem 'erb'
 gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'
 gem 'reek'
+# gem 'rspec'
 gem 'rubocop', '~> 1.21'
 gem 'rubocop-minitest', require: false
 gem 'rubocop-rake', require: false
+# gem 'rubocop-rspec', require: false
 gem 'shellwords'
 gem 'uri'
 gem 'yaml'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.2.0)
+    markdown_exec (1.3.1)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -12,16 +12,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    cgi (0.3.2)
+    cgi (0.3.3)
     clipboard (1.3.6)
     erb (2.2.3)
       cgi
+    json (2.6.2)
     kwalify (0.7.2)
-    minitest (5.15.0)
+    minitest (5.16.3)
     open3 (0.1.1)
     optparse (0.1.1)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
@@ -31,20 +32,21 @@ GEM
       kwalify (~> 0.7.0)
       parser (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rubocop (1.26.0)
+    rubocop (1.37.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.18.0)
+    rubocop-minitest (0.22.2)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -60,7 +62,7 @@ GEM
       tty-screen (~> 0.8)
       wisper (~> 2.0)
     tty-screen (0.8.1)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.3.0)
     uri (0.11.0)
     wisper (2.0.1)
     yaml (0.2.0)

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`
 
@@ -159,7 +159,7 @@ 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>`
+`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`.
@@ -171,7 +171,7 @@ Completions are calculated based on the current word and the prior word.
 
 In the table below, tab is indicated by `!`
 | Input | Completions |
-| :---: | :---: |
+| :--- | :--- |
 | `mde !` | local files and folders |
 | `mde -!` | all options |
 | `mde --!` | all options |
@@ -213,4 +213,81 @@ 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).
+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_vars)
+echo "vars1: ${vars1:-missing}"
+```
+
+```bash :test_quick
+cat README.md
+```
+
+- `echo "gem: --no-document" >> ~/.gemrc`
+
+- `bundle install --path vendor/bundle`
+
+```
+bundle exec rake test
+bundle exec rake rubocopminitest
+# bundle exec rake reek
+reek --config .reek .
+```
+
+```
+bundle exec rake build
+```
+includes Rake::Task['update_menu_yml'].execute
+         Rake::Task['update_tab_completion'].execute
+
+```
+bundle exec rake uninstall
+```
+
+```
+bundle exec rake install
+```
+
+```
+bundle exec rake publish
+```
+
+```
+bundle exec rake --tasks
+```
+```expect
+rake build                            # Build markdown_exec-1.3.0.9.gem into the pkg directory / gem build
+rake clean                            # Remove any temporary products / gem build clean
+rake clobber                          # Remove any generated files
+rake install                          # Build and install markdown_exec-1.3.0.9.gem into system gems / gem install
+rake install:local                    # Build and install markdown_exec-1.3.0.9.gem into system gems without network access
+rake publish                          # gem publish
+rake reek                             # reek
+rake release[remote]                  # Create tag v1.3.0.9 and build and push markdown_exec-1.3.0.9.gem to rubygems.org
+rake rubocop                          # Run RuboCop
+rake rubocop:autocorrect              # Autocorrect RuboCop offenses (only when it's safe)
+rake rubocop:autocorrect_all          # Autocorrect RuboCop offenses (safe and unsafe)
+rake rubocopminitest                  # named task because minitest not included in rubocop tests
+rake test                             # Run tests
+rake uninstall                        # gem uninstall
+rake update_installed_tab_completion  # update installed tab_completion.sh
+rake update_menu_yml                  # update menu.yml
+rake update_tab_completion            # update tab_completion.sh
+```