markdown_exec 1.3.9 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fb58efae22bb345c1c1a863aa9dbf62bd6682cda0154d15d8e114cdf1b8ae64
-  data.tar.gz: eb0f7696597c1c53fc529e0a538e0ca9b2b684418242605574d01c449a47bf67
+  metadata.gz: 6655d4d2fdbf1334fd7eb786e8b8e3e8401ac0e8cb0e10927c1e426be9422d83
+  data.tar.gz: 5e2e1272f186e8fb00d240fd11501cdc5630ab497298fcc02e43c42c9b3e0f45
 SHA512:
-  metadata.gz: 0520a2e9c8c224e511821e362c189aa648f1f76a2e72876d1d87132d7f76f3ecbf2e84adbb6c4852d07b44aa52ddb08b40cd5f913dbd6540cf459794762b682f
-  data.tar.gz: 8acbbc2f5bde35a2e41b9852951349ff5ee5bd561c42a283675d25d6edc8d915540ea33de8cc48f72e92692ce31edff8b33a1583e3d8a983f8c28b01e82799f9
+  metadata.gz: 63ab33098867f8f1af0b0281690e816cd657d9fc42181cdb895ee78ab2e722cc5c63303d2c2be7f9791a7cacc9503cbfc45d9277b1a35e5cdb33ef4217a8607a
+  data.tar.gz: 4535992b37f72e175388264c3e7ab9f5189a06e57b8a973521d95f62ea75a22de445518f19577563d78a81ebc2c8a99c3cc3e24639f04f792ad9017780c426bb

data/.pryrc

@@ -0,0 +1,13 @@
+if defined?(PryByebug)
+  Pry.config.pager = false
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 'd', 'down'
+  Pry.commands.alias_command 'f', 'finish'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'u', 'up'
+
+  Pry::Commands.command /^$/, 'repeat last command' do
+    _pry_.run_command Pry.history.to_a.last
+  end
+end

data/.rubocop.yml

@@ -15,7 +15,6 @@ Layout/LineContinuationLeadingSpace:
 
 Layout/LineLength:
   Max: 96
-  # Max: 120
 
 Lint/Debugger:
   Enabled: false
@@ -65,6 +64,9 @@ Style/DoubleNegation:
 Style/EmptyElse:
   Enabled: false
 
+Style/FormatStringToken:
+  Enabled: false
+
 Style/GlobalVars:
   Enabled: false
 
@@ -74,6 +76,18 @@ Style/MixinUsage:
 Style/MultilineBlockChain:
   Enabled: false
 
+Style/PerlBackrefs: # Prefer ::Regexp.last_match.post_match over $'.
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/Semicolon: # Do not use semicolons to terminate expressions.
+  Enabled: false
+
+Style/SingleLineMethods: # Avoid single-line method definitions.
+  Enabled: false
+
 Style/SlicingWithRange:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [1.4.1] - 2023-11-02
+
+### Added
+
+- Support for nested links.
+  A Link block name can be followed by the block name to execute in the linked document.
+  Nested links result in scripts with nested required blocks.
+
+## [1.4] - 2023-10-31
+
+### Added
+
+- Add required code blocks to link block types.
+  Allows for nested required code as links are navigated.
+
+- Add fg_rgbh_* methods to process hex RGB specifications.
+
 ## [1.3.9] - 2023-10-29
 
 Add block types for linking and variable control

data/Gemfile.lock

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

data/bin/bmde

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+require 'bundler/setup'
+Bundler.require(:default)
+
+require_relative '../lib/markdown_exec'
+
+MarkdownExec::MarkParse.new.run

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "1.3.9"
+  echo "1.4.1"
 }
 
 _mde() {
@@ -138,4 +138,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2023-10-29 19:38:35 UTC"
+# echo "Updated: 2023-11-02 13:20:09 UTC"

data/examples/linked1.md

@@ -3,26 +3,27 @@
 ::: * This is document 1 *
 ::: This document links to a matching document to demonstrate navigation between documents.
 
-::: This Bash block displays the value of variables "linked1var" and "linked2var"
+::: This Bash block displays the value of variables "page1_var_via_environment" and "page2_var_via_environment"
 
-```bash :page1_show_vars
+```bash :show_vars
 source bin/colorize_env_vars.sh
-colorize_env_vars 'on page1' linked1var linked2var
+colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
+colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
 ```
 
-::: This Link block sets variable "linked2var" and navigates to document 2.
+::: This Link block
+::: 1. requires a block that sets environment variable PAGE2_VAR_VIA_INHERIT,
+::: 2. navigates to document 2, and
+::: 3. executes block "show_vars" to display the imported PAGE2_VAR_VIA_INHERIT.
+::: Any script generated by page 2 will contain the inherited code.
 
-```link :linked2
-file: examples/linked2.md
-vars:
-  linked2var: from_linked1
+```bash :(vars2)
+PAGE2_VAR_VIA_INHERIT=for_page2_from_page1_via_inherited_code_file
 ```
 
-::: This Link block sets variable "linked2var", navigates to document 2, and executes block "page2_show_vars".
-
-```link :linked2_show_vars
+```link :linked2_import_vars +(vars2)
 file: examples/linked2.md
-block: page2_show_vars
+block: show_vars
 vars:
-  linked2var: from_linked1
+  page2_var_via_environment: for_page2_from_page1_via_current_environment
 ```

data/examples/linked2.md

@@ -3,26 +3,26 @@
 ::: * This is document 2 *
 ::: This document links to a matching document to demonstrate navigation between documents.
 
-::: This Bash block displays the value of variables "linked1var" and "linked2var"
+::: This Bash block displays the value of variables "page1_var_via_environment" and "page2_var_via_environment"
 
-```bash :page2_show_vars
+```bash :show_vars
 source bin/colorize_env_vars.sh
-colorize_env_vars 'on page2' linked1var linked2var
+colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
+colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
 ```
 
-::: This Link block sets variable "linked1var" and navigates to document 1.
+::: This Link block requires a block that
+::: 1. sets environment variable PAGE3_VAR_VIA_INHERIT,
+::: 2. navigates to document 3, and
+::: 3. executes block "show_vars" to display the imported PAGE3_VAR_VIA_INHERIT.
 
-```link :linked1
-file: examples/linked1.md
-vars:
-  linked1var: from_linked2
+```bash :(vars3)
+PAGE3_VAR_VIA_INHERIT=for_page3_from_page2_via_inherited_code_file
 ```
 
-::: This Link block sets variable "linked1var", navigates to document 1, and executes block "page1_show_vars".
-
-```link :linked1_show_vars
-file: examples/linked1.md
-block: page1_show_vars
+```link :linked3_import_vars +(vars3)
+file: examples/linked3.md
+block: show_vars
 vars:
-  linked1var: from_linked2
+  page3_var_via_environment: for_page3_from_page2_via_current_environment
 ```

data/examples/linked3.md

@@ -0,0 +1,12 @@
+# Demo document linking
+
+::: * This is document 3 *
+::: This document is linked from another document to demonstrate code transfer.
+
+::: This Bash block displays the value of variables "PAGE3_VAR_VIA_INHERIT" and "page3_var_via_environment"
+
+```bash :show_vars
+source bin/colorize_env_vars.sh
+colorize_env_vars 'vars for page2' PAGE2_VAR_VIA_INHERIT page2_var_via_environment
+colorize_env_vars 'vars for page3' PAGE3_VAR_VIA_INHERIT page3_var_via_environment
+```

data/lib/block_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 BLOCK_TYPE_BASH = 'bash'
 BLOCK_TYPE_LINK = 'link'
 BLOCK_TYPE_OPTS = 'opts'

data/lib/colorize.rb

@@ -2,81 +2,78 @@
 
 # encoding=utf-8
 
+# Extends Ruby's native String class to include ANSI coloring functionality.
+# Adds methods to apply RGB colors, named colors, and other formatting to strings.
 class String
-  alias_method :original_method_missing, :method_missing
-
+  # Handles dynamic method calls to create RGB colors.
+  #
+  # @param method_name [Symbol] The name of the method being called.
+  # @param args [Array] The arguments passed to the method.
+  # @param block [Proc] An optional block.
+  # @return [String] The formatted string.
   def method_missing(method_name, *args, &block)
-    if /^fg_rgb_/ =~ method_name.to_s
+    case method_name.to_s
+    when /^fg_rgb_/
       fg_rgb_color($'.gsub('_', ';'))
+    when /^fg_rgbh_/
+      hex_to_rgb($')
     else
-      original_method_missing(method_name, *args, &block)
+      super
     end
   end
 
-  # control sequence with reset
+  # Generates an ANSI control sequence for the string.
   #
+  # @return [String] The string wrapped in an ANSI control sequence.
   def ansi_control_sequence
     "\033[#{self}\033[0m"
   end
 
-  # use 24-bit RGB foreground color spec
-  # ex: 1;2;3
+  # Applies a 24-bit RGB foreground color to the string.
   #
+  # @param rgb [String] The RGB color, expressed as a string like "1;2;3".
+  # @return [String] The string with the applied RGB foreground color.
   def fg_rgb_color(rgb)
     "38;2;#{rgb}m#{self}".ansi_control_sequence
   end
 
-  def plain
-    self
-  end
-
-  # named colors
+  # Converts hex color codes to RGB and applies them to the string.
   #
-  def black
-    "30m#{self}".ansi_control_sequence
-  end
-
-  def red
-    "31m#{self}".ansi_control_sequence
+  # @param hex_str [String] The RGB color, expressed as a hex string like "FF00FF".
+  # @return [String] The string with the applied RGB foreground color.
+  def hex_to_rgb(hex_str)
+    fg_rgb_color(
+      hex_str.split('_').map { |hex| hex.to_i(16).to_s }.join(';')
+    )
   end
 
-  def bred
-    "1;31m#{self}".ansi_control_sequence
-  end
-
-  def green
-    "32m#{self}".ansi_control_sequence
-  end
-
-  def bgreen
-    "1;32m#{self}".ansi_control_sequence
-  end
-
-  def yellow
-    "33m#{self}".ansi_control_sequence
-  end
-
-  def byellow
-    "1;33m#{self}".ansi_control_sequence
-  end
-
-  def blue
-    "34m#{self}".ansi_control_sequence
-  end
-
-  def magenta
-    "35m#{self}".ansi_control_sequence
-  end
-
-  def cyan
-    "36m#{self}".ansi_control_sequence
-  end
-
-  def white
-    "37m#{self}".ansi_control_sequence
+  # Provides a plain, unmodified version of the string.
+  #
+  # @return [String] The original string.
+  def plain
+    self
   end
 
-  def bwhite
-    "1;37m#{self}".ansi_control_sequence
-  end
+  # A collection of methods for applying named colors.
+  #
+  # For example, #black applies a black foreground color to the string.
+  # These are provided for convenience and easy readability.
+
+  def black;   "30m#{self}".ansi_control_sequence; end
+  def bred;    "1;31m#{self}".ansi_control_sequence; end
+  def bgreen;  "1;32m#{self}".ansi_control_sequence; end
+  def byellow; "1;33m#{self}".ansi_control_sequence; end
+  def magenta; "35m#{self}".ansi_control_sequence; end
+  def cyan;    "36m#{self}".ansi_control_sequence; end
+  def white;   "37m#{self}".ansi_control_sequence; end
+  def bwhite;  "1;37m#{self}".ansi_control_sequence; end
+
+  # More named colors using RGB hex values
+  def blue;    fg_rgbh_00_00_FF; end
+  def green;   fg_rgbh_00_FF_00; end
+  def indigo;  fg_rgbh_4B_00_82; end
+  def orange;  fg_rgbh_FF_7F_00; end
+  def red;     fg_rgbh_FF_00_00; end
+  def violet;  fg_rgbh_94_00_D3; end
+  def yellow;  fg_rgbh_FF_FF_00; end
 end

data/lib/filter.rb

@@ -38,7 +38,7 @@ module MarkdownExec
       name = fcb.oname
       shell = fcb.fetch(:shell, '')
 
-      apply_name_filters(options, filters, name) #if shell == 'bash'
+      apply_name_filters(options, filters, name)
       apply_shell_filters(options, filters, shell)
       apply_other_filters(options, filters, fcb)
 
@@ -125,7 +125,7 @@ module MarkdownExec
 
       return unless options[:bash_only]
 
-      filters[:shell_default] = (shell == 'bash')
+      filters[:shell_default] = (shell == BLOCK_TYPE_BASH)
     end
 
     # Evaluates the filter settings to make a final decision on
@@ -239,7 +239,7 @@ if $PROGRAM_NAME == __FILE__
 
       def test_bash_only_condition_true
         @options[:bash_only] = true
-        @fcb[:shell] = 'bash'
+        @fcb[:shell] = BLOCK_TYPE_BASH
         assert Filter.fcb_select?(@options, @fcb)
       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.3.9'
+  VERSION = '1.4.1'
 end