markdown_exec 1.8.6 → 1.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44e42ccdbdf5eed7e6ee36add8a5dcdcfe62d6cd3fb6fd531daf960c6ce7c9b7
-  data.tar.gz: 753076d46e44f5d17698be53a0421212d8f2c804368f9737591dc92a7d5457d6
+  metadata.gz: 9fb4c6a799eb433c1df5b2a5b9969757bc7073bcd8ce410a341f8714dc4dd5dd
+  data.tar.gz: 385a8fe67c4cb460b43ae1263c7643d819fe5c236e572e3d3a6c04f26fb64666
 SHA512:
-  metadata.gz: 84d952fcfafed40a5e3949783760aec570448de48293fdae536b5386b95d8080d2c9c41f0149861686d2fd4985a59ebea6794e7953d7b4dc1185340d790e68a2
-  data.tar.gz: 9db0c523154e32c3094046084594564c9114fbd2519f6ff5d9a8fcc5feb0d31b76dc3ccd1d6c4e2625507b81b4f70f9b6fdf31e250d132a5fdf2fa54d3cb8c77
+  metadata.gz: 658083cad39ed6e9e2caf0243b9aa2d33d9c8b881ed370938cee3f062ba4d9f2fa4f940de7d1dfe2066c0afe285c562f1caefef367d18eacfa4a9d295061f0fb
+  data.tar.gz: 244c774edf797545ad63326caa39014b23cf3ed53622cdffcd2d37d37012be972ae3f538b619f6895c3ae72fcd80cafd0b9e9428bbd20788bb267307e5168a8d

data/.pryrc

@@ -1,4 +1,3 @@
-binding.pry
 if defined?(PryByebug)
   Pry.config.pager = false
   Pry.commands.alias_command 'c', 'continue'

data/.rubocop.yml

@@ -14,8 +14,6 @@ Layout/LineContinuationLeadingSpace:
   Enabled: false
 
 Layout/LineLength:
-  # Max: 78
-  # Max: 80
   Max: 96
 
 Lint/Debugger:
@@ -106,3 +104,6 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: single_quotes
+
+Style/UnlessElse:
+  Enabled: false

data/CHANGELOG.md

@@ -1,20 +1,62 @@
 # Changelog
 
+## [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.
+- Options for decorating inherited lines in the menu.
+- Options for parse and display of heading levels 1, 2, and 3.
+
+### Changed
+
+- Bypass chrome blocks when collecting dependencies.
+
 ## [1.8.6] - 2023-12-25
 
 ### Added
 
-- Default path for find command
+- Default path for find command.
 
 ### Changed
 
-- Refactor command-line processing
+- Refactor command-line processing.
 
 ## [1.8.5] - 2023-12-22
 
 ### 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.6)
+    markdown_exec (1.8.8)
       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.6"
+  echo "1.8.8"
 }
 
 _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-26 00:07:49 UTC"
+# echo "Updated: 2024-01-18 17:32:47 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,7 +1,6 @@
 Demonstrate setting a variable interactively for use in generated scripts.
 
 ```opts :(document_options)
-dump_inherited_lines: true
 pause_after_script_execution: false
 user_must_approve: false
 ```
@@ -48,5 +47,25 @@ echo VARIABLE=B
 
 ```bash :display_variable
 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
+```
+
+::: Load file into inherited lines
+Load (do not evaluate) and append to inherited lines.
+```link :load1
+load: examples/load1.sh
+```
+Load, evaluate, and append output to inherited lines.
+```link :load2_eval
+load: examples/load2.sh
+eval: true
+```

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/examples/opts.md

@@ -1,4 +1,6 @@
 # Demo configuring options
+## H2
+### H3
 
 ::: These Opts blocks set the color of a couple of menu options to demonstrate the live update of options.
 

data/lib/ansi_formatter.rb

@@ -21,11 +21,7 @@ class AnsiFormatter
     (data&.map do |item|
       scan_and_process_multiple_substrings(item, highlight, plain_color_sym,
                                            highlight_color_sym).join
-      # color_sym = highlight.include?(item) ? highlight_color_sym : c
-      # string_send_color(item, color_sym)
-    end || []) #.join
-    # formatted_deps
-    # "#{line_prefix}#{string_send_color(label, highlight_color_sym)}#{line_postfix}\n" + formatted_deps.join("\n")
+    end || [])
   end
 
   # Function to scan a string and process its segments based on multiple substrings

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,13 @@ IndexedLine = Struct.new(:index, :line) do
   end
 end
 
+class LinkDataKeys
+  Eval = 'eval'
+  Exec = 'exec'
+  Load = 'load'
+  Return = 'return'
+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],

data/lib/filter.rb

@@ -38,10 +38,6 @@ module MarkdownExec
       name = fcb.oname
       shell = fcb.fetch(:shell, '')
 
-      ### filter in menu, not in source code
-      filters[:depth] =
-        fcb.fetch(:depth,
-                  0).positive? && !options[:menu_include_imported_blocks]
       apply_name_filters(options, filters, name)
       apply_shell_filters(options, filters, shell)
       apply_other_filters(options, filters, fcb)
@@ -88,17 +84,19 @@ module MarkdownExec
     def self.apply_shell_filters(options, filters, shell)
       filters[:shell_expect] = shell == 'expect'
 
+      if shell.empty? && options[:bash_only]
+        filters[:shell_exclude] = true
+        return
+      end
+
       if shell.present? && options[:select_by_shell_regex].present?
         filters[:shell_select] =
           !!(shell =~ /#{options[:select_by_shell_regex]}/)
       end
 
-      unless shell.present? && options[:exclude_by_shell_regex].present?
-        return
-      end
+      return unless shell.present? && options[:exclude_by_shell_regex].present?
 
-      filters[:shell_exclude] =
-        !!(shell =~ /#{options[:exclude_by_shell_regex]}/)
+      filters[:shell_exclude] = !!(shell =~ /#{options[:exclude_by_shell_regex]}/)
     end
 
     # Applies additional filters to determine whether to include or
@@ -126,8 +124,6 @@ module MarkdownExec
         !!(options[:block_name_wrapper_match].present? &&
                   name =~ /#{options[:block_name_wrapper_match]}/)
 
-      return unless options[:bash_only]
-
       filters[:shell_default] = (shell == BlockType::BASH)
     end
 
@@ -178,6 +174,20 @@ module MarkdownExec
         options[pattern].present? && fcb[:oname] =~ /#{options[pattern]}/
       end
     end
+
+    # Yields to the provided block with specified parameters if certain conditions are met.
+    # The method checks if a block is given, if the selected_messages include :blocks,
+    # and if the fcb_select? method returns true for the given fcb.
+    #
+    # @param fcb [Object] The object to be evaluated and potentially passed to the block.
+    # @param selected_messages [Array<Symbol>] A collection of message types, one of which must be :blocks.
+    # @param block [Block] A block to be called if conditions are met.
+    def self.yield_to_block_if_applicable(fcb, selected_messages, configuration = {}, &block)
+      if block_given? && selected_messages.include?(:blocks) &&
+         fcb_select?(configuration, fcb)
+        block.call :blocks, fcb
+      end
+    end
   end
 end