markdown_exec 2.7.5 → 2.8.1

data/lib/mdoc.rb

@@ -85,14 +85,17 @@ module MarkdownExec
 
       dependencies = collect_dependencies(nickname)
       # !!t dependencies.count
-      all_dependency_names = collect_unique_names(dependencies).push(nickname).uniq
+      all_dependency_names =
+        collect_unique_names(dependencies).push(nickname).uniq
       # !!t all_dependency_names.count
 
       # select blocks in order of appearance in source documents
       #
       blocks = @table.select do |fcb|
         # 2024-08-04 match nickname
-        all_dependency_names.include?(fcb.pub_name) || all_dependency_names.include?(fcb.nickname) || all_dependency_names.include?(fcb.oname)
+        all_dependency_names.include?(fcb.pub_name) ||
+          all_dependency_names.include?(fcb.nickname) ||
+          all_dependency_names.include?(fcb.oname)
       end
       # !!t blocks.count
 
@@ -102,7 +105,10 @@ module MarkdownExec
       blocks = blocks.map do |fcb|
         # 2024-08-04 match oname for long block names
         # 2024-08-04 match nickname
-        unmet_dependencies.delete(fcb.pub_name) || unmet_dependencies.delete(fcb.nickname) || unmet_dependencies.delete(fcb.oname) # may not exist if block name is duplicated
+        # may not exist if block name is duplicated
+        unmet_dependencies.delete(fcb.pub_name) ||
+          unmet_dependencies.delete(fcb.nickname) ||
+          unmet_dependencies.delete(fcb.oname)
         if (call = fcb.call)
           fcb1 = get_block_by_anyname("[#{call.match(/^%\((\S+) |\)/)[1]}]")
           fcb1.cann = call
@@ -124,8 +130,10 @@ 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(anyname:, block_source:, label_body: true, label_format_above: nil,
-                                          label_format_below: nil)
+    def collect_recursively_required_code(
+      anyname:, block_source:,
+      label_body: true, label_format_above: nil, label_format_below: nil
+    )
       block_search = collect_block_dependencies(anyname: anyname)
       if block_search[:blocks]
         blocks = collect_wrapped_blocks(block_search[:blocks])
@@ -142,6 +150,7 @@ module MarkdownExec
                 fcb.body # entire body is returned to requesing block
               elsif [BlockType::LINK,
                      BlockType::LOAD,
+                     BlockType::UX,
                      BlockType::VARS].include? fcb.type
                 nil
               elsif fcb[:chrome] # for Link blocks like History
@@ -149,8 +158,10 @@ module MarkdownExec
               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)
+                generate_label_body_code(
+                  fcb, block_source,
+                  label_format_above, label_format_below
+                )
               else # raw body
                 fcb.body
               end
@@ -229,9 +240,14 @@ module MarkdownExec
         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
+        next unless fcb.collapsible
+
+        fcb.s1decorated = fcb.s1decorated + ' ' +
+                          (if fcb.collapse
+                             opts[:menu_collapsible_symbol_collapsed]
+                           else
+                             opts[:menu_collapsible_symbol_expanded]
+                           end)
       end
       opts[:compressed_ids] = collapser.compress_ids
       opts[:expanded_ids] = collapser.expand_ids
@@ -239,7 +255,9 @@ module MarkdownExec
       # remove
       # . empty chrome between code; edges are same as blanks
       #
-      select_elements_with_neighbor_conditions(selrows) do |prev_element, current, next_element|
+      select_elements_with_neighbor_conditions(selrows) do |prev_element,
+                                                            current,
+                                                            next_element|
         !(current[:chrome] && !current.oname.present?) ||
           !(!prev_element.nil? &&
             prev_element.shell.present? &&
@@ -290,13 +308,17 @@ module MarkdownExec
 
       label_above = if label_format_above.present?
                       format(label_format_above,
-                             block_source.merge({ block_name: block_name_for_bash_comment }))
+                             block_source.merge(
+                               { block_name: block_name_for_bash_comment }
+                             ))
                     else
                       nil
                     end
       label_below = if label_format_below.present?
                       format(label_format_below,
-                             block_source.merge({ block_name: block_name_for_bash_comment }))
+                             block_source.merge(
+                               { block_name: block_name_for_bash_comment }
+                             ))
                     else
                       nil
                     end
@@ -414,8 +436,11 @@ module MarkdownExec
       memo
     end
 
-    def select_elements_with_neighbor_conditions(array,
-                                                 last_selected_placeholder = nil, next_selected_placeholder = nil)
+    def select_elements_with_neighbor_conditions(
+      array,
+      last_selected_placeholder = nil,
+      next_selected_placeholder = nil
+    )
       selected_elements = []
       last_selected = last_selected_placeholder
 
@@ -462,8 +487,10 @@ if $PROGRAM_NAME == __FILE__
       end if false
 
       def test_collect_dependencies_with_valid_source
-        @mdoc.stubs(:get_block_by_anyname).with('source1').returns(OpenStruct.new(reqs: ['source2']))
-        @mdoc.stubs(:get_block_by_anyname).with('source2').returns(OpenStruct.new(reqs: []))
+        @mdoc.stubs(:get_block_by_anyname)
+             .with('source1').returns(OpenStruct.new(reqs: ['source2']))
+        @mdoc.stubs(:get_block_by_anyname)
+             .with('source2').returns(OpenStruct.new(reqs: []))
 
         expected = { 'source1' => ['source2'], 'source2' => [] }
         assert_equal expected, @mdoc.collect_dependencies('source1')
@@ -534,14 +561,17 @@ if $PROGRAM_NAME == __FILE__
       end
 
       def test_fcbs_per_options
-        opts = { hide_blocks_by_name: true, block_name_hidden_match: 'block1' }
+        opts = { hide_blocks_by_name: true,
+                 block_name_hidden_match: 'block1' }
         result = @doc.fcbs_per_options(opts)
         assert_equal [@table[1], @table[2]], result
       end if false ### broken test
 
       def test_recursively_required
         result = @doc.recursively_required_hash('block3')
-        assert_equal ({ 'block3' => ['block1'], 'block1' => ['block2'], 'block2' => nil }),
+        assert_equal ({ 'block3' => ['block1'],
+                        'block1' => ['block2'],
+                        'block2' => nil }),
                      result
 
         result_no_reqs = @doc.recursively_required_hash(nil)
@@ -584,8 +614,9 @@ if $PROGRAM_NAME == __FILE__
         # Test case 3: blocks with missing wraps
         assert_equal(
           %w[block4],
-          @mdoc.collect_wrapped_blocks([OpenStruct.new(oname: 'block4',
-                                                       wraps: ['wrap4'])]).map(&:oname)
+          @mdoc.collect_wrapped_blocks(
+            [OpenStruct.new(oname: 'block4', wraps: ['wrap4'])]
+          ).map(&:oname)
         )
       end
     end

data/lib/menu.src.yml

@@ -206,6 +206,12 @@
   :default: "(document_shell)"
   :procname: val_as_str
 
+- :opt_name: document_load_ux_block_name
+  :env_var: MDE_DOCUMENT_LOAD_UX_BLOCK_NAME
+  :description: Name of UX block to load with the document
+  :default: "\\[.*document_ux.*\\]"
+  :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
@@ -1026,6 +1032,18 @@
   :default: ">"
   :procname: val_as_str
 
+- :opt_name: menu_ux_color
+  :env_var: MDE_MENU_UX_COLOR
+  :description: Color of menu ux
+  :default: fg_rgbh_df_c0_df
+  :procname: val_as_str
+
+- :opt_name: menu_ux_row_format
+  :env_var: MDE_MENU_UX_ROW_FORMAT
+  :description: Format for UX row
+  :default: '%{name}=${%{name}}'
+  :procname: val_as_str
+
 - :opt_name: menu_vars_color
   :env_var: MDE_MENU_VARS_COLOR
   :description: Color of menu vars
@@ -1315,6 +1333,12 @@
   :description: Prompt to select a saved file
   :procname: val_as_str
 
+- :opt_name: prompt_ux_enter_a_value
+  :env_var: MDE_PROMPT_UX_ENTER_A_VALUE
+  :description: Prompt to enter a value for UX blocks
+  :default: "\nEnter a value:"
+  :procname: val_as_str
+
 - :opt_name: prompt_show_expr_format
   :env_var: MDE_PROMPT_SHOW_EXPR_FORMAT
   :description: prompt_show_expr_format
@@ -1630,6 +1654,12 @@
   :default: false
   :procname: val_as_bool
 
+- :opt_name: ux_auto_load_force_default
+  :env_var: MDE_UX_AUTO_LOAD_FORCE_DEFAULT
+  :arg_name: BOOL
+  :default: true
+  :procname: val_as_bool
+
 - :opt_name: variable_expression_regexp
   :env_var: MDE_VARIABLE_EXPRESSION_REGEXP
   :description: variable_expression_regexp

data/lib/menu.yml

@@ -171,6 +171,11 @@
   :description: Name of shell block to load with the document
   :default: "(document_shell)"
   :procname: val_as_str
+- :opt_name: document_load_ux_block_name
+  :env_var: MDE_DOCUMENT_LOAD_UX_BLOCK_NAME
+  :description: Name of UX block to load with the document
+  :default: "\\[.*document_ux.*\\]"
+  :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
@@ -864,6 +869,16 @@
   :description: Symbol before each task
   :default: ">"
   :procname: val_as_str
+- :opt_name: menu_ux_color
+  :env_var: MDE_MENU_UX_COLOR
+  :description: Color of menu ux
+  :default: fg_rgbh_df_c0_df
+  :procname: val_as_str
+- :opt_name: menu_ux_row_format
+  :env_var: MDE_MENU_UX_ROW_FORMAT
+  :description: Format for UX row
+  :default: "%{name}=${%{name}}"
+  :procname: val_as_str
 - :opt_name: menu_vars_color
   :env_var: MDE_MENU_VARS_COLOR
   :description: Color of menu vars
@@ -1123,6 +1138,13 @@
     Choose a file:
   :description: Prompt to select a saved file
   :procname: val_as_str
+- :opt_name: prompt_ux_enter_a_value
+  :env_var: MDE_PROMPT_UX_ENTER_A_VALUE
+  :description: Prompt to enter a value for UX blocks
+  :default: |2-
+
+    Enter a value:
+  :procname: val_as_str
 - :opt_name: prompt_show_expr_format
   :env_var: MDE_PROMPT_SHOW_EXPR_FORMAT
   :description: prompt_show_expr_format
@@ -1391,6 +1413,11 @@
   :arg_name: BOOL
   :default: false
   :procname: val_as_bool
+- :opt_name: ux_auto_load_force_default
+  :env_var: MDE_UX_AUTO_LOAD_FORCE_DEFAULT
+  :arg_name: BOOL
+  :default: true
+  :procname: val_as_bool
 - :opt_name: variable_expression_regexp
   :env_var: MDE_VARIABLE_EXPRESSION_REGEXP
   :description: variable_expression_regexp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.7.5
+  version: 2.8.1
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -108,6 +108,10 @@ files:
 - assets/select_a_file.png
 - bats/bats.bats
 - bats/block-type-opts.bats
+- bats/block-type-ux-auto.bats
+- bats/block-type-ux-exec.bats
+- bats/block-type-ux-row-format.bats
+- bats/block-type-ux-transform.bats
 - bats/block-type-vars.bats
 - bats/block-types.bats
 - bats/border.bats
@@ -124,6 +128,7 @@ files:
 - bats/options.bats
 - bats/plain.bats
 - bats/publish.bats
+- bats/table-column-truncate.bats
 - bats/table.bats
 - bats/test_helper.bash
 - bats/variable-expansion.bats
@@ -138,6 +143,10 @@ files:
 - docs/dev/block-type-bash.md
 - docs/dev/block-type-opts.md
 - docs/dev/block-type-port.md
+- docs/dev/block-type-ux-auto.md
+- docs/dev/block-type-ux-exec.md
+- docs/dev/block-type-ux-row-format.md
+- docs/dev/block-type-ux-transform.md
 - docs/dev/block-type-vars.md
 - docs/dev/border.md
 - docs/dev/command-substitution.md
@@ -159,6 +168,7 @@ files:
 - docs/dev/screen-width.md
 - docs/dev/specs-import.md
 - docs/dev/specs.md
+- docs/dev/table-column-truncate.md
 - docs/dev/table-indent.md
 - docs/dev/table-invalid.md
 - docs/dev/text-decoration.md