color_porter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: 494204b013a17898b7acc1e42d09c92483a4401afa6cf8b6c440f4473094173ad3a305e84a6c10cb4d13eb3200a37c322f5f584c03235437db71399a4dcfc59f
+  metadata.gz: b7c2c59a57d01723ee9f80977c242a2104650d095798e4636bb2680ecf371ae601f16b8c8db9e0766f77446820b67d01edf9fa0b4dea25f54ef73e197f3d205c
+SHA1: 
+  data.tar.gz: 51d835aa4618c46dc89caf0fdf3d4a731e789b36
+  metadata.gz: e5e9e44c269924d249bb1409a7b6ab853a1ad75a

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nathan Bertram
+
+MIT License
+
+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/README.md

@@ -0,0 +1,58 @@
+# ColorPorter
+
+The easy way to work with with RGB and Hex values in ruby. This code was written during the [48 hour Rails Rumble 13 contest](http://railsrumble.com/) and has been extracted from the code base of [our entry (elementcss.com)](http://railsrumble.com/entries/124-elementcss).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'color_porter'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Parse a string and color porter will return an RGB or Hex object if a match is found
+
+```ruby
+ColorPorter.parse('#ccc') # => #<ColorPorter::Hex @code="cccccc">
+ColorPorter.parse('rgb(204,204,204)') #  => #<ColorPorter::RGB @blue=204, @green=204, @red=204>
+```
+
+Do conversions between RGB and Hex
+
+```ruby
+hex = ColorPorter::Hex.new('cccccc')
+rgb = hex.to_rgb # =>  #<ColorPorter::RGB @blue=204, @green=204, @red=204>
+rgb.to_s # => "rgb(204,204,204)"
+
+hex = rgb.to_hex # => #<ColorPorter::Hex @code="cccccc">
+hex.to_s # => "#cccccc"
+```
+
+Grab the luminosity (brightness) of a RGB or Hex value.
+
+```ruby
+hex = ColorPorter::Hex.new('cccccc')
+hex.luminosity # => 13421772
+
+rgb = ColorPorter::RGB.new(204,204,204)
+rgb.luminosity # => 13421772
+```
+
+## Author
+[Nathan Bertram](https://github.com/nathanbertram)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Ensure tests are passing with `rspec`
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+7. You da man!

data/color_porter.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/color_porter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Bertram"]
+  gem.email         = ["nbertram@gmail.com"]
+  gem.description   = %q{Color Porter does the heavy lifting when working Hex & RGB in Ruby}
+  gem.summary       = %q{Work directly with Hex & RGB objects in Ruby}
+  gem.homepage      = "http://github.com/nathanbertram/color_porter"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "color_porter"
+  gem.require_paths = ["lib"]
+  gem.version       = ColorPorter::VERSION
+  gem.license       = 'MIT'
+
+  gem.add_development_dependency('rspec')
+end

data/lib/color_porter/hex.rb

@@ -0,0 +1,45 @@
+module ColorPorter
+  class Hex
+    attr_accessor :code
+
+    def initialize(code='')
+      code = code.to_s.gsub('#', '')
+      @code = (code.length == 3 ? code*2 : code).gsub!(/[\W_]*/, '')
+      @code = nil unless valid?
+    end
+
+    def valid?
+      @code.nil? ? false : @code.size == 6
+    end
+
+    def luminosity
+      @code.hex
+    end
+
+    def to_s
+      "##{@code.to_s}"
+    end
+
+    def to_hex
+      return self
+    end
+
+    def to_rgb
+      hex_str_rev = @code.each_char.to_a.reverse.join
+      if hex_str_rev.size == 3
+        hex_str_rev = hex_str_rev[0] + hex_str_rev[0] + hex_str_rev[1] + hex_str_rev[1] + hex_str_rev[2] + hex_str_rev[2]
+      elsif hex_str_rev.size != 6
+        return nil
+      end
+
+      hex = hex_str_rev.to_s.hex
+      rgb = {}
+      %w(r g b).inject(hex) {|a,i| rest, rgb[i] = a.divmod 256; rest}
+      red = rgb["r"].to_s
+      green = rgb["g"].to_s
+      blue = rgb["b"].to_s
+
+      RGB.new(red, green, blue)
+    end
+  end
+end

data/lib/color_porter/rgb.rb

@@ -0,0 +1,46 @@
+module ColorPorter
+  class RGB
+    attr_accessor :red, :green, :blue
+
+    def initialize(red, green, blue)
+      @red, @green, @blue = red.to_i, green.to_i, blue.to_i
+      @red = 0 unless (0..255).include?(@red)
+      @green = 0 unless (0..255).include?(@green)
+      @blue = 0 unless (0..255).include?(@blue)
+    end
+
+    def valid?
+      (0..255).include?(@red) && (0..255).include?(@green) && (0..255).include?(@blue)
+    end
+
+    def luminosity
+      to_hex.luminosity
+    end
+
+    def to_s
+      "rgb(#{@red},#{@green},#{@blue})"
+    end
+
+    def to_rgb
+      return self
+    end
+
+    def to_hex
+      r, g, b = @red.to_s(16), @green.to_s(16), @blue.to_s(16)
+
+      if r.size < 2
+        r = "0" + r
+      end
+
+      if g.size < 2
+        g = "0" + g
+      end
+
+      if b.size < 2
+        b = "0" + b
+      end
+
+      return Hex.new("##{r}#{g}#{b}")      
+    end
+  end
+end

data/lib/color_porter/version.rb

@@ -0,0 +1,3 @@
+module ColorPorter
+  VERSION = "0.0.1"
+end

data/lib/color_porter.rb

@@ -0,0 +1,22 @@
+require "color_porter/version"
+
+module ColorPorter
+  CSS_RGB_REGEX = /rgb\((?<r>\d{1,3}),(?<g>\d{1,3}),(?<b>\d{1,3})\)/
+  CSS_HEX_REGEX = /([a-f]|[A-F]|[0-9]){3}(([a-f]|[A-F]|[0-9]){3})?\b/
+
+  def self.parse(color_string)
+    # Consider Implementing: parsing values that come in as red, green, blue, pink and convert to Hex value
+    #                 as browsers parse them.
+
+    if color_string =~ CSS_RGB_REGEX
+      rgb_data = color_string.match(CSS_RGB_REGEX)
+      RGB.new(rgb_data[:r], rgb_data[:g], rgb_data[:b])
+    elsif color_string =~ CSS_HEX_REGEX
+      Hex.new(color_string)
+    else
+      return nil
+    end
+  end
+
+
+end

data/spec/color_porter_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+
+describe ColorPorter do
+
+  describe "parse" do
+    it "should be able to parse out hex values" do
+      ColorPorter.parse('#cdcdcd').class.should == ColorPorter::Hex
+      ColorPorter.parse('#cdcdcd').to_s.should == '#cdcdcd'
+
+      ColorPorter.parse('cccccc').class.should == ColorPorter::Hex
+      ColorPorter.parse('cccccc').to_s.should == '#cccccc'
+
+      ColorPorter.parse('ccc').class.should == ColorPorter::Hex
+      ColorPorter.parse('ccc').to_s.should == '#cccccc'
+    end
+
+    it "should be able to parse out rgb values" do
+      ColorPorter.parse("rgb(5,5,5)").class.should == ColorPorter::RGB
+      ColorPorter.parse("rgb(5,5,5)").to_s.should == "rgb(5,5,5)"
+
+      ColorPorter.parse("rgb(55,55,55)").class.should == ColorPorter::RGB
+      ColorPorter.parse("rgb(55,55,55)").to_s.should == "rgb(55,55,55)"
+
+      ColorPorter.parse("rgb(120,121,123)").class.should == ColorPorter::RGB
+      ColorPorter.parse("rgb(120,121,123)").to_s.should == "rgb(120,121,123)"
+    end
+
+    it "should return nil if no match is found" do
+      ColorPorter.parse("#internet").should == nil
+    end
+  end
+
+  describe ColorPorter::Hex do
+    describe "initialize" do
+      it "it should initialize with a valid hex value" do
+        ColorPorter::Hex.new('ccc').to_s.should == '#cccccc'
+        ColorPorter::Hex.new('cccccc').to_s.should == '#cccccc'
+        ColorPorter::Hex.new('#cccccc').to_s.should == '#cccccc'
+      end
+    end
+
+    describe "valid?" do
+      it "should return true/false if valid" do
+        ColorPorter::Hex.new('#cccccc').valid?.should == true
+        ColorPorter::Hex.new('not valid').valid?.should == false
+      end
+    end
+
+    describe "luminosity" do
+      it "should return the value for luminosity" do
+        ColorPorter::Hex.new('#cccccc').luminosity.should == 13421772
+      end
+    end
+
+    describe "to_s" do
+      it "should return a string value" do
+        ColorPorter::Hex.new('#cccccc').to_s.should == '#cccccc'
+      end
+    end
+
+    describe "to_rgb" do
+      it "should convert to an RGB value" do
+        rgb = ColorPorter::Hex.new('#cccccc').to_rgb
+        rgb.class.should == ColorPorter::RGB
+        rgb.to_s.should == "rgb(204,204,204)"
+      end
+    end
+  end
+
+
+  describe ColorPorter::RGB do
+    describe "initialize" do
+      it "it should initialize with a valid rgb value" do
+        ColorPorter::RGB.new(100,100,100).to_s.should == "rgb(100,100,100)"
+      end
+    end
+
+    describe "valid?" do
+      it "should parse a hex string" do
+        ColorPorter::RGB.new(120,120,121).valid?.should == true
+      end
+    end
+
+    describe "luminosity" do
+      it "should return the luminosity" do
+        ColorPorter::RGB.new(120,120,121).luminosity.should == 7895161
+      end
+    end
+
+    describe "to_s" do
+      it "should return a string rgb" do
+        ColorPorter::RGB.new(120,120,121).to_s.should == "rgb(120,120,121)"
+      end
+    end
+
+    describe "to_hex" do
+      it "should return a hex value" do
+        ColorPorter::RGB.new(120,120,121).to_hex.class.should == ColorPorter::Hex
+        ColorPorter::RGB.new(120,120,121).to_hex.to_s.should == "#787879"
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../../lib/color_porter', __FILE__)
+require File.expand_path('../../lib/color_porter/hex', __FILE__)
+require File.expand_path('../../lib/color_porter/rgb', __FILE__)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: color_porter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathan Bertram
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Color Porter does the heavy lifting when working Hex & RGB in Ruby
+email: 
+- nbertram@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rspec
+- LICENSE
+- README.md
+- color_porter.gemspec
+- lib/.DS_Store
+- lib/color_porter.rb
+- lib/color_porter/hex.rb
+- lib/color_porter/rgb.rb
+- lib/color_porter/version.rb
+- spec/color_porter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nathanbertram/color_porter
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Work directly with Hex & RGB objects in Ruby
+test_files: 
+- spec/color_porter_spec.rb
+- spec/spec_helper.rb