wcag_color_contrast 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 409a9a32d764aa58736e52425280daac433d59ef
+  data.tar.gz: edc08eb2b5ecc5c7cb6ec6a0ad9e9b13526939ab
+SHA512:
+  metadata.gz: 50481e57f9f92481ae24e0a147cbca0227d022e129f8bca06b7474b0aac23600864093a6899db245155c25c0b041e010b7b60cbd3eeeab69e07f8eb3eb3d470d
+  data.tar.gz: 885749d694361beed564bb2c3c22b2120e77fcc6c8f49142dc924488910ca28794d35c3b058b83851bed1045c794be4da5b28a8d66154db9128e49d8c6fd9e63

data/README.md

@@ -26,14 +26,21 @@ $ gem install wcag_color_contrast
 
 ## Usage
 
-Pass 2 rgb colors are strings (3 or 6 characters, case insensitive):
+With 2 hex colors as strings (3 or 6 characters, case insensitive, no leading pound/hash sign):
 
 ```ruby
 require 'wcag_color_contrast'
-WCAGColorContrast.new.ratio('999', 'ffffff')
+WCAGColorContrast.ratio('999', 'ffffff')
 #=> 2.849027755287037
 ```
 
+Can also calculate the relative luminance of a color
+
+```ruby
+WCAGColorContrast.relative_luminance('008800')
+#=> 0.17608318886144392
+```
+
 ## Contributing
 
 1. Fork it
@@ -41,3 +48,7 @@ WCAGColorContrast.new.ratio('999', 'ffffff')
 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
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/mkdynamic/wcag_color_contrast/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/wcag_color_contrast.rb

@@ -3,11 +3,15 @@ require "wcag_color_contrast/version"
 module WCAGColorContrast
   class InvalidColorError < StandardError; end
 
-  # Helper method for WCAGColorContrast#new#ratio.
+  # Helper method for WCAGColorContrast::Ratio.new#ratio.
   def self.ratio(*args)
     Ratio.new.ratio(*args)
   end
 
+  def self.relative_luminance(rgb)
+    Ratio.new.relative_luminance(rgb)
+  end
+
   class Ratio
     # Calculate contast ratio beetween RGB1 and RGB2.
     def ratio(rgb1, rgb2)
@@ -23,6 +27,14 @@ module WCAGColorContrast
       l1 > l2 ? (l1 + 0.05) / (l2 + 0.05) : (l2 + 0.05) / (l1 + 0.05)
     end
 
+    # Calculate the relative luminance for an rgb color
+    def relative_luminance(rgb)
+      raise InvalidColorError, rgb unless valid_rgb?(rgb)
+
+      srgb = rgb_to_srgba(rgb)
+      srgb_lightness(srgb)
+    end
+
     private
 
     # Convert RGB color to sRGB.

data/lib/wcag_color_contrast/version.rb

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

data/test/test.rb

@@ -8,4 +8,9 @@ class WCAGColorContrastTest < MiniTest::Unit::TestCase
     assert_in_delta 1.425, WCAGColorContrast.ratio('d8d8d8', 'fff')
     assert_in_delta 1.956, WCAGColorContrast.ratio('eee', 'AAABBB')
   end
+
+  def test_relative_luminance
+    assert_equal 1, WCAGColorContrast.relative_luminance('ffffff')
+    assert_in_delta 0.176, WCAGColorContrast.relative_luminance('008800')
+  end
 end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: wcag_color_contrast
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2017-11-13 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: 
@@ -66,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,33 +71,26 @@ files:
 homepage: https://github.com/mkdynamic/wcag_color_contrast
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Calculate the contrast ratio between 2 colors, for checking against the WCAG
   recommended contrast ratio for legibility.
 test_files: