markdown_exec 2.6.0 → 2.7.0

data/examples/linked3.md

@@ -5,8 +5,9 @@
 
 ::: This Bash block displays the value of variables "PAGE3_VAR_VIA_INHERIT" and "page3_var_via_environment"
 
-```bash :show_vars
-source bin/colorize_env_vars.sh
-colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
-colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
-```
+| Variable| Value
+| -| -
+| PAGE2_VAR_VIA_INHERIT| ${PAGE2_VAR_VIA_INHERIT}
+| page2_var_via_environment| ${page2_var_via_environment}
+| PAGE3_VAR_VIA_INHERIT| ${PAGE3_VAR_VIA_INHERIT}
+| page3_var_via_environment| ${page3_var_via_environment}

data/examples/linked_show.md

@@ -1,7 +1,8 @@
 # Demo document linking
 
 ::: Display variables set in the calling document
-```bash :show_vars
-source bin/colorize_env_vars.sh
-colorize_env_vars 'from linked.md load1.sh' var1 var2
-```
+
+| Variable| Value
+| -| -
+| var1| ${var1}
+| var2| ${var2}

data/examples/nickname.md

@@ -1,5 +1,6 @@
 # Demo block nicknames
 
+@import example-document-opts.md
 ```opts :(document_opts)
 pause_after_script_execution: true
 ```

data/examples/opts-blocks-require.md

@@ -1,4 +1,5 @@
 # Demonstrate requiring blocks
+@import example-document-opts.md
 ```opts :(document_opts) +(custom) +[custom]
 menu_divider_color: red     # color to indicate failure
 ```

data/examples/opts-blocks.md

@@ -19,6 +19,7 @@ menu_note_match: "^\\+ +(?<line>.+?) *$"
 menu_task_color: fg_rgb_127_127_255
 ```
 
+@import example-document-opts.md
 ```opts :(document_opts)
 menu_divider_color: green
 menu_link_color: fg_rgbh_88_cc_66

data/examples/opts_output_execution.md

@@ -1,6 +1,7 @@
 # Demo options: output_execution_report, output_execution_summary
 
 ::: Options are initially True
+@import example-document-opts.md
 ```opts :(document_opts) +[document_options]
 output_execution_report: true
 output_execution_summary: true

data/examples/pass-through-arguments.md

@@ -1,3 +1,4 @@
+@import example-document-opts.md
 ```opts :(document_opts)
 execute_in_own_window: false
 pause_after_script_execution: true

data/examples/pause-after-execution.md

@@ -1,5 +1,6 @@
 # Demonstrate pause for user approval before returning to the menu
 Controlled by option `pause_after_script_execution`.
+@import example-document-opts.md
 ```opts :(document_opts)
 pause_after_script_execution: true
 ```

data/examples/port-blocks.md

@@ -1,13 +1,5 @@
 # Demo variable porting
 
-```opts :(document_opts)
-dump_inherited_lines: true
-execute_in_own_window: false
-output_execution_report: false
-output_execution_summary: false
-pause_after_script_execution: true
-```
-
 ::: Set the VAULT value in memory.
 ::: Call this block prior to `show` to demonstrate in-memory value being written to script.
 
@@ -27,6 +19,18 @@ VAULT2
 
 ```bash :show +[vault]
 : ${VAULT:=This variable has not been set.}
-source bin/colorize_env_vars.sh
-colorize_env_vars '' VAULT
 ```
+
+| Variable| Value
+| -| -
+| VAULT| ${VAULT}
+| VAULT2| ${VAULT2}
+
+@import example-document-opts.md
+```opts :(document_opts)
+dump_inherited_lines: true
+execute_in_own_window: false
+output_execution_report: false
+output_execution_summary: false
+pause_after_script_execution: true
+```

data/examples/save.md

@@ -1,4 +1,5 @@
 # Demonstrate custom file names
+@import example-document-opts.md
 ```opts :(document_opts) +[custom]
 pause_after_script_execution: true  # for interactive demos
 save_executed_script:         true  # demonstrate saved scripts

data/examples/text-markup.md

@@ -47,6 +47,7 @@ line_decor_post  |  Line-oriented text decoration (Post)
 line_decor_pre   |  Line-oriented text decoration (Pre)
 menu_note_match  |  Pattern for notes in block selection menu
 
+@import example-document-opts.md
 ```opts :(document_opts)
 line_decor_post:
   - :color_method: blue
@@ -55,4 +56,4 @@ line_decor_post:
     :pattern: '!([^!]{0,64})!green!'
   - :color_method: red
     :pattern: '!([^!]{0,64})!red!'
-```
+```

data/examples/variable-expansion-save-block.md

@@ -0,0 +1,48 @@
+```vars :sample-configuration
+NAME: name01
+```
+	- NAME: ${NAME}
+
+```link :enter-variable-value +(enter-variable-value)
+exec: true
+```
+```bash :(enter-variable-value)
+echo >&2 "NAME [$NAME]?: "
+read -r response
+echo "NAME=$(printf "%q" "${response:-$NAME}")"
+```
+
+```history :list_ec2_instance_configuration_files
+directory: test
+filename_pattern: '^(?<name>.*)$'
+glob: '*.sh'
+view: '%{name}'
+```
+
+```load :load_configuration_document_from_directory
+directory: test
+glob: '*.sh'
+```
+
+```save :save_stack_file_names
+directory: test
+glob: "${NAME}.sh"
+```
+
+```bash :loggable-action
+echo `date -u`
+```
+```opts :(document_opts)
+save_executed_script: true
+save_execution_output: true
+
+# Add "NAME" named group to default shell expansion.
+# Include a wildcard as default to allow for matching when undefined.
+saved_asset_format: "%{prefix}%{join}${NAME:-*}%{join}%{time}%{join}%{filename}%{join}%{mark}%{join}%{blockname}%{join}%{exts}"
+
+# Add "name" capture group to default expression
+saved_asset_match: "^(?<prefix>.+)(?<join>_)(?<name>.*)\\g'join'(?<time>[0-9\\-]+)\\g'join'(?<filename>.+)\\g'join'(?<mark>~)\\g'join'(?<blockname>.+)\\g'join'(?<exts>\\..+)$"
+
+# Add "name" capture group to default format
+saved_history_format:         "%{name}  %{time}  %{blockname}  %{exts}"
+```

data/examples/variable-expansion.md

@@ -59,8 +59,9 @@ directory: tmp
 glob: ${ALPHA}.sh
 ```
 ```view
+View
 ```
-```edit
+```edit :edit
 ```
 ```save
 directory: tmp
@@ -68,6 +69,7 @@ glob: ${ALPHA}.sh
 ```
 
 / import bats-document-configuration.md
+@import example-document-opts.md
 ```opts :(document_opts)
 divider4_center: false
 

data/examples/vars-blocks.md

@@ -1,38 +1,28 @@
+@import example-document-opts.md
 ```opts :(document_opts)
 execute_in_own_window: false
 output_execution_report: false
 output_execution_summary: false
 pause_after_script_execution: true
 ```
-The hidden block "(defaults)" sets the environment variable VAULT to "default" if it is unset.
-```bash :(defaults)
-: ${VAULT:=default}
-```
-
-::: Select below to trigger. If it prints "VAULT: default", the shell block was processed.
-The named block prints the environment variable VAULT. It requires hidden block "(defaults)" before printing.
-    ```bash :show_vars +(defaults)
-    source bin/colorize_env_vars.sh
-    colorize_env_vars '' VAULT
-    ```
+/The hidden block "(defaults)" sets the environment variable VAULT to "default" if it is unset.
+/```bash :(defaults)
+/: ${VAULT:=default}
+/```
+| Variable| Value
+| -| -
+| VAULT| ${VAULT}
 
+::: Select below to trigger.
 The block sets the environment variable VAULT to "11".
-When clicked, it adds the variable to the inherited code. It does not output.
+When clicked, it adds the variable to the inherited code.
     ```vars :[set_vault_11]
     VAULT: 11
     ```
 
-# DOES NOT WORK 2024-07-20
-## This does not evaluate the shell block.
-::: Select below to trigger. If it prints "VAULT: 22", the shell block was processed.
-The block sets the environment variable VAULT to "22". It requires block "show_vars". Notice block "show_vars" is called after the variable is set.
-    ```vars :[set_with_show] +show_vars
+::: Select below to trigger.
+The block sets the environment variable VAULT to "22".
+When clicked, it adds the variable to the inherited code.
+    ```vars :[set_with_show]
     VAULT: 22
     ```
-
-## This outputs the value before the variable is set.
-The named block prints the environment variable VAULT. It requires block "set".
-    ```bash :show_with_set +[set_vault_11]
-    source bin/colorize_env_vars.sh
-    colorize_env_vars '' VAULT
-    ```

data/examples/wrap.md

@@ -100,6 +100,7 @@ shell_code_label_format_above: "#  -^-"
 shell_code_label_format_below: "#  -v-  +%{block_name}  -o-  %{document_filename}  -o-  %{time_now_date}  -v-"
 ```
 
+@import example-document-opts.md
 ```opts :(document_opts)
 execute_in_own_window: false
 output_execution_report: false
@@ -108,4 +109,4 @@ pause_after_script_execution: true
 line_decor_pre:
   - :color_method: :underline_italic
     :pattern: '"([^"]{0,64})"'
-```
+```

data/lib/collapser.rb

@@ -1,3 +1,8 @@
+#!/usr/bin/env bundle exec ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+# v2024-12-02
 require_relative 'constants'
 
 class Collapser
@@ -12,11 +17,11 @@ class Collapser
     @collapsed_level = collapsed_level
     @collapsible_types = collapsible_types.dup
     @options = options.dup
-    @state = state.dup # do not dup
+    @state = state # do not dup
   end
 
   def collapse_per_options?(fcb, options: @options)
-    criteria = options["#{fcb.type}#{fcb.level}_collapse".to_sym]
+    criteria = options[:"#{fcb.type}#{fcb.level}_collapse"]
     return false if criteria.nil?
 
     criteria
@@ -36,7 +41,7 @@ class Collapser
   end
 
   def collapsible_per_options?(fcb, options: @options)
-    criteria = options["#{fcb.type}#{fcb.level}_collapsible".to_sym]
+    criteria = options[:"#{fcb.type}#{fcb.level}_collapsible"]
     return false if criteria.nil?
 
     criteria
@@ -83,19 +88,17 @@ class Collapser
       collapsed_level = fcb.level if fcb.collapse
       fcb.hide = true # block is at a deeper level thus hidden
 
-    else
+    elsif fcb.collapsible
       # Currently expanded; evaluate for the current block
-      if fcb.collapsible
-        fcb.collapse = collapse?(fcb, initialize: initialize)
-        collapsed_level = fcb.collapse ? fcb.level : nil
-        fcb.hide = false
-      elsif collapsible_per_type?(fcb)
-        fcb.collapsible = false
-        fcb.collapse = false
-        fcb.hide = false
-      else
-        fcb.hide = true
-      end
+      fcb.collapse = collapse?(fcb, initialize: initialize)
+      collapsed_level = fcb.collapse ? fcb.level : nil
+      fcb.hide = false
+    elsif collapsible_per_type?(fcb)
+      fcb.collapsible = false
+      fcb.collapse = false
+      fcb.hide = false
+    else
+      fcb.hide = true
     end
     @state[fcb.id] = fcb.level if fcb.collapse
 
@@ -147,7 +150,7 @@ class CollapserTest < Minitest::Test
   def test_analyze
     # Define test scenarios as arrays of FCB objects and expected filtered results
 
-    # :id, :type, :level, :token
+    # :id, :type, :level, :token (in order for FCB.new)
     ff_h1a = ['h1a', 'heading', 1, '']
     ff_h1b = ['h1b', 'heading', 1, '']
     ff_h2a = ['h2a', 'heading', 2, '']
@@ -159,8 +162,10 @@ class CollapserTest < Minitest::Test
     ff_h1a_collapse = ['h1a', 'heading', 1, COLLAPSIBLE_TOKEN_COLLAPSE]
     ff_h1a_expand = ['h1a', 'heading', 1, COLLAPSIBLE_TOKEN_EXPAND]
     ff_h1b_expand = ['h1b', 'heading', 1, COLLAPSIBLE_TOKEN_EXPAND]
+    ff_h2a_collapse = ['h2a', 'heading', 2, COLLAPSIBLE_TOKEN_COLLAPSE]
+    ff_h2b_collapse = ['h2b', 'heading', 2, COLLAPSIBLE_TOKEN_COLLAPSE]
 
-    # :collapse, :collapsible, :hide
+    # :collapse, :collapsible, :hide (in order for FCB.new)
     cc_init = [false, false, false]
     cc_collapse = [true, false, false]
     cc_collapse_collapsible = [true, true, false]
@@ -169,52 +174,81 @@ class CollapserTest < Minitest::Test
     cc_hide = [false, false, true]
     cc_undefined_hide = [nil, nil, false]
 
+    fc_h1a__collapse = FCB.new(*ff_h1a, *cc_collapse)
+    fc_h1a__collapse_collapsible = FCB.new(*ff_h1a, *cc_collapse_collapsible)
+    fc_h1a__collapsed_init = FCB.new(*ff_h1a_collapse, *cc_init)
+    fc_h1a__collapsible = FCB.new(*ff_h1a, *cc_collapsible)
+    fc_h1a__collapsible_hide = FCB.new(*ff_h1a, *cc_collapsible_hide)
+    fc_h1a__expanded_init = FCB.new(*ff_h1a_expand, *cc_init)
     fc_h1a__init = FCB.new(*ff_h1a, *cc_init)
-    fc_h1b__init = FCB.new(*ff_h1b, *cc_init)
-    fc_h2a__init = FCB.new(*ff_h2a, *cc_init)
-    fc_h2b__init = FCB.new(*ff_h2b, *cc_init)
-    fc_t1__init = FCB.new(*ff_t1, *cc_init)
-    fc_t2__init = FCB.new(*ff_t2, *cc_init)
-    fc_t3__init = FCB.new(*ff_t3, *cc_init)
-    fc_t4__init = FCB.new(*ff_t4, *cc_init)
 
-    fc_h1a__collapse = FCB.new(*ff_h1a, *cc_collapse)
+    fc_h1b__init = FCB.new(*ff_h1b, *cc_init)
 
-    fc_h1a__collapse_collapsible = FCB.new(*ff_h1a, *cc_collapse_collapsible)
+    fc_h2a__collapse = FCB.new(*ff_h2a, *cc_collapse)
     fc_h2a__collapse_collapsible = FCB.new(*ff_h2a, *cc_collapse_collapsible)
-
-    fc_h1a__collapsible = FCB.new(*ff_h1a, *cc_collapsible)
+    fc_h2a__collapsed_collapsible = FCB.new(*ff_h2a_collapse, *cc_collapsible)
     fc_h2a__collapsible = FCB.new(*ff_h2a, *cc_collapsible)
+    fc_h2a__hide = FCB.new(*ff_h2a, *cc_hide)
+    fc_h2a__init = FCB.new(*ff_h2a, *cc_init)
 
-    fc_h1a__collapsible_hide = FCB.new(*ff_h1a, *cc_collapsible_hide)
+    fc_h2b__init = FCB.new(*ff_h2b, *cc_init)
 
     fc_t1__hide = FCB.new(*ff_t1, *cc_hide)
+    fc_t1__init = FCB.new(*ff_t1, *cc_init)
     fc_t2__hide = FCB.new(*ff_t2, *cc_hide)
-    fc_h2a__hide = FCB.new(*ff_h2a, *cc_hide)
+    fc_t2__init = FCB.new(*ff_t2, *cc_init)
+    fc_t3__init = FCB.new(*ff_t3, *cc_init)
+    fc_t4__hide = FCB.new(*ff_t4, *cc_hide)
+    fc_t4__init = FCB.new(*ff_t4, *cc_init)
 
     analyze_cases = {
       with_token: [
         { name: 'collapse',
-          fcbs: [FCB.new(*ff_h1a_collapse, *cc_init)],
+          fcbs: [fc_h1a__collapsed_init],
           expected: [FCB.new(*ff_h1a_collapse, *cc_collapse)] },
         { name: 'expand',
-          fcbs: [FCB.new(*ff_h1a_expand, *cc_init)],
-          expected: [FCB.new(*ff_h1a_expand, *cc_init)] },
+          fcbs: [fc_h1a__expanded_init],
+          expected: [fc_h1a__expanded_init] },
         { name: 'collapse, against options',
-          fcbs: [FCB.new(*ff_h1a_collapse, *cc_init)],
+          fcbs: [fc_h1a__collapsed_init],
           options: { heading1_collapse: false },
           expected: [FCB.new(*ff_h1a_collapse, *cc_collapse)] },
         { name: 'expand, against options',
-          fcbs: [FCB.new(*ff_h1a_expand, *cc_init)],
+          fcbs: [fc_h1a__expanded_init],
           options: { heading1_collapse: true },
-          expected: [FCB.new(*ff_h1a_expand, *cc_init)] },
+          expected: [fc_h1a__expanded_init] }
       ],
 
       with_no_state: [
-        { name: ' ',
-          fcbs: [FCB.new(*ff_h1a_expand, *cc_init), fc_t1__init, fc_h2a__init, fc_t2__init, FCB.new(*ff_h1b_expand, *cc_init), fc_t3__init, fc_h2b__init, fc_t4__init],
+        { name: 'heading2_collapse',
+          fcbs: [
+            fc_h1a__init,
+            fc_h2a__init,
+            fc_h1b__init,
+            fc_h2b__init
+          ],
+          options: { heading2_collapse: true },
+          expected: [
+            fc_h1a__init,
+            fc_h2a__collapse, # s/b fc_h2a__collapse_collapsible, ok for test
+            fc_h1b__init,
+            fc_h2b__init # s/b fc_h2b__collapse_collapsible, ok for test
+          ] },
+
+        { name: 'hide subsections',
+          fcbs: [
+            fc_h1a__init, fc_t1__init,
+            fc_h2a__init, fc_t2__init,
+            fc_h1b__init, fc_t3__init,
+            fc_h2b__init, fc_t4__init
+          ],
           options: { heading2_collapse: true },
-          expected: [FCB.new(*ff_h1a_expand, *cc_init), fc_t1__init, FCB.new(*ff_h2a, *cc_collapse), FCB.new(*ff_h1b_expand, *cc_init), fc_t3__init, FCB.new(*ff_h2b, *cc_collapse)] },
+          expected: [
+            fc_h1a__init, fc_t1__init,
+            fc_h2a__collapse, fc_t2__hide,
+            fc_h1b__init, fc_t3__init,
+            fc_h2b__init, fc_t4__hide
+          ] },
 
         { name: 'not collapsible',
           fcbs: [fc_h1a__init],
@@ -263,7 +297,7 @@ class CollapserTest < Minitest::Test
                      heading2_collapsible: true },
           expected: [fc_h1a__init,
                      fc_h2a__collapse_collapsible,
-                     fc_t1__hide] },
+                     fc_t1__hide] }
       ],
 
       with_empty_state: [
@@ -271,25 +305,27 @@ class CollapserTest < Minitest::Test
           fcbs: [fc_h1a__init],
           options: { heading1_collapsible: true },
           initialize: false,
-          expected: [fc_h1a__collapsible] },
+          expected: [fc_h1a__collapsible] }
       ],
 
       with_collapsed_state: [
         { name: 'collapsed remains collapsed',
           fcbs: [fc_h1a__collapse_collapsible],
           options: { heading1_collapsible: true },
-          state: { "h1a" => 1 },
+          state: { 'h1a' => 1 },
           initialize: false,
-          expected: [fc_h1a__collapse_collapsible] },
+          expected: [fc_h1a__collapse_collapsible] }
       ]
     }
 
     analyze_cases.each do |name, test_cases|
       test_cases.each_with_index do |test_case, index|
-        @collapser = Collapser.new(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)
+        @collapser = Collapser.new(
+          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
+        )
         analysis = @collapser.analyze(
           test_case[:fcbs],
           initialize: test_case[:initialize].nil? ? true : test_case[:initialize]

data/lib/evaluate_shell_expressions.rb

@@ -6,9 +6,10 @@
 require 'open3'
 
 def evaluate_shell_expressions(initial_code, expressions, shell: '/bin/bash',
-                               key_format: "%%<%s>")
+                               key_format: "%%<%s>",
+                               initial_code_required: false)
   # !!p initial_code expressions key_format shell
-  return if initial_code.nil? || initial_code.empty? ||
+  return if (initial_code_required && (initial_code.nil? || initial_code.empty?)) ||
             expressions.nil? || expressions.empty? ||
             key_format.nil? || key_format.empty?
 

data/lib/fcb.rb

@@ -157,13 +157,19 @@ module MarkdownExec
       ### update name, nickname, title, label ???
 
       # Replace variables in `dname` using the replacements dictionary
-      @attrs[:dname] = @attrs[:dname].gsub(pattern) do |match|
+      @attrs[:dname] = @attrs[:dname]&.gsub(pattern) do |match|
+        replacements[match]
+      end
+      @attrs[:s0printable] = @attrs[:s0printable]&.gsub(pattern) do |match|
+        replacements[match]
+      end
+      @attrs[:s1decorated] = @attrs[:s1decorated]&.gsub(pattern) do |match|
         replacements[match]
       end
 
       # Replace variables in each line of `body` if `body` is present
       if @attrs[:body]
-        @attrs[:body] = @attrs[:body].map do |line|
+        @attrs[:body] = @attrs[:body]&.map do |line|
           if line.empty?
             line
           else