color_contrast_calc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a8775f32887a986970172b51ad16f6ecfed4eef
-  data.tar.gz: e7b5c2e6b91390bd2d9e2ad198bba4a02d4fd739
+  metadata.gz: c4b26adb4fda2262eea7f261682ab051b808f2a0
+  data.tar.gz: d021fedafd96acdf28e7b2e9e1757380546d8408
 SHA512:
-  metadata.gz: 976ca9c5262cb36a3c293f6ee856f2c5ba485a6b98ed62cb545dd730623edfcc3ff449b18f5f242953cc9d408185d0ef9c5365e53ca0203dad6f327da0743f16
-  data.tar.gz: 5cd83c0fa63c5a601162a0ae79d5e09149594333c5218d058d17a9c3af54d6c98effbf412adb57c471cac5a1bd9147ad503671a20d0c43536bfcaf22726369fd
+  metadata.gz: 922f5d4c9914fd92473b135ddec0f92eab3c8b121acebbfecae1f489ce8e1f1ba693b3f37404b4e2198fccdf1144e049aa265dfd7cba32e977be5a20aaef5c8c
+  data.tar.gz: 29538d2de8d60496a1b800071311502710dc1b1d01a8e0c5746303db3c33da3836c66f092a1e391f86a10b6c33ea433508daeb0d5db612aa36a246a1e03c8bba

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
   - ruby-head
   - jruby-head
 before_install: gem install bundler -v 1.15.3

data/README.ja.md

@@ -28,6 +28,10 @@ Or install it yourself as:
 
 ## 使い方
 
+ここでは大まかな概要が分かるような例を挙げています。
+
+詳細なドキュメントはhttp://www.rubydoc.info/gems/color_contrast_calc を見て下さい。
+
 ### 色の表現
 
 ユーティリティ内で色を表わすクラスとしてColorContrastCalc::Color`
@@ -91,6 +95,31 @@ The contrast ratio between yellow and black is 19.5560
 The contrast ratio between #ffff00 and #000000 is 19.5560
 ```
 
+もしくは2色の16進数カラーコードあるいはRGB値からコントラスト比を計算することも可能です。
+
+次のコードを `yellow_black_hex_contrast.rb`として保存し:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow, black = %w[#ff0 #000000]
+# or
+# yellow, black = [[255, 255, 0], [0, 0, 0]]
+
+ratio = ColorContrastCalc::Checker.contrast_ratio(yellow, black)
+level = ColorContrastCalc::Checker.ratio_to_level(ratio)
+
+puts "Contrast ratio between yellow and black: #{ratio}"
+puts "Contrast level: #{level}"
+```
+
+以下のように実行します:
+
+```bash
+Contrast ratio between yellow and black: 19.555999999999997
+Contrast level: AAA
+```
+
 ### 例2: ある色に対し十分なコントラスト比のある色を見つける
 
 2色の組み合わせのうち、一方の色のbrightness/lightnessを変化させることで十分な
@@ -191,20 +220,20 @@ 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
+# 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')
+hsl_ordered = ColorContrastCalc.sort(colors, 'hSL')
 puts("Colors sorted in the order of hSL: #{hsl_ordered.map(&:name)}")
 
-# sort by RGB order.
+# Sort by RGB order.
 
-rgb_ordered = ColorContrastCalc::Sorter.sort(colors, 'RGB')
+rgb_ordered = ColorContrastCalc.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')
+grb_ordered = ColorContrastCalc.sort(colors, 'GRB')
 puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
 
 # And you can directly sort hex color codes.
@@ -212,7 +241,7 @@ puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
 ## 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')
+hsl_ordered = ColorContrastCalc.sort(hex_codes, 'hSL')
 puts("Colors sorted in the order of hSL: #{hsl_ordered}")
 ```
 

data/README.md

@@ -6,8 +6,8 @@ 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
+* Find (if exists) a color that has sufficient contrast to a given color
+* Create a new color from a given color by adjusting properties of the latter
 * Sort colors
 
 ## Installation
@@ -20,7 +20,7 @@ gem 'color_contrast_calc'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -28,6 +28,10 @@ Or install it yourself as:
 
 ## Usage
 
+Here are some examples that will give you a brief overview of the library.
+
+The full documentation is available at http://www.rubydoc.info/gems/color_contrast_calc
+
 ### Representing a color
 
 To represent a color, class `ColorContrastCalc::Color` is provided.
@@ -90,6 +94,32 @@ The contrast ratio between yellow and black is 19.5560
 The contrast ratio between #ffff00 and #000000 is 19.5560
 ```
 
+Or it is also possible to calculate the contrast ratio of two colors from
+their hex color codes or RGB values.
+
+Save the following code as `yellow_black_hex_contrast.rb`:
+
+```ruby
+require 'color_contrast_calc'
+
+yellow, black = %w[#ff0 #000000]
+# or
+# yellow, black = [[255, 255, 0], [0, 0, 0]]
+
+ratio = ColorContrastCalc::Checker.contrast_ratio(yellow, black)
+level = ColorContrastCalc::Checker.ratio_to_level(ratio)
+
+puts "Contrast ratio between yellow and black: #{ratio}"
+puts "Contrast level: #{level}"
+```
+
+Then execute the script:
+
+```bash
+Contrast ratio between yellow and black: 19.555999999999997
+Contrast level: AAA
+```
+
 ### 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
@@ -190,20 +220,20 @@ 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
+# 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')
+hsl_ordered = ColorContrastCalc.sort(colors, 'hSL')
 puts("Colors sorted in the order of hSL: #{hsl_ordered.map(&:name)}")
 
-# sort by RGB order.
+# Sort by RGB order.
 
-rgb_ordered = ColorContrastCalc::Sorter.sort(colors, 'RGB')
+rgb_ordered = ColorContrastCalc.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')
+grb_ordered = ColorContrastCalc.sort(colors, 'GRB')
 puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
 
 # And you can directly sort hex color codes.
@@ -211,7 +241,7 @@ puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
 ## 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')
+hsl_ordered = ColorContrastCalc.sort(hex_codes, 'hSL')
 puts("Colors sorted in the order of hSL: #{hsl_ordered}")
 ```
 

data/color_contrast_calc.gemspec

@@ -7,6 +7,7 @@ require 'color_contrast_calc/version'
 Gem::Specification.new do |spec|
   spec.name          = 'color_contrast_calc'
   spec.version       = ColorContrastCalc::VERSION
+  spec.required_ruby_version = ">= 2.2"
   spec.authors       = ['HASHIMOTO, Naoki']
   spec.email         = ['hashimoto.naoki@gmail.com']
 

data/examples/sort_colors.rb

@@ -5,20 +5,20 @@ 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
+# 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')
+hsl_ordered = ColorContrastCalc.sort(colors, 'hSL')
 puts("Colors sorted in the order of hSL: #{hsl_ordered.map(&:name)}")
 
-# sort by RGB order.
+# Sort by RGB order.
 
-rgb_ordered = ColorContrastCalc::Sorter.sort(colors, 'RGB')
+rgb_ordered = ColorContrastCalc.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')
+grb_ordered = ColorContrastCalc.sort(colors, 'GRB')
 puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
 
 # And you can directly sort hex color codes.
@@ -26,5 +26,5 @@ puts("Colors sorted in the order of GRB: #{grb_ordered.map(&:name)}")
 ## 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')
+hsl_ordered = ColorContrastCalc.sort(hex_codes, 'hSL')
 puts("Colors sorted in the order of hSL: #{hsl_ordered}")

data/examples/yellow_black_hex_contrast.rb

@@ -0,0 +1,11 @@
+require 'color_contrast_calc'
+
+yellow, black = %w[#ff0 #000000]
+# or
+# yellow, black = [[255, 255, 0], [0, 0, 0]]
+
+ratio = ColorContrastCalc::Checker.contrast_ratio(yellow, black)
+level = ColorContrastCalc::Checker.ratio_to_level(ratio)
+
+puts "Contrast ratio between yellow and black: #{ratio}"
+puts "Contrast level: #{level}"

data/lib/color_contrast_calc/sorter.rb

@@ -87,9 +87,13 @@ module ColorContrastCalc
     # @param color_order [String] String such as "HSL", "RGB" or "lsH"
     # @param key_mapper [Proc, nil] Proc object used to retrive key values
     #   from items to be sorted
+    # @param key_mapper_block [Proc] Block that is used instead of key_mapper
+    #   when the latter is not given
     # @return [Array<Color>, Array<String>] Array of of sorted colors
 
-    def self.sort(colors, color_order = 'hSL', key_mapper = nil)
+    def self.sort(colors, color_order = 'hSL',
+                  key_mapper = nil, &key_mapper_block)
+      key_mapper = key_mapper_block if !key_mapper && key_mapper_block
       key_type = KeyTypes.guess(colors[0], key_mapper)
       compare = compile_compare_function(color_order, key_type, key_mapper)
 
@@ -103,9 +107,14 @@ module ColorContrastCalc
     # @param key_type [Symbol] +:color+, +:components+ or +:hex+
     # @param key_mapper [Proc, nil] Proc object to be used to retrive
     #   key values from items to be sorted.
+    # @param key_mapper_block [Proc] Block that is used instead of
+    #   key_mapper when the latter is not given
     # @return [Proc] Proc object to be passed to Array#sort()
 
-    def self.compile_compare_function(color_order, key_type, key_mapper = nil)
+    def self.compile_compare_function(color_order, key_type,
+                                      key_mapper = nil, &key_mapper_block)
+      key_mapper = key_mapper_block if !key_mapper && key_mapper_block
+
       case key_type
       when KeyTypes::COLOR
         compare = compile_color_compare_function(color_order)

data/lib/color_contrast_calc/version.rb

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

data/lib/color_contrast_calc.rb

@@ -38,6 +38,31 @@ module ColorContrastCalc
     color_from_str(color_value, name)
   end
 
+  ##
+  # Sort colors in the order specified by +color_order+.
+  #
+  # Sort colors given as a list or tuple of Color instances or hex
+  # color codes. (alias of Sorter.sort())
+  #
+  # You can specify sorting order by giving a +color_order+ tring, such
+  # as "HSL" or "RGB". A component of +color_order+ on the left side
+  # has a higher sorting precedence, and an uppercase letter means
+  # descending order.
+  # @param colors [Array<Color>, Array<String>] Array of Color instances
+  #   or items from which color hex codes can be retrieved.
+  # @param color_order [String] String such as "HSL", "RGB" or "lsH"
+  # @param key_mapper [Proc, nil] Proc object used to retrive key values
+  #   from items to be sorted
+  # @param key_mapper_block [Proc] Block that is used instead of key_mapper
+  #   when the latter is not given
+  # @return [Array<Color>, Array<String>] Array of of sorted colors
+
+  def self.sort(colors, color_order = 'hSL',
+                key_mapper = nil, &key_mapper_block)
+    key_mapper = key_mapper_block if !key_mapper && key_mapper_block
+    Sorter.sort(colors, color_order, key_mapper)
+  end
+
   ##
   # Return an array of named colors.
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: color_contrast_calc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HASHIMOTO, Naoki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-31 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - examples/grayscale.rb
 - examples/sort_colors.rb
 - examples/yellow_black_contrast.rb
+- examples/yellow_black_hex_contrast.rb
 - examples/yellow_orange_contrast.rb
 - exe/color_contrast_calc
 - lib/color_contrast_calc.rb
@@ -130,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="