colour 0.3 → 0.4.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rspec", "~> 2.6"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.6)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Wes Devauld
+
+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/Rakefile

@@ -1,18 +1,40 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
+# encoding: utf-8
 
-load 'tasks/setup.rb'
+require 'rubygems'
+require 'bundler'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'rake'
+require 'jeweler'
 
-ensure_in_path 'lib'
-require 'colour'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 
-task :default => 'spec:run'
+Jeweler::Tasks.new do |gem|
+  gem.name = "colour"
+  gem.homepage = "http://github.com/wdevauld/colour"
+  gem.license = "MIT"
+  gem.summary = %Q{Colour manipulation library supporting RGB and HSV representations}
+  gem.description = %Q{Support for computation of colour swatches in both the RGB and HSV colour representations}
+  gem.email = "wes@devauld.ca"
+  gem.authors = ["Wes Devauld"]
+end
+Jeweler::RubygemsDotOrgTasks.new
 
-PROJ.name = 'colour'
-PROJ.authors = 'Wes Devauld'
-PROJ.email = 'wes@devauld.ca' 
-PROJ.url = 'http://code.devauld.ca/git/colour/'
-PROJ.rubyforge_name = 'colour'
-PROJ.version = '0.3'
-PROJ.exclude = %w(.git)
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end 
+
+desc "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude gems\/,spec\/} 
+  t.verbose = true
+end
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/colour.rb

@@ -1,165 +1,123 @@
-# $Id$
-
-# Equivalent to a header guard in C/C++
-# Used to prevent the class/module from being loaded more than once
-unless defined? Colour
-
+# Colour is intended to be a mixin for all representations of colour.  It is not intended
+# to be initialized on its own
 module Colour
-	def to_rgb
-		self	
-	end
+    def to_rgb
+        self    
+    end
 
-	def to_hsv
-		self
-	end
-	
-	def web_hex
-		self.to_rgb.web_hex
-	end
+    def to_hsv
+        self
+    end
+
+    def web_hex
+        self.to_rgb.web_hex
+    end
   
-	def hex
-		self.to_rgb.hex
-	end
+    def hex
+        self.to_rgb.hex
+    end
   
-	def web_safe(depth=1)
-		self.to_rgb.web_safe(depth)
-	end
-	
-	def to_s
-		self.to_rgb.web_hex
-	end
-
-	# Return the complementary colour	
-	def complementary
-		rotate_hue(180)
-	end
-	
-	# Return two colours spread distance apart opposite
-	# the colour wheel
-	def split_complementary(spread=60)
-		c = self.class.name.downcase
-		hsv = self.to_hsv
-		v = [HSV.new(((hsv.h + 540 - spread / 2) % 360),hsv.s,hsv.v).send("to_" + c), 
-		HSV.new(((hsv.h + 540 + spread / 2) % 360),hsv.s,hsv.v).send("to_" + c)]
-		if block_given? then
-			v.each do |color| yield color end
-		end
-		v  
-	end
+    def web_safe(depth=1)
+        self.to_rgb.web_safe(depth)
+    end
+
+    def to_s
+        self.to_rgb.web_hex
+    end
+
+    # Return the complementary colour   
+    def complementary
+        rotate_hue(180)[0]
+    end
+
+    # Return two colours spread distance apart opposite
+    # the colour wheel
+    def split_complementary(spread=60)
+        c = self.class.name.downcase
+        hsv = self.to_hsv
+        v = [HSV.new(((hsv.h + 540 - spread / 2) % 360),hsv.s,hsv.v).send("to_" + c), 
+        HSV.new(((hsv.h + 540 + spread / 2) % 360),hsv.s,hsv.v).send("to_" + c)]
+        if block_given? then
+            v.each do |color| yield color end
+        end
+        v  
+    end
   
-	# Move the specified number of degrees, for the
-	# specified number of steps
-	def rotate_hue(degrees=180, steps=1)
-		c = self.class.name.downcase
-		hsv = self.to_hsv
-		v = []
-		(1..steps).each do |i|
-			v << HSV.new((hsv.h + (degrees * i) + 360 * i) % 360, hsv.s, hsv.v).send("to_" + c)
-		end
-		if block_given? then
-			v.each do |color| yield color end
-		end
-		v 
-	end
+    # Move the specified number of degrees, for the
+    # specified number of steps
+    def rotate_hue(degrees=180, steps=1)
+        c = self.class.name.downcase
+        hsv = self.to_hsv
+        v = []
+        (1..steps).each do |i|
+            v << HSV.new((hsv.h + (degrees * i) + 360 * i) % 360, hsv.s, hsv.v).send("to_" + c)
+        end
+        if block_given? then
+            v.each do |color| yield color end
+        end
+        v 
+    end
   
-	def analogous(degrees=30, steps=5, &block)
-		if block_given? then
-			rotate_hue(degrees, steps) do |c|
-				block.call(c)
-			end
-		else
-			rotate_hue(degrees, steps)
-		end
-	end
+    def analogous(degrees=30, steps=5, &block)
+        if block_given? then
+            rotate_hue(degrees, steps) do |c|
+                block.call(c)
+            end
+        else
+            rotate_hue(degrees, steps)
+        end
+    end
   
-	def triadic(&block)
-		if block_given? then
-			rotate_hue(120, 2) do |c|
-				block.call(c)
-			end
-		else
-			rotate_hue(120,2)
-		end
-	end
-
-
-	def gradient_to(colour, steps=10)
-		c = self.class.name.downcase
-		origin = self.to_rgb
-		destination = colour.to_rgb
-		gradient = []
-
-		#TODO: *_range isn't really being used
-		red_range = destination.r - origin.r
-		red_increment = red_range / steps
-		green_range = destination.g - origin.g
-		green_increment = green_range / steps
-		blue_range = destination.b - origin.b
-		blue_increment = blue_range / steps	
-
-		steps.times do |i|
-			intermediate = RGB.new(
-				origin.r + red_increment * i,
-				origin.g + green_increment * i,
-				origin.b + blue_increment * i
-			)
-			gradient << intermediate.send("to_" + c)
-			if block_given? then
-				yield intermediate.send("to_" + c)
-			end
-		end
-		gradient
-	end
-
-	#Bones specific stuff
-
-	# :stopdoc:
-	VERSION = '0.2.1'
-	LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-	PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-	# :startdoc:
-
-	# Returns the version string for the library.
-	#
-	def self.version
-		VERSION
-	end
-
-	# Returns the library path for the module. If any arguments are given,
-	# they will be joined to the end of the libray path using
-	# <tt>File.join</tt>.
-	#
-	def self.libpath( *args )
-		args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
-	end
-
-	# Returns the lpath for the module. If any arguments are given,
-	# they will be joined to the end of the path using
-	# <tt>File.join</tt>.
-	#
-	def self.path( *args )
-	  args.empty? ? PATH : ::File.join(PATH, *args)
-	end
-	
-	# Utility method used to rquire all files ending in .rb that lie in the
-	# directory below this file that has the same name as the filename passed
-	# in. Optionally, a specific _directory_ name can be passed in such that
-	# the _filename_ does not have to be equivalent to the directory.
-	#
-	def self.require_all_libs_relative_to( fname, dir = nil )
-	  dir ||= ::File.basename(fname, '.*')
-	  search_me = ::File.expand_path(
-	      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-	
-	  Dir.glob(search_me).sort.each {|rb| require rb}
-	end
-end  # module Colour
-
-Colour.require_all_libs_relative_to __FILE__
-require 'rgb'
-require 'standard_colours'
-require 'hsv'
-
-end  # unless defined?
-
-# EOF
+    def triadic(&block)
+        if block_given? then
+            rotate_hue(120, 2) do |c|
+                block.call(c)
+            end
+        else
+            rotate_hue(120,2)
+        end
+    end
+
+
+    def gradient_to(colour, steps=10)
+        c = self.class.name.downcase
+        origin = self.to_rgb
+        destination = colour.to_rgb
+        gradient = []
+
+        #Special Case, if some joker asks for a gradient of one step
+        # the range calculation will result in NaN
+        if steps == 1 then
+           if block_given? then
+             yield self
+           end
+           return [self] 
+        end
+
+        #TODO: *_range isn't really being used
+        red_range = destination.r - origin.r
+        red_increment = red_range / (steps - 1)
+        green_range = destination.g - origin.g
+        green_increment = green_range / (steps - 1)
+        blue_range = destination.b - origin.b
+        blue_increment = blue_range / (steps - 1) 
+
+        steps.times do |i|
+            intermediate = RGB.new(
+                origin.r + red_increment * i,
+                origin.g + green_increment * i,
+                origin.b + blue_increment * i
+            )
+            gradient << intermediate.send("to_" + c)
+            if block_given? then
+                yield intermediate.send("to_" + c)
+            end
+        end
+        gradient
+    end
+end 
+
+require_relative 'rgb'
+require_relative 'hsv'
+require_relative 'standard_colours'
+require_relative 'gradient'

data/lib/gradient.rb

@@ -0,0 +1,23 @@
+class Gradient 
+    def initialize(origin, destination)
+        @origin = origin
+        @destination = destination
+    end
+
+    def colour_at(distance_percent)
+        c = @origin.class.to_s.downcase
+
+        origin_rgb = @origin.to_rgb
+        destination_rgb = @destination.to_rgb
+
+        delta_r = destination_rgb.r - origin_rgb.r
+        delta_g = destination_rgb.g - origin_rgb.g
+        delta_b = destination_rgb.b - origin_rgb.b
+
+        approximation = RGB.new(delta_r * distance_percent + origin_rgb.r,
+                                delta_g * distance_percent + origin_rgb.g,
+                                delta_b * distance_percent + origin_rgb.b)
+        approximation.send("to_" + c)
+    end 
+
+end

data/lib/hsv.rb

@@ -22,15 +22,15 @@ class HSV
 			q = @v * (1 - @s * f)
 			t = @v * (1 - @s * (1 - f))
 			case i
-				when 0:
+				when 0 then
 					RGB.new(v,t,p)
-				when 1:
+				when 1 then
 					RGB.new(q,v,p)
-				when 2:
+				when 2 then
 					RGB.new(p,v,t)
-				when 3:
+				when 3 then
 					RGB.new(p,q,v)
-				when 4:
+				when 4 then
 					RGB.new(t,p,v)
 				else
 					RGB.new(v,p,q)