markdown_exec 1.7 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97045160c53b7dca3998f6d700bf136f500826141d226f9f2cc650d15e6d1ba7
-  data.tar.gz: c69c23b07fcb3304d0209f79596619fbe54d0c2bb9a03f94c8598e3358c25ed7
+  metadata.gz: c4fdb41b414911d16030ffbfb8c4b07ca8c09e3684f21e123d0d99cd738dba3d
+  data.tar.gz: 70c1ec9fb9b795d0cbdcc87ceb03809a57af5901a70dc2b1d319c9451592d687
 SHA512:
-  metadata.gz: a525dc3c727c38aba2d52382871650b6d2636891028a6def27f8958fcd78ae46afcb8fbbeb0f1bfdb0d550beb22c7cc90c67744c52143490f0a27c75c9158442
-  data.tar.gz: ae304dc41d17d2763a17b518da50956f0271ca401a4bc78929200eeb17ab3d19dfd148db76f104aed8216120c38673d19c9e56af018d3c9d83534c8901cc0915
+  metadata.gz: abea63db83a4d785bce7c2ec1c9babebe6d78637872a068c4d6b2169832de8ea707a2c3ae426f6cd5ea548269194a797d95abdd7fceb286c4efa49da9d591bfe
+  data.tar.gz: 1b102cb3e898789d6ddf2a401f90cfee04403ea135a14a5067673b250855aef569ca3b39a171570930ef5946d52874d022fb19fd9cf7c1561737144aefc5ef3c

data/.rubocop.yml

@@ -14,9 +14,9 @@ Layout/LineContinuationLeadingSpace:
   Enabled: false
 
 Layout/LineLength:
-  Max: 78
+  # Max: 78
   # Max: 80
-  # Max: 96
+  Max: 96
 
 Lint/Debugger:
   Enabled: false
@@ -72,6 +72,9 @@ Style/FormatStringToken:
 Style/GlobalVars:
   Enabled: false
 
+Style/Lambda:
+  Enabled: false
+
 Style/MixinUsage:
   Enabled: false
 

data/Gemfile.lock

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

data/Rakefile

@@ -79,6 +79,7 @@ task :minitest do
   commands = [
     './lib/block_label.rb',
     './lib/cached_nested_file_reader.rb',
+    './lib/directory_searcher.rb',
     './lib/fcb.rb',
     './lib/filter.rb',
     './lib/hash_delegator.rb',

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.7"
+  echo "1.8"
 }
 
 _mde() {
@@ -40,6 +40,14 @@ _mde() {
             
               -f) COMPREPLY="."; return 0 ;;
             
+              --find) COMPREPLY="''"; return 0 ;;
+            
+              -?) COMPREPLY="''"; return 0 ;;
+            
+              --how) COMPREPLY="''"; return 0 ;;
+            
+              -?) COMPREPLY="''"; return 0 ;;
+            
               --list-count) COMPREPLY="32"; return 0 ;;
             
               --output-execution-summary) COMPREPLY="0"; return 0 ;;
@@ -74,7 +82,7 @@ _mde() {
   # present matching option names
   #
   if [[ ${cur} == -* ]] ; then
-    opts=("--block-name" "--config" "--debug" "--exit" "--filename" "--help" "--list-blocks" "--list-count" "--list-default-env" "--list-default-yaml" "--list-docs" "--list-recent-output" "--list-recent-scripts" "--output-execution-summary" "--output-script" "--output-stdout" "--path" "--pwd" "--run-last-script" "--save-executed-script" "--save-execution-output" "--saved-script-folder" "--saved-stdout-folder" "--select-recent-output" "--select-recent-script" "--tab-completions" "--user-must-approve" "--version" "--display-level")
+    opts=("--block-name" "--config" "--debug" "--exit" "--filename" "--find" "--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
@@ -101,6 +109,14 @@ _mde() {
         
           -f) COMPREPLY=".RELATIVE_PATH."; return 0 ;;
         
+          --find) COMPREPLY=".FIND."; return 0 ;;
+        
+          -?) COMPREPLY=".FIND."; return 0 ;;
+        
+          --how) COMPREPLY=".HOW."; return 0 ;;
+        
+          -?) COMPREPLY=".HOW."; return 0 ;;
+        
           --list-count) COMPREPLY=".INT.1-."; return 0 ;;
         
           --output-execution-summary) COMPREPLY=".BOOL."; return 0 ;;
@@ -138,4 +154,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2023-12-01 18:34:38 UTC"
+# echo "Updated: 2023-12-11 19:58:50 UTC"

data/examples/colors.md

@@ -0,0 +1,48 @@
+# Demo configuring options
+
+::: These Opts blocks set the color for all elements.
+
+```opts :(document_options)
+```
+```opts :(default)
+exception_color_detail:                fg_rgbh_E0_E0_20  # Color of exception detail
+exception_color_name:                  fg_rgbh_E0_20_20  # Color of exception name
+execution_report_preview_frame_color:  fg_rgbh_20_80_80  # execution_report_preview_frame_color
+menu_bash_color:                       fg_rgbh_40_C0_F0  # Color of menu bash
+menu_chrome_color:                     fg_rgbh_80_80_20  # Color of menu chrome
+menu_divider_color:                    fg_rgbh_20_98_80  # Color of menu divider
+menu_link_color:                       fg_rgbh_20_E0_20  # Color of menu link
+menu_note_color:                       fg_rgbh_40_A0_A0  # Color of menu note
+menu_opts_color:                       fg_rgbh_E0_60_E0  # Color of menu opts
+menu_opts_set_color:                   fg_rgbh_E0_20_20  # Color of menu opts
+menu_task_color:                       fg_rgbh_A0_20_D0  # Color of menu task
+menu_vars_color:                       fg_rgbh_E0_80_20  # Color of menu vars
+menu_vars_set_color:                   fg_rgbh_E0_80_20  # Color of menu vars
+output_execution_label_name_color:     fg_rgbh_20_D8_80  # Color of output_execution_label_name
+output_execution_label_value_color:    fg_rgbh_20_E0_80  # Color of output_execution_label_value
+prompt_color_after_script_execution:   fg_rgbh_20_E8_80  # Color of prompt after script execution
+script_execution_frame_color:          fg_rgbh_20_80_80  # script_execution_frame_color
+script_preview_frame_color:            fg_rgbh_20_80_80  # Color of output divider
+warning_color:                         fg_rgbh_E0_E0_20  # Color of warning message
+```
+
+::: Example blocks
+
+```bash :Bash1
+```
+```link :Link1
+```
+```opts :Opts1
+```
+```port :Port1
+```
+```vars :Vars1
+```
+[ ] 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

data/examples/include.md

@@ -1,12 +1,19 @@
 ```bash :(one)
-a
+echo block "one"
 ```
+
 ```bash :two +(one)
-b
+echo block "two" requires one
 ```
+
 ```bash :(three) +two +(one)
-c
+echo block "three" requires two and one
 ```
+
 ```bash :four +(three)
-d
+echo block "four" requires three
+```
+
+```bash :trigger_unmet_dependency +(unmet)
+echo block "five" requires an unmet dependency
 ```

data/examples/opts.md

@@ -19,4 +19,11 @@ menu_task_color: fg_rgb_127_127_255
 menu_divider_color: green
 menu_link_color: fg_rgbh_88_cc_66
 menu_note_color: yellow
+
+menu_note_match: "^\\s*(?<line>[^\\s/].*)\\s*$" # Pattern for notes in block selection menu; start with any char except '/'
 ```
+
+note 1
+note 2 ends with /
+ / note 3 starts with /
+note 4

data/lib/ansi_formatter.rb

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+class AnsiFormatter
+  def initialize(options = {})
+    @options = options
+  end
+
+  def format_and_highlight_array(
+    data,
+    highlight_color_sym: :exception_color_detail,
+    plain_color_sym: :menu_chrome_color,
+    label: 'Data:',
+    highlight: [],
+    line_prefix: '  ',
+    line_postfix: '',
+    detail_sep: ''
+  )
+    (data&.map do |item|
+      scan_and_process_multiple_substrings(item, highlight, plain_color_sym,
+                                           highlight_color_sym).join
+      # color_sym = highlight.include?(item) ? highlight_color_sym : c
+      # string_send_color(item, color_sym)
+    end || []) #.join
+    # formatted_deps
+    # "#{line_prefix}#{string_send_color(label, highlight_color_sym)}#{line_postfix}\n" + formatted_deps.join("\n")
+  end
+
+  # Formats and highlights a list of data. data are presented with indentation,
+  # and specific items can be highlighted in a specified color, while others are shown in a plain color.
+  #
+  # @param data [Hash] A hash of data, where each key is a dependency name,
+  #        and its value is an array of sub-items.
+  # @param highlight_color_sym [Symbol] The color method to apply to highlighted items.
+  #        Default is :exception_color_detail.
+  # @param plain_color_sym [Symbol] The color method for non-highlighted items.
+  #        Default is :menu_chrome_color.
+  # @param label [String] The label to prefix the list of data with.
+  #        Default is 'data:'.
+  # @param highlight [Array] An array of items to highlight. Each item in this array will be
+  #        formatted with the specified highlight color.
+  # @param line_prefix [String] Prefix for each line. Default is '  '.
+  # @param line_postfix [String] Postfix for each line. Default is ''.
+  # @param detail_sep [String] Separator for items in the sub-list. Default is '  '.
+  # @return [String] A formatted string representation of the data with highlighted items.
+  def format_and_highlight_hash(
+    data,
+    highlight_color_sym: :exception_color_detail,
+    plain_color_sym: :menu_chrome_color,
+    label: 'Data:',
+    highlight: [],
+    line_prefix: '  ',
+    line_postfix: '',
+    detail_sep: '  '
+  )
+    formatted_deps = data&.map do |dep_name, sub_items|
+      formatted_sub_items = sub_items.map do |item|
+        color_sym = highlight.include?(item) ? highlight_color_sym : plain_color_sym
+        string_send_color(item, color_sym)
+      end.join(detail_sep)
+
+      "#{line_prefix}- #{string_send_color(dep_name,
+                                           highlight.include?(dep_name) ? highlight_color_sym : plain_color_sym)}: #{formatted_sub_items}#{line_postfix}"
+    end || []
+
+    "#{line_prefix}#{string_send_color(label,
+                                       highlight_color_sym)}#{line_postfix}\n" + formatted_deps.join("\n")
+  end
+
+  # Function to scan a string and process its segments based on multiple substrings
+  # @param str [String] The string to scan.
+  # @param substrings [Array<String>] The substrings to match in the string.
+  # @param plain_sym [Symbol] The symbol for non-matching segments.
+  # @param color_sym [Symbol] The symbol for matching segments.
+  # @return [Array<String>] The processed segments.
+  def scan_and_process_multiple_substrings(str, substrings, plain_sym, color_sym)
+    return string_send_color(str, plain_sym) if substrings.empty? || substrings.any?(&:empty?)
+
+    results = []
+    remaining_str = str.dup
+
+    while remaining_str.length.positive?
+      match_indices = substrings.map { |substring| remaining_str.index(substring) }.compact
+      earliest_match = match_indices.min
+
+      if earliest_match
+        # Process non-matching segment before the earliest match, if any
+        unless earliest_match.zero?
+          non_matching_segment = remaining_str.slice!(0...earliest_match)
+          results << string_send_color(non_matching_segment, plain_sym)
+        end
+
+        # Find which substring has this earliest match
+        matching_substring = substrings.find do |substring|
+          remaining_str.index(substring) == earliest_match
+        end
+
+        if matching_substring
+          matching_segment = remaining_str.slice!(0...matching_substring.length)
+          results << string_send_color(matching_segment, color_sym)
+        end
+      else
+        # Process the remaining non-matching segment
+        results << string_send_color(remaining_str, plain_sym)
+        break
+      end
+    end
+
+    results
+  end
+
+  # Function to scan a string and process its segments
+  # @param str [String] The string to scan.
+  # @param substring [String] The substring to match in the string.
+  # @param plain_sym [Symbol] The symbol for non-matching segments.
+  # @param color_sym [Symbol] The symbol for matching segments.
+  # @return [Array<String>] The processed segments.
+  def scan_and_process_string(str, substring, plain_sym, color_sym)
+    return string_send_color(str, plain_sym) unless substring.present?
+
+    results = []
+    remaining_str = str.dup
+
+    while remaining_str.length.positive?
+      match_index = remaining_str.index(substring)
+      if match_index
+        # Process non-matching segment before the match, if any
+        unless match_index.zero?
+          non_matching_segment = remaining_str.slice!(0...match_index)
+          results << string_send_color(non_matching_segment, plain_sym)
+        end
+
+        # Process the matching segment
+        matching_segment = remaining_str.slice!(0...substring.length)
+        results << string_send_color(matching_segment, color_sym)
+      else
+        # Process the remaining non-matching segment
+        results << string_send_color(remaining_str, plain_sym)
+        break
+      end
+    end
+
+    results
+  end
+
+  # # Example usage
+  # scan_and_process_string("Hello world, hello universe", "hello", :plain, :color)
+
+  # Applies a color method to a string based on the provided color symbol.
+  # The color method is fetched from @options and applied to the string.
+  # @param string [String] The string to which the color will be applied.
+  # @param color_sym [Symbol] The symbol representing the color method.
+  # @param default [String] Default color method to use if color_sym is not found in @options.
+  # @return [String] The string with the applied color method.
+  def string_send_color(string, color_sym, default: 'plain')
+    color_method = @options.fetch(color_sym, default).to_sym
+    string.to_s.send(color_method)
+  end
+end

data/lib/directory_searcher.rb

@@ -0,0 +1,239 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+require 'find'
+
+# Formats and highlights a list of dependencies. Dependencies are presented with indentation,
+# and specific items can be highlighted in a specified color, while others are shown in a plain color.
+#
+# @param dependencies [Hash] A hash of dependencies, where each key is a dependency name,
+#        and its value is an array of sub-items.
+# @param highlight_color_sym [Symbol] The color method to apply to highlighted items.
+#        Default is :exception_color_detail.
+# @param plain_color_sym [Symbol] The color method for non-highlighted items.
+#        Default is :menu_chrome_color.
+# @param label [String] The label to prefix the list of dependencies with.
+#        Default is 'Dependencies:'.
+# @param highlight [Array] An array of items to highlight. Each item in this array will be
+#        formatted with the specified highlight color.
+# @param line_prefix [String] Prefix for each line. Default is '  '.
+# @param line_postfix [String] Postfix for each line. Default is ''.
+# @param detail_sep [String] Separator for items in the sub-list. Default is '  '.
+# @return [String] A formatted string representation of the dependencies with highlighted items.
+def format_and_highlight_dependencies(
+  dependencies,
+  highlight_color_sym: :exception_color_detail,
+  plain_color_sym: :menu_chrome_color,
+  label: 'Dependencies:',
+  highlight: [],
+  line_prefix: '  ',
+  line_postfix: '',
+  detail_sep: '  '
+)
+  formatted_deps = dependencies&.map do |dep_name, sub_items|
+    formatted_sub_items = sub_items.map do |item|
+      color_sym = highlight.include?(item) ? highlight_color_sym : plain_color_sym
+      string_send_color(item, color_sym)
+    end.join(detail_sep)
+
+    "#{line_prefix}- #{string_send_color(dep_name,
+                                         highlight.include?(dep_name) ? highlight_color_sym : plain_color_sym)}: #{formatted_sub_items}#{line_postfix}"
+  end || []
+
+  "#{line_prefix}#{string_send_color(label,
+                                     highlight_color_sym)}#{line_postfix}\n" + formatted_deps.join("\n")
+end
+# warn menu_blocks.to_yaml.sub(/^(?:---\n)?/, "MenuBlocks:\n")
+
+IndexedLine = Struct.new(:index, :line) do
+  def to_s
+    line
+  end
+end
+
+# Class DirectorySearcher
+# This class provides methods to search for a specified pattern
+# in directory names, file names, and contents of files within given paths.
+class DirectorySearcher
+  attr_reader :pattern, :paths, :include_subdirectories, :filename_glob
+
+  # Constructor
+  # @param pattern [Regexp] The regular expression pattern to search for.
+  # @param paths [Array<String>] List of directories to search in.
+  # @param include_subdirectories [Boolean] Whether to search in subdirectories.
+  # @param filename_glob [String, nil] Glob pattern for file names.
+  def initialize(pattern, paths, include_subdirectories: true, filename_glob: '*.[Mm][Dd]') #'*.md'
+    @pattern = pattern
+    @paths = paths
+    @include_subdirectories = include_subdirectories
+    @filename_glob = filename_glob
+  end
+
+  # Searches for the pattern in directory names.
+  # @return [Array<String>] List of matching directory names.
+  def search_in_directory_names
+    match_dirs = []
+    @paths.each do |path|
+      Find.find(path) do |p|
+        # p 'search_in_directory_names', p
+        # Find.prune unless @include_subdirectories || path == p
+        match_dirs << p if File.directory?(p) && p.match?(@pattern)
+      end
+    end
+    match_dirs
+  end
+
+  # Searches for the pattern in file names.
+  # @return [Array<String>] List of matching file names.
+  def search_in_file_names
+    match_files = []
+    @paths.each do |path|
+      Find.find(path) do |p|
+        # Find.prune unless @include_subdirectories || path == p
+        next unless File.file?(p)
+
+        file_name = File.basename(p)
+        next if @filename_glob && !File.fnmatch(@filename_glob, file_name)
+
+        begin
+          match_files << p if file_name.encode('UTF-8', invalid: :replace, undef: :replace,
+                                                        replace: '').match?(@pattern)
+        rescue EncodingError
+          # Optionally log the file with encoding issues
+          # puts "Encoding error in file: #{p}"
+        end
+      end
+    end
+    match_files
+  end
+
+  # 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
+    match_details = {}
+
+    @paths.each do |path|
+      Find.find(path) do |p|
+        Find.prune unless @include_subdirectories || path == p
+        next unless File.file?(p)
+
+        next if @filename_glob && !File.fnmatch(@filename_glob, File.basename(p))
+
+        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)
+              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
+        rescue EncodingError
+          # Optionally log the file with encoding issues
+          # puts "Encoding error in file: #{p}"
+        end
+      end
+    end
+
+    match_details
+  end
+
+  # # Searches for the pattern in the contents of the files.
+  # # @return [Array<String>] List of matching lines from files.
+  # def search_in_file_contents
+  #   match_lines = []
+  #   @paths.each do |path|
+  #     Find.find(path) do |p|
+  #       Find.prune unless @include_subdirectories || path == p
+  #       next unless File.file?(p)
+
+  #       next if @filename_glob && !File.fnmatch(@filename_glob, File.basename(p))
+
+  #       begin
+  #         File.foreach(p).with_index do |line, _line_num|
+  #           line_utf8 = line.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')
+  #           match_lines << line_utf8.chomp if line_utf8.match?(@pattern)
+  #         end
+  #       rescue EncodingError
+  #         # Optionally log the file with encoding issues
+  #         # puts "Encoding error in file: #{p}"
+  #       end
+  #     end
+  #   end
+  #   match_lines
+  # end
+end
+
+if $PROGRAM_NAME == __FILE__
+  require 'bundler/setup'
+  Bundler.require(:default)
+
+  require 'minitest/autorun'
+  # require 'mocha/minitest'
+  # require_relative 'directory_searcher'
+
+  # Test class for DirectorySearcher
+  class DirectorySearcherTest < Minitest::Test
+    # Setup method to initialize common test data
+    def setup
+      @pattern = /test_pattern/
+      @paths = ['./spec']
+      @searcher = DirectorySearcher.new(@pattern, @paths)
+    end
+
+    # Test search_in_directory_names method
+    def test_search_in_directory_names
+      # Add assertions based on your test directory structure and expected results
+      assert_equal [], @searcher.search_in_directory_names
+    end
+
+    # Test search_in_file_names method
+    def test_search_in_file_names
+      # Add assertions based on your test directory structure and expected results
+      assert_equal [], @searcher.search_in_file_names
+    end
+
+    # Test search_in_file_contents method
+    def test_search_in_file_contents
+      # Add assertions based on your test directory structure and expected results
+      assert_equal ({}), @searcher.search_in_file_contents
+    end
+  end
+
+  # Test class for DirectorySearcher
+  class DirectorySearcherTest2 < Minitest::Test
+    # Setup method to initialize common test data
+    def setup
+      @pattern_spec = /spec/
+      @paths = ['./spec']
+      @filename_glob = nil
+      @searcher_spec = DirectorySearcher.new(@pattern_spec, @paths,
+                                             filename_glob: @filename_glob)
+    end
+
+    # Test search_in_directory_names method for 'spec'
+    def test_search_in_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
+    end
+
+    # Test search_in_file_names method for 'spec'
+    def test_search_in_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
+    end
+
+    # # Test search_in_file_contents method for 'spec'
+    # def test_search_in_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
+    # end
+  end
+
+end

data/lib/env.rb

@@ -18,8 +18,7 @@ module Env
 
   # :reek:UtilityFunction
   def env_bool_false(name)
-    !(val = (name && ENV.fetch(name,
-                               nil))).nil? && !(val.empty? || val == '0')
+    !(val = (name && ENV.fetch(name, nil))).nil? && !(val.empty? || val == '0')
   end
 
   # skip :reek:DataClump