paintbrush 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c87f82d4c60332bb80901c9b53ba99d027190044b8b6a8a0d91f0577c870846
-  data.tar.gz: cb1e9bd1e7c4fc0b65ac0ae6e50ce02dd62e86d7845192b1b14d18a602f069ce
+  metadata.gz: cb568b4656208e4b1d5e134b9a6982a50be63f9da4a776aa7210a302f65a59ce
+  data.tar.gz: cc92c16814e12eb90e089c5affaa6c4739ecbec1f9121093739c6e776e2aaf0f
 SHA512:
-  metadata.gz: 21bacc0759c545c65c66d70e0fbdb7b406ea1fa224ebcab36e02d9f82ba4e4c0bdbb33dc34f61f52224272ee8c49cae3641d7ca48fdaf0bd5278ae3a3fdf6b08
-  data.tar.gz: a1340e727fe19c354cb5ae43202afe2ddfbdb94d8748cb8cba16edac3c1d88f3293e6825156c65043329d81f84a78ae041adc6e7d99fad52d64fe8cfe5513ea6
+  metadata.gz: dbc3a7c11aedf89c5191e1a538b902235c84e7a540b7d155ee008c1ad58e56a2eb4f139f151d681f06ba93fc7345221130ba0972d7d331ac6e793ef8b7752172
+  data.tar.gz: c2bc6bb3a2e09ec5c9aa2d25c47f1b118cf01e2d10eef340e430806531c05421b11e7292d677d96f12112f1d252d64cb1c673a1f50bcf99d6ac8c0a493a98116

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paintbrush (0.1.0)
+    paintbrush (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'paintbrush'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/paintbrush/bounded_color_element.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Paintbrush
+  # Wraps a Paintbrush::ColorElement instance and maps its start and end boundaries within a
+  # compiled escaped string by matching specific unique (indexed) escape codes. Provides
+  # `#surround?` for detecting if another element exists within the current element's boundaries.
+  class BoundedColorElement
+    def initialize(color_element:, escaped_output:)
+      @color_element = color_element
+      @escaped_output = escaped_output
+    end
+
+    def surround?(element)
+      return false if element == self
+      return false unless element.open_index.between?(open_index, close_index)
+      return false unless element.close_index.between?(open_index, close_index)
+
+      true
+    end
+
+    def inspect
+      "<#{self.class} boundaries=#{boundaries}>"
+    end
+
+    def index
+      color_element.index
+    end
+
+    def code
+      color_element.code
+    end
+
+    def boundaries
+      @boundaries ||= [open_index, close_index]
+    end
+
+    def open_index
+      @open_index ||= escaped_output.index(Escapes.open(index))
+    end
+
+    def close_index
+      escaped_output.index(Escapes.close(index))
+    end
+
+    private
+
+    attr_reader :escaped_output, :color_element
+  end
+end

data/lib/paintbrush/color_element.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Paintbrush
+  # Provides a substring enclosed in unique escape codes for later colorization when the full
+  # string has been created and all interpolation is completed. Adds itself to a provided stack
+  # of ColorElement objects on initialization.
+  class ColorElement
+    attr_reader :stack, :code, :string, :index
+    attr_accessor :open_index, :close_index
+
+    def initialize(stack:, code:, string:)
+      @stack = stack
+      @code = code
+      @string = string
+      @index = stack.size
+      stack << self
+    end
+
+    def to_s
+      "#{Escapes.open(index)}#{string}#{Escapes.close(index)}"
+    end
+
+    def inspect
+      "<#{self.class.name} index=#{index} code=#{code}>"
+    end
+  end
+end

data/lib/paintbrush/colorized_string.rb

@@ -7,7 +7,7 @@ module Paintbrush
   class ColorizedString
     def initialize(&block)
       @block = block
-      @codes = []
+      @stack = []
     end
 
     # Returns a colorized string by injecting escape codes into the various calls to each color
@@ -19,30 +19,43 @@ module Paintbrush
 
     private
 
-    attr_reader :block, :codes
+    attr_reader :block, :stack
 
-    def colorized_string
-      codes.each.with_index.reduce(escaped_output) do |string, (code, index)|
-        restored_color_code = index + 1 == codes.size ? '0' : codes[index + 1]
-        subbed_string(string, index, code, restored_color_code)
+    def colorized_string(string: escaped_output, tree: element_tree)
+      tree[:children].reduce(string) do |output, child|
+        subbed = subbed_string(output, child[:node], tree[:node])
+        next subbed if child[:children].empty?
+
+        colorized_string(string: subbed, tree: child)
+      end
+    end
+
+    def bounded_color_elements
+      @bounded_color_elements ||= stack.map do |color_element|
+        BoundedColorElement.new(color_element: color_element, escaped_output: escaped_output)
       end
     end
 
-    def subbed_string(string, index, code, restored_color_code)
+    def element_tree
+      @element_tree ||= ElementTree.new(bounded_color_elements: bounded_color_elements).tree
+    end
+
+    def subbed_string(string, color_element, parent_color_element)
+      restored_color_code = parent_color_element.nil? ? '0' : parent_color_element.code
       string
-        .sub("#{Colors::ESCAPE_START_OPEN}#{index}#{Colors::ESCAPE_START_CLOSE}", "\e[#{code}m")
-        .sub("#{Colors::ESCAPE_END_OPEN}#{index}#{Colors::ESCAPE_END_CLOSE}", "\e[0m\e[#{restored_color_code}m")
+        .sub(Escapes.open(color_element.index).to_s, "\e[#{color_element.code}m")
+        .sub(Escapes.close(color_element.index).to_s, "\e[0m\e[#{restored_color_code}m")
     end
 
     def escaped_output
-      context.instance_eval(&block)
+      @escaped_output ||= context.instance_eval(&block)
     end
 
     def context
       eval('self', block.binding, __FILE__, __LINE__).dup.tap do |context|
         context.send(:include, Paintbrush::Colors) if context.respond_to?(:include)
         context.send(:extend, Paintbrush::Colors) if context.respond_to?(:extend)
-        context.send(:instance_variable_set, :@__codes, codes)
+        context.send(:instance_variable_set, :@__stack, stack)
       end
     end
   end

data/lib/paintbrush/colors.rb

@@ -6,11 +6,6 @@ module Paintbrush
   # string to be reconstituted afterwards with nested strings restoring the previous color once
   # they have terminated.
   module Colors
-    ESCAPE_START_OPEN = "\e[3;15;17]OPEN:"
-    ESCAPE_START_CLOSE = "\e[3;15;17]CLOSE:"
-    ESCAPE_END_OPEN = "\e[17;15;3]OPEN:"
-    ESCAPE_END_CLOSE = "\e[17;15;3]CLOSE:"
-
     COLOR_CODES = {
       black: '30',
       red: '31',
@@ -25,10 +20,7 @@ module Paintbrush
 
     COLOR_CODES.each do |name, code|
       define_method name do |string|
-        @__codes.push(code)
-        "#{ESCAPE_START_OPEN}#{@__codes.size - 1}#{ESCAPE_START_CLOSE}" \
-          "#{string}" \
-          "#{ESCAPE_END_OPEN}#{@__codes.size - 1}#{ESCAPE_END_CLOSE}"
+        ColorElement.new(stack: @__stack, code: code, string: string).to_s
       end
     end
   end

data/lib/paintbrush/element_tree.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Paintbrush
+  # A tree of BoundedColorElement objects. Used to build a full tree of colorized substrings in
+  # order to allow discovery of parent substrings and use their color code to restore to when the
+  # substring is terminated. Allows deeply-nested colorized strings.
+  class ElementTree
+    attr_reader :tree
+
+    def initialize(bounded_color_elements:)
+      @bounded_color_elements = bounded_color_elements
+      @tree = { node: nil, children: [] }
+      build_tree(boundary_end: bounded_color_elements.map(&:close_index).max)
+    end
+
+    def build_tree(boundary_end:, root: @tree, elements: bounded_color_elements, boundary_start: 0)
+      root_nodes, non_root_nodes = partitioned_elements(elements, boundary_start, boundary_end)
+
+      root_nodes.each do |node|
+        root[:children] << child_node(node)
+        build_tree(
+          root: root[:children].last,
+          elements: non_root_nodes,
+          boundary_start: node.open_index,
+          boundary_end: node.close_index
+        )
+      end
+    end
+
+    private
+
+    attr_reader :bounded_color_elements
+
+    def child_node(node)
+      { node: node, children: [] }
+    end
+
+    def partitioned_elements(elements, boundary_start, boundary_end)
+      elements.partition do |element|
+        next false if elements.any? { |child| child.surround?(element) }
+
+        element.boundaries.all? { |index| index.between?(boundary_start, boundary_end) }
+      end
+    end
+  end
+end

data/lib/paintbrush/escapes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Paintbrush
+  # Provides an authority on escape code generation. Provides `.close` and `.open`, both of which
+  # receive an index (i.e. the current size of the stack). Used for escape code insertion and comparison.
+  module Escapes
+    def self.open(index)
+      "\e[3;15;17]START_OPEN:#{index}:\e[3;15;17]START_CLOSE"
+    end
+
+    def self.close(index)
+      "\e[17;15;3]END_OPEN:#{index}:\e[17;15;3]END_CLOSE"
+    end
+  end
+end

data/lib/paintbrush/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paintbrush
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/paintbrush.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 require_relative 'paintbrush/version'
+require_relative 'paintbrush/escapes'
 require_relative 'paintbrush/colors'
 require_relative 'paintbrush/colorized_string'
+require_relative 'paintbrush/color_element'
+require_relative 'paintbrush/bounded_color_element'
+require_relative 'paintbrush/element_tree'
 
 # Colorizes a string, provides `#paintbrush`. When included/extended in a class, call
 # `#paintbrush` and pass a block to use the provided dynamically defined methods, e.g.:
@@ -16,9 +20,11 @@ require_relative 'paintbrush/colorized_string'
 #   end
 # ```
 module Paintbrush
-  class Error < StandardError; end
+  def self.paintbrush(&block)
+    ColorizedString.new(&block).colorized
+  end
 
   def paintbrush(&block)
-    ColorizedString.new(&block).colorized
+    Paintbrush.paintbrush(&block)
   end
 end

data/rspec-documentation/bundle/introduction.html

@@ -0,0 +1,312 @@
+<html>
+  <head>
+    <link rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.3/css/bootstrap.min.css"
+    integrity="sha512-SbiR/eusphKoMVVXysTKG/7VseWii+Y3FdHrt0EpKgpToZeemhqHeZeLWLhJutz/2ut2Vw1uQEj2MbRF+TVBUA=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer" />
+    <style>
+
+      .code {
+        font-family: monospace;
+        max-height: 30rem;
+        overflow-y: auto;
+      }
+
+      h1.title {
+        display: inline;
+      }
+
+      .header .separator {
+        display: inline-block;
+        height: 2.5rem;
+      }
+
+      .version {
+        color: #bbb;
+        font-size: 2rem;
+      }
+
+      .ansi-html {
+        display: inline-block;
+        background-color: #2e2e2e;
+        border: 5px solid #2e2e2e;
+        border-radius: 10px;
+      }
+
+      .ansi-html .ansi-color-0 { color: #555555; }
+      .ansi-html .ansi-color-1 { color: #ff0000; }
+      .ansi-html .ansi-color-2 { color: #47ff47; }
+      .ansi-html .ansi-color-3 { color: #e9e947; }
+      .ansi-html .ansi-color-4 { color: #49a0dd; }
+      .ansi-html .ansi-color-5 { color: #8d7eeb; }
+      .ansi-html .ansi-color-6 { color: #2eecff; }
+      .ansi-html .ansi-color-7 { color: #ffffff; }
+      .ansi-html .ansi-color-9 { color: #606060; }
+      .ansi-html .ansi-color-reset { color: #dddddd; }
+
+      .highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight, .highlight .w {
+  color: #24292f;
+  background-color: #f6f8fa;
+}
+.highlight .k, .highlight .kd, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kt, .highlight .kv {
+  color: #cf222e;
+}
+.highlight .gr {
+  color: #f6f8fa;
+}
+.highlight .gd {
+  color: #82071e;
+  background-color: #ffebe9;
+}
+.highlight .nb {
+  color: #953800;
+}
+.highlight .nc {
+  color: #953800;
+}
+.highlight .no {
+  color: #953800;
+}
+.highlight .nn {
+  color: #953800;
+}
+.highlight .sr {
+  color: #116329;
+}
+.highlight .na {
+  color: #116329;
+}
+.highlight .nt {
+  color: #116329;
+}
+.highlight .gi {
+  color: #116329;
+  background-color: #dafbe1;
+}
+.highlight .kc {
+  color: #0550ae;
+}
+.highlight .l, .highlight .ld, .highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
+  color: #0550ae;
+}
+.highlight .sb {
+  color: #0550ae;
+}
+.highlight .bp {
+  color: #0550ae;
+}
+.highlight .ne {
+  color: #0550ae;
+}
+.highlight .nl {
+  color: #0550ae;
+}
+.highlight .py {
+  color: #0550ae;
+}
+.highlight .nv, .highlight .vc, .highlight .vg, .highlight .vi, .highlight .vm {
+  color: #0550ae;
+}
+.highlight .o, .highlight .ow {
+  color: #0550ae;
+}
+.highlight .gh {
+  color: #0550ae;
+  font-weight: bold;
+}
+.highlight .gu {
+  color: #0550ae;
+  font-weight: bold;
+}
+.highlight .s, .highlight .sa, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .se, .highlight .sh, .highlight .sx, .highlight .s1, .highlight .ss {
+  color: #0a3069;
+}
+.highlight .nd {
+  color: #8250df;
+}
+.highlight .nf, .highlight .fm {
+  color: #8250df;
+}
+.highlight .err {
+  color: #f6f8fa;
+  background-color: #82071e;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cp, .highlight .cpf, .highlight .c1, .highlight .cs {
+  color: #6e7781;
+}
+.highlight .gl {
+  color: #6e7781;
+}
+.highlight .gt {
+  color: #6e7781;
+}
+.highlight .ni {
+  color: #24292f;
+}
+.highlight .si {
+  color: #24292f;
+}
+.highlight .ge {
+  color: #24292f;
+  font-style: italic;
+}
+.highlight .gs {
+  color: #24292f;
+  font-weight: bold;
+}
+
+    </style>
+  </head>
+
+  <body>
+    <div class="container m-3 p-3">
+      <div class="header p-3 m-3 w-90 text-end">
+  <h1 class="title">paintbrush</h1>
+  <span class="separator border-end pb-2 ms-2 me-2"></span>
+  <span class="version">0.1.0</span>
+</div>
+
+<hr/>
+
+
+      <div class="row">
+        <div class="col-auto page-tree fs-6 mt-1 ms-3 me-3">
+          
+            <li>
+          
+            <a href='/home/bob/dev/paintbrush/rspec-documentation/bundle/introduction.html'>Introduction</a>
+          
+            </li>
+          
+            <ul>
+          
+            </ul>
+          
+        </div>
+
+        <div class="col">
+          <h1 id="paintbrush">Paintbrush</h1>
+
+<p>Simple and concise string colorization for <em>Ruby</em> without overloading <code>String</code> methods or requiring verbose class/method invocation.</p>
+
+<p><em>Paintbrush</em> has zero dependencies and does not pollute any namespaces or objects outside of the <code>#paintbrush</code> method wherever you include the <code>Paintbrush</code> module.</p>
+
+<p>Nesting is supported, allowing you to use multiple colors within the same string. The previous color is automatically restored.</p>
+
+<div location="9"><button type="button" class="btn btn-primary float-end" data-bs-toggle="modal" data-bs-target="#modal-15cae418-087d-45aa-b936-ea2c34033c01-side-by-side"> View Side-by-side </button>   <div class="modal fade" id="modal-15cae418-087d-45aa-b936-ea2c34033c01-side-by-side" data-bs-backdrop="static" data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
+    <div class="modal-dialog modal-xl">
+      <div class="modal-content">
+        <div class="modal-header">
+          <h5 class="modal-title" id="modal-15cae418-087d-45aa-b936-ea2c34033c01-side-by-side-label">Side-by-side view</h5>
+ <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+        </div>
+        <div class="modal-body">
+          <div class="container p-3">
+            <div class="row border">
+              <div class="col border">
+                <div class="p-3 mb-5 code highlight">
+<span class="nb">require</span> <span class="s1">'paintbrush'</span><br /><br /><span class="kp">extend</span> <span class="no">Paintbrush</span><br /><br /><span class="n">output</span> <span class="o">=</span> <span class="n">paintbrush</span> <span class="p">{</span> <span class="n">purple</span> <span class="s2">"You used </span><span class="si">#{</span><span class="n">green</span> <span class="s1">'four'</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">blue</span> <span class="s2">"(</span><span class="si">#{</span><span class="n">cyan</span> <span class="s1">'4'</span><span class="si">}</span><span class="s2">)"</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">yellow</span> <span class="s1">'colors'</span><span class="si">}</span><span class="s2"> today!"</span> <span class="p">}</span><br /><span class="n">it_documents</span> <span class="n">output</span> <span class="k">do</span><br />  <span class="n">expect</span><span class="p">(</span><span class="n">output</span><span class="p">).</span><span class="nf">to</span> <span class="n">eql</span> <span class="s2">"</span><span class="se">\e</span><span class="s2">[35mYou used </span><span class="se">\e</span><span class="s2">[32mfour</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[35m "</span> <span class="p">\</span><br />                        <span class="s2">"</span><span class="se">\e</span><span class="s2">[34m(</span><span class="se">\e</span><span class="s2">[36m4</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[34m)</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[35m "</span> <span class="p">\</span><br />                        <span class="s2">"</span><span class="se">\e</span><span class="s2">[33mcolors</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[35m today!</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[0m"</span><br /><span class="k">end</span><br />
+                </div>
+              </div>
+              <div class="col border">
+                <div class="p-3 mb-5 code highlight">
+                  <div class="ansi-html border m-1 p-4">
+<span></span><span class="ansi-color-5">You used </span><span class="ansi-color-2">four</span><span class="ansi-color-reset"></span><span class="ansi-color-5"> </span><span class="ansi-color-4">(</span><span class="ansi-color-6">4</span><span class="ansi-color-reset"></span><span class="ansi-color-4">)</span><span class="ansi-color-reset"></span><span class="ansi-color-5"> </span><span class="ansi-color-3">colors</span><span class="ansi-color-reset"></span><span class="ansi-color-5"> today!</span><span class="ansi-color-reset"></span><span class="ansi-color-reset"></span>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div class="modal-footer">
+<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+        </div>
+      </div>
+    </div>
+  </div>
+  <ul class="nav nav-tabs" id="html-tabs-15cae418-087d-45aa-b936-ea2c34033c01" role="tablist">
+    <li class="nav-item" role="presentation"><button class="nav-link active" id="code-source-15cae418-087d-45aa-b936-ea2c34033c01-tab" data-bs-toggle="tab" data-bs-target="#code-source-15cae418-087d-45aa-b936-ea2c34033c01" type="button" role="tab" aria-controls="code-source" aria-selected="true">Code</button></li>
+    <li class="nav-item" role="presentation"><button class="nav-link" id="rendered-15cae418-087d-45aa-b936-ea2c34033c01-tab" data-bs-toggle="tab" data-bs-target="#rendered-15cae418-087d-45aa-b936-ea2c34033c01" type="button" role="tab" aria-controls="rendered" aria-selected="false">Output</button></li>
+  </ul>
+  <div class="tab-content" id="html-tab-content-15cae418-087d-45aa-b936-ea2c34033c01">
+    <div class="tab-pane fade show active" id="code-source-15cae418-087d-45aa-b936-ea2c34033c01" role="tabpanel" aria-labelledby="code-source-15cae418-087d-45aa-b936-ea2c34033c01-tab">
+      <div class="p-3 mb-5 code highlight">
+<span class="nb">require</span> <span class="s1">'paintbrush'</span><br /><br /><span class="kp">extend</span> <span class="no">Paintbrush</span><br /><br /><span class="n">output</span> <span class="o">=</span> <span class="n">paintbrush</span> <span class="p">{</span> <span class="n">purple</span> <span class="s2">"You used </span><span class="si">#{</span><span class="n">green</span> <span class="s1">'four'</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">blue</span> <span class="s2">"(</span><span class="si">#{</span><span class="n">cyan</span> <span class="s1">'4'</span><span class="si">}</span><span class="s2">)"</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">yellow</span> <span class="s1">'colors'</span><span class="si">}</span><span class="s2"> today!"</span> <span class="p">}</span><br /><span class="n">it_documents</span> <span class="n">output</span> <span class="k">do</span><br />  <span class="n">expect</span><span class="p">(</span><span class="n">output</span><span class="p">).</span><span class="nf">to</span> <span class="n">eql</span> <span class="s2">"</span><span class="se">\e</span><span class="s2">[35mYou used </span><span class="se">\e</span><span class="s2">[32mfour</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[35m "</span> <span class="p">\</span><br />                        <span class="s2">"</span><span class="se">\e</span><span class="s2">[34m(</span><span class="se">\e</span><span class="s2">[36m4</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[34m)</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[35m "</span> <span class="p">\</span><br />                        <span class="s2">"</span><span class="se">\e</span><span class="s2">[33mcolors</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[35m today!</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[0m"</span><br /><span class="k">end</span><br />
+      </div>
+    </div>
+    <div class="tab-pane fade" id="rendered-15cae418-087d-45aa-b936-ea2c34033c01" role="tabpanel" aria-labelledby="rendered-15cae418-087d-45aa-b936-ea2c34033c01-tab">
+      <div class="p-3 mb-5 code highlight">
+        <div class="ansi-html border m-1 p-4">
+<span></span><span class="ansi-color-5">You used </span><span class="ansi-color-2">four</span><span class="ansi-color-reset"></span><span class="ansi-color-5"> </span><span class="ansi-color-4">(</span><span class="ansi-color-6">4</span><span class="ansi-color-reset"></span><span class="ansi-color-4">)</span><span class="ansi-color-reset"></span><span class="ansi-color-5"> </span><span class="ansi-color-3">colors</span><span class="ansi-color-reset"></span><span class="ansi-color-5"> today!</span><span class="ansi-color-reset"></span><span class="ansi-color-reset"></span>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+<div location="22"><button type="button" class="btn btn-primary float-end" data-bs-toggle="modal" data-bs-target="#modal-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-side-by-side"> View Side-by-side </button>   <div class="modal fade" id="modal-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-side-by-side" data-bs-backdrop="static" data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
+    <div class="modal-dialog modal-xl">
+      <div class="modal-content">
+        <div class="modal-header">
+          <h5 class="modal-title" id="modal-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-side-by-side-label">Side-by-side view</h5>
+ <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+        </div>
+        <div class="modal-body">
+          <div class="container p-3">
+            <div class="row border">
+              <div class="col border">
+                <div class="p-3 mb-5 code highlight">
+<span class="nb">require</span> <span class="s1">'paintbrush'</span><br /><br /><span class="kp">extend</span> <span class="no">Paintbrush</span><br /><br /><span class="n">output</span> <span class="o">=</span> <span class="n">paintbrush</span> <span class="k">do</span><br />  <span class="s2">"</span><span class="si">#{</span><span class="n">blue</span> <span class="s1">'foo'</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">green</span> <span class="s2">"bar </span><span class="si">#{</span><span class="n">cyan</span> <span class="sx">%w[foo bar baz]</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s1">', '</span><span class="p">)</span><span class="si">}</span><span class="s2"> with </span><span class="si">#{</span><span class="n">cyan</span> <span class="s1">'qux'</span><span class="si">}</span><span class="s2"> and quux"</span><span class="si">}</span><span class="s2"> and corge"</span><br /><span class="k">end</span><br /><br /><span class="n">it_documents</span> <span class="n">output</span> <span class="k">do</span><br />  <span class="n">expect</span><span class="p">(</span><span class="n">output</span><span class="p">).</span><span class="nf">to</span> <span class="n">eql</span> <span class="s2">"</span><span class="se">\e</span><span class="s2">[34mfoo</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[0m </span><span class="se">\e</span><span class="s2">[32mbar </span><span class="se">\e</span><span class="s2">[36mfoo, bar, baz"</span> <span class="p">\</span><br />                        <span class="s2">"</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[32m with </span><span class="se">\e</span><span class="s2">[36mqux</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[32m "</span><span class="p">\</span><br />                        <span class="s2">"and quux</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[0m and corge"</span><br /><span class="k">end</span><br />
+                </div>
+              </div>
+              <div class="col border">
+                <div class="p-3 mb-5 code highlight">
+                  <div class="ansi-html border m-1 p-4">
+<span></span><span class="ansi-color-4">foo</span><span class="ansi-color-reset"></span><span class="ansi-color-reset"> </span><span class="ansi-color-2">bar </span><span class="ansi-color-6">foo, bar, baz</span><span class="ansi-color-reset"></span><span class="ansi-color-2"> with </span><span class="ansi-color-6">qux</span><span class="ansi-color-reset"></span><span class="ansi-color-2"> and quux</span><span class="ansi-color-reset"></span><span class="ansi-color-reset"> and corge</span>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div class="modal-footer">
+<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+        </div>
+      </div>
+    </div>
+  </div>
+  <ul class="nav nav-tabs" id="html-tabs-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0" role="tablist">
+    <li class="nav-item" role="presentation"><button class="nav-link active" id="code-source-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-tab" data-bs-toggle="tab" data-bs-target="#code-source-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0" type="button" role="tab" aria-controls="code-source" aria-selected="true">Code</button></li>
+    <li class="nav-item" role="presentation"><button class="nav-link" id="rendered-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-tab" data-bs-toggle="tab" data-bs-target="#rendered-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0" type="button" role="tab" aria-controls="rendered" aria-selected="false">Output</button></li>
+  </ul>
+  <div class="tab-content" id="html-tab-content-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0">
+    <div class="tab-pane fade show active" id="code-source-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0" role="tabpanel" aria-labelledby="code-source-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-tab">
+      <div class="p-3 mb-5 code highlight">
+<span class="nb">require</span> <span class="s1">'paintbrush'</span><br /><br /><span class="kp">extend</span> <span class="no">Paintbrush</span><br /><br /><span class="n">output</span> <span class="o">=</span> <span class="n">paintbrush</span> <span class="k">do</span><br />  <span class="s2">"</span><span class="si">#{</span><span class="n">blue</span> <span class="s1">'foo'</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">green</span> <span class="s2">"bar </span><span class="si">#{</span><span class="n">cyan</span> <span class="sx">%w[foo bar baz]</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s1">', '</span><span class="p">)</span><span class="si">}</span><span class="s2"> with </span><span class="si">#{</span><span class="n">cyan</span> <span class="s1">'qux'</span><span class="si">}</span><span class="s2"> and quux"</span><span class="si">}</span><span class="s2"> and corge"</span><br /><span class="k">end</span><br /><br /><span class="n">it_documents</span> <span class="n">output</span> <span class="k">do</span><br />  <span class="n">expect</span><span class="p">(</span><span class="n">output</span><span class="p">).</span><span class="nf">to</span> <span class="n">eql</span> <span class="s2">"</span><span class="se">\e</span><span class="s2">[34mfoo</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[0m </span><span class="se">\e</span><span class="s2">[32mbar </span><span class="se">\e</span><span class="s2">[36mfoo, bar, baz"</span> <span class="p">\</span><br />                        <span class="s2">"</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[32m with </span><span class="se">\e</span><span class="s2">[36mqux</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[32m "</span><span class="p">\</span><br />                        <span class="s2">"and quux</span><span class="se">\e</span><span class="s2">[0m</span><span class="se">\e</span><span class="s2">[0m and corge"</span><br /><span class="k">end</span><br />
+      </div>
+    </div>
+    <div class="tab-pane fade" id="rendered-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0" role="tabpanel" aria-labelledby="rendered-c3e2bbb8-9a13-4400-93a1-0e6c9847cba0-tab">
+      <div class="p-3 mb-5 code highlight">
+        <div class="ansi-html border m-1 p-4">
+<span></span><span class="ansi-color-4">foo</span><span class="ansi-color-reset"></span><span class="ansi-color-reset"> </span><span class="ansi-color-2">bar </span><span class="ansi-color-6">foo, bar, baz</span><span class="ansi-color-reset"></span><span class="ansi-color-2"> with </span><span class="ansi-color-6">qux</span><span class="ansi-color-reset"></span><span class="ansi-color-2"> and quux</span><span class="ansi-color-reset"></span><span class="ansi-color-reset"> and corge</span>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+        </div>
+      </div>
+      <hr/>
+
+    </div>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.3/js/bootstrap.bundle.min.js"
+            integrity="sha512-i9cEfJwUwViEPFKdC1enz4ZRGBj8YQo6QByFTF92YXHi7waCqyexvRD75S5NVTsSiTv7rKWqG9Y5eFxmRsOn0A=="
+            crossorigin="anonymous"
+            referrerpolicy="no-referrer"></script>
+  </body>
+</html>

data/rspec-documentation/pages/Introduction.md

@@ -0,0 +1,36 @@
+# Paintbrush
+
+Simple and concise string colorization for _Ruby_ without overloading `String` methods or requiring verbose class/method invocation.
+
+_Paintbrush_ has zero dependencies and does not pollute any namespaces or objects outside of the `#paintbrush` method wherever you include the `Paintbrush` module.
+
+Nesting is supported, allowing you to use multiple colors within the same string. The previous color is automatically restored.
+
+```rspec:ansi
+require 'paintbrush'
+
+extend Paintbrush
+
+output = paintbrush { purple "You used #{green 'four'} #{blue "(#{cyan '4'})"} #{yellow 'colors'} today!" }
+it_documents output do
+  expect(output).to eql "\e[35mYou used \e[32mfour\e[0m\e[35m " \
+                        "\e[34m(\e[36m4\e[0m\e[34m)\e[0m\e[35m " \
+                        "\e[33mcolors\e[0m\e[35m today!\e[0m\e[0m"
+end
+```
+
+```rspec:ansi
+require 'paintbrush'
+
+extend Paintbrush
+
+output = paintbrush do
+  "#{blue 'foo'} #{green "bar #{cyan %w[foo bar baz].join(', ')} with #{cyan 'qux'} and quux"} and corge"
+end
+
+it_documents output do
+  expect(output).to eql "\e[34mfoo\e[0m\e[0m \e[32mbar \e[36mfoo, bar, baz" \
+                        "\e[0m\e[32m with \e[36mqux\e[0m\e[32m "\
+                        "and quux\e[0m\e[0m and corge"
+end
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paintbrush
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies: []
 description: Provides a set of encapsulated methods for nested colorization of strings.
 email:
@@ -28,10 +28,16 @@ files:
 - Rakefile
 - doc/example.png
 - lib/paintbrush.rb
+- lib/paintbrush/bounded_color_element.rb
+- lib/paintbrush/color_element.rb
 - lib/paintbrush/colorized_string.rb
 - lib/paintbrush/colors.rb
+- lib/paintbrush/element_tree.rb
+- lib/paintbrush/escapes.rb
 - lib/paintbrush/version.rb
 - paintbrush.gemspec
+- rspec-documentation/bundle/introduction.html
+- rspec-documentation/pages/Introduction.md
 - sig/paintbrush.rbs
 homepage: https://github.com/bobf/paintbrush
 licenses: []