red-colors 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3587e5433ccb431efbc46112034d3b9f00d40ad58e8389cb4081bf0bdcb3304f
-  data.tar.gz: 2568105af67abd20c5133a7181194489006eef94cc3c4834d0f3509eaf01c5f9
+  metadata.gz: c144d5d89c917428d99401b92513852896b2ff109228d85b2ddac5dd40b89fb4
+  data.tar.gz: 8e99f5fadc2068211a0ec92d12ad754ae777efedd23048867c0ad91824fe7a35
 SHA512:
-  metadata.gz: d15ae1556244a040ff0822fc739e7dd561d2f29fc9cec04ba68bbc72a1bd6afe097c66fa88f5450bd7f7bce3e89622b34726bdc5e64320255cb6ba71a0c508f7
-  data.tar.gz: aa96cd5773128f79d48993319d920e7325b4db7520429eb211347abfb375688566b083d049e1e679aa81ca05f545682490d70f2b29beaedcbc6ea1c094c45c50
+  metadata.gz: 53491ee2e2c97a99c624d5e4d2fc73d9939f68ee9b27f24f54bcf1f3831f87f8cf2d115d4c8b0499e73e2623ad6e045c714f254a4dc33da55dfdf84213b45903
+  data.tar.gz: 1d783343d7536ca570bdbd049d83d92a107450341e03a8f4a390f88abc891d92d67404e198b87ee7555b6abea05610e13f4afcd9421d417c20f1ef3e38be002c

data/README.md

@@ -27,6 +27,8 @@ $ gem install red-colors
 
 To be described later.
 
+See the [documentation](https://rubydoc.info/gems/red-colors) for now.
+
 ## License
 
 The MIT license. See [`LICENSE.txt`](LICENSE.txt) for details.

data/lib/colors.rb

@@ -8,6 +8,7 @@ require_relative "colors/hsla"
 require_relative "colors/husl"
 require_relative "colors/rgb"
 require_relative "colors/rgba"
+require_relative "colors/xterm256"
 require_relative "colors/xyy"
 require_relative "colors/xyz"
 

data/lib/colors/convert.rb

@@ -148,6 +148,51 @@ module Colors
       dot_product(RGB2XYZ, srgb_to_linear_srgb(r, g, b))
     end
 
+    def rgb_to_xterm256(r, g, b)
+      i = closest_xterm256_rgb_index(r)
+      j = closest_xterm256_rgb_index(g)
+      k = closest_xterm256_rgb_index(b)
+
+      r0 = xterm256_rgb_index_to_rgb_value(i)
+      g0 = xterm256_rgb_index_to_rgb_value(j)
+      b0 = xterm256_rgb_index_to_rgb_value(k)
+      d0 = (r - r0)**2 + (g - g0)**2 + (b - b0)**2
+
+      l = closest_xterm256_gray_index(r, g, b)
+      gr = xterm256_gray_index_to_gray_level(l)
+      d1 = (r - gr)**2 + (g - gr)**2 + (b - gr)**2
+
+      if d0 > d1
+        xterm256_gray_index_to_code(l)
+      else
+        xterm256_rgb_indices_to_code(i, j, k)
+      end
+    end
+
+    def xterm256_rgb_index_to_rgb_value(i)
+      (i == 0) ? 0 : (40*i + 55)/255.0
+    end
+
+    def closest_xterm256_rgb_index(x)
+      ([x*255 - 55, 0].max / 40.0).round
+    end
+
+    def xterm256_gray_index_to_gray_level(i)
+      (10*i + 8)/255.0
+    end
+
+    def closest_xterm256_gray_index(r, g, b)
+      ((255*(r + g + b) - 24)/30.0).round.clamp(0, 23)
+    end
+
+    def xterm256_rgb_indices_to_code(i, j, k)
+      6*(6*i + j) + k + 16
+    end
+
+    def xterm256_gray_index_to_code(i)
+      i + 232
+    end
+
     # sRGB -> ???
 
     def srgb_to_linear_srgb(r, g, b)

data/lib/colors/rgb.rb

@@ -125,6 +125,10 @@ module Colors
       XYZ.new(*Convert.rgb_to_xyz(r, g, b))
     end
 
+    def to_xterm256
+      Xterm256.new(*Convert.rgb_to_xterm256(r, g, b))
+    end
+
     private def canonicalize(r, g, b)
       if [r, g, b].map(&:class) == [Integer, Integer, Integer]
         canonicalize_from_integer(r, g, b)

data/lib/colors/version.rb

@@ -1,3 +1,3 @@
 module Colors
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/colors/xterm256.rb

@@ -0,0 +1,56 @@
+module Colors
+  class Xterm256 < AbstractColor
+    include Helper
+
+    def initialize(code)
+      unless 16 <= code && code <= 255
+        raise ArgumentError, "code should be in 16..255, but #{code} is given"
+      end
+      @code = code
+    end
+
+    attr_reader :code
+
+    def ==(other)
+      case other
+      when Xterm256
+        code == other.code
+      else
+        super
+      end
+    end
+
+    def to_rgb_components
+      if code < 232
+        x = code - 16
+        x, b = x.divmod(6)
+        r, g = x.divmod(6)
+        r = 40*r + 55 if r > 0
+        g = 40*g + 55 if g > 0
+        b = 40*b + 55 if b > 0
+        [
+          canonicalize_component_from_integer(r, :r),
+          canonicalize_component_from_integer(g, :r),
+          canonicalize_component_from_integer(b, :r)
+        ]
+      else
+        grey = to_grey_level
+        [grey, grey, grey]
+      end
+    end
+
+    def to_grey_level
+      if code < 232
+        r, g, b = to_rgb_components
+        x, y, z = Convet.rgb_to_xyz(r, g, b)
+      else
+        grey = 10*(code - 232) + 8
+        canonicalize_component_from_integer(grey, :grey)
+      end
+    end
+
+    def to_rgb
+      RGB.new(*to_rgb_components)
+    end
+  end
+end

data/lib/colors/xyz.rb

@@ -4,7 +4,7 @@ module Colors
 
     EPSILON = (6/29r)**3
 
-    KAPPA = (29/3)**3
+    KAPPA = (29/3r)**3
 
     def initialize(x, y, z)
       @x, @y, @z = canonicalize(x, y, z)

data/test/test-rgb.rb

@@ -318,4 +318,64 @@ class ColorsRGBTest < Test::Unit::TestCase
     assert_near(Colors::HUSL.new(0r, 0r, 1r),
                 Colors::RGB.new(1r, 1r, 1r).to_husl)
   end
+
+  data do
+    data_set = {}
+    # colors 16-231 are a 6x6x6 color cube
+    (0...6).each do |r|
+      (0...6).each do |g|
+        (0...6).each do |b|
+          code = 6*(6*r + g) + b + 16
+          red   = (r > 0) ? 40*r + 55 : r
+          green = (g > 0) ? 40*g + 55 : g
+          blue  = (b > 0) ? 40*b + 55 : b
+          label = "Color #{code} is rgb(#{red}, #{green}, #{blue})"
+          data_set[label] = [code, Colors::RGB.new(red, green, blue)]
+        end
+      end
+    end
+    # colors 232-256 are grayscale colors
+    (0...24).each do |y|
+      code = 232 + y
+      level = 10*y + 8
+      label = "Color #{code} is gray(#{level})"
+      data_set[label] = [code, Colors::RGB.new(level, level, level)]
+    end
+    # Some colors to check cloest color finder
+    [
+      [   0,   0,   8,  16 ],
+      [   0,   8,   0,  16 ],
+      [  11,   0,   0,  16 ],
+      [   0,   0,  12, 232 ],
+      [   0,  12,   0, 232 ],
+      [  12,   0,   0, 232 ],
+
+      [   0,   0,  75,  17 ],
+      [   0,  75,   0,  22 ],
+      [  75,   0,   0,  52 ],
+
+      [   0, 128, 128,  30 ],
+      [ 102, 102, 102, 241 ],
+      [ 103, 103, 103, 242 ],
+      [ 208, 238, 238, 254 ],
+      [ 208, 208, 238, 189 ],
+
+      # TODO: Reconsider the following cases
+      [   0,   0,  55, 233 ],
+      [   0,  55,   0, 233 ],
+      [  55,   0,   0, 233 ],
+      [   0,   0,  74, 234 ],
+      [   0,  74,   0, 234 ],
+      [  74,   0,   0, 234 ],
+    ].each do |r, g, b, code|
+      label = "rgb(#{r}, #{g}, #{b}) is color #{code}"
+      data_set[label] = [code, Colors::RGB.new(r, g, b)]
+    end
+    data_set
+  end
+  def test_to_xterm256
+    code, rgb = data
+    assert_equal(Colors::Xterm256.new(code),
+                 rgb.to_xterm256)
+  end
 end

data/test/test-xterm256.rb

@@ -0,0 +1,76 @@
+class ColorsXterm256Test < Test::Unit::TestCase
+  include TestHelper
+
+  sub_test_case(".new") do
+    sub_test_case("with color code") do
+      test("the regular case") do
+        codes = [16, 255]
+        colors = codes.map {|i| Colors::Xterm256.new(i) }
+        assert_equal(codes,
+                     colors.map(&:code))
+      end
+
+      data do
+        (0..15).map { |code|
+          ["ANSI color #{code}", code]
+        }.to_h
+      end
+      def test_ansi_color_code(code)
+        assert_raise(ArgumentError) do
+          Colors::Xterm256.new(code)
+        end
+      end
+
+      test("the negative argument") do
+        assert_raise(ArgumentError) do
+          Colors::Xterm256.new(-1)
+        end
+      end
+
+      test("too large argument") do
+        assert_raise(ArgumentError) do
+          Colors::Xterm256.new(256)
+        end
+      end
+    end
+  end
+
+  test("==") do
+    assert { Colors::Xterm256.new(16) == Colors::Xterm256.new(16) }
+    assert { Colors::Xterm256.new(132) == Colors::Xterm256.new(132) }
+  end
+
+  test("!=") do
+    assert { Colors::Xterm256.new(16) != Colors::Xterm256.new(17) }
+  end
+
+  data do
+    data_set = {}
+    # colors 16-231 are a 6x6x6 color cube
+    (0...6).each do |r|
+      (0...6).each do |g|
+        (0...6).each do |b|
+          code = 6*(6*r + g) + b + 16
+          red   = (r > 0) ? 40*r + 55 : r
+          green = (g > 0) ? 40*g + 55 : g
+          blue  = (b > 0) ? 40*b + 55 : b
+          label = "Color #{code} is rgb(#{red}, #{green}, #{blue})"
+          data_set[label] = [code, Colors::RGB.new(red, green, blue)]
+        end
+      end
+    end
+    # colors 232-256 are grayscale colors
+    (0...24).each do |y|
+      code = 232 + y
+      level = 10*y + 8
+      label = "Color #{code} is gray(#{level})"
+      data_set[label] = [code, Colors::RGB.new(level, level, level)]
+    end
+    data_set
+  end
+  def test_to_rgb(data)
+    code, rgb = data
+    assert_equal(rgb,
+                 Colors::Xterm256.new(code).to_rgb)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-colors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kenta Murata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - lib/colors/rgb.rb
 - lib/colors/rgba.rb
 - lib/colors/version.rb
+- lib/colors/xterm256.rb
 - lib/colors/xyy.rb
 - lib/colors/xyz.rb
 - red-colors.gemspec
@@ -116,6 +117,7 @@ files:
 - test/test-named-color.rb
 - test/test-rgb.rb
 - test/test-rgba.rb
+- test/test-xterm256.rb
 - test/test-xyz.rb
 homepage: https://github.com/red-data-tools/red-colors
 licenses:
@@ -136,19 +138,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Red Colors provides a wide array of features for dealing with colors. This
   includes conversion between colorspaces, desaturation, and parsing colors.
 test_files:
-- test/test-hsla.rb
-- test/test-named-color.rb
-- test/test-rgba.rb
 - test/helper.rb
-- test/test-rgb.rb
 - test/run.rb
 - test/test-hsl.rb
-- test/test-xyz.rb
+- test/test-hsla.rb
 - test/test-husl.rb
+- test/test-named-color.rb
+- test/test-rgb.rb
+- test/test-rgba.rb
+- test/test-xterm256.rb
+- test/test-xyz.rb