markdown_exec 1.8.4 → 1.8.6

data/lib/link_history.rb

@@ -5,18 +5,20 @@
 module MarkdownExec
   class LinkState
     attr_accessor :block_name, :document_filename,
-                  :inherited_block_names, :inherited_lines
+                  :inherited_block_names, :inherited_dependencies, :inherited_lines
 
     # Initialize the LinkState with keyword arguments for each attribute.
     # @param block_name [String, nil] the name of the block.
     # @param document_filename [String, nil] the filename of the document.
     # @param inherited_block_names [Array<String>, nil] the names of the inherited blocks.
+    # @param inherited_dependencies [?, nil] the dependecy hierarcy.
     # @param inherited_lines [Array<String>, nil] the inherited lines of code.
     def initialize(block_name: nil, document_filename: nil,
-                   inherited_block_names: [], inherited_lines: nil)
+                   inherited_block_names: [], inherited_dependencies: nil, inherited_lines: nil)
       @block_name = block_name
       @document_filename = document_filename
       @inherited_block_names = inherited_block_names
+      @inherited_dependencies = inherited_dependencies
       @inherited_lines = inherited_lines
     end
 
@@ -34,6 +36,7 @@ module MarkdownExec
         other.block_name == block_name &&
         other.document_filename == document_filename &&
         other.inherited_block_names == inherited_block_names &&
+        other.inherited_dependencies == inherited_dependencies &&
         other.inherited_lines == inherited_lines
     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 = '1.8.4'
+  VERSION = '1.8.6'
 end

data/lib/markdown_exec.rb

@@ -41,6 +41,8 @@ tap_config envvar: MarkdownExec::TAP_DEBUG
 $stderr.sync = true
 $stdout.sync = true
 
+ARGV_SEP = '--'
+
 # custom error: file specified is missing
 #
 class FileMissingError < StandardError; end
@@ -49,6 +51,11 @@ def dp(str)
   lout " => #{str}", level: DISPLAY_LEVEL_DEBUG
 end
 
+def rbi
+  pp(caller.take(4).map.with_index { |line, ind| "   - #{ind}: #{line}" })
+  binding.irb
+end
+
 def rbp
   rpry
   pp(caller.take(4).map.with_index { |line, ind| "   - #{ind}: #{line}" })
@@ -58,7 +65,7 @@ end
 def bpp(*args)
   pp '+ bpp()'
   pp(*args.map.with_index { |line, ind| "  - #{ind}: #{line}" })
-  rbp
+  rbi
 end
 
 def rpry
@@ -131,10 +138,11 @@ module MarkdownExec
       )
     end
 
-    # return arguments before `--`
+    # return arguments before ARGV_SEP
+    # arguments after ARGV_SEP are passed to the generatede script
     #
     def arguments_for_mde(argv = ARGV)
-      case ind = argv.find_index('--')
+      case ind = argv.find_index(ARGV_SEP)
       when nil
         argv
       when 0
@@ -200,14 +208,13 @@ module MarkdownExec
     # Reports and executes block logic
     def execute_block_logic(files)
       @options[:filename] = select_document_if_multiple(files)
-      @options.select_execute_bash_and_special_blocks
+      @options.document_menu_loop
     end
 
     ## Executes the block specified in the options
     #
     def execute_block_with_error_handling
       finalize_cli_argument_processing
-      @options[:input_cli_rest] = @rest
       execute_code_block_based_on_options(@options)
     rescue FileMissingError
       warn "File missing: #{$!}"
@@ -288,6 +295,7 @@ module MarkdownExec
       #
       block_name = rest.shift
       @options[:block_name] = block_name if block_name.present?
+      @options[:input_cli_rest] = @rest
     rescue FileMissingError
       warn_format('finalize_cli_argument_processing',
                   "File missing -- #{$!}", { abort: true })
@@ -341,10 +349,11 @@ module MarkdownExec
         ->(_) { exit }
       when 'find'
         ->(value) {
+          find_path = @options[:find_path].present? ? @options[:find_path] : @options[:path]
           @fout.fout 'Searching in: ' \
-                     "#{HashDelegator.new(@options).string_send_color(@options[:path],
+                     "#{HashDelegator.new(@options).string_send_color(find_path,
                                                                       :menu_chrome_color)}"
-          searcher = DirectorySearcher.new(value, [@options[:path]])
+          searcher = DirectorySearcher.new(value, [find_path])
 
           @fout.fout 'In file contents'
           hash = searcher.search_in_file_contents
@@ -528,6 +537,8 @@ module MarkdownExec
       execute_block_with_error_handling
     rescue StandardError
       error_handler('run')
+    ensure
+      yield if block_given?
     end
 
     private
@@ -539,7 +550,7 @@ module MarkdownExec
 
       saved_name_split filename
       @options[:save_executed_script] = false
-      @options.select_execute_bash_and_special_blocks
+      @options.document_menu_loop
     rescue StandardError
       error_handler('run_last_script')
     end
@@ -606,7 +617,7 @@ module MarkdownExec
 
       saved_name_split(filename)
 
-      @options.select_execute_bash_and_special_blocks ### ({ save_executed_script: false })
+      @options.document_menu_loop ### ({ save_executed_script: false })
     end
 
     public

data/lib/menu.src.yml

@@ -17,7 +17,7 @@
 
 - :arg_name: NAME
   :compreply: false
-  :description: Name of block
+  :description: Name of block to execute
   :env_var: MDE_BLOCK_NAME
   :long_name: block-name
   :opt_name: block_name
@@ -92,6 +92,14 @@
   :opt_name: document_load_opts_block_name
   :procname: val_as_str
 
+- :arg_name: BOOL
+  :default: false
+  :description: Dump @delegate_object
+  :env_var: MDE_DUMP_DELEGATE_OBJECT
+  :long_name: dump-dump-delegate-object
+  :opt_name: dump_delegate_object
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Dump BlocksInFile (stage 1)
@@ -100,6 +108,14 @@
   :opt_name: dump_blocks_in_file
   :procname: val_as_bool
 
+- :arg_name: BOOL
+  :default: false
+  :description: Dump inherited lines
+  :env_var: MDE_DUMP_INHERITED_LINES
+  :long_name: dump-dump-inherited-lines
+  :opt_name: dump_inherited_lines
+  :procname: val_as_bool
+
 - :arg_name: BOOL
   :default: false
   :description: Dump MenuBlocks (stage 2)
@@ -187,18 +203,20 @@
 ## match fenced code indented by spaces
 #
 - :default: "^(?<indent> *)`{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>.*) *$"
+  :description: Match the start of a fenced block
   :env_var: MDE_FENCED_START_EXTENDED_REGEX
   :opt_name: fenced_start_extended_regex
   :procname: val_as_str
 
 - :arg_name: RELATIVE_PATH
   :compreply: "."
-  :description: Name of document
+  :description: Name of the document to load
   :env_var: MDE_FILENAME
   :long_name: filename
   :opt_name: filename
@@ -212,6 +230,14 @@
   :procname: find
   :short_name: "?"
 
+- :arg_name: FIND_PATH
+  :default: ""
+  :description: Path for find (uses PATH if empty)
+  :env_var: MDE_FIND_PATH
+  :long_name: find-path
+  :opt_name: find_path
+  :procname: val_as_str
+
 - :default: "^# *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
@@ -338,7 +364,7 @@
 
 - :arg_name: BOOL
   :default: false
-  :description: Display headings (levels 1,2,3) in block selection menu
+  :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
   :procname: val_as_bool
@@ -408,7 +434,8 @@
 
 - :arg_name: BOOL
   :default: false
-  :description: Include imported notes in menu
+  # :description: Include imported notes in menu
+  :description: Whether imported blocks should be included in the menu
   :env_var: MDE_MENU_INCLUDE_IMPORTED_NOTES
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
@@ -590,7 +617,7 @@
 
 - :arg_name: BOOL
   :default: true
-  :description: Display standard output from execution
+  :description: Whether standard output from execution is displayed
   :env_var: MDE_OUTPUT_STDOUT
   :long_name: output-stdout
   :opt_name: output_stdout
@@ -612,14 +639,14 @@
 
 - :arg_name: BOOL
   :default: true
-  :description: Pause afte executing a BASH block
-  :env_var: MDE_PAUSE_after_script_execution
+  :description: Wheter to pause after manually executing a block and the next menu
+  :env_var: MDE_PAUSE_AFTER_SCRIPT_EXECUTION
   :opt_name: pause_after_script_execution
   :procname: val_as_bool
 
 - :default: "\nContinue?"
-  :description: Prompt after script execution
-  :env_var: MDE_PROMPT_after_script_execution
+  :description: Prompt after manually executing a block and the next menu
+  :env_var: MDE_PROMPT_AFTER_SCRIPT_EXECUTION
   :opt_name: prompt_after_script_execution
   :procname: val_as_str
 
@@ -701,7 +728,7 @@
 
 - :arg_name: BOOL
   :default: false
-  :description: Save executed script
+  :description: Wheter to save an executed script`
   :env_var: MDE_SAVE_EXECUTED_SCRIPT
   :long_name: save-executed-script
   :opt_name: save_executed_script
@@ -743,7 +770,7 @@
 
 - :arg_name: RELATIVE_PATH
   :default: logs
-  :description: Saved script folder
+  :description: Folder where saved scripts are stored
   :env_var: MDE_SAVED_SCRIPT_FOLDER
   :long_name: saved-script-folder
   :opt_name: saved_script_folder
@@ -868,7 +895,7 @@
 
 - :arg_name: BOOL
   :default: true
-  :description: Pause for user to approve script
+  :description: Requires user approval before executing a script
   :env_var: MDE_USER_MUST_APPROVE
   :long_name: user-must-approve
   :opt_name: user_must_approve

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.8.4)
+# MDE - Markdown Executor (1.8.6)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -15,7 +15,7 @@
   :procname: val_as_str
 - :arg_name: NAME
   :compreply: false
-  :description: Name of block
+  :description: Name of block to execute
   :env_var: MDE_BLOCK_NAME
   :long_name: block-name
   :opt_name: block_name
@@ -77,6 +77,13 @@
   :env_var: MDE_DOCUMENT_LOAD_OPTS_BLOCK_NAME
   :opt_name: document_load_opts_block_name
   :procname: val_as_str
+- :arg_name: BOOL
+  :default: false
+  :description: Dump @delegate_object
+  :env_var: MDE_DUMP_DELEGATE_OBJECT
+  :long_name: dump-dump-delegate-object
+  :opt_name: dump_delegate_object
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Dump BlocksInFile (stage 1)
@@ -84,6 +91,13 @@
   :long_name: dump-blocks-in-file
   :opt_name: dump_blocks_in_file
   :procname: val_as_bool
+- :arg_name: BOOL
+  :default: false
+  :description: Dump inherited lines
+  :env_var: MDE_DUMP_INHERITED_LINES
+  :long_name: dump-dump-inherited-lines
+  :opt_name: dump_inherited_lines
+  :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Dump MenuBlocks (stage 2)
@@ -160,17 +174,19 @@
   :procname: exit
   :short_name: x
 - :default: "^(?<indent> *)`{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>.*)
     *$"
+  :description: Match the start of a fenced block
   :env_var: MDE_FENCED_START_EXTENDED_REGEX
   :opt_name: fenced_start_extended_regex
   :procname: val_as_str
 - :arg_name: RELATIVE_PATH
   :compreply: "."
-  :description: Name of document
+  :description: Name of the document to load
   :env_var: MDE_FILENAME
   :long_name: filename
   :opt_name: filename
@@ -182,6 +198,13 @@
   :long_name: find
   :procname: find
   :short_name: "?"
+- :arg_name: FIND_PATH
+  :default: ''
+  :description: Path for find (uses PATH if empty)
+  :env_var: MDE_FIND_PATH
+  :long_name: find-path
+  :opt_name: find_path
+  :procname: val_as_str
 - :default: "^# *(?<name>[^#]*?) *$"
   :env_var: MDE_HEADING1_MATCH
   :opt_name: heading1_match
@@ -286,7 +309,8 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
-  :description: Display headings (levels 1,2,3) in block selection menu
+  :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
   :procname: val_as_bool
@@ -345,7 +369,7 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
-  :description: Include imported notes in menu
+  :description: Whether imported blocks should be included in the menu
   :env_var: MDE_MENU_INCLUDE_IMPORTED_NOTES
   :opt_name: menu_include_imported_notes
   :procname: val_as_bool
@@ -497,7 +521,7 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: true
-  :description: Display standard output from execution
+  :description: Whether standard output from execution is displayed
   :env_var: MDE_OUTPUT_STDOUT
   :long_name: output-stdout
   :opt_name: output_stdout
@@ -516,15 +540,15 @@
   :short_name: p
 - :arg_name: BOOL
   :default: true
-  :description: Pause afte executing a BASH block
-  :env_var: MDE_PAUSE_after_script_execution
+  :description: Wheter to pause after manually executing a block and the next menu
+  :env_var: MDE_PAUSE_AFTER_SCRIPT_EXECUTION
   :opt_name: pause_after_script_execution
   :procname: val_as_bool
 - :default: |2-
 
     Continue?
-  :description: Prompt after script execution
-  :env_var: MDE_PROMPT_after_script_execution
+  :description: Prompt after manually executing a block and the next menu
+  :env_var: MDE_PROMPT_AFTER_SCRIPT_EXECUTION
   :opt_name: prompt_after_script_execution
   :procname: val_as_str
 - :default: |2-
@@ -601,7 +625,7 @@
   :procname: val_as_int
 - :arg_name: BOOL
   :default: false
-  :description: Save executed script
+  :description: Wheter to save an executed script`
   :env_var: MDE_SAVE_EXECUTED_SCRIPT
   :long_name: save-executed-script
   :opt_name: save_executed_script
@@ -637,7 +661,7 @@
   :procname: val_as_str
 - :arg_name: RELATIVE_PATH
   :default: logs
-  :description: Saved script folder
+  :description: Folder where saved scripts are stored
   :env_var: MDE_SAVED_SCRIPT_FOLDER
   :long_name: saved-script-folder
   :opt_name: saved_script_folder
@@ -746,7 +770,7 @@
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: true
-  :description: Pause for user to approve script
+  :description: Requires user approval before executing a script
   :env_var: MDE_USER_MUST_APPROVE
   :long_name: user-must-approve
   :opt_name: user_must_approve

data/lib/regexp_replacer.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+require 'find'
+
+class RegexpReplacer
+  # Constructor to initialize with file path
+  def initialize(file_path)
+    @file_path = file_path
+  end
+
+  # Perform the replacement based on the specified option
+  def perform_replacement(option)
+    content = File.read(@file_path)
+    modified_content = case option
+                       when 1
+                         replace_pattern1(content)
+                       when 2
+                         replace_pattern2(content)
+                       else
+                         raise "Invalid option. Please choose 1 or 2."
+                       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'
+    content.gsub(regexp, substitution)
+  end
+
+  # Replacement for pattern 2
+  def replace_pattern2(content)
+    regexp = /^( *);;pp __LINE__,(.+) #(@\w+)/
+    substitution = '\1# \3 \2'
+    content.gsub(regexp, substitution)
+  end
+end
+
+# Running the script with command line arguments
+if ARGV.length != 2
+  puts "Usage: ruby regexp_replacer.rb [file_path] [option (1 or 2)]"
+  exit
+end
+
+file_path, option = ARGV
+replacer = RegexpReplacer.new(file_path)
+begin
+  replacer.perform_replacement(option.to_i)
+  puts "Replacement performed successfully."
+rescue StandardError => e
+  puts "Error: #{e.message}"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.8.4
+  version: 1.8.6
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -119,6 +119,7 @@ files:
 - examples/import1.md
 - examples/include.md
 - examples/infile_config.md
+- examples/linked.md
 - examples/linked1.md
 - examples/linked2.md
 - examples/linked3.md
@@ -156,6 +157,7 @@ files:
 - lib/option_value.rb
 - lib/pty1.rb
 - lib/regexp.rb
+- lib/regexp_replacer.rb
 - lib/rspec_helpers.rb
 - lib/saved_assets.rb
 - lib/saved_files_matcher.rb