luminosity_contrast 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d5208e8c97547e595e4a1277a86f84138298b13
+  data.tar.gz: 62d2c8f2ccefb091733ce4a1539b48cb83603dff
+SHA512:
+  metadata.gz: 4d0d750948caae5290a2ea2ea825d9c9ab6561d61a6c56ba9c66c92acaca9fdd5ff6ea126bc211e2402622764a60c3798c465f89d80c9f0002ca3131ee446ef9
+  data.tar.gz: 345761d85c5bbd3b8224dc06df0226bc8e343941397522018c91bde27a766dc4bbdb9d8339d3d8a1d570681e402986f83d358120307a57dc8047589921e86bee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jj@kickstarter.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Justin Jones
+
+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,60 @@
+# LuminosityContrast
+
+Calculate the [Luminosity Contrast Ratio](https://www.w3.org/TR/WCAG20/#contrast-ratiodef) of two colors to determine whether text can be easily read. This quantifies the legibility of colored text on a colored background for accessibility purposes.
+
+Implements the formula in WCAG 2.0 guideline 1.4
+
+A recommended value is at least 4.5:1 (`4.5`) for standard text, or at least 3:1 (`3.0`) for large text.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'luminosity_contrast'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install luminosity_contrast
+
+## Usage
+
+```ruby
+LuminosityContrast.ratio('000', 'fff')
+# => 21.0
+
+LuminosityContrast.ratio([0,0,0], [255,255,255])
+# => 21.0
+
+sienna = LuminosityContrast::Color.new('A0522D')
+LuminosityContrast.ratio(sienna, sienna)
+# => 1.0
+
+midnight_blue = LuminosityContrast::Color.new('191970')
+sky_blue = LuminosityContrast::Color.new('87CEEB')
+midnight_blue.ratio(sky_blue)
+# => 8.5256628387305
+sky_blue.ratio(midnight_blue)
+# => 8.5256628387305
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/devpuppy/luminosity_contrast. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "luminosity_contrast"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/luminosity_contrast.rb

@@ -0,0 +1,34 @@
+require "luminosity_contrast/version"
+require "luminosity_contrast/color"
+
+
+module LuminosityContrast
+
+  # module methods
+  class << self
+    # expects two RGB values as Arrays of three numbers
+    #   example: [0, 0, 0], [255.0, 255.0, 255.0]
+    # or hex code strings (3 or 6 characters)
+    #   example: '000000', 'fff'
+    # returns the Luminosity Contrast Ratio between 1.0 and 21.0
+    def ratio(rgb1, rgb2)
+      c1, c2 = [rgb1, rgb2].map { |rgb| Color.new(rgb) }
+      l1, l2 = [c1, c2].map(&:relative_luminance).sort
+      (l2 + 0.05) / (l1 + 0.05)
+    end
+
+    # expects RGB as three numeric values between 0.0 and 255.0
+    # returns relative luminance of a color between 0.0 and 1.0
+    def relative_luminance(r, g, b)
+      (0.2126 * f(r)) + (0.7152 * f(g)) + (0.0722 * f(b))
+    end
+
+    # assists calculation of relative luminance
+    # expects a single RGB component between 0.0 and 255.0
+    private def f(component)
+      c = component / 255.0
+      c <= 0.03928 ? c : ((c + 0.055) / 1.055) ** 2.4
+    end
+  end
+end
+

data/lib/luminosity_contrast/color.rb

@@ -0,0 +1,56 @@
+module LuminosityContrast
+  class Color
+    attr_reader :r, :g, :b
+
+    def initialize(*args)
+      input = args.size == 1 ? args[0] : args
+      @r, @g, @b = Color.rgb_from(input)
+    end
+
+    def relative_luminance
+      LuminosityContrast.relative_luminance(r,g,b)
+    end
+
+    def ratio(color)
+      LuminosityContrast.ratio(self, color)
+    end
+
+    def to_rgb
+      [r, g, b]
+    end
+
+    class << self
+
+      # expects a 3 or 6 character hex color code
+      # or an array with 3 numbers between 0 and 255
+      # or an object that responds to .r, .g, .b
+      def rgb_from(input)
+        case input
+        when String # hex code
+          raise 'Invalid hex code' unless input =~ /\A([0-9a-f]{3}){1,2}\z/i
+          rgb = if input.size == 3
+            input.split('').map { |h| h * 2 }
+          else
+            input.scan(/.{2}/)
+          end
+          rgb.map { |h| h.hex.to_i }
+        when Array # array of numbers
+          raise 'Invalid RGB array' unless input.size == 3
+          input.map(&:to_f)
+        when Hash
+          rgb = input.values_at(:r, :g, :b)
+          raise 'Invalid RGB hash' unless rgb.size == 3
+          rgb.map(&:to_f)
+        else
+          methods = [:r,:g, :b]
+          if methods.select { |m| input.respond_to?(m) }.size == methods.size
+            methods.map { |m| input.send(m) }
+          else
+            raise 'Invalid input'
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/luminosity_contrast/version.rb

@@ -0,0 +1,3 @@
+module LuminosityContrast
+  VERSION = "0.2.0"
+end

data/luminosity_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 'luminosity_contrast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "luminosity_contrast"
+  spec.version       = LuminosityContrast::VERSION
+  spec.authors       = ["Justin Jones"]
+
+  spec.summary       = %q{calculate Luminosity Contrast Ratio per WCAG 2.0 guideline 1.4}
+  spec.homepage      = "https://github.com/devpuppy/luminosity_contrast"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: luminosity_contrast
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Justin Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email: 
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/luminosity_contrast.rb
+- lib/luminosity_contrast/color.rb
+- lib/luminosity_contrast/version.rb
+- luminosity_contrast.gemspec
+homepage: https://github.com/devpuppy/luminosity_contrast
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: calculate Luminosity Contrast Ratio per WCAG 2.0 guideline 1.4
+test_files: []