color_contrast_calc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a8775f32887a986970172b51ad16f6ecfed4eef
+  data.tar.gz: e7b5c2e6b91390bd2d9e2ad198bba4a02d4fd739
+SHA512:
+  metadata.gz: 976ca9c5262cb36a3c293f6ee856f2c5ba485a6b98ed62cb545dd730623edfcc3ff449b18f5f242953cc9d408185d0ef9c5365e53ca0203dad6f327da0743f16
+  data.tar.gz: 5cd83c0fa63c5a601162a0ae79d5e09149594333c5218d058d17a9c3af54d6c98effbf412adb57c471cac5a1bd9147ad503671a20d0c43536bfcaf22726369fd

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*~
+.ruby-version

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.2
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+Metrics/BlockLength:
+  Exclude: ["spec/**/*", "test/**/*"]
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - ruby-head
+  - jruby-head
+before_install: gem install bundler -v 1.15.3

data/.yardopts

@@ -0,0 +1,4 @@
+--readme README.md
+--no-private
+-
+README.ja.md

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in color_contrast_calc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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.ja.md

@@ -0,0 +1,296 @@
+# ColorContrastCalc
+
+`ColorContrastCalc`は、十分なコントラストのある色をWCAG 2.0を念頭に置きながら
+選択することを支援するユーティリティとして開発しています。 
+
+このユーティリティを使い次のことができます:
+
+* 2つの色のコントラスト比を確認する
+* ある色に対し十分なコントラストがある色を(もしあれば)見つける
+* ある色の属性を調整し、新しい色を作る
+* 色をソートする
+
+## インストール
+
+Gemfileに次の行を追加し:
+
+```ruby
+gem 'color_contrast_calc'
+```
+
+次のコマンドを実行します:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install color_contrast_calc
+
+## 使い方
+
+### 色の表現
+
+ユーティリティ内で色を表わすクラスとしてColorContrastCalc::Color`
+が用意されています。
+このクラスはユーティリティ内のほとんどの操作で利用されます。
+
+例えば赤色を表す`Color`のインスタンスを生成したい場合、
+`ColorContrastCalc.color_from`というメソッドが利用できます。
+
+次のコードを`color_instance.rb`として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+# Create an instance of Color from a hex code
+# (You can pass 'red' or [255, 0, 0] instead of '#ff0000')
+red = ColorContrastCalc.color_from('#ff0000')
+puts red.class
+puts red.name
+puts red.hex
+puts red.rgb.to_s
+puts red.hsl.to_s
+
+```
+
+以下のように実行します:
+
+```bash
+$ ruby color_instance.rb
+ColorContrastCalc::Color
+red
+#ff0000
+[255, 0, 0]
+[0.0, 100.0, 50.0]
+
+```
+
+### 例1: 2つの色のコントラスト比を計算する
+
+例えば黄色と黒のコントラスト比を計算したい場合、
+次のコードを`yellow_black_contrast.rb`として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow = ColorContrastCalc.color_from('yellow')
+black = ColorContrastCalc.color_from('black')
+
+contrast_ratio = yellow.contrast_ratio_against(black)
+
+report = 'The contrast ratio between %s and %s is %2.4f'
+puts(format(report, yellow.name, black.name, contrast_ratio))
+puts(format(report, yellow.hex, black.hex, contrast_ratio))
+```
+
+以下のように実行します:
+
+```bash
+$ ruby yellow_black_contrast.rb
+The contrast ratio between yellow and black is 19.5560
+The contrast ratio between #ffff00 and #000000 is 19.5560
+```
+
+### 例2: ある色に対し十分なコントラスト比のある色を見つける
+
+2色の組み合わせのうち、一方の色のbrightness/lightnessを変化させることで十分な
+コントラストのある色を見つけたい場合、次のコードを`yellow_orange_contrast.rb`
+として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow = ColorContrastCalc.color_from('yellow')
+orange = ColorContrastCalc.color_from('orange')
+
+report = 'The contrast ratio between %s and %s is %2.4f'
+
+# Find brightness adjusted colors.
+
+a_orange = yellow.find_brightness_threshold(orange, 'A')
+a_contrast_ratio = yellow.contrast_ratio_against(a_orange)
+
+aa_orange = yellow.find_brightness_threshold(orange, 'AA')
+aa_contrast_ratio = yellow.contrast_ratio_against(aa_orange)
+
+puts('# Brightness adjusted colors')
+puts(format(report, yellow.hex, a_orange.hex, a_contrast_ratio))
+puts(format(report, yellow.hex, aa_orange.hex, aa_contrast_ratio))
+
+# Find lightness adjusted colors.
+
+a_orange = yellow.find_lightness_threshold(orange, 'A')
+a_contrast_ratio = yellow.contrast_ratio_against(a_orange)
+
+aa_orange = yellow.find_lightness_threshold(orange, 'AA')
+aa_contrast_ratio = yellow.contrast_ratio_against(aa_orange)
+
+puts('# Lightness adjusted colors')
+puts(format(report, yellow.hex, a_orange.hex, a_contrast_ratio))
+puts(format(report, yellow.hex, aa_orange.hex, aa_contrast_ratio))
+```
+
+以下のように実行します:
+
+```bash
+$ ruby yellow_orange_contrast.rb
+# Brightness adjusted colors
+The contrast ratio between #ffff00 and #c68000 is 3.0138
+The contrast ratio between #ffff00 and #9d6600 is 4.5121
+# Lightness adjusted colors
+The contrast ratio between #ffff00 and #c78000 is 3.0012
+The contrast ratio between #ffff00 and #9d6600 is 4.5121
+```
+
+### 例3: ある色のグレースケール
+
+ある色のグレースケールを得るために`ColorContrastCalc::Color` には
+`new_grayscale_color`というインスタンスメソッドがあります。
+
+例えば次のコードを`grayscale.rb`として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow = ColorContrastCalc.color_from('yellow')
+orange = ColorContrastCalc.color_from('orange')
+
+report = 'The grayscale of %s is %s.'
+puts(format(report, yellow.hex, yellow.new_grayscale_color))
+puts(format(report, orange.hex, orange.new_grayscale_color))
+```
+
+以下のように実行します:
+
+```bash
+$ ruby grayscale.rb
+The grayscale of #ffff00 is #ededed.
+The grayscale of #ffa500 is #acacac.
+```
+
+また`new_grayscale_color`以外に、以下のインスタンスメッソドが
+`ColorContrastCalc::Color`では利用できます。:
+
+* `new_brightness_color`
+* `new_contrast_color`
+* `new_hue_rotate_color`
+* `new_invert_color`
+* `new_saturate_color`
+
+### 例4: 色をソートする
+
+`ColorContrastCalc::Sorter.sort`を使って色のソートができます。
+
+またこのメソッドの2番目の引数でソート順を指定することもできます。
+
+例えば次のコードを`sort_colors.rb`として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+color_names = ['red', 'yellow', 'lime', 'cyan', 'fuchsia', 'blue']
+colors = color_names.map {|c| ColorContrastCalc.color_from(c) }
+
+# sort by hSL order.  An uppercase for a component of color means
+# that component should be sorted in descending order.
+
+hsl_ordered = ColorContrastCalc::Sorter.sort(colors, 'hSL')
+puts("Colors sorted in the order of hSL: #{hsl_ordered.map(&:name)}")
+
+# sort by RGB order.
+
+rgb_ordered = ColorContrastCalc::Sorter.sort(colors, 'RGB')
+puts("Colors sorted in the order of RGB: #{rgb_ordered.map(&:name)}")
+
+# You can also change the precedence of components.
+
+grb_ordered = ColorContrastCalc::Sorter.sort(colors, 'GRB')
+puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
+
+# And you can directly sort hex color codes.
+
+## Hex color codes that correspond to the color_names given above.
+hex_codes = ['#ff0000', '#ff0', '#00ff00', '#0ff', '#f0f', '#0000FF']
+
+hsl_ordered = ColorContrastCalc::Sorter.sort(hex_codes, 'hSL')
+puts("Colors sorted in the order of hSL: #{hsl_ordered}")
+```
+
+以下のように実行します:
+
+```bash
+$ ruby sort_colors.rb
+Colors sorted in the order of hSL: ["red", "yellow", "lime", "cyan", "blue", "fuchsia"]
+Colors sorted in the order of RGB: ["yellow", "fuchsia", "red", "cyan", "lime", "blue"]
+Colors sorted in the order of GRB: ["yellow", "cyan", "lime", "fuchsia", "red", "blue"]
+Colors sorted in the order of hSL: ["#ff0000", "#ff0", "#00ff00", "#0ff", "#0000FF", "#f0f"]
+```
+
+### 例5: 定義済みの色のリスト
+
+[拡張カラーキーワードで定義された色](https://www.w3.org/TR/SVG/types.html#ColorKeywords)・
+ウェブセーフカラーの2つのリストが予め定義されています。
+
+
+また、HSLでsaturation・lightnessが共通する色のリストを生成する
+`ColorContrastCalc::Color::List.hsl_colors`というメソッドがあります。
+
+例えば次のコードを`color_lists.rb`として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+# Named colors
+named_colors = ColorContrastCalc.named_colors
+
+puts("The number of named colors: #{named_colors.size}")
+puts("The first of named colors: #{named_colors[0].name}")
+puts("The last of named colors: #{named_colors[-1].name}")
+
+# Web safe colors
+web_safe_colors = ColorContrastCalc.web_safe_colors
+
+puts("The number of web safe colors: #{web_safe_colors.size}")
+puts("The first of web safe colors: #{web_safe_colors[0].name}")
+puts("The last of web safe colors: #{web_safe_colors[-1].name}")
+
+# HSL colors
+hsl_colors = ColorContrastCalc.hsl_colors
+
+puts("The number of HSL colors: #{hsl_colors.size}")
+puts("The first of HSL colors: #{hsl_colors[0].name}")
+puts("The 60th of HSL colors: #{hsl_colors[60].name}")
+puts("The 120th of HSL colors: #{hsl_colors[120].name}")
+puts("The last of HSL colors: #{hsl_colors[-1].name}")
+```
+
+以下のように実行します:
+
+```bash
+$ ruby color_lists.rb
+The number of named colors: 147
+The first of named colors: aliceblue
+The last of named colors: yellowgreen
+The number of web safe colors: 216
+The first of web safe colors: black
+The last of web safe colors: white
+The number of HSL colors: 361
+The first of HSL colors: #ff0000
+The 60th of HSL colors: #ffff00
+The 120th of HSL colors: #00ff00
+The last of HSL colors: #ff0000
+```
+
+## 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/color_contrast_calc_rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/README.md

@@ -0,0 +1,295 @@
+# ColorContrastCalc
+
+`ColorContrastCalc` is a utility that helps you choose colors with
+sufficient contrast, WCAG 2.0 in mind.
+
+With this library, you can do following things:
+
+* Check the contrast ratio between two colors
+* Find (if exists) a color that has suffcient contrast to a given color
+* Create a new color from a given color by adjusting properies of the latter
+* Sort colors
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'color_contrast_calc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install color_contrast_calc
+
+## Usage
+
+### Representing a color
+
+To represent a color, class `ColorContrastCalc::Color` is provided.
+And most of the operations in this utility use this class.
+
+As an illustration, if you want to create an instance of `Color` for red,
+you may use a method `ColorContrastCalc.color_from`
+
+Save the following code as `color_instance.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+# Create an instance of Color from a hex code
+# (You can pass 'red' or [255, 0, 0] instead of '#ff0000')
+red = ColorContrastCalc.color_from('#ff0000')
+puts red.class
+puts red.name
+puts red.hex
+puts red.rgb.to_s
+puts red.hsl.to_s
+
+```
+
+Then execute the script:
+
+```bash
+$ ruby color_instance.rb
+ColorContrastCalc::Color
+red
+#ff0000
+[255, 0, 0]
+[0.0, 100.0, 50.0]
+
+```
+
+### Example 1: Calculate the contrast ratio between two colors
+
+If you want to calculate the contrast ratio between yellow and black,
+save the following code as `yellow_black_contrast.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow = ColorContrastCalc.color_from('yellow')
+black = ColorContrastCalc.color_from('black')
+
+contrast_ratio = yellow.contrast_ratio_against(black)
+
+report = 'The contrast ratio between %s and %s is %2.4f'
+puts(format(report, yellow.name, black.name, contrast_ratio))
+puts(format(report, yellow.hex, black.hex, contrast_ratio))
+```
+
+Then execute the script:
+
+```bash
+$ ruby yellow_black_contrast.rb
+The contrast ratio between yellow and black is 19.5560
+The contrast ratio between #ffff00 and #000000 is 19.5560
+```
+
+### Example 2: Find colors that have enough contrast ratio with a given color
+
+If you want to find a combination of colors with sufficient contrast
+by changing the brightness/lightness of one of those colors, save the
+following code as `yellow_orange_contrast.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow = ColorContrastCalc.color_from('yellow')
+orange = ColorContrastCalc.color_from('orange')
+
+report = 'The contrast ratio between %s and %s is %2.4f'
+
+# Find brightness adjusted colors.
+
+a_orange = yellow.find_brightness_threshold(orange, 'A')
+a_contrast_ratio = yellow.contrast_ratio_against(a_orange)
+
+aa_orange = yellow.find_brightness_threshold(orange, 'AA')
+aa_contrast_ratio = yellow.contrast_ratio_against(aa_orange)
+
+puts('# Brightness adjusted colors')
+puts(format(report, yellow.hex, a_orange.hex, a_contrast_ratio))
+puts(format(report, yellow.hex, aa_orange.hex, aa_contrast_ratio))
+
+# Find lightness adjusted colors.
+
+a_orange = yellow.find_lightness_threshold(orange, 'A')
+a_contrast_ratio = yellow.contrast_ratio_against(a_orange)
+
+aa_orange = yellow.find_lightness_threshold(orange, 'AA')
+aa_contrast_ratio = yellow.contrast_ratio_against(aa_orange)
+
+puts('# Lightness adjusted colors')
+puts(format(report, yellow.hex, a_orange.hex, a_contrast_ratio))
+puts(format(report, yellow.hex, aa_orange.hex, aa_contrast_ratio))
+```
+
+Then execute the script:
+
+```bash
+$ ruby yellow_orange_contrast.rb
+# Brightness adjusted colors
+The contrast ratio between #ffff00 and #c68000 is 3.0138
+The contrast ratio between #ffff00 and #9d6600 is 4.5121
+# Lightness adjusted colors
+The contrast ratio between #ffff00 and #c78000 is 3.0012
+The contrast ratio between #ffff00 and #9d6600 is 4.5121
+```
+
+### Example 3: Grayscale of given colors
+
+For getting grayscale, `ColorContrastCalc::Color` has an instance method
+`new_grayscale_color`.
+For example, save the following code as `grayscale.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow = ColorContrastCalc.color_from('yellow')
+orange = ColorContrastCalc.color_from('orange')
+
+report = 'The grayscale of %s is %s.'
+puts(format(report, yellow.hex, yellow.new_grayscale_color))
+puts(format(report, orange.hex, orange.new_grayscale_color))
+```
+
+Then execute the script:
+
+```bash
+$ ruby grayscale.rb
+The grayscale of #ffff00 is #ededed.
+The grayscale of #ffa500 is #acacac.
+```
+
+And other than `new_grayscale_color`, following instance methods
+are available for `ColorContrastCalc::Color`:
+
+* `new_brightness_color`
+* `new_contrast_color`
+* `new_hue_rotate_color`
+* `new_invert_color`
+* `new_saturate_color`
+
+### Example 4: Sort colors
+
+You can sort colors using a method `ColorContrastCalc::Sorter.sort`.
+
+And by passing the second argument to this method, you can also specify
+the sort order.
+
+For example, save the following code as `sort_colors.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+color_names = ['red', 'yellow', 'lime', 'cyan', 'fuchsia', 'blue']
+colors = color_names.map {|c| ColorContrastCalc.color_from(c) }
+
+# sort by hSL order.  An uppercase for a component of color means
+# that component should be sorted in descending order.
+
+hsl_ordered = ColorContrastCalc::Sorter.sort(colors, 'hSL')
+puts("Colors sorted in the order of hSL: #{hsl_ordered.map(&:name)}")
+
+# sort by RGB order.
+
+rgb_ordered = ColorContrastCalc::Sorter.sort(colors, 'RGB')
+puts("Colors sorted in the order of RGB: #{rgb_ordered.map(&:name)}")
+
+# You can also change the precedence of components.
+
+grb_ordered = ColorContrastCalc::Sorter.sort(colors, 'GRB')
+puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
+
+# And you can directly sort hex color codes.
+
+## Hex color codes that correspond to the color_names given above.
+hex_codes = ['#ff0000', '#ff0', '#00ff00', '#0ff', '#f0f', '#0000FF']
+
+hsl_ordered = ColorContrastCalc::Sorter.sort(hex_codes, 'hSL')
+puts("Colors sorted in the order of hSL: #{hsl_ordered}")
+```
+
+Then execute the script:
+
+```bash
+$ ruby sort_colors.rb
+Colors sorted in the order of hSL: ["red", "yellow", "lime", "cyan", "blue", "fuchsia"]
+Colors sorted in the order of RGB: ["yellow", "fuchsia", "red", "cyan", "lime", "blue"]
+Colors sorted in the order of GRB: ["yellow", "cyan", "lime", "fuchsia", "red", "blue"]
+Colors sorted in the order of hSL: ["#ff0000", "#ff0", "#00ff00", "#0ff", "#0000FF", "#f0f"]
+```
+
+### Example 5: Lists of predefined colors
+
+Two lists of colors are provided, one is for
+[named colors](https://www.w3.org/TR/SVG/types.html#ColorKeywords)
+and the other for the web safe colors.
+
+And there is a method `ColorContrastCalc::Color::List.hsl_colors` that
+generates a list of HSL colors that share same saturation and lightness.
+
+For example, save the following code as `color_lists.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+# Named colors
+named_colors = ColorContrastCalc.named_colors
+
+puts("The number of named colors: #{named_colors.size}")
+puts("The first of named colors: #{named_colors[0].name}")
+puts("The last of named colors: #{named_colors[-1].name}")
+
+# Web safe colors
+web_safe_colors = ColorContrastCalc.web_safe_colors
+
+puts("The number of web safe colors: #{web_safe_colors.size}")
+puts("The first of web safe colors: #{web_safe_colors[0].name}")
+puts("The last of web safe colors: #{web_safe_colors[-1].name}")
+
+# HSL colors
+hsl_colors = ColorContrastCalc.hsl_colors
+
+puts("The number of HSL colors: #{hsl_colors.size}")
+puts("The first of HSL colors: #{hsl_colors[0].name}")
+puts("The 60th of HSL colors: #{hsl_colors[60].name}")
+puts("The 120th of HSL colors: #{hsl_colors[120].name}")
+puts("The last of HSL colors: #{hsl_colors[-1].name}")
+```
+
+Then execute the script:
+
+```bash
+$ ruby color_lists.rb
+The number of named colors: 147
+The first of named colors: aliceblue
+The last of named colors: yellowgreen
+The number of web safe colors: 216
+The first of web safe colors: black
+The last of web safe colors: white
+The number of HSL colors: 361
+The first of HSL colors: #ff0000
+The 60th of HSL colors: #ffff00
+The 120th of HSL colors: #00ff00
+The last of HSL colors: #ff0000
+```
+
+## 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/color_contrast_calc_rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).