paleta 0.0.1 → 0.0.2

data/.gitignore

@@ -1,4 +1,7 @@
 .DS_Store
 .rspec
 Gemfile.lock
-Guardfile
+Guardfile
+*.gem
+.bundle
+tmp

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jordan Stephens <http://jordanstephens.net>
+
+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/lib/paleta.rb

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

data/lib/paleta/color.rb

@@ -1,7 +1,8 @@
 module Paleta
   class Color
+    include Math
     
-    attr_reader :red, :green, :blue, :hue, :saturation, :lightness
+    attr_reader :red, :green, :blue, :hue, :saturation, :lightness, :hex
     
     def initialize(red = 0, green = 0, blue = 0)
       self.red = red
@@ -12,31 +13,77 @@ module Paleta
     def red=(val)
       @red = range_validator(val, 0..255)
       update_hsl
+      update_hex
     end
     
     def green=(val)
       @green = range_validator(val, 0..255)
       update_hsl
+      update_hex
     end
     
     def blue=(val)
       @blue = range_validator(val, 0..255)
       update_hsl
+      update_hex
     end
     
     def lightness=(val)
       @lightness = range_validator(val, 0..100)
       update_rgb
+      update_hex
     end
     
     def saturation=(val)
       @saturation = range_validator(val, 0..100)
       update_rgb
+      update_hex
     end
     
     def hue=(val)
       @hue = range_validator(val, 0..360)
       update_rgb
+      update_hex
+    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")
+        raise(ArgumentError, "Invalid Hex String")
+      end
+      @hex = val.upcase
+      @red = val[0..1].hex
+      @green = val[2..3].hex
+      @blue = val[4..5].hex
+      update_hsl
+    end
+    
+    def lighten!(percent = 5)
+      @lightness += percent
+      @lightness = 100 if @lightness > 100
+      update_rgb
+      update_hex
+    end
+    
+    def darken!(percent = 5)
+      @lightness -= percent
+      @lightness = 0 if @lightness < 0
+      update_rgb
+      update_hex
+    end
+    
+    def invert!
+      @red = 255 - @red
+      @green = 255 - @green
+      @blue = 255 - @blue
+      update_hsl
+      update_hex
+    end
+    
+    def similarity(color)
+      sqrt(((@red - color.red) ** 2) + ((@green - color.green) ** 2) + ((@blue - color.blue) ** 2)) / sqrt(3 * (255 ** 2))
     end
     
     private
@@ -50,22 +97,21 @@ module Paleta
       max = [r, g, b].max
       delta = max - min
       
-      @hue = 0
-      @saturation = 0
-      @lightness = (max + min) / 2.0
+      h = s = 0
+      l = (max + min) / 2.0
       
       if delta != 0
-        @saturation = (@lightness < 0.5) ? delta / (max + min) : delta / (2.0 - max - min)
+        s = (l < 0.5) ? delta / (max + min) : delta / (2.0 - max - min)
         case max
-        when r; @hue = (g - b) / delta
-        when g; @hue = 2 + (b - r) / delta
-        when b; @hue = 4 + (r - g) / delta
+        when r; h = (g - b) / delta
+        when g; h = 2 + (b - r) / delta
+        when b; h = 4 + (r - g) / delta
         end
       end
-      @hue *= 60
+      @hue = h * 60
       @hue += 360 if @hue < 0
-      @saturation *= 100
-      @lightness *= 100
+      @saturation = s * 100
+      @lightness = l * 100
     end
     
     def update_rgb
@@ -75,32 +121,34 @@ module Paleta
       l = @lightness / 100.0
       
       if s == 0
-        r = l * 255
-        g = l * 255
-        b = l * 255
+        r = g = b = l * 255
       else
-        th = h / 6.0
-        if l < 0.5
-          t2 = l * (s + 1)
-        else
-          t2 = (l + s) - (l * s)
-        end
+        h /= 6.0
+        t2 = l < 0.5 ? l * (s + 1) : (l + s) - (l * s)
         t1 = 2 * l - t2
         
-        tr = th + (1.0 / 3.0)
-        tg = th
-        tb = th - (1.0 / 3.0)
+        r = h + (1.0 / 3.0)
+        g = h
+        b = h - (1.0 / 3.0)
         
-        tr = hue_calc(tr, t1, t2)
-        tg = hue_calc(tg, t1, t2)
-        tb = hue_calc(tb, t1, t2)
+        r = hue_calc(r, t1, t2)
+        g = hue_calc(g, t1, t2)
+        b = hue_calc(b, t1, t2)
         
-        @red = tr * 255.0
-        @green = tg * 255.0
-        @blue = tb * 255.0
+        @red = r * 255.0
+        @green = g * 255.0
+        @blue = b * 255.0
       end
     end
     
+    def update_hex
+      r = @red.to_s(16) rescue "00"
+      g = @green.to_s(16) rescue "00"
+      b = @blue.to_s(16) rescue "00"
+      [r, g, b].each { |c| c = "0#{c}" if c.length < 2 }      
+      @hex = "#{r}#{g}#{b}".upcase
+    end
+    
     def hue_calc(value, t1, t2)
       value += 1 if value < 0
       value -= 1 if value > 1

data/lib/paleta/multiple_regression.rb

@@ -0,0 +1,39 @@
+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

data/lib/paleta/palette.rb

@@ -1,5 +1,6 @@
 module Paleta
   class Palette
+    include Math
     
     attr_accessor :colors
     
@@ -18,8 +19,62 @@ module Paleta
       @colors[i]
     end
     
+    def size
+      @colors.size
+    end
+    
     def include?(color)
       @colors.include?(color)
     end
+    
+    def lighten!(percent = 5)
+      @colors.each do |color|
+        color.lighten!(percent)
+      end
+    end
+    
+    def darken!(percent = 5)
+      @colors.each do |color|
+        color.darken!(percent)
+      end
+    end
+    
+    def invert!
+      @colors.each do |color|
+        color.invert!
+      end
+    end
+    
+    def similarity(palette)
+      r1 = self.fit
+      r2 = palette.fit
+      
+      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))
+      
+      d1 + d2
+    end
+        
+    def fit
+      # create a 3xn matrix where n = @colors.size to represent the set of colors
+      reds = @colors.map { |c| c.red }
+      greens = @colors.map { |c| c.green }
+      blues = @colors.map { |c| c.blue }
+      MultipleRegression.new(reds, greens, blues)
+    end
   end
 end

data/lib/paleta/version.rb

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

data/paleta.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/paleta/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ['Jordan Stephens']
   gem.email         = ['iam@jordanstephens.net']
-  gem.description   = 'color palette gem'
-  gem.summary       = 'color palette gem'
+  gem.description   = 'A gem for working with color palettes'
+  gem.summary       = 'A little library for creating, manipulating and comparing colors and color palettes'
   gem.homepage      = 'http://jordanstephens.net'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/readme.markdown

@@ -0,0 +1,86 @@
+# Paleta
+
+A gem for working with color palettes
+
+## Installation
+
+To install, run
+
+    $ gem install paleta
+	
+Or, add this to your application's Gemfile
+
+``` ruby
+gem 'paleta'
+```
+
+and run
+
+    $ bundle
+	
+## Usage
+
+### Color
+
+    # create a color with RGB components
+	color = Paleta::Color.new(94, 161, 235)
+	
+	# access component values
+	color.red # => 94
+	color.green # => 161
+	color.blue # => 235
+	
+	# HSL components are maintained too!
+	color.hue # => 211.48936170212767
+	color.saturation # => 77.90055248618782
+	color.lightness # => 64.50980392156862
+	
+	# a HEX value is also maintained for each Color
+	color.hex # => "5EA1EB"
+	
+	# lighten by a percentage
+	color.lighten!(10) 
+	
+	# darken by a percentage
+	color.darken!(10) 
+	
+	# invert a color
+	color.invert!
+	
+	# calculate similarity between Colors
+	# Color#similarity calculates the similarity between two colors and returns a
+	# value in 0..1, with 0 being identical and 1 being as dissimilar as possible
+	color2 = Paleta::Color.new(237, 172, 33)
+	color.similarity(color2) # => 0.5609077061558945
+	
+### Palette
+
+	# 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)
+
+	# retreive a Color from a Palette
+	palette[1] # => color2
+	
+	# lighten and darken an entire Palette by a percentage
+	palette.lighten!(15)
+	palette.darken!(20)
+
+	# invert each color in a Palette
+	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)
+    
+    color3 = Paleta::Color.new(13, 57, 182)
+    color4 = Paleta::Color.new(94, 161, 235)
+    palette2 = Paleta::Palette.new(color3, color4)
+	
+    palette1.similarity(palette2) # => 0.0046992695975874915
+	
+See the [documentation](http://rubydoc.info/gems/paleta/ "Documentation").
+
+ 

data/spec/models/color_spec.rb

@@ -56,4 +56,74 @@ describe Paleta::Color do
     color.green.to_i.should == 195
     color.blue.to_i.should == 178
   end
+  
+  it "should lighten by a percentage, " do
+    color = Paleta::Color.new(94, 161, 235)
+    lightness = color.lightness
+    color.lighten!
+    color.lightness.should == lightness + 5
+    lightness = color.lightness
+    color.lighten!(20)
+    color.lightness.should == lightness + 20
+  end
+  
+  it "should quietly maintain a maximum of 100 when lightening" do
+    color = Paleta::Color.new(94, 161, 235)
+    color.lighten!(300)
+    color.lightness.should == 100
+  end
+  
+  it "should darken by a percentage" do
+    color = Paleta::Color.new(94, 161, 235)
+    lightness = color.lightness
+    color.darken!
+    color.lightness.should == lightness - 5
+    lightness = color.lightness
+    color.darken!(20)
+    color.lightness.should == lightness - 20
+  end
+  
+  it "should quietly maintain a minimum of 0 when darkening" do
+    color = Paleta::Color.new(94, 161, 235)
+    color.darken!(300)
+    color.lightness.should == 0
+  end
+  
+  it "should invert" do
+    color = Paleta::Color.new(94, 161, 235)
+    color.invert!
+    color.red.should == 161
+    color.green.should == 94
+    color.blue.should == 20
+  end
+  
+  it "should calculate its similarity to another Color" do
+    color1 = Paleta::Color.new(94, 161, 235)
+    color2 = Paleta::Color.new(237, 172, 33)
+    color1.similarity(color2).round(5).should == 0.56091
+    
+    color1 = Paleta::Color.new(237, 172, 33)
+    color2 = Paleta::Color.new(237, 172, 33)
+    color1.similarity(color2).should == 0
+        
+    color1 = Paleta::Color.new(0, 0, 0)
+    color2 = Paleta::Color.new(255, 255, 255)
+    color1.similarity(color2).should == 1
+  end
+  
+  it "should maintain its HEX value" do
+    color = Paleta::Color.new(94, 161, 235)
+    color.hex.should == "5EA1EB"
+  end
+  
+  it "should update its HSB and RGB components when its HEX value is updated" do
+    color = Paleta::Color.new
+    color.hex = "ffffff"
+    color.red.should == 255
+    color.green.should == 255
+    color.blue.should == 255
+    color.hue.should == 0
+    color.saturation.should == 0
+    color.lightness.should == 100
+  end
 end

data/spec/models/palette_spec.rb

@@ -28,4 +28,84 @@ describe Paleta::Palette do
     palette[0].should == c1
     palette[1].should be_nil
   end
+  
+  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)
+    lightness1 = c1.lightness
+    lightness2 = c2.lightness
+    percent = 20
+    palette.lighten!(percent)
+    palette[0].lightness.should == lightness1 + percent
+    palette[1].lightness.should == lightness2 + percent
+  end
+  
+  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)
+    lightness1 = c1.lightness
+    lightness2 = c2.lightness
+    percent = 20
+    palette.darken!(percent)
+    palette[0].lightness.should == lightness1 - percent
+    palette[1].lightness.should == lightness2 - percent
+  end
+  
+  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)
+    palette.invert!
+    palette[0].red.should == 242
+    palette[0].green.should == 198
+    palette[0].blue.should == 73
+    palette[1].red.should == 161
+    palette[1].green.should == 94
+    palette[1].blue.should == 20
+  end
+  
+  it "should calculate a multiple regression over each Color in the Palette in RGB space" do
+    c1 = Paleta::Color.new(13, 57, 182)
+    c2 = Paleta::Color.new(94, 161, 235)
+    c3 = Paleta::Color.new(237, 172, 33)
+    palette = Paleta::Palette.new(c1, c2, c3)
+    r = palette.fit
+    r.slope[:r].should == 0.4632575855725132
+    r.slope[:g].should == -0.5730072013906133
+    r.slope[:b].should == 0.06837037037037037
+    r.offset[:r].should == 76.87979685435182
+    r.offset[:g].should == 224.49093618077973
+    r.offset[:b].should == 104.41111111111111
+  end
+  
+  it "should calculate its similarity to another Palette" do
+    c1 = Paleta::Color.new(0, 0, 0)
+    p1 = Paleta::Palette.new(c1)
+    
+    c2 = Paleta::Color.new(255, 255, 255)
+    p2 = Paleta::Palette.new(c2)
+    
+    p1.similarity(p2).should == 1
+    
+    c3 = Paleta::Color.new(0, 0, 0)
+    c4 = Paleta::Color.new(255, 255, 255)
+    p3 = Paleta::Palette.new(c3, c4)
+    
+    c5 = Paleta::Color.new(0, 0, 0)
+    c6 = Paleta::Color.new(255, 255, 255)
+    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)
+    
+    c9 = Paleta::Color.new(13, 57, 182)
+    c10 = Paleta::Color.new(94, 161, 235)
+    p6 = Paleta::Palette.new(c9, c10)
+    p5.similarity(p6).round(5).should == 0.0047
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paleta
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-01-06 00:00:00.000000000Z
 dependencies: []
-description: color palette gem
+description: A gem for working with color palettes
 email:
 - iam@jordanstephens.net
 executables: []
@@ -20,11 +20,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - lib/paleta.rb
 - lib/paleta/color.rb
+- lib/paleta/multiple_regression.rb
 - lib/paleta/palette.rb
 - lib/paleta/version.rb
 - paleta.gemspec
+- readme.markdown
 - spec/models/color_spec.rb
 - spec/models/palette_spec.rb
 - spec/spec_helper.rb
@@ -51,7 +54,8 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: color palette gem
+summary: A little library for creating, manipulating and comparing colors and color
+  palettes
 test_files:
 - spec/models/color_spec.rb
 - spec/models/palette_spec.rb