markdown_exec 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb96e0d1b92398066dedcaf7017ee6d7deea37ef9ba19fa089de6c4e5aebf27d
-  data.tar.gz: f8b8ffcb0f30fbec9321a4a9f14ae7568b16b31e40833046fb1ab16ddcf28c1b
+  metadata.gz: af8a53f03e48c890798b520b84bd0357ccef4f31d93b97cc7cc8b4b72ca1a035
+  data.tar.gz: cd5983d2ff18ee8e2a29da6bea364c03bdaf6a43871d45b16483a8996d129894
 SHA512:
-  metadata.gz: 96a95683c52b4a7546d2cb1ce399dd6c278a7783305d70e12a0a8ac5c70df739705a0ccb06a14f8861ca5794193f201ab185cd7e994e6fcc4eef56a0f038504e
-  data.tar.gz: 51991405ec7dae5c31dcc1ff6294172279d046975647ca8676b4e28918d2ff954a19e671bae4cc7381963816f8b0826b4723c4bf61fb6a35fd8fce25e808ed63
+  metadata.gz: 47e4e75e5a4e473ab9e9726cb7774aec95eb4a26d1d48035e3f6a69df0162c6b004fa625f5ae9f3c973bb25f732c9e938c0008dd07abb759f3211258d943fcc8
+  data.tar.gz: 306fc1218c64d57b1ca82191060298f87f9ae996e43f278cd72144fa3b839e3e4e4b8d3168f34c2fca4bd1ba9fa8ca1ab0a42659980d115b2d3293edc5e75238

data/.rubocop.yml

@@ -15,8 +15,8 @@ Layout/LineContinuationLeadingSpace:
 
 Layout/LineLength:  # 2024-01-21 temp disable
   Enabled: false
-  Max: 96
-  Max: 120
+  # Max: 96
+  # Max: 120
 
 Lint/Debugger:
   Enabled: false
@@ -24,6 +24,9 @@ Lint/Debugger:
 Lint/SafeNavigationChain:
   Enabled: false
 
+Lint/UnusedMethodArgument:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -45,6 +48,9 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ParameterLists:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Enabled: false
 
@@ -54,9 +60,15 @@ Minitest/MultipleAssertions:
 Naming/RescuedExceptionsVariableName:
   PreferredName: err
 
+Security/Eval:
+  Enabled: false
+
 Security/YAMLLoad:
   Enabled: false
 
+Style/ClassVars:
+  Enabled: false
+
 Style/CommentedKeyword:
   Enabled: false
 
@@ -87,6 +99,9 @@ Style/MultilineBlockChain:
 Style/OpenStructUse:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/PerlBackrefs: # Prefer ::Regexp.last_match.post_match over $'.
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [2.0.7] - 2024-06-04
+
+### Added
+
+- Color names that set foreground and background color.
+  Similar to the existing foreground-only color names.
+  The background colors follow the foreground color values in the name.
+  Two names, to accept values as decimal and hex.
+- Example document for line wrapping.
+- Menu entry to execute shell commands.
+- Option to control menu entry for shell commands.
+- Recognition of nicknames in command line processing.
+- Trap user interrupting executing scripts.
+
+### Changed
+
+- Do not decorate indentations.
+- Line-wrap and center headings.
+  Headings are now centered, the text is case-folded and the color
+  (foreground and background) is according to the level.
+  Centering is based on the console width detected.
+- Line-wrap normal document text and format headings.
+- Parse lines into indentation, text, and trailing whitespace.
+- Update nicknames example to exercise hidden blocks from the command line.
+- The optional prompt to exit after execution is now more frequent.
+- Set characters used in saved file names
+
+## [2.0.6] - 2024-05-28
+
+### Added
+
+- Color-coding to folder names in the menu following a keyword search.
+  Implement color-coding for folder names. Each folder name is assigned a color based on the folder name to highlight repetitive folder structures.
+
+- Load-code option to read one or more files into inherited lines.
+
+- Automatic Load, Edit, Save, and View menu entries to manage inherited lines.
+  The value of `document_saved_lines_glob` is displayed above the menu items, if any.
+  The Load menu item appears when one or more files match the glob.
+  The Edit menu item appears when one or more lines have been inherited.
+  The Save menu item appears when one or more lines have been inherited.
+  The View menu item appears when one or more lines have been inherited.
+
+### Changed
+
+- Fix block name processing for blocks with no name.
+  Demo in examples/block_names.md loads content of examples/load1.sh.
+
 ## [2.0.5] - 2024-04-24
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.0.5)
+    markdown_exec (2.0.7)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "2.0.5"
+  echo "2.0.7"
 }
 
 _mde() {
@@ -36,15 +36,15 @@ _mde() {
             
               -d) COMPREPLY="0"; return 0 ;;
             
-              --dump-dump-delegate-object) COMPREPLY="0"; return 0 ;;
+              --dump-delegate-object) COMPREPLY="0"; return 0 ;;
             
               --dump-blocks-in-file) COMPREPLY="0"; return 0 ;;
             
-              --dump-dump-inherited-block_names) COMPREPLY="0"; return 0 ;;
+              --dump-inherited-block_names) COMPREPLY="0"; return 0 ;;
             
-              --dump-dump-inherited-dependencies) COMPREPLY="0"; return 0 ;;
+              --dump-inherited-dependencies) COMPREPLY="0"; return 0 ;;
             
-              --dump-dump-inherited-lines) COMPREPLY="0"; return 0 ;;
+              --dump-inherited-lines) COMPREPLY="0"; return 0 ;;
             
               --dump-menu-blocks) COMPREPLY="0"; return 0 ;;
             
@@ -66,12 +66,12 @@ _mde() {
             
               --list-count) COMPREPLY="32"; return 0 ;;
             
+              --load-code) COMPREPLY="''"; return 0 ;;
+            
               --open) COMPREPLY="''"; return 0 ;;
             
               -o) COMPREPLY="''"; return 0 ;;
             
-              --output-execution-summary) COMPREPLY="0"; return 0 ;;
-            
               --output-script) COMPREPLY="0"; return 0 ;;
             
               --output-stdout) COMPREPLY="1"; return 0 ;;
@@ -80,14 +80,6 @@ _mde() {
             
               -p) COMPREPLY="."; return 0 ;;
             
-              --save-executed-script) COMPREPLY="0"; return 0 ;;
-            
-              --save-execution-output) COMPREPLY="0"; return 0 ;;
-            
-              --saved-script-folder) COMPREPLY="logs"; return 0 ;;
-            
-              --saved-stdout-folder) COMPREPLY="logs"; return 0 ;;
-            
               --user-must-approve) COMPREPLY="0"; return 0 ;;
             
               -q) COMPREPLY="0"; return 0 ;;
@@ -102,7 +94,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-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" "--open" "--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-delegate-object" "--dump-blocks-in-file" "--dump-inherited-block_names" "--dump-inherited-dependencies" "--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" "--load-code" "--open" "--output-script" "--output-stdout" "--path" "--pwd" "--run-last-script" "--select-recent-output" "--select-recent-script" "--tab-completions" "--user-must-approve" "--version" "--display-level")
     COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
 
     return 0
@@ -125,15 +117,15 @@ _mde() {
         
           -d) COMPREPLY=".BOOL."; return 0 ;;
         
-          --dump-dump-delegate-object) COMPREPLY=".BOOL."; return 0 ;;
+          --dump-delegate-object) COMPREPLY=".BOOL."; return 0 ;;
         
           --dump-blocks-in-file) COMPREPLY=".BOOL."; return 0 ;;
         
-          --dump-dump-inherited-block_names) COMPREPLY=".BOOL."; return 0 ;;
+          --dump-inherited-block_names) COMPREPLY=".BOOL."; return 0 ;;
         
-          --dump-dump-inherited-dependencies) COMPREPLY=".BOOL."; return 0 ;;
+          --dump-inherited-dependencies) COMPREPLY=".BOOL."; return 0 ;;
         
-          --dump-dump-inherited-lines) COMPREPLY=".BOOL."; return 0 ;;
+          --dump-inherited-lines) COMPREPLY=".BOOL."; return 0 ;;
         
           --dump-menu-blocks) COMPREPLY=".BOOL."; return 0 ;;
         
@@ -155,12 +147,12 @@ _mde() {
         
           --list-count) COMPREPLY=".INT.1-."; return 0 ;;
         
+          --load-code) COMPREPLY=".PATH."; return 0 ;;
+        
           --open) COMPREPLY=".OPEN."; return 0 ;;
         
           -o) COMPREPLY=".OPEN."; return 0 ;;
         
-          --output-execution-summary) COMPREPLY=".BOOL."; return 0 ;;
-        
           --output-script) COMPREPLY=".BOOL."; return 0 ;;
         
           --output-stdout) COMPREPLY=".BOOL."; return 0 ;;
@@ -169,14 +161,6 @@ _mde() {
         
           -p) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
         
-          --save-executed-script) COMPREPLY=".BOOL."; return 0 ;;
-        
-          --save-execution-output) COMPREPLY=".BOOL."; return 0 ;;
-        
-          --saved-script-folder) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
-        
-          --saved-stdout-folder) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
-        
           --user-must-approve) COMPREPLY=".BOOL."; return 0 ;;
         
           -q) COMPREPLY=".BOOL."; return 0 ;;
@@ -194,4 +178,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2024-04-26 15:37:23 UTC"
+# echo "Updated: 2024-06-05 03:00:42 UTC"

data/examples/block_names.md

@@ -0,0 +1,23 @@
+Demonstrate display of block names and requiring blocks.
+
+This block is listed by its name `A`.
+It requires block `[C]`.
+Executing it outputs `1`, `3`.
+```bash :A +[C]
+echo "1"
+```
+
+This block is listed according to its content `echo "2"`.
+It requires blocks `A`, `[C]`.
+Executing it outputs `1`, `2`, `3`.
+It cannot be addressed/required.
+```bash +A
+echo "2"
+```
+
+This block is listed according to its content `echo "3"` and addressed by its nick name `[C]`.
+It requires no blocks.
+Executing it outputs `3`.
+```bash :[C]
+echo "3"
+```

data/examples/interrupt.md

@@ -0,0 +1,9 @@
+```opts :(document_options)
+pause_after_script_execution: false
+```
+```bash
+tail -f ~/.bash_profile
+```
+```bash
+tail -f ~/.profile
+```

data/examples/line-wrapping.md

@@ -0,0 +1,17 @@
+# Demo wrapping long lines
+
+MDE detects the screen's dimensions: height (lines) and width (characters)
+
+If `select_page_height` is positive, the height of the MDE menu is fixed. Otherwise, the height is derived from the screen's height.
+
+Normal document text is displayed as disabled menu lines. The width of these lines is limited according to the screen's width.
+
+::: Test Indented Lines
+
+  Indented with two spaces, this line should wrap in an aesthetically pleasing way. Indented with two spaces, this line should wrap in an aesthetically pleasing way.
+
+	Indented with a tab, this line should wrap in an aesthetically pleasing way. Indented with a tab, this line should wrap in an aesthetically pleasing way.
+
+# Heading 1 - UPPER lower Mixed - Alpha Beta Gamma Delta Epsilon Zeta Eta Theta Iota Kappa Lambda Mu Nu Xi Omicron Pi Rho Sigma Tau Upsilon Phi Chi Psi Omega
+## Heading 2 - UPPER lower Mixed - Alpha Beta Gamma Delta Epsilon Zeta Eta Theta Iota Kappa Lambda Mu Nu Xi Omicron Pi Rho Sigma Tau Upsilon Phi Chi Psi Omega
+### Heading 3 - UPPER lower Mixed - Alpha Beta Gamma Delta Epsilon Zeta Eta Theta Iota Kappa Lambda Mu Nu Xi Omicron Pi Rho Sigma Tau Upsilon Phi Chi Psi Omega

data/examples/linked.md

@@ -92,6 +92,14 @@ load: examples/load2.sh
 eval: true
 ```
 
+::: Load file into inherited lines and switch document
+Load (do not evaluate) and append to inherited lines and switch document.
+```link :load_from_file_link_and_show
+block: show_vars
+file: examples/linked_show.md
+load: examples/load1.sh
+```
+
 ::: Save and Load
 Save inherited lines to a file.
 ```link :save1

data/examples/linked_show.md

@@ -0,0 +1,7 @@
+# Demo document linking
+
+::: Display variables set in the calling document
+```bash :show_vars
+source bin/colorize_env_vars.sh
+colorize_env_vars 'from linked.md load1.sh' var1 var2
+```

data/examples/load_code.md

@@ -0,0 +1,10 @@
+Demonstrate loading inherited code via the command line.
+
+Run this command to display the inherited code.
+`mde --load-code examples/load1.sh examples/load_code.md display_variables`
+
+```bash :display_variables
+source bin/colorize_env_vars.sh
+echo The current value of environment variables:
+colorize_env_vars '' var1 var2
+```

data/examples/nickname.md

@@ -1,26 +1,63 @@
 # Demo block nicknames
 
 ```opts :(document_options)
-save_executed_script: true
+pause_after_script_execution: true
 ```
 
+## Blocks with no name
 ::: This block has no name.
 ::: The code block is displayed.
 
 ```bash
-echo Unnamed block
+echo This block has no name.
 ```
 
-::: These blocks use nicknames.
-::: The code blocks are displayed.
-::: The nicknames can be used for requiring blocks.
+## Blocks with nicknames
+::: The code block is displayed.
+::: The nickname can be used to require the block.
 
 ```bash :[A]
-echo From the required block 2
+echo 'This block has a nickname: [A].'
+echo The full block is displayed in the menu.
 ```
 
-::: Execute this block that requires the block above.
-
+### Nicknames in documents
+::: Execute this block that requires the block above by its nickname.
 ```bash :[B] +[A]
-echo From the parent block 1
+echo 'This block has a nickname: [B].'
+echo 'This block requires block [A].'
+```
+
+### Nicknames from the command line
+Block `[A]` is called from the command line.
+```bash
+mde examples/nickname.md '[A]'
+```
+
+## Blocks with hidden names
+### There is a hidden block here.
+::: This block has a hidden name: (C).
+::: This block does not appear in the menu.
+::: This block requires the block above by its nickname.
+```bash :(C) +[A]
+echo 'This block has a hidden name: (C).'
+echo This block is hidden from the menu.
+echo 'This block requires block [A].'
+```
+
+### Hidden names from the command line
+Block `(C)` is called from the command line.
+```bash
+mde examples/nickname.md '(C)'
+```
+
+### Block without a name
+::: This block does not have a name.
+::: It requires hidden block (D).
+```bash +(D)
+echo "Block without a name"
+```
+::: This block has a hidden name: (D).
+```bash :(D)
+echo "Block D"
 ```

data/examples/pause-after-execution.md

@@ -0,0 +1,9 @@
+# Demonstrate pause for user approval before returning to the menu
+Controlled by option `pause_after_script_execution`.
+```opts :(document_options)
+pause_after_script_execution: true
+```
+
+```bash
+echo `date`
+```

data/lib/color_scheme.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+# A class that represents a color scheme based on configurable parameters
+# that determine how the RGB values are calculated for a given string segment.
+class ColorScheme
+  attr_accessor :base_red, :multiplier_red, :modulus_red,
+                :base_green, :multiplier_green, :modulus_green,
+                :base_blue, :multiplier_blue, :modulus_blue
+
+  # Initializes a new ColorScheme object with base values, multipliers, and moduli
+  # for the red, green, and blue components of an RGB color.
+  # @param [Integer] base_red Base red component value.
+  # @param [Integer] multiplier_red Multiplier for red component based on string hash.
+  # @param [Integer] modulus_red Modulus for calculating red component.
+  # @param [Integer] base_green Base green component value.
+  # @param [Integer] multiplier_green Multiplier for green component based on string hash.
+  # @param [Integer] modulus_green Modulus for calculating green component.
+  # @param [Integer] base_blue Base blue component value.
+  # @param [Integer] multiplier_blue Multiplier for blue component based on string hash.
+  # @param [Integer] modulus_blue Modulus for calculating blue component.
+  def initialize(base_red, multiplier_red, modulus_red,
+                 base_green, multiplier_green, modulus_green,
+                 base_blue, multiplier_blue, modulus_blue)
+    @base_red = base_red
+    @multiplier_red = multiplier_red
+    @modulus_red = modulus_red
+    @base_green = base_green
+    @multiplier_green = multiplier_green
+    @modulus_green = modulus_green
+    @base_blue = base_blue
+    @multiplier_blue = multiplier_blue
+    @modulus_blue = modulus_blue
+  end
+
+  # Calculates and returns the ANSI escape code for coloring a string segment
+  # based on its hash value.
+  # @param [String] segment The string segment to color.
+  # @return [String] ANSI escape code string with RGB color formatting.
+  def color_for(segment)
+    hash_value = segment.each_byte.reduce(0, :+)
+    red = @base_red + (@multiplier_red * (hash_value % @modulus_red))
+    green = @base_green + (@multiplier_green * (hash_value % @modulus_green))
+    blue = @base_blue + (@multiplier_blue * (hash_value % @modulus_blue))
+    "\e[38;2;#{red};#{green};#{blue}m#{segment}\e[0m"
+  end
+
+  # Applies color codes to each segment of a filesystem path, differentiating the
+  # final segment from others using a distinct color scheme.
+  # @param [String] path The filesystem path to colorize.
+  # @return [String] The colorized path.
+  def self.colorize_path(path)
+    segments = path.split('/')
+    segments.map.with_index do |segment, index|
+      color_scheme = if index == segments.size - 1
+                       ColorScheme.new(192, 0, 1, 192, 0, 1, 192, 0, 1)
+                     else
+                       ColorScheme.new(32, 1, 192, 32, 1, 192, 255, 0, 1)
+                     end
+
+      color_scheme.color_for(segment)
+    end.join('/')
+  end
+end

data/lib/colorize.rb

@@ -13,6 +13,11 @@ class String
   # @return [String] The formatted string.
   def method_missing(method_name, *args, &block)
     case method_name.to_s
+    when /^fg_bg_rgb_/
+      bytes = $'.split('_')
+      fg_bg_rgb_color(bytes[0..2].join(';'), bytes[3..5].join(';'))
+    when /^fg_bg_rgbh_/
+      hex_to_fg_bg_rgb($')
     when /^fg_rgb_/
       fg_rgb_color($'.gsub('_', ';'))
     when /^fg_rgbh_/
@@ -29,6 +34,14 @@ class String
     "\033[#{self}\033[0m"
   end
 
+  # Applies a 24-bit RGB foreground color to the string.
+  #
+  # @param rgb [String] The RGB color, expressed as a string like "1;2;3".
+  # @return [String] The string with the applied RGB foreground color.
+  def fg_bg_rgb_color(fg_rgb, bg_rgb)
+    "38;2;#{fg_rgb}m\033[48;2;#{bg_rgb}m#{self}".ansi_control_sequence
+  end
+
   # Applies a 24-bit RGB foreground color to the string.
   #
   # @param rgb [String] The RGB color, expressed as a string like "1;2;3".
@@ -37,6 +50,18 @@ class String
     "38;2;#{rgb}m#{self}".ansi_control_sequence
   end
 
+  # Converts hex color codes to RGB and applies them to the string.
+  #
+  # @param hex_str [String] The RGB color, expressed as a hex string like "FF00FF".
+  # @return [String] The string with the applied RGB foreground color.
+  def hex_to_fg_bg_rgb(hex_str)
+    values = hex_str.split('_').map { |hex| hex.to_i(16).to_s }
+    fg_bg_rgb_color(
+      values[0..2].join(';'),
+      values[3..5].join(';')
+    )
+  end
+
   # Converts hex color codes to RGB and applies them to the string.
   #
   # @param hex_str [String] The RGB color, expressed as a hex string like "FF00FF".

data/lib/constants.rb

@@ -6,9 +6,9 @@
 require_relative 'block_types'
 
 class ExecutionStreams
-  StdErr = :stderr
-  StdIn  = :stdin
-  StdOut = :stdout
+  STD_ERR = :stderr
+  STD_IN  = :stdin
+  STD_OUT = :stdout
 end
 
 IndexedLine = Struct.new(:index, :line) do
@@ -18,29 +18,24 @@ IndexedLine = Struct.new(:index, :line) do
 end
 
 class LinkKeys
-  Block = 'block'
-  Eval = 'eval'
-  Exec = 'exec'
-  File = 'file'
-  Load = 'load'
-  NextBlock = 'next_block'
-  Return = 'return'
-  Save = 'save'
-  Vars = 'vars'
+  BLOCK = 'block'
+  EVAL = 'eval'
+  EXEC = 'exec'
+  FILE = 'file'
+  LOAD = 'load'
+  NEXT_BLOCK = 'next_block'
+  RETURN = 'return'
+  SAVE = 'save'
+  VARS = 'vars'
 end
 
 class LoadFile
-  Load = true
-  Reuse = false
+  LOAD = true
+  REUSE = false
 end
 
 LoadFileLinkState = Struct.new(:load_file, :link_state)
 
-class MenuControl
-  Fresh = false
-  Repeat = true
-end
-
 class MenuOptions
   YES = 1
   NO = 2
@@ -51,7 +46,12 @@ end
 class MenuState
   BACK = :back
   CONTINUE = :continue
+  EDIT = :edit
   EXIT = :exit
+  LOAD = :load
+  SAVE = :save
+  SHELL = :shell
+  VIEW = :view
 end
 
 # a struct to hold the data for a single line

data/lib/fcb.rb

@@ -3,6 +3,21 @@
 
 # encoding=utf-8
 
+class Hash
+  # block name in commands and documents
+  def pub_name
+    fetch(:nickname, nil) || fetch(:oname, nil)
+  end
+end
+# require 'ostruct'
+
+# class BlkS < OpenStruct
+#   # Method to fetch the value associated with the attribute :nickname or :oname
+#   def pub_name
+#     self.nickname || self.oname
+#   end
+# end
+
 module MarkdownExec
   class Error < StandardError; end