markdown_exec 2.7.2 → 2.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf1cce75f6ae919ebb237862e74ade141e6300426e514331b4410cf7cfa0b27e
-  data.tar.gz: 2ea6f8f6fa47f01b324b6663c6c1dcd0f69a0c2a164d7591f5c714d9618b90a4
+  metadata.gz: 5b2dff995a0986c3e248185703f187d49b9cabaabdfae999af261b524ebac1d9
+  data.tar.gz: 4303e59dc01d2c600872b506cb365d1de0452a93bacb13c47358525e80d39ad8
 SHA512:
-  metadata.gz: 87b6c3f35b0fd85b06dc1d94afc6c145fd27989def6972dcaf66e85a8c899e3550376efa9b0e70efe2327e403a46615b6c51a5210653bf5bdd0e1c6946d477f7
-  data.tar.gz: 78fd6cb33feabb7a94c0df274528cf2ffd0d4b60e1bf37328304a125b71edc44c6fd884c003af7088b0953923cee3e3a2b3f39b139b1559bf0b2b4337792ecc9
+  metadata.gz: ab35fe5e0b66c683133f65e9937cdf3336231e3522aed575bedceae8a7044fcf155b11c7e28b324720858dfa53f1443e35b8c5b188796300aa499bb6071930f1
+  data.tar.gz: e8146b88c20bf43c4f43c6d19dd016a249f3227f42450196bf1a40b3356a1f37ae53c645122d25b285ae58c806df3724dd5e32d2e1ac120b45e8f4f86fe7ebbf

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## [2.7.4] - 2025-02-02
+
+### Added
+
+- Option to control initial truncation of table cell text to fit screen width.
+- Truncate text to fit table cell fit to screen width. Click on first row of any table to toggle.
+
+### Changed
+
+- Fix the display of collapsible sections.
+- Fix the display of shell expansion and command substitution output.
+- Hide gem sources in caller.deref.
+
+## [2.7.3] - 2025-01-29
+
+### Added
+
+- Automatic loading of multiple Opts and Vars blocks when opening a document.
+
+### Changed
+
+- Fix text displayed when text is wrapped to the next line.
+- Handle and report failure of single tests.
+
+## [2.7.2] - 2025-01-03
+
+### Added
+
+- Block name comparison in FCB class.
+- Option for automatic shell block per document.
+
+### Changed
+
+- Disable command substitution in comments.
+- Fix the source reported by debug function ww0.
+- Inverse the entire line to highlight the active menu line.
+- Return single file if no globs in load block.
+- Update the calculation and use of IDs for blocks used to retrieve the block selected from the menu.
+
+## [2.7.1] - 2024-12-10
+
+### Changed
+
+- Register console dimensions prior to arguments.
+
 ## [2.7.0] - 2024-12-09
 
 ### Added
@@ -399,7 +444,7 @@ Rename options to match use.
   These blocks can be hidden blocks and required in a script.
 
 - Add a "wrap" fenced code block type to facilitate script generation.
-  See document `examples/wrap.md`.
+  See document `examples/wrapped-blocks.md`.
   These blocks are hidden and can be required by one or more blocks.
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.7.2)
+    markdown_exec (2.7.4)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)

data/Rakefile

@@ -74,14 +74,38 @@ task :clean do
   system 'rm *.gem'
 end
 
+def execute_with_error_handling(iterator)
+  all_error_level = 0
+  all_failed_files = []
+  
+  iterator.each do |item|
+    command = yield(item)
+    next unless command # Skip if command is nil
+    
+    result = system(command)
+    error_level = $?.exitstatus
+
+    if error_level != 0
+      puts "Error: Command '#{command}' failed with exit status #{error_level}."
+      all_error_level = error_level
+      all_failed_files << command
+    end
+  end
+
+  if all_error_level != 0
+    puts "Error: #{all_failed_files.join(', ')} failed."
+    exit all_error_level
+  end
+end
+
 desc 'bats'
 task :bats do
-  FileList['bats/**/*.bats'].each do |file|
-    next if %w[bats/bats.bats bats/fail.bats].include?(file)
+  execute_with_error_handling(FileList['bats/**/*.bats']) do |file|
+    next nil if %w[bats/bats.bats bats/fail.bats].include?(file)
 
     # temporary clear WW to disable debugging
     # WW pollutes output expected by BATS tests
-    system "unset WW; bats #{file}"
+    "unset WW; bats #{file}"
   end
 end
 
@@ -118,14 +142,8 @@ task :minitest do
     './lib/dev/process_template.rb --test'
   ]
 
-  commands.each do |command|
-    result = system("bundle exec ruby #{command}")
-    error_level = $?.exitstatus
-
-    if error_level != 0
-      puts "Error: Command '#{command}' failed with exit status #{error_level}."
-      exit error_level
-    end
+  execute_with_error_handling(commands) do |command|
+    "bundle exec ruby #{command}"
   end
 end
 task mini: %i[minitest]

data/bats/block-type-opts.bats

@@ -0,0 +1,23 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+# Type: Opts
+
+@test 'Opts block - before' {
+  skip 'Fails because command executes after the block is processed'
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-opts.md \
+   'BEFORE Species_menu_note_format: "AFTER %{line}" '
+}
+
+@test 'Opts block - after' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-opts.md \
+   '[decorate-note]' \
+   'AFTER Species_menu_note_format: "AFTER %{line}"'
+}
+
+@test 'Opts block - show that menu has changed' {
+  skip 'Unable to show that menu has changed'
+  spec_mde_args_expect docs/dev/block-type-opts.md '[decorate-note]' \
+   'AFTER Species'
+}

data/bats/block-type-vars.bats

@@ -0,0 +1,26 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+# Type: Vars
+
+# includes output from automatic vars blocks
+@test 'Vars block - auto load' {
+  BATS_OUTPUT_FILTER=A
+  spec_mde_args_expect docs/dev/block-type-vars.md show \
+   'Species = Not specified Genus = Not specified  Species: Not specified VAULT:'
+}
+
+# includes output from assignment and from shell block
+@test 'Vars block - set variable' {
+  BATS_OUTPUT_FILTER=A
+  spec_mde_args_expect docs/dev/block-type-vars.md '[set_vault_1]' show \
+   'Species = Not specified Genus = Not specified VAULT = 1  Species: Not specified VAULT: 1'
+}
+
+# handles invalid YAML in block
+@test 'Vars block - invalid YAML' {
+  BATS_OUTPUT_FILTER=A
+  spec_mde_args_expect docs/dev/block-type-vars.md '[invalid_yaml]' show \
+   'Species = Not specified Genus = Not specified  Species: Not specified VAULT:'
+}

data/bats/block-types.bats

@@ -47,26 +47,6 @@ load 'test_helper'
   run_mde_specs_md_args_expect_xansi '[VARIABLE1]' '(echo-VARIABLE1)' ' VARIABLE1: 1   VARIABLE1: 1'
 }
 
-# Type: Opts
-
-@test 'Opts block - before' {
-  skip 'Fails because command executes after the block is processed'
-  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-opts.md \
-   'BEFORE Species_menu_note_format: "AFTER %{line}" '
-}
-
-@test 'Opts block - after' {
-  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-opts.md \
-   '[decorate-note]' \
-   'AFTER Species_menu_note_format: "AFTER %{line}"'
-}
-
-@test 'Opts block - show that menu has changed' {
-  skip 'Unable to show that menu has changed'
-  spec_mde_args_expect docs/dev/block-type-opts.md '[decorate-note]' \
-   'AFTER Species'
-}
-
 # Type: Port
 
 # includes output from assignment and from shell block
@@ -81,19 +61,3 @@ load 'test_helper'
   spec_mde_args_expect docs/dev/block-type-port.md VAULT-is-export show \
    '   VAULT: This variable has not been set.'
 }
-
-# Type: Vars
-
-# includes output from automatic vars block
-@test 'Vars block - auto load' {
-  BATS_OUTPUT_FILTER=A
-  spec_mde_args_expect docs/dev/block-type-vars.md show \
-   'Species = Not specified  Species: Not specified VAULT:'
-}
-
-# includes output from assignment and from shell block
-@test 'Vars block - set variable' {
-  BATS_OUTPUT_FILTER=A
-  spec_mde_args_expect docs/dev/block-type-vars.md '[set_vault_1]' show \
-   'Species = Not specified VAULT = 1  Species: Not specified VAULT: 1'
-}

data/bats/line-wrapping.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Text and Headings' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/line-wrapping.md \
+   "          DEMO WRAPPING LONG LINES__MDE detects the screen's dimensions:_height (lines) and width (characters)__Normal document text is displayed as_disabled menu lines. The width of these_lines is limited according to the screen's_width.__Test Indented Lines__  Indented with two spaces, this line_  should wrap in an aesthetically pleasing_  way.__    Indented with a tab, this line should_    wrap in an aesthetically pleasing way.__  SPECIES GENUS FAMILY ORDER CLASS PHYLUM_               KINGDOM DOMAIN_species genus family order class phylum_kingdom domain"
+}

data/bats/options-collapse.bats

@@ -4,23 +4,23 @@ load 'test_helper'
 
 @test 'Options - Collapsible - Document options' {
   spec_mde_xansi_oname_doc_blocks_expect docs/dev/options-collapse.md \
-   'H1.1_L1.1_H2.1_H1.2_H2.2_H1.3_H2.3_L2.3_h3.3_L3.3_D4.3_L4.3'
+   'H1.1_L1.1_H2.1_H1.2_H1.3_L1.3_H2.3_L2.3_h3.3_L3.3_D4.3_L4.3'
 }
 
 @test 'Options - Collapsible Heading - Expand' {
   spec_mde_xansi_oname_doc_blocks_expect docs/dev/options-collapse.md \
    H2.1 \
-   'H1.1_L1.1_H2.1_L2.1_h3.1_L3.1_D4.1_L4.1_H1.2_L1.2_H2.2_H1.3_H2.3_L2.3_h3.3_L3.3_D4.3_L4.3'
+   'H1.1_L1.1_H2.1_L2.1_h3.1_L3.1_D4.1_L4.1_H1.2_H1.3_L1.3_H2.3_L2.3_h3.3_L3.3_D4.3_L4.3'
 }
 
 @test 'Options - Collapsible Divider' {
   spec_mde_xansi_oname_doc_blocks_expect docs/dev/options-collapse.md \
    D4.3 \
-   'H1.1_L1.1_H2.1_H1.2_H2.2_H1.3_H2.3_L2.3_h3.3_L3.3_D4.3'
+   'H1.1_L1.1_H2.1_H1.2_H1.3_L1.3_H2.3_L2.3_h3.3_L3.3_D4.3'
 }
 
 @test 'Options - Reveal' {
   spec_mde_xansi_oname_doc_blocks_expect docs/dev/options-collapse.md \
-   H2.2 h3.2 D4.2 \
-   'H1.1_L1.1_H2.1_H1.2_H2.2_L2.2_h3.2_L3.2_D4.2_L4.2_H1.3_L1.3_H2.3_L2.3_h3.3_L3.3_D4.3_L4.3'
+   H1.2 H2.2 h3.2 D4.2 \
+   'H1.1_L1.1_H2.1_H1.2_L1.2_H2.2_L2.2_h3.2_L3.2_D4.2_L4.2_H1.3_L1.3_H2.3_L2.3_h3.3_L3.3_D4.3_L4.3'
 }

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "2.7.2"
+  echo "2.7.4"
 }
 
 _mde() {

data/docs/dev/block-type-opts.md

@@ -6,6 +6,9 @@ menu_note_format: "AFTER %{line}"
 ```opts :(document_opts)
 menu_final_divider:
 menu_for_saved_lines: false
+```
+/ Demonstrate multiple (document_opts) in a single file
+```opts :(document_opts)
 menu_initial_divider:
 menu_note_format: "BEFORE %{line}"
-```
+```

data/docs/dev/block-type-vars.md

@@ -1,6 +1,15 @@
+```vars :(document_vars)
+Species: Not specified
+```
+```vars :(document_vars)
+Genus: Not specified
+```
 ```vars :[set_vault_1]
 VAULT: 1
 ```
+```vars :[invalid_yaml]
+this is not yaml
+```
 ```bash :show
 echo "Species: $Species"
 echo "VAULT: $VAULT"
@@ -8,8 +17,6 @@ echo "VAULT: $VAULT"
 | Variable| Value
 | -| -
 | Species| ${Species}
+| Genus| ${Genus}
 | VAULT| ${VAULT}
-@import bats-document-configuration.md
-```vars :(document_vars)
-Species: Not specified
-```
+@import bats-document-configuration.md

data/docs/dev/line-wrapping.md

@@ -0,0 +1,24 @@
+# Demo wrapping long lines
+
+MDE detects the screen's dimensions: height (lines) and width (characters)
+
+Normal document text is displayed as disabled menu lines. The width of these lines is limited according to the screen's width.
+
+::: Test Indented Lines
+
+  Indented with two spaces, this line should wrap in an aesthetically pleasing way.
+
+	Indented with a tab, this line should wrap in an aesthetically pleasing way.
+
+# species genus family order class phylum kingdom domain
+## species genus family order class phylum kingdom domain
+@import bats-document-configuration.md
+```opts :(document_opts)
+divider4_center: false
+heading1_center: true
+heading2_center: false
+screen_width: 48
+
+menu_note_match: "^(?<indent>[ \t]*)(?<line>(?!/)(?<text>.*?)(?<trailing>[ \t]*))?$"
+
+```

data/docs/dev/options-collapse.md

@@ -33,7 +33,7 @@ divider4_collapse: false
 divider4_collapsible: true
 heading1_center: false
 heading1_collapse: false
-heading1_collapsible: false
+heading1_collapsible: true
 heading2_center: false
 heading2_collapse: true
 heading2_collapsible: true

data/examples/link-blocks-vars.md

@@ -1,59 +1,87 @@
-# Demonstrate link blocks set variables
-@import example-document-opts.md
-```opts :(document_opts)
-execute_in_own_window: false
-menu_with_inherited_lines: true
-output_execution_report: false
-output_execution_summary: false
-pause_after_script_execution: true
+# Demonstrate Setting Variables in the Inherited Lines
+
+```link :select-a-folder +(select-a-folder)
+eval: true
+```
+```bash :(select-a-folder)
+echo "PT=$(osascript -e 'do shell script "echo " & quoted form of POSIX path of (choose folder with prompt "Please select a folder:")' 2>/dev/null)"
 ```
 
-## Demonstrate a link block that sets a variable
-::: Select below to trigger. If it prints "VARIABLE1: 1", the Link block was processed.
+This table displays the value of variables in the context of the current inherited lines. At first, the variable is empty unless it exists in the current shell environment.
 
 | Variable| Value
 | -| -
-| VARIABLE1| ${VARIABLE1}
+| SPECIES| ${SPECIES}
+
+## Current Inherited Lines
+
+```view
+View the current inherited lines.
+```
+
+The inherited lines can also be displayed automatically within the menu by enabling this option:
+
+```opts
+menu_with_inherited_lines: true
+```
+
+## Setting Variables in the Inherited Lines
+
+You can set environment variables in the inherited lines by adding shell expressions. For example, a line such as `SPECIES=Unknown` in the inherited lines defines a variable that can be used in the rest of the executed script.
+
+Below are several ways to add such expressions to the inherited lines:
+
+### Vars Block
+
+This block (YAML) adds a variable and its value to the inherited lines:
+
+```vars
+SPECIES: Tapanuli Orangutan
+```
+
+### Link Block
+
+This block (YAML) also adds a variable and its value to the inherited lines:
 
-The block sets VARIABLE1.
-For each environment variable in `vars`, append an inherited line that assigns the variable the specified value.
     ```link
     vars:
-      VARIABLE1: 1
+      SPECIES: Psychedelic Frogfish
     ```
 
-## Demonstrate a link block that requires a shell block that sets a variable
-This block "[bash_set_to_3]" is required below. It sets the variable "ALPHA".
-    ```bash :[bash_set_to_3]
-    ALPHA=3
-    ```
-::: Select below to trigger. If it prints "ALPHA: 3", the Link block was processed.
-These blocks require the *code* of the named shell block.
-    ```link +[bash_set_to_3]
-    block: "(display_variable_ALPHA)"
-    ```
-    ```link +[bash_set_to_3]
-    next_block: "(display_variable_ALPHA)"
-    ```
+### Link+Bash Blocks
 
-This block "[bash_set_to_4]" is required below. It prints a command that sets the variable "ALPHA".
-    ```bash :[bash_set_to_4]
-    echo "ALPHA=4"
-    ```
-::: Select below to trigger. If it prints "ALPHA: 4", the Link block was processed.
-These blocks require the *output* of the execution of the code in the named shell block.
-    ```link +[bash_set_to_4]
-    eval: true
-    block: "(display_variable_ALPHA)"
+::: Adding Code to the Inherited Lines
+
+This Link block (YAML) appends the Bash code defined in the referenced block to the inherited lines:
+
+    ```link :add-bash-code +[bash_species]
     ```
-    ```link +[bash_set_to_4]
+        ```bash :[bash_species] @disable
+        SPECIES='Ruby Seadragon'
+        ```
+
+If necessary to extract environment variable values displayed in the menu, inherited lines are executed every time the menu displayed. Therefore, do add code that has unwanted side effects when executed multiple times.
+
+::: Adding Evaluated Code Output to the Inherited Lines
+
+This Link block (YAML) appends the output of the Bash code to the inherited lines. The Bash code is executed first to generate the output:
+
+    ```link :add-evaluated-bash-code +[bash_species_code]
     eval: true
-    next_block: "(display_variable_ALPHA)"
     ```
+        ```bash :[bash_species_code] @disable
+        echo "SPECIES='Illacme tobini (Millipede)'"
+        ```
 
 | Variable| Value
 | -| -
-| ALPHA| ${ALPHA}
+| SPECIES| ${SPECIES}
 
-```bash :(display_variable_ALPHA)
-```
+@import example-document-opts.md
+```opts :(document_opts)
+execute_in_own_window: false
+menu_with_inherited_lines: false
+output_execution_report: false
+output_execution_summary: false
+pause_after_script_execution: true
+```

data/lib/collapser.rb

@@ -6,18 +6,20 @@
 require_relative 'constants'
 
 class Collapser
-  attr_accessor :options, :state
+  attr_accessor :compress_ids, :expand_ids, :options
 
   def initialize(
     collapsed_level: nil,
     collapsible_types: COLLAPSIBLE_TYPES,
-    options: {},
-    state: Hash.new(nil)
+    compress_ids:,
+    expand_ids:,
+    options: {}
   )
     @collapsed_level = collapsed_level
     @collapsible_types = collapsible_types.dup
     @options = options.dup
-    @state = state # do not dup
+    @compress_ids = compress_ids # by ref, user action
+    @expand_ids = expand_ids # by ref, user action
   end
 
   def collapse_per_options?(fcb, options: @options)
@@ -27,13 +29,15 @@ class Collapser
     criteria
   end
 
-  def collapse_per_state?(fcb, default: false, state: @state)
-    return false if state.nil?
-
-    criteria = state[fcb.id]
-    return default if criteria.nil?
-
-    !!criteria
+  # collapse per user action
+  def collapse_per_state?(fcb, default: false)
+    if @compress_ids.key?(fcb.id) && !!@compress_ids[fcb.id]
+      true
+    elsif @expand_ids.key?(fcb.id) && !!@expand_ids[fcb.id]
+      false
+    else
+      default
+    end
   end
 
   def collapse_per_token?(fcb)
@@ -52,10 +56,11 @@ class Collapser
   end
 
   def collapse?(fcb, initialize: false)
+    per_options_and_token = (collapse_per_options?(fcb) || collapse_per_token?(fcb)) && !expand_per_token?(fcb)
     if initialize
-      (collapse_per_options?(fcb) || collapse_per_token?(fcb)) && !expand_per_token?(fcb)
+      per_options_and_token
     else
-      collapse_per_state?(fcb, default: false)
+      collapse_per_state?(fcb, default: per_options_and_token)
     end
   end
 
@@ -100,8 +105,13 @@ class Collapser
     else
       fcb.hide = true
     end
-    @state[fcb.id] = fcb.level if fcb.collapse
-
+    if fcb.collapse
+      @compress_ids[fcb.id] = fcb.level
+      @expand_ids.delete(fcb.id)
+    else
+      @compress_ids.delete(fcb.id)
+      @expand_ids[fcb.id] = fcb.level
+    end
     collapsed_level
   end
 
@@ -138,13 +148,15 @@ OPTIONS = {
   heading3_collapse: false,
   heading3_collapsible: true
 }.freeze
-STATE = {}.freeze
 
 class CollapserTest < Minitest::Test
   def setup
-    @collapser = Collapser.new(collapsible_types: COLLAPSIBLE_TYPES.dup,
-                               options: OPTIONS.dup,
-                               state: STATE).dup
+    @collapser = Collapser.new(
+      collapsible_types: COLLAPSIBLE_TYPES.dup,
+      options: OPTIONS.dup,
+      compress_ids: {},
+      expand_ids: {}
+    ).dup
   end
 
   def test_analyze
@@ -312,7 +324,8 @@ class CollapserTest < Minitest::Test
         { name: 'collapsed remains collapsed',
           fcbs: [fc_h1a__collapse_collapsible],
           options: { heading1_collapsible: true },
-          state: { 'h1a' => 1 },
+          compress_ids: { 'h1a' => 1 },
+          expand_ids: {},
           initialize: false,
           expected: [fc_h1a__collapse_collapsible] }
       ]
@@ -324,7 +337,8 @@ class CollapserTest < Minitest::Test
           collapsed_level: test_case[:collapsed_level],
           collapsible_types: test_case[:collapsible_types] || COLLAPSIBLE_TYPES,
           options: (test_case[:options] || OPTIONS).dup,
-          state: (test_case[:state] || STATE).dup
+          compress_ids: test_case[:compress_ids] || {},
+          expand_ids: {}
         )
         analysis = @collapser.analyze(
           test_case[:fcbs],