ex_aequo 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae17031917aa3f9f0321d0f71f66e55a132f53220de7614edea1aced743b989
-  data.tar.gz: f47174e7f94bb872469c44dc13a2aef2f1ad418d39ac743fec13359a934e5b46
+  metadata.gz: 394e714f95ecbb3b54b5a264ce5be367d235fcebe7513b89d48d0491de236312
+  data.tar.gz: 177328fccfa5fbfd1911944ac5d6a65ccf7a7315589930d91beb764e413b2c4f
 SHA512:
-  metadata.gz: 16bf984e4980c795890f5665ede3d3515c1c33872a023b346c689c2ffb83b293eb2ce06b76b363d6dc55c87f641c0cf72566b8dbad7456a742ffc0bb41d30a5f
-  data.tar.gz: 4294e88bd872a53906aa7155cdb53e0808ea4424a47170578b7faef553bcdee0ee11ef11e69abdea0a8855ab6942affe895124ce877529d3c8e388834cfb1688
+  metadata.gz: c929dc3f52e077403241a32d114e36f76629f62c0da14d4927b03b6845bdfba0e3a1240d5a0b4285b048e2971a5898af675b86a80c5830fb35fc404a52d343ce
+  data.tar.gz: 2c2966155b1b3ddb5ca671105568248b8e1e1f6e1ebc205d4d91dc3582343969ecf1ca9bd56f2f7906f322011ab376047b699afea2c9925f1bedd399a32f7061

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,71 @@ 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,
+        web: 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, :web'
+        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:, web:, italic:, underline:}
+        if rgb
+          ExAequo::Color.rgb(*Array(rgb), italic:, underline:)
+        elsif web
+          ExAequo::Color.rgb(*ExAequo::Color::Web.to_rgb(web), 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/web.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module ExAequo
+  module Color
+    module Web
+      extend self
+
+      WebColorNames = {
+        'aliceblue' => [240, 248, 255],
+        'antiquewhite' => [250, 235, 215],
+        'aqua' => [0, 255, 255],
+        'aquamarine' => [127, 255, 212],
+        'azure' => [240, 255, 255],
+        'beige' => [245, 245, 220],
+        'bisque' => [255, 228, 196],
+        'black' => [0, 0, 0],
+        'blanchedalmond' => [255, 235, 205],
+        'blue' => [0, 0, 255],
+        'blueviolet' => [138, 43, 226],
+        'brown' => [165, 42, 42],
+        'burlywood' => [222, 184, 135],
+        'cadetblue' => [95, 158, 160],
+        'chartreuse' => [127, 255, 0],
+        'chocolate' => [210, 105, 30],
+        'coral' => [255, 127, 80],
+        'cornflowerblue' => [100, 149, 237],
+        'cornsilk' => [255, 248, 220],
+        'crimson' => [220, 20, 60],
+        'cyan' => [0, 255, 255],
+        'darkblue' => [0, 0, 139],
+        'darkcyan' => [0, 139, 139],
+        'darkgoldenrod' => [184, 134, 11],
+        'darkgray' => [169, 169, 169],
+        'darkgreen' => [0, 100, 0],
+        'darkgrey' => [169, 169, 169],
+        'darkkhaki' => [189, 183, 107],
+        'darkmagenta' => [139, 0, 139],
+        'darkolivegreen' => [85, 107, 47],
+        'darkorange' => [255, 140, 0],
+        'darkorchid' => [153, 50, 204],
+        'darkred' => [139, 0, 0],
+        'darksalmon' => [233, 150, 122],
+        'darkseagreen' => [143, 188, 143],
+        'darkslateblue' => [72, 61, 139],
+        'darkslategray' => [47, 79, 79],
+        'darkslategrey' => [47, 79, 79],
+        'darkturquoise' => [0, 206, 209],
+        'darkviolet' => [148, 0, 211],
+        'deeppink' => [255, 20, 147],
+        'deepskyblue' => [0, 191, 255],
+        'dimgray' => [105, 105, 105],
+        'dimgrey' => [105, 105, 105],
+        'dodgerblue' => [30, 144, 255],
+        'firebrick' => [178, 34, 34],
+        'floralwhite' => [255, 250, 240],
+        'forestgreen' => [34, 139, 34],
+        'fuchsia' => [255, 0, 255],
+        'gainsboro' => [220, 220, 220],
+        'ghostwhite' => [248, 248, 255],
+        'gold' => [255, 215, 0],
+        'goldenrod' => [218, 165, 32],
+        'gray' => [128, 128, 128],
+        'green' => [0, 128, 0],
+        'greenyellow' => [173, 255, 47],
+        'grey' => [128, 128, 128],
+        'honeydew' => [240, 255, 240],
+        'hotpink' => [255, 105, 180],
+        'indianred' => [205, 92, 92],
+        'indigo' => [75, 0, 130],
+        'ivory' => [255, 255, 240],
+        'khaki' => [240, 230, 140],
+        'lavender' => [230, 230, 250],
+        'lavenderblush' => [255, 240, 245],
+        'lawngreen' => [124, 252, 0],
+        'lemonchiffon' => [255, 250, 205],
+        'lightblue' => [173, 216, 230],
+        'lightcoral' => [240, 128, 128],
+        'lightcyan' => [224, 255, 255],
+        'lightgoldenrodyellow' => [250, 250, 210],
+        'lightgray' => [211, 211, 211],
+        'lightgreen' => [144, 238, 144],
+        'lightgrey' => [211, 211, 211],
+        'lightpink' => [255, 182, 193],
+        'lightsalmon' => [255, 160, 122],
+        'lightseagreen' => [32, 178, 170],
+        'lightskyblue' => [135, 206, 250],
+        'lightslategray' => [119, 136, 153],
+        'lightslategrey' => [119, 136, 153],
+        'lightsteelblue' => [176, 196, 222],
+        'lightyellow' => [255, 255, 224],
+        'lime' => [0, 255, 0],
+        'limegreen' => [50, 205, 50],
+        'linen' => [250, 240, 230],
+        'magenta' => [255, 0, 255],
+        'maroon' => [128, 0, 0],
+        'mediumaquamarine' => [102, 205, 170],
+        'mediumblue' => [0, 0, 205],
+        'mediumorchid' => [186, 85, 211],
+        'mediumpurple' => [147, 112, 219],
+        'mediumseagreen' => [60, 179, 113],
+        'mediumslateblue' => [123, 104, 238],
+        'mediumspringgreen' => [0, 250, 154],
+        'mediumturquoise' => [72, 209, 204],
+        'mediumvioletred' => [199, 21, 133],
+        'midnightblue' => [25, 25, 112],
+        'mintcream' => [245, 255, 250],
+        'mistyrose' => [255, 228, 225],
+        'moccasin' => [255, 228, 181],
+        'navajowhite' => [255, 222, 173],
+        'navy' => [0, 0, 128],
+        'oldlace' => [253, 245, 230],
+        'olive' => [128, 128, 0],
+        'olivedrab' => [107, 142, 35],
+        'orange' => [255, 165, 0],
+        'orangered' => [255, 69, 0],
+        'orchid' => [218, 112, 214],
+        'palegoldenrod' => [238, 232, 170],
+        'palegreen' => [152, 251, 152],
+        'paleturquoise' => [175, 238, 238],
+        'palevioletred' => [219, 112, 147],
+        'papayawhip' => [255, 239, 213],
+        'peachpuff' => [255, 218, 185],
+        'peru' => [205, 133, 63],
+        'pink' => [255, 192, 203],
+        'plum' => [221, 160, 221],
+        'powderblue' => [176, 224, 230],
+        'purple' => [128, 0, 128],
+        'red' => [255, 0, 0],
+        'rosybrown' => [188, 143, 143],
+        'royalblue' => [65, 105, 225],
+        'saddlebrown' => [139, 69, 19],
+        'salmon' => [250, 128, 114],
+        'sandybrown' => [244, 164, 96],
+        'seagreen' => [46, 139, 87],
+        'seashell' => [255, 245, 238],
+        'sienna' => [160, 82, 45],
+        'silver' => [192, 192, 192],
+        'skyblue' => [135, 206, 235],
+        'slateblue' => [106, 90, 205],
+        'slategray' => [112, 128, 144],
+        'slategrey' => [112, 128, 144],
+        'snow' => [255, 250, 250],
+        'springgreen' => [0, 255, 127],
+        'steelblue' => [70, 130, 180],
+        'tan' => [210, 180, 140],
+        'teal' => [0, 128, 128],
+        'thistle' => [216, 191, 216],
+        'tomato' => [255, 99, 71],
+        'transparent' => [0, 0, 0],
+        'turquoise' => [64, 224, 208],
+        'violet' => [238, 130, 238],
+        'wheat' => [245, 222, 179],
+        'white' => [255, 255, 255],
+        'whitesmoke' => [245, 245, 245],
+        'yellow' => [255, 255, 0],
+        'yellowgreen' => [154, 205, 50],
+        'rebeccapurple' => [102, 51, 153]
+      }.freeze
+      def to_rgb(color)
+        WebColorNames.fetch(color.to_s.downcase) { raise ArgumentError, "unsupported web color: #{color}" }
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/ex_aequo/color.rb

@@ -1,8 +1,12 @@
 # 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/web'
 
 require_relative 'color/colorizer'
 
@@ -12,12 +16,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 +36,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.3'
   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.3
 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,12 @@ 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/color/web.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: