ttyhue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb7345390820acfae134f75dc1981a94237f2f928923e69b811b054beefbdeca
+  data.tar.gz: e538fbdd297be620d19b00734fa45e32997d6a41908536135b040e1816ab2abe
+SHA512:
+  metadata.gz: 172e42263db78b3eaa8ed2560a2f175868d3ef15022f95de19912302398086cd21cc62d3bb305cdfbfbfa2846d3111d62887cfaee88125c41f4bba533fcf180c
+  data.tar.gz: a7cf357df077c92732886b0909e7741283688592c9830c6ecb3f0331ec18d03eb11a1e6343edd779ffaa4eeea9f585dc4d7dbf050888fcd3eb773d973434db29

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    ttyhue (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    minitest (5.16.3)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.6)
+    ruby-progressbar (1.11.0)
+    shoulda-context (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (= 5.16.3)
+  minitest-reporters (= 1.5.0)
+  rake (~> 13.0)
+  shoulda-context (= 2.0.0)
+  ttyhue!
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Dominik Sito.
+
+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/README.md

@@ -0,0 +1,93 @@
+# TTYHue
+Ruby gem for colorizing terminal output, supporting terminal theme colors as well as more fine-grained gui colors palette.
+
+## Features
+* no runtime dependencies
+* easy to use formatting HTML-like syntax
+* support for custom styles
+
+## Usage
+Installation
+```bash
+$ gem install ttyhue
+```
+
+```ruby
+require 'ttyhue'
+```
+### Terminal theme colors
+
+`TTYHue` supports default formatting for terminal theme colors:
+```ruby
+TTYHue.c "This is {red}red{/red} and this is {blue}blue{/blue}"
+```
+including color `light` options
+```ruby
+TTYHue.c "This is {lred}light red{/lred} and this is {lblue}light blue{/lblue}"
+```
+... or background mode
+```ruby
+TTYHue.c "This is {blred}light red background{/blred} and this is {bblue}blue background{/bblue}"
+```
+All possible options can be listed by:
+```ruby
+    TTYHue.preview_termcolors
+```
+![screenshot](https://raw.githubusercontent.com/railis/ttyhue/master/examples/term_colors.png)
+
+### GUI colors
+
+`TTYHue` also supports term color codes (0-255) directly by prefixing the corresponding code with `gui`.
+
+```ruby
+TTYHue.c "This is {gui123}foreground{gui123} and {bgui123}background{/bgui123}"
+```
+The absolute list of color codes can be previewed by typing:
+```ruby
+TTYHue.preview_guicolors
+```
+![screenshot](https://raw.githubusercontent.com/railis/ttyhue/master/examples/gui_colors.png)
+
+### Custom styles
+
+In order to improve readability, color codes can be wrapped into custom styles.
+
+```ruby
+TTYHUe.c(
+  "{header}Title{/header}\n{content}Content{/content}\n{footer}Footer{/footer}",
+  header: {fg: :blue},
+  content: {fg: :lgray, bg: :gui234},
+  footer: {fg: :gui252}
+)
+```
+
+Custom styles can be set globally as well.
+```ruby
+TTYHue.set_style(
+  header: {fg: :blue},
+  content: {fg: :lgray, bg: :gui234},
+  footer: {fg: :gui252}
+)
+
+TTYHue.c "{header}Title{/header}\n{content}Content{/content}\n{footer}Footer{/footer}"
+```
+## Contributing
+
+### Workflow
+
+1. Fork it ( https://github.com/railis/ttyhue/fork )
+2. Create your feature branch (`git checkout -b new_feature`)
+3. Commit your changes (`git commit -am 'Commit feature'`)
+4. Push to the branch (`git push origin new_feature`)
+5. Create a new Pull Request
+
+### Running tests
+
+```bash
+$ bundle install
+$ rake test
+```
+
+## Copyright
+
+Copyright (c) 2022 Dominik Sito. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: %i[]
+Rake::TestTask.new do |task|
+  task.pattern = "test/ttyhue/*_test.rb"
+end

data/lib/ttyhue/colorizer.rb

@@ -0,0 +1,39 @@
+module TTYHue
+  class Colorizer
+
+    class << self
+
+      def colorize(str)
+        Parser.new(str).parse.map do |parsed_section|
+          colorized_section(parsed_section)
+        end.join
+      end
+
+      private
+
+      def colorized_section(section)
+        "".tap do |str|
+          if section[:bg] == :default && section[:fg] == :default
+            str << section[:str]
+          else
+            str << closing_byte
+            str << opening_csi_for_color(section[:fg], false) if section[:fg] != :default
+            str << opening_csi_for_color(section[:bg], true) if section[:bg] != :default
+            str << section[:str]
+            str << closing_byte
+          end
+        end
+      end
+
+      def opening_csi_for_color(color, bg)
+        "\x1b[#{TermColor.by_name(color).term_hex(bg)}m"
+      end
+
+      def closing_byte
+        "\033[m"
+      end
+
+    end
+
+  end
+end

data/lib/ttyhue/parser/color_stack.rb

@@ -0,0 +1,30 @@
+module TTYHue
+  class Parser
+    class ColorStack
+
+      def initialize
+        @stack = []
+      end
+
+      def push(value, opts={})
+        @stack.unshift({value: value, opts: opts})
+      end
+
+      def pop(value, opts={})
+        @stack.each_with_index do |v,i|
+          if v[:value] == value && v[:opts] == opts
+            @stack.delete_at(i)
+            break
+          end
+        end
+      end
+
+      def top(opts={})
+        @stack.select do |e|
+          e[:opts] == opts
+        end.first.to_h[:value]
+      end
+
+    end
+  end
+end

data/lib/ttyhue/parser/color_tag.rb

@@ -0,0 +1,25 @@
+module TTYHue
+  class Parser
+    class ColorTag < Tag
+
+      def regexp
+        /{(?<closing>\/?)(?<bg>b?)(?<name>#{TermColor.defs.map(&:tag_name).join("|")})}/
+      end
+
+      attr_reader :color_name, :bg
+
+      def bg
+        @match_data[:bg] != ""
+      end
+
+      def closing
+        @match_data[:closing] != ""
+      end
+
+      def color_name
+        TermColor.by_tag(@match_data[:name]).color_name
+      end
+
+    end
+  end
+end

data/lib/ttyhue/parser/style_tag.rb

@@ -0,0 +1,30 @@
+module TTYHue
+  class Parser
+    class StyleTag < Tag
+
+      def regexp
+        /{(?<closing>\/?)(?<name>#{@styles.keys.map(&:to_s).join("|")})}/
+      end
+
+      def initialize(str, styles = {})
+        @styles = styles
+        super(str)
+      end
+
+      def fg_color_name
+        TermColor.by_tag(styles_hash[:fg].to_s)&.color_name
+      end
+
+      def bg_color_name
+        TermColor.by_tag(styles_hash[:bg].to_s)&.color_name
+      end
+
+      private
+
+      def styles_hash
+        @styles[@match_data[:name].to_sym]
+      end
+
+    end
+  end
+end

data/lib/ttyhue/parser/tag.rb

@@ -0,0 +1,24 @@
+module TTYHue
+  class Parser
+    class Tag
+
+      def initialize(str)
+        @str = str
+        @match_data = str.match(regexp)
+        return unless @match_data
+      end
+
+      def valid?
+        !!@match_data
+      end
+
+      def closing
+        @match_data[:closing] != ""
+      end
+
+    end
+  end
+end
+
+require_relative "color_tag"
+require_relative "style_tag"

data/lib/ttyhue/parser.rb

@@ -0,0 +1,82 @@
+require 'strscan'
+require_relative "parser/tag"
+require_relative "parser/color_stack"
+
+module TTYHue
+  class Parser
+
+    TOKENS = {
+      tag: /{[^{}]+}/,
+      content: /[^{]+/
+    }
+
+    class ParseError < StandardError; end
+
+    def initialize(string, styles = {})
+      @string = string
+      @styles = TTYHue.global_style.merge(styles)
+    end
+
+    def parse
+      @color_stack = ColorStack.new
+      @result = []
+      scanner = StringScanner.new(@string)
+      until scanner.eos?
+        next if handle_content!(scanner.scan(TOKENS[:content]))
+        next if handle_tag!(scanner.scan(TOKENS[:tag]))
+      end
+      flattened_result
+    end
+
+    private
+
+    def flattened_result
+      [].tap do |res|
+        @result.each do |e|
+          last = res.last
+          if last && last[:fg] == e[:fg] && last[:bg] == e[:bg]
+            last[:str] += e[:str]
+          else
+            res << e
+          end
+        end
+      end
+    end
+
+    def handle_content!(str)
+      return false unless str
+
+      @result << {
+        fg: @color_stack.top(bg: false) || :default,
+        bg: @color_stack.top(bg: true) || :default,
+        str: str
+      }
+    end
+
+    def handle_tag!(str)
+      return false unless str
+
+      color_tag = ColorTag.new(str)
+      style_tag = StyleTag.new(str, @styles)
+
+      if color_tag.valid?
+        if color_tag.closing
+          @color_stack.pop(color_tag.color_name, bg: color_tag.bg)
+        else
+          @color_stack.push(color_tag.color_name, bg: color_tag.bg)
+        end
+      elsif style_tag.valid?
+        if style_tag.closing
+          @color_stack.pop(style_tag.fg_color_name, bg: false) if style_tag.fg_color_name
+          @color_stack.pop(style_tag.bg_color_name, bg: true) if style_tag.bg_color_name
+        else
+          @color_stack.push(style_tag.fg_color_name, bg: false) if style_tag.fg_color_name
+          @color_stack.push(style_tag.bg_color_name, bg: true) if style_tag.bg_color_name
+        end
+      else
+        handle_content!(str)
+      end
+    end
+
+  end
+end

data/lib/ttyhue/preview.rb

@@ -0,0 +1,32 @@
+module TTYHue
+  class Preview
+
+    class << self
+
+      def preview_termcolors
+        %w{black red green yellow blue magenta cyan white}.each do |c|
+          ['', 'b'].each do |bg|
+            ['', 'l'].each do |l|
+              tag_name = "#{bg}#{l}#{c}"
+              print TTYHue.c("  {#{tag_name}}  #{tag_name.ljust(12)}{/#{tag_name}}")
+            end
+          end
+          print "\n"
+        end
+        nil
+      end
+
+      def preview_guicolors
+        (1..256).each do |x|
+          num = x - 1
+          tag_name = "gui#{num}"
+          print TTYHue.c(" {#{tag_name}}#{num.to_s.ljust(3)}{/#{tag_name}}")
+          print "\n" if x % 16 == 0
+        end
+        nil
+      end
+
+    end
+
+  end
+end

data/lib/ttyhue/term_color.rb

@@ -0,0 +1,83 @@
+module TTYHue
+  class TermColor
+
+    LABELS = %w{black red green yellow blue magenta cyan white}
+
+    def self.defs
+      [].tap do |res|
+        [false, true].each do |light|
+          LABELS.each do |label|
+            res << Theme.new(label, light)
+          end
+        end
+        (0..255).each do |code|
+          res << Gui.new(code)
+        end
+      end
+    end
+
+    def self.by_tag(tag_name)
+      defs.select {|d| d.tag_name == tag_name}.first
+    end
+
+    def self.by_name(name)
+      defs.select {|d| d.color_name == name}.first
+    end
+
+    class Base
+
+      def inspect
+        "#<TermColor @name=#{color_name} @tag=#{tag_name}>"
+      end
+
+    end
+
+    class Theme < Base
+
+      def initialize(label, light)
+        @label = label
+        @light = light
+      end
+
+      def color_name
+        [('light' if @light), @label].compact.join("_").to_sym
+      end
+
+      def tag_name
+        [('l' if @light), @label].compact.join
+      end
+
+      def term_hex(bg)
+        color_index = TermColor::LABELS.index(@label)
+        if @light
+          bg ? "10#{color_index}" : "9#{color_index}"
+        else
+          bg ? "4#{color_index}" : "3#{color_index}"
+        end
+      end
+
+    end
+
+    class Gui < Base
+
+      def initialize(code)
+        @code = code
+      end
+
+      def color_name
+        "gui_#{@code}".to_sym
+      end
+
+      def tag_name
+        "gui#{@code.to_s}"
+      end
+
+      def term_hex(bg)
+        prefix = bg ? "48;5;" : "38;5;"
+        prefix + @code.to_s
+      end
+
+    end
+
+  end
+end

data/lib/ttyhue/version.rb

@@ -0,0 +1,3 @@
+module TTYHue
+  VERSION = "0.1.0"
+end

data/lib/ttyhue.rb

@@ -0,0 +1,32 @@
+require_relative "ttyhue/term_color"
+require_relative "ttyhue/parser"
+require_relative "ttyhue/colorizer"
+require_relative "ttyhue/preview"
+
+module TTYHue
+
+  def self.global_style
+    begin
+      @@styles.to_h
+    rescue NameError
+      {}
+    end
+  end
+
+  def self.set_style(hash)
+    @@styles = hash.to_h
+  end
+
+  def self.c(str)
+    TTYHue::Colorizer.colorize(str)
+  end
+
+  def self.preview_termcolors
+    Preview.preview_termcolors
+  end
+
+  def self.preview_guicolors
+    Preview.preview_guicolors
+  end
+
+end

data/ttyhue.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/ttyhue/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ttyhue"
+  spec.version       = TTYHue::VERSION
+  spec.authors       = ["Dominik Sito"]
+  spec.email         = ["dominik.sito@gmail.com"]
+
+  spec.summary       = "Ruby gem for colorizing terminal output, supporting terminal theme colors as well as more fine-grained gui colors palette."
+  spec.description   = "Ruby gem for colorizing terminal output, supporting terminal theme colors as well as more fine-grained gui colors palette."
+  spec.homepage      = "https://github.com/railis/ttyhue"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/railis/ttyhue"
+  spec.metadata["changelog_uri"] = "https://raw.githubusercontent.com/railis/ttyhue/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "5.16.3"
+  spec.add_development_dependency "minitest-reporters", "1.5.0"
+  spec.add_development_dependency "shoulda-context", "2.0.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ttyhue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominik Sito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.16.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.16.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Ruby gem for colorizing terminal output, supporting terminal theme colors
+  as well as more fine-grained gui colors palette.
+email:
+- dominik.sito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/gui_colors.png
+- examples/term_colors.png
+- lib/ttyhue.rb
+- lib/ttyhue/colorizer.rb
+- lib/ttyhue/parser.rb
+- lib/ttyhue/parser/color_stack.rb
+- lib/ttyhue/parser/color_tag.rb
+- lib/ttyhue/parser/style_tag.rb
+- lib/ttyhue/parser/tag.rb
+- lib/ttyhue/preview.rb
+- lib/ttyhue/term_color.rb
+- lib/ttyhue/version.rb
+- ttyhue.gemspec
+homepage: https://github.com/railis/ttyhue
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/railis/ttyhue
+  source_code_uri: https://github.com/railis/ttyhue
+  changelog_uri: https://raw.githubusercontent.com/railis/ttyhue/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.22
+signing_key: 
+specification_version: 4
+summary: Ruby gem for colorizing terminal output, supporting terminal theme colors
+  as well as more fine-grained gui colors palette.
+test_files: []