markdown_exec 1.8.7 → 1.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a04f06ad7f74d2557e1967ae424a8b5f8b08e9ddbbad10091ab6612f94c106
-  data.tar.gz: 54a9b79333781bb540ce1e37f686bf132d437c2ab5475c6cd64c40b3f821935e
+  metadata.gz: a81d96c57727583a17c019bcb0a8097c6d97633a7b5ee2b33e2d9a7e56a4c081
+  data.tar.gz: 4c67c34577546161914e77be928867128e55d926c3419c2ab4c6cc521d051cae
 SHA512:
-  metadata.gz: 4106f3dc27781398aee563bba15355b05f67a118170da36e9c1c51b776ec7549576ee162b090a33a3da278694438a66746d2f4c31384315929eca57558c5ca7a
-  data.tar.gz: d46fa757bcfbee2fbfdebee46050ff579d4cd050a3203c887db47a5de4cc275986308cd056ef264947f1d7f239b717a8617b2a51218594f85cd10b27d14156bf
+  metadata.gz: 6e7ffb35e3b7cf4aa9fa03095519d28aa088367a8b91cbcf440b143f732510a43401e78b435a0ea73f03a6754e55897fa9800b121f9f767d64715d4d79f019b3
+  data.tar.gz: a4f94c70dc8f58a7b6bf79a4baf063ef893173ccb26aa57f19a1ab485656ec469dcfa3f70555cb2bddddc55b8a3023576724d23dc30d2b16f444dbd732025b9f

data/.rubocop.yml

@@ -104,3 +104,6 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: single_quotes
+
+Style/UnlessElse:
+  Enabled: false

data/CHANGELOG.md

@@ -1,7 +1,44 @@
-## [1.8.7] - 2023-12-31
-
 # 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
+
+- Debounce/Control repeated launching of the same block via the menu.
+
+- Option to match block nicknames.
+  Nicknames are used for scripting and are not displayed in the menu -- the block body is shown the menu.
+
+- Option to execute script to launch Terminal window.
+  Provide batch variables to use in the execute_command_format script.
+  Limit iTerm window position to visible area.
+  Store output of executed script.
+  Menu to replay, review, and exit.
+
+- Report line in document importing a missing file.
+
+- Option to search for import files within each of the specified paths (recursion optional).
+
+- Eval block loads (appends) local file to inherited lines.
+
+- Eval block executes script and appends filtered output to inherited lines.
+  Select output using begin and end matching lines.
+  Transform selected output with per-line match and print specifications.
+
+### Changed
+
+- Sanitize block names in formatted lines above and below inherited code.
+
+## [1.8.7] - 2023-12-31
+
 ### Added
 
 - Option for block name that presents the menu.
@@ -26,7 +63,8 @@
 
 ### Added
 
-- "eval" key for link block type to compute lines to append to the inherited state.
+- "eval" boolean value for Link blocks to compute lines to append to the inherited state.
+- "return" boolean value for Link blocks to return to the original page.
 - Options for dumping data associated with the menu or state.
 - Debug and irb gems.
 

data/Gemfile

@@ -9,6 +9,7 @@ gemspec
 gem 'clipboard'
 gem 'debug'
 gem 'erb'
+gem 'httparty' # 2024-01-01 for ChatGPI API
 gem 'irb', '>= 1.8.0'
 gem 'mocha', require: false
 gem 'minitest', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (1.8.7)
+    markdown_exec (1.8.9)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -47,6 +47,9 @@ GEM
     erb (4.0.3)
       cgi (>= 0.3.3)
     erubi (1.12.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     io-console (0.7.1)
@@ -60,9 +63,11 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     method_source (1.0.0)
+    mini_mime (1.1.5)
     minitest (5.20.0)
     mocha (2.1.0)
       ruby2_keywords (>= 0.0.5)
+    multi_xml (0.6.0)
     nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
     open3 (0.1.2)
@@ -182,6 +187,7 @@ DEPENDENCIES
   clipboard
   debug
   erb
+  httparty
   irb (>= 1.8.0)
   markdown_exec!
   minitest

data/Rakefile

@@ -82,6 +82,7 @@ task :minitest do
     './lib/directory_searcher.rb',
     './lib/fcb.rb',
     './lib/filter.rb',
+    './lib/find_files.rb',
     './lib/hash_delegator.rb',
     './lib/markdown_exec.rb',
     './lib/mdoc.rb',

data/bin/bmde

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.8.7"
+  echo "1.8.9"
 }
 
 _mde() {
@@ -80,9 +80,9 @@ _mde() {
             
               --saved-stdout-folder) COMPREPLY="logs"; return 0 ;;
             
-              --user-must-approve) COMPREPLY="1"; return 0 ;;
+              --user-must-approve) COMPREPLY="0"; return 0 ;;
             
-              -q) COMPREPLY="1"; return 0 ;;
+              -q) COMPREPLY="0"; return 0 ;;
             
               --display-level) COMPREPLY="1"; return 0 ;;
             
@@ -178,4 +178,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2023-12-31 17:23:18 UTC"
+# echo "Updated: 2024-01-20 19:29:56 UTC"

data/examples/colors.md

@@ -43,7 +43,8 @@ warning_color: fg_rgbh_ff_7f_00
 ```
 
 ::: Example blocks
-
+```
+```
 ```bash :Bash1
 ```
 ```link :Link1

data/examples/indent.md

@@ -0,0 +1,66 @@
+This is a concise guide for using Bash commands to find and list recent files in a Linux system. The commands are safe to use and can help you quickly locate recently modified or accessed files.
+
+1. **List Recently Modified Files**:
+   You can use the `ls` command with sorting options to list recently modified files in the current directory.
+
+   ```bash
+   ls -lt
+   ```
+
+2. **Using `stat` for File Details**:
+   To get detailed information about file modifications, access, and change, use the `stat` command.
+
+   Example for a specific file:
+   ```bash
+   stat .
+   ```
+
+3. **Find Files**:
+   A. **Find Files Modified in the Last N Days**:
+      The `find` command is useful for searching files modified within a specific number of days.
+
+      For example, to find files modified in the last 7 days:
+      ```bash
+      find . -type f -mtime -7
+      ```
+
+   B. **Display Files Accessed Recently**:
+      Similarly, you can list files that were accessed recently using the `find` command.
+
+      1. To list files accessed in the last 3 days:
+         ```bash
+         find . -type f -atime -3
+         ```
+
+      2. **Advanced Search with `find`**:
+         Combine `find` with other commands for advanced searching. For instance, to list and sort files by modification time:
+
+         ```bash
+         find . -type f -mtime -7 -exec ls -lt {} +
+         ```
+
+These commands provide a basic way to manage and track file modifications and access on your system. They are particularly useful for system administration and file management tasks.
+
+```link :Link1
+```
+
+   ```link :Link2
+   ```
+
+```opts :Opts1
+```
+
+   ```opts :Opts2
+   ```
+
+```port :Port1
+```
+
+   ```port :Port2
+   ```
+
+```vars :Vars1
+```
+
+   ```vars :Vars2
+   ```

data/examples/linked.md

@@ -1,52 +1,101 @@
-Demonstrate setting a variable interactively for use in generated scripts.
+Demonstrate setting variable values interactively for use in generated scripts.
 
 ```opts :(document_options)
-dump_inherited_lines: true
 pause_after_script_execution: false
 user_must_approve: false
 ```
 
-::: Set VARIABLE to "A"
+::: 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
+```
 
-```link :set_to_A +(set_to_A)
-block: display_variable
+::: 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
 ```
 
-```bash :(set_to_A)
-VARIABLE=A
+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
+```
+```link :set_ALPHA_to_3_via_required_block_and_display +(bash_set_to_3)
+block: display_variable_ALPHA
 ```
 
-```link :set_to_A_eval +(set_to_A_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_A_eval)
-echo VARIABLE=A
+```bash :(bash_eval_set_to_4)
+echo 'ALPHA="4"'
 ```
 
-::: Set VARIABLE to "B"
-
-```link :set_to_B +(set_to_B)
-block: display_variable
+::: Display value of ALPHA
+```bash :display_variable_ALPHA
+source bin/colorize_env_vars.sh
+echo The current value of environment variable ALPHA is now:
+colorize_env_vars '' ALPHA
 ```
 
-```bash :(set_to_B)
-VARIABLE=B
+::: Load file into inherited lines
+Load (do not evaluate) and append to inherited lines.
+```link :load1
+load: examples/load1.sh
 ```
-
-```link :set_to_B_eval +(set_to_B_eval)
-block: display_variable
+Load, evaluate, and append output to inherited lines.
+```link :load2_eval
+load: examples/load2.sh
 eval: true
 ```
 
-```bash :(set_to_B_eval)
-echo VARIABLE=B
+::: 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
 ```
 
-::: Display value of VARIABLE
-
-```bash :display_variable
+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 '' VARIABLE
+colorize_env_vars '' TIMESTAMP
 ```

data/examples/load1.sh

@@ -0,0 +1,5 @@
+# line 1
+var1=line2
+# line 3
+var2=line4
+# line 5

data/examples/load2.sh

@@ -0,0 +1,5 @@
+# line 1
+echo "var1=line2"
+# line 3
+echo "var2=line4"
+# line 5

data/examples/nickname.md

@@ -0,0 +1,26 @@
+# Demo block nicknames
+
+```opts :(document_options)
+save_executed_script: true
+```
+
+::: This block has no name.
+::: The code block is displayed.
+
+```bash
+echo Unnamed block
+```
+
+::: These blocks use nicknames.
+::: The code blocks are displayed.
+::: The nicknames can be used for requiring blocks.
+
+```bash :[A]
+echo From the required block 2
+```
+
+::: Execute this block that requires the block above.
+
+```bash :[B] +[A]
+echo From the parent block 1
+```

data/lib/array.rb

@@ -4,6 +4,10 @@
 # encoding=utf-8
 
 class Array
+  def pluck(key)
+    map { |hash| hash[key] if hash.is_a?(Hash) }.compact
+  end
+
   # Processes each element of the array, yielding the previous, current, and next elements to the given block.
   # Deletes the current element if the block returns true.
   # @return [Array] The modified array after conditional deletions.

data/lib/cached_nested_file_reader.rb

@@ -8,6 +8,7 @@
 require 'fileutils'
 require_relative 'constants'
 require_relative 'exceptions'
+require_relative 'find_files'
 
 ##
 # The CachedNestedFileReader class provides functionality to read file lines with the ability
@@ -38,25 +39,28 @@ class CachedNestedFileReader
     )
   end
 
-  def readlines(filename, depth = 0, &block)
+  def readlines(filename, depth = 0, context: '', import_paths: nil, &block)
     if @file_cache.key?(filename)
       @file_cache[filename].each(&block) if block
       return @file_cache[filename]
     end
 
     directory_path = File.dirname(filename)
-    # lines = File.readlines(filename, chomp: true)
     processed_lines = []
-
-    File.readlines(filename, chomp: true).each do |line|
+    File.readlines(filename, chomp: true).each.with_index do |line, ind|
       if Regexp.new(@import_pattern) =~ line
         name_strip = $~[:name].strip
         included_file_path = if name_strip =~ %r{^/}
                                name_strip
+                             elsif import_paths
+                               find_files(name_strip, import_paths + [directory_path])&.first
                              else
                                File.join(directory_path, name_strip)
                              end
+
         processed_lines += readlines(included_file_path, depth + 1,
+                                     context: "#{filename}:#{ind + 1}",
+                                     import_paths: import_paths,
                                      &block)
       else
         nested_line = NestedLine.new(line, depth)
@@ -68,58 +72,58 @@ class CachedNestedFileReader
     @file_cache[filename] = processed_lines
   rescue Errno::ENOENT
     # Exceptions.error_handler('readlines', { abort: true })
-    warn_format('readlines', "No such file -- #{filename}", { abort: true })
+    warn_format('readlines', "No such file -- #{filename} @@ #{context}", { abort: true })
   end
 end
 
-if $PROGRAM_NAME == __FILE__
-  require 'minitest/autorun'
-  require 'tempfile'
+return if $PROGRAM_NAME != __FILE__
 
-  class CachedNestedFileReaderTest < Minitest::Test
-    def setup
-      @file2 = Tempfile.new('test2.txt')
-      @file2.write("ImportedLine1\nImportedLine2")
-      @file2.rewind
+require 'minitest/autorun'
+require 'tempfile'
 
-      @file1 = Tempfile.new('test1.txt')
-      @file1.write("Line1\nLine2\n #insert #{@file2.path}\nLine3")
-      @file1.rewind
-      @reader = CachedNestedFileReader.new(import_pattern: /^ *#insert (?'name'.+)$/)
-    end
+class CachedNestedFileReaderTest < Minitest::Test
+  def setup
+    @file2 = Tempfile.new('test2.txt')
+    @file2.write("ImportedLine1\nImportedLine2")
+    @file2.rewind
 
-    def teardown
-      @file1.close
-      @file1.unlink
+    @file1 = Tempfile.new('test1.txt')
+    @file1.write("Line1\nLine2\n #insert #{@file2.path}\nLine3")
+    @file1.rewind
+    @reader = CachedNestedFileReader.new(import_pattern: /^ *#insert (?'name'.+)$/)
+  end
 
-      @file2.close
-      @file2.unlink
-    end
+  def teardown
+    @file1.close
+    @file1.unlink
 
-    def test_readlines_without_imports
-      result = @reader.readlines(@file2.path).map(&:to_s)
-      assert_equal %w[ImportedLine1 ImportedLine2], result
-    end
+    @file2.close
+    @file2.unlink
+  end
 
-    def test_readlines_with_imports
-      result = @reader.readlines(@file1.path).map(&:to_s)
-      assert_equal %w[Line1 Line2 ImportedLine1 ImportedLine2 Line3],
-                   result
-    end
+  def test_readlines_without_imports
+    result = @reader.readlines(@file2.path).map(&:to_s)
+    assert_equal %w[ImportedLine1 ImportedLine2], result
+  end
 
-    def test_caching_functionality
-      # First read
+  def test_readlines_with_imports
+    result = @reader.readlines(@file1.path).map(&:to_s)
+    assert_equal %w[Line1 Line2 ImportedLine1 ImportedLine2 Line3],
+                 result
+  end
 
-      result1 = @reader.readlines(@file2.path).map(&:to_s)
+  def test_caching_functionality
+    # First read
 
-      # Simulate file content change
-      @file2.reopen(@file2.path, 'w') { |f| f.write('ChangedLine') }
+    result1 = @reader.readlines(@file2.path).map(&:to_s)
 
-      # Second read (should read from cache, not the changed file)
-      result2 = @reader.readlines(@file2.path).map(&:to_s)
+    # Simulate file content change
+    @file2.reopen(@file2.path, 'w') { |f| f.write('ChangedLine') }
 
-      assert_equal result1, result2
-      assert_equal %w[ImportedLine1 ImportedLine2], result2
-    end
+    # Second read (should read from cache, not the changed file)
+    result2 = @reader.readlines(@file2.path).map(&:to_s)
+
+    assert_equal result1, result2
+    assert_equal %w[ImportedLine1 ImportedLine2], result2
   end
 end

data/lib/ce_get_cost_and_usage.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+require 'terminal-table'
+
+cmd = 'aws ce get-cost-and-usage        --time-period Start=2023-12-01,End=2023-12-31        --granularity MONTHLY        --metrics "UnblendedCost" "UsageQuantity"        --group-by Type=DIMENSION,Key=SERVICE'
+
+# Parse the YAML content
+text = system(cmd)
+data = YAML.load(text)
+
+# Extracting the relevant information
+services = data["ResultsByTime"][0]["Groups"].map do |group|
+  service_name = group["Keys"][0]
+  unblended_cost = "#{group['Metrics']['UnblendedCost']['Amount']} #{group['Metrics']['UnblendedCost']['Unit']}"
+  usage_quantity = "#{group['Metrics']['UsageQuantity']['Amount']} #{group['Metrics']['UsageQuantity']['Unit']}"
+  [service_name, unblended_cost, usage_quantity]
+end
+
+# Create a table
+table = Terminal::Table.new :headings => ['Service', 'Unblended Cost', 'Usage Quantity'], :rows => services
+
+# Output the table
+puts table

data/lib/constants.rb

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

data/lib/exceptions.rb

@@ -4,12 +4,14 @@
 # encoding=utf-8
 
 module Exceptions
-  def self.error_handler(name = '', opts = {}, format_string: "\nError: %{name} -- %{message}", color_symbol: :red, take_count: 16)
+  def self.error_handler(name = '', opts = {}, backtrace: $@, format_string: "\nError: %{name} -- %{message}", color_symbol: :red, take_count: 16)
     warn(error = format(format_string,
                         { name: name, message: $! }).send(color_symbol))
-    warn($@.select do |s|
-           s.include? 'markdown_exec'
-         end.reject { |s| s.include? 'vendor' }.take(take_count).map.with_index { |line, ind| " *   #{ind}: #{line}" })
+    if backtrace
+      warn(backtrace.select do |s|
+             s.include? 'markdown_exec'
+           end.reject { |s| s.include? 'vendor' }.take(take_count).map.with_index { |line, ind| " *   #{ind}: #{line}" })
+    end
 
     binding.pry if $tap_enable
     raise ArgumentError, error unless opts.fetch(:abort, true)

data/lib/fcb.rb

@@ -21,6 +21,7 @@ module MarkdownExec
         dname: nil,
         indent: '',
         name: nil,
+        nickname: nil,
         oname: nil,
         reqs: [],
         shell: '',
@@ -38,12 +39,13 @@ module MarkdownExec
     # @param fcb [Object] The FCB object whose title is to be derived.
     # @return [String] The derived title.
     def derive_title_from_body
-      body_content = @attrs[:body]
-      unless body_content
+      unless (body_content = @attrs[:body])
+        # empty body -> empty title
         @attrs[:title] = ''
         return
       end
 
+      # body -> title
       @attrs[:title] = if body_content.count == 1
                          body_content.first
                        else
@@ -113,6 +115,7 @@ if $PROGRAM_NAME == __FILE__
         headings: %w[Header1 Header2],
         dname: 'Sample name',
         indent: '',
+        nickname: nil,
         name: 'Sample name',
         oname: 'Sample name',
         reqs: %w[req1 req2],