paleta 0.0.2 → 0.0.3

data/lib/paleta/color.rb

@@ -1,15 +1,48 @@
+require 'paleta/core_ext/math'
+
 module Paleta
   class Color
     include Math
     
     attr_reader :red, :green, :blue, :hue, :saturation, :lightness, :hex
     
-    def initialize(red = 0, green = 0, blue = 0)
+    def initialize(*args)
+      
+      # example: new(:hex, "336699")
+      if args.length == 2 && args[0] == :hex && args[1].is_a?(String)
+        hex_init(args[1])
+      # example: new(235, 129, 74)
+      elsif args.length == 3 && args[0].is_a?(Numeric) && args[1].is_a?(Numeric) && args[2].is_a?(Numeric)
+        rgb_init(args[0], args[1], args[2])
+      elsif args.length == 4 && [:rgb, :hsl].include?(args[0]) && args[1].is_a?(Numeric) && args[2].is_a?(Numeric) && args[3].is_a?(Numeric)
+        # example: new(:hsl, 320, 96, 74)
+        rgb_init(args[1], args[2], args[3]) if args[0] == :rgb
+        # example: new(:rgb, 235, 129, 74)
+        hsl_init(args[1], args[2], args[3]) if args[0] == :hsl
+      elsif args.length == 0
+        # example: new()
+        rgb_init(0, 0, 0)
+      else
+        raise(ArgumentError, "Invalid arguments")
+      end
+    end
+    
+    def rgb_init(red = 0, green = 0, blue = 0)
       self.red = red
       self.green = green
       self.blue = blue
     end
     
+    def hsl_init(hue = 0, saturation = 0, lightness = 0)
+      self.hue = hue
+      self.saturation = saturation
+      self.lightness = lightness
+    end
+    
+    def hex_init(val = "000000")
+      self.hex = val
+    end
+    
     def red=(val)
       @red = range_validator(val, 0..255)
       update_hsl
@@ -47,10 +80,7 @@ module Paleta
     end
     
     def hex=(val)
-      if val.length != 6 || 
-        (val[0..1] == 0 && val[0..1] != "00") || 
-        (val[2..3] == 0 && val[2..3] != "00") || 
-        (val[4..5] == 0 && val[4..5] != "00")
+      unless val.length == 6 && /^[[:xdigit:]]+$/ === val
         raise(ArgumentError, "Invalid Hex String")
       end
       @hex = val.upcase
@@ -83,15 +113,15 @@ module Paleta
     end
     
     def similarity(color)
-      sqrt(((@red - color.red) ** 2) + ((@green - color.green) ** 2) + ((@blue - color.blue) ** 2)) / sqrt(3 * (255 ** 2))
+      distance({ :r => @red, :g => @green, :b => @blue}, { :r => color.red, :g => color.green, :b => color.blue}) / sqrt(3 * (255 ** 2))
     end
     
     private
     
     def update_hsl
-      r = @red / 255.0 rescue 0
-      g = @green / 255.0 rescue 0
-      b = @blue / 255.0 rescue 0
+      r = @red / 255.0 rescue 0.0
+      g = @green / 255.0 rescue 0.0
+      b = @blue / 255.0 rescue 0.0
       
       min = [r, g, b].min
       max = [r, g, b].max
@@ -116,9 +146,9 @@ module Paleta
     
     def update_rgb
       
-      h = @hue / 360.0
-      s = @saturation / 100.0
-      l = @lightness / 100.0
+      h = @hue / 360.0 rescue 0
+      s = @saturation / 100.0 rescue 0
+      l = @lightness / 100.0 rescue 0
       
       if s == 0
         r = g = b = l * 255

data/lib/paleta/core_ext/math.rb

@@ -0,0 +1,50 @@
+module Math
+  def distance(a, b)
+    unless (a.is_a?(Hash) && b.is_a?(Hash) && a.keys == b.keys) || (a.is_a?(Array) && b.is_a?(Array) && a.size == b.size)
+      raise ArgumentError, "Arguments must be Hashes with identical keys or Arrays of the same size"
+    end
+    sum = 0
+    a.keys.each { |k| sum += (a[k] - b[k]) ** 2 } if a.is_a?(Hash)
+    a.each_with_index { |v, i| sum += (a[i] - b[i]) ** 2 } if a.is_a?(Array)
+    sqrt(sum)
+  end
+  
+  class MultipleRegression
+    attr_accessor :slope, :offset
+
+    def initialize dr, dg, db
+      
+      @slope, @offset = {}, {}
+      @size = dr.size
+      raise "arguments not same length!" unless @size == dg.size && @size == db.size
+    
+      if @size == 1
+        @slope = { :r => dr[0], :g => dg[0], :b => db[0] }
+        @offset = { :r => 0, :g => 0, :b => 0 }
+        return
+      end
+    
+      srr = sgg = sbb = srg = sbr = sgb = sr = sb = sg = 0
+      dr.zip(dg,db).each do |r,g,b|
+        srr += r ** 2
+        sgg += g ** 2
+        srg += r * g
+        sbr += b * r
+        sgb += g * b
+        sr  += r
+        sb  += g
+        sg  += b
+      end
+      
+      @slope[:r] = ( @size * srg - sr * sb ) / ( @size * srr - sr ** 2 ).to_f
+      @slope[:g] = ( @size * sgb - sb * sg ) / ( @size * sgg - sb ** 2 ).to_f
+      @slope[:b] = ( @size * sgb - sb * sg ) / ( @size * sbb - sg ** 2 ).to_f
+    
+      @offset[:r] = (sb - @slope[:r] * sr) / @size
+      @offset[:g] = (sg - @slope[:g] * sb) / @size
+      @offset[:b] = (sr - @slope[:b] * sg) / @size
+      
+      return
+    end
+  end
+end

data/lib/paleta/palette.rb

@@ -1,3 +1,5 @@
+require 'paleta/core_ext/math'
+
 module Paleta
   class Palette
     include Math
@@ -15,6 +17,18 @@ module Paleta
       color.is_a?(Color) ? @colors << color : raise(ArgumentError, "Passed argument is not a Color")
     end
     
+    def push(color)
+      self << color
+    end
+    
+    def pop
+      @colors.pop
+    end
+    
+    def delete_at(i = 0)
+      @colors.delete_at(i)
+    end
+    
     def [](i)
       @colors[i]
     end
@@ -46,25 +60,24 @@ module Paleta
     end
     
     def similarity(palette)
-      r1 = self.fit
-      r2 = palette.fit
+      r, a, b = [], [], []
+      (0..1).each { |i| a[i], b[i] = {}, {} }
       
-      a1, a2, b1, b2 = {}, {}, {}, {}
-      a1[:r] = 0 * r1.slope[:r] + r1.offset[:r]
-      a1[:g] = 0 * r1.slope[:g] + r1.offset[:g]
-      a1[:b] = 0 * r1.slope[:b] + r1.offset[:b]
-      b1[:r] = 255 * r1.slope[:r] + r1.offset[:r]
-      b1[:g] = 255 * r1.slope[:g] + r1.offset[:g]
-      b1[:b] = 255 * r1.slope[:b] + r1.offset[:b]
-      a2[:r] = 0 * r2.slope[:r] + r2.offset[:r]
-      a2[:g] = 0 * r2.slope[:g] + r2.offset[:g]
-      a2[:b] = 0 * r2.slope[:b] + r2.offset[:b]
-      b2[:r] = 255 * r2.slope[:r] + r2.offset[:r]
-      b2[:g] = 255 * r2.slope[:g] + r2.offset[:g]
-      b2[:b] = 255 * r2.slope[:b] + r2.offset[:b]
-
-      d1 = sqrt(((a1[:r] - a2[:r]) ** 2) + ((a1[:g] - a2[:g]) ** 2) + ((a1[:b] - a2[:b]) ** 2)) / sqrt(3 * (65025 ** 2))
-      d2 = sqrt(((b1[:r] - b2[:r]) ** 2) + ((b1[:g] - b2[:g]) ** 2) + ((b1[:b] - b2[:b]) ** 2)) / sqrt(3 * (65025 ** 2))
+      # r[i] is the Math::MultipleRegression of the Palette in RGB space
+      r[0] = self.fit
+      r[1] = palette.fit
+      
+      [0, 1].each do |i|
+        [:r, :g, :b].each do |k|
+          a[i][k] = 0 * r[i].slope[k] + r[i].offset[k]
+          b[i][k] = 255 * r[i].slope[k] + r[i].offset[k]
+        end
+      end
+      
+      d_max = sqrt(3 * (65025 ** 2))
+     
+      d1 = distance(a[0], a[1]) / d_max
+      d2 = distance(b[0], b[1]) / d_max
       
       d1 + d2
     end

data/lib/paleta/version.rb

@@ -1,3 +1,3 @@
 module Paleta
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/paleta.rb

@@ -1,6 +1,5 @@
 require 'paleta/version'
 require 'paleta/color'
-require 'paleta/multiple_regression'
 require 'paleta/palette'
 
 module Paleta

data/readme.markdown

@@ -22,7 +22,16 @@ and run
 
 ### Color
 
-    # create a color with RGB components
+	# create a color with HSL components
+	color = Paleta::Color.new(:hsl, 280, 37, 68)
+	
+	# create a color with RGB components
+	color = Paleta::Color.new(:rgb, 94, 161, 235)
+	
+	# create a color with a HEX value
+	color = Paleta::Color.new(:hex, "5EA1EB")
+	
+    # creating a color with no flag defaults to RGB components
 	color = Paleta::Color.new(94, 161, 235)
 	
 	# access component values
@@ -58,11 +67,15 @@ and run
 	# add Colors to a Palette
     color1 = Paleta::Color.new(13, 57, 182)
     color2 = Paleta::Color.new(94, 161, 235)
-    palette = Paleta::Palette.new(c1, c2)
+	color3 = Paleta::Color.new(237, 182, 17)
+    palette = Paleta::Palette.new(color1, color2, color3)
 
 	# retreive a Color from a Palette
 	palette[1] # => color2
 	
+	# remove a Color from a Palette by index
+	palette.delete_at(2)
+	
 	# lighten and darken an entire Palette by a percentage
 	palette.lighten!(15)
 	palette.darken!(20)
@@ -71,13 +84,13 @@ and run
 	palette.invert!
 	
 	# calculate similarity of two Palettes
-    color1 = Paleta::Color.new(13, 57, 182)
-    color2 = Paleta::Color.new(237, 172, 33)
-    palette1 = Paleta::Palette.new(color1, color2)
+    color4 = Paleta::Color.new(13, 57, 182)
+    color5 = Paleta::Color.new(237, 172, 33)
+    palette1 = Paleta::Palette.new(color4, color5)
     
-    color3 = Paleta::Color.new(13, 57, 182)
-    color4 = Paleta::Color.new(94, 161, 235)
-    palette2 = Paleta::Palette.new(color3, color4)
+    color6 = Paleta::Color.new(13, 57, 182)
+    color7 = Paleta::Color.new(94, 161, 235)
+    palette2 = Paleta::Palette.new(color6, color7)
 	
     palette1.similarity(palette2) # => 0.0046992695975874915
 	

data/spec/models/color_spec.rb

@@ -1,13 +1,34 @@
 require 'spec_helper'
 
 describe Paleta::Color do
-  it "should initialize with components in 0..255" do
+  it "should initialize with RGB components in 0..255" do
     color = Paleta::Color.new(94, 161, 235)
     color.red.should == 94
     color.green.should == 161
     color.blue.should == 235
   end
   
+  it "should initialize with the :hex flag and a valid 6 character HEX string" do
+    color = Paleta::Color.new(:hex, "5EA1EB")
+    color.red.should == 94
+    color.green.should == 161
+    color.blue.should == 235
+  end
+  
+  it "should initialize with the :hsl flag, hue in 0..360, and saturation and lightness in 0..100" do
+    color = Paleta::Color.new(:hsl, 280, 37, 68)
+    color.hue.should == 280
+    color.saturation.should == 37
+    color.lightness.should == 68
+  end
+  
+  it "should initialize with the :rgb flag with RGB components in 0..255" do
+    color = Paleta::Color.new(:rgb, 94, 161, 235)
+    color.red.should == 94
+    color.green.should == 161
+    color.blue.should == 235
+  end
+  
   it "should not initialize with components not in 0..255" do
     expect{ Paleta::Color.new(-74, 333, 4321) }.to raise_error
   end

data/spec/models/palette_spec.rb

@@ -14,7 +14,7 @@ describe Paleta::Palette do
     expect{ Paleta::Palette.new(c1, c2) }.to raise_error
   end
   
-  it "should add colors to an initialized palette" do
+  it "should add Colors" do
     c1 = Paleta::Color.new(13, 57, 182)
     c2 = Paleta::Color.new(94, 161, 235)
     palette = Paleta::Palette.new(c1)
@@ -22,14 +22,39 @@ describe Paleta::Palette do
     palette.include?(c2).should be_true
   end
   
-  it "should allow array-style accessing of colors" do
+  it "should add Colors with push" do
+    c1 = Paleta::Color.new(13, 57, 182)
+    c2 = Paleta::Color.new(94, 161, 235)
+    palette = Paleta::Palette.new(c1)
+    palette.push(c2)
+    palette[1].should == c2
+  end
+  
+  it "should remove the last Color with pop" do
+    c1 = Paleta::Color.new(13, 57, 182)
+    c2 = Paleta::Color.new(94, 161, 235)
+    palette = Paleta::Palette.new(c1, c2)
+    c = palette.pop()
+    c.should == c2
+    palette.include?(c2).should be_false
+  end
+  
+  it "should remove Colors by index" do
+    c1 = Paleta::Color.new(13, 57, 182)
+    c2 = Paleta::Color.new(94, 161, 235)
+    palette = Paleta::Palette.new(c1, c2)
+    palette.delete_at(0)
+    palette.include?(c1).should be_false
+  end
+  
+  it "should allow array-style accessing of Colors" do
     c1 = Paleta::Color.new(13, 57, 182)
     palette = Paleta::Palette.new(c1)
     palette[0].should == c1
     palette[1].should be_nil
   end
   
-  it "should lighten each color in a palette by a percentage" do
+  it "should lighten each Color in a Palette by a percentage" do
     c1 = Paleta::Color.new(13, 57, 182)
     c2 = Paleta::Color.new(94, 161, 235)
     palette = Paleta::Palette.new(c1, c2)
@@ -41,7 +66,7 @@ describe Paleta::Palette do
     palette[1].lightness.should == lightness2 + percent
   end
   
-  it "should darken each color in a palette by a percentage" do
+  it "should darken each Color in a Palette by a percentage" do
     c1 = Paleta::Color.new(13, 57, 182)
     c2 = Paleta::Color.new(94, 161, 235)
     palette = Paleta::Palette.new(c1, c2)
@@ -53,7 +78,7 @@ describe Paleta::Palette do
     palette[1].lightness.should == lightness2 - percent
   end
   
-  it "should invert each color in a palette" do
+  it "should invert each Color in a Palette" do
     c1 = Paleta::Color.new(13, 57, 182)
     c2 = Paleta::Color.new(94, 161, 235)
     palette = Paleta::Palette.new(c1, c2)
@@ -98,7 +123,6 @@ describe Paleta::Palette do
     p4 = Paleta::Palette.new(c5, c6)
     p3.similarity(p4).should == 0
     
-    
     c7 = Paleta::Color.new(13, 57, 182)
     c8 = Paleta::Color.new(237, 172, 33)
     p5 = Paleta::Palette.new(c7, c8)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paleta
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-06 00:00:00.000000000Z
+date: 2012-01-07 00:00:00.000000000Z
 dependencies: []
 description: A gem for working with color palettes
 email:
@@ -23,7 +23,7 @@ files:
 - LICENSE
 - lib/paleta.rb
 - lib/paleta/color.rb
-- lib/paleta/multiple_regression.rb
+- lib/paleta/core_ext/math.rb
 - lib/paleta/palette.rb
 - lib/paleta/version.rb
 - paleta.gemspec

data/lib/paleta/multiple_regression.rb

@@ -1,39 +0,0 @@
-class MultipleRegression
-  attr_accessor :slope, :offset
-
-  def initialize dr, dg, db
-    
-    @size = dr.size
-    raise "arguments not same length!" unless @size == dg.size && @size == db.size
-    
-    if @size == 1
-      @slope = { :r => dr[0], :g => dg[0], :b => db[0] }
-      @offset = { :r => 0, :g => 0, :b => 0 }
-      return
-    end
-    
-    srr = sgg = sbb = srg = sbr = sgb = sr = sb = sg = 0
-    dr.zip(dg,db).each do |r,g,b|
-      srr += r ** 2
-      sgg += g ** 2
-      srg += r * g
-      sbr += b * r
-      sgb += g * b
-      sr  += r
-      sb  += g
-      sg  += b
-    end
-    
-    slope_rg = ( @size * srg - sr * sb ) / ( @size * srr - sr ** 2 ).to_f
-    slope_gb = ( @size * sgb - sb * sg ) / ( @size * sgg - sb ** 2 ).to_f
-    slope_br = ( @size * sgb - sb * sg ) / ( @size * sbb - sg ** 2 ).to_f
-    
-    offset_rg = (sb - slope_rg * sr) / @size
-    offset_gb = (sg - slope_gb * sb) / @size
-    offset_br = (sr - slope_br * sg) / @size
-    
-    @slope = { :r => slope_rg, :g => slope_gb, :b => slope_br }
-    @offset = { :r => offset_rg, :g => offset_gb, :b => offset_br }
-    return
-  end
-end