markdown_exec 2.1.0 → 2.3.0

data/lib/menu.yml

@@ -236,8 +236,10 @@
   :default: false
   :description: Execute script in own window
   :env_var: MDE_EXECUTE_IN_OWN_WINDOW
+  :long_name: execute_in_own_window
   :opt_name: execute_in_own_window
   :procname: val_as_bool
+  :short_name: w
 - :default: fg_rgbh_7f_ff_00
   :description: execution_report_preview_frame_color
   :env_var: MDE_EXECUTION_REPORT_PREVIEW_FRAME_COLOR
@@ -259,12 +261,12 @@
   :long_name: exit
   :procname: exit
   :short_name: x
-- :default: "^(?<indent> *)`{3,}"
+- :default: "^(?<indent>[ \t]*)`{3,}"
   :description: Matches the start and end of a fenced code block
   :env_var: MDE_FENCED_START_AND_END_REGEX
   :opt_name: fenced_start_and_end_regex
   :procname: val_as_str
-- :default: "^(?<indent> *)`{3,}(?<shell>[^`\\s]*) *(:(?<name>[^\\s]*))? *(?<rest>.*)
+- :default: "^(?<indent>[ \t]*)`{3,}(?<shell>[^`\\s]*) *(:(?<name>[^\\s]*))? *(?<rest>.*)
     *$"
   :description: Match the start of a fenced block
   :env_var: MDE_FENCED_START_EXTENDED_REGEX
@@ -325,7 +327,7 @@
   :procname: val_as_str
 - :arg_name: HOW
   :default: ''
-  :description: Find in YAML configuration options
+  :description: Find keyword in YAML configuration options
   :long_name: how
   :procname: how
   :short_name: "?"
@@ -337,6 +339,35 @@
   :env_var: MDE_IMPORT_PATTERN
   :opt_name: import_pattern
   :procname: val_as_str
+- :default:
+  - :color_method: :bold_underline
+    :pattern: "\\*\\*_([^_]{0,64})_\\*\\*"
+  - :color_method: :bold_italic
+    :pattern: "\\*\\*~([^~]{0,64})~\\*\\*"
+  - :color_method: :bold
+    :pattern: "\\*\\*([^*]{0,64})\\*\\*"
+  - :color_method: :bold
+    :pattern: __([^_]{0,64})__
+  - :color_method: :underline
+    :pattern: "\\*([^*]{0,64})\\*"
+  - :color_method: :underline_italic
+    :pattern: _~([^_]{0,64})~_
+  - :color_method: strikethrough
+    :pattern: "~~([^~]{0,64})~~"
+  :description: Line-oriented text decoration (Main)
+  :env_var: MDE_LINE_DECOR_MAIN
+  :opt_name: line_decor_main
+  :procname: val_as_str
+- :default: []
+  :description: Line-oriented text decoration (Post)
+  :env_var: MDE_LINE_DECOR_POST
+  :opt_name: line_decor_post
+  :procname: val_as_str
+- :default: []
+  :description: Line-oriented text decoration (Pre)
+  :env_var: MDE_LINE_DECOR_PRE
+  :opt_name: line_decor_pre
+  :procname: val_as_str
 - :description: List blocks
   :long_name: list-blocks
   :opt_name: list_blocks
@@ -373,6 +404,7 @@
   :long_name: load-code
   :opt_name: load_code
   :procname: val_as_str
+  :short_name: l
 - :arg_name: PREFIX
   :default: mde
   :description: Name prefix for stdout files
@@ -431,7 +463,7 @@
   :env_var: MDE_MENU_DIVIDER_FORMAT
   :opt_name: menu_divider_format
   :procname: val_as_str
-- :default: "^:::(?<line>(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+- :default: "^(?<indent>[ \t]*):::(?<line>(?<text>.*?)(?<trailing>[ \t]*))?$"
   :description: Pattern for topics/dividers in block selection menu
   :env_var: MDE_MENU_DIVIDER_MATCH
   :opt_name: menu_divider_match
@@ -548,7 +580,7 @@
   :env_var: MDE_MENU_NOTE_FORMAT
   :opt_name: menu_note_format
   :procname: val_as_str
-- :default: "^(?<line>(?!/)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+- :default: "^(?<line>(?![ \t]*/)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :description: Pattern for notes in block selection menu
   :env_var: MDE_MENU_NOTE_MATCH
   :opt_name: menu_note_match
@@ -820,12 +852,17 @@
   :opt_name: prompt_exit
   :procname: val_as_str
 - :default: Back
-  :description: Quit prompt
-  :env_var: MDE_PROMPT_FILESPEC_OTHER
+  :description: User wants out of menu
+  :env_var: MDE_PROMPT_FILESPEC_BACK
   :opt_name: prompt_filespec_back
   :procname: val_as_str
+- :default: Facet
+  :description: User wants to tailor the menu
+  :env_var: MDE_PROMPT_FILESPEC_FACET
+  :opt_name: prompt_filespec_facet
+  :procname: val_as_str
 - :default: Other
-  :description: Prompt for a custom file name
+  :description: User wants a custom file name
   :env_var: MDE_PROMPT_FILESPEC_OTHER
   :opt_name: prompt_filespec_other
   :procname: val_as_str
@@ -894,7 +931,7 @@
   :env_var: MDE_PROMPT_YES
   :opt_name: prompt_yes
   :procname: val_as_str
-- :description: Gem home folder
+- :description: Print the gem's home directory
   :long_name: pwd
   :opt_name: pwd
   :procname: val_as_bool
@@ -909,12 +946,12 @@
   :opt_name: runtime_exception_error_level
   :procname: val_as_int
 - :default: "%{prefix}%{join}%{time}%{join}%{filename}%{join}%{mark}%{join}%{blockname}%{join}%{exts}"
-  :description: saved_asset_format
+  :description: Format for script and log file names
   :env_var: MDE_SAVED_ASSET_FORMAT
   :opt_name: saved_asset_format
   :procname: val_as_str
 - :default: "^(?<prefix>.+)(?<join>_)(?<time>[0-9\\-]+)\\g'join'(?<filename>.+)\\g'join'(?<mark>~)\\g'join'(?<blockname>.+)\\g'join'(?<exts>\\..+)$"
-  :description: saved_asset_match
+  :description: Regexp for script and log file names
   :env_var: MDE_SAVED_ASSET_MATCH
   :opt_name: saved_asset_match
   :procname: val_as_str
@@ -940,6 +977,11 @@
   :env_var: MDE_SAVED_FILENAME_REPLACEMENT
   :opt_name: saved_filename_replacement
   :procname: val_as_str
+- :default: "%{time}  %{blockname}  %{exts}"
+  :description: Format for each row displayed in history
+  :env_var: MDE_SAVED_HISTORY_FORMAT
+  :opt_name: saved_history_format
+  :procname: val_as_str
 - :arg_name: INT
   :default: 493
   :description: chmod for saved scripts
@@ -1027,14 +1069,6 @@
   :env_var: MDE_SELECT_PAGE_HEIGHT
   :opt_name: select_page_height
   :procname: val_as_int
-- :description: Select and execute a recently saved output
-  :long_name: select-recent-output
-  :opt_name: select_recent_output
-  :procname: val_as_bool
-- :description: Select and execute a recently saved script
-  :long_name: select-recent-script
-  :opt_name: select_recent_script
-  :procname: val_as_bool
 - :default: "#!/usr/bin/env"
   :description: Shebang for saved scripts
   :env_var: MDE_SHEBANG
@@ -1061,6 +1095,12 @@
   :env_var: MDE_SHELL_CODE_LABEL_TIME_FORMAT
   :opt_name: shell_code_label_time_format
   :procname: val_as_str
+- :arg_name: BOOL
+  :default: true
+  :description: Whether saved file names include shell parameter expansion
+  :env_var: MDE_SHELL_PARAMETER_EXPANSION
+  :opt_name: shell_parameter_expansion
+  :procname: val_as_bool
 - :description: List tab completions
   :long_name: tab-completions
   :opt_name: tab_completions

data/lib/namer.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+require 'digest'
+# require_relative 'poly'
+
+$pd = false unless defined?($pd)
+
+class Hash
+  # block name in commands and documents
+  def pub_name(**kwargs)
+    full = fetch(:nickname, nil) || fetch(:oname, nil)
+    full&.to_s&.pub_name(**kwargs).tap { |ret| pp [__LINE__, 'Hash.pub_name() ->', ret] if $pd }
+  end
+end
+
+class String
+  FN_ID_LEN = 4
+  FN_MAX_LEN = 64
+  FN_PATTERN = %r{[^!#%\+\-0-9=@A-Z_a-z()\[\]{}]}.freeze # characters than can be used in a file name without quotes or escaping
+  # except '.', ',', '~' reserved for tokenization
+  # / !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+  FN_REPLACEMENT = '_'
+
+  # block name in commands and documents
+  def pub_name(
+    id_len: FN_ID_LEN, max_len: FN_MAX_LEN,
+    pattern: FN_PATTERN, replacement: FN_REPLACEMENT
+  )
+    trimmed = if self[max_len]
+                rand(((10**(id_len - 1)) + 1)..(10**id_len)).to_s
+                dig = Digest::MD5.hexdigest(self)[0, id_len]
+                self[0..max_len - id_len] + dig
+              else
+                self
+              end
+
+    trimmed.gsub(pattern, replacement).tap { |ret| pp [__LINE__, 'String.pub_name() ->', ret] if $pd }
+  end
+end
+
+# require 'ostruct'
+
+# class BlkS < OpenStruct
+#   # Method to fetch the value associated with the attribute :nickname or :oname
+#   def pub_name
+#     self.nickname || self.oname
+#   end
+# end

data/lib/poly.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+$pd = false
+
+class Poly
+  # attr_reader :table
+  def initialize(table = {})
+    @table = table.tap{|ret| pp [__LINE__,'Poly.initialize()','table',table.to_yaml] if $pd }
+  end
+
+  def fetch(key, *args)
+    key_sym = key.to_sym
+    if respond_to?("get_#{key}")
+      send("get_#{key}")
+    elsif @table.key?(key_sym)
+      @table[key_sym]
+    elsif block_given?
+      yield key_sym
+    elsif args.count.positive?
+# binding.irb
+      args.first
+    else
+binding.irb
+      raise KeyError, "key not found: #{key}"
+    end.tap{|ret| pp([__LINE__,"Poly.fetch #{key} #{args}",'->',ret]) if $pd }
+  end
+
+  def key?(name)
+    @table.key?(name.to_sym).tap{|ret| pp([__LINE__,"Poly.key? #{name}",'->',ret]) if $pd }
+  end
+
+  def method_missing(name, *args)
+    pt = nil
+    if name.to_s.end_with?('=')
+      # Setter method
+      attribute = name.to_s.chomp('=').to_sym
+      value = args.first
+      if respond_to?("set_#{attribute}")
+        pt = 'send set_'
+        send("set_#{attribute}", value)
+      else
+        pt = 'table set'
+        @table[attribute] = value
+      end
+    elsif respond_to?("get_#{name}")
+      pt = 'send get_'
+      # Getter method
+      send("get_#{name}")
+    elsif @table.respond_to?(name)
+      pt = 'send name'
+      @table.send(name, *args)
+    else
+      pt = 'table read'
+      @table[name.to_sym]
+    end.tap{|ret| pp([__LINE__,"Poly.method_missing #{name} #{args.map(&:to_s).join(' ')}",pt,'->',ret]) if $pd }
+  end
+
+  def respond_to_missing?(name, include_private = false)
+    # name.to_s.end_with?('=') || @table.key?(name.to_sym) || @table.respond_to?(name) || super
+    (name.to_s.end_with?('=') || @table.key?(name.to_sym) || @table.respond_to?(name) || super).tap{|ret| pp([__LINE__,"Poly.respond_to_missing? #{name}",'->',ret]) if $pd }
+  end
+
+  def [](key)
+    if respond_to?("get_#{key}")
+      send("get_#{key}")
+    else
+      @table[key.to_sym]
+    end.tap{|ret| pp([__LINE__,"Poly.[] #{key}",'->',ret]) if $pd }
+  end
+
+  def []=(key, value)
+    if respond_to?("set_#{key}")
+      send("set_#{key}", value)
+    else
+      @table[key.to_sym] = value
+    end.tap{|ret| pp([__LINE__,"Poly.[]= #{key} #{value}",'->',ret]) if $pd }
+  end
+
+  # for export to Prompt library
+  # def merge(*args)
+  #   Proc.new { |x| @table.merge x }
+  # end
+  def merge(*args)
+# pp caller
+# binding.irb
+    @table.merge(*args).tap{|ret| pp([__LINE__,"Poly.merge",'->',ret]) if $pd }
+  end
+
+  # for export to Prompt library
+  def to_h
+    @table.tap{|ret| pp([__LINE__,"Poly.to_h",'->',ret]) if $pd }
+  end
+
+  def to_yaml
+    @table.to_yaml.tap{|ret| pp([__LINE__,"Poly.to_yaml",'->',ret]) if $pd }
+  end
+end
+
+# class CustomStruct < Poly
+#   # Custom setter for virtual attribute :full_name
+#   def set_full_name(value)
+#     names = value.split(' ')
+#     @table[:first_name] = names.first
+#     @table[:last_name] = names.last
+#   end
+
+#   # Custom getter for virtual attribute :full_name
+#   def get_full_name
+#     "#{@table[:first_name]} #{@table[:last_name]}"
+#   end
+# end
+
+# # Example usage
+# person = CustomStruct.new
+# person.first_name = 'John'
+# person.last_name = 'Doe'
+# puts person.first_name  # => John
+# puts person.last_name   # => Doe
+
+# # Setting and getting a virtual attribute
+# person.full_name = 'Jane Smith'
+# puts person.first_name  # => Jane
+# puts person.last_name   # => Smith
+# puts person.full_name   # => Jane Smith
+
+# # Setting and getting a regular attribute
+# person.age = 30
+# puts person.age         # => 30
+
+# # Using array notation
+# person[:age] = 35
+# puts person[:age]       # => 35
+
+# person[:full_name] = 'Alice Johnson'
+# puts person[:first_name] # => Alice
+# puts person[:last_name]  # => Johnson
+# puts person[:full_name]  # => Alice Johnson
+
+# # Using fetch method
+# puts person.fetch(:age)          # => 35
+# puts person.fetch(:nonexistent, 'default') # => default
+# puts person.fetch(:nonexistent) { |key| "block default for #{key}" } # => block default for nonexistent
+
+# # This will raise a KeyError
+# begin
+#   person.fetch(:nonexistent)
+# rescue KeyError => e
+#   puts e.message  # => key not found: nonexistent
+# end

data/lib/saved_assets.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
+require_relative 'namer'
 
 module MarkdownExec
   # SavedAsset
@@ -12,10 +13,6 @@ module MarkdownExec
   # method derives a name for stdout redirection.
   #
   class SavedAsset
-    FNR11 = %r{[^!#%\+\-0-9=@A-Z_a-z]}.freeze # characters than can be used in a file name without quotes or escaping
-    # except '.', ',', '~' reserved for tokenization
-    # / !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
-    FNR12 = '_'
     DEFAULT_FTIME = '%F-%H-%M-%S'
     FILE_BLOCK_SEP = ','
     JOIN_STR = '_'
@@ -26,21 +23,17 @@ module MarkdownExec
     # @param time [Time] the time object for formatting
     # @param blockname [String] the block name to include
     # @param ftime [String] the time format (default: DEFAULT_FTIME)
-    # @param pattern [Regexp] the pattern to search (default: FNR11)
-    # @param replace [String] the string to replace the pattern (default: FNR12)
     # @param exts [String] the extension to append (default: '.sh')
     def initialize(
       saved_asset_format:, filename: nil, prefix: nil, time: nil, blockname: nil,
-      ftime: DEFAULT_FTIME, pattern: FNR11, replace: FNR12, exts: nil,
+      ftime: DEFAULT_FTIME, exts: nil,
       mark: nil, join_str: nil
     )
-      @filename = filename ? filename.gsub(pattern, replace) : '*' # [String] the name of the file
+      @filename = filename ? filename.pub_name : '*' # [String] the name of the file
       @prefix = prefix || '*' # [String] the prefix to use
       @time = time ? time.strftime(ftime) : '*' # [Time] the time object for formatting
-      @blockname = blockname ? blockname.gsub(pattern, replace) : '*' # [String] the block name to include
+      @blockname = blockname ? blockname.pub_name : '*' # [String] the block name to include
       # @ftime = ftime # [String] the time format (default: DEFAULT_FTIME)
-      # @pattern = pattern # [Regexp] the pattern to search (default: FNR11)
-      # @replace = replace # [String] the string to replace the pattern (default: FNR12)
       @exts = exts || '.*' # [String] the extension to append (default: '.sh')
       @mark = mark || MARK_STR
       @join_str = join_str || JOIN_STR

data/lib/string_util.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
-
 module StringUtil
   # Splits the given string on the first occurrence of the specified character.
   # Returns an array containing the portion of the string before the character and the rest of the string.

data/lib/text_analyzer.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module TextAnalyzer
+  # Analyzes a hierarchical structure (String or Array) and highlights segments based on the pattern
+  #
+  # @param hierarchy [String, Array] the hierarchical structure to be analyzed
+  # @param pattern [Regexp] the pattern to match against the text
+  # @param default_color [String] the color for non-matching segments
+  # @param match_color [String] the color for matching segments
+  #
+  # @return [Array<Hash>, Array<Array<Hash>>] an array or nested arrays of highlighted segments
+  #
+  # @raise [ArgumentError] if the hierarchy structure is neither a String nor an Array
+  def self.analyze_hierarchy(hierarchy, pattern, default_color, match_color)
+    case hierarchy
+    when String
+      highlight_segments(hierarchy, pattern, default_color, match_color)
+    when Hash
+      decorated = highlight_segments(hierarchy[:text], pattern,
+                                     hierarchy[:color], match_color)
+
+      case decorated
+      when String
+        hierarchy
+      when Array
+        if decorated.length == 1
+          hierarchy
+        else
+          decorated
+        end
+      else
+        decorated
+      end
+    when Array
+      hierarchy.map do |element|
+        analyze_hierarchy(element, pattern, default_color, match_color)
+      end
+    when HierarchyString
+
+      hierarchy.replace_text! do |substring|
+        substring ### no change
+      end
+
+    else
+      binding.irb
+      raise ArgumentError, 'Invalid hierarchy structure'
+    end
+  end
+
+  # Highlights segments of the text based on the pattern
+  #
+  # @param text [String] the text to be analyzed
+  # @param pattern [Regexp] the pattern to match against the text
+  # @param default_color [String] the color for non-matching segments
+  # @param match_color [String] the color for matching segments
+  #
+  # @return [Array<Hash>] an array of hashes, each containing a segment of text and its corresponding color
+  def self.highlight_segments(text, pattern, default_color, match_color)
+    segments = []
+
+    yield_matches_and_non_matches(text, pattern) do |segment, is_match|
+      segments << if is_match
+                    { text: segment, color: match_color }
+                  else
+                    { text: segment, color: default_color }
+                  end
+    end
+
+    segments
+  end
+
+  # Yields matching and non-matching segments of the text based on the pattern
+  #
+  # @param text [String] the text to be analyzed
+  # @param pattern [Regexp] the pattern to match against the text
+  #
+  # @yieldparam segment [String] a segment of the text
+  # @yieldparam is_match [Boolean] true if the segment matches the pattern, false otherwise
+  def self.yield_matches_and_non_matches(text, pattern)
+    last_end = 0
+
+    text.scan(pattern) do |match|
+      match_start = Regexp.last_match.begin(0)
+      match_end = Regexp.last_match.end(0)
+
+      # Yield the non-matching segment before the match
+      yield text[last_end...match_start], false if match_start > last_end
+
+      # Yield the matching segment
+      yield match.first, true
+
+      last_end = match_end
+    end
+
+    # Yield any remaining non-matching segment after the last match
+    return unless last_end < text.length
+
+    yield text[last_end..-1], false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -113,6 +113,8 @@ files:
 - bin/setup
 - bin/tab_completion.sh
 - bin/tab_completion.sh.erb
+- examples/bash-blocks.md
+- examples/block-names.md
 - examples/block_names.md
 - examples/colors.md
 - examples/data-files.md
@@ -125,6 +127,9 @@ files:
 - examples/index.md
 - examples/interrupt.md
 - examples/line-wrapping.md
+- examples/link-blocks-block.md
+- examples/link-blocks-load-save.md
+- examples/link-blocks-vars.md
 - examples/linked.md
 - examples/linked1.md
 - examples/linked2.md
@@ -135,15 +140,16 @@ files:
 - examples/load2.sh
 - examples/load_code.md
 - examples/nickname.md
-- examples/opts.md
+- examples/opts-blocks-require.md
+- examples/opts-blocks.md
 - examples/opts_output_execution.md
-- examples/pass-through.md
+- examples/pass-through-arguments.md
 - examples/pause-after-execution.md
 - examples/plant.md
-- examples/port.md
+- examples/port-blocks.md
 - examples/save.md
 - examples/search.md
-- examples/vars.md
+- examples/vars-blocks.md
 - examples/wrap.md
 - lib/ansi_formatter.rb
 - lib/array.rb
@@ -165,6 +171,7 @@ files:
 - lib/fout.rb
 - lib/hash.rb
 - lib/hash_delegator.rb
+- lib/hierarchy_string.rb
 - lib/input_sequencer.rb
 - lib/instance_method_wrapper.rb
 - lib/link_history.rb
@@ -173,8 +180,10 @@ files:
 - lib/mdoc.rb
 - lib/menu.src.yml
 - lib/menu.yml
+- lib/namer.rb
 - lib/object_present.rb
 - lib/option_value.rb
+- lib/poly.rb
 - lib/regexp.rb
 - lib/resize_terminal.rb
 - lib/rspec_helpers.rb
@@ -185,6 +194,7 @@ files:
 - lib/streams_out.rb
 - lib/string_util.rb
 - lib/tap.rb
+- lib/text_analyzer.rb
 homepage: https://rubygems.org/gems/markdown_exec
 licenses:
 - MIT

data/examples/vars.md

@@ -1,20 +0,0 @@
-```bash :(defaults)
-: ${VAULT:=default}
-```
-```bash :show_vars +(defaults)
-source bin/colorize_env_vars.sh
-colorize_env_vars '' VAULT
-```
-```vars :set
-VAULT: 11
-```
-```vars :set_with_show +show_vars
-VAULT: 22
-```
-```bash :(hidden)
-colorize_env_vars '' NOTHING
-```
-```bash :show_with_set +set
-source bin/colorize_env_vars.sh
-colorize_env_vars '' VAULT
-```