css_color_contrast 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6f9cc746835363817c13f2501387b3c0cb8463568296a0e8ce07f82cb8a793e
+  data.tar.gz: 1bf6ca7654c957b64e7290c46dfe04b6c9c851f4fc821413e56079c451c5706d
+SHA512:
+  metadata.gz: 7c0419c7968a6087f961500697869436acfd685e38fe4228c95e23f50b8b6538cb00364ea0bd942cc809efca896b1a99b0e8983b95f47f5f1bb0596926c634fe
+  data.tar.gz: 848d70b305f39f98d20164c4c724396bf63f9af9b6167c010e99f7cdc55e57d3e6fe0f6f01d3e80f2d930db2869833a502569b3a72b62d296265ecbebc945e8a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0
+  - ruby-head
+  - jruby-head
+before_install: gem install bundler -v 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hashimoto.naoki@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    css_color_contrast (0.1.0)
+      color_contrast_calc (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    color_contrast_calc (0.7.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  css_color_contrast!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.79)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 HASHIMOTO, Naoki
+
+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,79 @@
+# CssColorContrast
+
+From 2 colors, calculates [the contrast ratio defined for WCAG 2.0](https://www.w3.org/TR/WCAG20/#contrast-ratiodef).
+
+Hexadecimal notation, RGB/HSL/HWB functions are supported as input formats.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'css_color_contrast'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install css_color_contrast
+
+## Usage
+
+### Calculate the contrast ratio
+
+For example, if you want to calculate the contrast ratio between yellow and black:
+
+```ruby
+require 'css_color_contrast'
+
+CssColorContrast.ratio('#ff0', [0, 0, 0])
+# => 19.555999999999997
+
+CssColorContrast.ratio('rgb(255, 255, 0)', 'black')
+# => 19.555999999999997
+
+CssColorContrast.ratio('hsl(60deg, 100%, 50%)', 'hwb(60deg 0% 100%)')
+# => 19.555999999999997
+```
+
+The following formats are supported for the arguments of `CssColorContrast.ratio()`.
+
+* RGB values as an Array of Integers: [255, 255, 0], [0, 0, 0], etc.
+* RGB values in hexadecimal notation: #ff0, #ffff00, #FF0, etc.
+* RGB values in functional notation: rgb(255, 255, 0), rgb(255 255 0), etc.
+* HSL colors in functional notation: hsl(60deg, 100%, 50%), hsl(60 100% 50%), etc.
+* [Experimental] HWB colors in functional notation: hwb(60deg 0% 0%), hwb(60 0% 0%), etc.
+* [Extended color keywords](https://www.w3.org/TR/css-color-3/#svg-color): white, black, red, etc.
+
+### Calculate the relative luminance
+
+You can also calculate the relative luminance of a given color as follows:
+
+```ruby
+require 'css_color_contrast'
+
+CssColorContrast.relative_luminance('#ff0')
+# => 0.9278
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/nico-hn/css_color_contrast. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nico-hn/css_color_contrast/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CssColorContrast project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nico-hn/css_color_contrast/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "css_color_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(__FILE__)

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/css_color_contrast.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/css_color_contrast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "css_color_contrast"
+  spec.version       = CssColorContrast::VERSION
+  spec.authors       = ["HASHIMOTO, Naoki"]
+  spec.email         = ["hashimoto.naoki@gmail.com"]
+
+  spec.summary       = <<-SUMMARY
+    Utility to calculate the contrast ratio between 2 colors, for checking
+    the level of conformance to the WCAG 2.0 criteria.
+    Hexadecimal notation, RGB/HSL/HWB functions are supported as input formats.
+  SUMMARY
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/nico-hn/css_color_contrast/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "color_contrast_calc", "~> 0.7.0"
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/exe/css_color_contrast

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'css_color_contrast'

data/lib/css_color_contrast.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'css_color_contrast/version'
+require 'color_contrast_calc'
+
+##
+# Provide methods to calculate the contrast ratio
+# related values from given colors.
+
+module CssColorContrast
+  class Error < StandardError; end
+
+  ##
+  # Calculate the contrast ratio between given colors.
+  #
+  # The contrast ratio is defined at
+  # {https://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef}.
+  # @param color1 [String, Array<Integer>] A color given as an array of
+  #   integers or a string. The string can be a predefined color name,
+  #   hex color code, rgb/hsl/hwb functions. Yellow, for example,
+  #   can be given as [255, 255, 0], "#ffff00", "rgb(255, 255, 255)",
+  #   "hsl(60deg, 100% 50%)" or "hwb(60deg 0% 0%)".
+  # @param color2 [String, Array<Integer>] Same as for +color1+.
+  # @return [Float] Contrast ratio
+
+  def self.ratio(color1, color2)
+    ColorContrastCalc.contrast_ratio(color1, color2)
+  end
+
+  ##
+  # Calculate the relative luminance of a color.
+  #
+  # The definition of relative luminance is given at
+  # {https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef}.
+  # @param color [String, Array<Integer>] A color given as an array of
+  #   integers or a string. The string can be a name of predefined
+  #   color, hex color code, rgb/hsl/hwb functions. Yellow, for example,
+  #   can be given as [255, 255, 0], "#ffff00", "rgb(255, 255, 255)",
+  #   "hsl(60deg, 100% 50%)" or "hwb(60deg 0% 0%)".
+  # @return [Float] Relative luminance of the passed color.
+
+  def self.relative_luminance(color)
+    ColorContrastCalc::Color.as_color(color).relative_luminance
+  end
+end

data/lib/css_color_contrast/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CssColorContrast
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: css_color_contrast
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HASHIMOTO, Naoki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: color_contrast_calc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- hashimoto.naoki@gmail.com
+executables:
+- css_color_contrast
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- css_color_contrast.gemspec
+- exe/css_color_contrast
+- lib/css_color_contrast.rb
+- lib/css_color_contrast/version.rb
+homepage: https://github.com/nico-hn/css_color_contrast/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/nico-hn/css_color_contrast/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Utility to calculate the contrast ratio between 2 colors, for checking the
+  level of conformance to the WCAG 2.0 criteria. Hexadecimal notation, RGB/HSL/HWB
+  functions are supported as input formats.
+test_files: []