markdown_exec 2.8.0 → 2.8.2

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.8.0'
+  VERSION = '2.8.2'
 end

data/lib/markdown_exec.rb

@@ -656,32 +656,6 @@ module MarkdownExec
       @options.merge(@options.run_state.to_h)
     end
 
-    def iter_source_blocks(source, &block)
-      case source
-      when 1
-        HashDelegator.new(@options).blocks_from_nested_files.each(&block)
-      when 2
-        blocks_in_file, menu_blocks, mdoc =
-          HashDelegator.new(@options)
-                       .mdoc_menu_and_blocks_from_nested_files(LinkState.new)
-        blocks_in_file.each(&block)
-      when 3
-        blocks_in_file, menu_blocks, mdoc =
-          HashDelegator.new(@options)
-                       .mdoc_menu_and_blocks_from_nested_files(LinkState.new)
-        menu_blocks.each(&block)
-      else
-        @options.iter_blocks_from_nested_files do |btype, fcb|
-          case btype
-          when :blocks
-            yield fcb
-          when :filter
-            %i[blocks]
-          end
-        end
-      end
-    end
-
     ##
     # Returns a lambda expression based on the given procname.
     # @param procname [String] The name of the process to generate a lambda for.
@@ -916,7 +890,7 @@ module MarkdownExec
         # save value to options hash if option is named
         #
         lambda { |value|
-          name = item[:long_name]&.present? ? '--' + item[:long_name].to_s : '-' + item[:short_name].to_s
+          name = item[:long_name]&.present? ? "--#{item[:long_name]}" : "-#{item[:short_name]}"
           options_parsed << item.merge(name: name, value: value)
           (item[:proccode] ? item[:proccode].call(value) : value).tap do |converted|
             options[item[:opt_name]] = converted if item[:opt_name]
@@ -1013,7 +987,16 @@ module MarkdownExec
     # Presents a TTY prompt to select an option or exit, returns selected option or nil
     def select_option_or_exit(prompt_text, strings, opts = {})
       @options.select_option_with_metadata(
-        prompt_text, strings, opts
+        prompt_text,
+        strings,
+        opts,
+        menu_blocks: strings.map do |string|
+          FCB.new(
+            chrome: true,
+            dname: string,
+            id: string
+          )
+        end
       )&.fetch(:selected)
     end
 

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])
@@ -150,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
@@ -230,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
@@ -240,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? &&
@@ -291,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
@@ -334,13 +355,12 @@ module MarkdownExec
       else
         opts[:hide_blocks_by_name] &&
           ((opts[:block_name_hidden_match]&.present? &&
-            block.oname&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
+            block.s2title&.match(Regexp.new(opts[:block_name_hidden_match]))) ||
            (opts[:block_name_include_match]&.present? &&
-            block.oname&.match(Regexp.new(opts[:block_name_include_match]))) ||
+            block.s2title&.match(Regexp.new(opts[:block_name_include_match]))) ||
            (opts[:block_name_wrapper_match]&.present? &&
-            block.oname&.match(Regexp.new(opts[:block_name_wrapper_match])))) &&
-          (block.oname&.present? || block[:label]&.present?)
-
+            block.s2title&.match(Regexp.new(opts[:block_name_wrapper_match])))) &&
+          (block.s2title&.present? || block[:label]&.present?)
       end
     end
 
@@ -415,8 +435,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
 
@@ -463,8 +486,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')
@@ -529,20 +554,23 @@ if $PROGRAM_NAME == __FILE__
       def test_hide_menu_block_on_name
         opts = { hide_blocks_by_name: true,
                  block_name_hidden_match: 'block1' }
-        block = FCB.new(oname: '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
       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)
@@ -585,8 +613,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

@@ -54,6 +54,7 @@
 
 - :opt_name: block_name_match
   :env_var: MDE_BLOCK_NAME_MATCH
+  :description: Pattern for the block name in the line defining the block
   :default: ":(?<title>\\S+)( |$)"
   :procname: val_as_str
 

data/lib/menu.yml

@@ -44,6 +44,7 @@
   :procname: val_as_str
 - :opt_name: block_name_match
   :env_var: MDE_BLOCK_NAME_MATCH
+  :description: Pattern for the block name in the line defining the block
   :default: ":(?<title>\\S+)( |$)"
   :procname: val_as_str
 - :opt_name: block_name_nick_match

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.2
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -107,7 +107,13 @@ files:
 - assets/select_a_block.png
 - assets/select_a_file.png
 - bats/bats.bats
+- bats/block-hide.bats
 - bats/block-type-opts.bats
+- bats/block-type-ux-auto.bats
+- bats/block-type-ux-exec.bats
+- bats/block-type-ux-require.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
@@ -136,9 +142,15 @@ files:
 - bin/tab_completion.sh
 - bin/tab_completion.sh.erb
 - docs/dev/bats-document-configuration.md
+- docs/dev/block-hide.md
 - 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-require.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