color 1.4.2 → 1.5.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjQwMTIxMzBkMGIzMmI2YmJjOWMwODE3ZDU5ZTlhYTFlNGM2YmQ0Zg==
+  data.tar.gz: !binary |-
+    M2VjNGUwNmFmOWRhMzQzZjA3OWZhMTM2MDgxYzcxMzc4NjYzOTZlZQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmYzNTFkZWZjYWM1ZTAxNjJhYzZkMTk0NGE2OTU5MTBiOGM1NWY4Mzg3NDA1
+    MmVjMjEzOTYzYzVkMGNkOGRmNDY0MTM0YmI0ZDc3YTYxMDAxMzE1OGZhNTNh
+    NmU4Y2Q5ZTY2ZjA1NDMwZThmYTA1ZDNjNTkzZTMzOGEwMzJlYmE=
+  data.tar.gz: !binary |-
+    NWIxY2I2NTVjN2RjZDQwMTc5NjQwZDRhODM5MmMwODJiMDQwMGNmM2M4Yzk3
+    ZDUxMzJhYjE1ODA3ZGY3NTZmMzJkODg0MmNjZTI2NzA5NjcxZjcxNTYzMzk2
+    YWQyZGQ3Y2RmY2RkOTc0NzkzMTYxODI1Mzg4MzA5MDA3YjEyYjQ=

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+,���������>Z?)��յ�Ũ�#�]WkV��rrv��d��
+�H;�'���E<��-Z7��)����<�� ��q#��Q�����|O��1efh������>QU�g��g�_���Q��+�&�:�F���C�}��s�/9[�

data.tar.gz.sig

@@ -1,3 +1,2 @@
-xn)Zn����Q�P���VU�GO�(�%ȩ0(�i[�p�̽p�[�q��:
-�ۀ�)�����屮{�Yړ���}�:���d���E������'I����2��6�;��d$�H��8ٚ�7/�먇m���=�$&`D�7�8̼�<����}U'!~dZ������ٟ�wr��
��ѩc2嬼�]g�L��G���
-���G�I@�iLDcP��Pÿ���ӣB<Y�®�(���,�;��r_�3��.��
+�L�
+��}��+�n{��`7~�.&J�Q~�$lȊ��V���x{�,��¼���(w^><���\
�X�[vBC21��J�7���Δ�w4ļѾJ7a��2\r�u|eò����^o�p�9p��!������)�

data/History.rdoc

@@ -1,3 +1,36 @@
+== 1.5.1 / 2014-01-28
+
+* color 1.5 was a yanked release.
+
+* Minor enhancements:
+  * Added new methods to Color::RGB to make it so that the default defined
+    colours can be looked up by hex, name, or both.
+  * Added a method to Color::RGB to extract colours from text by hex, name, or
+    both.
+  * Added new common methods for colour names. Converted colours do not retain
+    names.
+  * Restructured color comparisons to use protocols instead of custom
+    implementations. This makes it easier to implement new colour classes. To
+    make this work, color classes should +include+ Color only need to implement
+    <tt>#coerce(other)</tt>, <tt>#to_a</tt>, and supported conversion methods
+    (e.g., <tt>#to_rgb</tt>).
+  * Added @daveheitzman’s initial implementation of an RGB contrast method as
+    an extension file: <tt>require 'color/rgb/contrast'</tt>. This method and
+    the value it returns should be considered experimental; it requires further
+    examination to ensure that the results produced are consistent with the
+    contrast comparisons used in Color::Palette::MonoContrast.
+  * Reducing duplicated code.
+
+* Bug Fixes:
+  * Moved +lib/color/rgb-colors.rb+ to +lib/color/rgb/colors.rb+. This should
+    have no impact in general.
+  * Improved the way that named colors are specified internally.
+  * Fixed bugs with Ruby 1.8.7 that may have been introduced in color 1.4.2.
+
+* Tooling Changes:
+  * Added simplecov for test coverage analysis.
+  * Modernized Travis CI support.
+
 == 1.4.2 / 2013-06-30
 
 Maintenance:

data/Manifest.txt

@@ -13,7 +13,7 @@ lib/color/palette.rb
 lib/color/palette/adobecolor.rb
 lib/color/palette/gimp.rb
 lib/color/palette/monocontrast.rb
-lib/color/rgb-colors.rb
+lib/color/rgb/colors.rb
 lib/color/rgb.rb
 lib/color/rgb/metallic.rb
 lib/color/yiq.rb

data/README.rdoc

@@ -23,8 +23,20 @@ L*a*b*) are not supported because Color does not yet support colour profiles,
 giving no meaningful way to convert colours in absolute colour spaces (like
 L*a*b*, XYZ) to non-absolute colour spaces (like RGB).
 
-Color version 1.4.2 updates the release and install as a RubyGem to remove an
-unnecessary dependency, adds code climate analysis, and Travis CI support.
+Color version 1.5.1 is mostly a maintenance release, fixing some bugs that may
+have been introduced with the previous release on Ruby 1.8.7. New features
+include an experimental contrast comparison method for RGB colours (found in
+lib/color/rgb/contrast.rb) provided by Dave Heitzman, and methods suggested by
+Thomas Sawyer based on the Spectrum library.
+
+Barring bugs introduced in this release, this will be the last version of color
+that supports Ruby 1.8, so make sure that your gem specification is set
+properly, to <tt>~> 1.5</tt> if that matters for your application.
+
+=== Note about color 1.5
+
+Color 1.5 was released before the documetation was complete and has been
+yanked.
 
 == History
 

data/Rakefile

@@ -3,7 +3,6 @@
 require 'rubygems'
 require 'hoe'
 
-Hoe.plugin :bundler
 Hoe.plugin :doofus
 Hoe.plugin :email
 Hoe.plugin :gemspec2
@@ -12,9 +11,13 @@ Hoe.plugin :minitest
 Hoe.plugin :rubyforge
 Hoe.plugin :travis
 
-Hoe.spec 'color' do
-  developer "Austin Ziegler", "austin@rubyforge.org"
-  developer "Matt Lyon", "matt@postsomnia.com"
+spec = Hoe.spec 'color' do
+  developer('Austin Ziegler', 'austin@rubyforge.org')
+  developer('Matt Lyon', 'matt@postsomnia.com')
+
+  self.need_tar = true
+
+  # self.require_ruby_version '>= 1.9.2'
 
   self.remote_rdoc_dir = '.'
   self.rsync_args << ' --exclude=statsvn/'
@@ -22,8 +25,8 @@ Hoe.spec 'color' do
   self.history_file = 'History.rdoc'
   self.readme_file = 'README.rdoc'
   self.extra_rdoc_files = FileList["*.rdoc"].to_a
+  self.licenses = ["MIT"]
 
-  self.extra_dev_deps << ['hoe-bundler', '~> 1.2']
   self.extra_dev_deps << ['hoe-doofus', '~> 1.0']
   self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
   self.extra_dev_deps << ['hoe-git', '~> 1.5']
@@ -32,3 +35,15 @@ Hoe.spec 'color' do
   self.extra_dev_deps << ['minitest', '~> 5.0']
   self.extra_dev_deps << ['rake', '~> 10.0']
 end
+
+namespace :test do
+  desc "Runs test coverage. Only works Ruby 1.9+ and assumes 'simplecov' is installed."
+  task :coverage do
+    spec.test_prelude = [
+      'require "simplecov"',
+      'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+      'gem "minitest"'
+    ].join('; ')
+    Rake::Task['test'].execute
+  end
+end

data/lib/color.rb

@@ -3,10 +3,11 @@
 
 # = Colour Management with Ruby
 module Color
-  COLOR_VERSION = '1.4.2'
+  COLOR_VERSION = '1.5.1'
 
   class RGB; end
   class CMYK; end
+  class HSL; end
   class GrayScale; end
   class YIQ; end
 
@@ -18,65 +19,115 @@ module Color
   # tolerance value of each other.
   COLOR_TOLERANCE = 1e-4
 
-  class << self
-    # Returns +true+ if the value is less than COLOR_EPSILON.
-    def near_zero?(value)
-      (value.abs <= COLOR_EPSILON)
-    end
+  # Compares the +other+ colour to this one. The +other+ colour will be
+  # coerced to the same type as the current colour. Such converted colour
+  # comparisons will always be more approximate than non-converted
+  # comparisons.
+  #
+  # If the +other+ colour cannot be coerced to the current colour class, a
+  # +NoMethodError+ exception will be raised.
+  #
+  # All values are compared as floating-point values, so two colours will be
+  # reported equivalent if all component values are within COLOR_TOLERANCE
+  # of each other.
+  def ==(other)
+    Color.equivalent?(self, other)
+  end
 
-    # Returns +true+ if the value is within COLOR_EPSILON of zero or less than
-    # zero.
-    def near_zero_or_less?(value)
-      (value < 0.0 or near_zero?(value))
-    end
+  # The primary name for the colour.
+  def name
+    names.first
+  end
 
-    # Returns +true+ if the value is within COLOR_EPSILON of one.
-    def near_one?(value)
-      near_zero?(value - 1.0)
-    end
+  # All names for the colour.
+  def names
+    self.names = nil unless defined? @names
+    @names
+  end
+  def names=(n) # :nodoc:
+    @names = Array(n).flatten.compact.map(&:to_s).map(&:downcase).sort.uniq
+  end
+  alias_method :name=, :names=
+end
 
-    # Returns +true+ if the value is within COLOR_EPSILON of one or more than
-    # one.
-    def near_one_or_more?(value)
-      (value > 1.0 or near_one?(value))
-    end
+class << Color
+  # Returns +true+ if the value is less than COLOR_EPSILON.
+  def near_zero?(value)
+    (value.abs <= Color::COLOR_EPSILON)
+  end
 
-    # Normalizes the value to the range (0.0) .. (1.0).
-    def normalize(value)
-      if near_zero_or_less? value
-        0.0
-      elsif near_one_or_more? value
-        1.0
-      else
-        value
-      end
-    end
-    alias normalize_fractional normalize
+  # Returns +true+ if the value is within COLOR_EPSILON of zero or less than
+  # zero.
+  def near_zero_or_less?(value)
+    (value < 0.0 or near_zero?(value))
+  end
 
-    def normalize_to_range(value, range)
-      range = (range.end..range.begin) if (range.end < range.begin)
+  # Returns +true+ if the value is within COLOR_EPSILON of one.
+  def near_one?(value)
+    near_zero?(value - 1.0)
+  end
 
-      if value <= range.begin
-        range.begin
-      elsif value >= range.end
-        range.end
-      else
-        value
-      end
-    end
+  # Returns +true+ if the value is within COLOR_EPSILON of one or more than
+  # one.
+  def near_one_or_more?(value)
+    (value > 1.0 or near_one?(value))
+  end
+
+  # Returns +true+ if the two values provided are near each other.
+  def near?(x, y)
+    (x - y).abs <= Color::COLOR_TOLERANCE
+  end
+
+  # Returns +true+ if the two colours are roughly equivalent. If colour
+  # conversions are required, this all conversions will be implemented
+  # using the default conversion mechanism.
+  def equivalent?(a, b)
+    a.to_a.zip(a.coerce(b).to_a).all? { |(x, y)| near?(x, y) }
+  end
+
+  # Coerces, if possible, the second given colour object to the first
+  # given colour object type. This will probably involve colour
+  # conversion and therefore a loss of fidelity.
+  def coerce(a, b)
+    a.coerce(b)
+  end
 
-    # Normalize the value to the range (0) .. (255).
-    def normalize_byte(value)
-      normalize_to_range(value, 0..255).to_i
+  # Normalizes the value to the range (0.0) .. (1.0).
+  def normalize(value)
+    if near_zero_or_less? value
+      0.0
+    elsif near_one_or_more? value
+      1.0
+    else
+      value
     end
-    alias normalize_8bit normalize_byte
+  end
+  alias normalize_fractional normalize
+
+  # Normalizes the value to the specified range.
+  def normalize_to_range(value, range)
+    range = (range.end..range.begin) if (range.end < range.begin)
 
-    # Normalize the value to the range (0) .. (65535).
-    def normalize_word(value)
-      normalize_to_range(value, 0..65535).to_i
+    if value <= range.begin
+      range.begin
+    elsif value >= range.end
+      range.end
+    else
+      value
     end
-    alias normalize_16bit normalize_word
   end
+
+  # Normalize the value to the range (0) .. (255).
+  def normalize_byte(value)
+    normalize_to_range(value, 0..255).to_i
+  end
+  alias normalize_8bit normalize_byte
+
+  # Normalize the value to the range (0) .. (65535).
+  def normalize_word(value)
+    normalize_to_range(value, 0..65535).to_i
+  end
+  alias normalize_16bit normalize_word
 end
 
 require 'color/rgb'
@@ -84,10 +135,10 @@ require 'color/cmyk'
 require 'color/grayscale'
 require 'color/hsl'
 require 'color/yiq'
-require 'color/rgb/metallic'
+require 'color/css'
 
-module Color
-  def self.const_missing(name) #:nodoc:
+class << Color
+  def const_missing(name) #:nodoc:
     case name
     when "VERSION", :VERSION, "COLOR_TOOLS_VERSION", :COLOR_TOOLS_VERSION
       warn "Color::#{name} has been deprecated. Use Color::COLOR_VERSION instead."
@@ -113,7 +164,7 @@ module Color
   #                 Color::RGB object will be created.
   # mode = :cmyk::  +values+ must be an array of [ cyan %, magenta %, yellow
   #                 %, black % ]. A Color::CMYK object will be created.
-  def self.new(values, mode = :rgb)
+  def new(values, mode = :rgb)
     warn "Color.new has been deprecated. Use Color::#{mode.to_s.upcase}.new instead."
     color = case mode
             when :hsl

data/lib/color/cmyk.rb

@@ -3,56 +3,42 @@
 # would be mixed from 30% cyan, 0% magenta, 80% yellow, and 30% black.
 # Primarily used in four-colour printing processes.
 class Color::CMYK
+  include Color
+
   # The format of a DeviceCMYK colour for PDF. In color-tools 2.0 this will
   # be removed from this package and added back as a modification by the
   # PDF::Writer package.
   PDF_FORMAT_STR = "%.3f %.3f %.3f %.3f %s"
 
-  # Compares the other colour to this one. The other colour will be
-  # converted to CMYK before comparison, so the comparison between a CMYK
-  # colour and a non-CMYK colour will be approximate and based on the other
-  # colour's #to_cmyk conversion. If there is no #to_cmyk conversion, this
-  # will raise an exception. This will report that two CMYK colours are
-  # equivalent if all component values are within COLOR_TOLERANCE of each
-  # other.
-  def ==(other)
-    other = other.to_cmyk
-    other.kind_of?(Color::CMYK) and
-    ((@c - other.c).abs <= Color::COLOR_TOLERANCE) and
-    ((@m - other.m).abs <= Color::COLOR_TOLERANCE) and
-    ((@y - other.y).abs <= Color::COLOR_TOLERANCE) and
-    ((@k - other.k).abs <= Color::COLOR_TOLERANCE)
+  # Coerces the other Color object into CMYK.
+  def coerce(other)
+    other.to_cmyk
   end
 
-  # Creates a CMYK colour object from fractional values 0..1.
-  #
-  #   Color::CMYK.from_fraction(0.3, 0, 0.8, 0.3)
-  def self.from_fraction(c = 0, m = 0, y = 0, k = 0)
-    colour = Color::CMYK.new
-    colour.c = c
-    colour.m = m
-    colour.y = y
-    colour.k = k
-    colour
-  end
+  class << self
+    # Creates a CMYK colour object from fractional values 0..1.
+    #
+    #   Color::CMYK.from_fraction(0.3, 0, 0.8, 0.3)
+    def from_fraction(c = 0, m = 0, y = 0, k = 0, &block)
+      new(c, m, y, k, 1.0, &block)
+    end
 
-  # Creates a CMYK colour object from percentages. Internally, the colour is
-  # managed as fractional values 0..1.
-  #
-  #   Color::CMYK.new(30, 0, 80, 30)
-  def self.from_percent(c = 0, m = 0, y = 0, k = 0)
-    Color::CMYK.new(c, m, y, k)
+    # Creates a CMYK colour object from percentages. Internally, the colour is
+    # managed as fractional values 0..1.
+    #
+    #   Color::CMYK.new(30, 0, 80, 30)
+    def from_percent(c = 0, m = 0, y = 0, k = 0, &block)
+      new(c, m, y, k, &block)
+    end
   end
 
   # Creates a CMYK colour object from percentages. Internally, the colour is
   # managed as fractional values 0..1.
   #
   #   Color::CMYK.new(30, 0, 80, 30)
-  def initialize(c = 0, m = 0, y = 0, k = 0)
-    @c = c / 100.0
-    @m = m / 100.0
-    @y = y / 100.0
-    @k = k / 100.0
+  def initialize(c = 0, m = 0, y = 0, k = 0, radix = 100.0, &block) # :yields self:
+    @c, @m, @y, @k = [ c, m, y, k ].map { |v| Color.normalize(v / radix) }
+    block.call(self) if block
   end
 
   # Present the colour as a DeviceCMYK fill colour string for PDF. This will
@@ -138,15 +124,10 @@ class Color::CMYK
   # profiles.
   def to_rgb(use_adobe_method = false)
     if use_adobe_method
-      r = 1.0 - [1.0, @c + @k].min
-      g = 1.0 - [1.0, @m + @k].min
-      b = 1.0 - [1.0, @y + @k].min
+      Color::RGB.from_fraction(*adobe_cmyk_rgb)
     else
-      r = 1.0 - (@c.to_f * (1.0 - @k.to_f) + @k.to_f)
-      g = 1.0 - (@m.to_f * (1.0 - @k.to_f) + @k.to_f)
-      b = 1.0 - (@y.to_f * (1.0 - @k.to_f) + @k.to_f)
+      Color::RGB.from_fraction(*standard_cmyk_rgb)
     end
-    Color::RGB.from_fraction(r, g, b)
   end
 
   # Converts the CMYK colour to a single greyscale value. There are
@@ -264,4 +245,19 @@ class Color::CMYK
   def k=(kk)
     @k = Color.normalize(kk)
   end
+
+  def to_a
+    [ c, m, y, k ]
+  end
+
+  private
+  # Implements the Adobe PDF conversion of CMYK to RGB.
+  def adobe_cmyk_rgb
+    [ @c, @m, @y ].map { |v| 1.0 - [ 1.0, v + @k ].min }
+  end
+
+  # Implements the standard conversion of CMYK to RGB.
+  def standard_cmyk_rgb
+    [ @c, @m, @y ].map { |v| 1.0 - (v * (1.0 - k) + k) }
+  end
 end