markdown_exec 1.3.8 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f61a046f9f071edb4e123fd5ad1972de408c4a40c97d923322e416f643f4ffb
-  data.tar.gz: 8d00be273b75ac093809cbc168e585d36da49a26fa0bdde6ee242d06a94c3caf
+  metadata.gz: 25d73d643251be40fcf14edd59a890d3d4fca847217b02c9ee6ad6fdbb06b72e
+  data.tar.gz: 8bde8d7e84230d50f34425fa3d549c9bbf7b78bb89219290a454547ba6a6b001
 SHA512:
-  metadata.gz: 054de96356ebb625db55bccb693e498abebf01ab7eeb44b28f6391c3fec3ca87b72970916cbc3ba4dca9088905206b47a33213c9ded81fa67458c47827ba7068
-  data.tar.gz: 642a9e511a013c4485eb187e4be1d22a6516686b8815de1c6b1c230790269612357e9635d0b7b078dbc8f334b1e2d2e06980af71330f3bf8c1a273861bf902f4
+  metadata.gz: 04fec544c21aac267c89868755a76cbc0f0565cc676ed3ed647ab9459c7308cf01a26572cb059a0aadc26c403067b3ead4fcd2ce5d05051320ee2aa2b8dee911
+  data.tar.gz: 3f6ffedbddbf9a15c3fa7c05b24f61367dbff5c717328a333b1cded39ebba13e18f333383f4d35786b565b8985f2433e683daadf01a89963a606471415a4a503

data/.pryrc

@@ -0,0 +1,11 @@
+if defined?(PryByebug)
+  Pry.config.pager = false
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 'f', 'finish'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+
+  Pry::Commands.command /^$/, 'repeat last command' do
+    _pry_.run_command Pry.history.to_a.last
+  end
+end

data/.rubocop.yml

@@ -15,7 +15,6 @@ Layout/LineContinuationLeadingSpace:
 
 Layout/LineLength:
   Max: 96
-  # Max: 120
 
 Lint/Debugger:
   Enabled: false
@@ -65,6 +64,9 @@ Style/DoubleNegation:
 Style/EmptyElse:
   Enabled: false
 
+Style/FormatStringToken:
+  Enabled: false
+
 Style/GlobalVars:
   Enabled: false
 
@@ -74,6 +76,18 @@ Style/MixinUsage:
 Style/MultilineBlockChain:
   Enabled: false
 
+Style/PerlBackrefs: # Prefer ::Regexp.last_match.post_match over $'.
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/Semicolon: # Do not use semicolons to terminate expressions.
+  Enabled: false
+
+Style/SingleLineMethods: # Avoid single-line method definitions.
+  Enabled: false
+
 Style/SlicingWithRange:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## [1.3.9] - 2023-10-29
+
+Add block types for linking and variable control
+
+Rename options to match use.
+
+### Added
+
+- Pass-through arguments after "--" to the executed script.
+  See document `examples/pass-through.md`.
+
+- Add RGB color specification to basic ANSI color names.
+  Foreground R, G, and B values are encoded in the name "fg_rgb_R_G_B" with their decimal values.
+  e.g. red = "fg_rgb_255_0_0"
+  e.g. green = "fg_rgb_0_255_0"
+  e.g. blue = "fg_rgb_0_0_255"
+
+- Add a "link" fenced code block type as a menu choice to load a different document.
+  The `link` block can specify:
+  - environment variables and values to set prior to loading the document,
+  - a block name to execute in the loaded document.
+  In the resulting menu, an automatic option (Back) allows the user to return to the original document.
+  See documents `examples/linked1.md`, `examples/linked2.md`.
+
+- Add an "opts" fenced code block type as a menu choice to set current MDE options.
+  See document `examples/opts.md`.
+
+- Add a "vars" fenced code block type as a menu choice to set current environment variables.
+  See document `examples/vars.md`.
+  These blocks can be hidden blocks and required in a script.
+
+- Add a "wrap" fenced code block type to facilitate script generation.
+  See document `examples/wrap.md`.
+  These blocks are hidden and can be required by one or more blocks.
+
+### Changed
+
+- Rename RegExp options to match use.
+
 ## [1.3.8] - 2023-10-20
 
 ### Added
@@ -230,8 +269,8 @@ e.g. `MDE_OUTPUT_VIEWER_OPTIONS="-a '/Applications/Sublime Text.app'" mde --sele
 | 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,}`` |
-| fenced_start_ex_match | MDE_FENCED_START_EX_MATCH  | ``^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$`` |
+| fenced_start_and_end_regex | MDE_FENCED_START_AND_END_REGEX  | ``^`{3,}`` |
+| fenced_start_extended_regex | MDE_FENCED_START_EXTENDED_REGEX  | ``^`{3,}(?<shell>[^`\s]*) *(?<name>.*)$`` |
 | heading1_match | MDE_HEADING1_MATCH  | `^# *(?<name>[^#]*?) *$` |
 | heading2_match | MDE_HEADING2_MATCH  | `^## *(?<name>[^#]*?) *$` |
 | heading3_match | MDE_HEADING3_MATCH  | `^### *(?<name>.+?) *$` |

data/Gemfile

@@ -8,6 +8,7 @@ source 'https://rubygems.org'
 gemspec
 gem 'clipboard'
 gem 'erb'
+gem 'mocha', require: false
 gem 'minitest', require: false
 gem 'pry-nav'
 gem 'pry-stack_explorer'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.3.8)
+    markdown_exec (1.4)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -54,6 +54,8 @@ GEM
       nokogiri (>= 1.12.0)
     method_source (1.0.0)
     minitest (5.20.0)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
     nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
     open3 (0.1.2)
@@ -138,6 +140,7 @@ GEM
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     shellwords (0.1.0)
     thor (1.2.2)
     tty-color (0.6.0)
@@ -166,6 +169,7 @@ DEPENDENCIES
   erb
   markdown_exec!
   minitest
+  mocha
   pry-nav
   pry-stack_explorer
   railties

data/Rakefile

@@ -81,7 +81,7 @@ task :minitest do
     './lib/cached_nested_file_reader.rb',
     './lib/fcb.rb',
     './lib/filter.rb',
-    './lib/markdown_block_manager.rb',
+    './lib/markdown_exec.rb',
     './lib/mdoc.rb',
     './lib/object_present.rb',
     './lib/option_value.rb',
@@ -91,12 +91,10 @@ task :minitest do
   ]
 
   commands.each do |command|
-    begin
-      raise "Failed: #{command}" unless system("bundle exec ruby #{command}")
-    rescue StandardError => e
-      puts "Error: #{e.message}"
-      exit 1
-    end
+    raise "Failed: #{command}" unless system("bundle exec ruby #{command}")
+  rescue StandardError => err
+    puts "Error: #{err.message}"
+    exit 1
   end
 end
 
@@ -105,6 +103,12 @@ task :reek do
   `reek --config .reek .`
 end
 
+desc 'test'
+task :test do
+  Rake::Task['minitest'].execute
+  system 'bundle exec rspec'
+end
+
 private
 
 # write menu.yml

data/bin/bmde

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+require 'bundler/setup'
+Bundler.require(:default)
+
+require_relative '../lib/markdown_exec'
+
+MarkdownExec::MarkParse.new.run

data/bin/colorize_env_vars.sh

@@ -0,0 +1,7 @@
+colorize_env_vars() {
+  echo -e "- \033[1;32m${1}\033[0m"
+  shift
+  for var_name in "$@"; do
+    echo -e "\033[0;33m${var_name}\033[0;31m:\033[0m ${!var_name}"
+  done
+}

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.3.8"
+  echo "1.4"
 }
 
 _mde() {
@@ -40,14 +40,6 @@ _mde() {
             
               -f) COMPREPLY="."; return 0 ;;
             
-              --path) COMPREPLY="."; return 0 ;;
-            
-              -p) COMPREPLY="."; return 0 ;;
-            
-              --user-must-approve) COMPREPLY="1"; return 0 ;;
-            
-              -q) COMPREPLY="1"; return 0 ;;
-            
               --list-count) COMPREPLY="32"; return 0 ;;
             
               --output-execution-summary) COMPREPLY="0"; return 0 ;;
@@ -56,6 +48,10 @@ _mde() {
             
               --output-stdout) COMPREPLY="1"; return 0 ;;
             
+              --path) COMPREPLY="."; return 0 ;;
+            
+              -p) COMPREPLY="."; return 0 ;;
+            
               --save-executed-script) COMPREPLY="0"; return 0 ;;
             
               --save-execution-output) COMPREPLY="0"; return 0 ;;
@@ -64,6 +60,10 @@ _mde() {
             
               --saved-stdout-folder) COMPREPLY="logs"; return 0 ;;
             
+              --user-must-approve) COMPREPLY="1"; return 0 ;;
+            
+              -q) COMPREPLY="1"; return 0 ;;
+            
               --display-level) COMPREPLY="1"; return 0 ;;
             
       esac
@@ -74,7 +74,7 @@ _mde() {
   # present matching option names
   #
   if [[ ${cur} == -* ]] ; then
-    opts=("--block-name" "--config" "--debug" "--filename" "--help" "--path" "--user-must-approve" "--version" "--exit" "--list-blocks" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--select-recent-output" "--select-recent-script" "--tab-completions" "--run-last-script" "--pwd" "--list-count" "--output-execution-summary" "--output-script" "--output-stdout" "--save-executed-script" "--save-execution-output" "--saved-script-folder" "--saved-stdout-folder" "--display-level")
+    opts=("--block-name" "--config" "--debug" "--exit" "--filename" "--help" "--list-blocks" "--list-count" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--pwd" "--run-last-script" "--save-executed-script" "--save-execution-output" "--saved-script-folder" "--saved-stdout-folder" "--select-recent-output" "--select-recent-script" "--tab-completions" "--user-must-approve" "--version" "--display-level")
     COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
 
     return 0
@@ -101,14 +101,6 @@ _mde() {
         
           -f) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
         
-          --path) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
-        
-          -p) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
-        
-          --user-must-approve) COMPREPLY=".BOOL."; return 0 ;;
-        
-          -q) COMPREPLY=".BOOL."; return 0 ;;
-        
           --list-count) COMPREPLY=".INT.1-."; return 0 ;;
         
           --output-execution-summary) COMPREPLY=".BOOL."; return 0 ;;
@@ -117,6 +109,10 @@ _mde() {
         
           --output-stdout) COMPREPLY=".BOOL."; return 0 ;;
         
+          --path) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
+        
+          -p) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
+        
           --save-executed-script) COMPREPLY=".BOOL."; return 0 ;;
         
           --save-execution-output) COMPREPLY=".BOOL."; return 0 ;;
@@ -125,6 +121,10 @@ _mde() {
         
           --saved-stdout-folder) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
         
+          --user-must-approve) COMPREPLY=".BOOL."; return 0 ;;
+        
+          -q) COMPREPLY=".BOOL."; return 0 ;;
+        
           --display-level) COMPREPLY=".INT.0-3."; return 0 ;;
         
     esac
@@ -138,4 +138,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2023-10-20 23:59:34 UTC"
+# echo "Updated: 2023-10-31 15:43:43 UTC"

data/examples/duplicate_block.md

@@ -0,0 +1,10 @@
+```bash :a
+01
+```
+```bash :a
+02
+```
+```bash :a
+03
+```
+

data/examples/import0.md

@@ -0,0 +1,8 @@
+```bash :01
+01
+```
+@import import1.md
+```bash :03
+03
+```
+

data/examples/import1.md

@@ -0,0 +1,10 @@
+```bash :11
+11
+```
+```bash :12
+12
+```
+```bash:13
+13
+```
+

data/examples/include.md

@@ -0,0 +1,12 @@
+```bash :(one)
+a
+```
+```bash :two +(one)
+b
+```
+```bash :(three) +two +(one)
+c
+```
+```bash :four +(three)
+d
+```

data/examples/infile_config.md

@@ -0,0 +1,10 @@
+```yaml :(mde_config)
+display_level: -1 # invalid value, use only for testing
+menu_divider_match: "^::: +(?<name>.+?)$"
+menu_divider_format: "=> %s <="
+```
+
+::: :divider 1
+
+```bash :placeholder
+```

data/examples/linked1.md

@@ -0,0 +1,28 @@
+# Demo document linking
+
+::: * This is document 1 *
+::: This document links to a matching document to demonstrate navigation between documents.
+
+::: This Bash block displays the value of variables "page1_var_via_environment" and "page2_var_via_environment"
+
+```bash :show_vars
+source bin/colorize_env_vars.sh
+colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
+colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
+```
+
+::: This Link block
+::: 1. requires a block that sets environment variable PAGE2_VAR_VIA_INHERIT,
+::: 2. navigates to document 2, and
+::: 3. executes block "show_vars" to display the imported PAGE2_VAR_VIA_INHERIT.
+
+```bash :(vars2)
+PAGE2_VAR_VIA_INHERIT=for_page2_from_page1_via_inherited_code_file
+```
+
+```link :linked2_import_vars +(vars2)
+file: examples/linked2.md
+block: show_vars
+vars:
+  page2_var_via_environment: for_page2_from_page1_via_current_environment
+```

data/examples/linked2.md

@@ -0,0 +1,29 @@
+# Demo document linking
+
+::: * This is document 2 *
+::: This document links to a matching document to demonstrate navigation between documents.
+
+::: This Bash block displays the value of variables "page1_var_via_environment" and "page2_var_via_environment"
+
+```bash :show_vars
+source bin/colorize_env_vars.sh
+colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
+colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
+```
+
+
+::: This Link block requires a block that
+::: 1. sets environment variable PAGE3_VAR_VIA_INHERIT,
+::: 2. navigates to document 3, and
+::: 3. executes block "show_vars" to display the imported PAGE3_VAR_VIA_INHERIT.
+
+```bash :(vars3)
+PAGE3_VAR_VIA_INHERIT=for_page3_from_page2_via_inherited_code_file
+```
+
+```link :linked3_import_vars +(vars3)
+file: examples/linked3.md
+block: show_vars
+vars:
+  page3_var_via_environment: for_page3_from_page2_via_current_environment
+```

data/examples/linked3.md

@@ -0,0 +1,12 @@
+# Demo document linking
+
+::: * This is document 3 *
+::: This document is linked from another document to demonstrate code transfer.
+
+::: This Bash block displays the value of variables "PAGE3_VAR_VIA_INHERIT" and "page3_var_via_environment"
+
+```bash :show_vars
+source bin/colorize_env_vars.sh
+colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
+colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
+```

data/examples/opts.md

@@ -0,0 +1,13 @@
+# Demo configuring options
+
+::: These Opts blocks set the color of a couple of menu options to demonstrate the live update of options.
+
+```opts :opts1
+menu_divider_color: yellow
+menu_task_color: fg_rgb_255_63_255
+```
+
+```opts :opts2
+menu_divider_color: fg_rgb_255_0_255
+menu_task_color: fg_rgb_127_127_255
+```

data/examples/pass-through.md

@@ -0,0 +1,14 @@
+Pass-through arguments after "--" to the executed script.
+
+A block can expect arguments to receive all arguments to MDE after "--".
+
+For `mde examples/pass-through.md output_arguments -- 123`,
+this block outputs:
+
+        ARGS: 123
+
+::: This block will output any arguments after "--" in the command line.
+
+```bash :output_arguments
+echo "ARGS: $*"
+```

data/examples/plant.md

@@ -0,0 +1,23 @@
+::: Nourish
+
+[ ] Observe soil moisture level
+
+```bash :Watering_the_plant
+echo glug glug glug
+```
+
+::: Maintain
+
+[ ] Observe leaf color and health
+
+```bash :Trimming_dead_or_yellowing_leaves
+echo snip snip
+```
+
+::: Release
+
+[ ] Observe flowering and fruiting patterns
+
+```bash :Repotting_when_necessary
+echo farewell
+```

data/examples/port.md

@@ -0,0 +1,23 @@
+# Demo variable porting
+
+::: This block requires the Port block and displays the value.
+::: The Port block contributes the variable VAULT to the generated script.
+
+```bash :show +(vault)
+: ${VAULT:=This variable has not been set.}
+source bin/colorize_env_vars.sh
+colorize_env_vars '' VAULT
+```
+
+::: Set the VAULT value in memory.
+::: Call this block prior to `show` to demonstrate in-memory value being written to script.
+
+```vars :set
+VAULT: This variable was set by the "set" block.
+```
+
+::: There is an invisible Port block that saves current/live environment variable values into the generated script.
+
+```port :(vault)
+VAULT
+```

data/examples/vars.md

@@ -0,0 +1,20 @@
+```bash :(defaults)
+: ${VAULT:=default}
+```
+```bash :show_vars +(defaults)
+source bin/colorize_env_vars.sh
+colorize_env_vars '' VAULT
+```
+```vars :set
+VAULT: 11
+```
+```vars :set_with_show +show_vars
+VAULT: 22
+```
+```bash :(hidden)
+colorize_env_vars '' NOTHING
+```
+```bash :show_with_set +set
+source bin/colorize_env_vars.sh
+colorize_env_vars '' VAULT
+```

data/examples/wrap.md

@@ -0,0 +1,33 @@
+# Demo block wrapping
+
+::: This block is wrapped by the `{outer*}` pair of blocks.
+
+```bash :single +{outer}
+echo single body - wrapped by outer
+```
+
+::: This block is wrapped first by the `{outer*}` pair of blocks
+::: and nested inside, the `{inner*}` pair of blocks.
+
+```bash :nested +{outer} +{inner}
+echo nested body - wrapped by outer and then inner
+```
+
+::: This pair of hidden blocks are the `{inner*}` set.
+```bash :{inner}
+echo inner-before
+```
+
+```bash :{inner-after}
+echo inner-after
+```
+
+::: This pair of hidden blocks are the `{outer*}` set.
+
+```bash :{outer}
+echo outer-before
+```
+
+```bash :{outer-after}
+echo outer-after
+```

data/lib/block_types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+BLOCK_TYPE_BASH = 'bash'
+BLOCK_TYPE_LINK = 'link'
+BLOCK_TYPE_OPTS = 'opts'
+BLOCK_TYPE_PORT = 'port'
+BLOCK_TYPE_VARS = 'vars'

data/lib/cached_nested_file_reader.rb

@@ -69,7 +69,6 @@ if $PROGRAM_NAME == __FILE__
       @file1 = Tempfile.new('test1.txt')
       @file1.write("Line1\nLine2\n #insert #{@file2.path}\nLine3")
       @file1.rewind
-      # binding.pry
       @reader = CachedNestedFileReader.new(import_pattern: /^ *#insert (.+)$/)
     end