markdown_exec 2.8.1 → 2.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d752af0db5e1c1a770b64f9341c3d08e1e9bc8612230a9cb44ddc7fddc4c3051
-  data.tar.gz: 5ba8524b3323bd8333b82a5d0607fbb9db59a5157a1c7ae0564b3f624f26addd
+  metadata.gz: dfa1920cdbee40306492b597411dff701777c0ac158dc969a02d3ac2db7351b2
+  data.tar.gz: fe5c8229410f4263b9aa394c99f1d1be61b6a119684ca5c29e8f0a7851d4391a
 SHA512:
-  metadata.gz: 29b210e56b46a1edf099c02267e2b3c7cdae6701f7ee99d5a946d06eea7272da3534765110ec36a6de017a10d0f4833c9075c27dacb0cec8b050192d3892d748
-  data.tar.gz: e73cd906ce9035c8c78d2e301866af4a76bc7a730c5109fc8cc59ecf64679cb578fb04b324e700df064886d250c394c441f77850b9e21230d346d08bd92a9a5f
+  metadata.gz: e2566c1f28e9eb898c490aa9076d762fe76b8f2092a1b6b4a9d37ff889d02bea021cf84fad63c2f9598d7ba17d7a6ac63840d49958d6dfad9f45b57250a4d3b7
+  data.tar.gz: 44a40a84a65eb477951b6929307837cc8493e70b9fe76b5065bb86e54b2b10f07241de175552132979ddb00b5c8bdce031d64688189b78f5da9f953e74399f4a

data/.rubocop.yml

@@ -76,6 +76,9 @@ Security/YAMLLoad:
 Style/ClassVars:
   Enabled: false
 
+Style/CombinableLoops:
+  Enabled: false
+
 Style/CommentedKeyword:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## [2.8.3] - 2025-02-27
+
+### Added
+
+- "echo" support to UX blocks for evaluated shell expressions
+
+  Introduces the `echo` key to UX blocks, allowing the output of an
+  evaluated shell expression to be assigned to a named variable.
+  Implements `export_echo_with_code` to execute the expression safely
+  and handle invalidated outputs. Also ensures proper transformation of
+  export values.
+
+- Persist allocated FCBs.
+
+- Read-only flag to UX menu blocks
+
+  Introduces a `readonly` flag for UX menu blocks, allowing exports to
+  specify whether a block should be immutable. The flag is assigned from
+  the export definition and enforced in the menu logic.
+
+### Changed
+
+- Correct indent of all lines displayed for a block.
+- Retain whitespace in output from shell blocks.
+- Remove a function to report the compiled version from the tab completion script. It is not used.
+
+## [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.1)
+    markdown_exec (2.8.3)
       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-echo.bats

@@ -0,0 +1,20 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'automatic block - default' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-echo.md \
+   'VAR=markdown_exec_IAB='
+}
+
+@test 'inherited lines' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-echo.md \
+   '(menu_with_inherited_lines)' \
+   'VAR=markdown_exec_VAR=markdown_exec_IAB='
+}
+
+@test 'selected block' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-echo.md \
+   '(VAR_has_count)' '[IAB_has_count]' \
+   'VAR=14_IAB=1414'
+}

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'An undefined variable is a precondition' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-preconditions.md \
+   'A value must exist for: MISSING_VARIABLE_SPECIES='
+}

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

@@ -0,0 +1,10 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'automatic block - disabled' {
+  spec_mde_args_expect \
+   docs/dev/block-type-ux-readonly.md \
+   --list-blocks-message readonly --list-blocks-type 3 --list-blocks \
+   true
+}

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-vars.bats

@@ -7,8 +7,8 @@ load 'test_helper'
 # 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:'
+  spec_mde_xansi_dname_doc_blocks_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
@@ -22,5 +22,5 @@ load 'test_helper'
 @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:'
+   'Species = Not specified Genus = Not specified  Species: Not specified VAULT: '
 }

data/bats/indented-multi-line-output.bats

@@ -0,0 +1,9 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Retain whitespace in output from shell blocks' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/indented-multi-line-output.md \
+   '[make-output]' \
+   '_Species_ Genus_  Family_Order'
+}

data/bats/line-decor-dynamic.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Line decor, dynamic - new pattern, line_decor_pre, ansi' {
+  spec_mde_dname_doc_blocks_expect docs/dev/line-decor-dynamic.md \
+   $'\e[38;2;200;200;33m\e[48;2;60;60;32mSpecies\e[0m'
+}

data/bats/test_helper.bash

@@ -209,6 +209,16 @@ spec_mde_args_grep_filter_expect () {
   [[ -n $status ]]
 }
 
+spec_mde_dname_doc_blocks_expect () {
+  BATS_SAFE=_
+  spec_mde_args_expect "$1" \
+   "${@:2:$(($#-2))}" \
+   --list-blocks-message dname \
+   --list-blocks-type 3 \
+   --list-blocks \
+  "${!#}"
+}
+
 spec_mde_xansi_dname_doc_blocks_expect () {
   BATS_OUTPUT_FILTER=A
   BATS_SAFE=_

data/bin/tab_completion.sh

@@ -12,10 +12,6 @@ __filedirs_all()
   COMPREPLY='.'
 }
 
-_mde_echo_version() {
-  echo "2.8.1"
-}
-
 _mde() {
   local cur prev opts
   cur="${COMP_WORDS[COMP_CWORD]}"
@@ -213,4 +209,3 @@ _mde() {
 }
 
 complete -o filenames -o nospace -F _mde mde
-# _mde_echo_version

data/bin/tab_completion.sh.erb

@@ -12,10 +12,6 @@ __filedirs_all()
   COMPREPLY='.'
 }
 
-_mde_echo_version() {
-  echo "<%= MarkdownExec::VERSION %>"
-}
-
 _mde() {
   local cur prev opts
   cur="${COMP_WORDS[COMP_CWORD]}"
@@ -104,4 +100,3 @@ _mde() {
 }
 
 complete -o filenames -o nospace -F _mde mde
-# _mde_echo_version

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-echo.md

@@ -0,0 +1,21 @@
+/ This automatic block sets VAR and displays the current value in the menu.
+```ux :[document_ux_VAR]
+default: :echo
+echo: $(basename `pwd`)
+name: VAR
+```
+/ This block is not visible. Execute to display the inherited lines for testing.
+```opts :(menu_with_inherited_lines)
+menu_with_inherited_lines: true
+```
+/ This block is not visible. Execute to set a new value, displayed by the block above.
+```ux :(VAR_has_count)
+echo: $(basename `pwd` | wc -c)
+name: VAR
+```
+/ This block is visible. Execute to set a new value, displayed by the block above.
+```ux :[IAB_has_count]
+echo: $VAR$VAR
+name: IAB
+```
+@import bats-document-configuration.md

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

@@ -0,0 +1,9 @@
+/ an automatic UX block that has a precondition that must be met before it is executed
+```ux :[document_ux_SPECIES]
+default: :exec
+exec: printf "$MISSING_VARIABLE"
+name: SPECIES
+preconditions:
+- MISSING_VARIABLE
+```
+@import bats-document-configuration.md

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

@@ -0,0 +1,7 @@
+/ This automatic block sets VAR and displays the current value in the menu.
+```ux :[document_ux_VAR]
+default: Pongo tapanuliensis
+name: SPECIES
+readonly: true
+```
+@import bats-document-configuration.md

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

@@ -0,0 +1,32 @@
+/ 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: echo "${ENTITY%%,*}"
+name: SPECIES
+transform: :chomp
+```
+/ required ux block requires another
+```ux :[ux_GENUS] +[ux_NAME]
+default: :exec
+exec: echo "${ENTITY##*,}"
+name: GENUS
+transform: :chomp
+```
+/ executed in context of prior ux blocks, uses their initial values
+```ux :[ux_NAME]
+default: :exec
+exec: echo "$SPECIES - $GENUS"
+name: NAME
+transform: :chomp
+```
+/ executed after other ux blocks, uses their initial values
+```ux :[document_ux_NAME2]
+default: :exec
+exec: echo "$NAME"
+name: NAME2
+transform: :chomp
+```
+@import bats-document-configuration.md

data/docs/dev/indented-multi-line-output.md

@@ -0,0 +1,11 @@
+/ Retain whitespace in output from shell blocks
+``` :[make-output]
+echo 'Species'
+echo -e " Genus\n  Family\tOrder"
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+line_decor_pre:
+  - :color_method: :ansi_38_2_200_200_33__48_2_60_60_32__0
+    :pattern: '%([^_]{0,64})%'
+```

data/docs/dev/line-decor-dynamic.md

@@ -0,0 +1,9 @@
+/ Demonstrate dynamic color names
+/ line_decor_pre is performed before line_decor_main and line_decor_post
+%Species%
+@import bats-document-configuration.md
+```opts :(document_opts)
+line_decor_pre:
+  - :color_method: :ansi_38_2_200_200_33__48_2_60_60_32__0
+    :pattern: '%([^_]{0,64})%'
+```

data/lib/ansi_string.rb

@@ -14,6 +14,15 @@ class AnsiString < String
   def method_missing(method_name, *args, &block)
     if dynamic_color_method?(method_name)
       case method_name.to_s
+      when /^ansi_/
+        segments = $'.split('__')
+        codes = ''
+        segments[0..-2].each do |segment|
+          codes += "\033[#{segment.split('_').join(';')}m"
+        end
+        codes += self.to_s
+        codes += "\033[#{segments.last.split('_').join(';')}m"
+        self.class.new(codes)
       when /^fg_bg_rgb_/
         bytes = $'.split('_')
         fg_bg_rgb_color(bytes[0..2].join(';'), bytes[3..5].join(';'))
@@ -148,6 +157,6 @@ class AnsiString < String
   # @param method_name [Symbol] The name of the method being checked.
   # @return [Boolean] True if the method name matches a dynamic color method.
   def dynamic_color_method?(method_name)
-    method_name.to_s =~ /^(fg_bg_rgb_|fg_bg_rgbh_|fg_rgb_|fg_rgbh_)/
+    method_name.to_s =~ /^(ansi_|fg_bg_rgb_|fg_bg_rgbh_|fg_rgb_|fg_rgbh_)/
   end
 end

data/lib/fcb.rb

@@ -14,15 +14,19 @@ 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'],
     default: export['default'],
+    echo: export['echo'],
     exec: export['exec'],
     menu_format: export['menu_format'] || menu_format,
     name: name,
+    preconditions: export['preconditions'],
     prompt: export['prompt'] || prompt,
+    readonly: export['readonly'].nil? ? false : export['readonly'],
     transform: export['transform'],
     validate: export['validate'] || validate
   )
@@ -135,7 +139,9 @@ module MarkdownExec
 
           @attrs[:center] = table_center
           oname = @attrs[:oname] = format(export.menu_format, export.to_h)
+          @attrs[:readonly] = export.readonly
         else
+          # triggered by an empty block
           raise "Invalid data type: #{data.inspect}"
         end
       end
@@ -146,8 +152,6 @@ module MarkdownExec
       )
     end
 
-    private
-
     # Formats multiline body content as a title string.
     # indents all but first line with two spaces
     # so it displays correctly in menu.
@@ -179,6 +183,17 @@ module MarkdownExec
 
     public
 
+    def name_in_menu!(indented_multi_line)
+      # Indent has been extracted from the first line,
+      # remove indent from the remaining lines.
+      @attrs[:dname] =
+        if @attrs[:indent].empty?
+          indented_multi_line
+        else
+          indented_multi_line.gsub("\n#{@attrs[:indent]}", "\n")
+        end
+    end
+
     def respond_to_missing?(method_name, include_private = false)
       @attrs.key?(method_name.to_sym) || super
     end
@@ -253,8 +268,8 @@ if $PROGRAM_NAME == __FILE__
   end
 
   def sort_hash_recursively(hash)
-    hash.each_with_object({}) do |(k, v), new_hash|
-      new_hash[k] = v.is_a?(Hash) ? sort_hash_recursively(v) : v
+    hash.transform_values do |v|
+      v.is_a?(Hash) ? sort_hash_recursively(v) : v
     end.sort.to_h
   end
 

data/lib/filter.rb

@@ -127,8 +127,9 @@ module MarkdownExec
       filters[:fcb_chrome] = fcb.fetch(:chrome, false)
       filters[:shell_default] = (fcb.type == BlockType::SHELL)
 
-      if options[:block_disable_match].present? &&
-         fcb.start_line =~ Regexp.new(options[:block_disable_match])
+      if fcb.readonly ||
+         (options[:block_disable_match].present? &&
+          fcb.start_line =~ Regexp.new(options[:block_disable_match]))
         fcb.disabled = TtyMenu::DISABLE
       end
       return unless name.present?