ex_aequo 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae17031917aa3f9f0321d0f71f66e55a132f53220de7614edea1aced743b989
-  data.tar.gz: f47174e7f94bb872469c44dc13a2aef2f1ad418d39ac743fec13359a934e5b46
+  metadata.gz: 8b6cd6a07b2a9d435aeadf493afb7c3efb927697e24ba774e524d2c05d0345dc
+  data.tar.gz: 6d7ad31a36ccd40db1673cf2bb9e50303cb23300a1f0455fcdae85cb217c21ed
 SHA512:
-  metadata.gz: 16bf984e4980c795890f5665ede3d3515c1c33872a023b346c689c2ffb83b293eb2ce06b76b363d6dc55c87f641c0cf72566b8dbad7456a742ffc0bb41d30a5f
-  data.tar.gz: 4294e88bd872a53906aa7155cdb53e0808ea4424a47170578b7faef553bcdee0ee11ef11e69abdea0a8855ab6942affe895124ce877529d3c8e388834cfb1688
+  metadata.gz: 1d58560196e7c7a9ba5ab95eacced6545843a35e12c0b5cea22e43cdeb3e2d416012e4328f625d482dfdcce77b18d83320b22ac0224764555220e8fc750bd026
+  data.tar.gz: 1f4ca9354ac79edd8cb66690bb2b89986bd2a1411393862be7baefbfcd8dbfc62d349dad1f7f4cf4d7146636bc54049295ab0cbacd044bd52ca81c3160619b91

data/lib/ex_aequo/color/ansi.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'modifiers'
 module ExAequo
   module Color
     module Ansi
       extend self
+      include ExAequo::Color::Modifiers
 
       AnsiColorEscape = {
         black:     30,
@@ -16,12 +18,12 @@ module ExAequo
         white:     37
       }.freeze
 
-      def ansi(name)
+      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}m"
+          "\e[#{value}#{postfix_modifiers(bold:, dim:, italic:, underline:)}m"
         end
       end
 

data/lib/ex_aequo/color/ansi256.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'modifiers'
 module ExAequo
   module Color
     module Ansi256
       extend self
+      include ExAequo::Color::Modifiers
 
-      def ansi256(color)
+      def ansi256(color, bold: false, dim: false, italic: false, underline: false)
         case color
         in 1..256
-          "\e[38;5;#{color}m"
+          "\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

data/lib/ex_aequo/color/colorizer.rb

@@ -5,17 +5,68 @@ module ExAequo
     module Colorizer
       extend self
 
-      def colorize(text, rgb: nil, ansi: nil, ansi256: nil, reset: true)
-        unless [rgb, ansi, ansi256].compact.size == 1
-          raise ArgumentError, 'need to specify exactly one of the following keyword arguments: :ansi, :ansi256, :rgb'
-        end
+      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)
 
         [
-          ExAequo::Color.rgb(*Array(rgb)),
+          _color_code(**kwds),
           text,
-          reset ? ExAequo::Color.reset : nil
+          _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

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

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'modifiers'
 module ExAequo
   module Color
     module Rgb
       extend self
 
-      def rgb(red, green = nil, blue = nil)
+      def rgb(red, green = nil, blue = nil, **kwds)
         if green && blue
-          _rgb(red, green, blue)
+          _rgb(red, green, blue, **kwds)
         else
           raise ArgumentError, 'takes 1 or 3 parameters, given two' if green
 
-          _rgb(*_hex_to_triple(red))
+          _rgb(*_hex_to_triple(red), **kwds)
         end
       end
 
@@ -47,10 +48,11 @@ module ExAequo
         raise IllegalColor, "#{hex} is not a legal rgb hex string"
       end
 
-      def _rgb(red, green, blue)
+      def _rgb(red, green, blue, italic: false, underline: false)
         case _check_rgb(red, green, blue)
         in :ok
-          "\e[38;2;#{red};#{green};#{blue}m"
+          modifier = ExAequo::Color::Modifiers.postfix_modifiers(italic:, underline:)
+          "\e[38;2;#{red};#{green};#{blue}#{modifier}m"
         in message
           raise IllegalColor, message
         end

data/lib/ex_aequo/color.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'kernel/access'
+require_relative 'kernel/fn'
+
 require_relative 'color/ansi'
 require_relative 'color/ansi256'
 require_relative 'color/rgb'
@@ -12,12 +15,12 @@ module ExAequo
 
     class IllegalColor < RuntimeError; end
 
-    def ansi(color)
-      ExAequo::Color::Ansi.ansi(color)
+    def ansi(color, **kwds)
+      ExAequo::Color::Ansi.ansi(color, **kwds)
     end
 
-    def ansi256(color)
-      ExAequo::Color::Ansi256.ansi256(color)
+    def ansi256(color, **kwds)
+      ExAequo::Color::Ansi256.ansi256(color, **kwds)
     end
 
     def colorize(text, **params)
@@ -32,8 +35,8 @@ module ExAequo
       "\e[0m"
     end
 
-    def rgb(*args)
-      ExAequo::Color::Rgb.rgb(*args)
+    def rgb(*args, **kwds)
+      ExAequo::Color::Rgb.rgb(*args, **kwds)
     end
   end
 end

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.1'
+    VERSION = '0.1.2'
   end
 end
 # 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.1
+  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
 
@@ -25,7 +25,11 @@ files:
 - 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: