markdown_exec 3.0.3 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aca4576a97f3d528e52f331941144d91970a5dd6477d60a6270de464e47475cb
-  data.tar.gz: 2c16498793d375c37d4b07c55500e76b63f1ab9dd37cdbbc83dedbeced288d5c
+  metadata.gz: e3f36dcdba359857aa80f8888d8eaf61e5d2675952a5809341bd993cf30c9ef1
+  data.tar.gz: cc753bd25f2b229b6c3d7bab99249c2b6786e4b3efa3ca56c098ff4838f9ad78
 SHA512:
-  metadata.gz: d90b01f7fa224697dc393a70fea22cd3083a200e32f52d9bead14e08d83a45d86d2ed00d5a90995c14401a28b850fb92ca0fb2682e91977671cd393924635ce5
-  data.tar.gz: 7272c814fe69625754c7e6c0dcddd2bd21d602636eb089593080f4f26ae0863cbe2915fcfa470058677420781a8d57f13a7e5f52348bcf280738779238871197
+  metadata.gz: f982dcfa66c59168f8cdf6b1d9d5fc9af2b946f8d9dc42b4d8af9061bb94758784916f1d2afafe7bb215f60d8588900aff43132a8418199f19abbb1b033087cc
+  data.tar.gz: a7219bde3d387303ca86ea096dc9fbcb059c028c74d9bff1696d9f6bb2d8b77715e9080aec424e4ea35a53462fe895ea6210e930ab6d6a1129172fd95f6a9312

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [3.0.5] - 2025-05-23
+
+### Changed
+
+- Values for UX echo are validated and transformed.
+
+## [3.0.4] - 2025-05-28
+
+### Changed
+
+- Apply shell option when not specified for a block.
+
 ## [3.0.3] - 2025-05-23
 
 ### Changed

data/Gemfile.lock

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

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Each key in the echo hash is processed.' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-echo-hash-transform.md \
+   'Tapanuli Orangutan_Species: PONGO TAPANULIENSIS_Genus: PONGO_Tapanuli Orangutan_Family: H:Hominidae_Order: P:Primates'
+}

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

@@ -10,7 +10,8 @@ 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_VAR=markdown_exec_IAB='
+   'VAR=markdown_exec_IAB='
+   # 'VAR=markdown_exec_VAR=markdown_exec_IAB='
 }
 
 @test 'selected block - output of wc includes whitespace' {

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

@@ -0,0 +1,40 @@
+/ Each key in the echo hash is processed.
+/
+/ Each value is transformed.
+```ux
+echo:
+  Species: Pongo tapanuliensis
+  Genus: Pongo
+format: Tapanuli Orangutan
+name: Species
+transform: :upcase
+```
+Species: ${Species}
+Genus: ${Genus}
+/
+/ Each value is validated and transformed.
+```ux
+echo:
+  Family: Hominidae
+  Order: Primates
+format: Tapanuli Orangutan
+name: Family
+transform: '%{capital}:%{name}'
+validate: >
+  ^(?<name>(?<capital>.?).*)$
+```
+Family: ${Family}
+Order: ${Order}
+//
+// Each key in the exec hash is processed.
+/```ux
+/exec:
+/  Species2: printf %s 'Histiophryne psychedelica'
+/  Genus2: printf %s 'Histiophryne'
+/format: Psychedelic Frogfish
+/name: Species2
+/transform: :downcase
+/```
+/Species2: ${Species2}
+/Genus2: ${Genus2}
+@import bats-document-configuration.md

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

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

data/lib/hash_delegator.rb

@@ -1094,17 +1094,18 @@ module MarkdownExec
       @ux_most_recent_filename = @delegate_object[:filename]
 
       (blocks.each.with_object([]) do |block, merged_options|
-        command_result_w_e_t_nl = code_from_ux_block_to_set_environment_variables(
-          block,
-          mdoc,
-          force: @delegate_object[:ux_auto_load_force_default],
-          only_default: true,
-          silent: true
-        )
+        command_result_w_e_t_nl =
+          code_from_ux_block_to_set_environment_variables(
+            block,
+            mdoc,
+            force: @delegate_object[:ux_auto_load_force_default],
+            only_default: true,
+            silent: true
+          )
         if command_result_w_e_t_nl.failure?
           merged_options
         else
-          merged_options.push(command_result_w_e_t_nl.stdout)
+          merged_options.push(command_result_w_e_t_nl.new_lines)
         end
       end).to_a
     end
@@ -1115,6 +1116,7 @@ module MarkdownExec
       selected, mdoc, inherited_code: nil, force: true, only_default: false,
       silent:
     )
+      ret_command_result = nil
       exit_prompt = @delegate_object[:prompt_filespec_back]
 
       required = mdoc.collect_recursively_required_code(
@@ -1169,7 +1171,20 @@ module MarkdownExec
           end
           return command_result_w_e_t_nl if command_result_w_e_t_nl.failure?
 
+          command_result_w_e_t_nl.new_lines =
+            command_result_w_e_t_nl.new_lines.map do |name_force|
+              transformed = if command_result_w_e_t_nl.transformable
+                              transform_export_value(name_force[:text], export)
+                            else
+                              name_force[:text]
+                            end
+              ENV[name_force[:name]] = transformed
+              code_line_safe_assign(
+                name_force[:name], transformed, force: name_force[:force]
+              )
+            end
           required_lines.concat(command_result_w_e_t_nl.new_lines)
+
           if SelectResponse.continue?(command_result_w_e_t_nl.stdout)
             if command_result_w_e_t_nl.transformable
               command_result_w_e_t_nl.stdout = transform_export_value(
@@ -1179,16 +1194,18 @@ module MarkdownExec
 
             if command_result_w_e_t_nl.exportable
               ENV[export.name] = command_result_w_e_t_nl.stdout.to_s
-              required_lines.push code_line_safe_assign(export.name, command_result_w_e_t_nl.stdout,
-                                                        force: force)
+              required_lines.push code_line_safe_assign(
+                export.name, command_result_w_e_t_nl.stdout, force: force
+              )
             end
           end
+          ret_command_result = command_result_w_e_t_nl
         else
           raise "Invalid data type: #{data.inspect}"
         end
       end
 
-      CommandResult.new(stdout: required_lines)
+      ret_command_result || CommandResult.new(stdout: required_lines)
     end
 
     # sets ENV
@@ -1377,11 +1394,13 @@ module MarkdownExec
                         end
 
       if allow_execution
-        execute_required_lines(blockname: selected.pub_name,
-                               erls: { play_bin: play_bin,
-                                       shell: selected.shell },
-                               required_lines: required_lines,
-                               shell: selected.shell)
+        execute_required_lines(
+          blockname: selected.pub_name,
+          erls: { play_bin: play_bin,
+                  shell: selected_shell(selected.shell) },
+          required_lines: required_lines,
+          shell: selected_shell(selected.shell)
+        )
       end
 
       link_state.block_name = nil
@@ -1694,6 +1713,10 @@ module MarkdownExec
       @prior_execution_block = nil
     end
 
+    def selected_shell(shell_name)
+      shell_name.empty? ? shell : shell_name
+    end
+
     # Determines the state of a selected block in the menu based
     #  on the selected option.
     # It categorizes the selected option into either EXIT, BACK,
@@ -2490,7 +2513,7 @@ module MarkdownExec
       if @delegate_object[:save_executed_script]
         write_command_file(blockname: blockname,
                            required_lines: required_lines,
-                           shell: shell)
+                           shell: selected_shell(shell))
       end
       if @dml_block_state
         calc_logged_stdout_filename(block_name: @dml_block_state.block.oname)
@@ -2498,7 +2521,7 @@ module MarkdownExec
       format_and_execute_command(
         code_lines: required_lines,
         erls: erls,
-        shell: shell
+        shell: selected_shell(shell)
       )
       post_execution_process
     end
@@ -2615,8 +2638,8 @@ module MarkdownExec
             command_result.warning = warning_required_empty(export) unless silent
           else
             ENV[name] = command_result.stdout.to_s
-            new_lines << code_line_safe_assign(name, command_result.stdout,
-                                               force: force)
+            new_lines << { name: name, force: force,
+                           text: command_result.stdout }
           end
         end
 
@@ -2705,7 +2728,7 @@ module MarkdownExec
         formatted_command,
         args: @pass_args,
         erls: erls,
-        shell: shell
+        shell: selected_shell(shell)
       )
       @fout.fout fetch_color(data_sym: :script_execution_tail,
                              color_sym: :script_execution_frame_color)
@@ -2968,8 +2991,8 @@ module MarkdownExec
       else
         iter_blocks_from_nested_files do |btype, fcb|
           case btype
-          when :blocks; yield fcb
-          when :filter; %i[blocks]
+          when :blocks then yield fcb
+          when :filter then %i[blocks]
           end
         end
       end
@@ -3138,9 +3161,9 @@ module MarkdownExec
                                                    opts_block_name)
       return if selected_blocks.empty?
 
-      dependency_map = selected_blocks.map do |block|
+      dependency_map = selected_blocks.to_h do |block|
         [block.id, block.reqs]
-      end.to_h
+      end
 
       selected_blocks.each do |block|
         mdoc.collect_dependencies(memo: dependency_map, block: block)
@@ -3576,7 +3599,7 @@ module MarkdownExec
             bash_script_lines
           )
         )
-        temp_file.close  # Close the file before chmod and execution
+        temp_file.close # Close the file before chmod and execution
         File.chmod(0o755, temp_file.path)
 
         if @delegate_object[:archive_ad_hoc_scripts]
@@ -3587,8 +3610,7 @@ module MarkdownExec
           `cp #{temp_file.path} #{archive_filename}`
         end
 
-        output = `bash #{temp_file.path}`
-        #### use shell per configuration
+        output = `#{shell} #{temp_file.path}`
 
         CommandResult.new(stdout: output, exit_status: $?.exitstatus)
       end
@@ -3868,7 +3890,7 @@ module MarkdownExec
       elsif sel == MenuOptions::SAVE_SCRIPT
         save_to_file(
           required_lines: required_lines, selected: selected,
-          shell: selected.shell
+          shell: selected_shell(selected.shell)
         )
       end
 
@@ -4204,7 +4226,7 @@ module MarkdownExec
       required_lines:, selected:, shell:
     )
       write_command_file(
-        required_lines: required_lines, blockname: selected.pub_name, shell: shell
+        required_lines: required_lines, blockname: selected.pub_name, shell: selected_shell(shell)
       )
       @fout.fout "File saved: #{@run_state.saved_filespec}"
     end
@@ -4215,7 +4237,7 @@ module MarkdownExec
         saved_asset_format:
           shell_escape_asset_format(
             code_lines: link_state&.inherited_lines,
-            shell: shell
+            shell: selected_shell(shell)
           )
       ).generate_name
     end
@@ -4390,7 +4412,6 @@ module MarkdownExec
       marker = Random.new.rand.to_s
 
       code = (code_lines || []) + ["echo -n \"#{marker}#{raw}\""]
-      # !!t code
       File.write filespec, HashDelegator.join_code_lines(code)
       File.chmod 0o755, filespec
 
@@ -4501,6 +4522,7 @@ module MarkdownExec
       return value unless export.transform.present?
 
       if export.transform.is_a? Symbol
+        ### TBD validate for symbol
         value.send(export.transform)
       else
         format(
@@ -4607,7 +4629,7 @@ module MarkdownExec
       new_lines = []
       command_result = nil
 
-      case as = FCB.act_source(export)
+      case FCB.act_source(export)
       when false, UxActSource::FALSE
         raise 'Should not be reached.'
 

data/lib/markdown_exec/version.rb

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

data/lib/mdoc.rb

@@ -469,6 +469,9 @@ module MarkdownExec
       else
         blocks = [block]
       end
+      blocks.each do |block|
+        memo[block.id] = []
+      end
       return memo unless blocks.count.positive?
 
       required_blocks = blocks.map(&:reqs).flatten(1)
@@ -542,11 +545,11 @@ if $PROGRAM_NAME == __FILE__
       end if false
 
       def test_collect_dependencies_with_valid_source
-        @mdoc.stubs(:get_block_by_anyname)
-             .with('source1').returns(OpenStruct.new(id: 'source1',
-                                                     reqs: ['source2']))
-        @mdoc.stubs(:get_block_by_anyname)
-             .with('source2').returns(OpenStruct.new(id: 'source2', reqs: []))
+        @mdoc.stubs(:get_blocks_by_anyname)
+             .with('source1').returns([OpenStruct.new(id: 'source1',
+                                                      reqs: ['source2'])])
+        @mdoc.stubs(:get_blocks_by_anyname)
+             .with('source2').returns([OpenStruct.new(id: 'source2', reqs: [])])
 
         expected = { 'source1' => ['source2'], 'source2' => [] }
         assert_equal expected, @mdoc.collect_dependencies(pubname: 'source1')
@@ -627,7 +630,7 @@ if $PROGRAM_NAME == __FILE__
         result = @doc.recursively_required_hash('block3')
         assert_equal ({ 'block3' => ['block1'],
                         'block1' => ['block2'],
-                        'block2' => nil }),
+                        'block2' => [nil] }),
                      result
 
         result_no_reqs = @doc.recursively_required_hash(nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.5
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-23 00:00:00.000000000 Z
+date: 2025-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -116,6 +116,7 @@ files:
 - bats/block-type-ux-auto.bats
 - bats/block-type-ux-chained.bats
 - bats/block-type-ux-default.bats
+- bats/block-type-ux-echo-hash-transform.bats
 - bats/block-type-ux-echo-hash.bats
 - bats/block-type-ux-echo.bats
 - bats/block-type-ux-exec.bats
@@ -168,6 +169,7 @@ files:
 - docs/dev/block-type-ux-auto.md
 - docs/dev/block-type-ux-chained.md
 - docs/dev/block-type-ux-default.md
+- docs/dev/block-type-ux-echo-hash-transform.md
 - docs/dev/block-type-ux-echo-hash.md
 - docs/dev/block-type-ux-echo.md
 - docs/dev/block-type-ux-exec.md