markdown_exec 3.5.1 → 3.5.2

data/lib/link_history.rb

@@ -14,12 +14,15 @@ module MarkdownExec
     # 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_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, display_menu: nil, document_filename: nil,
-                   inherited_block_names: [], inherited_dependencies: nil, inherited_lines: nil,
-                   keep_code: false, prior_block_was_link: nil)
+    def initialize(
+      block_name: nil, display_menu: nil, document_filename: nil,
+      inherited_block_names: [], inherited_dependencies: nil,
+      inherited_lines: nil, keep_code: false, prior_block_was_link: nil
+    )
       @block_name = block_name
       @display_menu = display_menu
       @document_filename = document_filename
@@ -28,10 +31,12 @@ module MarkdownExec
       @inherited_lines = inherited_lines
       @keep_code = keep_code
       @prior_block_was_link = prior_block_was_link
+      wwt :link_state, self, caller.deref
     end
 
     # Creates an empty LinkState instance.
-    # @return [LinkState] an instance with all attributes set to their default values.
+    # @return [LinkState] an instance with all attributes
+    # set to their default values.
     def self.empty
       new
     end
@@ -99,12 +104,14 @@ module MarkdownExec
       @history = []
     end
 
-    # Peeks at the most recent LinkState, returns an empty LinkState if stack is empty.
+    # 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.
+    # Pops the most recent LinkState off the stack, returns an empty LinkState
+    # if stack is empty.
     def pop
       @history.pop || LinkState.empty
     end
@@ -131,10 +138,14 @@ if $PROGRAM_NAME == __FILE__
     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'])
+        @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

data/lib/markdown_exec/version.rb

@@ -8,5 +8,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '3.5.1'
+  VERSION = '3.5.2'
 end

data/lib/mdoc.rb

@@ -5,6 +5,7 @@
 
 require_relative 'block_types'
 require_relative 'collapser'
+require_relative 'command_result'
 require_relative 'filter'
 
 $pd = false unless defined?($pd)
@@ -12,7 +13,7 @@ $pd = false unless defined?($pd)
 module MarkdownExec
   class MenuFilter
     def initialize(opts)
-      @opts = opts.merge(block_name_hidden_match: nil)
+      @opts = opts.merge(block_name_hide_custom_match: nil)
     end
 
     def fcb_in_menu?(fcb)
@@ -38,10 +39,10 @@ module MarkdownExec
         false
       else
         @opts[:hide_blocks_by_name] &&
-          ((@opts[:block_name_hidden_match]&.present? &&
+          ((@opts[:block_name_hide_custom_match]&.present? &&
+            block.s2title&.match(Regexp.new(@opts[:block_name_hide_custom_match]))) ||
+           (@opts[:block_name_hidden_match]&.present? &&
             block.s2title&.match(Regexp.new(@opts[:block_name_hidden_match]))) ||
-           (@opts[:block_name_include_match]&.present? &&
-            block.s2title&.match(Regexp.new(@opts[:block_name_include_match]))) ||
            (@opts[:block_name_wrapper_match]&.present? &&
             block.s2title&.match(Regexp.new(@opts[:block_name_wrapper_match])))) &&
           (block.s2title&.present? || block[:label]&.present?)
@@ -85,7 +86,7 @@ module MarkdownExec
       end
     end
 
-    # Collects and formats the shell command output to redirect script block code to a file or a variable.
+    # Generates a shell command to redirect a block's body to either a shell variable or a file.
     #
     # @param [Hash] fcb A hash containing information about the script block's stdout and body.
     #   @option fcb [Hash] :stdout A hash specifying the stdout details.
@@ -93,10 +94,10 @@ module MarkdownExec
     #     @option stdout [String] :name The name of the variable or file to which the body will be output.
     #   @option fcb [Array<String>] :body An array of strings representing the lines of the script block's body.
     #
-    # @return [String] A string containing the formatted shell command to output the script block's body.
+    # @return [String] A string containing the shell command to redirect the script block's body.
     #   If stdout[:type] is true, the command will export the body to a shell variable.
     #   If stdout[:type] is false, the command will write the body to a file.
-    def collect_block_code_stdout(fcb)
+    def code_for_fcb_body_into_var_or_file(fcb)
       stdout = fcb[:stdout]
       body = fcb.body.join("\n")
       if stdout[:type]
@@ -168,44 +169,31 @@ module MarkdownExec
     #
     def collect_recursively_required_code(
       anyname:, block_source:,
-      label_body: true, label_format_above: nil, label_format_below: nil
+      label_body: true, label_format_above: nil, label_format_below: nil,
+      inherited_lines: [] ###s
     )
+      raise 'unexpected label_body' unless label_body
+
       block_search = collect_block_dependencies(anyname: anyname)
       if block_search[:blocks]
         blocks = collect_wrapped_blocks(block_search[:blocks])
         # !!t blocks.count
 
+        code_inherit = blocks.map do |fcb|
+          process_block_to_code(
+            fcb, block_source,
+            label_body, label_format_above, label_format_below,
+            inherited_lines: inherited_lines
+          )
+        end
+
         block_search.merge(
           { block_names: blocks.map(&:pub_name),
-            code: blocks.map do |fcb|
-              if fcb[:cann]
-                collect_block_code_cann(fcb)
-              elsif fcb[:stdout]
-                collect_block_code_stdout(fcb)
-              elsif [BlockType::OPTS].include? fcb.type
-                fcb.body # entire body is returned to requesing block
-
-              elsif [BlockType::LINK,
-                     BlockType::LOAD,
-                     BlockType::UX,
-                     BlockType::VARS].include? fcb.type
-                nil # Vars for all types are collected later
-              elsif fcb[:chrome] # for Link blocks like History
-                nil
-              elsif fcb.type == BlockType::PORT
-                generate_env_variable_shell_commands(fcb)
-              elsif label_body
-                generate_label_body_code(
-                  fcb, block_source,
-                  label_format_above, label_format_below
-                )
-              else # raw body
-                fcb.body
-              end
-            end.compact.flatten(1).compact }
+            code: code_inherit.map(&:first).compact.flatten(1).compact,
+            inherit: code_inherit.map(&:last).compact.flatten(1).compact }
         )
       else
-        block_search.merge({ block_names: [], code: [] })
+        block_search.merge({ block_names: [], code: [], inherit: [] })
       end
     rescue StandardError
       error_handler('collect_recursively_required_code')
@@ -237,6 +225,8 @@ module MarkdownExec
             table_not_split.select { |fcb| fcb.code_name_included?(wrap_after) }
           end.flatten(1)
       end.flatten(1).compact
+    rescue StandardError
+      wwe $!
     end
 
     def error_handler(name = '', opts = {})
@@ -252,7 +242,7 @@ module MarkdownExec
     # @return [Array<Hash>] An array of code blocks that match the options.
     #
     def fcbs_per_options(opts = {})
-      options = opts.merge(block_name_hidden_match: nil)
+      options = opts.merge(block_name_hide_custom_match: nil)
       selrows = @table.select do |fcb_title_groups|
         Filter.fcb_select? options, fcb_title_groups
       end
@@ -305,6 +295,8 @@ module MarkdownExec
             !next_element.nil? &&
             next_element.shell.present?)
       end
+    rescue StandardError
+      wwe $!
     end
 
     # Generates shell code lines to set environment variables named in the body of the given object.
@@ -328,7 +320,7 @@ module MarkdownExec
       end
     end
 
-    # Generates a formatted code block with labels above and below the main content.
+    # Wraps a code block body with formatted labels above and below the main content.
     # The labels and content are based on the provided format strings and the body of the given object.
     #
     # @param fcb [Object] An object with a `pub_name` method that returns a string, and a `body` method that returns an array of strings.
@@ -343,8 +335,8 @@ module MarkdownExec
     #   and `label_format_below` is "End of %{block_name}", the method will return:
     #     ["Start of Example_Block", "line1", "line2", "End of Example_Block"]
     #
-    def generate_label_body_code(fcb, block_source, label_format_above,
-                                 label_format_below)
+    def wrap_block_body_with_labels(fcb, block_source, label_format_above,
+                                    label_format_below)
       block_name_for_bash_comment = fcb.pub_name.gsub(/\s+/, '_')
 
       label_above = if label_format_above.present?
@@ -403,16 +395,83 @@ module MarkdownExec
         false
       else
         opts[:hide_blocks_by_name] &&
-          ((opts[:block_name_hidden_match]&.present? &&
+          ((opts[:block_name_hide_custom_match]&.present? &&
+            block.s2title&.match(Regexp.new(opts[:block_name_hide_custom_match]))) ||
+           (opts[:block_name_hidden_match]&.present? &&
             block.s2title&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
-           (opts[:block_name_include_match]&.present? &&
-            block.s2title&.match(Regexp.new(opts[:block_name_include_match]))) ||
            (opts[:block_name_wrapper_match]&.present? &&
             block.s2title&.match(Regexp.new(opts[:block_name_wrapper_match])))) &&
           (block.s2title&.present? || block[:label]&.present?)
       end
     end
 
+    # Processes a single code block and returns its code representation.
+    #
+    # @param fcb [Hash] The code block to process.
+    # @param block_source [Hash] Additional information for label generation.
+    # @param label_body [Boolean] Whether to generate labels around the body.
+    # @param label_format_above [String, nil] Format string for label above content.
+    # @param label_format_below [String, nil] Format string for label below content.
+    # @return [String, Array, nil] The code representation of the block, or nil if the block should be skipped.
+    #
+    def process_block_to_code(fcb, block_source, label_body, label_format_above,
+                              label_format_below, inherited_lines: [])
+      raise 'unexpected label_body' unless label_body
+
+      new_inherited_lines = []
+
+      new_code_lines = if fcb[:cann]
+                         collect_block_code_cann(fcb)
+                       elsif fcb[:stdout]
+                         code_for_fcb_body_into_var_or_file(fcb)
+                       elsif [BlockType::OPTS].include? fcb.type
+                         fcb.body # entire body is returned to requesing block
+
+                       elsif [BlockType::LINK,
+                              BlockType::LOAD,
+                              BlockType::UX,
+                              BlockType::VARS].include? fcb.type
+                         nil # Vars for all types are collected later
+                       elsif fcb[:chrome] # for Link blocks like History
+                         nil
+                       elsif fcb.type == BlockType::PORT
+                         generate_env_variable_shell_commands(fcb)
+                       elsif label_body
+                         raise 'unexpected type' if fcb.type != BlockType::SHELL
+
+                         # BlockType::  SHELL block
+                         if fcb.start_line =~ /@eval/ ###s
+                           command_result = HashDelegator.execute_bash_script_lines(
+                             code_lines: inherited_lines + fcb.body,
+                             export: OpenStruct.new(exportable: true, name: ''),
+                             force: true,
+                             shell: fcb.shell || 'bash'
+                           )
+                           command_result.new_lines.map { _1[:text] }.tap do
+                             if fcb.start_line =~ /@inherit/ ###s
+                               new_inherited_lines = _1
+                             end
+                           end
+
+                         elsif fcb.start_line =~ /@inherit/ ###s
+                           # raw body
+                           ### expansions?
+                           new_inherited_lines = fcb.body
+                           nil # collect later or return as code to inherit
+
+                         else
+                           wrap_block_body_with_labels(
+                             fcb, block_source,
+                             label_format_above, label_format_below
+                           )
+                         end
+                       else # raw body
+                         fcb.body
+                       end
+
+      [new_code_lines, new_inherited_lines].tap { wwr _1 }
+    end
+
     # Recursively fetches required code blocks for a given list of requirements.
     #
     # @param reqs [Array<String>] An array of requirements to start the recursion from.
@@ -620,7 +679,7 @@ if $PROGRAM_NAME == __FILE__
 
       def test_hide_menu_block_on_name
         opts = { hide_blocks_by_name: true,
-                 block_name_hidden_match: 'block1' }
+                 block_name_hide_custom_match: 'block1' }
         block = FCB.new(s2title: 'block1')
         result = @doc.hide_menu_block_on_name(opts, block)
         assert result # this should be true based on the given logic
@@ -628,7 +687,7 @@ if $PROGRAM_NAME == __FILE__
 
       def test_fcbs_per_options
         opts = { hide_blocks_by_name: true,
-                 block_name_hidden_match: 'block1' }
+                 block_name_hide_custom_match: 'block1' }
         result = @doc.fcbs_per_options(opts)
         assert_equal [@table[1], @table[2]], result
       end if false ### broken test