coloral 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b96706199aa28753694c93f42a60c94f19f297
-  data.tar.gz: 18957b1ed36776e69c7efb906e583390ecaadccf
+  metadata.gz: c6ef43a625d7e426d32a9235d87ddc1e45816478
+  data.tar.gz: f3760d2634cf7a1ab454a21231b4a3810d377d90
 SHA512:
-  metadata.gz: 729c0d73b8f2f46d26533bfeb76621e58f46d4deecb57cfe5c8c73c37ec15d39b8495148b1324af579477d19376091836e7f9e03905cd51fc3a3ee2402ec7557
-  data.tar.gz: ce7f34f2cbcc98ad0dcf7e138dfa23067752087617ad3244e931894fcf5002f43e62150fab4baf9b1c1454acfa262f296e38b1fb2885eb092ad0b0af973caecf
+  metadata.gz: 0e57a6b3ba50c351398c54b312ab80776aa1da56367bc5393394b01a43775c0d7cc9c42cba6c3589cd8eb3c0830d0f7ecd6484968e8e401fa444bf3b7f8133fa
+  data.tar.gz: 787ba952d7fde0b540a9bd846b61d02cf2e2d2f4d4edc2c7de15ce5fca5c3f8c2535d8188e994e550160e463c5aa8e5fdc0c66858be69138050ec63be24d6d4d

data/.travis.yml

@@ -1 +1,3 @@
 language: ruby
+rvm:
+  - 2.0.0

data/Guardfile

@@ -7,10 +7,10 @@
 #  * bundler binstubs: 'bin/rspec'
 #  * spring: 'bin/rsspec' (This will use spring if running and you have
 #                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * zeus: 'zeus rspec' (requires the server to be started separatly)
 #  * 'just' rspec: 'rspec'
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.md

@@ -1,4 +1,5 @@
 # Coloral
+[![Gem Version](https://badge.fury.io/rb/coloral.svg)](http://badge.fury.io/rb/coloral)
 [![Build Status](https://travis-ci.org/pducks32/coloral.svg?branch=master)](https://travis-ci.org/pducks32/coloral)
 [![Code Climate](https://codeclimate.com/github/pducks32/coloral/badges/gpa.svg)](https://codeclimate.com/github/pducks32/coloral)
 [![Test Coverage](https://codeclimate.com/github/pducks32/coloral/badges/coverage.svg)](https://codeclimate.com/github/pducks32/coloral)
@@ -22,12 +23,27 @@ Or install it yourself as:
     $ gem install coloral
 
 ## Usage
+Below is the basic API for using `Coloral` with RGB and all other plugins follow a identical format substituting `rgb`. In addition to RGB `Coloral` also supports
 
-TODO: Write usage instructions here
+* RGB
+* HSL
+* Hex
+* HSB/HSV
+* *and many more comming soon*
+
+```ruby
+require 'coloral'
+Coloral.from_rgb 250, 75, 119 # Also supports array
+Coloral.from_rgb red: 250, green: 75, blue: 119 # Also supports hash input
+my_color = Coloral.from_rgb 250, 75, 119 #=> #<Coloral::Color @hue=345, @saturation=95, @lightness=64>
+my_color.to_hex #=> "#F94A77"
+my_color.to_css_rgb #=> "rgb(250, 75, 119)"s
+
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/coloral/fork )
+1. Fork it ( https://github.com/pducks/coloral/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`)

data/coloral.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.0'
+  
   spec.add_development_dependency "bundler", ">= 1.6.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/coloral.rb

@@ -1,15 +1,20 @@
 require "coloral/version"
 
 module Coloral
-  def self.from_hex(hex_string)
-    Color.from_hex(hex_string)
-  end
-
-  class Color
-    def initialize; end
+  autoload :Model, "coloral/model"
+  autoload :RGBModel, "coloral/models/rgb_model"
+  autoload :Color, "coloral/color"
 
-    def self.from_hex(hex_string)
-      Color.new
+  def self.method_missing(meth, *args, &block)
+    if meth.to_s.start_with?("from", "for") && Color.respond_to?(meth)
+      Color.public_send(meth, *args)
+    else
+      super
     end
   end
+
+  def respond_to_missing?(meth, include_private = false)
+    meth.to_s.start_with?("from", "for") && Color.respond_to?(meth) || super
+  end
+
 end

data/lib/coloral/color.rb

@@ -0,0 +1,21 @@
+class Coloral::Color
+
+  include Coloral::RGBModel
+
+  attr_reader :hue, :saturation, :lightness
+
+  def initialize(hue, saturation, lightness)
+    @hue, @saturation, @lightness = hue, saturation, lightness
+  end
+
+  def self.from_hex(hex_string)
+    new *hex_string.scan(/([0-9a-fA-F]{2})/).flatten
+  end
+
+
+  def self.from_hsl(a_hue = nil, a_saturation = nil, a_lightness = nil, h: a_hue, s: a_saturation, l: a_lightness, hue: h, saturation: s, lightness: l)
+    raise ArgumentError if [hue, saturation, lightness].any?(&:nil?)
+    new hue, saturation, lightness
+  end
+
+end

data/lib/coloral/model.rb

@@ -0,0 +1,8 @@
+
+module Coloral::Model
+
+  def included(base)
+    base.extend self::ConstructorMethod
+  end
+
+end

data/lib/coloral/models/rgb_model.rb

@@ -0,0 +1,41 @@
+module Coloral
+  module RGBModel
+    extend Coloral::Model
+
+    module ConstructorMethod
+      def from_rgb(a_red = nil, a_green = nil, a_blue = nil, r: a_red, g: a_green, b: a_blue, red: r, green: g, blue: b)
+        raise ArgumentError if [red, blue, green].any?(&:nil?)
+        red /= 255
+        green /= 255
+        blue /= 255
+        min, max = [red, blue, green].minmax
+        delta = (max - min).to_f
+        lum   = (max + min) / 2.0
+
+        if delta.zero? # close to 0.0, so it's a grey
+          hue = 0
+          sat = 0
+        else
+          if lum <= 0.5
+            sat = delta / (max + min).to_f
+          else
+            sat = delta / (2 - max - min).to_f
+          end
+          sixth = 1 / 6.0
+          if red == max # Color.near_zero_or_less?(@r - max)
+            hue = (sixth * ((green - blue) / delta))
+            hue += 1.0 if green < blue
+          elsif green == max # Color.near_zero_or_less(@g - max)
+            hue = (sixth * ((blue - red) / delta)) + (1.0 / 3.0)
+          elsif blue == max # Color.near_zero_or_less?(@b - max)
+            hue = (sixth * ((red - green) / delta)) + (2.0 / 3.0)
+          end
+
+          hue += 1 if hue < 0
+          hue -= 1 if hue > 1
+        end
+        new(hue, sat, lum)
+      end
+    end
+  end
+end

data/lib/coloral/version.rb

@@ -1,3 +1,3 @@
 module Coloral
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/color_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+module Coloral
+  describe Color do
+    
+    it "has hsl attributes" do
+      attributes = { hue: 220, saturation: 60, lightness: 55 }
+      expect(Color.from_hsl(attributes)).to have_attributes attributes
+    end
+
+    describe "::from_hex" do
+      context "with no parameters" do
+        it "raises ArgumentError" do
+          expect{ Color.from_hex() }.to raise_error ArgumentError
+        end
+      end
+      context "when # is in front" do
+        it "returns a color" do
+          expect(Color.from_hex("#00FF00")).to be_a Color
+        end
+      end
+      context "when # is not in front" do
+        it "returns a color" do
+          expect(Color.from_hex("00FF00")).to be_a Color
+        end
+      end
+    end
+
+    describe "::from_hsl" do
+      context "with no parameters" do
+        it "raises ArgumentError" do
+          expect{ Color.from_hsl() }.to raise_error ArgumentError
+        end
+      end
+      context "with no special syntax" do
+        it "returns a color" do
+          expect(Color.from_hsl(175, 50, 85)).to be_a Color
+        end
+      end
+      context "with hsl hash" do
+        it "returns a color" do
+          hash = { h: 175, s: 50, l: 85 }
+          expect(Color.from_hsl(hash)).to be_a Color
+        end
+      end
+      context "with hue saturation lightness hash" do
+        it "returns a color" do
+          hash = { hue: 175, saturation: 50, lightness: 85 }
+          expect(Color.from_hsl(hash)).to be_a Color
+        end
+      end
+    end
+
+    describe "::from_rgb" do
+      context "with no parameters" do
+        it "raises ArgumentError" do
+          expect{ Color.from_hsl() }.to raise_error ArgumentError
+        end
+      end
+      context "with no special syntax" do
+        it "returns a color" do
+          expect(Color.from_rgb(200, 180, 90)).to be_a Color
+        end
+      end
+      context "with hsl hash" do
+        it "returns a color" do
+          hash = { r: 200, g: 180, b: 90 }
+          expect(Color.from_rgb(hash)).to be_a Color
+        end
+      end
+      context "with hue saturation lightness hash" do
+        it "returns a color" do
+          hash = { red: 200, green: 180, blue: 90 }
+          expect(Color.from_rgb(hash)).to be_a Color
+        end
+      end
+    end
+  end
+end

data/spec/coloral_spec.rb

@@ -2,9 +2,11 @@ require "spec_helper"
 
 module Coloral
   describe Coloral do
-    describe "::from_hex" do
-      it "creates color using hex" do
-        expect(Coloral.from_hex("#00FF00")).to be_a Color
+
+    context "with 'from_*' or 'for_*' method" do
+      it "delegates to Color" do
+        expect(Color).to receive(:from_hex)
+        Coloral.from_hex("#00FF00")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coloral
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Patrick Metcalfe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,11 @@ files:
 - Rakefile
 - coloral.gemspec
 - lib/coloral.rb
+- lib/coloral/color.rb
+- lib/coloral/model.rb
+- lib/coloral/models/rgb_model.rb
 - lib/coloral/version.rb
+- spec/color_spec.rb
 - spec/coloral_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -84,9 +88,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -100,6 +104,7 @@ specification_version: 4
 summary: The best way to create, convert, or manipulate colors in Ruby using helpful
   color functions.
 test_files:
+- spec/color_spec.rb
 - spec/coloral_spec.rb
 - spec/spec_helper.rb
 has_rdoc: