wcag_color_contrast 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wcag_color_contrast.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Dodwell
+
+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,43 @@
+# WCAGColorContrast
+
+A Ruby port of the Javascript https://github.com/doochik/wcag-color-contrast.
+
+Calculates the contrast ratio between 2 colors, for checking against the WCAG recommended contrast ratio for legibility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wcag_color_contrast'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install wcag_color_contrast
+```
+
+## Usage
+
+Pass 2 rgb colors are strings (3 or 6 characters, case insensitive):
+
+```ruby
+require 'wcag_color_contrast'
+WCAGColorContrast.new.ratio('999', 'ffffff')
+#=> 2.849027755287037
+```
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+end
+
+task :default => :test

data/lib/wcag_color_contrast.rb

@@ -0,0 +1,51 @@
+require "wcag_color_contrast/version"
+
+module WCAGColorContrast
+  class InvalidColorError < StandardError; end
+
+  # Helper method for WCAGColorContrast#new#ratio.
+  def self.ratio(*args)
+    Ratio.new.ratio(*args)
+  end
+
+  class Ratio
+    # Calculate contast ratio beetween RGB1 and RGB2.
+    def ratio(rgb1, rgb2)
+      raise InvalidColorError, rgb1 unless valid_rgb?(rgb1)
+      raise InvalidColorError, rgb2 unless valid_rgb?(rgb2)
+
+      srgb1 = rgb_to_srgba(rgb1)
+      srgb2 = rgb_to_srgba(rgb2)
+
+      l1 = srgb_lightness(srgb1)
+      l2 = srgb_lightness(srgb2)
+
+      l1 > l2 ? (l1 + 0.05) / (l2 + 0.05) : (l2 + 0.05) / (l1 + 0.05)
+    end
+
+    private
+
+    # Convert RGB color to sRGB.
+    def rgb_to_srgba(rgb)
+      rgb << rgb if rgb.size == 3
+      [
+        rgb.slice(0,2).to_i(16) / 255.0,
+        rgb.slice(2,2).to_i(16) / 255.0,
+        rgb.slice(4,2).to_i(16) / 255.0
+      ]
+    end
+
+    # Calculate lightness for sRGB color.
+    def srgb_lightness(srgb)
+      r, g, b = srgb
+      0.2126 * (r <= 0.03928 ? r / 12.92 : ((r + 0.055) / 1.055) ** 2.4) +
+      0.7152 * (g <= 0.03928 ? g / 12.92 : ((g + 0.055) / 1.055) ** 2.4) +
+      0.0722 * (b <= 0.03928 ? b / 12.92 : ((b + 0.055) / 1.055) ** 2.4)
+    end
+
+    # Validate RGB string.
+    def valid_rgb?(rgb)
+      rgb && (rgb.match(/^[a-f0-9]{3}$/i) || rgb.match(/^[a-f0-9]{6}$/i))
+    end
+  end
+end

data/lib/wcag_color_contrast/version.rb

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

data/test/test.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'wcag_color_contrast'
+
+class WCAGColorContrastTest < MiniTest::Unit::TestCase
+  def test_ratios
+    assert_in_delta 2.849, WCAGColorContrast.ratio('999', 'ffffff')
+    assert_in_delta 1.425, WCAGColorContrast.ratio('d8d8d8', 'fff')
+    assert_in_delta 1.956, WCAGColorContrast.ratio('eee', 'AAABBB')
+  end
+end

data/wcag_color_contrast.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wcag_color_contrast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wcag_color_contrast'
+  spec.version       = WCAGColorContrast::VERSION
+  spec.authors       = ['Mark Dodwell']
+  spec.email         = ['mark@mkdynamic.co.uk']
+  spec.summary       = 'Calculate the contrast ratio between 2 colors, for checking against the WCAG recommended contrast ratio for legibility.'
+  spec.homepage      = 'https://github.com/mkdynamic/wcag_color_contrast'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split($/)
+  spec.executables   = `git ls-files -- bin/*`.split($/).map &File.method(:basename)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: wcag_color_contrast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Dodwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mark@mkdynamic.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wcag_color_contrast.rb
+- lib/wcag_color_contrast/version.rb
+- test/test.rb
+- wcag_color_contrast.gemspec
+homepage: https://github.com/mkdynamic/wcag_color_contrast
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3364554805105049379
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3364554805105049379
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Calculate the contrast ratio between 2 colors, for checking against the WCAG
+  recommended contrast ratio for legibility.
+test_files:
+- test/test.rb