markdown_exec 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fce77c3fa5686b583f500f1f5afafcb21903c323dcb5466662130e240581957
-  data.tar.gz: 0cb414335a8df51349d7fac27da3ab7d1b79af81af8f104605d1c2158b8067cc
+  metadata.gz: 7e95733b82149c0ae79c429132f53373975961457c9fc6dd6b5f4feed5618d63
+  data.tar.gz: bfc880428a6cb6e3f58f3248972fffdbe2a51449c3e12ee1b4542aee0148fa29
 SHA512:
-  metadata.gz: ef7aed19a54e257e07dee6d7b9cef11062c68fb35aad42bcba9a33584086eb7b1016523dc013bb2bc88c34d0349190d4f9ca9b2e524daf086e4eae4bbf8b4d5b
-  data.tar.gz: '08530d2e5f303fd6743dcbf9aaec45f375c91e4895541e4a466621401c4147954c498c4c72c570b1e2a34faee9bcfa58fe1434708c44b55f749fff854a54f4dd'
+  metadata.gz: d24fdac6f00933c9796fe8225c81d35745d2275055b8963b565955a4a9a581e232ddc99e67999e8b00053ecb573ae4e24be8875506d6257b645d4eea74661b40
+  data.tar.gz: 10423e9faec308472a9678b7726c78c5b0be55a702c866e6b4cbe722f6aa6f69cae80ed9a30857f08c60dae792fc70062ebb7a16fd3728d0bc289b9487bc3a98

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [3.0.2] - 2025-05-21
+
+### Added
+
+- Options to permit the archiving of ad-hoc shell scripts.
+
+### Changed
+
+- Force use of Bash shell for ad-hoc shell scripts.
+
+## [3.0.1] - 2025-05-21
+
+### Changed
+
+- Block ids to reflect source file when imported.
+- Disable UX block warnings for initial values.
+
 ## [3.0.0] - 2025-05-20
 
 ### Added

data/Gemfile.lock

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

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

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'automatic block is invalid YAML' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-invalid.md \
-   '_Error: HashDelegator../docs/dev/block-type-ux-invalid.md¤ItrBlkFrmNstFls:1 - --- !ruby/object:NullResult_message: Invalid YAML_data: invalid_ --  -- '
+   '_Error: HashDelegator.ItrBlkFrmNstFls:1¤./docs/dev/block-type-ux-invalid.md:1 - --- !ruby/object:NullResult_message: Invalid YAML_data: invalid_ --  -- '
 }

data/bats/block-type-ux-required-variables.bats

@@ -2,7 +2,19 @@
 
 load 'test_helper'
 
-@test 'An undefined variable is a precondition' {
+@test 'An undefined variable is a precondition - initial' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-required-variables.md \
-   'A value must exist for: MISSING_VARIABLE_SPECIES='
+   'SPECIES='
 }
+
+# hangs
+# Enter a value: []: #<Errno::EISDIR: Is a directory @ io_fillbuf - fd:12 test>
+# ["/Users/fareed/Documents/dev/ruby/markdown_exec/lib/hash_delegator.rb:4650:in `gets'",
+#  "/Users/fareed/Documents/dev/ruby/markdown_exec/lib/hash_delegator.rb:4650:in `gets'",
+#  "/Users/fareed/Documents/dev/ruby/markdown_exec/lib/hash_delegator.rb:4650:in `block in ux_block_export_activated'",
+#
+#@test 'An undefined variable is a precondition - active' {
+#  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-required-variables.md \
+#   test \
+#   'A value must exist for: MISSING_VARIABLE_SPECIES='
+#}

data/bats/import.bats

@@ -14,3 +14,11 @@ load 'test_helper'
   spec_mde_args_expect docs/dev/import-missing.md \
    ' Error: CachedNestedFileReader.readlines -- No such file or directory - this-is-missing.md @@ '
 }
+
+@test 'Directives - import; list block ids' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import.md \
+   --list-block-message id --list-blocks \
+   'ItrBlkFrmNstFls:1¤./docs/dev/specs-import.md:0_ItrBlkFrmNstFls:4¤./docs/dev/specs-import.md:3_ItrBlkFrmNstFls:7¤./docs/dev/specs-import.md:6'
+}

data/docs/dev/block-type-ux-required-variables.md

@@ -1,5 +1,5 @@
 / an automatic UX block that has a precondition that must be met before it is executed
-```ux :[document_ux_SPECIES]
+```ux :test
 exec: printf "$MISSING_VARIABLE"
 name: SPECIES
 required:

data/lib/cached_nested_file_reader.rb

@@ -39,6 +39,8 @@ class CachedNestedFileReader
     )
   end
 
+  # yield each line to the block
+  # return the processed lines
   def readlines(filename, depth = 0, context: '', import_paths: nil,
                 indention: '', &block)
     if @file_cache.key?(filename)
@@ -70,7 +72,7 @@ class CachedNestedFileReader
                                      indention: import_indention,
                                      &block)
       else
-        nested_line = NestedLine.new(line, depth, indention)
+        nested_line = NestedLine.new(line, depth, indention, filename, ind)
         processed_lines.push(nested_line)
         block&.call(nested_line)
       end

data/lib/constants.rb

@@ -92,7 +92,7 @@ class MenuState
 end
 
 # a struct to hold the data for a single line
-NestedLine = Struct.new(:text, :depth, :indention) do
+NestedLine = Struct.new(:text, :depth, :indention, :filename, :index) do
   def to_s
     indention + text
   end

data/lib/hash_delegator.rb

@@ -1098,7 +1098,8 @@ module MarkdownExec
           block,
           mdoc,
           force: @delegate_object[:ux_auto_load_force_default],
-          only_default: true
+          only_default: true,
+          silent: true
         )
         if command_result_w_e_t_nl.failure?
           merged_options
@@ -1111,7 +1112,8 @@ module MarkdownExec
     # parse YAML body defining the UX for a single variable
     # set ENV value for the variable and return code lines for the same
     def code_from_ux_block_to_set_environment_variables(
-      selected, mdoc, inherited_code: nil, force: true, only_default: false
+      selected, mdoc, inherited_code: nil, force: true, only_default: false,
+      silent:
     )
       exit_prompt = @delegate_object[:prompt_filespec_back]
 
@@ -1161,7 +1163,7 @@ module MarkdownExec
             command_result_w_e_t_nl =
               ux_block_export_activated(eval_code, export, exit_prompt)
             if command_result_w_e_t_nl.failure?
-              warn command_result_w_e_t_nl.warning if command_result_w_e_t_nl.warning&.present?
+              warn command_result_w_e_t_nl.warning if command_result_w_e_t_nl.warning&.present? && !silent
               return command_result_w_e_t_nl
             end
           end
@@ -2019,7 +2021,8 @@ module MarkdownExec
         command_result_w_e_t_nl = code_from_ux_block_to_set_environment_variables(
           selected,
           @dml_mdoc,
-          inherited_code: @dml_link_state.inherited_lines
+          inherited_code: @dml_link_state.inherited_lines,
+          silent: true
         )
         ### TBD if command_result_w_e_t_nl.failure?
         next_state_append_code(
@@ -2581,7 +2584,7 @@ module MarkdownExec
     end
 
     def export_echo_with_code(
-      bash_script_lines, export, force:
+      bash_script_lines, export, force:, silent:
     )
       exportable = true
       command_result = nil
@@ -2596,7 +2599,7 @@ module MarkdownExec
         )
         if command_result.exit_status == EXIT_STATUS_REQUIRED_EMPTY
           exportable = false
-          command_result.warning = warning_required_empty(export)
+          command_result.warning = warning_required_empty(export) unless silent
         end
 
       when Hash
@@ -2609,7 +2612,7 @@ module MarkdownExec
             )
           )
           if command_result.exit_status == EXIT_STATUS_REQUIRED_EMPTY
-            command_result.warning = warning_required_empty(export)
+            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,
@@ -2937,17 +2940,20 @@ module MarkdownExec
 
       state = initial_state
       selected_types = yield :filter
+      index = 0
       cfile.readlines(
         @delegate_object[:filename],
         import_paths: options_import_paths
-      ).each_with_index do |nested_line, index|
-        next unless nested_line
+      ) do |nested_line|
+        next if nested_line.nil?
 
         update_line_and_block_state(
           nested_line, state, selected_types,
-          source_id: "#{@delegate_object[:filename]}¤ItrBlkFrmNstFls:#{index}",
+          source_id: "ItrBlkFrmNstFls:#{index}¤#{nested_line.filename}:#{nested_line.index}",
           &block
         )
+
+        index += 1
       end
     end
 
@@ -2962,10 +2968,8 @@ module MarkdownExec
       else
         iter_blocks_from_nested_files do |btype, fcb|
           case btype
-          when :blocks
-            yield fcb
-          when :filter
-            %i[blocks]
+          when :blocks; yield fcb
+          when :filter; %i[blocks]
           end
         end
       end
@@ -3010,7 +3014,7 @@ module MarkdownExec
           )
 
         else
-          output_lines = `#{cmd}`.split("\n")
+          output_lines = `bash #{file.path}`.split("\n")
         end
       end
 
@@ -3564,11 +3568,24 @@ module MarkdownExec
 
     def output_from_adhoc_bash_script_file(bash_script_lines)
       Tempfile.create('script_exec') do |temp_file|
-        temp_file.write(HashDelegator.join_code_lines(bash_script_lines))
-        temp_file.flush
+        temp_file.write(
+          HashDelegator.join_code_lines(
+            bash_script_lines
+          )
+        )
+        temp_file.close  # Close the file before chmod and execution
         File.chmod(0o755, temp_file.path)
 
-        output = `#{temp_file.path}`
+        if @delegate_object[:archive_ad_hoc_scripts]
+          archive_filename = format(
+            @delegate_object[:archive_path_format],
+            time: Time.now.strftime(@delegate_object[:archive_time_format])
+          )
+          `cp #{temp_file.path} #{archive_filename}`
+        end
+
+        output = `bash #{temp_file.path}`
+        #### use shell per configuration
 
         CommandResult.new(stdout: output, exit_status: $?.exitstatus)
       end
@@ -4587,7 +4604,7 @@ module MarkdownExec
       new_lines = []
       command_result = nil
 
-      case as = FCB.act_source(export)####
+      case as = FCB.act_source(export)
       when false, UxActSource::FALSE
         raise 'Should not be reached.'
 
@@ -4599,7 +4616,8 @@ module MarkdownExec
           command_result, exportable, new_lines = export_echo_with_code(
             bash_script_lines,
             export,
-            force: true
+            force: true,
+            silent: false
           )
           if command_result.failure?
             command_result
@@ -4634,7 +4652,8 @@ module MarkdownExec
         command_result, exportable, new_lines = export_echo_with_code(
           bash_script_lines,
           export,
-          force: true
+          force: true,
+          silent: false
         )
 
         command_result
@@ -4688,6 +4707,7 @@ module MarkdownExec
       exportable = true
       new_lines = []
       command_result = nil
+      silent = true
 
       case FCB.init_source(export)
       when false, UxActSource::FALSE
@@ -4703,7 +4723,8 @@ module MarkdownExec
           command_result, exportable, new_lines = export_echo_with_code(
             bash_script_lines,
             export,
-            force: false
+            force: false,
+            silent: silent
           )
           unless command_result.failure?
             command_result.stdout = (exportable && command_result.stdout.split("\n").first) || ''
@@ -4732,7 +4753,8 @@ module MarkdownExec
         command_result, exportable, new_lines = export_echo_with_code(
           bash_script_lines,
           export,
-          force: false
+          force: false,
+          silent: silent
         )
 
       when ':exec', UxActSource::EXEC
@@ -4750,7 +4772,7 @@ module MarkdownExec
       # add message for required variables
       if command_result.exit_status == EXIT_STATUS_REQUIRED_EMPTY
         command_result.warning = warning_required_empty(export)
-        warn command_result.warning
+        warn command_result.warning unless silent
       end
 
       command_result.exportable = exportable
@@ -5198,6 +5220,7 @@ module MarkdownExec
         mdoc_menu_and_blocks_from_nested_files(
           @dml_link_state, source_id: source_id
         )
+
       dump_delobj(@dml_blocks_in_file, @dml_menu_blocks, @dml_link_state)
     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 = '3.0.0'
+  VERSION = '3.0.2'
 end

data/lib/menu.src.yml

@@ -4,6 +4,25 @@
   :description: Show current configuration values
   :procname: show_config
 
+- :opt_name: archive_ad_hoc_scripts
+  :env_var: MDE_ARCHIVE_AD_HOC_SCRIPTS
+  :description: Archive ad-hoc bash scripts
+  :arg_name: BOOL
+  :default: false
+  :procname: val_as_bool
+
+- :opt_name: archive_time_format
+  :env_var: MDE_ARCHIVE_TIME_FORMAT
+  :description: Time format for archive filenames
+  :default: '%Y-%m-%d-%H-%M-%S-%N'
+  :procname: val_as_str
+
+- :opt_name: archive_path_format
+  :env_var: MDE_ARCHIVE_PATH_FORMAT
+  :description: Format for archive file paths
+  :default: '/tmp/mde-ad-hoc-%{time}'
+  :procname: val_as_str
+
 - :opt_name: bash_only
   :env_var: MDE_BASH_ONLY
   :description: Execute only blocks of type "bash"

data/lib/menu.yml

@@ -2,6 +2,22 @@
 - :short_name: '0'
   :description: Show current configuration values
   :procname: show_config
+- :opt_name: archive_ad_hoc_scripts
+  :env_var: MDE_ARCHIVE_AD_HOC_SCRIPTS
+  :description: Archive ad-hoc bash scripts
+  :arg_name: BOOL
+  :default: false
+  :procname: val_as_bool
+- :opt_name: archive_time_format
+  :env_var: MDE_ARCHIVE_TIME_FORMAT
+  :description: Time format for archive filenames
+  :default: "%Y-%m-%d-%H-%M-%S-%N"
+  :procname: val_as_str
+- :opt_name: archive_path_format
+  :env_var: MDE_ARCHIVE_PATH_FORMAT
+  :description: Format for archive file paths
+  :default: "/tmp/mde-ad-hoc-%{time}"
+  :procname: val_as_str
 - :opt_name: bash_only
   :env_var: MDE_BASH_ONLY
   :description: Execute only blocks of type "bash"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-20 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard