markdown_exec 2.0.3.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a409e4d991db71ebae3bf9cfa6e7fcad695b6f5e1ffc017cffddc0ce168497
-  data.tar.gz: 11e5a9c57f38a06a328310a0d368d9c136a959f1c75260e916cb9bd35706cda6
+  metadata.gz: eadeecd7019d53202aabe57d9486ee616826e6b5f42fce0fa24f8e377c1b50e5
+  data.tar.gz: cde007bddd4821263045eeba415cc1e2f42591d03294fc678c4093384373146b
 SHA512:
-  metadata.gz: ac29e181ea9a2b6fbc081d7dc13288fed6990c4a215d3d9b0a25e499cfefe63346c1f648988495537c0147f954c9ddf4c76ee110a288d9a3dc1e821b47525282
-  data.tar.gz: 992e6fa7a4438c5b580ad6b026ed351109b9b818106f647fc9c5234165abdd07bc729ff34a4bec6d0a678200a5de7c6bbbbceee2b395964a599a95622a8de06e
+  metadata.gz: 5a4a3a36d420c41403be33dbc7ac8e53f446dac53ba3ce8e9cd2fafb1ff0c1026aa1df633f6d79e1742ea11a07f71bd3f64df95f772798ff4624b8c36a8f93b2
+  data.tar.gz: 1acc6cb2bf716b30a1ab8037ad0e43ff3646b23b991cd1bd9d31b1aad37ccf6ae97bd01eaeecc57e644ceb580a9aa9bf61742075777a528ffc180a43a955ccb1

data/.rubocop.yml

@@ -16,6 +16,7 @@ Layout/LineContinuationLeadingSpace:
 Layout/LineLength:  # 2024-01-21 temp disable
   Enabled: false
   Max: 96
+  Max: 120
 
 Lint/Debugger:
   Enabled: false
@@ -83,6 +84,9 @@ Style/MixinUsage:
 Style/MultilineBlockChain:
   Enabled: false
 
+Style/OpenStructUse:
+  Enabled: false
+
 Style/PerlBackrefs: # Prefer ::Regexp.last_match.post_match over $'.
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [2.0.4] - 2024-04-22
+
+### Added
+
+- Option to match and open directories and files.
+
 ## [2.0.3] - 2024-04-15
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.0.3.2)
+    markdown_exec (2.0.4)
       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.3.2"
+  echo "2.0.4"
 }
 
 _mde() {
@@ -66,6 +66,10 @@ _mde() {
             
               --list-count) COMPREPLY="32"; return 0 ;;
             
+              --open) COMPREPLY="''"; return 0 ;;
+            
+              -o) COMPREPLY="''"; return 0 ;;
+            
               --output-execution-summary) COMPREPLY="0"; return 0 ;;
             
               --output-script) COMPREPLY="0"; return 0 ;;
@@ -98,7 +102,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" "--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" "--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")
     COMPREPLY=( $(compgen -W "$(printf "'%s' " "${opts[@]}")" -- "${cur}") )
 
     return 0
@@ -151,6 +155,10 @@ _mde() {
         
           --list-count) COMPREPLY=".INT.1-."; 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 ;;
@@ -186,4 +194,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2024-04-18 00:24:36 UTC"
+# echo "Updated: 2024-04-23 01:25:22 UTC"

data/examples/linked.md

@@ -9,7 +9,29 @@ user_must_approve: false
 block: (display_variable)
 eval: true
 ```
-
+Block name with all chars.
+/ !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+/ ¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ
+```link :!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+file: examples/linked2.md
+block: show_vars
+vars:
+  page2_var_via_environment: for_page2_from_page1_via_current_environment
+```
+```link :¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ
+file: examples/linked2.md
+block: show_vars
+vars:
+  page2_var_via_environment: for_page2_from_page1_via_current_environment
+```
+Block with no title is displayed correctly in a single line (for a Bash comment).
+```link
+file: examples/linked2.md
+block: show_vars
+vars:
+  page2_var_via_environment: for_page2_from_page1_via_current_environment
+```
+Spaces in variable value are unchanged.
 ```link :link_with_vars_with_spaces
 vars:
   test: "1 2 3"
@@ -124,11 +146,9 @@ 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
 ```

data/lib/directory_searcher.rb

@@ -110,7 +110,7 @@ class DirectorySearcher
 
   # Searches for the pattern in directory names.
   # @return [Array<String>] List of matching directory names.
-  def search_in_directory_names
+  def find_directory_names
     match_dirs = []
     @paths.each do |path|
       Find.find(path) do |p|
@@ -123,7 +123,7 @@ class DirectorySearcher
 
   # Searches for the pattern in file names.
   # @return [Array<String>] List of matching file names.
-  def search_in_file_names
+  def find_file_names
     match_files = []
     @paths.each do |path|
       Find.find(path) do |p|
@@ -147,7 +147,7 @@ class DirectorySearcher
 
   # Searches for the pattern in the contents of the files and returns matches along with their file paths and line numbers.
   # @return [Hash] A hash where each key is a file path and each value is an array of hashes with :line_number and :line keys.
-  def search_in_file_contents
+  def find_file_contents
     match_details = {}
 
     @paths.each do |path|
@@ -178,7 +178,7 @@ class DirectorySearcher
 
   # # Searches for the pattern in the contents of the files.
   # # @return [Array<String>] List of matching lines from files.
-  # def search_in_file_contents
+  # def find_file_contents
   #   match_lines = []
   #   @paths.each do |path|
   #     Find.find(path) do |p|
@@ -219,22 +219,22 @@ if $PROGRAM_NAME == __FILE__
       @searcher = DirectorySearcher.new(@pattern, @paths)
     end
 
-    # Test search_in_directory_names method
-    def test_search_in_directory_names
+    # Test find_directory_names method
+    def test_find_directory_names
       # Add assertions based on your test directory structure and expected results
-      assert_equal [], @searcher.search_in_directory_names
+      assert_equal [], @searcher.find_directory_names
     end
 
-    # Test search_in_file_names method
-    def test_search_in_file_names
+    # Test find_file_names method
+    def test_find_file_names
       # Add assertions based on your test directory structure and expected results
-      assert_equal [], @searcher.search_in_file_names
+      assert_equal [], @searcher.find_file_names
     end
 
-    # Test search_in_file_contents method
-    def test_search_in_file_contents
+    # Test find_file_contents method
+    def test_find_file_contents
       # Add assertions based on your test directory structure and expected results
-      assert_equal ({}), @searcher.search_in_file_contents
+      assert_equal ({}), @searcher.find_file_contents
     end
   end
 
@@ -249,26 +249,26 @@ if $PROGRAM_NAME == __FILE__
                                              filename_glob: @filename_glob)
     end
 
-    # Test search_in_directory_names method for 'spec'
-    def test_search_in_directory_names_for_spec
+    # Test find_directory_names method for 'spec'
+    def test_find_directory_names_for_spec
       # Replace with actual expected directory names containing 'spec'
       expected_dirs = ['./spec']
-      assert_equal expected_dirs, @searcher_spec.search_in_directory_names
+      assert_equal expected_dirs, @searcher_spec.find_directory_names
     end
 
-    # Test search_in_file_names method for 'spec'
-    def test_search_in_file_names_for_spec
+    # Test find_file_names method for 'spec'
+    def test_find_file_names_for_spec
       # Replace with actual expected file names containing 'spec'
       expected_files = ['./spec/cli_spec.rb', './spec/env_spec.rb',
                         './spec/markdown_exec_spec.rb', './spec/tap_spec.rb']
-      assert_equal expected_files, @searcher_spec.search_in_file_names
+      assert_equal expected_files, @searcher_spec.find_file_names
     end
 
-    # # Test search_in_file_contents method for 'spec'
-    # def test_search_in_file_contents_for_spec
+    # # Test find_file_contents method for 'spec'
+    # def test_find_file_contents_for_spec
     #   # Replace with actual expected lines containing 'spec'
     #   expected_lines = {['Line with spec 1', 'Line with spec 2']}
-    #   assert_equal expected_lines, @searcher_spec.search_in_file_contents
+    #   assert_equal expected_lines, @searcher_spec.find_file_contents
     # end
   end
 

data/lib/find_files.rb

@@ -4,25 +4,29 @@
 # encoding=utf-8
 # version 2024-01-15
 
-# Finds files matching a given pattern within specified directory paths.
+# 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) and an array of paths.
+# 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 "..".
 # 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
+# are 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.
+#   exclude_dirs (Boolean): If true, excludes "." and ".." and directory names from the results.
 #
 # Returns:
-#   Array<String>: A unique list of file paths that match the given pattern in the specified paths.
+#   Array<String>: A unique list of file paths that match the given pattern in the specified paths,
+#   excluding directories if exclude_dirs is true.
 #
 # Example:
-#   find_files('version.rb', ['lib/**', 'spec'])
+#   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])
+def find_files(pattern, paths = ['', Dir.pwd], exclude_dirs: false)
   matched_files = []
 
   paths.each do |path_with_wildcard|
@@ -30,12 +34,51 @@ def find_files(pattern, paths = ['', Dir.pwd])
     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)
+    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
+
+    matched_files += files
   end
 
   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

data/lib/hash_delegator.rb

@@ -3,8 +3,8 @@
 
 # encoding=utf-8
 
-require 'English'
 require 'clipboard'
+require 'English'
 require 'fileutils'
 require 'open3'
 require 'optparse'
@@ -22,7 +22,6 @@ require_relative 'block_label'
 require_relative 'block_types'
 require_relative 'cached_nested_file_reader'
 require_relative 'constants'
-require_relative 'std_out_err_logger'
 require_relative 'directory_searcher'
 require_relative 'exceptions'
 require_relative 'fcb'
@@ -32,6 +31,7 @@ require_relative 'hash'
 require_relative 'link_history'
 require_relative 'mdoc'
 require_relative 'regexp'
+require_relative 'std_out_err_logger'
 require_relative 'string_util'
 
 class String
@@ -365,6 +365,23 @@ module PathUtils
   end
 end
 
+class BashCommentFormatter
+  # Formats a multi-line string into a format safe for use in Bash comments.
+  def self.format_comment(input_string)
+    return '# ' if input_string.nil?
+    return '# ' if input_string.empty?
+
+    formatted = input_string.split("\n").map do |line|
+      "# #{line.gsub('#', '\#')}"
+    end
+    formatted.join("\n")
+  end
+  # # fit oname in single bash comment
+  # def oname_for_bash_comment(oname)
+  #   oname.gsub("\n", ' ~ ').gsub(/  +/, ' ')
+  # end
+end
+
 module MarkdownExec
   class DebugHelper
     # Class-level variable to store history of printed messages
@@ -1336,28 +1353,28 @@ module MarkdownExec
       }
     end
 
-#     # Loads auto link block.
-#     def load_auto_link_block(all_blocks, link_state, mdoc, block_source:)
-#       block_name = @delegate_object[:document_load_link_block_name]
-#       return unless block_name.present? && @most_recent_loaded_filename != @delegate_object[:filename]
+    #     # Loads auto link block.
+    #     def load_auto_link_block(all_blocks, link_state, mdoc, block_source:)
+    #       block_name = @delegate_object[:document_load_link_block_name]
+    #       return unless block_name.present? && @most_recent_loaded_filename != @delegate_object[:filename]
 
-#       block = HashDelegator.block_find(all_blocks, :oname, block_name)
-#       return unless block
+    #       block = HashDelegator.block_find(all_blocks, :oname, block_name)
+    #       return unless block
 
-#       if block.fetch(:shell, '') != BlockType::LINK
-#         HashDelegator.error_handler('must be Link block type', { abort: true })
+    #       if block.fetch(:shell, '') != BlockType::LINK
+    #         HashDelegator.error_handler('must be Link block type', { abort: true })
 
-#       else
-#         # debounce_reset
-#         push_link_history_and_trigger_load(
-#           link_block_body: block.fetch(:body, ''),
-#           mdoc: mdoc,
-#           selected: block,
-#           link_state: link_state,
-#           block_source: block_source
-#         )
-#       end
-#     end
+    #       else
+    #         # debounce_reset
+    #         push_link_history_and_trigger_load(
+    #           link_block_body: block.fetch(:body, ''),
+    #           mdoc: mdoc,
+    #           selected: block,
+    #           link_state: link_state,
+    #           block_source: block_source
+    #         )
+    #       end
+    #     end
 
     # Loads auto blocks based on delegate object settings and updates if new filename is detected.
     # Executes a specified block once per filename.
@@ -1754,7 +1771,7 @@ module MarkdownExec
       # load key and values from link block into current environment
       #
       if link_block_data[LinkKeys::Vars]
-        code_lines.push "# #{selected[:oname]}"
+        code_lines.push BashCommentFormatter.format_comment(selected[:oname])
         (link_block_data[LinkKeys::Vars] || []).each do |(key, value)|
           ENV[key] = value.to_s
           code_lines.push(assign_key_value_in_bash(key, value))
@@ -1907,9 +1924,9 @@ module MarkdownExec
               debounce_reset
               link_state = LinkState.new
               options_state = read_show_options_and_trigger_reuse(
-                                selected: @dml_block_state.block,
-                                link_state: link_state
-                              )
+                selected: @dml_block_state.block,
+                link_state: link_state
+              )
 
               @menu_base_options.merge!(options_state.options)
               @delegate_object.merge!(options_state.options)
@@ -2103,15 +2120,25 @@ module MarkdownExec
 
     # Presents a TTY prompt to select an option or exit, returns metadata including option and selected
     def select_option_with_metadata(prompt_text, names, opts = {})
+
+      ## configure to environment
+      #
+      unless opts[:select_page_height].positive?
+        require 'io/console'
+        opts[:per_page] = opts[:select_page_height] = [IO.console.winsize[0] - 3, 4].max
+      end
+
       selection = @prompt.select(prompt_text,
                                  names,
                                  opts.merge(filter: true))
-
-      item = if names.first.instance_of?(String)
-               { dname: selection }
-             else
-               names.find { |item| item[:dname] == selection }
-             end
+      item = names.find do |item|
+        if item.instance_of?(String)
+          item == selection
+        else
+          item[:dname] == selection
+        end
+      end
+      item = { dname: item } if item.instance_of?(String)
       unless item
         HashDelegator.error_handler('select_option_with_metadata', error: 'menu item not found')
         exit 1
@@ -2318,10 +2345,6 @@ module MarkdownExec
                        end
 
       sph = @delegate_object[:select_page_height]
-      unless sph.positive?
-        require 'io/console'
-        sph = [IO.console.winsize[0] - 3, 4].max
-      end
       selection_opts.merge!(per_page: sph)
 
       selected_option = select_option_with_metadata(prompt_title, block_menu,
@@ -2387,9 +2410,9 @@ module MarkdownExec
         clean_hash_recursively(value)
       when Struct
         struct_hash = value.to_h # Convert the Struct to a hash
-        cleaned_hash = clean_hash_recursively(struct_hash) # Clean the hash
+        clean_hash_recursively(struct_hash) # Clean the hash
         # Return the cleaned hash instead of updating the Struct
-        return cleaned_hash
+
       else
         value
       end
@@ -2402,9 +2425,7 @@ module MarkdownExec
         obj[key] = cleaned_value if value.is_a?(Hash) || value.is_a?(Struct)
       end
 
-      if obj.is_a?(Hash)
-        obj.select! { |key, value| ![nil, '', [], {}, nil].include?(value) }
-      end
+      obj.reject! { |_key, value| [nil, '', [], {}, nil].include?(value) } if obj.is_a?(Hash)
 
       obj
     end
@@ -2438,7 +2459,42 @@ Bundler.require(:default)
 require 'minitest/autorun'
 require 'mocha/minitest'
 
-require_relative 'std_out_err_logger'
+class BashCommentFormatterTest < Minitest::Test
+  # Test formatting a normal string without special characters
+  def test_format_simple_string
+    input = 'This is a simple comment.'
+    expected = '# This is a simple comment.'
+    assert_equal expected, BashCommentFormatter.format_comment(input)
+  end
+
+  # Test formatting a string containing hash characters
+  def test_format_string_with_hash
+    input = 'This is a #comment with hash.'
+    expected = '# This is a \\#comment with hash.'
+    assert_equal expected, BashCommentFormatter.format_comment(input)
+  end
+
+  # Test formatting an empty string
+  def test_format_empty_string
+    input = ''
+    expected = '# '
+    assert_equal expected, BashCommentFormatter.format_comment(input)
+  end
+
+  # Test formatting a multi-line string
+  def test_format_multi_line_string
+    input = "This is the first line.\nThis is the second line."
+    expected = "# This is the first line.\n# This is the second line."
+    assert_equal expected, BashCommentFormatter.format_comment(input)
+  end
+
+  # Test formatting strings with leading and trailing whitespace
+  def test_format_whitespace
+    input = '  This has leading and trailing spaces  '
+    expected = '#   This has leading and trailing spaces  '
+    assert_equal expected, BashCommentFormatter.format_comment(input)
+  end
+end
 
 module MarkdownExec
   class TestHashDelegator0 < Minitest::Test
@@ -3294,31 +3350,37 @@ module MarkdownExec
 
   class PathUtilsTest < Minitest::Test
     def test_absolute_path_returns_unchanged
-      absolute_path = "/usr/local/bin"
-      expression = "path/to/*/directory"
+      absolute_path = '/usr/local/bin'
+      expression = 'path/to/*/directory'
       assert_equal absolute_path, PathUtils.resolve_path_or_substitute(absolute_path, expression)
     end
 
     def test_relative_path_gets_substituted
-      relative_path = "my_folder"
-      expression = "path/to/*/directory"
-      expected_output = "path/to/my_folder/directory"
+      relative_path = 'my_folder'
+      expression = 'path/to/*/directory'
+      expected_output = 'path/to/my_folder/directory'
       assert_equal expected_output, PathUtils.resolve_path_or_substitute(relative_path, expression)
     end
 
     def test_path_with_no_slash_substitutes_correctly
-      relative_path = "data"
-      expression = "path/to/*/directory"
-      expected_output = "path/to/data/directory"
+      relative_path = 'data'
+      expression = 'path/to/*/directory'
+      expected_output = 'path/to/data/directory'
       assert_equal expected_output, PathUtils.resolve_path_or_substitute(relative_path, expression)
     end
 
     def test_empty_path_substitution
-      empty_path = ""
-      expression = "path/to/*/directory"
-      expected_output = "path/to//directory"
+      empty_path = ''
+      expression = 'path/to/*/directory'
+      expected_output = 'path/to//directory'
       assert_equal expected_output, PathUtils.resolve_path_or_substitute(empty_path, expression)
     end
-  end
 
+    # Test formatting a string containing UTF-8 characters
+    def test_format_utf8_characters
+      input = 'Unicode test: ā, ö, 💻, and 🚀 are fun!'
+      expected = '# Unicode test: ā, ö, 💻, and 🚀 are fun!'
+      assert_equal expected, BashCommentFormatter.format_comment(input)
+    end
+  end
 end # module MarkdownExec

data/lib/markdown_exec/version.rb

@@ -7,5 +7,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '2.0.3.2'
+  VERSION = '2.0.4'
 end

data/lib/markdown_exec.rb

@@ -23,6 +23,7 @@ require_relative 'env'
 require_relative 'exceptions'
 require_relative 'fcb'
 require_relative 'filter'
+require_relative 'find_files'
 require_relative 'fout'
 require_relative 'hash_delegator'
 require_relative 'input_sequencer'
@@ -102,6 +103,45 @@ end
 module MarkdownExec
   include Exceptions
 
+  class SearchResultsReport < DirectorySearcher
+    def directory_names(search_options, highlight_value)
+      matched_directories = find_directory_names
+      {
+        section_title: 'directory names',
+        data: matched_directories,
+        formatted_text: [{ content: AnsiFormatter.new(search_options).format_and_highlight_array(matched_directories, highlight: [highlight_value]) }]
+      }
+    end
+
+    def file_contents(search_options, highlight_value)
+      matched_contents = find_file_contents.map.with_index do |(file, contents), index|
+        [file, contents.map { |detail| format('=%4.d: %s', detail.index, detail.line) }, index]
+      end
+      {
+        section_title: 'file contents',
+        data: matched_contents.map(&:first),
+        formatted_text: matched_contents.map do |(file, details, index)|
+                { header: format('- %3.d: %s', index + 1, file),
+                  content: AnsiFormatter.new(search_options).format_and_highlight_array(
+                    details,
+                    highlight: [highlight_value]
+                  ) }
+              end
+      }
+    end
+
+    def file_names(search_options, highlight_value)
+      matched_files = find_file_names
+      {
+        section_title: 'file names',
+        data: matched_files,
+        formatted_text: [{ content: AnsiFormatter.new(search_options).format_and_highlight_array(
+          matched_files, highlight: [highlight_value]
+        ).join("\n") }]
+      }
+    end
+  end
+
   ##
   #
   # :reek:DuplicateMethodCall { allow_calls: ['block', 'item', 'lm', 'opts', 'option', '@options', 'required_blocks'] }
@@ -286,6 +326,8 @@ module MarkdownExec
           @options[:path] = pos
         elsif File.exist?(pos)
           @options[:filename] = pos
+        elsif @options[:default_find_select_open]
+          find_value(pos, execute_chosen_found: true)
         else
           raise FileMissingError, pos, caller
         end
@@ -303,6 +345,47 @@ module MarkdownExec
       error_handler('finalize_cli_argument_processing')
     end
 
+    # return { exit: true } to cause app to exit
+    def find_value(value, execute_chosen_found: false)
+      find_path = @options[:find_path].present? ? @options[:find_path] : @options[:path]
+      @fout.fout 'Searching in: ' \
+                 "#{HashDelegator.new(@options).string_send_color(find_path,
+                                                                  :menu_chrome_color)}"
+      searcher = SearchResultsReport.new(value, [find_path])
+      file_names = searcher.file_names(options, value)
+      file_contents = searcher.file_contents(options, value)
+      directory_names = searcher.directory_names(options, value)
+
+      ### search in file contents (block names, chrome, or text)
+      [file_contents,
+       directory_names,
+       file_names].each do |data|
+        @fout.fout "In #{data[:section_title]}" if data[:section_title]
+        next unless data[:formatted_text]
+
+        data[:formatted_text].each do |fi|
+          @fout.fout fi[:header] if fi[:header]
+          @fout.fout fi[:content] if fi[:content]
+        end
+      end
+      return { exit: true } unless execute_chosen_found
+
+      ## pick a document to open
+      #
+      files = directory_names[:data].map do |dn|
+        find_files('*', [dn], exclude_dirs: true)
+      end.flatten(1)
+      choices = \
+       [{ disabled: '', name: "in #{file_names[:section_title]}".cyan }] \
+       + file_names[:data] \
+       + [{ disabled: '', name: "in #{directory_names[:section_title]}".cyan }] \
+       + files \
+       + [{ disabled: '', name: "in #{file_contents[:section_title]}".cyan }] \
+       + file_contents[:data]
+      @options[:filename] = select_document_if_multiple(choices)
+      { exit: false }
+    end
+
     ## Sets up the options and returns the parsed arguments
     #
     def initialize_and_parse_cli_options
@@ -344,35 +427,9 @@ module MarkdownExec
         ->(value) { tap_config value: value }
       when 'exit'
         ->(_) { exit }
-      when 'find'
+      when 'find', 'open'
         ->(value) {
-          find_path = @options[:find_path].present? ? @options[:find_path] : @options[:path]
-          @fout.fout 'Searching in: ' \
-                     "#{HashDelegator.new(@options).string_send_color(find_path,
-                                                                      :menu_chrome_color)}"
-          searcher = DirectorySearcher.new(value, [find_path])
-
-          @fout.fout 'In file contents'
-          hash = searcher.search_in_file_contents
-          hash.each.with_index do |(key, v2), i1|
-            @fout.fout format('- %3.d: %s', i1 + 1, key)
-            @fout.fout AnsiFormatter.new(options).format_and_highlight_array(
-              v2.map { |nl| format('=%4.d: %s', nl.index, nl.line) },
-              highlight: [value]
-            )
-          end
-
-          @fout.fout 'In directory names'
-          @fout.fout AnsiFormatter.new(options).format_and_highlight_array(
-            searcher.search_in_directory_names, highlight: [value]
-          )
-
-          @fout.fout 'In file names'
-          @fout.fout AnsiFormatter.new(options).format_and_highlight_array(
-            searcher.search_in_file_names, highlight: [value]
-          ).join("\n")
-
-          exit
+          exit if find_value(value, execute_chosen_found: procname == 'open').fetch(:exit, false)
         }
       when 'help'
         ->(_) {
@@ -553,9 +610,7 @@ module MarkdownExec
     end
 
     def saved_name_split(name)
-      # rubocop:disable Layout/LineLength
       mf = /#{@options[:saved_script_filename_prefix]}_(?<time>[0-9\-]+)_(?<file>.+)_,_(?<block>.+)\.sh/.match(name)
-      # rubocop:enable Layout/LineLength
       return unless mf
 
       @options[:block_name] = mf[:block]
@@ -578,7 +633,8 @@ module MarkdownExec
     def select_option_or_exit(prompt_text, strings, opts = {})
       result = @options.select_option_with_metadata(prompt_text, strings,
                                                     opts)
-      return unless result.fetch(:option, nil)
+      ### 2024-04-20 what for?
+      # return unless result.fetch(:option, nil)
 
       result[:selected]
     end

data/lib/menu.src.yml

@@ -82,7 +82,7 @@
 - :arg_name: BOOL
   :default: true
   :description: debounce_execution
-  :env_var: MDE_debounce_execution
+  :env_var: MDE_DEBOUNCE_EXECUTION
   :opt_name: debounce_execution
   :procname: val_as_bool
 
@@ -94,6 +94,13 @@
   :procname: debug
   :short_name: d
 
+- :arg_name: BOOL
+  :default: true
+  :description: default_find_select_open
+  :env_var: MDE_DEFAULT_FIND_SELECT_OPEN
+  :opt_name: default_find_select_open
+  :procname: val_as_bool
+
 - :default: "> "
   :env_var: MDE_DISPLAY_LEVEL_XBASE_PREFIX
   :opt_name: display_level_xbase_prefix
@@ -716,6 +723,13 @@
   :opt_name: no_chrome
   :procname: val_as_bool
 
+- :arg_name: OPEN
+  :default: ''
+  :description: Find argument in documents, present list, and open user selection
+  :long_name: open
+  :procname: open
+  :short_name: o
+
 - :default:
   :description: Expression to match to start collecting lines
   :env_var: MDE_OUTPUT_ASSIGNMENT_BEGIN

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (2.0.3.2)
+# MDE - Markdown Executor (2.0.4)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -69,7 +69,7 @@
 - :arg_name: BOOL
   :default: true
   :description: debounce_execution
-  :env_var: MDE_debounce_execution
+  :env_var: MDE_DEBOUNCE_EXECUTION
   :opt_name: debounce_execution
   :procname: val_as_bool
 - :arg_name: BOOL
@@ -79,6 +79,12 @@
   :long_name: debug
   :procname: debug
   :short_name: d
+- :arg_name: BOOL
+  :default: true
+  :description: default_find_select_open
+  :env_var: MDE_DEFAULT_FIND_SELECT_OPEN
+  :opt_name: default_find_select_open
+  :procname: val_as_bool
 - :default: "> "
   :env_var: MDE_DISPLAY_LEVEL_XBASE_PREFIX
   :opt_name: display_level_xbase_prefix
@@ -600,6 +606,12 @@
   :env_var: MDE_NO_CHROME
   :opt_name: no_chrome
   :procname: val_as_bool
+- :arg_name: OPEN
+  :default: ''
+  :description: Find argument in documents, present list, and open user selection
+  :long_name: open
+  :procname: open
+  :short_name: o
 - :default:
   :description: Expression to match to start collecting lines
   :env_var: MDE_OUTPUT_ASSIGNMENT_BEGIN

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.0.3.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard