markdown_exec 1.3.8 → 1.4

data/lib/colorize.rb

@@ -2,67 +2,78 @@
 
 # encoding=utf-8
 
-# │0  │ to restore default    │
-# │   │ color                 │
-# ├───┼───────────────────────┤
-# │   │                       │
-# │1  │ for brighter colors   │
-# ├───┼───────────────────────┤
-# │   │                       │
-# │4  │ for underlined text   │
-# ├───┼───────────────────────┤
-# │   │                       │
-# │5  │ for flashing text
+# 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
-  def plain
-    self
+  # 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)
+    case method_name.to_s
+    when /^fg_rgb_/
+      fg_rgb_color($'.gsub('_', ';'))
+    when /^fg_rgbh_/
+      hex_to_rgb($')
+    else
+      super
+    end
   end
 
-  def black
-    "\033[30m#{self}\033[0m"
+  # 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
 
-  def red
-    "\033[31m#{self}\033[0m"
+  # 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 bred
-    "\033[1;31m#{self}\033[0m"
+  # Converts hex color codes to RGB and applies them to the string.
+  #
+  # @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 green
-    "\033[32m#{self}\033[0m"
-  end
-
-  def bgreen
-    "\033[1;32m#{self}\033[0m"
-  end
-
-  def yellow
-    "\033[33m#{self}\033[0m"
-  end
-
-  def byellow
-    "\033[1;33m#{self}\033[0m"
-  end
-
-  def blue
-    "\033[34m#{self}\033[0m"
-  end
-
-  def magenta
-    "\033[35m#{self}\033[0m"
+  # Provides a plain, unmodified version of the string.
+  #
+  # @return [String] The original string.
+  def plain
+    self
   end
 
-  def cyan
-    "\033[36m#{self}\033[0m"
-  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 white
-    "\033[37m#{self}\033[0m"
-  end
+  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
 
-  def bwhite
-    "\033[1;37m#{self}\033[0m"
-  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/fcb.rb

@@ -18,7 +18,9 @@ module MarkdownExec
         body: nil,
         call: nil,
         headings: [],
+        dname: nil,
         name: nil,
+        oname: nil,
         reqs: [],
         shell: '',
         title: '',
@@ -27,39 +29,9 @@ module MarkdownExec
       }.merge(options)
     end
 
-    def to_h
-      @attrs
-    end
-
-    def to_yaml
-      @attrs.to_yaml
-    end
-
-    private
-
-    # 2023-10-07 proposed but not functional with code
-    #
-    # def method_missing(method, *args, &block)
-    #   method_name = method.to_s
-
-    #   if method_name[-1] == '='
-    #     @attrs[method_name.chop.to_sym] = args[0]
-    #   elsif @attrs.key?(method_name.to_sym)
-    #     @attrs[method_name.to_sym]
-    #   else
-    #     super
-    #   end
-    # rescue StandardError => err
-    #   warn(error = "ERROR ** FCB.method_missing(method: #{method_name}, *args: #{args.inspect}, &block)")
-    #   warn err.inspect
-    #   warn(caller[0..4])
-    #   raise err  # Here, we simply propagate the original error instead of wrapping it in a StandardError.
-    # end
-
     # :reek:ManualDispatch
     def method_missing(method, *args, &block)
       method_name = method.to_s
-
       if @attrs.respond_to?(method_name)
         @attrs.send(method_name, *args, &block)
       elsif method_name[-1] == '='
@@ -79,6 +51,14 @@ module MarkdownExec
     def respond_to_missing?(method_name, _include_private = false)
       @attrs.key?(method_name.to_sym) || super
     end
+
+    def to_h
+      @attrs
+    end
+
+    def to_yaml
+      @attrs.to_yaml
+    end
   end
 end
 
@@ -92,7 +72,9 @@ if $PROGRAM_NAME == __FILE__
         body: 'Sample body',
         call: 'Sample call',
         headings: %w[Header1 Header2],
+        dname: 'Sample name',
         name: 'Sample name',
+        oname: 'Sample name',
         reqs: %w[req1 req2],
         shell: 'bash',
         text: 'Sample Text',

data/lib/filter.rb

@@ -35,7 +35,7 @@ module MarkdownExec
         wrap_name: nil
       }
 
-      name = fcb.fetch(:name, '')
+      name = fcb.oname
       shell = fcb.fetch(:shell, '')
 
       apply_name_filters(options, filters, name)
@@ -107,7 +107,7 @@ module MarkdownExec
     # @param fcb [Hash] The fenced code block to be evaluated.
     #
     def self.apply_other_filters(options, filters, fcb)
-      name = fcb.fetch(:name, '')
+      name = fcb.oname
       shell = fcb.fetch(:shell, '')
       filters[:fcb_chrome] = fcb.fetch(:chrome, false)
 
@@ -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
@@ -166,13 +166,17 @@ if $PROGRAM_NAME == __FILE__
   require 'bundler/setup'
   Bundler.require(:default)
 
+  require 'fcb'
   require 'minitest/autorun'
 
   module MarkdownExec
     class FilterTest < Minitest::Test
       def setup
         @options = {}
-        @fcb = {}
+        @fcb = FCB.new(
+          dname: nil,
+          oname: nil
+        )
       end
 
       # Tests for fcb_select? method
@@ -191,27 +195,27 @@ if $PROGRAM_NAME == __FILE__
       def test_hidden_name_condition
         @options[:hide_blocks_by_name] = true
         @options[:block_name_hidden_match] = 'hidden'
-        @fcb[:name] = 'hidden_block'
+        @fcb[:oname] = 'hidden_block'
         refute Filter.fcb_select?(@options, @fcb)
       end
 
       def test_include_name_condition
         @options[:hide_blocks_by_name] = true
         @options[:block_name_indlude_match] = 'include'
-        @fcb[:name] = 'include_block'
+        @fcb[:oname] = 'include_block'
         assert Filter.fcb_select?(@options, @fcb)
       end
 
       def test_wrap_name_condition
         @options[:hide_blocks_by_name] = true
         @options[:block_name_wrapper_match] = 'wrap'
-        @fcb[:name] = 'wrap_block'
+        @fcb[:oname] = 'wrap_block'
         assert Filter.fcb_select?(@options, @fcb)
       end
 
       def test_name_exclude_condition
         @options[:block_name] = 'test'
-        @fcb[:name] = 'sample'
+        @fcb[:oname] = 'sample'
         refute Filter.fcb_select?(@options, @fcb)
       end
 
@@ -223,7 +227,7 @@ if $PROGRAM_NAME == __FILE__
 
       def test_name_select_condition
         @options[:select_by_name_regex] = 'select'
-        @fcb[:name] = 'select_this'
+        @fcb[:oname] = 'select_this'
         assert Filter.fcb_select?(@options, @fcb)
       end
 
@@ -235,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.8'
+  VERSION = '1.4'
 end