markdown_exec 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f36dcdba359857aa80f8888d8eaf61e5d2675952a5809341bd993cf30c9ef1
-  data.tar.gz: cc753bd25f2b229b6c3d7bab99249c2b6786e4b3efa3ca56c098ff4838f9ad78
+  metadata.gz: e90e469ce0209e21b14e2534769a953c7d8122a97e9fe22714e346620e5a3b46
+  data.tar.gz: 8edf46cc55bb88b2d8cb32a147ce9c730d7951ec1e87b249f346cb5aa226d836
 SHA512:
-  metadata.gz: f982dcfa66c59168f8cdf6b1d9d5fc9af2b946f8d9dc42b4d8af9061bb94758784916f1d2afafe7bb215f60d8588900aff43132a8418199f19abbb1b033087cc
-  data.tar.gz: a7219bde3d387303ca86ea096dc9fbcb059c028c74d9bff1696d9f6bb2d8b77715e9080aec424e4ea35a53462fe895ea6210e930ab6d6a1129172fd95f6a9312
+  metadata.gz: 8da075848dc51de098e42f6f09aaa99914c53604f892c473e9ea834cf99c9e3e9a9fa7e41604991c1d912ff637a186e6e4b5c9dfc3d7d2fbdffc9245262e5c4f
+  data.tar.gz: 892adbee4f68a4a1aedaf8aedd10baffa724f31454b31e8384def5eb97f4d5bb06e50f777a33afaa92fb1c1b2fd42c022a405208dbf41ba9d0ac31a0680145f2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [3.0.6] - 2025-06-07
+
+### Added
+
+- Class to interface with ENV variable.
+
+### Changed
+
+- Improve the collection of inherited code resulting from the evaluation of blocks.
+
 ## [3.0.5] - 2025-05-23
 
 ### Changed

data/Gemfile.lock

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

data/bats/block-type-ux-act-init.bats

@@ -0,0 +1,17 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'act_source' {
+  spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-act-init.md \
+   export_act \
+   'allow_echo_edit_exec_allow_allow_allow_allow_allow_allow_false_allow_allow_edit'
+}
+
+@test 'init_source' {
+  spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-act-init.md \
+   export_init \
+   'allow_allow_allow_allow_allow_default_echo_exec_allow_false_false_1.0.0_allow_false'
+}
+
+# bin/bmde docs/dev/block-type-ux-act-init.md --list-blocks-message export_init --list-blocks-type 3 --list-blocks

data/bats/block-type-ux-echo.bats

@@ -10,8 +10,7 @@ load 'test_helper'
 @test 'inherited lines' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-echo.md \
    '(menu_with_inherited_lines)' \
-   'VAR=markdown_exec_IAB='
-   # 'VAR=markdown_exec_VAR=markdown_exec_IAB='
+   '[[ -z $VAR ]] && VAR=markdown_exec_VAR=markdown_exec_IAB='
 }
 
 @test 'selected block - output of wc includes whitespace' {

data/bats/block-type-ux-sources.bats

@@ -11,7 +11,7 @@ load 'test_helper'
 @test 'init_source' {
   spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-sources.md \
    export_init \
-   'default_exec_echo_allow_false_false'
+   'Guest_exec_echo_allow_false_false'
 }
 
 @test 'act_source' {

data/bats/block-type-ux-transform.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'Transformed output of executed commands' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-transform.md \
-   '_Execution output has a trailing newline._Var0=markdown_exec__00000000  6d 61 72 6b 64 6f 77 6e  5f 65 78 65 63 0a        |markdown_exec.|_0000000e__With validate and transform, output has no newline._Var1=markdown_exec_00000000  6d 61 72 6b 64 6f 77 6e  5f 65 78 65 63           |markdown_exec|_0000000d__With transform :chomp, output has no newline._Var2=markdown_exec_00000000  6d 61 72 6b 64 6f 77 6e  5f 65 78 65 63           |markdown_exec|_0000000d__With transform :upcase, output is in upper case w/ newline._Var3=MARKDOWN_EXEC__00000000  4d 41 52 4b 44 4f 57 4e  5f 45 58 45 43 0a        |MARKDOWN_EXEC.|_0000000e'
+  '_Execution output has a trailing newline._Var0=markdown_exec__ 6d 61 72 6b 64 6f 77 6e 5f 65 78 65 63 0a      __With validate and transform, output has no newline._Var1=markdown_exec_ 6d 61 72 6b 64 6f 77 6e 5f 65 78 65 63         __With transform :chomp, output has no newline._Var2=markdown_exec_ 6d 61 72 6b 64 6f 77 6e 5f 65 78 65 63         __With transform :upcase, output is in upper case w/ newline._Var3=MARKDOWN_EXEC__ 4d 41 52 4b 44 4f 57 4e 5f 45 58 45 43 0a      '
 }

data/bats/import-conflict.bats

@@ -0,0 +1,11 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Import and require blocks with duplicate names - blocks with same name have different requirements' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-conflict-0.md \
+   'u0.0' \
+   '_u0.0_d0.0_u0.1_d1.0_u1.1'
+}

data/bats/import-duplicates.bats

@@ -0,0 +1,53 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+# Imported blocks `[du]1.*` appear before principal blocks `[du]0.*` in the code evaluated because the import of `import-duplicates-1.md` is above the `0.*` definitions in the principal file.
+
+@test 'Import and require blocks with duplicate names - unique in main 0' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-duplicates-0.md \
+   'u0.0' \
+   '_d1.0_d1.1_d0.0_d0.1_u0.0'
+}
+
+@test 'Import and require blocks with duplicate names - unique in main 1' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-duplicates-0.md \
+   'u0.1' \
+   '_d1.1_d0.1_u0.1'
+}
+
+@test 'Import and require blocks with duplicate names - duplicate 0' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-duplicates-0.md \
+   'd0' \
+   '_d1.0_d1.1_d0.0_d0.1'
+}
+
+@test 'Import and require blocks with duplicate names - duplicate 1' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-duplicates-0.md \
+   'd1' \
+   '_d1.1_d0.1'
+}
+
+@test 'Import and require blocks with duplicate names - unique in import 0' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-duplicates-0.md \
+   'u1.0' \
+   '_d1.0_d1.1_u1.0_d0.0_d0.1'
+}
+
+@test 'Import and require blocks with duplicate names - unique in import 1' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import-duplicates-0.md \
+   'u1.1' \
+   '_d1.1_u1.1_d0.1'
+}

data/bats/variable-expansion-multiline.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test '' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/variable-expansion-multiline.md \
-   'Genus2 = Pongo_Pongo_UX block:_Genus2=Pongo_Pongo_Command substitution:_Genus2 hex: 00000000  50 6f 6e 67 6f 0a 50 6f  6e 67 6f                 |Pongo.Pongo|_0000000b_Command substitution:_Genus2 text: Pongo_Pongo_Command substitution:_Gemfile_Gemfile.lock_Variable expansion:_Genus2 text: Pongo_Pongo'
+   'Genus2 = Pongo_Pongo_UX block:_Genus2=Pongo_Pongo_Command substitution:_Genus2 hex:  50 6f 6e 67 6f 0a 50 6f 6e 67 6f               _Command substitution:_Genus2 text: Pongo_Pongo_Command substitution:_Gemfile_Gemfile.lock_Variable expansion:_Genus2 text: Pongo_Pongo'
 }

data/bin/bmde

@@ -6,12 +6,13 @@ require 'bundler/setup'
 Bundler.require(:default)
 
 require_relative '../lib/markdown_exec'
+require_relative '../lib/env_interface'
 
 trace_enabled = false
 
-if ENV['MDE_TRACE_POINT']
-  trace_output = if ENV['MDE_TRACE_POINT_FILE']
-                   File.open(ENV['MDE_TRACE_POINT_FILE'], 'a')
+if EnvInterface.get('MDE_TRACE_POINT')
+  trace_output = if EnvInterface.get('MDE_TRACE_POINT_FILE')
+                   File.open(EnvInterface.get('MDE_TRACE_POINT_FILE'), 'a')
                  else
                    $stderr
                  end

data/docs/dev/block-type-ux-act-init.md

@@ -0,0 +1,187 @@
+# UX Block Test Cases
+
+This document contains test cases for all possible combinations of `init` and `act` behaviors.
+
+## Test Cases
+
+### 1. Explicit Init and Act
+
+#### 1.1 Init: allow, Act: allow
+```ux
+name: ENVIRONMENT
+init: :allow
+allow:
+  - development
+  - staging
+  - production
+act: :allow
+```
+Behavior:
+- Init: Uses first allowed value (development)
+- Act: Shows menu of allowed values
+
+#### 1.2 Init: allow, Act: echo
+```ux
+name: ENVIRONMENT
+init: :allow
+allow:
+  - development
+  - staging
+  - production
+act: :echo
+echo: "Selected environment: ${ENVIRONMENT}"
+```
+Behavior:
+- Init: Uses first allowed value (development)
+- Act: Evaluates echo string with current value
+
+#### 1.3 Init: allow, Act: edit
+```ux
+name: ENVIRONMENT
+init: :allow
+allow:
+  - development
+  - staging
+  - production
+act: :edit
+prompt: "Select environment"
+```
+Behavior:
+- Init: Uses first allowed value (development)
+- Act: Prompts for input
+
+#### 1.4 Init: allow, Act: exec
+```ux
+name: ENVIRONMENT
+init: :allow
+allow:
+  - development
+  - staging
+  - production
+act: :exec
+exec: "echo 'Deploying to ${ENVIRONMENT}'"
+```
+Behavior:
+- Init: Uses first allowed value (development)
+- Act: Executes command with current value
+
+### 2. Default Init (no init key)
+
+#### 2.1 Default Init (allow), Act: allow
+```ux
+name: ENVIRONMENT
+allow:
+  - development
+  - staging
+  - production
+act: :allow
+```
+Behavior:
+- Init: Uses first allowed value (development)
+- Act: Shows menu of allowed values
+
+#### 2.2 Default Init (default), Act: allow
+```ux
+name: ENVIRONMENT
+default: development
+act: :allow
+```
+Behavior:
+- Init: Uses default value (development)
+- Act: Shows menu of allowed values
+
+#### 2.3 Default Init (echo), Act: allow
+```ux
+name: CURRENT_DIR
+echo: $(pwd)
+act: :allow
+```
+Behavior:
+- Init: Evaluates echo command
+- Act: Shows menu of allowed values
+
+#### 2.4 Default Init (exec), Act: allow
+```ux
+name: CURRENT_DIR
+exec: basename $(pwd)
+act: :allow
+```
+Behavior:
+- Init: Executes command
+- Act: Shows menu of allowed values
+
+### 3. Default Act (no act key)
+
+#### 3.1 Init: allow, Default Act
+```ux
+name: ENVIRONMENT
+init: :allow
+allow:
+  - development
+  - staging
+  - production
+```
+Behavior:
+- Init: Uses first allowed value (development)
+- Act: Shows menu of allowed values (defaults to :allow)
+
+#### 3.2 Init: false, Default Act
+```ux
+name: ENVIRONMENT
+init: false
+allow:
+  - development
+  - staging
+  - production
+echo: "Current: ${ENVIRONMENT}"
+```
+Behavior:
+- Init: No initialization
+- Act: Shows menu of allowed values (defaults to :allow)
+
+### 4. Special Cases
+
+#### 4.1 Init: false, Act: false
+```ux
+name: READONLY_VAR
+init: false
+act: false
+```
+Behavior:
+- Init: No initialization
+- Act: Cannot be activated
+
+#### 4.2 Init: string, Act: allow
+```ux
+name: VERSION
+init: "1.0.0"
+act: :allow
+allow:
+  - "1.0.0"
+  - "1.0.1"
+  - "1.1.0"
+```
+Behavior:
+- Init: Uses string value "1.0.0"
+- Act: Shows menu of allowed values
+
+#### 4.3 No Init, No Act
+```ux
+name: ENVIRONMENT
+allow:
+  - development
+  - staging
+  - production
+```
+Behavior:
+- Init: Uses first allowed value
+- Act: Shows menu of allowed values (defaults to :allow)
+
+#### 4.4 No Init, No Act, No Allow
+```ux
+name: USER_INPUT
+prompt: "Enter value"
+```
+Behavior:
+- Init: No initialization (defaults to false)
+- Act: Prompts for input (defaults to :edit) 

data/docs/dev/block-type-ux-auto.md

@@ -27,7 +27,6 @@ name: v4
 / name, default, exec; auto-load executed `basename $(pwd)`
 / allowed is ignored by exec
 ```ux :[document_ux_v5]
-init: :exec
 exec: basename $(pwd)
 name: v5
 ```

data/docs/dev/block-type-ux-default.md

@@ -6,7 +6,7 @@ name: v1
 / name and default
 / transform and validate options not applied to default
 ```ux
-default: 11
+init: 11
 name: v2
 ```
 / name and default; auto-load
@@ -17,7 +17,7 @@ name: v3
 ```
 / name, default, exec; auto-load static
 ```ux :[document_ux_v4]
-default: 21
+init: 21
 exec: basename $(pwd)
 name: v4
 ```

data/docs/dev/block-type-ux-echo.md

@@ -21,6 +21,6 @@ echo: $VAR$VAR
 name: IAB
 ```
 ```opts :(document_opts)
-menu_with_inherited_lines: true
+menu_with_inherited_lines: false
 ```
 @import bats-document-configuration.md

data/docs/dev/block-type-ux-exec.md

@@ -15,7 +15,6 @@ name: ux1
 / auto-load block and execute command to calculate
 / click block to recalculate
 ```ux :[document_ux2]
-act: :exec
 exec: basename $(pwd)
 name: ux2
 ```

data/docs/dev/block-type-ux-sources.md

@@ -1,8 +1,8 @@
 / 1. Simple variable display and edit:
 ```ux
+init: Guest
 name: USER_NAME
 prompt: Enter your name
-default: Guest
 ```
 /Behavior: Displays the USER_NAME variable. When clicked, prompts for input with "Enter your name" and defaults to "Guest" if no input is provided.
 /

data/docs/dev/block-type-ux-transform.md

@@ -4,7 +4,7 @@
 exec: basename $(pwd)
 name: Var0
 ```
-$(echo -n "$Var0" | hexdump -C)
+$(echo -n "$Var0" | hexdump -v -e '16/1 " %02x"')
 :::
 **With validate and transform, output has no newline.**
 ```ux :[document_ux_transform_1]
@@ -13,7 +13,7 @@ name: Var1
 transform: '%{name}'
 validate: (?<name>.+)
 ```
-$(echo -n "$Var1" | hexdump -C)
+$(echo -n "$Var1" | hexdump -v -e '16/1 " %02x"')
 :::
 **With transform `:chomp`, output has no newline.**
 ```ux :[document_ux_transform_2]
@@ -21,7 +21,7 @@ exec: basename $(pwd)
 name: Var2
 transform: :chomp
 ```
-$(echo -n "$Var2" | hexdump -C)
+$(echo -n "$Var2" | hexdump -v -e '16/1 " %02x"')
 :::
 **With transform `:upcase`, output is in upper case w/ newline.**
 ```ux :[document_ux_transform_3]
@@ -29,9 +29,10 @@ exec: basename $(pwd)
 name: Var3
 transform: :upcase
 ```
-$(echo -n "$Var3" | hexdump -C)
+$(echo -n "$Var3" | hexdump -v -e '16/1 " %02x"')
 @import bats-document-configuration.md
 ```opts :(document_opts)
 divider4_collapsible: false
+screen_width: 80
 table_center: false
 ```

data/docs/dev/command-substitution.md

@@ -22,5 +22,6 @@ menu_final_divider:
 menu_for_saved_lines: false
 menu_initial_divider:
 menu_vars_set_format:
+screen_width: 80
 table_center: false
 ```

data/docs/dev/import-conflict-0.md

@@ -0,0 +1,12 @@
+/ Import and require blocks with different requirements.
+``` :u0.0 +d0
+echo u0.0
+```
+``` :d0 +u0.1
+echo d0.0
+```
+``` :u0.1
+echo u0.1
+```
+@import import-conflict-1.md
+@import bats-document-configuration.md

data/docs/dev/import-conflict-1.md

@@ -0,0 +1,7 @@
+/ Blocks with duplicate names to be imported.
+``` :d0 +u1.1
+echo d1.0
+```
+``` :u1.1
+echo u1.1
+```

data/docs/dev/import-duplicates-0.md

@@ -0,0 +1,17 @@
+/ Import and require blocks with duplicate names.
+/ Imported blocks appear first in the code because the import is at the top of the file.
+@import import-duplicates-1.md
+/ `d1` is required by `d0` in the import
+``` :d0
+echo d0.0
+```
+``` :d1
+echo d0.1
+```
+``` :u0.0 +d0
+echo u0.0
+```
+``` :u0.1 +d1
+echo u0.1
+```
+@import bats-document-configuration.md

data/docs/dev/import-duplicates-1.md

@@ -0,0 +1,13 @@
+/ Blocks with duplicate names to be imported.
+``` :d0 +d1
+echo d1.0
+```
+``` :d1
+echo d1.1
+```
+``` :u1.0 +d0
+echo u1.0
+```
+``` :u1.1 +d1
+echo u1.1
+```

data/docs/dev/load_code.md

@@ -10,5 +10,6 @@ Run this command to display the inherited code.
 @import bats-document-configuration.md
 ```opts :(document_opts)
 menu_for_saved_lines: false
+screen_width: 80
 table_center: false
 ```

data/docs/dev/no-active-elements.md

@@ -3,4 +3,5 @@ A **document** with no active elements.
 @import bats-document-configuration.md
 ```opts :(document_opts)
 heading1_center: false
+screen_width: 80
 ```

data/docs/dev/variable-expansion-multiline.md

@@ -14,7 +14,7 @@ readonly: true
 /
 / Confirm the string contains a newline `0a`
 __Command substitution__:
-Genus2 hex: $(printf "$Genus2" | hexdump -C)
+Genus2 hex: $(printf "$Genus2" | hexdump -v -e '16/1 " %02x"')
 /
 / output with substitution
 __Command substitution__:
@@ -28,4 +28,7 @@ $(ls -1 G*)
 __Variable expansion__:
 Genus2 text: ${Genus2}
 /
+```opts :(document_opts)
+screen_width: 80
+```
 @import bats-document-configuration.md

data/docs/ux-blocks-examples.md

@@ -0,0 +1,120 @@
+# UX Block Examples
+
+This file contains a collection of unique UX block examples from the documentation.
+
+## Basic Examples
+
+### Simple Variable Display and Edit
+```ux
+init: Guest
+name: USER_NAME
+prompt: Enter your name
+```
+
+### Command Output Initialization
+```ux
+name: CURRENT_DIR
+init: :exec
+exec: basename $(pwd)
+transform: :chomp
+```
+
+### Echo-based Initialization
+```ux
+name: SHELL_VERSION
+init: :echo
+echo: $SHELL
+```
+
+### Selection from Allowed Values
+```ux
+name: ENVIRONMENT
+allow:
+  - development
+  - staging
+  - production
+prompt: Select environment
+```
+
+## Validation Examples
+
+### Email Validation
+```ux
+name: USER_EMAIL
+prompt: Enter email address
+validate: '(?<local>[^@]+)@(?<domain>[^@]+)'
+transform: '%{local}@%{domain}'
+```
+
+### Version Number Validation
+```ux
+name: VERSION
+prompt: Enter version number
+validate: '(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)'
+transform: '%{major}.%{minor}.%{patch}'
+```
+
+## Complex Examples
+
+### Git Branch Selection with Validation
+```ux
+name: BRANCH_NAME
+init: ":exec"
+exec: "git branch --format='%(refname:short)'"
+validate: "^(?<type>feature|bugfix|hotfix)/(?<ticket>[A-Z]+-\d+)-(?<desc>.+)$"
+transform: "${type}/${ticket}-${desc}"
+prompt: "Select or enter branch name"
+```
+
+### Environment Configuration with Dependencies
+```ux
+name: DATABASE_URL
+require:
+  - ENVIRONMENT
+  - DB_HOST
+  - DB_PORT
+format: "postgresql://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}"
+```
+
+### Multi-step Configuration
+```ux
+name: DEPLOY_CONFIG
+require:
+  - ENVIRONMENT
+  - VERSION
+init: ":echo"
+echo: "Deploying ${VERSION} to ${ENVIRONMENT}"
+act: ":exec"
+exec: "deploy.sh ${ENVIRONMENT} ${VERSION}"
+```
+
+### Conditional Initialization
+```ux
+name: API_KEY
+init: ":allow"
+allow:
+  - ${PROD_API_KEY}
+  - ${STAGING_API_KEY}
+  - ${DEV_API_KEY}
+require:
+  - ENVIRONMENT
+```
+
+### Formatted Output with Validation
+```ux
+name: PHONE_NUMBER
+prompt: "Enter phone number"
+validate: "(?<country>\d{1,3})(?<area>\d{3})(?<number>\d{7})"
+transform: "+${country} (${area}) ${number}"
+format: "Phone: ${PHONE_NUMBER}"
+```
+
+### Command Output with Transformation
+```ux
+name: GIT_STATUS
+init: ":exec"
+exec: "git status --porcelain"
+validate: "(?<status>[AMDR])\s+(?<file>.+)"
+transform: "${status}: ${file}"
+format: "Changes: ${GIT_STATUS}"
+```