markdown_exec 2.8.0 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36bb5c2d9e91eeeae59067f91fc88a3ad8e6b1a27ebfb474ff900903d030042
-  data.tar.gz: b002fc24e78006e830fdc66bb0be4df05fe9df62e6c036965eefbb7047f37ec7
+  metadata.gz: 066c72f2f85462a89163b7834669dee6526e516ee3ebfe4be2e8b269cb4ece36
+  data.tar.gz: 48c2bce9ac82cda2cbecca5bea4564b28013cdbab7005e249e8a856d0280afa0
 SHA512:
-  metadata.gz: 8eedac9012c2c0103afe99a8ea0cd235b26b3ab62618b35d79af6f685a56195818d28ba70588f93d754c76e5c4b3bb524de0ed09fd97864bdc79a424015911a9
-  data.tar.gz: d24b8c56e50416032de644f00d11f6bb81689617e47da57ec1e4b39a693c867dedff268ddd00e023bc134fc40ee9ae9b452a808131d129b378508464ac0793f5
+  metadata.gz: fe1270b8cf11efc8ad9e81cb43052bc75cfc217e362c7d6e30acb6981a6d0be749f290b9b15ce1a2655d6a7e157177c4cd975aa61de22a6f6bafe2a835285228
+  data.tar.gz: 9445285db86af55fe5ba0b784a24d30dd418ac3d1dc551183a5a1b3b865df27a6b314ddc08b4a013de5e926e023439753fe08cd4ea8d6c6da0c0d9547e4a9546

data/.rubocop.yml

@@ -76,6 +76,9 @@ Security/YAMLLoad:
 Style/ClassVars:
   Enabled: false
 
+Style/CombinableLoops:
+  Enabled: false
+
 Style/CommentedKeyword:
   Enabled: false
 
@@ -97,6 +100,9 @@ Style/GlobalVars:
 Style/IfUnlessModifier: # 2024-08 suggests lines that are too long
   Enabled: false
 
+Style/KeywordParametersOrder:
+  Enabled: false
+
 Style/Lambda:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## [2.8.2] - 2025-02-19
+
+### Added
+
+- UX blocks can add preconditions. Preconditions are variable names that must be set before the UX block is executed. If any preconditions are not set, a warning is displayed, and the sequence is aborted.
+- UX blocks can require shell an other UX blocks.
+- UX blocks are evaluated in order and calculation can depend on prior variables in the same sequence.
+
+### Changed
+
+- Hide all blocks per their initial title instead of `oname`.
+- Make menu blocks for list of files found to fix crash.
+- Use a block ID to recall the selected block.
+- UX blocks are hidden similar to the rest.
+
+## [2.8.1] - 2025-02-13
+
+### Added
+
+- BATS tests for UX block type.
+
+### Changed
+
+- Improve persistence of position in menu on reload
+- Update block-type-ux-exec BATS test.
+- Refactor menu for selecting items with facets.
+
 ## [2.8.0] - 2025-02-10
 
 ### Added

data/Gemfile.lock

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

data/bats/block-hide.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'hide blocks' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-hide.md \
+   'visible'
+}

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Initial values' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-auto.md \
+   'v1 = _v2 = _v3 = 12_v4 = 21_v5 = markdown_exec_v6 = 31'
+}

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Output of executed commands as initial value' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-exec.md \
+   "ux0=_ux1=Unknown_ux2=markdown_exec_ux3=markdown_exec_ux4=Xform: 'markdown'"
+}

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Output of executed commands as initial value' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-require.md \
+   'SPECIES=Pongo tapanuliensis_GENUS=Pongo_NAME=Pongo tapanuliensis - Pongo_NAME2=Pongo tapanuliensis - Pongo'
+}

data/bats/block-type-ux-row-format.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Row format merges with prior table' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-row-format.md \
+   '  | Variable  | Value            | Prompt              |_  | --------- | ---------------- | ------------------- |_  | Species   | Pongo tapanulien | New species?    |_ | Name: Gen | Value: Pongo     | Prompt: New genus? |_  | Family    | Hominidae        | Enter a value:  |'
+}

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+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.|__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|__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|__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.|'
+}

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "2.8.0"
+  echo "2.8.2"
 }
 
 _mde() {

data/docs/dev/block-hide.md

@@ -0,0 +1,18 @@
+``` :(hidden)
+```
+``` :visible
+```
+/ ux block is displayed differently than other types
+```ux :()
+name: name
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+# Pattern for blocks to hide from user-selection
+block_name_include_match:
+  ^\(.*\)$
+
+# Pattern for the block name in the line defining the block
+block_name_match: |
+  :(?<title>\S+)( |$)
+```

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

@@ -0,0 +1,43 @@
+/ v2025-02-08
+/ name only
+```ux
+name: v1
+```
+/ name and default
+/ transform and validate options not applied to default
+```ux
+default: 11
+name: v2
+```
+/ name and default; auto-load
+/ prompt option is ignored during auto-load
+```ux :[document_ux_v3]
+default: 12
+name: v3
+```
+/ name, default, exec; auto-load static
+```ux :[document_ux_v4]
+default: 21
+exec: basename $(pwd)
+name: v4
+```
+/ name, default, exec; auto-load executed `basename $(pwd)`
+/ allowed is ignored by exec
+```ux :[document_ux_v5]
+default: :exec
+exec: basename $(pwd)
+name: v5
+```
+/ name, default, allowed; auto-load static default
+```ux :[document_ux_v6]
+allowed:
+- 32
+- 33
+default: 31
+name: v6
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+menu_ux_row_format: '%{name} = ${%{name}}'
+ux_auto_load_force_default: true
+```

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

@@ -0,0 +1,42 @@
+/ auto-load block, does not execute command to calculate
+/ click block to calculate
+```ux :[document_ux0]
+exec: basename $(pwd)
+name: ux0
+```
+/ auto-load block and execute command to calculate
+/ click block to recalculate
+```ux :[document_ux1]
+default: Unknown
+exec: basename $(pwd)
+name: ux1
+```
+/ auto-load block and execute command to calculate
+/ click block to recalculate
+```ux :[document_ux2]
+default: :exec
+exec: basename $(pwd)
+name: ux2
+```
+/ required block defining a function used in exec
+```bash :(bash3)
+# function from bash3
+val () { basename $(pwd) ; }
+```
+```ux :[document_ux3] +(bash3)
+default: :exec
+exec: val
+name: ux3
+```
+/ default is computed
+/ output of execution is validated/parsed
+/ parsing is transformed
+```ux :[document_ux4]
+default: :exec
+exec: basename $(pwd)
+name: ux4
+transform: "Xform: '%{name}'"
+validate: |
+  ^(?<name>.*)(_.*)$
+```
+@import bats-document-configuration.md

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

@@ -0,0 +1,28 @@
+/ an automatic UX block requires a shell block and another UX block
+``` :(shell)
+ENTITY='Pongo tapanuliensis,Pongo'
+```
+```ux :[document_ux_SPECIES] +(shell) +[ux_GENUS]
+default: :exec
+exec: printf "${ENTITY%%,*}"
+name: SPECIES
+```
+/ required ux block requires another
+```ux :[ux_GENUS] +[ux_NAME]
+default: :exec
+exec: printf "${ENTITY##*,}"
+name: GENUS
+```
+/ executed in context of prior ux blocks, uses their initial values
+```ux :[ux_NAME]
+default: :exec
+exec: printf "$SPECIES - $GENUS"
+name: NAME
+```
+/ executed after other ux blocks, uses their initial values
+```ux :[document_ux_NAME2]
+default: :exec
+exec: printf "$NAME"
+name: NAME2
+```
+@import bats-document-configuration.md

data/docs/dev/block-type-ux-row-format.md

@@ -0,0 +1,47 @@
+/ v2025-02-08
+| Variable| Value| Prompt
+| -| -| -
+/ auto-load default value
+/ custom prompt
+/ select list
+/ default value
+```ux :[document_ux_Species]
+allowed:
+- Pongo tapanuliensis
+- Histiophryne psychedelica
+- Phyllopteryx dewysea
+default: Pongo tapanuliensis
+name: Species
+prompt: New species?
+```
+/ auto-load default value
+/ cell text is prefixed Name/Value/Prompt
+/ select list contains additional text
+/ selected value is validated with named groups
+/ selected value is transformed; named capture is prefixed Xform
+```ux :[document_ux_Genus]
+allowed:
+- 1. Pongo
+- 2. Histiophryne
+- 3. Phyllopteryx
+default: Pongo
+menu_format: "| Name: %{name}| Value: ${%{name}}| Prompt: %{prompt}"
+name: Genus
+prompt: New genus?
+transform: "Xform: '%{name}'"
+validate: |
+  ^\d+\. *(?<name>[^ ].*)$
+```
+/ default
+/ auto-load default value
+```ux :[document_ux_Family]
+default: Hominidae
+name: Family
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+menu_ux_row_format: '| %{name}| ${%{name}}| %{prompt}'
+screen_width: 64
+table_center: true
+ux_auto_load_force_default: true
+```

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

@@ -0,0 +1,41 @@
+:::
+**Execution output has a trailing newline.**
+```ux :[document_ux_transform_0]
+default: :exec
+exec: basename $(pwd)
+name: Var0
+```
+$(echo -n "$Var0" | hexdump -C)
+:::
+**With validate and transform, output has no newline.**
+```ux :[document_ux_transform_1]
+default: :exec
+exec: basename $(pwd)
+name: Var1
+transform: '%{name}'
+validate: (?<name>.+)
+```
+$(echo -n "$Var1" | hexdump -C)
+:::
+**With transform `:chomp`, output has no newline.**
+```ux :[document_ux_transform_2]
+default: :exec
+exec: basename $(pwd)
+name: Var2
+transform: :chomp
+```
+$(echo -n "$Var2" | hexdump -C)
+:::
+**With transform `:upcase`, output is in upper case w/ newline.**
+```ux :[document_ux_transform_3]
+default: :exec
+exec: basename $(pwd)
+name: Var3
+transform: :upcase
+```
+$(echo -n "$Var3" | hexdump -C)
+@import bats-document-configuration.md
+```opts :(document_opts)
+divider4_collapsible: false
+table_center: false
+```

data/lib/constants.rb

@@ -100,8 +100,10 @@ end
 
 # selected block and subsequent menu state
 #
+BlockSelection = Struct.new(:id)
 SelectedBlockMenuState = Struct.new(:block, :source, :state)
 
 class TtyMenu
+  ENABLE = nil
   DISABLE = ''
 end

data/lib/fcb.rb

@@ -14,7 +14,8 @@ def parse_yaml_of_ux_block(
   export = data['export']
   export = data if export.nil?
   name = export['name']
-  raise "Invalid data: #{data.inspect}" unless name.present?
+
+  raise "Name is missing in UX block: #{data.inspect}" unless name.present?
 
   OpenStruct.new(
     allowed: export['allowed'],
@@ -22,6 +23,7 @@ def parse_yaml_of_ux_block(
     exec: export['exec'],
     menu_format: export['menu_format'] || menu_format,
     name: name,
+    preconditions: export['preconditions'],
     prompt: export['prompt'] || prompt,
     transform: export['transform'],
     validate: export['validate'] || validate
@@ -56,10 +58,6 @@ module MarkdownExec
         title: '',
         type: ''
       }.merge(options)
-      # @attrs[:raw_body] ||= @attrs[:body]
-      # @attrs[:raw_dname] ||= @attrs[:dname]
-      # @attrs[:raw_s0printable] ||= @attrs[:s0printable]
-      # @attrs[:raw_s1decorated] ||= @attrs[:s1decorated]
     end
 
     def code_name_included?(*names)
@@ -92,34 +90,6 @@ module MarkdownExec
                        end
     end
 
-    # def body=(value)
-    #   ww0 'body=', value
-    #   # binding.irb
-    #   @attrs[:raw_body] ||= value
-    #   @attrs[:body] = value
-    # end
-
-    # def dname=(value)
-    #   ww0 'dname=', value
-    #   binding.irb if value == '                                              | Species| Not specified'
-    #   @attrs[:raw_dname] ||= value
-    #   @attrs[:dname] = value
-    # end
-
-    # def s0printable=(value)
-    #   ww0 's0printable=', value
-    #   # binding.irb
-    #   @attrs[:raw_s0printable] ||= value
-    #   @attrs[:s0printable] = value
-    # end
-
-    # def s1decorated=(value)
-    #   ww0 's1decorated=', value
-    #   # binding.irb
-    #   @attrs[:raw_s1decorated] ||= value
-    #   @attrs[:s1decorated] = value
-    # end
-
     # Processes a block to generate its summary, modifying its attributes
     #  based on various matching criteria.
     # It handles special formatting for bash blocks, extracting and setting
@@ -168,6 +138,7 @@ module MarkdownExec
           @attrs[:center] = table_center
           oname = @attrs[:oname] = format(export.menu_format, export.to_h)
         else
+          # triggered by an empty block
           raise "Invalid data type: #{data.inspect}"
         end
       end