color-rgb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 445d364c50a40c003797bb41d7e02607f7d26686
+  data.tar.gz: 1fac8c6e57e1f9aaaedbee116d5d70528f32f1aa
+SHA512:
+  metadata.gz: bc64036e91f60eacb2527b212cfa0bc749c1ad4791f26141422acd9dae87dd427ef1136cc77b175d6d688694adcdf5cfaf41f45fd990b49fe72aede5b42b8acc
+  data.tar.gz: 01aeda0ccac119fed135fc5f6e97e38016aec0bce58a8f2ca16d4abf59a1c59a1ed8387b161fbf62b3ebd411b75fc3ceb6024c07fa89535952bffd1db5745067

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in color.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Apartment Therapy LLC
+
+MIT License
+
+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,86 @@
+# Colorkit
+
+A set of utilities to help with dealing with RGB colors. Supporting
+
+- colorspace conversion from RGB to XYZ or CIE l*a*b*
+- determining distance between two colors using CIE76
+- storing RGB colors as integers
+
+http://en.wikipedia.org/wiki/CIE_1931_color_space
+http://en.wikipedia.org/wiki/Color_difference#CIE76
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'color-rgb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install color
+
+## Usage
+
+To instantiate an RGB color
+
+```ruby
+Color::RGB.new(r, g, b)          # r, g, b arguments
+Color::RGB.from_array([r, g, b]) # an array of RGB values
+Color::RGB.from_int(rgb_int)     # int
+```
+
+To convert to XYZ or CIE L*a*b*
+
+```ruby
+color_rgb = Color::RGB.new(r, g, b)
+color_rgb.to_xyz
+color_rgb.to_lab
+```
+
+Or to convert to an int for storage
+
+```ruby
+color_rgb = Color::RGB.new(r, g, b)
+color_rgb.to_int
+```
+
+Or to go from an Color::RGB instance back to an array of r,g,b values
+
+```ruby
+color_rgb.to_a
+```
+
+To determine distance / similarity between two RGB colors
+
+```ruby
+rgb_one = Color::RGB.new(r, g, b)
+rgb_two = Color::RGB.new(other_r, other_g, other_b)
+
+Color::Comparison.distance(rgb_one, rgb_two)
+```
+
+If you are planning to compare rgb_one against a number of colors in sequence
+tou can instantiate a comparitor object and call compare with any other RGB
+
+```ruby
+rgb_one = Color::RGB.new(r, g, b)
+
+comparitor = Color::Comparison.new(rgb_one)
+comparitor.compare(some_other_rgb_color) # Color::RGB isntance
+comparitor.compare([r, g, b]) # array of RGB values
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/apartmenttherapy/color-rgb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/color-rgb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'color/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "color-rgb"
+  spec.version       = Color::VERSION
+  spec.authors       = ["ramin keene"]
+  spec.email         = ["raminkeene@gmail.com"]
+  spec.summary       = %q{RGB color utlities conversion and color distance}
+  spec.description   = %q{RGB color utilities for converting RGB color into different colorspace (CIE*Lab or XYZ), a different format, or comparing similarity of two colors}
+  spec.homepage      = "http://github.com/apartmenttherapy/color-rgb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rspec"
+end

data/lib/color-rgb.rb

@@ -0,0 +1 @@
+require 'color'

data/lib/color.rb

@@ -0,0 +1,10 @@
+require "color/cie_lab"
+require "color/comparison"
+require "color/rgb"
+require "color/version"
+require "color/xyz"
+
+module Color
+  class RGBArraySizeError < StandardError; end
+  class RGBArrayValueOutOfBoundsError < StandardError; end
+end

data/lib/color/cie_lab.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+module Color
+  class CIELab
+    attr_reader :x, :y, :z
+
+    def self.from_xyz(xyz_color)
+      self.new(xyz_color)
+    end
+
+    def initialize(color)
+      @x = color.x
+      @y = color.y
+      @z = color.z
+    end
+
+    def to_a
+      [l, a, b]
+    end
+
+    def reference_x
+      95.047 # Observer= 2°, Illuminant= D65
+    end
+
+    def reference_y
+      100.00
+    end
+
+    def reference_z
+      108.883
+    end
+
+    def var_x
+      @var_x ||= calculate_var(x / reference_x)
+    end
+
+    def var_y
+      @var_y ||= calculate_var(y / reference_y)
+    end
+
+    def var_z
+      @var_z ||= calculate_var(z / reference_z)
+    end
+
+    def l
+      ( 116.0 * var_y) - 16.0
+    end
+
+    def a
+      500.0 * ( var_x - var_y)
+    end
+
+    def b
+      200.0 * ( var_y - var_z)
+    end
+
+    private
+
+    def calculate_var(value)
+      if ( value > 0.008856)
+        value ** ( 1.0/3.0)
+      else
+        ( 7.787 * value) + ( 16.0 / 116.0)
+      end
+    end
+  end
+end

data/lib/color/comparison.rb

@@ -0,0 +1,31 @@
+module Color
+  class Comparison
+    attr_reader :rgb_color
+
+    def self.distance(rgb, rgb_match)
+      color_comparitor = self.new(rgb)
+      color_comparitor.compare(rgb_match)
+    end
+
+    def initialize(rgb_color)
+      @rgb_color = rgb_color.is_a?(Array) ? to_rgb_instance(rgb_color) : rgb_color
+    end
+
+    def compare(color)
+      color = color.is_a?(Array) ? to_rgb_instance(color) : color
+      CIE76(rgb_color, color)
+    end
+
+    private
+
+    def CIE76(subject, match)
+      subject_lab = subject.to_lab
+      match_lab = match.to_lab
+      Math.sqrt((subject_lab[0] - match_lab[0])**2 + (subject_lab[1] - match_lab[1])**2 + (subject_lab[2] - match_lab[2])**2)
+    end
+
+    def to_rgb_instance(rgb_array)
+      RGB.from_array(rgb_array)
+    end
+  end
+end

data/lib/color/rgb.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+module Color
+  class RGB
+    attr_reader :r, :g, :b
+
+    def self.from_array(rgb_array)
+      if rgb_array.length != 3
+        raise RGBArraySizeError.new("RGB array should contain 3 values")
+      end
+      self.new(rgb_array[0], rgb_array[1], rgb_array[2])
+    end
+
+    def self.from_int(rgb_int)
+      red   = (rgb_int >> 16) & 0xFF;
+      green = (rgb_int >> 8) & 0xFF;
+      blue  = rgb_int & 0xFF;
+      self.new(red, green, blue)
+    end
+
+    def initialize(r, g, b)
+      @r = r.to_f
+      @g = g.to_f
+      @b = b.to_f
+
+      validate_values
+    end
+
+    def to_lab
+      xyz_color = Color::XYZ.from_rgb(self)
+      Color::CIELab.from_xyz(xyz_color).to_a
+    end
+
+    def to_xyz
+      Color::XYZ.from_rgb(self).to_a
+    end
+
+    def to_int
+      rgb_int = r.to_i
+      rgb_int = (rgb_int << 8) + g.to_i
+      rgb_int = (rgb_int << 8) + b.to_i
+    end
+
+    def to_a
+      [r.to_i, g.to_i, b.to_i]
+    end
+
+    private
+
+    def validate_values
+      if r > 255
+        raise Color::RGBArrayValueOutOfBoundsError.new("R is #{r}")
+      end
+
+      if g > 255
+        raise Color::RGBArrayValueOutOfBoundsError.new("G is #{g}")
+      end
+
+      if b > 255
+        raise Color::RGBArrayValueOutOfBoundsError.new("B is #{b}")
+      end
+    end
+  end
+end

data/lib/color/version.rb

@@ -0,0 +1,3 @@
+module Color
+  VERSION = "0.0.2"
+end

data/lib/color/xyz.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+module Color
+  class XYZ
+    attr_reader :r, :g, :b
+
+    def self.from_rgb(rgb_color)
+      self.new(rgb_color)
+    end
+
+    def initialize(color)
+      @r = color.r.to_f
+      @g = color.g.to_f
+      @b = color.b.to_f
+    end
+
+    def to_a
+      [x, y, z]
+    end
+
+    def x
+      @x ||= ( var_r * 0.4124 + var_g * 0.3576 + var_b * 0.1805 )
+    end
+
+    def y
+      @y ||= ( var_r * 0.2126 + var_g * 0.7152 + var_b * 0.0722)
+    end
+
+    def z
+      @z ||= ( var_r * 0.0193 + var_g * 0.1192 + var_b * 0.9505)
+    end
+
+    def var_r
+      @var_r ||= convert(:r)
+    end
+
+    def var_g
+      @var_g ||= convert(:g)
+    end
+
+    def var_b
+      @var_b ||= convert(:b)
+    end
+
+    def convert(value)
+      variable = (send(value) / 255.0)
+      if ( variable > 0.04045)
+        variable = ( ( variable + 0.055) / 1.055) ** 2.4
+      else
+        variable = variable / 12.92
+      end
+      variable * 100
+    end
+  end
+end

data/spec/color/cie_lab_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Color::CIELab do
+  let(:rgb) { Color::RGB.new(255, 192, 203) }
+  let(:xyz) { Color::XYZ.new(rgb) }
+
+  subject{ Color::CIELab.new(xyz) }
+
+  describe '.from_xyz' do
+    it 'returns an instance of Color::CIELab' do
+      expect(Color::CIELab.from_xyz(xyz)).to be_an_instance_of(Color::CIELab)
+    end
+  end
+
+  describe '#initialize' do
+    it 'takes a Color::XYZ object and initiates x, y, z attributes' do
+      expect(subject.instance_variable_get(:@x)).to eq(xyz.x)
+      expect(subject.instance_variable_get(:@y)).to eq(xyz.y)
+      expect(subject.instance_variable_get(:@z)).to eq(xyz.z)
+    end
+  end
+
+  context 'l,a,b' do
+    describe '#b' do
+      it 'calculates l' do
+        expect(subject.l).to eq(83.58479885775868)
+      end
+    end
+
+    describe '#a' do
+      it 'calculates a' do
+        expect(subject.a).to eq(24.14966101257138)
+      end
+    end
+
+    describe '#b' do
+      it 'calculates b' do
+        expect(subject.b).to eq(3.315387151150806)
+      end
+    end
+  end
+
+  describe '#to_a' do
+    it 'returns an array of l,a,b values' do
+      expect(subject.to_a).to eq([83.58479885775868, 24.14966101257138, 3.315387151150806])
+    end
+  end
+end

data/spec/color/comparison_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Color::Comparison do
+  let(:rgb) { [12, 145, 44] }
+  let(:match) { [13, 32, 55] }
+  let(:instance)    { Color::Comparison.new(rgb) }
+  let(:rgb_instance) { Color::RGB.from_array(rgb) }
+
+  describe '#compare' do
+    subject{ Color::Comparison.new(rgb_instance) }
+
+    it 'CIE76 distance should be 90.7247 ' do
+      expect(subject.compare(Color::RGB.from_array(match)).round(4)).to eq(90.7247)
+    end
+  end
+
+  describe '.distance' do
+    it 'converts rgb_color array to RGB' do
+      comparitor = Color::Comparison.new(rgb)
+      expect(comparitor.instance_variable_get(:@rgb_color)).to be_an_instance_of(Color::RGB)
+    end
+
+    it 'converts match color array to RGB' do
+      expect(instance).to receive(:to_rgb_instance)
+        .with(match)
+        .and_return(Color::RGB.from_array(match))
+
+      expect(Color::Comparison).to receive(:new)
+        .with(rgb)
+        .and_return(instance)
+
+      Color::Comparison.distance(rgb, match)
+    end
+
+    it 'accepts a Color::RGB' do
+      comparitor = Color::Comparison.new(rgb_instance)
+      expect(comparitor.instance_variable_get(:@rgb_color)).to be(rgb_instance)
+    end
+
+    it 'accepts an RGB instance and does not convert' do
+      expect(instance).to_not receive(:to_rgb_instance)
+
+      expect(Color::Comparison).to receive(:new)
+        .with(rgb_instance)
+        .and_return(instance)
+
+      Color::Comparison.distance(rgb_instance, Color::RGB.from_array(match))
+    end
+  end
+end

data/spec/color/rgb_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Color::RGB do
+  describe '#inititalize' do
+    it 'takes R, G, B as args' do
+      color = Color::RGB.new(12, 13, 14)
+      expect(color.r).to eq(12.0)
+      expect(color.g).to eq(13.0)
+      expect(color.b).to eq(14.0)
+    end
+
+    it 'raises an error if  R, G, B args are greater than 255' do
+      expect{
+        Color::RGB.new(12, 13, 355)
+      }.to raise_error(Color::RGBArrayValueOutOfBoundsError)
+    end
+  end
+
+  context 'packing to integers' do
+    let(:rgb)   { [255, 20, 147] }
+    let(:color) { Color::RGB.from_array(rgb) }
+    let(:packed) { 16716947 }
+
+    describe '.to_int' do
+      it 'translates ' do
+        expect(color.to_int).to eq packed
+      end
+    end
+
+    describe '.from_int' do
+      it 'packs rgb values into an int for db storage' do
+        expect(Color::RGB.from_int(packed).to_a).to eq(rgb)
+      end
+    end
+  end
+
+  describe '#to_a' do
+    it 'returns an array of integers representing RGB' do
+      expect(Color::RGB.new(23, 56, 77).to_a).to eq([23, 56, 77])
+    end
+  end
+
+  describe '.from_array' do
+    it 'builds an RGB object' do
+      color = Color::RGB.from_array([12, 13, 14])
+      expect(color).to be_an_instance_of(Color::RGB)
+      expect(color.r).to eq(12.0)
+      expect(color.g).to eq(13.0)
+      expect(color.b).to eq(14.0)
+    end
+
+    context 'errors' do
+      it 'will raise an exception if an array is < 3 values' do
+        expect{ Color::RGB.from_array([]) }.to raise_error(Color::RGBArraySizeError)
+      end
+
+      it 'will raise an exception if an array is not > values' do
+        expect{
+          Color::RGB.from_array([1, 2, 3, 4])
+        }.to raise_error(Color::RGBArraySizeError)
+      end
+
+      it 'will raise an exception if array values are greater than 255' do
+        expect{
+          Color::RGB.from_array([1, 2, 333])
+        }.to raise_error(Color::RGBArrayValueOutOfBoundsError)
+      end
+    end
+  end
+
+  context 'color conversions' do
+    let(:rgb) { [34, 155, 167] }
+
+    describe '#to_lab' do
+      it 'should convert to expected values' do
+        color = Color::RGB.from_array(rgb)
+        expect(color.to_lab).to eq([
+            58.57679489951133,
+            -27.28307080696585,
+            -15.45207927427481
+          ])
+      end
+    end
+
+    describe '#to_xyz' do
+      it 'should convert to expected values' do
+        color = Color::RGB.from_array(rgb)
+        expect(color.to_xyz).to eq([
+            19.356083204751798,
+            26.57279128189712,
+            40.66810545648842
+          ])
+      end
+    end
+  end
+end

data/spec/color/xyz_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Color::XYZ do
+  let(:rgb) { Color::RGB.new(255, 192, 203) }
+  subject   { Color::XYZ.new(rgb) }
+
+  describe '.from_rgb' do
+    it 'returns an instance of Color::XYZ' do
+      expect(Color::XYZ.from_rgb(rgb)).to be_an_instance_of(Color::XYZ)
+    end
+  end
+
+  describe '#initialize' do
+    it 'takes a Color::RGB object and initiates r, g, b attributes' do
+      expect(subject.instance_variable_get(:@r)).to eq(rgb.r)
+      expect(subject.instance_variable_get(:@g)).to eq(rgb.g)
+      expect(subject.instance_variable_get(:@b)).to eq(rgb.b)
+    end
+  end
+
+  context 'x, y, z' do
+    describe '#x' do
+      it 'calculates x' do
+        expect(subject.x).to eq(70.8691291752058)
+      end
+    end
+
+    describe '#y' do
+      it 'calculates y' do
+        expect(subject.y).to eq(63.27107070246611)
+      end
+    end
+
+    describe '#z' do
+      it 'calculates z' do
+        expect(subject.z).to eq(64.977242282389)
+      end
+    end
+  end
+
+  describe '#to_a' do
+    it 'returns an array of x, y, z values' do
+      expect(subject.to_a).to eq([70.8691291752058, 63.27107070246611, 64.977242282389])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'color'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.color = true
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: color-rgb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- ramin keene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RGB color utilities for converting RGB color into different colorspace
+  (CIE*Lab or XYZ), a different format, or comparing similarity of two colors
+email:
+- raminkeene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- color-rgb.gemspec
+- lib/color-rgb.rb
+- lib/color.rb
+- lib/color/cie_lab.rb
+- lib/color/comparison.rb
+- lib/color/rgb.rb
+- lib/color/version.rb
+- lib/color/xyz.rb
+- spec/color/cie_lab_spec.rb
+- spec/color/comparison_spec.rb
+- spec/color/rgb_spec.rb
+- spec/color/xyz_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/apartmenttherapy/color-rgb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RGB color utlities conversion and color distance
+test_files:
+- spec/color/cie_lab_spec.rb
+- spec/color/comparison_spec.rb
+- spec/color/rgb_spec.rb
+- spec/color/xyz_spec.rb
+- spec/spec_helper.rb