color_contrast_calc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 624186d8778091959fe8526cba79cbe56708c16d
-  data.tar.gz: 2961fad47dfc7afa4b4893dd3d7b0995a97e5601
+  metadata.gz: 513b56ff5dca5ea3a6a7343a4cc5111a19c976e2
+  data.tar.gz: 9958f22f8d1474b93a3573ce728ffe6e41abe6d7
 SHA512:
-  metadata.gz: a28e5639b5db61cb0a722a1802b6969d1bb2c20d60783efd9242094f76e984987bd16330d37ac2f36f480c25b81b2679617035159dde4f74798c101a7b7e0de8
-  data.tar.gz: 5f95b64878aba232ed3923849de80776c33229a899fb76014ed397fa3918f89ab869cc690546cbe49ee68f8f970944f4e315ef23beb29fdfae0391f26b1efdcc
+  metadata.gz: ebf3189b2a716538c29fe3c3730e47f79d9a51fba4d53989269fe20f9a56e0225ee38e105936aa2c05844b3fb4925243feeefa9c670733975f82b46eabb15c2d
+  data.tar.gz: 5c6b613c861aaa290e31d1c1c710c6d7775beb742f43c896f25e7c10bf1b890cc7833ebe7f37b8b4c5727bc1ce68eb4ad9c8916f8bc853fc8f47d405ac2d34ec

data/README.ja.md

@@ -174,7 +174,7 @@ The contrast ratio between #ffff00 and #9d6600 is 4.5121
 ### 例3: ある色のグレースケール
 
 ある色のグレースケールを得るために`ColorContrastCalc::Color` には
-`new_grayscale_color`というインスタンスメソッドがあります。
+`with_grayscale`というインスタンスメソッドがあります。
 
 例えば次のコードを`grayscale.rb`として保存し:
 
@@ -185,8 +185,8 @@ 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))
+puts(format(report, yellow.hex, yellow.with_grayscale))
+puts(format(report, orange.hex, orange.with_grayscale))
 ```
 
 以下のように実行します:
@@ -197,9 +197,20 @@ The grayscale of #ffff00 is #ededed.
 The grayscale of #ffa500 is #acacac.
 ```
 
-また`new_grayscale_color`以外に、以下のインスタンスメッソドが
+また`with_grayscale`以外に、以下のインスタンスメッソドが
 `ColorContrastCalc::Color`では利用できます。:
 
+* `with_brightness`
+* `with_contrast`
+* `with_hue_rotate`
+* `with_invert`
+* `with_saturate`
+
+#### 非推奨のメソッド
+
+以下のメソッドは非推奨であることにご注意下さい。
+
+* `new_grayscale_color`
 * `new_brightness_color`
 * `new_contrast_color`
 * `new_hue_rotate_color`

data/README.md

@@ -174,7 +174,7 @@ 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`.
+`with_grayscale`.
 For example, save the following code as `grayscale.rb`:
 
 ```ruby
@@ -184,8 +184,8 @@ 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))
+puts(format(report, yellow.hex, yellow.with_grayscale))
+puts(format(report, orange.hex, orange.with_grayscale))
 ```
 
 Then execute the script:
@@ -196,9 +196,20 @@ The grayscale of #ffff00 is #ededed.
 The grayscale of #ffa500 is #acacac.
 ```
 
-And other than `new_grayscale_color`, following instance methods
+And other than `with_grayscale`, following instance methods
 are available for `ColorContrastCalc::Color`:
 
+* `with_brightness`
+* `with_contrast`
+* `with_hue_rotate`
+* `with_invert`
+* `with_saturate`
+
+#### Deprecated instance methods
+
+Please note the following methods are deprecated:
+
+* `new_grayscale_color`
 * `new_brightness_color`
 * `new_contrast_color`
 * `new_hue_rotate_color`

data/examples/grayscale.rb

@@ -6,5 +6,5 @@ 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))
+puts(format(report, yellow.hex, yellow.with_grayscale))
+puts(format(report, orange.hex, orange.with_grayscale))

data/lib/color_contrast_calc/color.rb

@@ -3,6 +3,7 @@
 require 'color_contrast_calc/utils'
 require 'color_contrast_calc/checker'
 require 'color_contrast_calc/threshold_finder'
+require 'color_contrast_calc/deprecated'
 require 'json'
 
 module ColorContrastCalc
@@ -13,6 +14,7 @@ module ColorContrastCalc
   # instances of Color class.
 
   class Color
+    include Deprecated::Color
     # @private
     RGB_LIMITS = [0, 255].freeze
 
@@ -102,7 +104,7 @@ module ColorContrastCalc
     #   code is assigned instead.
     # @return [Color] New color with adjusted contrast
 
-    def new_contrast_color(ratio, name = nil)
+    def with_contrast(ratio, name = nil)
       generate_new_color(Converter::Contrast, ratio, name)
     end
 
@@ -115,7 +117,7 @@ module ColorContrastCalc
     #   code is assigned instead.
     # @return [Color] New color with adjusted brightness
 
-    def new_brightness_color(ratio, name = nil)
+    def with_brightness(ratio, name = nil)
       generate_new_color(Converter::Brightness, ratio, name)
     end
 
@@ -128,7 +130,7 @@ module ColorContrastCalc
     #   code is assigned instead.
     # @return [Color] New inverted color
 
-    def new_invert_color(ratio = 100, name = nil)
+    def with_invert(ratio = 100, name = nil)
       generate_new_color(Converter::Invert, ratio, name)
     end
 
@@ -141,7 +143,7 @@ module ColorContrastCalc
     #   code is assigned instead.
     # @return [Color] New hue rotation applied color
 
-    def new_hue_rotate_color(degree, name = nil)
+    def with_hue_rotate(degree, name = nil)
       generate_new_color(Converter::HueRotate, degree, name)
     end
 
@@ -154,7 +156,7 @@ module ColorContrastCalc
     #   code is assigned instead.
     # @return [Color] New saturated color
 
-    def new_saturate_color(ratio, name = nil)
+    def with_saturate(ratio, name = nil)
       generate_new_color(Converter::Saturate, ratio, name)
     end
 
@@ -167,7 +169,7 @@ module ColorContrastCalc
     #   code is assigned instead.
     # @return [Color] New grayscale color
 
-    def new_grayscale_color(ratio = 100, name = nil)
+    def with_grayscale(ratio = 100, name = nil)
       generate_new_color(Converter::Grayscale, ratio, name)
     end
 
@@ -290,7 +292,7 @@ module ColorContrastCalc
     # The max contrast in this context means that of colors modified
     # by the operation defined at
     # * {https://www.w3.org/TR/filter-effects/#funcdef-contrast}
-    # @return [Boolean] true if self.new_contrast_color(r) where r is
+    # @return [Boolean] true if self.with_contrast(r) where r is
     #   greater than 100 returns the same color as self.
 
     def max_contrast?

data/lib/color_contrast_calc/deprecated.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ColorContrastCalc
+  ##
+  # Collection of deprecated methods.
+
+  module Deprecated
+    def self.warn(old_method, new_method)
+      STDERR.puts "##{old_method} is deprecated. Use ##{new_method} instead"
+    end
+
+    module Color
+      # @deprecated Use {#with_contrast} instead
+      def new_contrast_color(ratio, name = nil)
+        Deprecated.warn(__method__, :with_contrast)
+        with_contrast(ratio, name)
+      end
+
+      # @deprecated Use {#with_brightness} instead
+      def new_brightness_color(ratio, name = nil)
+        Deprecated.warn(__method__, :with_brightness)
+        with_brightness(ratio, name)
+      end
+
+      # @deprecated Use {#with_invert} instead
+      def new_invert_color(ratio = 100, name = nil)
+        Deprecated.warn(__method__, :with_invert)
+        with_invert(ratio, name)
+      end
+
+      # @deprecated Use {#with_hue_rotate} instead
+      def new_hue_rotate_color(degree, name = nil)
+        Deprecated.warn(__method__, :with_hue_rotate)
+        with_hue_rotate(degree, name)
+      end
+
+      # @deprecated Use {#with_saturate} instead
+      def new_saturate_color(ratio, name = nil)
+        Deprecated.warn(__method__, :with_saturate)
+        with_saturate(ratio, name)
+      end
+
+      # @deprecated Use {#with_grayscale} instead
+      def new_grayscale_color(ratio = 100, name = nil)
+        Deprecated.warn(__method__, :with_grayscale)
+        with_grayscale(ratio, name)
+      end
+    end
+  end
+end

data/lib/color_contrast_calc/threshold_finder.rb

@@ -14,7 +14,7 @@ module ColorContrastCalc
     module Criteria
       # @private
 
-      def self.threshold_criteria(level, fixed_rgb, other_rgb)
+      def self.define(level, fixed_rgb, other_rgb)
         if should_scan_darker_side?(fixed_rgb, other_rgb)
           return ToDarkerSide.new(level, fixed_rgb)
         end
@@ -32,16 +32,15 @@ module ColorContrastCalc
       end
 
       class SearchDirection
-        attr_reader :level, :target_ratio, :fixed_luminance
+        attr_reader :target_contrast, :fixed_luminance
 
         def initialize(level, fixed_rgb)
-          @level = level
-          @target_ratio = Checker.level_to_ratio(level)
+          @target_contrast = Checker.level_to_ratio(level)
           @fixed_luminance = Checker.relative_luminance(fixed_rgb)
         end
 
         def sufficient_contrast?(rgb)
-          contrast_ratio(rgb) >= @target_ratio
+          contrast_ratio(rgb) >= @target_contrast
         end
 
         def contrast_ratio(rgb)
@@ -53,28 +52,28 @@ module ColorContrastCalc
       class ToDarkerSide < SearchDirection
         # @private
 
-        def round(r)
-          (r * 10).floor / 10.0
+        def round(ratio)
+          (ratio * 10).floor / 10.0
         end
 
         # @private
 
         def increment_condition(contrast_ratio)
-          contrast_ratio > @target_ratio
+          contrast_ratio > @target_contrast
         end
       end
 
       class ToBrighterSide < SearchDirection
         # @private
 
-        def round(r)
-          (r * 10).ceil / 10.0
+        def round(ratio)
+          (ratio * 10).ceil / 10.0
         end
 
         # @private
 
         def increment_condition(contrast_ratio)
-          @target_ratio > contrast_ratio
+          @target_contrast > contrast_ratio
         end
       end
     end
@@ -96,13 +95,55 @@ module ColorContrastCalc
 
       # @private
 
-      def sufficient_contrast?(fixed_rgb, other_rgb, level)
-        target_ratio = Checker.level_to_ratio(level)
-        ratio = Checker.contrast_ratio(fixed_rgb, other_rgb)
-        ratio >= target_ratio
+      def sufficient_contrast?(ref_luminance, rgb, criteria)
+        luminance = Checker.relative_luminance(rgb)
+        ratio = Checker.luminance_to_contrast_ratio(ref_luminance, luminance)
+        ratio >= criteria.target_contrast
       end
 
       private :sufficient_contrast?
+
+      def rgb_with_better_ratio(color, criteria, last_r, passing_r)
+        closest = rgb_with_ratio(color, last_r)
+
+        if passing_r && !criteria.sufficient_contrast?(closest)
+          return rgb_with_ratio(color, passing_r)
+        end
+
+        closest
+      end
+
+      private :rgb_with_better_ratio
+
+      # @private
+
+      def find_ratio(other_color, criteria, init_ratio, init_width)
+        target_contrast = criteria.target_contrast
+        r = init_ratio
+        passing_r = nil
+
+        FinderUtils.binary_search_width(init_width, 0.01) do |d|
+          contrast = criteria.contrast_ratio(rgb_with_ratio(other_color, r))
+
+          passing_r = r if contrast >= target_contrast
+          break if contrast == target_contrast
+
+          r += criteria.increment_condition(contrast) ? d : -d
+        end
+
+        [r, passing_r]
+      end
+
+      private :find_ratio
+
+      # @private
+
+      def rgb_with_ratio(rgb, ratio)
+        raise(NotImplementedError,
+              "Implement ##{__method__} with arguments #{rgb} and #{ratio}")
+      end
+
+      private :rgb_with_ratio
     end
 
     ##
@@ -126,19 +167,27 @@ module ColorContrastCalc
       #   adjusted from that of +other_rgb+
 
       def self.find(fixed_rgb, other_rgb, level = Checker::Level::AA)
-        criteria = Criteria.threshold_criteria(level, fixed_rgb, other_rgb)
+        criteria = Criteria.define(level, fixed_rgb, other_rgb)
         w = calc_upper_ratio_limit(other_rgb) / 2.0
 
         upper_rgb = upper_limit_rgb(criteria, other_rgb, w * 2)
         return upper_rgb if upper_rgb
 
-        r, sufficient_r = calc_brightness_ratio(other_rgb, criteria, w)
+        last_r, passing_r = find_ratio(other_rgb, criteria, w, w).map do |ratio|
+          criteria.round(ratio) if ratio
+        end
+
+        rgb_with_better_ratio(other_rgb, criteria, last_r, passing_r)
+      end
 
-        generate_satisfying_color(other_rgb, criteria, r, sufficient_r)
+      def self.rgb_with_ratio(rgb, ratio)
+        Converter::Brightness.calc_rgb(rgb, ratio)
       end
 
+      private_class_method :rgb_with_ratio
+
       def self.upper_limit_rgb(criteria, other_rgb, max_ratio)
-        limit_rgb = Converter::Brightness.calc_rgb(other_rgb, max_ratio)
+        limit_rgb = rgb_with_ratio(other_rgb, max_ratio)
         limit_rgb if exceed_upper_limit?(criteria, other_rgb, limit_rgb)
       end
 
@@ -152,44 +201,6 @@ module ColorContrastCalc
 
       private_class_method :exceed_upper_limit?
 
-      def self.calc_brightness_ratio(other_rgb, criteria, w)
-        target_ratio = criteria.target_ratio
-        r = w
-        sufficient_r = nil
-
-        FinderUtils.binary_search_width(w, 0.01) do |d|
-          contrast_ratio = calc_contrast_ratio(criteria, other_rgb, r)
-
-          sufficient_r = r if contrast_ratio >= target_ratio
-          break if contrast_ratio == target_ratio
-
-          r += criteria.increment_condition(contrast_ratio) ? d : -d
-        end
-
-        [r, sufficient_r]
-      end
-
-      private_class_method :calc_brightness_ratio
-
-      def self.generate_satisfying_color(other_rgb, criteria, r, sufficient_r)
-        nearest = Converter::Brightness.calc_rgb(other_rgb, criteria.round(r))
-
-        if sufficient_r && !criteria.sufficient_contrast?(nearest)
-          return Converter::Brightness.calc_rgb(other_rgb,
-                                                criteria.round(sufficient_r))
-        end
-
-        nearest
-      end
-
-      private_class_method :generate_satisfying_color
-
-      def self.calc_contrast_ratio(criteria, other_rgb, r)
-        criteria.contrast_ratio(Converter::Brightness.calc_rgb(other_rgb, r))
-      end
-
-      private_class_method :calc_contrast_ratio
-
       # @private
 
       def self.calc_upper_ratio_limit(rgb)
@@ -221,68 +232,49 @@ module ColorContrastCalc
 
       def self.find(fixed_rgb, other_rgb, level = Checker::Level::AA)
         other_hsl = Utils.rgb_to_hsl(other_rgb)
-        criteria = Criteria.threshold_criteria(level, fixed_rgb, other_rgb)
+        criteria = Criteria.define(level, fixed_rgb, other_rgb)
         max, min = determine_minmax(fixed_rgb, other_rgb, other_hsl[2])
 
-        boundary_color = lightness_boundary_color(fixed_rgb, max, min, level)
-        return boundary_color if boundary_color
+        boundary_rgb = lightness_boundary_rgb(fixed_rgb, max, min, criteria)
+        return boundary_rgb if boundary_rgb
 
-        l, sufficient_l = calc_lightness_ratio(other_hsl, criteria, max, min)
+        last_l, passing_l = find_ratio(other_hsl, criteria,
+                                       (max + min) / 2.0, max - min)
 
-        generate_satisfying_color(other_hsl, criteria, l, sufficient_l)
+        rgb_with_better_ratio(other_hsl, criteria, last_l, passing_l)
       end
 
-      def self.determine_minmax(fixed_rgb, other_rgb, init_l)
-        scan_darker_side = Criteria.should_scan_darker_side?(fixed_rgb,
-                                                             other_rgb)
-        scan_darker_side ? [init_l, 0] : [100, init_l] # [max, min]
-      end
-
-      private_class_method :determine_minmax
-
-      def self.lightness_boundary_color(rgb, max, min, level)
-        if min.zero? && !sufficient_contrast?(Rgb::BLACK, rgb, level)
-          return Rgb::BLACK
+      def self.rgb_with_ratio(hsl, ratio)
+        if hsl[2] != ratio
+          hsl = hsl.dup
+          hsl[2] = ratio
         end
 
-        if max == 100 && !sufficient_contrast?(Rgb::WHITE, rgb, level)
-          return Rgb::WHITE
-        end
+        Utils.hsl_to_rgb(hsl)
       end
 
-      private_class_method :lightness_boundary_color
+      private_class_method :rgb_with_ratio
 
-      def self.calc_lightness_ratio(other_hsl, criteria, max, min)
-        h, s, = other_hsl
-        l = (max + min) / 2.0
-        sufficient_l = nil
-
-        FinderUtils.binary_search_width(max - min, 0.01) do |d|
-          contrast_ratio = criteria.contrast_ratio(Utils.hsl_to_rgb([h, s, l]))
-
-          sufficient_l = l if contrast_ratio >= criteria.target_ratio
-          break if contrast_ratio == criteria.target_ratio
-
-          l += criteria.increment_condition(contrast_ratio) ? d : -d
-        end
-
-        [l, sufficient_l]
+      def self.determine_minmax(fixed_rgb, other_rgb, init_l)
+        on_darker_side = Criteria.should_scan_darker_side?(fixed_rgb, other_rgb)
+        on_darker_side ? [init_l, 0] : [100, init_l] # [max, min]
       end
 
-      private_class_method :calc_lightness_ratio
-
-      def self.generate_satisfying_color(other_hsl, criteria, l, sufficient_l)
-        h, s, = other_hsl
-        nearest = Utils.hsl_to_rgb([h, s, l])
+      private_class_method :determine_minmax
 
-        if sufficient_l && !criteria.sufficient_contrast?(nearest)
-          return Utils.hsl_to_rgb([h, s, sufficient_l])
+      def self.lightness_boundary_rgb(rgb, max, min, criteria)
+        if min.zero? && !sufficient_contrast?(Checker::Luminance::BLACK,
+                                              rgb, criteria)
+          return Rgb::BLACK
         end
 
-        nearest
+        if max == 100 && !sufficient_contrast?(Checker::Luminance::WHITE,
+                                               rgb, criteria)
+          return Rgb::WHITE
+        end
       end
 
-      private_class_method :generate_satisfying_color
+      private_class_method :lightness_boundary_rgb
     end
   end
 end

data/lib/color_contrast_calc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: color_contrast_calc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - HASHIMOTO, Naoki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - lib/color_contrast_calc/color.rb
 - lib/color_contrast_calc/converter.rb
 - lib/color_contrast_calc/data/color_keywords.json
+- lib/color_contrast_calc/deprecated.rb
 - lib/color_contrast_calc/shim.rb
 - lib/color_contrast_calc/sorter.rb
 - lib/color_contrast_calc/threshold_finder.rb