ex_aequo 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 924b4f22f2046635087a0cb06cb7b5df172503192affbd528a8abfe159dd034d
-  data.tar.gz: c193578103f9d284ff20a251fde1d316b2971c87323743c70829b9737594bc90
+  metadata.gz: 8b6cd6a07b2a9d435aeadf493afb7c3efb927697e24ba774e524d2c05d0345dc
+  data.tar.gz: 6d7ad31a36ccd40db1673cf2bb9e50303cb23300a1f0455fcdae85cb217c21ed
 SHA512:
-  metadata.gz: 36064ab0e650bfa6565278f6c6d2d15e358f5c41b0d01d1216972b7ea99564b9db8c1d5ec3346085daae4b153111dc7d0d192c36c445105843a14185f96db730
-  data.tar.gz: 9a33c2e3065aed18c944790bf8b78ea3db2135891af65a1dcc914acb8477338e9ecbdede51700c0dc042f8518c239c1719d7fdb33feaf416de68d556ce560641
+  metadata.gz: 1d58560196e7c7a9ba5ab95eacced6545843a35e12c0b5cea22e43cdeb3e2d416012e4328f625d482dfdcce77b18d83320b22ac0224764555220e8fc750bd026
+  data.tar.gz: 1f4ca9354ac79edd8cb66690bb2b89986bd2a1411393862be7baefbfcd8dbfc62d349dad1f7f4cf4d7146636bc54049295ab0cbacd044bd52ca81c3160619b91

data/README.md

@@ -1,12 +1,18 @@
 [![CI](https://gitlab.com/robert_dober/rb_ex_aequo/workflows/CI/badge.svg)](https://gitlab.com/robert_dober/rb_ex_aequo/actions)
 [![Coverage Status](https://coveralls.io/repos/gitlab/robert_dober/rb_ex_aequo/badge.svg?branch=master)](https://coveralls.io/gitlab/robert_dober/rb_ex_aequo?branch=master)
-[![Gem Version](https://badge.fury.io/rb/rb_ex_aequo.svg)](http://badge.fury.io/rb/rb_ex_aequo)
-[![Gem Downloads](https://img.shields.io/gem/dt/rb_ex_aequo.svg)](https://rubygems.org/gems/rb_ex_aequo)
+[![Gem Version](https://badge.fury.io/rb/ex_aequo.svg)](http://badge.fury.io/rb/ex_aequo)
+[![Gem Downloads](https://img.shields.io/gem/dt/ex_aequo.svg)](https://rubygems.org/gems/ex_aequo)
 
-# RbExAequo
+# ExAequo
+
+    gem install ex_aequo
 
 Some Tools
 
+
+
+##
+
 ## LICENSE
 
 Copyright 2022 Robert Dober robert.dober@gmail.com

data/lib/ex_aequo/color/ansi.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'modifiers'
+module ExAequo
+  module Color
+    module Ansi
+      extend self
+      include ExAequo::Color::Modifiers
+
+      AnsiColorEscape = {
+        black:     30,
+        red:       31,
+        green:     32,
+        yellow:    33,
+        blue:      34,
+        magenta:   35,
+        cyan:      36,
+        white:     37
+      }.freeze
+
+      def ansi(name, bold: false, dim: false, italic: false, underline: false)
+        case AnsiColorEscape.fetch(name.to_s.downcase.to_sym, nil)
+        in nil
+          raise IllegalColor, "#{name} is not one of the 8 legal basic ansi color names: #{_legal_ansi_color_names}"
+        in value
+          "\e[#{value}#{postfix_modifiers(bold:, dim:, italic:, underline:)}m"
+        end
+      end
+
+      private
+
+      def _legal_ansi_color_names
+        AnsiColorEscape.keys.inspect
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/color/ansi256.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'modifiers'
+module ExAequo
+  module Color
+    module Ansi256
+      extend self
+      include ExAequo::Color::Modifiers
+
+      def ansi256(color, bold: false, dim: false, italic: false, underline: false)
+        case color
+        in 1..256
+          "\e[38;5;#{color}#{postfix_modifiers(bold:, dim:, italic:, underline:)}m"
+        else
+          raise IllegalColor, "#{color.inspect} is not a color number between 1 and 256"
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/color/colorizer.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ExAequo
+  module Color
+    module Colorizer
+      extend self
+
+      ColorMethodKeywords = {
+        ansi: nil,
+        ansi256: nil,
+        rgb: nil,
+      }.freeze
+
+      StyleKeywords = {
+        bold: nil,
+        dim: nil,
+        italic: nil,
+        underline: nil
+      }.freeze
+
+      ColorizeKeywords = ColorMethodKeywords.merge(StyleKeywords).merge(reset: true)
+
+      def colorize(text, **kwds)
+        kwds =  ColorizeKeywords.merge(kwds)
+        _check_args!(kwds)
+
+        [
+          _color_code(**kwds),
+          text,
+          _maybe_reset(kwds[:reset])
+        ].join
+      end
+
+      private
+
+      def _check_args!(kwds)
+        spurious = kwds.keys - ColorizeKeywords.keys
+        raise ArgumentError, "illegal keywords #{spurious}, allowed: #{ColorizeKeywords.keys}" unless spurious.empty?
+
+        _check_rgb_args!(kwds)
+      end
+
+      def _check_rgb_args!(kwds)
+        unless kwds.values_at(*ColorMethodKeywords.keys).compact.size == 1
+          raise ArgumentError, 'need to specify exactly one of the following keyword arguments: :ansi, :ansi256, :rgb'
+        end
+
+        if kwds[:rgb] && Access.any_key?(kwds, :bold, :dim)
+          raise(
+            ArgumentError,
+            'specifying bold and/or dim with rgb does not make sense'
+          )
+        end
+      end
+
+      def _color_code(**kwds)
+        kwds => {ansi:, ansi256:, rgb:, italic:, underline:}
+        if rgb
+          ExAequo::Color.rgb(*Array(rgb), italic:, underline:)
+        elsif ansi
+          ExAequo::Color.ansi(ansi, **kwds.slice(*StyleKeywords.keys))
+        else
+          ExAequo::Color.ansi256(ansi256, **kwds.slice(*StyleKeywords.keys))
+        end
+      end
+
+      def _maybe_reset(reset)
+        reset ? ExAequo::Color.reset : nil
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/color/modifiers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ExAequo
+  module Color
+    module Modifiers extend self
+      ModifierValues = {
+        bold: 1,
+        dim: 2,
+        italic: 3,
+        underline: 4
+      }.freeze
+
+      def postfix_modifiers(bold: nil, dim: nil, italic: nil, underline: nil)
+        [
+          bold ? :bold : nil,
+          dim ? :dim : nil,
+          italic ? :italic : nil,
+          underline ? :underline : nil
+        ].compact
+          .map(&Access.hash_by_key(ModifierValues))
+          .map(&Fn.prefix_string(';'))
+          .join
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/color/rgb.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'modifiers'
+module ExAequo
+  module Color
+    module Rgb
+      extend self
+
+      def rgb(red, green = nil, blue = nil, **kwds)
+        if green && blue
+          _rgb(red, green, blue, **kwds)
+        else
+          raise ArgumentError, 'takes 1 or 3 parameters, given two' if green
+
+          _rgb(*_hex_to_triple(red), **kwds)
+        end
+      end
+
+      private
+
+      def _check_rgb(red, green, blue)
+        if _check_rgb_byte(red) && _check_rgb_byte(green) && _check_rgb_byte(blue)
+          :ok
+        else
+          "#{[red, green, blue]} is not a legal rgb specification, need three bytes (0..255)"
+        end
+      end
+
+      def _check_rgb_byte(byte)
+        case byte
+        in 0..255
+          true
+        else
+          false
+        end
+      end
+
+      LeadingHashRgx = %r{\A#}
+      def _hex_to_triple(hex)
+        chex = hex.sub(LeadingHashRgx, '')
+        case chex.grapheme_clusters.each_slice(2).map(&:join).map { Integer(_1, 16) }
+        in r, g, b
+          [r, g, b]
+        else
+          raise IllegalColor, "#{hex} is not a legal rgb hex string"
+        end
+      rescue ArgumentError
+        raise IllegalColor, "#{hex} is not a legal rgb hex string"
+      end
+
+      def _rgb(red, green, blue, italic: false, underline: false)
+        case _check_rgb(red, green, blue)
+        in :ok
+          modifier = ExAequo::Color::Modifiers.postfix_modifiers(italic:, underline:)
+          "\e[38;2;#{red};#{green};#{blue}#{modifier}m"
+        in message
+          raise IllegalColor, message
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/color.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'kernel/access'
+require_relative 'kernel/fn'
+
+require_relative 'color/ansi'
+require_relative 'color/ansi256'
+require_relative 'color/rgb'
+
+require_relative 'color/colorizer'
+
+module ExAequo
+  module Color
+    extend self
+
+    class IllegalColor < RuntimeError; end
+
+    def ansi(color, **kwds)
+      ExAequo::Color::Ansi.ansi(color, **kwds)
+    end
+
+    def ansi256(color, **kwds)
+      ExAequo::Color::Ansi256.ansi256(color, **kwds)
+    end
+
+    def colorize(text, **params)
+      if ENV['NO_COLOR']
+        text
+      else
+        ExAequo::Color::Colorizer.colorize(text, **params)
+      end
+    end
+
+    def reset
+      "\e[0m"
+    end
+
+    def rgb(*args, **kwds)
+      ExAequo::Color::Rgb.rgb(*args, **kwds)
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/kernel/access.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Access
+  extend self
+
+  def any_key?(hash, *keys)
+    keys.flatten.reduce(false) { |_, key| return true if hash[key] }
+    false
+  end
+
+  def hash_by_key(hash)
+    ->(key) { hash[key] }
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/kernel/fn.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Fn
+  extend self
+  def prefix_string(with)
+    ->(subject) { "#{with}#{subject}" }
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/kernel.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'kernel/fn'
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/version.rb

@@ -2,7 +2,7 @@
 
 module ExAequo
   module Version
-    VERSION = '0.1.0'
+    VERSION = '0.1.2'
   end
 end
 # SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ExAequo
+end
+require_relative 'ex_aequo/color'
+require_relative 'ex_aequo/version'
+# SPDX-License-Identifier: Apache-2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ex_aequo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies: []
 description: 'Some tools
 
@@ -20,6 +20,16 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/ex_aequo.rb
+- lib/ex_aequo/color.rb
+- lib/ex_aequo/color/ansi.rb
+- lib/ex_aequo/color/ansi256.rb
+- lib/ex_aequo/color/colorizer.rb
+- lib/ex_aequo/color/modifiers.rb
+- lib/ex_aequo/color/rgb.rb
+- lib/ex_aequo/kernel.rb
+- lib/ex_aequo/kernel/access.rb
+- lib/ex_aequo/kernel/fn.rb
 - lib/ex_aequo/version.rb
 homepage: https://gitlab.com/robert_dober/rb_ex_aequo
 licenses: