markdown_exec 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f3c0e2ecc6da4fa81adc0876e9f37180204935fd1b666abccd7584145922d98
-  data.tar.gz: 74534fa3b85c76447dbca1affea96bb31c566826edb6484acfeb14af9ce24de7
+  metadata.gz: 4350ee3346d6295cea603ec3602ce13c3cff3ebe83ff766c873141bebd28dca6
+  data.tar.gz: 57f150a38020be6404bdf140755c7328f70417f1fd98286c2974492d085707c0
 SHA512:
-  metadata.gz: 48c7a83d8bb1c00f947c87fc9de2c316371e538f7fb4637df0f0a58cb2385cb682e0ba65cdfd9e32f04ba5942022b50baa91dd20db17baa68162c8b531c35ab4
-  data.tar.gz: 1b343974fb86e0ff9a9775d50663ae37ccd3919d047cb9efa4291fd2d7b7fbd7b3f72325965949a11c4c999f2fba1167098452a4a52d1cd0dfd707fdabced800
+  metadata.gz: 4a412d4bf068a09371989336b50e82822e142fa27ee45c2d578a0d40834e74a618fbe968a26e10640a127c0c1078ecb1a65798bb19c7b171cfc07f11b08e03f3
+  data.tar.gz: e6df4504a02de72dcf40b07acc39cb24752916511217354d485502183469ac061ab841d7fdfbe30e63ffa93cd87c403ec619678998b17adce7e7b68bef87eb2d

data/.reek

@@ -24,3 +24,6 @@ detectors:
     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
+
+Layout/LineContinuationLeadingSpace:
+  Enabled: false
+
 Lint/SafeNavigationChain:
   Enabled: false
 
@@ -35,7 +41,16 @@ Metrics/PerceivedComplexity:
 
 Minitest/MultipleAssertions:
   Enabled: false
- 
+
+# RSpec/AnyInstance:
+#   Enabled: false
+
+# RSpec/MultipleExpectations:
+#   Enabled: true
+
+# RSpec/StubbedMock:
+#   Enabled: false
+
 Security/YAMLLoad:
   Enabled: false
 
@@ -54,6 +69,9 @@ Style/MixinUsage:
 Style/MultilineBlockChain:
   Enabled: false
 
+Style/SlicingWithRange:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes

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
@@ -48,25 +46,57 @@
 
 - [ ] 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
+- [ ] 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.2] - 2022-11-12
+
+### Added
+
+- Add EnvOpts class
+- RSpec for internal classes
+
+## [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
 
@@ -241,7 +271,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.3.0)
+    markdown_exec (1.3.2)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -12,16 +12,18 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    cgi (0.3.2)
+    cgi (0.3.3)
     clipboard (1.3.6)
+    diff-lcs (1.5.0)
     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,23 +33,39 @@ 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)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.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)
+    rubocop-rspec (2.14.2)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     shellwords (0.1.0)
     tty-color (0.6.0)
@@ -60,7 +78,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)
@@ -75,9 +93,11 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   reek
+  rspec
   rubocop (~> 1.21)
   rubocop-minitest
   rubocop-rake
+  rubocop-rspec
   shellwords
   uri
   yaml

data/README.md

@@ -235,3 +235,63 @@ vars1=$(
 ``` :(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
+```
+
+- add git version tag
+
+- push to remote origin
+
+```
+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
+```