paintbrush 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c87f82d4c60332bb80901c9b53ba99d027190044b8b6a8a0d91f0577c870846
+  data.tar.gz: cb1e9bd1e7c4fc0b65ac0ae6e50ce02dd62e86d7845192b1b14d18a602f069ce
+SHA512:
+  metadata.gz: 21bacc0759c545c65c66d70e0fbdb7b406ea1fa224ebcab36e02d9f82ba4e4c0bdbb33dc34f61f52224272ee8c49cae3641d7ca48fdaf0bd5278ae3a3fdf6b08
+  data.tar.gz: a1340e727fe19c354cb5ae43202afe2ddfbdb94d8748cb8cba16edac3c1d88f3293e6825156c65043329d81f84a78ae041adc6e7d99fad52d64fe8cfe5513ea6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paintbrush.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'devpack', '~> 0.4.1'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.51'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.22'
+gem 'strong_versions', '~> 0.4.5'

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    paintbrush (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    devpack (0.4.1)
+    diff-lcs (1.5.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    paint (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
+      paint (~> 2.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devpack (~> 0.4.1)
+  paintbrush!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.51)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.22)
+  strong_versions (~> 0.4.5)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Robert Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,78 @@
+# 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.
+
+```ruby
+include Paintbrush
+puts paintbrush { purple "You used #{green 'four'} #{blue "(#{cyan '4'})"} #{yellow 'colors'} today!" }
+```
+![example](doc/example.png "Example")
+
+## Installation
+
+Add _Paintbrush_ to your `Gemfile`:
+
+```ruby
+gem 'paintbrush'
+```
+
+Build your bundle:
+
+```ruby
+bundle install
+```
+
+## Usage
+
+Include the `Paintbrush` module anywhere and call `#paintbrush` to generate a colorized string. Nested strings are supported, allowing many complex combinations to be written in a single line.
+
+`#paintbrush` receives a block, within the block the following methods are available, each of which receives a string:
+
+* `#black`
+* `#red`
+* `#green`
+* `#yellow`
+* `#blue`
+* `#purple`
+* `#cyan`
+* `#white`
+* `#default`
+
+Use [string interpolation](https://docs.ruby-lang.org/en/3.2/syntax/literals_rdoc.html#label-String+Literals) to nest multiple colors:
+
+```ruby
+include Paintbrush
+puts paintbrush { green "some green text, #{yellow "some yellow text"} and some green again" }
+```
+
+## Alternatives
+
+* [Colorize](https://github.com/fazibear/colorize)
+* [Rainbow](https://github.com/sickill/rainbow)
+* [Paint](https://github.com/janlelis/paint)
+
+And [many others](https://www.ruby-toolbox.com/search?display=compact&order=score&q=string%20color&show_forks=false).
+
+## Motivation
+
+There are plenty of gems that solve this problem in various ways but I was unable to find one that achieves all of the following:
+
+* Support for nested strings.
+* No pollution of _Ruby_ `String` objects.
+* Concise syntax allowing strings to be generated in-line.
+
+This gem is an attempt to achieve all of the above. If it's not for you, take a look at one of the alternatives (see above).
+
+## Development
+
+Make a pull request to fix a bug or add a feature.
+
+Run `make test` to verify all tests and lint checks have passed.
+
+## License
+
+_Paintbrush_ is released under the [MIT License](https://opensource.org/license/mit/).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/paintbrush/colorized_string.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Paintbrush
+  # Core string colorization, provides various methods for colorizing a string, uses escape
+  # sequences to store references to start and end of each coloring method to allow nested
+  # colorizing with string interpolation within each individual call to `paintbrush`.
+  class ColorizedString
+    def initialize(&block)
+      @block = block
+      @codes = []
+    end
+
+    # Returns a colorized string by injecting escape codes into the various calls to each color
+    # method in the provided block, rebuilds the string and returns the value with regular ANSI
+    # color codes ready to be output to a console.
+    def colorized
+      colorized_string
+    end
+
+    private
+
+    attr_reader :block, :codes
+
+    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)
+      end
+    end
+
+    def subbed_string(string, index, code, restored_color_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")
+    end
+
+    def 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)
+      end
+    end
+  end
+end

data/lib/paintbrush/colors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Paintbrush
+  # Provides methods that are temporarily injected into block context. Each method returns an
+  # escaped string including the current stack size with start and end escape codes, allowing the
+  # 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',
+      green: '32',
+      yellow: '33',
+      blue: '34',
+      purple: '35',
+      cyan: '36',
+      white: '37',
+      default: '39'
+    }.freeze
+
+    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}"
+      end
+    end
+  end
+end

data/lib/paintbrush/version.rb

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

data/lib/paintbrush.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'paintbrush/version'
+require_relative 'paintbrush/colors'
+require_relative 'paintbrush/colorized_string'
+
+# 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.:
+#
+# ```ruby
+# class Foo
+#   include Paintbrush
+#
+#   def bar
+#     puts paintbrush { cyan("hello #{green("there")}) }
+#   end
+# ```
+module Paintbrush
+  class Error < StandardError; end
+
+  def paintbrush(&block)
+    ColorizedString.new(&block).colorized
+  end
+end

data/paintbrush.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/paintbrush/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'paintbrush'
+  spec.version = Paintbrush::VERSION
+  spec.authors = ['Bob Farrell']
+  spec.email = ['git@bob.frl']
+
+  spec.summary = 'Hassle-free text coloring for console applications.'
+  spec.description = 'Provides a set of encapsulated methods for nested colorization of strings.'
+  spec.homepage = 'https://github.com/bobf/paintbrush'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/paintbrush.rbs

@@ -0,0 +1,4 @@
+module Paintbrush
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: paintbrush
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-24 00:00:00.000000000 Z
+dependencies: []
+description: Provides a set of encapsulated methods for nested colorization of strings.
+email:
+- git@bob.frl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- doc/example.png
+- lib/paintbrush.rb
+- lib/paintbrush/colorized_string.rb
+- lib/paintbrush/colors.rb
+- lib/paintbrush/version.rb
+- paintbrush.gemspec
+- sig/paintbrush.rbs
+homepage: https://github.com/bobf/paintbrush
+licenses: []
+metadata:
+  homepage_uri: https://github.com/bobf/paintbrush
+  source_code_uri: https://github.com/bobf/paintbrush
+  changelog_uri: https://github.com/bobf/paintbrush
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Hassle-free text coloring for console applications.
+test_files: []