markdown_exec 1.8.6 → 1.8.7

data/lib/markdown_exec/version.rb

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

data/lib/mdoc.rb

@@ -23,6 +23,7 @@ module MarkdownExec
     #
     def initialize(table = [])
       @table = table
+      # &bc '@table.count:',@table.count
     end
 
     def collect_block_code_cann(fcb)
@@ -69,20 +70,28 @@ module MarkdownExec
     # @param name [String] The name of the code block to start the retrieval from.
     # @return [Array<Hash>] An array of code blocks required by the specified code block.
     #
-    def collect_recursively_required_blocks(name)
+    def collect_block_dependencies(name)
       name_block = get_block_by_anyname(name)
       if name_block.nil? || name_block.keys.empty?
         raise "Named code block `#{name}` not found. (@#{__LINE__})"
       end
 
       dependencies = collect_dependencies(name_block[:oname])
+      # &bc 'dependencies.count:',dependencies.count
       all_dependency_names = collect_unique_names(dependencies).push(name_block[:oname]).uniq
-      unmet_dependencies = all_dependency_names.dup
+      # &bc 'all_dependency_names.count:',all_dependency_names.count
 
-      # in order of appearance in document (@table)
-      # insert function blocks
-      blocks = @table.select { |fcb| all_dependency_names.include? fcb[:oname] }
-                     .map do |fcb|
+      # select non-chrome blocks in order of appearance in source documents
+      #
+      blocks = @table.select do |fcb|
+        !fcb.fetch(:chrome, false) && all_dependency_names.include?(fcb.fetch(:oname))
+      end
+      # &bc 'blocks.count:',blocks.count
+
+      ## add cann key to blocks, calc unmet_dependencies
+      #
+      unmet_dependencies = all_dependency_names.dup
+      blocks = blocks.map do |fcb|
         unmet_dependencies.delete(fcb[:oname]) # may not exist if block name is duplicated
         if (call = fcb[:call])
           [get_block_by_oname("[#{call.match(/^%\((\S+) |\)/)[1]}]")
@@ -91,6 +100,7 @@ module MarkdownExec
           []
         end + [fcb]
       end.flatten(1)
+      # &bc 'unmet_dependencies.count:',unmet_dependencies.count
 
       { all_dependency_names: all_dependency_names,
         blocks: blocks,
@@ -103,11 +113,13 @@ module MarkdownExec
     # @param name [String] The name of the code block to start the collection from.
     # @return [Array<String>] An array of strings containing the collected code blocks.
     #
-    def collect_recursively_required_code(name, label_body: true, label_format_above: nil,
-                                          label_format_below: nil, block_source:)
-      block_search = collect_recursively_required_blocks(name)
+    def collect_recursively_required_code(name, block_source:, label_body: true, label_format_above: nil,
+                                          label_format_below: nil)
+      block_search = collect_block_dependencies(name)
       if block_search[:blocks]
         blocks = collect_wrapped_blocks(block_search[:blocks])
+        # &bc 'blocks.count:',blocks.count
+
         block_search.merge(
           { block_names: blocks.map { |block| block[:oname] },
             code: blocks.map do |fcb|
@@ -134,6 +146,8 @@ module MarkdownExec
       else
         block_search.merge({ block_names: [], code: [] })
       end
+    rescue StandardError
+      error_handler('collect_recursively_required_code')
     end
 
     def collect_unique_names(hash)
@@ -160,6 +174,13 @@ module MarkdownExec
       end.flatten(1).compact
     end
 
+    def error_handler(name = '', opts = {})
+      Exceptions.error_handler(
+        "MDoc.#{name} -- #{$!}",
+        opts
+      )
+    end
+
     # Retrieves code blocks based on the provided options.
     #
     # @param opts [Hash] The options used for filtering code blocks.
@@ -432,13 +453,13 @@ if $PROGRAM_NAME == __FILE__
       end
 
       ### broken test
-      def test_collect_recursively_required_blocks
-        result = @doc.collect_recursively_required_blocks('block3')[:blocks]
+      def test_collect_block_dependencies
+        result = @doc.collect_block_dependencies('block3')[:blocks]
         expected_result = [@table[0], @table[1], @table[2]]
         assert_equal expected_result, result
 
         assert_raises(RuntimeError) do
-          @doc.collect_recursively_required_blocks('missing_block')
+          @doc.collect_block_dependencies('missing_block')
         end
       end
 

data/lib/menu.src.yml

@@ -238,17 +238,17 @@
   :opt_name: find_path
   :procname: val_as_str
 
-- :default: "^# *(?<name>[^#]*?) *$"
+- :default: "^# *(?<line>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
   :procname: val_as_str
 
-- :default: "^## *(?<name>[^#]*?) *$"
+- :default: "^## *(?<line>[^#]*?) *$"
   :env_var: MDE_HEADING2_MATCH
   :opt_name: heading2_match
   :procname: val_as_str
 
-- :default: "^### *(?<name>.+?) *$"
+- :default: "^### *(?<line>.+?) *$"
   :env_var: MDE_HEADING3_MATCH
   :opt_name: heading3_match
   :procname: val_as_str
@@ -363,7 +363,7 @@
   :procname: val_as_bool
 
 - :arg_name: BOOL
-  :default: false
+  :default: true
   :description: Controls whether headings(levels 1,2,3) are displayed in the block selection menu
   :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS
   :opt_name: menu_blocks_with_headings
@@ -419,6 +419,42 @@
   :opt_name: menu_final_divider
   :procname: val_as_str
 
+- :default: fg_rgbh_80_80_c0
+  :description: Color for heading 1 in menu
+  :env_var: MDE_MENU_HEADING1_COLOR
+  :opt_name: menu_heading1_color
+  :procname: val_as_str
+
+- :default: "# %{line}"
+  :description: format for menu heading1 in menu
+  :env_var: MDE_MENU_HEADING1_FORMAT
+  :opt_name: menu_heading1_format
+  :procname: val_as_str
+
+- :default: fg_rgbh_60_60_c0
+  :description: Color for heading 2 in menu
+  :env_var: MDE_MENU_HEADING2_COLOR
+  :opt_name: menu_heading2_color
+  :procname: val_as_str
+
+- :default: "## %{line}"
+  :description: format for menu heading2 in menu
+  :env_var: MDE_MENU_HEADING2_FORMAT
+  :opt_name: menu_heading2_format
+  :procname: val_as_str
+
+- :default: fg_rgbh_40_40_c0
+  :description: Color for heading 3 in menu
+  :env_var: MDE_MENU_HEADING3_COLOR
+  :opt_name: menu_heading3_color
+  :procname: val_as_str
+
+- :default: "### %{line}"
+  :description: format for menu heading3 in menu
+  :env_var: MDE_MENU_HEADING3_FORMAT
+  :opt_name: menu_heading3_format
+  :procname: val_as_str
+
 - :default: "0"
   :description: Import levels for blocks to appear in menu. Empty is all.
   :env_var: MDE_MENU_IMPORT_LEVEL_MATCH
@@ -440,6 +476,25 @@
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
 
+- :arg_name: BOOL
+  :default: true
+  :description: Display inherited lines at top of menu (vs bottom)
+  :env_var: MDE_MENU_INHERITED_LINES_AT_TOP
+  :opt_name: menu_inherited_lines_at_top
+  :procname: val_as_bool
+
+- :default: fg_rgbh_94_00_D3
+  :description: Color of inherited lines in menu
+  :env_var: MDE_MENU_INHERITED_LINES_COLOR
+  :opt_name: menu_inherited_lines_color
+  :procname: val_as_str
+
+- :default: "%{line}"
+  :description: format for inherited lines in menu
+  :env_var: MDE_MENU_INHERITED_LINES_FORMAT
+  :opt_name: menu_inherited_lines_format
+  :procname: val_as_str
+
 - :default:
     :line: ""
   :description: opening demarcation for menu
@@ -511,6 +566,12 @@
   :opt_name: menu_opts_set_format
   :procname: val_as_str
 
+- :default: "."
+  :description: Block name to display menu
+  :env_var: MDE_MENU_PERSIST_BLOCK_NAME
+  :opt_name: menu_persist_block_name
+  :procname: val_as_str
+
 - :default: fg_rgbh_ff_ff_ff
   :description: Color of menu task
   :env_var: MDE_MENU_TASK_COLOR
@@ -567,6 +628,13 @@
   :opt_name: menu_with_exit
   :procname: val_as_bool
 
+- :arg_name: BOOL
+  :default: true
+  :description: Display inherited lines in menu
+  :env_var: MDE_MENU_WITH_INHERITED_LINES
+  :opt_name: menu_with_inherited_lines
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Hide decorative menu entries

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.8.6)
+# MDE - Markdown Executor (1.8.7)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -205,15 +205,15 @@
   :long_name: find-path
   :opt_name: find_path
   :procname: val_as_str
-- :default: "^# *(?<name>[^#]*?) *$"
+- :default: "^# *(?<line>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
   :procname: val_as_str
-- :default: "^## *(?<name>[^#]*?) *$"
+- :default: "^## *(?<line>[^#]*?) *$"
   :env_var: MDE_HEADING2_MATCH
   :opt_name: heading2_match
   :procname: val_as_str
-- :default: "^### *(?<name>.+?) *$"
+- :default: "^### *(?<line>.+?) *$"
   :env_var: MDE_HEADING3_MATCH
   :opt_name: heading3_match
   :procname: val_as_str
@@ -308,7 +308,7 @@
   :opt_name: menu_blocks_with_docname
   :procname: val_as_bool
 - :arg_name: BOOL
-  :default: false
+  :default: true
   :description: Controls whether headings(levels 1,2,3) are displayed in the block
     selection menu
   :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS
@@ -356,6 +356,36 @@
   :env_var: MDE_MENU_FINAL_DIVIDER
   :opt_name: menu_final_divider
   :procname: val_as_str
+- :default: fg_rgbh_80_80_c0
+  :description: Color for heading 1 in menu
+  :env_var: MDE_MENU_HEADING1_COLOR
+  :opt_name: menu_heading1_color
+  :procname: val_as_str
+- :default: "# %{line}"
+  :description: format for menu heading1 in menu
+  :env_var: MDE_MENU_HEADING1_FORMAT
+  :opt_name: menu_heading1_format
+  :procname: val_as_str
+- :default: fg_rgbh_60_60_c0
+  :description: Color for heading 2 in menu
+  :env_var: MDE_MENU_HEADING2_COLOR
+  :opt_name: menu_heading2_color
+  :procname: val_as_str
+- :default: "## %{line}"
+  :description: format for menu heading2 in menu
+  :env_var: MDE_MENU_HEADING2_FORMAT
+  :opt_name: menu_heading2_format
+  :procname: val_as_str
+- :default: fg_rgbh_40_40_c0
+  :description: Color for heading 3 in menu
+  :env_var: MDE_MENU_HEADING3_COLOR
+  :opt_name: menu_heading3_color
+  :procname: val_as_str
+- :default: "### %{line}"
+  :description: format for menu heading3 in menu
+  :env_var: MDE_MENU_HEADING3_FORMAT
+  :opt_name: menu_heading3_format
+  :procname: val_as_str
 - :default: '0'
   :description: Import levels for blocks to appear in menu. Empty is all.
   :env_var: MDE_MENU_IMPORT_LEVEL_MATCH
@@ -373,6 +403,22 @@
   :env_var: MDE_MENU_INCLUDE_IMPORTED_NOTES
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: Display inherited lines at top of menu (vs bottom)
+  :env_var: MDE_MENU_INHERITED_LINES_AT_TOP
+  :opt_name: menu_inherited_lines_at_top
+  :procname: val_as_bool
+- :default: fg_rgbh_94_00_D3
+  :description: Color of inherited lines in menu
+  :env_var: MDE_MENU_INHERITED_LINES_COLOR
+  :opt_name: menu_inherited_lines_color
+  :procname: val_as_str
+- :default: "%{line}"
+  :description: format for inherited lines in menu
+  :env_var: MDE_MENU_INHERITED_LINES_FORMAT
+  :opt_name: menu_inherited_lines_format
+  :procname: val_as_str
 - :default:
     :line: ''
   :description: opening demarcation for menu
@@ -431,6 +477,11 @@
   :env_var: MDE_MENU_OPTS_SET_FORMAT
   :opt_name: menu_opts_set_format
   :procname: val_as_str
+- :default: "."
+  :description: Block name to display menu
+  :env_var: MDE_MENU_PERSIST_BLOCK_NAME
+  :opt_name: menu_persist_block_name
+  :procname: val_as_str
 - :default: fg_rgbh_ff_ff_ff
   :description: Color of menu task
   :env_var: MDE_MENU_TASK_COLOR
@@ -478,6 +529,12 @@
   :env_var: MDE_MENU_WITH_EXIT
   :opt_name: menu_with_exit
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: true
+  :description: Display inherited lines in menu
+  :env_var: MDE_MENU_WITH_INHERITED_LINES
+  :opt_name: menu_with_inherited_lines
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Hide decorative menu entries

data/lib/regexp_replacer.rb

@@ -15,28 +15,28 @@ class RegexpReplacer
   def perform_replacement(option)
     content = File.read(@file_path)
     modified_content = case option
-                       when 1
-                         replace_pattern1(content)
-                       when 2
-                         replace_pattern2(content)
+                       when 'v'
+                         verbose(content)
+                       when 'q'
+                         quiet(content)
                        else
-                         raise "Invalid option. Please choose 1 or 2."
+                         raise "Invalid option. Please choose 'v' or 'q'."
                        end
     File.write(@file_path, modified_content)
   end
 
   private
 
-  # Replacement for pattern 1
-  def replace_pattern1(content)
-    regexp = /^( *)# (@\w+) ('.+)/
-    substitution = '\1;;pp __LINE__,\3 #\2'
+  # Replacement for pattern 'v'
+  def verbose(content)
+    regexp = /^( *)# (&\w+) ('.+)/
+    substitution = '\1;;pp [__LINE__,\3] #\2'
     content.gsub(regexp, substitution)
   end
 
-  # Replacement for pattern 2
-  def replace_pattern2(content)
-    regexp = /^( *);;pp __LINE__,(.+) #(@\w+)/
+  # Replacement for pattern 'q'
+  def quiet(content)
+    regexp = /^( *);; ?pp \[__LINE__,(.+)\] #(&\w+)/
     substitution = '\1# \3 \2'
     content.gsub(regexp, substitution)
   end
@@ -44,14 +44,14 @@ end
 
 # Running the script with command line arguments
 if ARGV.length != 2
-  puts "Usage: ruby regexp_replacer.rb [file_path] [option (1 or 2)]"
+  puts "Usage: ruby regexp_replacer.rb [file_path] [option ('v' or 'q')]"
   exit
 end
 
 file_path, option = ARGV
 replacer = RegexpReplacer.new(file_path)
 begin
-  replacer.perform_replacement(option.to_i)
+  replacer.perform_replacement(option)
   puts "Replacement performed successfully."
 rescue StandardError => e
   puts "Error: #{e.message}"

data/lib/saved_assets.rb

@@ -12,18 +12,20 @@ module MarkdownExec
   # method derives a name for stdout redirection.
   #
   class SavedAsset
-    FNR11 = /pattern1/.freeze # TODO: Replace with actual pattern
-    FNR12 = 'replacement_string' # TODO: Replace with actual replacement string
+    FNR11 = %r{/|:}.freeze
+    FNR12 = '_'
+    DEFAULT_FTIME = '%F-%H-%M-%S'
 
     # Generates a formatted script name based on the provided parameters.
-    def self.script_name(filename:, prefix:, time:, blockname:)
-      fne = filename.gsub(FNR11, FNR12)
-      "#{[prefix, time.strftime('%F-%H-%M-%S'), fne, ',', blockname].join('_')}.sh"
+    def self.script_name(filename:, prefix:, time:, blockname:, ftime: DEFAULT_FTIME, join_str: '_', pattern: FNR11, replace: FNR12, exts: '.sh')
+      fne = filename.gsub(pattern, replace)
+      "#{[prefix, time.strftime(ftime), fne, ',', blockname].join(join_str)}#{exts}"
     end
 
     # Generates a formatted stdout name based on the provided parameters.
-    def self.stdout_name(filename:, prefix:, time:, blockname:)
-      "#{[prefix, time.strftime('%F-%H-%M-%S'), filename, blockname].join('_')}.out.txt"
+    def self.stdout_name(filename:, prefix:, time:, blockname:, ftime: DEFAULT_FTIME, join_str: '_', pattern: FNR11, replace: FNR12, exts: '.out.txt')
+      fne = filename.gsub(pattern, replace)
+      "#{[prefix, time.strftime(ftime), fne, ',', blockname].join(join_str)}#{exts}"
     end
   end
 end
@@ -50,7 +52,7 @@ if $PROGRAM_NAME == __FILE__
       time = Time.new(2023, 1, 1, 12, 0, 0)
       blockname = 'block1'
 
-      expected_name = 'test_2023-01-01-12-00-00_sample.txt_block1.out.txt'
+      expected_name = 'test_2023-01-01-12-00-00_sample.txt_,_block1.out.txt'
       assert_equal expected_name,
                    MarkdownExec::SavedAsset.stdout_name(filename: filename, prefix: prefix, time: time,
                                                         blockname: blockname)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.8.6
+  version: 1.8.7
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -81,8 +81,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0
 description: Interactively select and execute fenced code blocks in markdown files.
-  Build complex scripts by linking documents and naming and requiring blocks. Log
-  resulting scripts and output. Re-run scripts.
+  Build complex scripts by naming and requiring blocks. Log resulting scripts and
+  output. Re-run scripts.
 email:
 - fareed@phomento.com
 executables: