markdown_exec 1.8.8 → 1.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb4c6a799eb433c1df5b2a5b9969757bc7073bcd8ce410a341f8714dc4dd5dd
-  data.tar.gz: 385a8fe67c4cb460b43ae1263c7643d819fe5c236e572e3d3a6c04f26fb64666
+  metadata.gz: a81d96c57727583a17c019bcb0a8097c6d97633a7b5ee2b33e2d9a7e56a4c081
+  data.tar.gz: 4c67c34577546161914e77be928867128e55d926c3419c2ab4c6cc521d051cae
 SHA512:
-  metadata.gz: 658083cad39ed6e9e2caf0243b9aa2d33d9c8b881ed370938cee3f062ba4d9f2fa4f940de7d1dfe2066c0afe285c562f1caefef367d18eacfa4a9d295061f0fb
-  data.tar.gz: 244c774edf797545ad63326caa39014b23cf3ed53622cdffcd2d37d37012be972ae3f538b619f6895c3ae72fcd80cafd0b9e9428bbd20788bb267307e5168a8d
+  metadata.gz: 6e7ffb35e3b7cf4aa9fa03095519d28aa088367a8b91cbcf440b143f732510a43401e78b435a0ea73f03a6754e55897fa9800b121f9f767d64715d4d79f019b3
+  data.tar.gz: a4f94c70dc8f58a7b6bf79a4baf063ef893173ccb26aa57f19a1ab485656ec469dcfa3f70555cb2bddddc55b8a3023576724d23dc30d2b16f444dbd732025b9f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.8.9] - 2024-01-20
+
+### Added
+
+- Variables set in inherited lines for use in scripts.
+
+- Link key `save` to write inherited lines to disk.
+
 ## [1.8.8] - 2024-01-15
 
 ### Added

data/Gemfile.lock

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

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.8.8"
+  echo "1.8.9"
 }
 
 _mde() {
@@ -178,4 +178,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2024-01-18 17:32:47 UTC"
+# echo "Updated: 2024-01-20 19:29:56 UTC"

data/examples/linked.md

@@ -1,62 +1,52 @@
-Demonstrate setting a variable interactively for use in generated scripts.
+Demonstrate setting variable values interactively for use in generated scripts.
 
 ```opts :(document_options)
 pause_after_script_execution: false
 user_must_approve: false
 ```
 
-::: Set VARIABLE to "A"
-
-```link :set_to_A +(set_to_A)
-block: display_variable
+::: Set variable ALPHA in a Vars block
+For each environment variable named in block,
+ append an inherited line that assigns the variable the specified value.
+```vars :set_ALPHA_to_1_via_vars_block
+ALPHA: 1
 ```
 
-```bash :(set_to_A)
-VARIABLE=A
+::: Set variable ALPHA in a Link block
+For each environment variable in `vars`,
+ append an inherited line that assigns the variable the specified value.
+Subsequently, run the `display_variable_ALPHA` block.
+```link :set_ALPHA_to_2_via_link_block_and_display
+block: display_variable_ALPHA
+vars:
+  ALPHA: 2
 ```
 
-```link :set_to_A_eval +(set_to_A_eval)
-block: display_variable
-eval: true
+Make the code in the required block `(bash_set_to_3)` into inherited lines.
+Subsequently, run the `display_variable_ALPHA` block.
+```bash :(bash_set_to_3)
+ALPHA=3
 ```
-
-```bash :(set_to_A_eval)
-echo VARIABLE=A
+```link :set_ALPHA_to_3_via_required_block_and_display +(bash_set_to_3)
+block: display_variable_ALPHA
 ```
 
-::: Set VARIABLE to "B"
-
-```link :set_to_B +(set_to_B)
-block: display_variable
-```
-
-```bash :(set_to_B)
-VARIABLE=B
-```
-
-```link :set_to_B_eval +(set_to_B_eval)
-block: display_variable
+Evaluate the code in the required block `(bash_eval_set_to_4)` and
+ save (transformed) output into inherited lines.
+Subsequently, run the `display_variable_ALPHA` block.
+```link :set_ALPHA_to_4_via_evaluated_required_block_and_display +(bash_eval_set_to_4)
 eval: true
+next_block: display_variable_ALPHA
 ```
-
-```bash :(set_to_B_eval)
-echo VARIABLE=B
+```bash :(bash_eval_set_to_4)
+echo 'ALPHA="4"'
 ```
 
-::: Display value of VARIABLE
-
-```bash :display_variable
+::: Display value of ALPHA
+```bash :display_variable_ALPHA
 source bin/colorize_env_vars.sh
-echo The current value of environment variable VARIABLE is now:
-colorize_env_vars '' VARIABLE
-```
-
-```bash :(set_timestamp)
-echo 'yyyymmdd? (default: today UTC) '; read -r yyyymmdd; [[ -z $yyyymmdd ]] && yyyymmdd="$(date -u +%y%m%d)"
-echo "EC2_STACK_TS='$yyyymmdd'"
-```
-```link :request_input_and_inherit_output +(set_timestamp)
-exec: true
+echo The current value of environment variable ALPHA is now:
+colorize_env_vars '' ALPHA
 ```
 
 ::: Load file into inherited lines
@@ -69,3 +59,43 @@ Load, evaluate, and append output to inherited lines.
 load: examples/load2.sh
 eval: true
 ```
+
+::: Save and Load
+Save inherited lines to a file.
+```link :save1
+save: tmp/save1.sh
+```
+Load inherited lines from a file.
+Subsequently, run the `display_variables` block.
+```link :load_saved
+load: tmp/save1.sh
+block: display_variables
+```
+Display variables ALPHA, var1, var2
+```bash :display_variables
+source bin/colorize_env_vars.sh
+colorize_env_vars '' ALPHA var1 var2
+```
+
+Execute a script requiring input from the user.
+Save the output setting TIMESTAMP into inherited lines.
+Subsequently, run the `display_TIMESTAMP` block.
+```bash :(input_timestamp)
+if [[ -z $TIMESTAMP ]]; then
+  default="$(date -u +%y%m%d)"
+  echo "yymmdd? (default: $default / today UTC) "
+  read -r TIMESTAMP
+  [[ -z $TIMESTAMP ]] && TIMESTAMP="$(date -u +%y%m%d)"
+fi
+```
+```bash :(inherit_timestamp)
+echo "TIMESTAMP=\"$TIMESTAMP\""
+```
+```link :set_timestamp +(input_timestamp) +(inherit_timestamp)
+exec: true
+block: display_TIMESTAMP
+```
+```bash :display_TIMESTAMP
+source bin/colorize_env_vars.sh
+colorize_env_vars '' TIMESTAMP
+```

data/lib/constants.rb

@@ -17,11 +17,16 @@ IndexedLine = Struct.new(:index, :line) do
   end
 end
 
-class LinkDataKeys
+class LinkKeys
+  Block = 'block'
   Eval = 'eval'
   Exec = 'exec'
+  File = 'file'
   Load = 'load'
+  NextBlock = 'next_block'
   Return = 'return'
+  Save = 'save'
+  Vars = 'vars'
 end
 
 class LoadFile

data/lib/hash_delegator.rb

@@ -185,16 +185,20 @@ module HashDelegatorSelf
     fcb.oname = fcb.dname = fcb.title || ''
   end
 
+  def join_code_lines(lines)
+    ((lines || [])+ ['']).join("\n")
+  end
+
   def merge_lists(*args)
     # Filters out nil values, flattens the arrays, and ensures an empty list is returned if no valid lists are provided
     merged = args.compact.flatten
     merged.empty? ? [] : merged
   end
 
-  def next_link_state(block_name_from_cli, was_using_cli, block_state)
+  def next_link_state(block_name_from_cli, was_using_cli, block_state, block_name: nil)
     # &bsp 'next_link_state', block_name_from_cli, was_using_cli, block_state
     # Set block_name based on block_name_from_cli
-    block_name = block_name_from_cli ? @cli_block_name : nil
+    block_name = block_name_from_cli ? @cli_block_name : block_name
     # &bsp 'block_name:', block_name
 
     # Determine the state of breaker based on was_using_cli and the block type
@@ -600,8 +604,6 @@ module MarkdownExec
     # @param selected [Hash] The selected block.
     # @return [Array<String>] Required code blocks as an array of lines.
     def collect_required_code_lines(mdoc, selected, link_state = LinkState.new, block_source:)
-      set_environment_variables_for_block(selected) if selected[:shell] == BlockType::VARS
-
       required = mdoc.collect_recursively_required_code(
         selected[:nickname] || selected[:oname],
         label_format_above: @delegate_object[:shell_code_label_format_above],
@@ -624,7 +626,9 @@ module MarkdownExec
                                                highlight: [@delegate_object[:block_name]])
       end
 
-      HashDelegator.code_merge(link_state&.inherited_lines, required[:code])
+      code_lines = selected[:shell] == BlockType::VARS ? set_environment_variables_for_block(selected) : []
+
+      HashDelegator.code_merge(link_state&.inherited_lines, required[:code] + code_lines)
     end
 
     def command_execute(command, args: [])
@@ -926,6 +930,22 @@ module MarkdownExec
         @delegate_object.merge!(options_state.options)
         options_state.load_file_link_state
 
+      elsif selected[:shell] == BlockType::VARS
+        debounce_reset
+        block_names = []
+        code_lines = set_environment_variables_for_block(selected)
+        dependencies = {}
+        link_history_push_and_next(
+          curr_block_name: selected[:oname],
+          curr_document_filename: @delegate_object[:filename],
+          inherited_block_names: ((link_state&.inherited_block_names || []) + block_names).sort.uniq,
+          inherited_dependencies: (link_state&.inherited_dependencies || {}).merge(dependencies || {}), ### merge, not replace, key data
+          inherited_lines: HashDelegator.code_merge(link_state&.inherited_lines, code_lines),
+          next_block_name: '',
+          next_document_filename: @delegate_object[:filename],
+          next_load_file: LoadFile::Reuse
+        )
+
       elsif debounce_allows
         compile_execute_and_trigger_reuse(mdoc, selected, link_state,
                                           block_source: block_source)
@@ -1089,7 +1109,7 @@ module MarkdownExec
     def link_block_data_eval(link_state, code_lines, selected, link_block_data)
       all_code = HashDelegator.code_merge(link_state&.inherited_lines, code_lines)
 
-      if link_block_data.fetch(LinkDataKeys::Exec, false)
+      if link_block_data.fetch(LinkKeys::Exec, false)
         @run_state.files = Hash.new([])
         output_lines = []
 
@@ -1338,7 +1358,7 @@ module MarkdownExec
           inherited_block_names: ((link_state&.inherited_block_names || []) + block_names).sort.uniq,
           inherited_dependencies: (link_state&.inherited_dependencies || {}).merge(dependencies || {}), ### merge, not replace, key data
           inherited_lines: HashDelegator.code_merge(link_state&.inherited_lines, code_lines),
-          next_block_name: '', # not link_block_data['block'] || ''
+          next_block_name: '', # not link_block_data[LinkKeys::Block] || ''
           next_document_filename: @delegate_object[:filename], # not next_document_filename
           next_load_file: LoadFile::Reuse # not next_document_filename == @delegate_object[:filename] ? LoadFile::Reuse : LoadFile::Load
         )
@@ -1539,13 +1559,6 @@ module MarkdownExec
                                            link_state = LinkState.new)
       link_block_data = HashDelegator.parse_yaml_data_from_body(link_block_body)
 
-      # load key and values from link block into current environment
-      #
-      (link_block_data['vars'] || []).each do |(key, value)|
-        ENV[key] = value.to_s
-        ### add to inherited_lines
-      end
-
       ## collect blocks specified by block
       #
       if mdoc
@@ -1563,22 +1576,40 @@ module MarkdownExec
         code_lines = []
         dependencies = {}
       end
-      next_document_filename = link_block_data['file'] || @delegate_object[:filename]
+      next_document_filename = link_block_data[LinkKeys::File] || @delegate_object[:filename]
 
-      ## append blocks loaded per LinkDataKeys::Load
+      # load key and values from link block into current environment
       #
-      if (load_filespec = link_block_data.fetch(LinkDataKeys::Load, '')).present?
+      if link_block_data[LinkKeys::Vars]
+        code_lines.push "# #{selected[:oname]}"
+        (link_block_data[LinkKeys::Vars] || []).each do |(key, value)|
+          ENV[key] = value.to_s
+          require 'shellwords'
+          code_lines.push "#{key}=\"#{Shellwords.escape(value)}\""
+        end
+      end
+
+      ## append blocks loaded, apply LinkKeys::Eval
+      #
+      if (load_filespec = link_block_data.fetch(LinkKeys::Load, '')).present?
         code_lines += File.readlines(load_filespec, chomp: true)
       end
 
       # if an eval link block, evaluate code_lines and return its standard output
       #
-      if link_block_data.fetch(LinkDataKeys::Eval,
-                               false) || link_block_data.fetch(LinkDataKeys::Exec, false)
+      if link_block_data.fetch(LinkKeys::Eval,
+                               false) || link_block_data.fetch(LinkKeys::Exec, false)
         code_lines = link_block_data_eval(link_state, code_lines, selected, link_block_data)
       end
 
-      if link_block_data[LinkDataKeys::Return]
+      ## write variables
+      #
+      if (save_filespec = link_block_data.fetch(LinkKeys::Save, '')).present?
+        File.write(save_filespec, HashDelegator.join_code_lines(link_state&.inherited_lines))
+        next_document_filename = @delegate_object[:filename]
+      end
+
+      if link_block_data[LinkKeys::Return]
         pop_add_current_code_to_head_and_trigger_load(link_state, block_names, code_lines,
                                                       dependencies, selected)
 
@@ -1589,7 +1620,7 @@ module MarkdownExec
           inherited_block_names: ((link_state&.inherited_block_names || []) + block_names).sort.uniq,
           inherited_dependencies: (link_state&.inherited_dependencies || {}).merge(dependencies || {}), ### merge, not replace, key data
           inherited_lines: HashDelegator.code_merge(link_state&.inherited_lines, code_lines),
-          next_block_name: link_block_data['block'] || '',
+          next_block_name: link_block_data.fetch(LinkKeys::NextBlock, nil) || link_block_data[LinkKeys::Block] || '',
           next_document_filename: next_document_filename,
           next_load_file: next_document_filename == @delegate_object[:filename] ? LoadFile::Reuse : LoadFile::Load
         )
@@ -1668,8 +1699,13 @@ module MarkdownExec
           break
         end
 
+        ## order of block name processing
+        # from link block
+        # from cli
+        # from user
+        #
         link_state.block_name, @run_state.block_name_from_cli, cli_break = \
-          HashDelegator.next_link_state(!shift_cli_argument, now_using_cli, block_state)
+          HashDelegator.next_link_state(!link_state.block_name && !shift_cli_argument, now_using_cli, block_state, block_name: link_state.block_name)
 
         if !block_state.block[:block_name_from_ui] && cli_break
           # &bsp '!block_name_from_ui + cli_break -> break'
@@ -1814,14 +1850,20 @@ module MarkdownExec
     end
 
     def set_environment_variables_for_block(selected)
+      code_lines = []
       YAML.load(selected[:body].join("\n"))&.each do |key, value|
         ENV[key] = value.to_s
+
+        require 'shellwords'
+        code_lines.push "#{key}=\"#{Shellwords.escape(value)}\""
+
         next unless @delegate_object[:menu_vars_set_format].present?
 
         formatted_string = format(@delegate_object[:menu_vars_set_format],
                                   { key: key, value: value })
         print string_send_color(formatted_string, :menu_vars_set_color)
       end
+      code_lines
     end
 
     def should_add_back_option?
@@ -2111,7 +2153,7 @@ module MarkdownExec
                                               LinkState.new(block_name: 'sample_block',
                                                             document_filename: 'sample_file',
                                                             inherited_dependencies: {},
-                                                            inherited_lines: []))
+                                                            inherited_lines: ['# ', 'KEY="VALUE"']))
       assert_equal expected_result,
                    @hd.push_link_history_and_trigger_load(body, nil, FCB.new(block_name: 'sample_block',
                                                                              filename: 'sample_file'))
@@ -2282,7 +2324,7 @@ module MarkdownExec
         @mdoc.stubs(:collect_recursively_required_code).returns({ code: ['code line'] })
         result = @hd.collect_required_code_lines(@mdoc, @selected, block_source: {})
 
-        assert_equal ['code line'], result
+        assert_equal ['code line', 'key="value"'], result
       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 = '1.8.8'
+  VERSION = '1.8.9'
 end

data/lib/menu.src.yml

@@ -211,26 +211,11 @@
             tell the first window
                 set bounds to {xoff, yoff, xoff + winWidth, yoff + winHeight}
                 tell the current session
-                    write text "alias cat_script=\"cat -n \\\"%{script_filespec}\\\"\""
-                    write text "alias less_script=\"less \\\"%{script_filespec}\\\"\""
-                    write text "alias run_script=\"%{script_filespec}\""
-                    write text "alias vim_script=\"vim \\\"%{script_filespec}\\\"\""
-                    delay 1
-
-                    write text "alias cat_output=\"cat -n \\\"%{output_filespec}\\\"\""
-                    write text "alias grep_output=\"read -p Pattern: pattern && grep \\\"\\$pattern\\\" \\\"%{output_filespec}\\\"\""
-                    write text "alias less_output=\"less \\\"%{output_filespec}\\\"\""
-                    delay 1
-
-                    write text "alias menu=\"select cmd in cat_script less_script run_script vim_script cat_output grep_output less_output exit; do eval \\\"\\$cmd\\\"; done\""
-                    delay 1
-
+                    write text "# %{script_filespec}"
+                    write text "# %{output_filespec}"
                     write text "echo -ne \"\\033]; %{started_at} - %{document_filename} - %{block_name} \\007\""
                     write text "cd \"%{home}\""
                     write text "\"%{script_filename}\" | tee \"%{output_filespec}\""
-                    delay 2
-
-                    write text "menu"
                 end tell
             end tell
         end tell'
@@ -737,7 +722,7 @@
   :env_var: MDE_OUTPUT_ASSIGNMENT_FORMAT
   :opt_name: output_assignment_format
   :procname: val_as_str
-- :default: "^ *(\\w+=.*?) *$"
+- :default: "^ *(?<line>\\w+=.*?) *$"
   :description: Pattern for assignments from output
   :env_var: MDE_OUTPUT_ASSIGNMENT_MATCH
   :opt_name: output_assignment_match

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (1.8.8)
+# MDE - Markdown Executor (1.8.9)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -173,21 +173,12 @@
     yoff to xoff mod (screenHeight - winHeight)\n        \n        create window with
     default profile\n        tell the first window\n            set bounds to {xoff,
     yoff, xoff + winWidth, yoff + winHeight}\n            tell the current session\n
-    \               write text \"alias cat_script=\\\"cat -n \\\\\\\"%{script_filespec}\\\\\\\"\\\"\"\n
-    \               write text \"alias less_script=\\\"less \\\\\\\"%{script_filespec}\\\\\\\"\\\"\"\n
-    \               write text \"alias run_script=\\\"%{script_filespec}\\\"\"\n                write
-    text \"alias vim_script=\\\"vim \\\\\\\"%{script_filespec}\\\\\\\"\\\"\"\n                delay
-    1\n\n                write text \"alias cat_output=\\\"cat -n \\\\\\\"%{output_filespec}\\\\\\\"\\\"\"\n
-    \               write text \"alias grep_output=\\\"read -p Pattern: pattern &&
-    grep \\\\\\\"\\\\$pattern\\\\\\\" \\\\\\\"%{output_filespec}\\\\\\\"\\\"\"\n                write
-    text \"alias less_output=\\\"less \\\\\\\"%{output_filespec}\\\\\\\"\\\"\"\n                delay
-    1\n\n                write text \"alias menu=\\\"select cmd in cat_script less_script
-    run_script vim_script cat_output grep_output less_output exit; do eval \\\\\\\"\\\\$cmd\\\\\\\";
-    done\\\"\"\n                delay 1\n\n                write text \"echo -ne \\\"\\\\033];
+    \               write text \"# %{script_filespec}\"\n                write text
+    \"# %{output_filespec}\"\n                write text \"echo -ne \\\"\\\\033];
     %{started_at} - %{document_filename} - %{block_name} \\\\007\\\"\"\n                write
     text \"cd \\\"%{home}\\\"\"\n                write text \"\\\"%{script_filename}\\\"
-    | tee \\\"%{output_filespec}\\\"\"\n                delay 2\n\n                write
-    text \"menu\"\n            end tell\n        end tell\n    end tell'\n"
+    | tee \\\"%{output_filespec}\\\"\"\n            end tell\n        end tell\n    end
+    tell'\n"
   :description: execute_command_format
   :env_var: MDE_EXECUTE_COMMAND_FORMAT
   :opt_name: execute_command_format
@@ -611,7 +602,7 @@
   :env_var: MDE_OUTPUT_ASSIGNMENT_FORMAT
   :opt_name: output_assignment_format
   :procname: val_as_str
-- :default: "^ *(\\w+=.*?) *$"
+- :default: "^ *(?<line>\\w+=.*?) *$"
   :description: Pattern for assignments from output
   :env_var: MDE_OUTPUT_ASSIGNMENT_MATCH
   :opt_name: output_assignment_match

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 1.8.8
+  version: 1.8.9
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard