markdown_exec 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eadeecd7019d53202aabe57d9486ee616826e6b5f42fce0fa24f8e377c1b50e5
-  data.tar.gz: cde007bddd4821263045eeba415cc1e2f42591d03294fc678c4093384373146b
+  metadata.gz: eb96e0d1b92398066dedcaf7017ee6d7deea37ef9ba19fa089de6c4e5aebf27d
+  data.tar.gz: f8b8ffcb0f30fbec9321a4a9f14ae7568b16b31e40833046fb1ab16ddcf28c1b
 SHA512:
-  metadata.gz: 5a4a3a36d420c41403be33dbc7ac8e53f446dac53ba3ce8e9cd2fafb1ff0c1026aa1df633f6d79e1742ea11a07f71bd3f64df95f772798ff4624b8c36a8f93b2
-  data.tar.gz: 1acc6cb2bf716b30a1ab8037ad0e43ff3646b23b991cd1bd9d31b1aad37ccf6ae97bd01eaeecc57e644ceb580a9aa9bf61742075777a528ffc180a43a955ccb1
+  metadata.gz: 96a95683c52b4a7546d2cb1ce399dd6c278a7783305d70e12a0a8ac5c70df739705a0ccb06a14f8861ca5794193f201ab185cd7e994e6fcc4eef56a0f038504e
+  data.tar.gz: 51991405ec7dae5c31dcc1ff6294172279d046975647ca8676b4e28918d2ff954a19e671bae4cc7381963816f8b0826b4723c4bf61fb6a35fd8fce25e808ed63

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [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.5)
       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.5"
 }
 
 _mde() {
@@ -194,4 +194,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-04-26 15:37:23 UTC"

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/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

@@ -37,9 +37,7 @@ 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
 
     matched_files += files
   end

data/lib/hash_delegator.rb

@@ -232,16 +232,46 @@ module HashDelegatorSelf
     FileUtils.rm_f(path)
   end
 
-  # Evaluates the given string as Ruby code and rescues any StandardErrors.
+  # Evaluates the given string as Ruby code within a safe context.
   # If an error occurs, it calls the error_handler method with 'safeval'.
   # @param str [String] The string to be evaluated.
   # @return [Object] The result of evaluating the string.
   def safeval(str)
-    eval(str)
+    # # Restricting to evaluate only expressions
+    # unless str.match?(/\A\s*\w+\s*[\+\-\*\/\=\%\&\|\<\>\!]+\s*\w+\s*\z/)
+    #   error_handler('safeval') # 'Invalid expression'
+    #   return
+    # end
+
+    # # Whitelisting allowed operations
+    # allowed_methods = %w[+ - * / == != < > <= >= && || % & |]
+    # unless allowed_methods.any? { |op| str.include?(op) }
+    #   error_handler('safeval', 'Operation not allowed')
+    #   return
+    # end
+
+    # # Sanitize input (example: removing potentially harmful characters)
+    # str = str.gsub(/[^0-9\+\-\*\/\(\)\<\>\!\=\%\&\|]/, '')
+
+    # Evaluate the sanitized string
+    result = nil
+    binding.eval("result = #{str}")
+
+    result
   rescue StandardError # catches NameError, StandardError
     error_handler('safeval')
   end
 
+  # # Evaluates the given string as Ruby code and rescues any StandardErrors.
+  # # If an error occurs, it calls the error_handler method with 'safeval'.
+  # # @param str [String] The string to be evaluated.
+  # # @return [Object] The result of evaluating the string.
+  # def safeval(str)
+  #   eval(str)
+  # rescue StandardError # catches NameError, StandardError
+  #   error_handler('safeval')
+  # end
+
   def set_file_permissions(file_path, chmod_value)
     File.chmod(chmod_value, file_path)
   end
@@ -1321,6 +1351,18 @@ module MarkdownExec
       PathUtils.resolve_path_or_substitute(gets.chomp, filespec)
     end
 
+    # def read_block_name(line)
+    #   bm = extract_named_captures_from_option(line, @delegate_object[:block_name_match])
+    #   name = bm[:title]
+
+    #   if @delegate_object[:block_name_nick_match].present? && line =~ Regexp.new(@delegate_object[:block_name_nick_match])
+    #     name = $~[0]
+    #   else
+    #     name = bm && bm[1] ? bm[:title] : name
+    #   end
+    #   name
+    # end
+
     # Handle expression with wildcard characters
     # allow user to select or enter
     def save_filespec_wildcard_expansion(filespec)
@@ -1813,6 +1855,22 @@ module MarkdownExec
       end
     end
 
+    # Check if the delegate object responds to a given method.
+    # @param method_name [Symbol] The name of the method to check.
+    # @param include_private [Boolean] Whether to include private methods in the check.
+    # @return [Boolean] true if the delegate object responds to the method, false otherwise.
+    def respond_to?(method_name, include_private = false)
+      if super
+        true
+      elsif @delegate_object.respond_to?(method_name, include_private)
+        true
+      elsif method_name.to_s.end_with?('=') && @delegate_object.respond_to?(:[]=, include_private)
+        true
+      else
+        @delegate_object.respond_to?(method_name, include_private)
+      end
+    end
+
     def runtime_exception(exception_sym, name, items)
       if @delegate_object[exception_sym] != 0
         data = { name: name, detail: items.join(', ') }
@@ -2120,7 +2178,6 @@ 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?
@@ -2128,14 +2185,15 @@ module MarkdownExec
         opts[:per_page] = opts[:select_page_height] = [IO.console.winsize[0] - 3, 4].max
       end
 
+      # crashes if all menu options are disabled
       selection = @prompt.select(prompt_text,
                                  names,
                                  opts.merge(filter: true))
       item = names.find do |item|
-        if item.instance_of?(String)
-          item == selection
-        else
+        if item.instance_of?(Hash)
           item[:dname] == selection
+        else
+          item == selection
         end
       end
       item = { dname: item } if item.instance_of?(String)

data/lib/input_sequencer.rb

@@ -19,7 +19,7 @@ class InputSequencer
     @document_filename = document_filename
     @current_block = nil
     @block_queue = initial_blocks
-    @debug = Env::env_bool('INPUT_SEQUENCER_DEBUG', default: false) ### false e
+    @debug = Env.env_bool('INPUT_SEQUENCER_DEBUG', default: false)
   end
 
   # Merges the current menu state with the next, prioritizing the next state's values.
@@ -33,9 +33,11 @@ class InputSequencer
       inherited_lines: next_state.inherited_lines,
       prior_block_was_link: next_state.prior_block_was_link.nil? ? current.prior_block_was_link : next_state.prior_block_was_link
     )
+  # rubocop:disable Style/RescueStandardError
   rescue
     pp $!, $@
     exit 1
+    # rubocop:enable Style/RescueStandardError
   end
 
   # Generates the next menu state based on provided attributes.
@@ -69,7 +71,6 @@ class InputSequencer
     loop do
       break if run_yield(:parse_document, now_menu.document_filename, &block) == :break
 
-      pp [__LINE__, 'exit_when_bq_empty', exit_when_bq_empty, '@block_queue', @block_queue, 'now_menu', now_menu] if @debug
       # self.imw_ins now_menu, 'now_menu'
 
       break if exit_when_bq_empty && bq_is_empty? && !now_menu.prior_block_was_link
@@ -81,14 +82,13 @@ class InputSequencer
         choice = run_yield :user_choice, &block
 
         if choice.nil?
-          raise "Block not recognized."
+          raise 'Block not recognized.'
           break
         end
         break if run_yield(:exit?, choice&.downcase, &block) # Exit loop and method to terminate the app
 
         next_state = run_yield :execute_block, choice, &block
         # imw_ins next_state, 'next_state'
-        pp [__LINE__, 'next_state', next_state] if @debug
         return :break if next_state == :break
 
         next_menu = next_state
@@ -102,7 +102,6 @@ class InputSequencer
           block_name = @block_queue.shift
         end
         # self.imw_ins block_name, 'block_name'
-        pp [__LINE__, 'block_name', block_name] if @debug
 
         next_menu = if block_name == '.'
                       exit_when_bq_empty = false
@@ -112,15 +111,16 @@ class InputSequencer
                       state.display_menu = bq_is_empty?
                       state
                     end
-        pp [__LINE__, 'next_menu', next_menu] if @debug
         next_menu
         # imw_ins next_menu, 'next_menu'
       end
       now_menu = InputSequencer.merge_link_state(now_menu, next_menu)
     end
+  # rubocop:disable Style/RescueStandardError
   rescue
     pp $!, $@
     exit 1
+    # rubocop:enable Style/RescueStandardError
   end
 end
 

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.4'
+  VERSION = '2.0.5'
 end

data/lib/markdown_exec.rb

@@ -9,6 +9,7 @@ require 'fileutils'
 require 'open3'
 require 'optparse'
 require 'shellwords'
+require 'time'
 require 'tmpdir'
 require 'tty-prompt'
 require 'yaml'
@@ -103,6 +104,79 @@ end
 module MarkdownExec
   include Exceptions
 
+  class FileInMenu
+    # Prepends the age of the file in days to the file name for display in a menu.
+    # @param filename [String] the name of the file
+    # @return [String] modified file name with age prepended
+    def self.for_menu(filename)
+      file_age = (Time.now - File.mtime(filename)) / (60 * 60 * 24 * 30)
+
+      "  #{Histogram.display(file_age, 0, 11, 12, inverse: false)}: #{filename}"
+    end
+
+    # Removes the age from the string to retrieve the original file name.
+    # @param filename_with_age [String] the modified file name with age
+    # @return [String] the original file name
+    def self.from_menu(filename_with_age)
+      filename_with_age.split(': ', 2).last
+    end
+  end
+
+  # A class that generates a histogram bar in terminal using xterm-256 color codes.
+  class Histogram
+    # Generates and prints a histogram bar for a given value within a specified range and width, with an option for inverse display.
+    # @param integer_value [Integer] the value to represent in the histogram
+    # @param min [Integer] the minimum value of the range
+    # @param max [Integer] the maximum value of the range
+    # @param width [Integer] the total width of the histogram in characters
+    # @param inverse [Boolean] whether the histogram is displayed in inverse order (right to left)
+    def self.display(integer_value, min, max, width, inverse: false)
+      return if max <= min # Ensure the range is valid
+
+      # Normalize the value within the range 0 to 1
+      normalized_value = [0, [(integer_value - min).to_f / (max - min), 1].min].max
+
+      # Calculate how many characters should be filled
+      filled_length = (normalized_value * width).round
+
+      # # Generate the histogram bar using xterm-256 colors (color code 42 is green)
+      # filled_bar = "\e[48;5;42m" + ' ' * filled_length + "\e[0m"
+      filled_bar = ('¤' * filled_length).fg_rgbh_AF_AF_00
+      empty_bar = ' ' * (width - filled_length)
+
+      # Determine the order of filled and empty parts based on the inverse flag
+      inverse ? (empty_bar + filled_bar) : (filled_bar + empty_bar)
+    end
+  end
+
+  class MenuBuilder
+    def initialize
+      @chrome_color = :cyan
+      @o_color = :red
+    end
+
+    def build_menu(file_names, directory_names, found_in_block_names, files_in_directories, vbn)
+      choices = []
+
+      # Adding section title and data for file names
+      choices << { disabled: '', name: "in #{file_names[:section_title]}".send(@chrome_color) }
+      choices += file_names[:data].map { |str| FileInMenu.for_menu(str) }
+
+      # Conditionally add directory names if data is present
+      unless directory_names[:data].count.zero?
+        choices << { disabled: '', name: "in #{directory_names[:section_title]}".send(@chrome_color) }
+        choices += files_in_directories
+      end
+
+      # Adding found in block names
+      choices << { disabled: '', name: "in #{found_in_block_names[:section_title]}".send(@chrome_color) }
+
+      choices += vbn
+
+      choices
+    end
+  end
+
   class SearchResultsReport < DirectorySearcher
     def directory_names(search_options, highlight_value)
       matched_directories = find_directory_names
@@ -113,20 +187,24 @@ module MarkdownExec
       }
     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]
+    def found_in_block_names(search_options, highlight_value, formspec: '=%<index>4.d: %<line>s')
+      matched_contents = (find_file_contents do |line|
+                            read_block_name(line, search_options[:fenced_start_and_end_regex], search_options[:block_name_match], search_options[:block_name_nick_match])
+                          end).map.with_index do |(file, contents), index|
+        # [file, contents.map { |detail| format(formspec, detail.index, detail.line) }, index]
+        [file, contents.map { |detail| format(formspec, { index: detail.index, line: detail.line }) }, index]
       end
       {
-        section_title: 'file contents',
+        section_title: 'block names',
         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
+                          { header: format('- %3.d: %s', index + 1, file),
+                            content: AnsiFormatter.new(search_options).format_and_highlight_array(
+                              details,
+                              highlight: [highlight_value]
+                            ) }
+                        end,
+        matched_contents: matched_contents
       }
     end
 
@@ -140,6 +218,21 @@ module MarkdownExec
         ).join("\n") }]
       }
     end
+
+    def read_block_name(line, fenced_start_and_end_regex, block_name_match, block_name_nick_match)
+      return unless line.match(fenced_start_and_end_regex)
+
+      bm = extract_named_captures_from_option(line, block_name_match)
+      return if bm.nil?
+
+      name = bm[:title]
+
+      if block_name_nick_match.present? && line =~ Regexp.new(block_name_nick_match)
+        $~[0]
+      else
+        bm && bm[1] ? bm[:title] : name
+      end
+    end
   end
 
   ##
@@ -353,16 +446,17 @@ module MarkdownExec
                                                                   :menu_chrome_color)}"
       searcher = SearchResultsReport.new(value, [find_path])
       file_names = searcher.file_names(options, value)
-      file_contents = searcher.file_contents(options, value)
+      found_in_block_names = searcher.found_in_block_names(options, value, formspec: '%<line>s')
       directory_names = searcher.directory_names(options, value)
 
       ### search in file contents (block names, chrome, or text)
-      [file_contents,
+      [found_in_block_names,
        directory_names,
        file_names].each do |data|
-        @fout.fout "In #{data[:section_title]}" if data[:section_title]
+        next if data[:data].count.zero?
         next unless data[:formatted_text]
 
+        @fout.fout "In #{data[:section_title]}" if data[:section_title]
         data[:formatted_text].each do |fi|
           @fout.fout fi[:header] if fi[:header]
           @fout.fout fi[:content] if fi[:content]
@@ -372,17 +466,29 @@ module MarkdownExec
 
       ## pick a document to open
       #
-      files = directory_names[:data].map do |dn|
+      files_in_directories = 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)
+      end.flatten(1).map { |str| FileInMenu.for_menu(str) }
+
+      return { exit: true } unless file_names[:data]&.count.positive? || files_in_directories&.count.positive? || found_in_block_names[:data]&.count.positive?
+
+      vbn = found_in_block_names[:matched_contents].map do |matched_contents|
+        filename, details, = matched_contents
+        nexo = AnsiFormatter.new(@options).format_and_highlight_array(
+          details,
+          highlight: [value]
+        )
+        [FileInMenu.for_menu(filename)] + nexo.map { |str| { disabled: '', name: (' ' * 20) + str } }
+      end.flatten
+
+      choices = MenuBuilder.new.build_menu(file_names, directory_names, found_in_block_names, files_in_directories, vbn)
+
+      @options[:filename] = FileInMenu.from_menu(
+        select_document_if_multiple(
+          choices,
+          prompt: options[:prompt_select_md].to_s + ' ¤ Age in months'.fg_rgbh_AF_AF_00
+        )
+      )
       { exit: false }
     end
 
@@ -618,13 +724,13 @@ module MarkdownExec
                                            @options[:saved_filename_replacement])
     end
 
-    def select_document_if_multiple(files = list_markdown_files_in_path)
+    def select_document_if_multiple(files = list_markdown_files_in_path, prompt: options[:prompt_select_md].to_s)
       return files[0] if (count = files.count) == 1
 
       return unless count >= 2
 
       opts = options.dup
-      select_option_or_exit(HashDelegator.new(@options).string_send_color(opts[:prompt_select_md].to_s, :prompt_color_after_script_execution),
+      select_option_or_exit(HashDelegator.new(@options).string_send_color(prompt, :prompt_color_after_script_execution),
                             files,
                             opts.merge(per_page: opts[:select_page_height]))
     end

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (2.0.4)
+# MDE - Markdown Executor (2.0.5)
 ---
 - :description: Show current configuration values
   :procname: show_config

data/lib/std_out_err_logger.rb

@@ -18,8 +18,8 @@ class StdOutErrLogger < Logger
   # def initialize(file = nil)
   def initialize(file = "#{__dir__}/../tmp/hash_delegator_next_link_state.yaml")
     @file = file
-    super(file || STDOUT)
-    self.formatter = proc do |severity, datetime, progname, msg|
+    super(file || $stdout)
+    self.formatter = proc do |_severity, _datetime, _progname, msg|
       "#{msg}\n"
     end
   end
@@ -36,14 +36,12 @@ class StdOutErrLogger < Logger
       if @file
         super
       else
-        $stderr.puts(out)
+        warn(out)
       end
+    elsif @file
+      super
     else
-      if @file
-        super
-      else
-        $stdout.puts(out)
-      end
+      $stdout.puts(out)
     end
   end
 end
@@ -81,40 +79,40 @@ class StdOutErrLoggerTest < Minitest::Test
 
   def test_logging_info
     logger = StdOutErrLogger.new
-    logger.info("Info message")
+    logger.info('Info message')
     assert_equal "Info message\n", $stdout.string
     assert_empty $stderr.string
   end
 
   def test_logging_warning
     logger = StdOutErrLogger.new
-    logger.warn("Warning message")
+    logger.warn('Warning message')
     assert_empty $stdout.string
     assert_equal "Warning message\n", $stderr.string
   end
 
   def test_logging_error
     logger = StdOutErrLogger.new
-    logger.error("Error message")
+    logger.error('Error message')
     assert_empty $stdout.string
     assert_equal "Error message\n", $stderr.string
   end
 
   def test_logging_with_array
     logger = StdOutErrLogger.new
-    logger.info(["Message line 1", "Message line 2"])
+    logger.info(['Message line 1', 'Message line 2'])
     assert_equal "Message line 1\nMessage line 2\n", $stdout.string
   end
 
   def test_logging_with_block
     logger = StdOutErrLogger.new
-    logger.info { "Block message" }
+    logger.info { 'Block message' }
     assert_equal "Block message\n", $stdout.string
   end
 
   def test_logging_unknown_severity
     logger = StdOutErrLogger.new
-    logger.add(Logger::UNKNOWN, "Unknown severity message")
+    logger.add(Logger::UNKNOWN, 'Unknown severity message')
     assert_empty $stdout.string
     assert_equal "Unknown severity message\n", $stderr.string
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -133,6 +133,7 @@ files:
 - examples/pass-through.md
 - examples/plant.md
 - examples/port.md
+- examples/search.md
 - examples/vars.md
 - examples/wrap.md
 - lib/ansi_formatter.rb