markdown_exec 2.0.4 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eadeecd7019d53202aabe57d9486ee616826e6b5f42fce0fa24f8e377c1b50e5
-  data.tar.gz: cde007bddd4821263045eeba415cc1e2f42591d03294fc678c4093384373146b
+  metadata.gz: d1b2a98d8279b5a5705ba3dc3221d46f55387c0d834ec4283e93ac54f5929835
+  data.tar.gz: 440070d30a4650c0bb8b9a8b472d91d0bcb4357d18f5330194b10d1c5d6a764d
 SHA512:
-  metadata.gz: 5a4a3a36d420c41403be33dbc7ac8e53f446dac53ba3ce8e9cd2fafb1ff0c1026aa1df633f6d79e1742ea11a07f71bd3f64df95f772798ff4624b8c36a8f93b2
-  data.tar.gz: 1acc6cb2bf716b30a1ab8037ad0e43ff3646b23b991cd1bd9d31b1aad37ccf6ae97bd01eaeecc57e644ceb580a9aa9bf61742075777a528ffc180a43a955ccb1
+  metadata.gz: 32702e459d5eeac152583bd7dd8c5de3f6049b0fa8b2c389441f45afadc132678dabbb6898336297d09fa5411ae44963cd0b2353a69f9dc319eb9b302d4ec2db
+  data.tar.gz: a2ea933810ec3e90ed1cc62eccc9a2e8c94ee5dee1ed8c267b8750a97c67fb4a44bbcf8eb471137a65618b991966692d05684b3f69a97e5911dad3a777a15c60

data/.rubocop.yml

@@ -13,10 +13,8 @@ Layout/LeadingCommentSpace:
 Layout/LineContinuationLeadingSpace:
   Enabled: false
 
-Layout/LineLength:  # 2024-01-21 temp disable
-  Enabled: false
+Layout/LineLength:
   Max: 96
-  Max: 120
 
 Lint/Debugger:
   Enabled: false
@@ -24,6 +22,9 @@ Lint/Debugger:
 Lint/SafeNavigationChain:
   Enabled: false
 
+Lint/UnusedMethodArgument:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -54,13 +55,16 @@ Minitest/MultipleAssertions:
 Naming/RescuedExceptionsVariableName:
   PreferredName: err
 
+Security/Eval:
+  Enabled: false
+
 Security/YAMLLoad:
   Enabled: false
 
-Style/CommentedKeyword:
+Style/ClassVars:
   Enabled: false
 
-Style/Documentation:  # 2024-01-21 temp disable
+Style/CommentedKeyword:
   Enabled: false
 
 Style/DoubleNegation:
@@ -87,6 +91,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,32 @@
 # Changelog
 
+## [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
+
+- Open option: Search for keyword in block names instead of entire document.
+
 ## [2.0.4] - 2024-04-22
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.0.4)
+    markdown_exec (2.0.6)
       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.4"
+  echo "2.0.6"
 }
 
 _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-23 01:25:22 UTC"
+# echo "Updated: 2024-05-31 07:22:55 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/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/search.md

@@ -0,0 +1,21 @@
+Demonstrate keyword search in documents.
+Keywords in body: monkey secret
+
+Keyword in untyped block name.
+``` :monkey1
+```
+
+Keyword in Bash block name.
+```bash :monkey2
+```
+
+Keyword in block body.
+```
+monkey3
+```
+
+Keyword in Link block body.
+```link
+vars:
+  monkey4: 4
+```

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/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,11 @@ end
 class MenuState
   BACK = :back
   CONTINUE = :continue
+  EDIT = :edit
   EXIT = :exit
+  LOAD = :load
+  SAVE = :save
+  VIEW = :view
 end
 
 # a struct to hold the data for a single line

data/lib/directory_searcher.rb

@@ -160,9 +160,11 @@ class DirectorySearcher
         begin
           File.foreach(p).with_index(1) do |line, line_num| # Index starts from 1 for line numbers
             line_utf8 = line.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')
-            if line_utf8.match?(@pattern)
+
+            line_utf8 = yield(line_utf8) if block_given?
+
+            if line_utf8&.match?(@pattern)
               match_details[p] ||= []
-              # match_details[p] << { number: line_num, line: line_utf8.chomp }
               match_details[p] << IndexedLine.new(line_num, line_utf8.chomp)
             end
           end

data/lib/find_files.rb

@@ -2,13 +2,13 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
-# version 2024-01-15
+# version 2024-05-24
 
 # Finds files matching a given pattern within specified directory paths while optionally excluding
 # "." and ".." entries and directory names from the results.
 #
-# The function takes a pattern (filename or pattern with wildcards), an array of paths, and an
-# option to exclude directory entries and special entries "." and "..".
+# The function takes a pattern (filename or pattern with wildcards), an array of paths, and options
+# to exclude directory entries and special entries "." and "..", and to use relative paths.
 # It searches for files matching the pattern within each of the specified paths. Hidden files
 # are included in the search. The search can include subdirectories depending on the
 # path specification (e.g., 'dir/**' for recursive search).
@@ -18,15 +18,17 @@
 #   paths (Array<String>): An array of directory paths where the search will be performed.
 #     Paths can include wildcards for recursive search.
 #   exclude_dirs (Boolean): If true, excludes "." and ".." and directory names from the results.
+#   use_relative_paths (Boolean): If true, removes the app's base directory from the file names
+#     if present.
 #
 # Returns:
 #   Array<String>: A unique list of file paths that match the given pattern in the specified paths,
-#   excluding directories if exclude_dirs is true.
+#   excluding directories if exclude_dirs is true. Paths are relative if use_relative_paths is true.
 #
 # Example:
-#   find_files('version.rb', ['lib/**', 'spec'], true)
-#   # This might return file paths like ['lib/markdown_exec/version.rb', 'spec/version_spec.rb'].
-def find_files(pattern, paths = ['', Dir.pwd], exclude_dirs: false)
+#   find_files('version.rb', ['lib/**', 'spec'], true, true)
+#   # This might return file paths like ['markdown_exec/version.rb', 'spec/version_spec.rb'].
+def find_files(pattern, paths = ['', Dir.pwd], base_dir: Dir.pwd, exclude_dirs: false, use_relative_paths: true)
   matched_files = []
 
   paths.each do |path_with_wildcard|
@@ -37,9 +39,10 @@ def find_files(pattern, paths = ['', Dir.pwd], exclude_dirs: false)
     files = Dir.glob(search_pattern, File::FNM_DOTMATCH)
 
     # Optionally exclude "." and ".." and directory names
-    if exclude_dirs
-      files.reject! { |file| file.end_with?('/.', '/..') || File.directory?(file) }
-    end
+    files.reject! { |file| file.end_with?('/.', '/..') || File.directory?(file) } if exclude_dirs
+
+    # Optionally use relative paths
+    files.map! { |file| file.sub(/^#{Regexp.escape(base_dir)}\//, '') } if use_relative_paths
 
     matched_files += files
   end
@@ -47,38 +50,6 @@ def find_files(pattern, paths = ['', Dir.pwd], exclude_dirs: false)
   matched_files.uniq
 end
 
-# # Finds files matching a given pattern within specified directory paths.
-# #
-# # The function takes a pattern (filename or pattern with wildcards) and an array of paths.
-# # It searches for files matching the pattern within each of the specified paths. Hidden files
-# # are also included in the search. The search can include subdirectories depending on the
-# # path specification (e.g., 'dir/**' for recursive search).
-# #
-# # Args:
-# #   pattern (String): A filename or a pattern string with wildcards.
-# #   paths (Array<String>): An array of directory paths where the search will be performed.
-# #     Paths can include wildcards for recursive search.
-# #
-# # Returns:
-# #   Array<String>: A unique list of file paths that match the given pattern in the specified paths.
-# #
-# # 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 = ['', Dir.pwd])
-#   matched_files = []
-
-#   paths.each do |path_with_wildcard|
-#     # Combine the path with the wildcard and the pattern
-#     search_pattern = File.join(path_with_wildcard, pattern)
-
-#     # Use Dir.glob with the File::FNM_DOTMATCH flag to include hidden files
-#     matched_files += Dir.glob(search_pattern, File::FNM_DOTMATCH)
-#   end
-
-#   matched_files.uniq
-# end
-
 return if $PROGRAM_NAME != __FILE__
 
 # example CLI
@@ -138,4 +109,27 @@ class TestFindFiles < Minitest::Test
     result = find_files('.gitignore', ['.'])
     assert_includes result, './.gitignore'
   end
+
+  def test_find_files_with_non_existent_paths
+    # Test with non-existent paths
+    result = find_files('*.rb', %w[non_existent_dir another_fake_dir])
+    assert_empty result
+  end
+
+  def test_find_files_with_mixed_existent_and_non_existent_paths
+    # Test with a mix of existing and non-existing paths
+    result = find_files('*.rb', %w[lib non_existent_dir])
+    assert_includes result, 'lib/cli.rb'
+    assert_includes result, 'lib/colorize.rb'
+    # Ensure that non-existent paths do not cause failure and do not include files
+    assert_equal result.length, Dir.glob('lib/*.rb').length
+  end
+
+  def test_find_files_with_relative_paths
+    # Test with relative paths
+    base_dir = Dir.pwd
+    result = find_files('cli.rb', ['lib'], use_relative_paths: true)
+    assert_includes result, 'lib/cli.rb'
+    refute_includes result, "#{base_dir}/lib/cli.rb"
+  end
 end