markdown_exec 1.8.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb4c6a799eb433c1df5b2a5b9969757bc7073bcd8ce410a341f8714dc4dd5dd
-  data.tar.gz: 385a8fe67c4cb460b43ae1263c7643d819fe5c236e572e3d3a6c04f26fb64666
+  metadata.gz: 9bab8478298e4304b710d35a6c5c0d931635678d038a4a16f4714f9347f38aa6
+  data.tar.gz: 2a57f5bc25681718a5c23ec313a8c8767209d1422431348e310d311524e5d66c
 SHA512:
-  metadata.gz: 658083cad39ed6e9e2caf0243b9aa2d33d9c8b881ed370938cee3f062ba4d9f2fa4f940de7d1dfe2066c0afe285c562f1caefef367d18eacfa4a9d295061f0fb
-  data.tar.gz: 244c774edf797545ad63326caa39014b23cf3ed53622cdffcd2d37d37012be972ae3f538b619f6895c3ae72fcd80cafd0b9e9428bbd20788bb267307e5168a8d
+  metadata.gz: c6c4fcb0963a71d89968ff195bb963e31d4f887a7f97d524aeea29bcad5e359e698b89928d00f85cf6ad7cd99d768f2a7152a086fb32abf91e3477751b0979ba
+  data.tar.gz: 85631dcaa941169ae08527a2d2f185a82b5a296337aa78e2f50994f7cf2ecaa69966d4a647cafc7c772abd97f0ddc2fc7b2ff0ef298e30f6ff2f46d28eb12d12

data/.rubocop.yml

@@ -13,7 +13,8 @@ Layout/LeadingCommentSpace:
 Layout/LineContinuationLeadingSpace:
   Enabled: false
 
-Layout/LineLength:
+Layout/LineLength:  # 2024-01-21 temp disable
+  Enabled: false
   Max: 96
 
 Lint/Debugger:
@@ -58,6 +59,9 @@ Security/YAMLLoad:
 Style/CommentedKeyword:
   Enabled: false
 
+Style/Documentation:  # 2024-01-21 temp disable
+  Enabled: false
+
 Style/DoubleNegation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [2.0.0] - 2024-02-07
+
+### Added
+
+- Process format and glob to load, save script code.
+
+- Provide ENV and batch variables to formatting function.
+
+- Find files matching glob and present for user selection.
+
+- Allow for entry of new file name when saving.
+
+## [1.8.9] - 2024-01-20
+
+### Added
+
+- Variables set in inherited lines for use in scripts.
+
+- Link key `save` to write inherited lines to disk.
+
 ## [1.8.8] - 2024-01-15
 
 ### Added

data/Gemfile

@@ -9,7 +9,7 @@ gemspec
 gem 'clipboard'
 gem 'debug'
 gem 'erb'
-gem 'httparty' # 2024-01-01 for ChatGPI API
+# gem 'httparty' # 2024-01-01 for ChatGPI API
 gem 'irb', '>= 1.8.0'
 gem 'mocha', require: false
 gem 'minitest', require: false
@@ -24,5 +24,6 @@ gem 'rubocop-minitest', require: false
 gem 'rubocop-rake', require: false
 gem 'rubocop-rspec', require: false
 gem 'shellwords'
-gem 'uri'
+# gem 'tty-file'
+gem 'uri', '0.12.2'
 gem 'yaml', '~> 0.2.1'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.8.8)
+    markdown_exec (2.0.0)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -47,9 +47,6 @@ GEM
     erb (4.0.3)
       cgi (>= 0.3.3)
     erubi (1.12.0)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     io-console (0.7.1)
@@ -63,11 +60,9 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     method_source (1.0.0)
-    mini_mime (1.1.5)
     minitest (5.20.0)
     mocha (2.1.0)
       ruby2_keywords (>= 0.0.5)
-    multi_xml (0.6.0)
     nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
     open3 (0.1.2)
@@ -187,7 +182,6 @@ DEPENDENCIES
   clipboard
   debug
   erb
-  httparty
   irb (>= 1.8.0)
   markdown_exec!
   minitest
@@ -203,7 +197,7 @@ DEPENDENCIES
   rubocop-rake
   rubocop-rspec
   shellwords
-  uri
+  uri (= 0.12.2)
   yaml (~> 0.2.1)
 
 BUNDLED WITH

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.8.8"
+  echo "2.0.0"
 }
 
 _mde() {
@@ -40,6 +40,10 @@ _mde() {
             
               --dump-blocks-in-file) COMPREPLY="0"; return 0 ;;
             
+              --dump-dump-inherited-block_names) COMPREPLY="0"; return 0 ;;
+            
+              --dump-dump-inherited-dependencies) COMPREPLY="0"; return 0 ;;
+            
               --dump-dump-inherited-lines) COMPREPLY="0"; return 0 ;;
             
               --dump-menu-blocks) COMPREPLY="0"; return 0 ;;
@@ -94,7 +98,7 @@ _mde() {
   # present matching option names
   #
   if [[ ${cur} == -* ]] ; then
-    opts=("--block-name" "--config" "--debug" "--dump-dump-delegate-object" "--dump-blocks-in-file" "--dump-dump-inherited-lines" "--dump-menu-blocks" "--dump-selected-block" "--exit" "--filename" "--find" "--find-path" "--help" "--how" "--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")
+    opts=("--block-name" "--config" "--debug" "--dump-dump-delegate-object" "--dump-blocks-in-file" "--dump-dump-inherited-block_names" "--dump-dump-inherited-dependencies" "--dump-dump-inherited-lines" "--dump-menu-blocks" "--dump-selected-block" "--exit" "--filename" "--find" "--find-path" "--help" "--how" "--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
@@ -121,6 +125,10 @@ _mde() {
         
           --dump-blocks-in-file) COMPREPLY=".BOOL."; return 0 ;;
         
+          --dump-dump-inherited-block_names) COMPREPLY=".BOOL."; return 0 ;;
+        
+          --dump-dump-inherited-dependencies) COMPREPLY=".BOOL."; return 0 ;;
+        
           --dump-dump-inherited-lines) COMPREPLY=".BOOL."; return 0 ;;
         
           --dump-menu-blocks) COMPREPLY=".BOOL."; return 0 ;;
@@ -178,4 +186,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2024-01-18 17:32:47 UTC"
+# echo "Updated: 2024-02-08 17:51:16 UTC"

data/examples/colors.md

@@ -4,23 +4,45 @@
 
 <https://en.wikipedia.org/wiki/Complementary_colors#/media/File:RGB_color_wheel.svg>
 
-ff0000 red - exception text
-ff7f00 orange - warning text
-ffff00 yellow - notification text
-7fff00 chartreuse green - output frame
-00ff00 green - prompt
-00ff7f spring green - input frame
-00ffff cyan - menu text
-007fff azure - menu frame
-0000ff blue
-7f00ff violet - opts frame
-ff00ff magenta - opts text
-ff007f rose - exception frame
+/ ff0000 red - exception text
+/ ff7f00 orange - warning text
+/ ffff00 yellow - notification text
+/ 7fff00 chartreuse green - output frame
+/ 00ff00 green - prompt
+/ 00ff7f spring green - input frame
+/ 00ffff cyan - menu text
+/ 007fff azure - menu frame
+/ 0000ff blue
+/ 7f00ff violet - opts frame
+/ ff00ff magenta - opts text
+/ ff007f rose - exception frame
 
 ```opts :(document_options)
 ```
 
 ```opts :load_colors
+exception_color_detail: fg_rgbh_1f_00_7f
+exception_color_name: fg_rgbh_1f_00_00
+execution_report_preview_frame_color: fg_rgbh_7f_1f_00
+menu_bash_color: fg_rgbh_00_c0_c0
+menu_chrome_color: fg_rgbh_40_c0_c0
+menu_divider_color: fg_rgbh_80_d0_c0
+menu_link_color: fg_rgbh_e0_e0_20
+menu_note_color: fg_rgbh_b0_b0_b0
+menu_opts_color: fg_rgbh_1f_00_1f
+menu_opts_set_color: fg_rgbh_7f_00_1f
+menu_task_color: fg_rgbh_1f_1f_1f
+menu_vars_color: fg_rgbh_1f_a0_1f
+menu_vars_set_color: fg_rgbh_00_1f_1f
+output_execution_label_name_color: fg_rgbh_00_1f_00
+output_execution_label_value_color: fg_rgbh_00_1f_00
+prompt_color_after_script_execution: fg_rgbh_00_1f_00
+script_execution_frame_color: fg_rgbh_00_1f_7f
+script_preview_frame_color: fg_rgbh_7f_1f_00
+warning_color: fg_rgbh_1f_7f_00
+```
+
+```opts :load_colors2
 exception_color_detail: fg_rgbh_ff_00_7f
 exception_color_name: fg_rgbh_ff_00_00
 execution_report_preview_frame_color: fg_rgbh_7f_ff_00
@@ -57,10 +79,10 @@ warning_color: fg_rgbh_ff_7f_00
 ```
 [ ] Task1
 
-blue;    fg_rgbh_00_00_FF
-green;   fg_rgbh_00_FF_00
-indigo;  fg_rgbh_4B_00_82
-orange;  fg_rgbh_FF_7F_00
-red;     fg_rgbh_FF_00_00
-violet;  fg_rgbh_94_00_D3
-yellow;  fg_rgbh_FF_FF_00
+/ blue;    fg_rgbh_00_00_FF
+/ green;   fg_rgbh_00_FF_00
+/ indigo;  fg_rgbh_4B_00_82
+/ orange;  fg_rgbh_FF_7F_00
+/ red;     fg_rgbh_FF_00_00
+/ violet;  fg_rgbh_94_00_D3
+/ yellow;  fg_rgbh_FF_FF_00

data/examples/document_options.md

@@ -0,0 +1,8 @@
+This document demonstrates the automatic loading of options in a block with a reserved name.
+
+```opts :(document_options)
+menu_divider_format: "=> %{line} == %{line} <="
+```
+
+The divider below is named "Divider #1". Notice the "(document_options)" block sets the "menu_divider_format" option to duplicate the divider name when it is displayed.
+::: Divider #1

data/examples/duplicate_block.md

@@ -1,10 +1,7 @@
-```bash :a
-01
+Executing either of these blocks outputs the same two lines.
+```bash :duplicate_name
+echo from duplicate name, block 1
 ```
-```bash :a
-02
+```bash :duplicate_name
+echo from duplicate name, block 2
 ```
-```bash :a
-03
-```
-

data/examples/import0.md

@@ -1,10 +1,8 @@
-This is Page 0
+This is Page 0. It serves to demonstrate how options control the display of imported blocks and notes.
 
-@import import1.md
+::: "import1.md" is imported here.
 
-```opts :(document_options)
-user_must_approve: true
-```
+@import import1.md
 
 ::: Page 0 code blocks
 

data/examples/import1.md

@@ -1,4 +1,4 @@
-This is Page 1
+This is Page 1. It is imported by Page 0.
 
 ::: Page 1 code blocks
 

data/examples/include.md

@@ -1,19 +1,25 @@
-```bash :(one)
-echo block "one"
+This document demonstrates blocks requiring other blocks.
+
+Block "(Winter)" is hidden.
+```bash :(Winter)
+echo It is now Winter
 ```
 
-```bash :two +(one)
-echo block "two" requires one
+Block "Spring" is visible. It requires "(Winter)".
+```bash :Spring +(Winter)
+echo It is now Spring
 ```
 
-```bash :(three) +two +(one)
-echo block "three" requires two and one
+Block "(Summer)" is hidden. It requires "(Winter)" and "Spring"
+```bash :(Summer) +Spring +(Winter)
+echo It is now Summer
 ```
 
-```bash :four +(three)
-echo block "four" requires three
+Block "Fall" is visible. It requires "(Summer)" which itself requires the rest.
+```bash :Fall +(Summer)
+echo It is now Fall
 ```
 
-```bash :trigger_unmet_dependency +(unmet)
-echo block "five" requires an unmet dependency
+Block "Sunsear" is visible. It requires "Frostfall" which does not exist and triggers an unmet dependency error.
+```bash :Sunsear +Frostfall
 ```

data/examples/indent.md

@@ -1,3 +1,5 @@
+This document demonstrates content is indented to match the source.
+
 This is a concise guide for using Bash commands to find and list recent files in a Linux system. The commands are safe to use and can help you quickly locate recently modified or accessed files.
 
 1. **List Recently Modified Files**:

data/examples/index.md

@@ -0,0 +1,68 @@
+v2024-02-06
+
+```link
+file: examples/colors.md
+```
+```link
+file: examples/document_options.md
+```
+```link
+file: examples/duplicate_block.md
+```
+```link
+file: examples/import0.md
+```
+```link
+file: examples/import1.md
+```
+```link
+file: examples/include.md
+```
+```link
+file: examples/indent.md
+```
+```link
+file: examples/linked.md
+```
+```link
+file: examples/linked1.md
+```
+```link
+file: examples/linked2.md
+```
+```link
+file: examples/linked3.md
+```
+```link
+file: examples/llm.md
+```
+```link
+file: examples/load1.sh
+```
+```link
+file: examples/load2.sh
+```
+```link
+file: examples/nickname.md
+```
+```link
+file: examples/opts.md
+```
+```link
+file: examples/pass-through.md
+```
+```link
+file: examples/plant.md
+```
+```link
+file: examples/port.md
+```
+```link
+file: examples/title.md
+```
+```link
+file: examples/vars.md
+```
+```link
+file: examples/wrap.md
+```

data/examples/linked.md

@@ -1,62 +1,57 @@
-Demonstrate setting a variable interactively for use in generated scripts.
+Demonstrate setting variable values interactively for use in generated scripts.
 
 ```opts :(document_options)
 pause_after_script_execution: false
 user_must_approve: false
 ```
 
-::: Set VARIABLE to "A"
-
-```link :set_to_A +(set_to_A)
-block: display_variable
+```link :link_with_vars_with_spaces
+vars:
+  test: "1 2 3"
 ```
 
-```bash :(set_to_A)
-VARIABLE=A
+::: Set variable ALPHA in a Vars block
+For each environment variable named in block,
+ append an inherited line that assigns the variable the specified value.
+```vars :set_ALPHA_to_1_via_vars_block
+ALPHA: 1
 ```
 
-```link :set_to_A_eval +(set_to_A_eval)
-block: display_variable
-eval: true
+::: Set variable ALPHA in a Link block
+For each environment variable in `vars`,
+ append an inherited line that assigns the variable the specified value.
+Subsequently, run the `display_variable_ALPHA` block.
+```link :set_ALPHA_to_2_via_link_block_and_display
+block: display_variable_ALPHA
+vars:
+  ALPHA: 2
 ```
 
-```bash :(set_to_A_eval)
-echo VARIABLE=A
+Make the code in the required block `(bash_set_to_3)` into inherited lines.
+Subsequently, run the `display_variable_ALPHA` block.
+```bash :(bash_set_to_3)
+ALPHA=3
 ```
-
-::: Set VARIABLE to "B"
-
-```link :set_to_B +(set_to_B)
-block: display_variable
+```link :set_ALPHA_to_3_via_required_block_and_display +(bash_set_to_3)
+block: display_variable_ALPHA
 ```
 
-```bash :(set_to_B)
-VARIABLE=B
-```
-
-```link :set_to_B_eval +(set_to_B_eval)
-block: display_variable
+Evaluate the code in the required block `(bash_eval_set_to_4)` and
+ save (transformed) output into inherited lines.
+Subsequently, run the `display_variable_ALPHA` block.
+```link :set_ALPHA_to_4_via_evaluated_required_block_and_display +(bash_eval_set_to_4)
 eval: true
+next_block: display_variable_ALPHA
 ```
-
-```bash :(set_to_B_eval)
-echo VARIABLE=B
+```bash :(bash_eval_set_to_4)
+echo 'ALPHA="4"'
 ```
 
-::: Display value of VARIABLE
-
-```bash :display_variable
+::: Display value of ALPHA
+```bash :display_variable_ALPHA
 source bin/colorize_env_vars.sh
-echo The current value of environment variable VARIABLE is now:
-colorize_env_vars '' VARIABLE
-```
-
-```bash :(set_timestamp)
-echo 'yyyymmdd? (default: today UTC) '; read -r yyyymmdd; [[ -z $yyyymmdd ]] && yyyymmdd="$(date -u +%y%m%d)"
-echo "EC2_STACK_TS='$yyyymmdd'"
-```
-```link :request_input_and_inherit_output +(set_timestamp)
-exec: true
+echo The current value of environment variable ALPHA is now:
+colorize_env_vars '' ALPHA
 ```
 
 ::: Load file into inherited lines
@@ -69,3 +64,69 @@ Load, evaluate, and append output to inherited lines.
 load: examples/load2.sh
 eval: true
 ```
+
+::: Save and Load
+Save inherited lines to a file.
+```link :save1
+save: tmp/save1.sh
+```
+Load inherited lines from a file.
+Subsequently, run the `display_variables` block.
+```link :load_saved
+load: tmp/save1.sh
+block: display_variables
+```
+Display variables ALPHA, var1, var2
+```bash :display_variables
+source bin/colorize_env_vars.sh
+colorize_env_vars '' ALPHA var1 var2
+```
+
+Execute a script requiring input from the user.
+Save the output setting TIMESTAMP into inherited lines.
+Subsequently, run the `display_TIMESTAMP` block.
+```bash :(input_timestamp)
+if [[ -z $TIMESTAMP ]]; then
+  default="$(date -u +%y%m%d)"
+  echo "yymmdd? (default: $default / today UTC) "
+  read -r TIMESTAMP
+  [[ -z $TIMESTAMP ]] && TIMESTAMP="$(date -u +%y%m%d)"
+fi
+```
+```bash :(inherit_timestamp)
+echo "TIMESTAMP=\"$TIMESTAMP\""
+```
+```link :set_timestamp +(input_timestamp) +(inherit_timestamp)
+exec: true
+block: display_TIMESTAMP
+```
+```bash :display_TIMESTAMP
+source bin/colorize_env_vars.sh
+colorize_env_vars '' TIMESTAMP
+```
+
+::: Load file matching glob pattern into inherited lines
+Load (do not evaluate) and append to inherited lines.
+```link :load_glob_load1*
+load: examples/load1*.sh
+```
+```link :load_glob_load*
+load: examples/load*.sh
+```
+```link :load_glob_fail
+load: examples/fail*
+```
+```link :load_glob_with_format
+load: "%{home}/examples/load*.sh"
+```
+
+```link :save_glob_load*
+save: examples/*.sh
+```
+
+```link :save_glob_*
+save: examples/*.sh
+```
+```link :load_glob_*
+load: examples/*.sh
+```

data/examples/llm.md

@@ -0,0 +1,54 @@
+1. show practical examples for three important Bash commands.
+2. the commands must rely only on resources created and deleted in the example
+
+Let's create practical examples for three important Bash commands where all resources are created and deleted within the examples. The commands we'll use are `touch` (to create a file), `echo` (to write to a file), and `rm` (to delete a file).
+
+### 1. `touch` - Create an Empty File
+
+**Purpose**: `touch` is used to create an empty file or update the timestamp of an existing file.
+
+**Example**: Create an empty file named `example.txt`.
+
+```bash
+touch example.txt
+```
+
+### 2. `echo` - Write to a File
+
+**Purpose**: `echo` is used to display a line of text. Combined with redirection, it can write text to a file.
+
+**Example**: Write "Hello, world!" to `example.txt`.
+
+```bash
+echo "Hello, world!" > example.txt
+```
+
+### 3. `rm` - Remove a File
+
+**Purpose**: `rm` is used to remove files or directories.
+
+**Example**: Delete the `example.txt` file.
+
+```bash
+rm example.txt
+```
+
+**Combined Script**: To see all these commands in action, you can create a script that executes them sequentially:
+
+```bash
+#!/bin/bash
+
+# Create an empty file
+touch example.txt
+
+# Write text to the file
+echo "Hello, world!" > example.txt
+
+# Display the file content
+cat example.txt
+
+# Remove the file
+rm example.txt
+```
+
+**Note**: After this script runs, `example.txt` is created, written to, displayed, and then deleted, ensuring that no external resources are used or left behind.

data/lib/constants.rb

@@ -17,11 +17,16 @@ IndexedLine = Struct.new(:index, :line) do
   end
 end
 
-class LinkDataKeys
+class LinkKeys
+  Block = 'block'
   Eval = 'eval'
   Exec = 'exec'
+  File = 'file'
   Load = 'load'
+  NextBlock = 'next_block'
   Return = 'return'
+  Save = 'save'
+  Vars = 'vars'
 end
 
 class LoadFile

data/lib/find_files.rb

@@ -22,7 +22,7 @@
 # Example:
 #   find_files('version.rb', ['lib/**', 'spec'])
 #   # This might return file paths like ['lib/markdown_exec/version.rb', 'spec/version_spec.rb'].
-def find_files(pattern, paths)
+def find_files(pattern, paths = ['', Dir.pwd])
   matched_files = []
 
   paths.each do |path_with_wildcard|
@@ -65,7 +65,6 @@ class TestFindFiles < Minitest::Test
     expected_files = [
       'lib/cli.rb',
       'lib/colorize.rb',
-      'lib/dev/llm.rb',
       'lib/dev/watchfile.sh',
       'lib/markdown_exec.rb',
       'lib/markdown_exec/version.rb'