markdown_exec 1.8.2 → 1.8.5

data/lib/link_history.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+module MarkdownExec
+  class LinkState
+    attr_accessor :block_name, :document_filename,
+                  :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_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
+
+    # Creates an empty LinkState instance.
+    # @return [LinkState] an instance with all attributes set to their default values.
+    def self.empty
+      new
+    end
+
+    # Custom equality method to compare LinkState objects.
+    # @param other [LinkState] the other LinkState object to compare with.
+    # @return [Boolean] true if the objects are equal, false otherwise.
+    def ==(other)
+      other.class == self.class &&
+        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
+
+  class LinkHistory
+    def initialize
+      @history = []
+    end
+
+    # Peeks at the most recent LinkState, returns an empty LinkState if stack is empty.
+    def peek
+      @history.last || LinkState.empty
+    end
+
+    # Pops the most recent LinkState off the stack, returns an empty LinkState if stack is empty.
+    def pop
+      @history.pop || LinkState.empty
+    end
+
+    def prior_state_exist?
+      peek.document_filename.present?
+    end
+
+    # Pushes a LinkState onto the stack.
+    def push(link_state)
+      @history.push(link_state)
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  require 'bundler/setup'
+  Bundler.require(:default)
+
+  require 'minitest/autorun'
+  require 'mocha/minitest'
+
+  module MarkdownExec
+    class TestLinkHistory < Minitest::Test
+      def setup
+        @link_history = LinkHistory.new
+        @link_state1 = LinkState.new(block_name: 'block1', document_filename: 'document1.txt',
+                                     inherited_lines: ['code1.rb'])
+        @link_state2 = LinkState.new(block_name: 'block2', document_filename: 'document2.txt',
+                                     inherited_lines: ['code2.rb'])
+      end
+
+      def test_push
+        @link_history.push(@link_state1)
+        assert_equal @link_state1, @link_history.peek
+      end
+
+      def test_pop
+        @link_history.push(@link_state1)
+        @link_history.push(@link_state2)
+        assert_equal @link_state2, @link_history.pop
+        assert_equal @link_state1, @link_history.peek
+      end
+
+      def test_peek_empty
+        assert_equal LinkState.empty, @link_history.peek
+      end
+
+      def test_pop_empty
+        assert_equal LinkState.empty, @link_history.pop
+      end
+    end
+  end
+end
+
+__END__
+
+To generate the Ruby classes `LinkState` and `LinkHistory` with their current features and specifications, including the custom `==` method for object comparison and the implementation to handle empty states, you can use the following prompt:
+
+---
+
+Create Ruby classes `LinkState` and `LinkHistory` with the following specifications:
+
+1. **Class `LinkState`**:
+    - Attributes: `block_name`, `document_filename`, `inherited_lines`.
+    - Initialize with optional parameters for each attribute, defaulting to `nil`.
+    - Include a class method `empty` that creates an instance with all attributes set to `nil`.
+    - Implement a custom `==` method for comparing instances based on attribute values.
+
+2. **Class `LinkHistory`**:
+    - Use an array to manage a stack of `LinkState` instances.
+    - Implement the following methods:
+        - `push`: Adds a `LinkState` instance to the top of the stack.
+        - `pop`: Removes and returns the most recent `LinkState` from the stack, or returns an empty `LinkState` if the stack is empty.
+        - `peek`: Returns the most recent `LinkState` without removing it from the stack, or an empty `LinkState` if the stack is empty.
+
+3. **Testing**:
+    - Write Minitest test cases to validate each method in `LinkHistory`. Test scenarios should include pushing and popping `LinkState` instances, and handling an empty `LinkHistory`.
+
+The goal is to create a robust and efficient implementation of these classes, ensuring proper handling of stack operations and object comparisons.

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.2'
+  VERSION = '1.8.5'
 end

data/lib/markdown_exec.rb

@@ -41,8 +41,6 @@ tap_config envvar: MarkdownExec::TAP_DEBUG
 $stderr.sync = true
 $stdout.sync = true
 
-MDE_HISTORY_ENV_NAME = 'MDE_MENU_HISTORY'
-
 # custom error: file specified is missing
 #
 class FileMissingError < StandardError; end
@@ -51,6 +49,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}" })
@@ -60,7 +63,7 @@ end
 def bpp(*args)
   pp '+ bpp()'
   pp(*args.map.with_index { |line, ind| "  - #{ind}: #{line}" })
-  rbp
+  rbi
 end
 
 def rpry
@@ -172,26 +175,6 @@ module MarkdownExec
       }
     end
 
-    def clear_required_file
-      ENV['MDE_LINK_REQUIRED_FILE'] = ''
-    end
-
-    # # Deletes a required temporary file specified by an environment variable.
-    # # The function checks if the file exists before attempting to delete it.
-    # # Clears the environment variable after deletion.
-    # #
-    # def delete_required_temp_file
-    #   temp_blocks_file_path = ENV.fetch('MDE_LINK_REQUIRED_FILE', nil)
-
-    #   return if temp_blocks_file_path.nil? || temp_blocks_file_path.empty?
-
-    #   FileUtils.rm_f(temp_blocks_file_path)
-
-    #   clear_required_file
-    # rescue StandardError
-    #   error_handler('delete_required_temp_file')
-    # end
-
     public
 
     ## Determines the correct filename to use for searching files
@@ -368,6 +351,16 @@ module MarkdownExec
                                                                       :menu_chrome_color)}"
           searcher = DirectorySearcher.new(value, [@options[:path]])
 
+          @fout.fout 'In file contents'
+          hash = searcher.search_in_file_contents
+          hash.each.with_index do |(key, v2), i1|
+            @fout.fout format('- %3.d: %s', i1 + 1, key)
+            @fout.fout AnsiFormatter.new(options).format_and_highlight_array(
+              v2.map { |nl| format('=%4.d: %s', nl.index, nl.line) },
+              highlight: [value]
+            )
+          end
+
           @fout.fout 'In directory names'
           @fout.fout AnsiFormatter.new(options).format_and_highlight_array(
             searcher.search_in_directory_names, highlight: [value]
@@ -378,15 +371,6 @@ module MarkdownExec
             searcher.search_in_file_names, highlight: [value]
           ).join("\n")
 
-          @fout.fout 'In file contents'
-          hash = searcher.search_in_file_contents
-          hash.each.with_index do |(key, v2), i1|
-            @fout.fout format('- %3.d: %s', i1 + 1, key)
-            @fout.fout AnsiFormatter.new(options).format_and_highlight_array(
-              v2.map { |nl| format('=%4.d: %s', nl.index, nl.line) },
-              highlight: [value]
-            )
-          end
           exit
         }
       when 'help'
@@ -545,12 +529,12 @@ module MarkdownExec
     public
 
     def run
-      clear_required_file
       initialize_and_parse_cli_options
       execute_block_with_error_handling
-      @options.delete_required_temp_file
     rescue StandardError
       error_handler('run')
+    ensure
+      yield if block_given?
     end
 
     private

data/lib/mdoc.rb

@@ -3,8 +3,8 @@
 
 # encoding=utf-8
 
-require_relative 'filter'
 require_relative 'block_types'
+require_relative 'filter'
 
 module MarkdownExec
   ##
@@ -75,7 +75,6 @@ module MarkdownExec
         raise "Named code block `#{name}` not found. (@#{__LINE__})"
       end
 
-      # all_dependency_names = [name_block.oname] + recursively_required(name_block[:reqs])
       dependencies = collect_dependencies(name_block[:oname])
       all_dependency_names = collect_unique_names(dependencies).push(name_block[:oname]).uniq
       unmet_dependencies = all_dependency_names.dup
@@ -91,10 +90,11 @@ module MarkdownExec
         else
           []
         end + [fcb]
-      end.flatten(1) #.tap { rbp }
-      { all_dependency_names: all_dependency_names, 
-        blocks: blocks, 
-        dependencies: dependencies, 
+      end.flatten(1)
+
+      { all_dependency_names: all_dependency_names,
+        blocks: blocks,
+        dependencies: dependencies,
         unmet_dependencies: unmet_dependencies }
     end
 
@@ -103,26 +103,37 @@ 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)
+    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)
-      block_search.merge({ code: collect_wrapped_blocks(block_search[:blocks]).map do |fcb|
-        if fcb[:cann]
-          collect_block_code_cann(fcb)
-        elsif fcb[:stdout]
-          collect_block_code_stdout(fcb)
-        elsif [BlockType::LINK, BlockType::OPTS,
-               BlockType::VARS].include? fcb[:shell]
-          nil
-        elsif fcb[:shell] == BlockType::PORT
-          collect_block_code_shell(fcb)
-        elsif label_body
-          [label_format_above && format(label_format_above, { name: fcb[:oname] })] + 
-           fcb[:body] + 
-           [label_format_below && format(label_format_below, { name: fcb[:oname] })]
-        else # raw body
-          fcb[:body]
-        end
-      end.compact.flatten(1).compact })
+      if block_search[:blocks]
+        blocks = collect_wrapped_blocks(block_search[:blocks])
+        block_search.merge(
+          { block_names: blocks.map { |block| block[:oname] },
+            code: blocks.map do |fcb|
+              if fcb[:cann]
+                collect_block_code_cann(fcb)
+              elsif fcb[:stdout]
+                collect_block_code_stdout(fcb)
+              elsif [BlockType::LINK, BlockType::OPTS,
+                     BlockType::VARS].include? fcb[:shell]
+                nil
+              elsif fcb[:shell] == BlockType::PORT
+                collect_block_code_shell(fcb)
+              elsif label_body
+                [label_format_above && format(label_format_above,
+                                              block_source.merge({ block_name: fcb[:oname] }))] +
+                 fcb[:body] +
+                 [label_format_below && format(label_format_below,
+                                               block_source.merge({ block_name: fcb[:oname] }))]
+              else # raw body
+                fcb[:body]
+              end
+            end.compact.flatten(1).compact }
+        )
+      else
+        block_search.merge({ block_names: [], code: [] })
+      end
     end
 
     def collect_unique_names(hash)
@@ -279,11 +290,10 @@ module MarkdownExec
       return memo unless source
 
       if (block = get_block_by_anyname(source)).nil? || block.keys.empty?
-        if true
-          return memo
-        else
-          raise "Named code block `#{source}` not found. (@#{__LINE__})"
-        end
+        return memo if true
+
+        raise "Named code block `#{source}` not found. (@#{__LINE__})"
+
       end
 
       return memo unless block[:reqs]

data/lib/menu.src.yml

@@ -92,17 +92,35 @@
   :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)
   :env_var: MDE_DUMP_BLOCKS_IN_FILE
+  :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)
   :env_var: MDE_DUMP_MENU_BLOCKS
+  :long_name: dump-menu-blocks
   :opt_name: dump_menu_blocks
   :procname: val_as_bool
 
@@ -110,6 +128,7 @@
   :default: false
   :description: Dump selected block
   :env_var: MDE_DUMP_SELECTED_BLOCK
+  :long_name: dump-selected-block
   :opt_name: dump_selected_block
   :procname: val_as_bool
 
@@ -846,13 +865,13 @@
   :opt_name: shell
   :procname: val_as_str
 
-- :default: "#  -^-  +%{name}  -^-"
+- :default: "#  -^-  +%{block_name}  -o-  %{document_filename}  -^-"
   :description: shell_code_label_format_above
   :env_var: MDE_SHELL_CODE_LABEL_FORMAT_ABOVE
   :opt_name: shell_code_label_format_above
   :procname: val_as_str
 
-- :default: "#  -v-  +%{name}  -v-"
+- :default: "#  -v-  +%{block_name}  -v-"
   :description: shell_code_label_format_below
   :env_var: MDE_SHELL_CODE_LABEL_FORMAT_BELOW
   :opt_name: shell_code_label_format_below

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.8.2)
+# MDE - Markdown Executor (1.8.5)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -77,22 +77,39 @@
   :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)
   :env_var: MDE_DUMP_BLOCKS_IN_FILE
+  :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)
   :env_var: MDE_DUMP_MENU_BLOCKS
+  :long_name: dump-menu-blocks
   :opt_name: dump_menu_blocks
   :procname: val_as_bool
 - :arg_name: BOOL
   :default: false
   :description: Dump selected block
   :env_var: MDE_DUMP_SELECTED_BLOCK
+  :long_name: dump-selected-block
   :opt_name: dump_selected_block
   :procname: val_as_bool
 - :default: fg_rgbh_ff_00_7f
@@ -727,12 +744,12 @@
   :env_var: MDE_SHELL
   :opt_name: shell
   :procname: val_as_str
-- :default: "#  -^-  +%{name}  -^-"
+- :default: "#  -^-  +%{block_name}  -o-  %{document_filename}  -^-"
   :description: shell_code_label_format_above
   :env_var: MDE_SHELL_CODE_LABEL_FORMAT_ABOVE
   :opt_name: shell_code_label_format_above
   :procname: val_as_str
-- :default: "#  -v-  +%{name}  -v-"
+- :default: "#  -v-  +%{block_name}  -v-"
   :description: shell_code_label_format_below
   :env_var: MDE_SHELL_CODE_LABEL_FORMAT_BELOW
   :opt_name: shell_code_label_format_below

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.5
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2023-12-22 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
@@ -145,6 +146,7 @@ files:
 - lib/fout.rb
 - lib/hash.rb
 - lib/hash_delegator.rb
+- lib/link_history.rb
 - lib/markdown_exec.rb
 - lib/markdown_exec/version.rb
 - lib/mdoc.rb