markdown_exec 2.7.4 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b2dff995a0986c3e248185703f187d49b9cabaabdfae999af261b524ebac1d9
-  data.tar.gz: 4303e59dc01d2c600872b506cb365d1de0452a93bacb13c47358525e80d39ad8
+  metadata.gz: c36bb5c2d9e91eeeae59067f91fc88a3ad8e6b1a27ebfb474ff900903d030042
+  data.tar.gz: b002fc24e78006e830fdc66bb0be4df05fe9df62e6c036965eefbb7047f37ec7
 SHA512:
-  metadata.gz: ab35fe5e0b66c683133f65e9937cdf3336231e3522aed575bedceae8a7044fcf155b11c7e28b324720858dfa53f1443e35b8c5b188796300aa499bb6071930f1
-  data.tar.gz: e8146b88c20bf43c4f43c6d19dd016a249f3227f42450196bf1a40b3356a1f37ae53c645122d25b285ae58c806df3724dd5e32d2e1ac120b45e8f4f86fe7ebbf
+  metadata.gz: 8eedac9012c2c0103afe99a8ea0cd235b26b3ab62618b35d79af6f685a56195818d28ba70588f93d754c76e5c4b3bb524de0ed09fd97864bdc79a424015911a9
+  data.tar.gz: d24b8c56e50416032de644f00d11f6bb81689617e47da57ec1e4b39a693c867dedff268ddd00e023bc134fc40ee9ae9b452a808131d129b378508464ac0793f5

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 # Changelog
 
-## [2.7.4] - 2025-02-02
+## [2.8.0] - 2025-02-10
+
+### Added
+
+- Block type `ux` to facilitate the evaluation, display, and editing of shell variables.
+  The body of the `ux` block is in YAML.
+
+  A valid shell variable name is required as block key `name`. The remaining block keys are optional.
+
+  When the block is executed, its value is computed from the `default`, `exec`, `prompt`, `transform`, and `validate` keys and its output is assigned to the shell variable.
+
+  When a document is loaded, if one or more block names match `document_load_ux_block_name`, they are executed.
+  `ux_auto_load_force_default` limits the setting of the shell variable resulting from the execution of blocks executed at this time.
+
+  When an `ux` block is executed (after initial document load):
+  If the `default` value is the `exec` symbol, the command in the `exec` key is executed and its output is processed.
+  Else if the `allowed` value has one or more items, the user must pick from one of the items.
+  Else if the `prompt` value exists, the user must enter a value or nothing for the `default` value. The user is prompted with `prompt_ux_enter_a_value`.
+  Else the `default` value, as a string, is processed.
+
+  The output is validated/parsed by the regular expression in `validate`.
+  If the string matches, named groups are formatted with `menu_ux_row_format` and assigned to the shell variable.
+
+  The default `menu_ux_row_format` looks like a shell variable assignment.
+  If the output of `menu_ux_row_format` matches an immediately preceding table, the row is merged into that table.
+  Else the output is decorated with `menu_ux_color`.
+- Improve final output of `test` Rake task so failures are visible.
+
+## [2.7.5] - 2025-02-02
 
 ### Added
 

data/Gemfile.lock

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

data/Rakefile

@@ -155,9 +155,30 @@ end
 
 desc 'test'
 task :test do
-  system 'bundle exec rspec'
+  success = true
+  
+  # Run all tests and track failures
+  rspec_success = system('bundle exec rspec')
+  success = false unless rspec_success
+  
   Rake::Task['minitest'].invoke
+  minitest_success = $?.success?
+  success = false unless minitest_success
+  
   Rake::Task['bats'].invoke
+  bats_success = $?.success?
+  success = false unless bats_success
+  
+  # Report failures and exit with non-zero status if any test failed
+  unless success
+    failed_tests = []
+    failed_tests << 'RSpec' unless rspec_success
+    failed_tests << 'Minitest' unless minitest_success
+    failed_tests << 'Bats' unless bats_success
+    
+    puts "\nThe following test suites failed: #{failed_tests.join(', ')}"
+    exit 1
+  end
 end
 
 private

data/bats/command-substitution.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'Command substitution' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/command-substitution.md \
-   'CURRENT BASE NAME IS: MARKDOWN_EXEC_current base name is: markdown_exec_current base name is: markdown_exec_| current base name |_| ----------------- |_| markdown_exec     |_: notice the string is not expanded in Shell block types (names or body)._  echo "current base name is now $(basename `pwd`)"__load: file_markdown_exec.sh'
+   'CURRENT BASE NAME IS: MARKDOWN_EXEC_current base name is: markdown_exec_current base name is: markdown_exec_| current base name |_| ----------------- |_| markdown_exec     |_: notice the string is not expanded in Shell block types (names or body)._  echo "current base name is now $(basename `pwd`)"__load: file_markdown_exec.sh_Status not zero: $(err)'
 }

data/bats/line-wrapping.bats

@@ -4,5 +4,5 @@ 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"
+   "         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/table-column-truncate.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Tables - truncate columns' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/table-column-truncate.md \
+   'DEMONSTRATE TRUNCATION OF TEXT IN TABLE CELLS__| Common Name  | Species      | Genus |  Family | Year Di |_| ------------ | ------------ | ----- | ------- | ------- |_| Tapanuli Ora | Pongo tapanu | Pongo | Hominid |  2017   |_| Psychedelic  | Histiophryne | Histi | Antenna |  2009   |_| Ruby Seadrag | Phyllopteryx | Phyll | Syngnat |  2015   |_| Illacme tobi | Illacme tobi | Illac | Siphono |  2016   |_| Spiny Dandel | Taraxacum ja | Tarax | Asterac |  2022   |__'
+}

data/bats/table.bats

@@ -4,7 +4,7 @@ load 'test_helper'
 
 @test 'Tables - indented' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/table-indent.md \
-   'DEMONSTRATE TABLE INDENTATION__Table flush at left._Centered columns._|     Common Name      |          Species          |    Genus     |    Family     | Year Discovered |_| -------------------- | ------------------------- | ------------ | ------------- | --------------- |_|  Tapanuli Orangutan  |    Pongo tapanuliensis    |    Pongo     |   Hominidae   |      2017       |_| Psychedelic Frogfish | Histiophryne psychedelica | Histiophryne | Antennariidae |      2009       |_|    Ruby Seadragon    |   Phyllopteryx dewysea    | Phyllopteryx | Syngnathidae  |      2015       |__  Table indented with two spaces._  Left-justified columns._  | Common Name                | Species        | Genus   | Family          | Year Discovered |_  | -------------------------- | -------------- | ------- | --------------- | --------------- |_  | Illacme tobini (Millipede) | Illacme tobini | Illacme | Siphonorhinidae | 2016            |__    Table indented with one tab._    Right-justified columns._    |     Common Name |             Species |     Genus |     Family | Year Discovered |_    | --------------- | ------------------- | --------- | ---------- | --------------- |_    | Spiny Dandelion | Taraxacum japonicum | Taraxacum | Asteraceae |            2022 |'
+   'DEMONSTRATE TABLE INDENTATION__Table flush at left._Centered columns._|    Common Name     |        Species         |   Genus    |   Family    | Year Discover |_| ------------------ | ---------------------- | ---------- | ----------- | ------------- |_| Tapanuli Orangutan |  Pongo tapanuliensis   |   Pongo    |  Hominidae  |     2017      |_| Psychedelic Frogfi | Histiophryne psychedel | Histiophry | Antennariid |     2009      |_|   Ruby Seadragon   |  Phyllopteryx dewysea  | Phyllopter | Syngnathida |     2015      |__  Table indented with two spaces._  Left-justified columns._  | Common Name               | Species       | Genus  | Family         | Year Discovere |_  | ------------------------- | ------------- | ------ | -------------- | -------------- |_  | Illacme tobini (Millipede | Illacme tobin | Illacm | Siphonorhinida | 2016           |__    Table indented with one tab._    Right-justified columns._    |     Common Name |             Species |     Genus |     Family | Year Discovered |_    | --------------- | ------------------- | --------- | ---------- | --------------- |_    | Spiny Dandelion | Taraxacum japonicum | Taraxacum | Asteraceae |            2022 |'
 }
 
 @test 'Tables - invalid' {

data/bin/tab_completion.sh

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

data/docs/dev/bats-document-configuration.md

@@ -10,6 +10,9 @@ dump_selected_block: false     # Dump selected block
 execute_in_own_window: false
 
 menu_divider_format:
+
+menu_for_saved_lines: false
+
 menu_with_back: false
 menu_with_exit: false
 menu_with_shell: false

data/docs/dev/command-substitution.md

@@ -11,6 +11,7 @@ echo "current base name is now $(basename `pwd`)"
 ```link
 load: file_$(basename `pwd`).sh
 ```
+Status not zero: $(err)
 / This should not be evaluated $(err). It errs with "Error: HashDelegator.blocks_from_nested_files -- Shell script execution failed: /bin/bash: line 2: err: command not found"
 @import bats-document-configuration.md
 ```opts :(document_opts)

data/docs/dev/table-column-truncate.md

@@ -0,0 +1,17 @@
+# Demonstrate Truncation of Text in Table Cells
+
+| Common Name| Species| Genus| Family| Year Discovered
+| -| -|:-|-:|:-:
+| Tapanuli Orangutan| Pongo tapanuliensis| Pongo| Hominidae| 2017
+| Psychedelic Frogfish| Histiophryne psychedelica| Histiophryne| Antennariidae| 2009
+| Ruby Seadragon| Phyllopteryx dewysea| Phyllopteryx| Syngnathidae| 2015
+| Illacme tobini (Millipede)| Illacme tobini| Illacme| Siphonorhinidae| 2016
+| Spiny Dandelion| Taraxacum japonicum| Taraxacum| Asteraceae| 2022
+```
+```
+@import bats-document-configuration.md
+```opts :(document_opts)
+heading1_center: false
+screen_width: 60
+table_center: false
+```

data/docs/dev/table-indent.md

@@ -22,5 +22,6 @@ Centered columns.
 @import bats-document-configuration.md
 ```opts :(document_opts)
 heading1_center: false
+screen_width: 100
 table_center: false
 ```

data/examples/colors.md

@@ -33,6 +33,7 @@ menu_opts_color: fg_rgbh_1f_00_1f
 menu_opts_set_color: fg_rgbh_7f_00_1f
 menu_save_color: fg_rgbh_e0_e0_20
 menu_task_color: fg_rgbh_1f_1f_1f
+menu_ux_color: fg_rgbh_2f_c0_2f
 menu_vars_color: fg_rgbh_1f_a0_1f
 menu_vars_set_color: fg_rgbh_00_1f_1f
 output_execution_label_name_color: fg_rgbh_00_1f_00
@@ -60,6 +61,7 @@ menu_opts_set_color: fg_rgbh_7f_00_ff
 # menu_save_color: fg_rgbh_ea_ea_20
 menu_save_color: fg_rgbh_ff_ff_20
 menu_task_color: fg_rgbh_ff_ff_ff
+menu_ux_color: fg_rgbh_df_c0_df
 menu_vars_color: fg_rgbh_ff_a0_ff
 menu_vars_set_color: fg_rgbh_00_ff_ff
 output_execution_label_name_color: fg_rgbh_00_ff_00

data/lib/block_types.rb

@@ -14,6 +14,7 @@ class BlockType
     SAVE = 'save',
     SHELL = 'shell',
     TEXT = 'text',
+    UX = 'ux',
     VARS = 'vars',
     VIEW = 'view',
     YAML = 'yaml'

data/lib/constants.rb

@@ -27,12 +27,12 @@ BLOCK_TYPE_COLOR_OPTIONS = {
   BlockType::OPTS => :menu_opts_color,
   BlockType::SAVE => :menu_save_color,
   BlockType::SHELL => :menu_bash_color,
+  BlockType::UX => :menu_ux_color,
   BlockType::VARS => :menu_vars_color
 }.freeze
 
-
 COLLAPSIBLE_SYMBOL_COLLAPSED = '⬢' # '<+>' # '∆'
-COLLAPSIBLE_SYMBOL_EXPANDED = '⬡' # '< >' # '…' 
+COLLAPSIBLE_SYMBOL_EXPANDED = '⬡' # '< >' # '…'
 
 # in regexp (?<collapse>[+-~]?)
 COLLAPSIBLE_TOKEN_COLLAPSE = '+'

data/lib/evaluate_shell_expressions.rb

@@ -5,8 +5,12 @@
 
 require 'open3'
 
+class EvaluateShellExpression
+  StatusFail = :script_execution_failed unless const_defined?(:StatusFail)
+end
+
 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_required && (initial_code.nil? || initial_code.empty?)) ||
@@ -18,23 +22,26 @@ def evaluate_shell_expressions(initial_code, expressions, shell: '/bin/bash',
 
   # Construct a single shell script
   script = initial_code.dup
-  expressions.each_with_index do |(key, expression), index|
+  expressions.each_with_index do |(_key, expression), index|
     script << "\necho #{token}#{index}\n"
     script << expression << "\n"
   end
 
   # Execute
-  stdout_str, stderr_str, status = Open3.capture3(shell, "-c", script)
+  stdout_str, stderr_str, status = Open3.capture3(shell, '-c', script)
 
   unless status.success?
-    raise "Shell script execution failed: #{stderr_str}"
+    return EvaluateShellExpression::StatusFail
   end
 
   # Extract output for expressions
   result_hash = {}
-  stdout_str.split(/\n?#{token}\d+\n/)[1..-1].tap do |output_parts|
-    expressions.each_with_index do |(key, _expression), index|
-      result_hash[sprintf(key_format, key)] = output_parts[index].chomp
+  part = stdout_str.split(/\n?#{token}\d+\n/)
+  unless part.empty?
+    part[1..-1].tap do |output_parts|
+      expressions.each_with_index do |(key, _expression), index|
+        result_hash[format(key_format, key)] = output_parts[index].chomp
+      end
     end
   end
 
@@ -58,23 +65,23 @@ class TestShellExpressionEvaluator < Minitest::Test
   end
 
   def test_single_expression
-    expressions = { "greeting" => "echo 'Hello, World!'" }
+    expressions = { 'greeting' => "echo 'Hello, World!'" }
     result = evaluate_shell_expressions(@initial_code, expressions)
 
-    assert_equal "Hello, World!", result["%<greeting>"]
+    assert_equal 'Hello, World!', result['%<greeting>']
   end
 
   def test_multiple_expressions
     expressions = {
-      "greeting" => "echo 'Hello, World!'",
-      "date" => "date +%Y-%m-%d",
-      "kernel" => "uname -r"
+      'greeting' => "echo 'Hello, World!'",
+      'date' => 'date +%Y-%m-%d',
+      'kernel' => 'uname -r'
     }
     result = evaluate_shell_expressions(@initial_code, expressions)
 
-    assert_equal "Hello, World!", result["%<greeting>"]
-    assert_match /\d{4}-\d{2}-\d{2}/, result["%<date>"]
-    assert_match /\d+\.\d+\.\d+/, result["%<kernel>"]
+    assert_equal 'Hello, World!', result['%<greeting>']
+    assert_match(/\d{4}-\d{2}-\d{2}/, result['%<date>'])
+    assert_match(/\d+\.\d+\.\d+/, result['%<kernel>'])
   end
 
   def test_empty_expressions_list
@@ -85,13 +92,11 @@ class TestShellExpressionEvaluator < Minitest::Test
   end
 
   def test_invalid_expression
-    expressions = { "invalid" => "invalid_command" }
+    expressions = { 'invalid' => 'invalid_command' }
 
-    error = assert_raises(RuntimeError) do
-      evaluate_shell_expressions(@initial_code, expressions)
-    end
+    result = evaluate_shell_expressions(@initial_code, expressions)
 
-    assert_match /Shell script execution failed/, error.message
+    assert_equal EvaluateShellExpression::StatusFail, result
   end
 
   def test_initial_code_execution
@@ -99,17 +104,17 @@ class TestShellExpressionEvaluator < Minitest::Test
       #!/bin/sh
       echo "Custom setup message"
     BASH
-    expressions = { "test" => "echo Test after initial setup" }
+    expressions = { 'test' => 'echo Test after initial setup' }
 
     result = evaluate_shell_expressions(initial_code, expressions)
 
-    assert_equal "Test after initial setup", result["%<test>"]
+    assert_equal 'Test after initial setup', result['%<test>']
   end
 
   def test_large_number_of_expressions
-    expressions = (1..100).map { |i|
+    expressions = (1..100).map do |i|
       ["expr_#{i}", "echo Expression #{i}"]
-    }.to_h
+    end.to_h
 
     result = evaluate_shell_expressions(@initial_code, expressions)
 

data/lib/fcb.rb

@@ -5,6 +5,29 @@
 require 'digest'
 require_relative 'namer'
 
+def parse_yaml_of_ux_block(
+  data,
+  menu_format: nil,
+  prompt: nil,
+  validate: nil
+)
+  export = data['export']
+  export = data if export.nil?
+  name = export['name']
+  raise "Invalid data: #{data.inspect}" unless name.present?
+
+  OpenStruct.new(
+    allowed: export['allowed'],
+    default: export['default'],
+    exec: export['exec'],
+    menu_format: export['menu_format'] || menu_format,
+    name: name,
+    prompt: export['prompt'] || prompt,
+    transform: export['transform'],
+    validate: export['validate'] || validate
+  )
+end
+
 module MarkdownExec
   class Error < StandardError; end
 
@@ -106,12 +129,14 @@ module MarkdownExec
     # @return [Object] The modified functional code block with updated
     #  summary attributes.
     def for_menu!(
-      block_calls_scan: @delegate_object[:block_calls_scan],
-      block_name_match: @delegate_object[:block_name_match],
-      block_name_nick_match: @delegate_object[:block_name_nick_match],
-      id: ''
+      block_calls_scan:,
+      block_name_match:,
+      block_name_nick_match:,
+      id: '',
+      menu_format:,
+      prompt:,
+      table_center:
     )
-      # binding.irb
       call = @attrs[:call] = @attrs[:start_line]&.match(
         Regexp.new(block_calls_scan)
       )&.fetch(1, nil)
@@ -130,6 +155,23 @@ module MarkdownExec
               end
       @attrs[:title] = @attrs[:oname] = oname
       @attrs[:id] = id
+
+      if @attrs[:type] == BlockType::UX
+        case data = YAML.load(@attrs[:body].join("\n"))
+        when Hash
+          export = parse_yaml_of_ux_block(
+            data,
+            menu_format: menu_format,
+            prompt: prompt
+          )
+
+          @attrs[:center] = table_center
+          oname = @attrs[:oname] = format(export.menu_format, export.to_h)
+        else
+          raise "Invalid data type: #{data.inspect}"
+        end
+      end
+
       @attrs[:dname] = HashDelegator.indent_all_lines(
         (yield oname, BLOCK_TYPE_COLOR_OPTIONS[@attrs[:type]]),
         @attrs[:indent]

data/lib/format_table.rb

@@ -65,12 +65,15 @@ module MarkdownTableFormatter
 
   def format_cell(cell, align, width, truncate: true)
     plain_string = cell.gsub(/\033\[[\d;]+m|\033\[0m/, '')
+    exceeded = plain_string.length > width
     truncated = false
     ret = TrackedString.new(
       case
-      when truncate && plain_string.length > width
+      when truncate && exceeded
         truncated = true
-        plain_string[0, width]
+        plain_string[0, width] ### s/trim decorated text
+      when exceeded
+        cell
       when align == :center
         cell.center(width)
       when align == :right
@@ -79,6 +82,7 @@ module MarkdownTableFormatter
         cell.ljust(width)
       end
     )
+    ret.exceeded = exceeded
     ret.truncated = truncated
     ret
   end
@@ -152,11 +156,8 @@ module MarkdownTableFormatter
     alignment_indicators, column_widths =
       calculate_column_alignment_and_widths(rows, column_count)
 
-    # ww0 'table_width', table_width
-    # ww0 'truncate', truncate
-
     unless table_width.nil?
-      sum_column_widths = column_widths.sum
+      sum_column_widths = column_widths.sum + ((column_count * 3) + 5)
       if sum_column_widths > table_width
         ratio = table_width.to_f / sum_column_widths
         column_widths.each_with_index do |width, i|
@@ -168,7 +169,7 @@ module MarkdownTableFormatter
     format_rows__hs(
       rows, alignment_indicators, column_widths, decorate,
       truncate: truncate
-    ).tap { |ret| binding.irb if ret.class == TrackedString }
+    )
   end
 
   def insert_every_other(array, obj)

data/lib/hash_delegator.rb

@@ -92,6 +92,10 @@ module HashDelegatorSelf
     blocks.find { |item| item.send(msg) == value } || default
   end
 
+  def block_match(blocks, msg, value, default = nil)
+    blocks.select { |item| value =~ item.send(msg) }
+  end
+
   def block_select(blocks, msg, value, default = nil)
     blocks.select { |item| item.send(msg) == value }
   end
@@ -297,14 +301,16 @@ module HashDelegatorSelf
         truncate: $table_cell_truncate
       )
 
-      truncated_table_cell = false
+      exceeded_table_cell = false # any cell in table is exceeded
+      truncated_table_cell = false # any cell in table is truncated
       table__hs.each do |table_hs|
         table_hs.substrings.each do |substrings|
           substrings.each do |node|
-            if node[:text].class == TrackedString
-              truncated_table_cell = node[:text].truncated
-              break if truncated_table_cell
-            end
+            next unless node[:text].class == TrackedString
+
+            exceeded_table_cell ||= node[:text].exceeded
+            truncated_table_cell = node[:text].truncated
+            break if truncated_table_cell
           end
           break if truncated_table_cell
         end
@@ -337,9 +343,9 @@ module HashDelegatorSelf
 
         if ind.zero?
           fcb.truncated_table_cell = truncated_table_cell
-          # if truncated_table_cell
-          fcb.delete_key(:disabled)
-          # end
+          if exceeded_table_cell
+            fcb.delete_key(:disabled)
+          end
         end
       end
     end
@@ -588,6 +594,7 @@ module MarkdownExec
       @prompt = HashDelegator.tty_prompt_without_disabled_symbol
 
       @opts_most_recent_filename = nil
+      @ux_most_recent_filename = nil
       @vars_most_recent_filename = nil
       @pass_args = []
       @run_state = OpenStruct.new(
@@ -865,7 +872,6 @@ module MarkdownExec
       blocks = []
       iter_blocks_from_nested_files do |btype, fcb|
         count += 1
-
         case btype
         when :blocks
           if @delegate_object[:bash]
@@ -873,7 +879,10 @@ module MarkdownExec
               block_calls_scan: @delegate_object[:block_calls_scan],
               block_name_match: @delegate_object[:block_name_match],
               block_name_nick_match: @delegate_object[:block_name_nick_match],
-              id: "#{source_id}_bfnf_b_#{count}"
+              id: "#{source_id}_bfnf_b_#{count}",
+              menu_format: @delegate_object[:menu_ux_row_format],
+              prompt: @delegate_object[:prompt_ux_enter_a_value],
+              table_center: @delegate_object[:table_center]
             ) do |oname, color|
               apply_block_type_color_option(oname, color)
             end
@@ -935,7 +944,7 @@ module MarkdownExec
         (link_state&.inherited_lines_block || ''), commands,
         initial_code_required: initial_code_required,
         key_format: key_format
-      ) # !!t
+      )
     end
 
     def calc_logged_stdout_filename(block_name:)
@@ -1008,6 +1017,135 @@ module MarkdownExec
       ]
     end
 
+    def neval(export_exec, inherited_code)
+      # ww0 export_exec
+      # ww0 inherited_code
+      code = (inherited_code || []) + [export_exec]
+      filespec = generate_temp_filename
+      File.write filespec, HashDelegator.join_code_lines(code)
+      File.chmod 0o755, filespec
+      # ww0 File.read(filespec)
+      ret = `#{filespec}`
+      File.delete filespec
+      ret
+    end
+
+    # sets ENV
+    def code_from_ux_block_to_set_environment_variables(
+      selected, mdoc, inherited_code: nil, force: true, only_default: false
+    )
+      # ww0 inherited_code
+      # ww0 mdoc
+      exit_prompt = @delegate_object[:prompt_filespec_back]
+
+      required = mdoc.collect_recursively_required_code(
+        anyname: selected.pub_name,
+        label_format_above: @delegate_object[:shell_code_label_format_above],
+        label_format_below: @delegate_object[:shell_code_label_format_below],
+        block_source: block_source
+      )
+
+      code_lines = []
+      case data = YAML.load(selected.body.join("\n"))
+      when Hash
+        export = parse_yaml_of_ux_block(
+          data,
+          prompt: @delegate_object[:prompt_ux_enter_a_value],
+          validate: '^(?<name>[^ ].*)$'
+        )
+
+        exportable = true
+        if only_default
+          value = case export.default
+                  # exec > default
+                  when :exec
+                    raise unless export.exec.present?
+
+                    n1 = neval(export.exec, (inherited_code || []) + required[:code])
+
+                    if export.transform.present?
+                      if export.transform.is_a? Symbol
+                        n1.send(export.transform)
+                      else
+                        format(
+                          export.transform,
+                          NamedCaptureExtractor.extract_named_groups(
+                            n1, export.validate
+                          )
+                        )
+                      end
+                    else
+                      n1
+                    end
+
+                  # default
+                  else
+                    export.default.to_s
+                  end
+        else
+          caps = nil
+          value = nil
+
+          # exec > allowed
+          if export.exec
+            value = neval(export.exec, (inherited_code || []) + required[:code])
+            caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                              export.validate)
+
+          # allowed > prompt
+          elsif export.allowed && export.allowed.count.positive?
+            case (choice = prompt_select_code_filename(
+              [exit_prompt] + export.allowed,
+              string: export.prompt,
+              color_sym: :prompt_color_after_script_execution
+            ))
+            when exit_prompt
+              exportable = false
+            else
+              value = choice
+              caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                                export.validate)
+            end
+
+          # prompt > default
+          elsif export.prompt.present?
+            begin
+              while true
+                print "#{export.prompt} [#{export.default}]: "
+                value = gets.chomp
+                value = export.default.to_s if value.empty?
+                caps = NamedCaptureExtractor.extract_named_groups(value,
+                                                                  export.validate)
+                break if caps
+
+                # invalid input, retry
+
+              end
+            rescue Interrupt
+              exportable = false
+            end
+
+          # default
+          else
+            value = export.default
+          end
+
+          if exportable && export.transform.present?
+            value = format(export.transform, caps)
+          end
+        end
+
+        if exportable
+          ENV[export.name] = value.to_s
+          code_lines.push code_line_safe_assign(export.name, value,
+                                                force: force)
+        end
+      else
+        raise "Invalid data type: #{data.inspect}"
+      end
+      code_lines
+    end
+
     # sets ENV
     def code_from_vars_block_to_set_environment_variables(selected)
       code_lines = []
@@ -1027,6 +1165,15 @@ module MarkdownExec
       code_lines
     end
 
+    def code_line_safe_assign(name, value, force:)
+      if force
+# ww0 value
+        "#{name}=#{Shellwords.escape(value)}"
+      else
+        "[[ -z $#{name} ]] && #{name}=#{Shellwords.escape(value)}"
+      end
+    end
+
     def collect_line_decor_patterns(delegate_object)
       extract_patterns = lambda do |key|
         return [] unless delegate_object[key].present?
@@ -1412,7 +1559,7 @@ module MarkdownExec
                         @delegate_object[criteria[:color]].to_sym,
           decor_patterns:
             @decor_patterns_from_delegate_object_for_block_create,
-          disabled: fcb.truncated_table_cell.nil? && !(criteria[:collapsible] && @delegate_object[criteria[:collapsible]]),
+          disabled: !(criteria[:collapsible] && @delegate_object[criteria[:collapsible]]),
           fcb: fcb,
           id: "#{id}.#{index}",
           format_option: criteria[:format] &&
@@ -1790,6 +1937,18 @@ module MarkdownExec
         )
         next_state_set_code(selected, link_state, required_lines)
 
+      elsif selected.type == BlockType::UX
+        debounce_reset
+        next_state_append_code(
+          selected,
+          link_state,
+          code_from_ux_block_to_set_environment_variables(
+            selected,
+            @dml_mdoc,
+            inherited_code: @dml_link_state.inherited_lines
+          )
+        )
+
       elsif selected.type == BlockType::VARS
         debounce_reset
         next_state_append_code(selected, link_state,
@@ -2296,7 +2455,7 @@ module MarkdownExec
 
       variable_counts = count_named_group_occurrences(blocks, pattern,
                                                       group_name: group_name)
-      return if variable_counts.nil?
+      return if variable_counts.nil? || variable_counts == {}
 
       echo_commands = generate_echo_commands(variable_counts, echo_format)
 
@@ -2307,6 +2466,7 @@ module MarkdownExec
       )
 
       return if replacements.nil?
+      return if replacements == EvaluateShellExpression::StatusFail
 
       expand_blocks_with_replacements(blocks, replacements)
     end
@@ -2723,6 +2883,37 @@ module MarkdownExec
       true
     end
 
+    def load_auto_ux_block(
+      all_blocks,
+      mdoc,
+      block_name: @delegate_object[:document_load_ux_block_name]
+    )
+      unless block_name.present? &&
+             @ux_most_recent_filename != @delegate_object[:filename]
+        return
+      end
+
+      blocks = HashDelegator.block_select(all_blocks, :oname, block_name)
+      if blocks.empty?
+        blocks = HashDelegator.block_match(all_blocks, :nickname,
+                                           Regexp.new(block_name))
+      end
+      return if blocks.empty?
+
+      @ux_most_recent_filename = @delegate_object[:filename]
+
+      (blocks.each.with_object([]) do |block, merged_options|
+        merged_options.push(
+          code_from_ux_block_to_set_environment_variables(
+            block,
+            mdoc,
+            force: @delegate_object[:ux_auto_load_force_default],
+            only_default: true
+          )
+        )
+      end).to_a
+    end
+
     def load_auto_vars_block(all_blocks,
                              block_name: @delegate_object[:document_load_vars_block_name])
       unless block_name.present? &&
@@ -2871,6 +3062,16 @@ module MarkdownExec
         reload_blocks = true
       end
 
+      # load document ux block
+      #
+      if code_lines = load_auto_ux_block(all_blocks, mdoc)
+        new_code = HashDelegator.code_merge(link_state.inherited_lines,
+                                            code_lines)
+        next_state_set_code(nil, link_state, new_code)
+        link_state.inherited_lines = new_code
+        reload_blocks = true
+      end
+
       # load document vars block
       #
       if code_lines = load_auto_vars_block(all_blocks)
@@ -2924,7 +3125,6 @@ module MarkdownExec
       HashDelegator.tables_into_columns!(menu_blocks, @delegate_object,
                                          screen_width_for_table)
 
-
       [all_blocks, menu_blocks, mdoc]
     end
 
@@ -2988,7 +3188,6 @@ module MarkdownExec
     def menu_toggle_collapsible_block(selected)
       # return true if @compress_ids.key?(fcb.id) && !!@compress_ids[fcb.id]
       # return false if @expand_ids.key?(fcb.id) && !!@expand_ids[fcb.id]
-      # binding.irb
       if @compressed_ids.key?(selected.id) && !!@compressed_ids[selected.id]
         @compressed_ids.delete(selected.id)
         @expanded_ids[selected.id] = selected.level
@@ -3705,15 +3904,17 @@ module MarkdownExec
     end
 
     def screen_width
-      if @delegate_object[:screen_width] && @delegate_object[:screen_width].positive?
-        @delegate_object[:screen_width]
+      width = @delegate_object[:screen_width]
+      if width && width.positive?
+        width
       else
         @delegate_object[:console_width]
       end
     end
 
     def screen_width_for_table
-      screen_width - prompt_margin_left_width - prompt_margin_right_width - 2 # prompt is symbol + space (width: 2)
+      # menu adds newline after some lines if sized to the edge
+      screen_width - prompt_margin_left_width - prompt_margin_right_width - 3 # menu prompt symbol (1) + space (1) + gap (1)
     end
 
     def screen_width_for_wrapping

data/lib/hierarchy_string.rb

@@ -3,10 +3,11 @@
 require_relative 'ansi_string'
 
 class TrackedString < String
-  attr_accessor :truncated
+  attr_accessor :exceeded, :truncated
 
   def initialize(str)
-    super(str)
+    super
+    @exceeded = false
     @truncated = false
   end
 end

data/lib/markdown_exec/version.rb

@@ -7,5 +7,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '2.7.4'
+  VERSION = '2.8.0'
 end

data/lib/markdown_exec.rb

@@ -256,7 +256,7 @@ module MarkdownExec
                         block_name_nick_match)
       return unless line.match(fenced_start_and_end_regex)
 
-      bm = NamedCaptureExtractor::extract_named_groups(line, block_name_match)
+      bm = NamedCaptureExtractor.extract_named_groups(line, block_name_match)
       return if bm.nil?
 
       name = bm[:title]
@@ -282,7 +282,6 @@ module MarkdownExec
     include StringUtil
 
     def initialize(options = {})
-      # ww0 'options', options, caller.deref
       @option_parser = nil
 
       @options = HashDelegator.new(options)
@@ -405,7 +404,7 @@ module MarkdownExec
     ## Executes the block specified in the options
     #
     def execute_block_with_error_handling
-      @options.register_console_attributes(@options)    
+      @options.register_console_attributes(@options)
       finalize_cli_argument_processing
       execute_initial_commands_and_main_loop(@options, @options.run_state)
     rescue FileMissingError
@@ -430,11 +429,9 @@ module MarkdownExec
     def execute_simple_commands(options, stage: nil)
       # !!p stage
       simple_commands(options).each do |key, (cstage, proc)|
-        if @options[key].is_a?(TrueClass) || @options[key].present?
-          if stage && stage == cstage
-            proc.call
-            return true
-          end
+        if (@options[key].is_a?(TrueClass) || @options[key].present?) && (stage && stage == cstage)
+          proc.call
+          return true
         end
       end
       false

data/lib/mdoc.rb

@@ -142,6 +142,7 @@ module MarkdownExec
                 fcb.body # entire body is returned to requesing block
               elsif [BlockType::LINK,
                      BlockType::LOAD,
+                     BlockType::UX,
                      BlockType::VARS].include? fcb.type
                 nil
               elsif fcb[:chrome] # for Link blocks like History

data/lib/menu.src.yml

@@ -206,6 +206,12 @@
   :default: "(document_shell)"
   :procname: val_as_str
 
+- :opt_name: document_load_ux_block_name
+  :env_var: MDE_DOCUMENT_LOAD_UX_BLOCK_NAME
+  :description: Name of UX block to load with the document
+  :default: "\\[.*document_ux.*\\]"
+  :procname: val_as_str
+
 - :opt_name: document_load_vars_block_name
   :env_var: MDE_DOCUMENT_LOAD_VARS_BLOCK_NAME
   :description: Name of Vars block to load with the document
@@ -1026,6 +1032,18 @@
   :default: ">"
   :procname: val_as_str
 
+- :opt_name: menu_ux_color
+  :env_var: MDE_MENU_UX_COLOR
+  :description: Color of menu ux
+  :default: fg_rgbh_df_c0_df
+  :procname: val_as_str
+
+- :opt_name: menu_ux_row_format
+  :env_var: MDE_MENU_UX_ROW_FORMAT
+  :description: Format for UX row
+  :default: '%{name}=${%{name}}'
+  :procname: val_as_str
+
 - :opt_name: menu_vars_color
   :env_var: MDE_MENU_VARS_COLOR
   :description: Color of menu vars
@@ -1315,6 +1333,12 @@
   :description: Prompt to select a saved file
   :procname: val_as_str
 
+- :opt_name: prompt_ux_enter_a_value
+  :env_var: MDE_PROMPT_UX_ENTER_A_VALUE
+  :description: Prompt to enter a value for UX blocks
+  :default: "\nEnter a value:"
+  :procname: val_as_str
+
 - :opt_name: prompt_show_expr_format
   :env_var: MDE_PROMPT_SHOW_EXPR_FORMAT
   :description: prompt_show_expr_format
@@ -1630,6 +1654,12 @@
   :default: false
   :procname: val_as_bool
 
+- :opt_name: ux_auto_load_force_default
+  :env_var: MDE_UX_AUTO_LOAD_FORCE_DEFAULT
+  :arg_name: BOOL
+  :default: true
+  :procname: val_as_bool
+
 - :opt_name: variable_expression_regexp
   :env_var: MDE_VARIABLE_EXPRESSION_REGEXP
   :description: variable_expression_regexp

data/lib/menu.yml

@@ -171,6 +171,11 @@
   :description: Name of shell block to load with the document
   :default: "(document_shell)"
   :procname: val_as_str
+- :opt_name: document_load_ux_block_name
+  :env_var: MDE_DOCUMENT_LOAD_UX_BLOCK_NAME
+  :description: Name of UX block to load with the document
+  :default: "\\[.*document_ux.*\\]"
+  :procname: val_as_str
 - :opt_name: document_load_vars_block_name
   :env_var: MDE_DOCUMENT_LOAD_VARS_BLOCK_NAME
   :description: Name of Vars block to load with the document
@@ -864,6 +869,16 @@
   :description: Symbol before each task
   :default: ">"
   :procname: val_as_str
+- :opt_name: menu_ux_color
+  :env_var: MDE_MENU_UX_COLOR
+  :description: Color of menu ux
+  :default: fg_rgbh_df_c0_df
+  :procname: val_as_str
+- :opt_name: menu_ux_row_format
+  :env_var: MDE_MENU_UX_ROW_FORMAT
+  :description: Format for UX row
+  :default: "%{name}=${%{name}}"
+  :procname: val_as_str
 - :opt_name: menu_vars_color
   :env_var: MDE_MENU_VARS_COLOR
   :description: Color of menu vars
@@ -1123,6 +1138,13 @@
     Choose a file:
   :description: Prompt to select a saved file
   :procname: val_as_str
+- :opt_name: prompt_ux_enter_a_value
+  :env_var: MDE_PROMPT_UX_ENTER_A_VALUE
+  :description: Prompt to enter a value for UX blocks
+  :default: |2-
+
+    Enter a value:
+  :procname: val_as_str
 - :opt_name: prompt_show_expr_format
   :env_var: MDE_PROMPT_SHOW_EXPR_FORMAT
   :description: prompt_show_expr_format
@@ -1391,6 +1413,11 @@
   :arg_name: BOOL
   :default: false
   :procname: val_as_bool
+- :opt_name: ux_auto_load_force_default
+  :env_var: MDE_UX_AUTO_LOAD_FORCE_DEFAULT
+  :arg_name: BOOL
+  :default: true
+  :procname: val_as_bool
 - :opt_name: variable_expression_regexp
   :env_var: MDE_VARIABLE_EXPRESSION_REGEXP
   :description: variable_expression_regexp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.7.4
+  version: 2.8.0
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -124,6 +124,7 @@ files:
 - bats/options.bats
 - bats/plain.bats
 - bats/publish.bats
+- bats/table-column-truncate.bats
 - bats/table.bats
 - bats/test_helper.bash
 - bats/variable-expansion.bats
@@ -159,6 +160,7 @@ files:
 - docs/dev/screen-width.md
 - docs/dev/specs-import.md
 - docs/dev/specs.md
+- docs/dev/table-column-truncate.md
 - docs/dev/table-indent.md
 - docs/dev/table-invalid.md
 - docs/dev/text-decoration.md