markdown_exec 2.5.0 → 2.6.0

data/lib/hierarchy_string.rb

@@ -30,7 +30,7 @@ class HierarchyString
   attr_accessor :substrings
 
   # Initialize with a single hash or an array of hashes
-  def initialize(substrings, text_sym: :text, style_sym: :color)
+  def initialize(substrings = [], text_sym: :text, style_sym: :color)
     @substrings = parse_substrings(substrings)
     @text_sym = text_sym
     @style_sym = style_sym
@@ -82,6 +82,10 @@ class HierarchyString
     decorate_substrings(@substrings)
   end
 
+  def padded_width
+    concatenate.length
+  end
+
   # Handle string inspection methods and pass them to the concatenated string
   def method_missing(method_name, *arguments, &block)
     if ''.respond_to?(method_name)

data/lib/markdown_exec/version.rb

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

data/lib/markdown_exec.rb

@@ -15,7 +15,6 @@ require 'tty-prompt'
 require 'yaml'
 
 require_relative 'ansi_formatter'
-# require_relative 'block_label'
 require_relative 'cached_nested_file_reader'
 require_relative 'cli'
 require_relative 'color_scheme'
@@ -94,6 +93,7 @@ class NamedCaptureExtractor
     regexp = pattern.is_a?(Regexp) ? pattern : Regexp.new(pattern)
     str&.match(regexp)&.named_captures&.transform_keys(&:to_sym)
   end
+
   def self.extract_named_group2(match_data)
     match_data&.named_captures&.transform_keys(&:to_sym)
   end
@@ -415,14 +415,10 @@ module MarkdownExec
       options = calculated_options.merge(options)
       update_options(options, over: false)
       # recognize commands with an opt_name, no procname
-      # !!b
       return if execute_simple_commands(options, stage: 1)
-      # !!b
 
       mde_vux_main_loop(opts_prepare_file_list(options))
-      # !!b
       return unless @options[:output_saved_script_filename]
-      # !!b
 
       @fout.fout "script_block_name: #{run_state.script_block_name}"
       @fout.fout "s_save_filespec: #{run_state.saved_filespec}"
@@ -433,16 +429,10 @@ module MarkdownExec
       # !!p stage
       simple_commands(options).each do |key, (cstage, proc)|
         if @options[key].is_a?(TrueClass) || @options[key].present?
-          # !!v key, 'cstage', cstage
           if stage && stage == cstage
-            # !!b
             proc.call
             return true
-          else
-          # !!b
           end
-        else
-          # !!b
         end
       end
       false
@@ -584,7 +574,7 @@ module MarkdownExec
 
       files_table_rows = @options.read_saved_assets_for_history_table(
         asset: @options[:filename]
-      ) # !!v files_table_rows
+      )
       if sift_regexp
         # Filter history to file names matching a pattern
         files_table_rows.select! { |item| sift_regexp.match(item[:file]) }
@@ -816,20 +806,14 @@ module MarkdownExec
 
     # Reports and executes block logic
     def mde_vux_main_loop(files)
-      # !!b
       @options[:filename] = select_document_if_multiple(files)
       @options.vux_main_loop do |type, data|
         case type
         when :command_names
-          # !!b
           simple_commands(data).keys
         when :call_proc
-          # !!b
-          # simple_commands(data[0])[data[1]].call
           simple_commands(data[0])[data[1]][1].call
-
         when :end_of_cli
-          # !!b
           execute_simple_commands(options, stage: 2)
         else
           raise
@@ -1041,21 +1025,21 @@ module MarkdownExec
         list_default_yaml: [1, -> { @fout.fout_list list_default_yaml }],
         list_docs: [1, -> { @fout.fout_list opts_prepare_file_list(options) }],
         list_recent_output: [1, -> {
-                              @fout.fout_list list_recent_output(
-                                @options[:saved_stdout_folder],
-                                @options[:saved_stdout_glob], @options[:list_count]
-                              )
-                            }],
+                                  @fout.fout_list list_recent_output(
+                                    @options[:saved_stdout_folder],
+                                    @options[:saved_stdout_glob], @options[:list_count]
+                                  )
+                                }],
         list_recent_scripts: [1, -> {
-                               @fout.fout_list list_recent_scripts(
-                                 options[:saved_script_folder],
-                                 options[:saved_script_glob], options[:list_count]
-                               )
-                             }],
-        menu_export: [1, -> {@fout.fout menu_export }],
-        pwd: [1, -> {@fout.fout File.expand_path('..', __dir__) }],
-        run_last_script: [1, -> {run_last_script }],
-        tab_completions: [1, -> {@fout.fout tab_completions }]
+                                   @fout.fout_list list_recent_scripts(
+                                     options[:saved_script_folder],
+                                     options[:saved_script_glob], options[:list_count]
+                                   )
+                                 }],
+        menu_export: [1, -> { @fout.fout menu_export }],
+        pwd: [1, -> { @fout.fout File.expand_path('..', __dir__) }],
+        run_last_script: [1, -> { run_last_script }],
+        tab_completions: [1, -> { @fout.fout tab_completions }]
       }
     end
 

data/lib/mdoc.rb

@@ -4,6 +4,7 @@
 # encoding=utf-8
 
 require_relative 'block_types'
+require_relative 'collapser'
 require_relative 'filter'
 
 $pd = false unless defined?($pd)
@@ -206,27 +207,114 @@ module MarkdownExec
 
       ### hide rows correctly
 
-      unless options[:menu_include_imported_blocks]
-        selrows = selrows.reject do |block|
-          block.fetch(:depth, 0).positive?
+      unless opts[:menu_include_imported_blocks]
+        selrows = selrows.reject do |fcb|
+          fcb.fetch(:depth, 0).positive?
         end
       end
 
       if opts[:hide_blocks_by_name]
-        selrows = selrows.reject do |block|
-          hide_menu_block_on_name opts, block
+        selrows = selrows.reject do |fcb|
+          hide_menu_block_on_name(opts, fcb)
         end
       end
 
+      collapser = Collapser.new(
+        options: opts, state: opts[:compressed_ids] || {}
+      )
+      selrows = collapser.reject(selrows, initialize: opts[:compressed_ids].nil?) do |fcb, hide, collapsed_level|
+        # update fcb per state
+        if fcb.collapsible
+          fcb.s1decorated = fcb.s1decorated + ' ' + (fcb.collapse ? opts[:menu_collapsible_symbol_collapsed] : opts[:menu_collapsible_symbol_expanded])
+        end
+      end
+      opts[:compressed_ids] = collapser.state
+
       # remove
       # . empty chrome between code; edges are same as blanks
       #
-      select_elements_with_neighbor_conditions(selrows) do |prev_element, current, next_element|
-        !(current[:chrome] && !current.oname.present?) ||
-          !(!prev_element.nil? &&
-            prev_element.shell.present? &&
-            !next_element.nil? &&
-            next_element.shell.present?)
+      [
+        select_elements_with_neighbor_conditions(selrows) do |prev_element, current, next_element|
+          !(current[:chrome] && !current.oname.present?) ||
+            !(!prev_element.nil? &&
+              prev_element.shell.present? &&
+              !next_element.nil? &&
+              next_element.shell.present?)
+        end,
+        opts[:compressed_ids]
+      ]
+    end
+
+    # Filters out blocks that are nested within a hierarchy of "hidden" blocks.
+    #
+    # The method iterates over selected rows and uses a callback block to determine if a given block
+    # should trigger hiding for subsequent blocks in the hierarchy. Once hiding is triggered, all
+    # blocks with a level greater than the triggering block's level are excluded until the next
+    # visible collapsible block.
+    #
+    # @param selrows [Array] The array of selected rows to filter based on the callback's results.
+    # @param callback [Lambda/Proc] Alternate to yield block.
+    # @param collapsible_types [Array] Types to select, nil for all.
+    # @yield [block] A callback to evaluate each block; should return true to initiate hiding.
+    # @return [Array] Filtered list of rows, excluding those hidden by hierarchical hiding rules.
+    #
+    # Example:
+    #   proc_condition = Proc.new { |fcb| fcb.type == BlockType::HEADING && fcb.level == 1 }
+    #   reject_collapsed_blocks(selrows, callback: proc_condition)
+    #
+    #   lambda_condition = ->(fcb) { fcb.type == BlockType::HEADING && fcb.level == 1 }
+    #   reject_collapsed_blocks(selrows, callback: lambda_condition)
+    #
+    # Block: Exits the enclosing method (test_with_block) if return is used.
+    #        Flexible with arguments
+    # Proc: Exits the enclosing method (test_with_proc) when return is encountered, similar to a block.
+    # Lambda: Only exits the lambda itself, allowing reject_collapsed_blocks to continue execution.
+    #         Stricter argument checking.
+    #
+    # **`lambda` provides more control** and avoids the early exit behavior caused by `return` in blocks or `Proc` objects, making it a safer choice when you want `reject_collapsed_blocks` to complete its execution regardless of the callback’s behavior.
+    def reject_collapsed_blocks(
+      selrows,
+      callback: nil,
+      reject_callback: nil,
+      collapsible_types: nil,
+      &block
+    )
+      block ||= callback           # Use callback if no block is provided
+      hiding = false               # State to indicate if hiding is active
+      hidden_level = nil           # Level at which hiding was triggered
+
+      selrows.reject do |fcb|      # Reject rows that should be hidden based on the hierarchy
+        if hiding
+          # Currently in hiding mode; evaluate if the current block should remain hidden
+          if collapsible_types.nil? || collapsible_types.include?(fcb.type)
+            if hidden_level.nil?
+              # No specific hidden level yet, allow the item to show
+              false
+            elsif fcb.level > hidden_level
+              reject_callback.call(fcb, ) if reject_callback
+              # The current block is at a deeper level and thus remains hidden
+              true
+            else
+              # At the same or higher level than hidden_level, check if the callback initiates hiding again
+              hiding = block.call(fcb)
+              hidden_level = fcb.level if hiding # Update hidden level if hiding continues
+              false                              # Do not hide the initiating block itself
+            end
+          else
+            reject_callback.call(fcb) if reject_callback
+            # Non-collapsible block types (e.g., text or note) continue hiding by default
+            true
+          end
+
+        elsif block.call(fcb)
+          # If callback triggers hiding, initialize hiding state and hidden_level
+          hiding = fcb.type        # Start hiding subsequent blocks
+          hidden_level = fcb.level # Define the hierarchical level for hiding
+          false                    # Do not hide the initiating block itself
+
+        else
+          false                    # Default: do not hide if no hiding state
+        end
       end
     end
 
@@ -416,29 +504,6 @@ module MarkdownExec
 
       selected_elements
     end
-
-    # def select_elements_with_neighbor_conditions(array)
-    #   # This function filters elements from the array where the current element has property A set to true
-    #   # and both the previous and next elements have property B set to true.
-    #   selected_elements = []
-
-    #   array.each_with_index do |element, index|
-    #     next if index.zero? # Skip the first element since it has no previous element
-    #     break if index >= array.size - 1 # Break before the last to avoid out-of-bound errors
-
-    #     prev_element = array[index - 1]
-    #     next_element = array[index + 1]
-
-    #     # Check the conditions for property A on the current element and property B on adjacent elements
-    #     unless element[:chrome] && !element[:oname].present? && prev_element.shell.present? && next_element.shell.present?
-    #       selected_elements << element
-    #     # else
-    # # pp 'SKIPPING', element
-    #     end
-    #   end
-
-    #   selected_elements
-    # end
   end
 end
 
@@ -540,7 +605,7 @@ if $PROGRAM_NAME == __FILE__
 
       def test_fcbs_per_options
         opts = { hide_blocks_by_name: true, block_name_hidden_match: 'block1' }
-        result = @doc.fcbs_per_options(opts)
+        result, _ = @doc.fcbs_per_options(opts)
         assert_equal [@table[1], @table[2]], result
       end if false ### broken test
 

data/lib/menu.src.yml

@@ -11,6 +11,11 @@
   :default: false
   :procname: val_as_bool
 
+- :opt_name: block_batch_match
+  :env_var: MDE_BLOCK_BATCH_MATCH
+  :default: '@batch'
+  :procname: val_as_str
+
 - :opt_name: block_calls_scan
   :env_var: MDE_BLOCK_CALLS_SCAN
   :default: "%\\([^\\)]+\\)"
@@ -21,6 +26,11 @@
   :default: '@disable'
   :procname: val_as_str
 
+- :opt_name: block_interactive_match
+  :env_var: MDE_BLOCK_INTERACTIVE_MATCH
+  :default: '@interactive'
+  :procname: val_as_str
+
 - :opt_name: block_name
   :long_name: block-name
   :short_name: b
@@ -92,6 +102,12 @@
   :default: true
   :procname: val_as_bool
 
+# - :opt_name: command_substitution_regexp
+#   :env_var: MDE_COMMAND_SUBSTITUTION_REGEXP
+#   :description: command_substitution_regexp
+#   :default: "(?<expression>\\$\\((?<variable>[A-Z0-9a-z_]+)\\))"
+#   :procname: val_as_str
+
 - :long_name: config
   :description: Read configuration file
   :arg_name: PATH
@@ -136,6 +152,27 @@
   :default: "> "
   :procname: val_as_str
 
+- :opt_name: divider_match
+  :env_var: MDE_DIVIDER_MATCH
+  :description: Pattern for topics/dividers in block selection menu
+  :default: "^(?<indent>[ \t]*):::(?<collapse>[+-~]?)(?<leading>[ \t]*)(?<line>(?<text>.*?)(?<trailing>[ \t]*))?$"
+  :procname: val_as_str
+
+- :opt_name: divider4_center
+  :env_var: MDE_DIVIDER4_CENTER
+  :default: true
+  :procname: val_as_bool
+
+- :opt_name: divider4_collapse
+  :env_var: MDE_DIVIDER_COLLAPSE
+  :default: false
+  :procname: val_as_bool
+
+- :opt_name: divider4_collapsible
+  :env_var: MDE_DIVIDER_COLLAPSIBLE
+  :default: true
+  :procname: val_as_bool
+
 - :opt_name: document_configurations_directory
   :env_var: MDE_DOCUMENT_CONFIGURATIONS_DIRECTORY
   :description: Directory with files
@@ -160,7 +197,18 @@
 - :opt_name: document_load_opts_block_name
   :env_var: MDE_DOCUMENT_LOAD_OPTS_BLOCK_NAME
   :description: Name of Opts block to load with the document
-  :default: "(document_options)"
+  :default: "(document_opts)"
+  :procname: val_as_str
+
+- :opt_name: document_load_vars_block_name
+  :env_var: MDE_DOCUMENT_LOAD_VARS_BLOCK_NAME
+  :description: Name of Vars block to load with the document
+  :default: "(document_vars)"
+  :procname: val_as_str
+
+- :opt_name: document_play_bin
+  :env_var: MDE_DOCUMENT_PLAY_BIN
+  :default: play
   :procname: val_as_str
 
 - :opt_name: document_saved_lines_glob
@@ -402,29 +450,59 @@
   :default: true
   :procname: val_as_bool
 
-- :opt_name: heading2_center
-  :env_var: MDE_HEADING1_CENTER
-  :default: true
+- :opt_name: heading1_collapse
+  :env_var: MDE_HEADING1_COLLAPSE
+  :default: false
   :procname: val_as_bool
 
-- :opt_name: heading3_center
-  :env_var: MDE_HEADING1_CENTER
-  :default: true
+- :opt_name: heading1_collapsible
+  :env_var: MDE_HEADING1_COLLAPSIBLE
+  :default: false
   :procname: val_as_bool
 
 - :opt_name: heading1_match
   :env_var: MDE_HEADING1_MATCH
-  :default: "^#(?<line>(?!#)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+  :default: "^#(?<line>(?!#)(?<collapse>[+-~]?)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :procname: val_as_str
 
+- :opt_name: heading2_center
+  :env_var: MDE_HEADING2_CENTER
+  :default: true
+  :procname: val_as_bool
+
+- :opt_name: heading2_collapse
+  :env_var: MDE_HEADING2_COLLAPSE
+  :default: false
+  :procname: val_as_bool
+
+- :opt_name: heading2_collapsible
+  :env_var: MDE_HEADING2_COLLAPSIBLE
+  :default: true
+  :procname: val_as_bool
+
 - :opt_name: heading2_match
   :env_var: MDE_HEADING2_MATCH
-  :default: "^##(?<line>(?!#)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+  :default: "^##(?<line>(?!#)(?<collapse>[+-~]?)(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :procname: val_as_str
 
+- :opt_name: heading3_center
+  :env_var: MDE_HEADING3_CENTER
+  :default: true
+  :procname: val_as_bool
+
+- :opt_name: heading3_collapse
+  :env_var: MDE_HEADING3_COLLAPSE
+  :default: false
+  :procname: val_as_bool
+
+- :opt_name: heading3_collapsible
+  :env_var: MDE_HEADING3_COLLAPSIBLE
+  :default: true
+  :procname: val_as_bool
+
 - :opt_name: heading3_match
   :env_var: MDE_HEADING3_MATCH
-  :default: "^###(?<line>(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
+  :default: "^###(?<collapse>[+-~]?)(?<line>(?<indent>[ \t]*)(?<text>.*?)(?<trailing>[ \t]*))?$"
   :procname: val_as_str
 
 - :long_name: help
@@ -593,6 +671,13 @@
   :default: ".+\\.md"
   :procname: val_as_str
 
+- :opt_name: menu_active_color_pastel_messages
+  :env_var: MDE_MENU_ACTIVE_COLOR_PASTEL_MESSAGES
+  :description: menu_active_color_pastel_messages
+  :default:
+  - bright_magenta
+  - on_black
+
 - :opt_name: menu_back_at_top
   :env_var: MDE_MENU_BACK_AT_TOP
   :description: Display Back option at top of menu (vs bottom)
@@ -632,6 +717,18 @@
   :default: "%{line}"
   :procname: val_as_str
 
+- :opt_name: menu_collapsible_symbol_collapsed
+  :env_var: MDE_MENU_COLLAPSIBLE_SYMBOL_COLLAPSED
+  :description: menu_collapsible_symbol_collapsed
+  :default: '⬢' # ∆ ⬢ +
+  :procname: val_as_str
+
+- :opt_name: menu_collapsible_symbol_expanded
+  :env_var: MDE_MENU_COLLAPSIBLE_SYMBOL_expandED
+  :description: menu_collapsible_symbol_expanded
+  :default: '⬡' # … ⬡ -
+  :procname: val_as_str
+
 - :opt_name: menu_divider_color
   :env_var: MDE_MENU_DIVIDER_COLOR
   :description: Color of menu divider
@@ -644,12 +741,6 @@
   :default: "-:=   %{line}   =:-"
   :procname: val_as_str
 
-- :opt_name: menu_divider_match
-  :env_var: MDE_MENU_DIVIDER_MATCH
-  :description: Pattern for topics/dividers in block selection menu
-  :default: "^(?<indent>[ \t]*):::(?<line>(?<text>.*?)(?<trailing>[ \t]*))?$"
-  :procname: val_as_str
-
 - :opt_name: menu_divider_symbol
   :env_var: MDE_MENU_DIVIDER_SYMBOL
   :description: Symbol before each divider
@@ -903,7 +994,7 @@
 - :opt_name: menu_table_rows_match
   :env_var: MDE_MENU_TABLE_ROWS_MATCH
   :description: Pattern for table rows
-  :default: '^(?<line>[ \t]*(?<text>\|.*?)(?<trailing>[ \t]*))$'
+  :default: '^(?<line>(?<indent>[ \t]*)(?<text>\|.*?)(?<trailing>[ \t]*))$'
   :procname: val_as_str
 
 - :opt_name: menu_task_color
@@ -1095,6 +1186,16 @@
   :default: false
   :procname: val_as_bool
 
+- :opt_name: play_bin_batch
+  :env_var: MDE_PLAY_BIN_BATCH
+  :default: play
+  :procname: val_as_str
+
+- :opt_name: play_bin_interactive
+  :env_var: MDE_PLAY_BIN_INTERACTIVE
+  :default: play_interactive
+  :procname: val_as_str
+
 - :opt_name: probe
   :long_name: probe
   :env_var: MDE_PROBE
@@ -1469,6 +1570,12 @@
   :description: Color for table border
   :default: fg_bg_rgbh_00_00_df_14_18_1c
 
+- :opt_name: table_center
+  :env_var: MDE_TABLE_CENTER
+  :arg_name: BOOL
+  :default: true
+  :procname: val_as_bool
+
 - :opt_name: table_header_row_color
   :env_var: MDE_TABLE_HEADER_ROW_COLOR
   :description: Color for table header row