color_contrast_calc 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 513b56ff5dca5ea3a6a7343a4cc5111a19c976e2
-  data.tar.gz: 9958f22f8d1474b93a3573ce728ffe6e41abe6d7
+  metadata.gz: 5a62e36d449991a9381385e68fcf0c2e8201bdbc
+  data.tar.gz: 1053f1e6a889f8062ab53de73eaf1f92c434785f
 SHA512:
-  metadata.gz: ebf3189b2a716538c29fe3c3730e47f79d9a51fba4d53989269fe20f9a56e0225ee38e105936aa2c05844b3fb4925243feeefa9c670733975f82b46eabb15c2d
-  data.tar.gz: 5c6b613c861aaa290e31d1c1c710c6d7775beb742f43c896f25e7c10bf1b890cc7833ebe7f37b8b4c5727bc1ce68eb4ad9c8916f8bc853fc8f47d405ac2d34ec
+  metadata.gz: 1b51b39ef9e836dcf205883dba7a3ee96a3844eab201e799a012e22e85e88a4c69cdbe03d11f7d5f9fa1069c972034496c6c1b8e30d2a90b98b8bce04932d780
+  data.tar.gz: 49891f3150bdb8bf43831efe09150889109b9eaf9d0244ec5a4101d07dd77878caf82faa4831ea3779224ae46895daeebcef351ad38c9b958544ee7a24c3554d

data/lib/color_contrast_calc.rb

@@ -9,33 +9,22 @@ require 'color_contrast_calc/color'
 require 'color_contrast_calc/sorter'
 
 module ColorContrastCalc
-  ##
-  # Error raised if creating a Color instance with invalid value.
-
-  class InvalidColorRepresentationError < StandardError; end
-
   ##
   # Return an instance of Color.
   #
   # As +color_value+, you can pass a predefined color name, or an
   # RGB value represented as an array of integers or a hex code such
   # as [255, 255, 0] or "#ffff00". +name+ is assigned to the returned
-  # instance if it does not have a name already assigned.
+  # instance.
   # @param color_value [String, Array<Integer>] Name of a predefined
-  #   color or RGB value
-  # @param name [String] Unless the instance has predefined name, the
-  #   name passed to the method is set to self.name
+  #   color, hex color code or RGB value
+  # @param name [String] Without specifying a name, a color keyword name
+  #   (if exists) or the value of normalized hex color code is assigned
+  #   to Color#name
   # @return [Color] Instance of Color
 
   def self.color_from(color_value, name = nil)
-    error_message = 'A color should be given as an array or string.'
-
-    if !color_value.is_a?(String) && !color_value.is_a?(Array)
-      raise InvalidColorRepresentationError, error_message
-    end
-
-    return color_from_rgb(color_value, name) if color_value.is_a?(Array)
-    color_from_str(color_value, name)
+    Color.color_from(color_value, name)
   end
 
   ##
@@ -101,33 +90,4 @@ module ColorContrastCalc
   def self.hsl_colors(s: 100, l: 50, h_interval: 1)
     Color::List.hsl_colors(s: s, l: l, h_interval: h_interval)
   end
-
-  def self.color_from_rgb(color_value, name = nil)
-    error_message = 'An RGB value should be given in form of [r, g, b].'
-
-    unless Utils.valid_rgb?(color_value)
-      raise InvalidColorRepresentationError, error_message
-    end
-
-    hex_code = Utils.rgb_to_hex(color_value)
-    Color::List::HEX_TO_COLOR[hex_code] || Color.new(color_value, name)
-  end
-
-  private_class_method :color_from_rgb
-
-  def self.color_from_str(color_value, name = nil)
-    error_message = 'A hex code is in form of "#xxxxxx" where 0 <= x <= f.'
-
-    named_color = Color::List::NAME_TO_COLOR[color_value]
-    return named_color if named_color
-
-    unless Utils.valid_hex?(color_value)
-      raise InvalidColorRepresentationError, error_message
-    end
-
-    hex_code = Utils.normalize_hex(color_value)
-    Color::List::HEX_TO_COLOR[hex_code] || Color.new(hex_code, name)
-  end
-
-  private_class_method :color_from_str
 end

data/lib/color_contrast_calc/color.rb

@@ -7,6 +7,11 @@ require 'color_contrast_calc/deprecated'
 require 'json'
 
 module ColorContrastCalc
+  ##
+  # Error raised if creating a Color instance with invalid value.
+
+  class InvalidColorRepresentationError < StandardError; end
+
   ##
   # Represent specific colors.
   #
@@ -15,6 +20,144 @@ module ColorContrastCalc
 
   class Color
     include Deprecated::Color
+
+    ##
+    # Module that implements class methods of Color
+
+    module Factory
+      include Deprecated::Color::Factory
+
+      ##
+      # Return an instance of Color for a predefined color name.
+      #
+      # Color names are defined at
+      # * {https://www.w3.org/TR/SVG/types.html#ColorKeywords}
+      # @param name [String] Name of color
+      # @return [Color] Instance of Color
+
+      def from_name(name)
+        List::NAME_TO_COLOR[name.downcase]
+      end
+
+      ##
+      # Return an instance of Color for an RGB value
+      #
+      # @param rgb [Array<Integer>] RGB value represented as an
+      #   array of integers such as [255, 255, 0]
+      # @param name [String] You can name the color to be created
+      # @return [Color] Instance of Color
+
+      def from_rgb(rgb, name = nil)
+        !name && List::HEX_TO_COLOR[Utils.rgb_to_hex(rgb)] ||
+          Color.new(rgb, name)
+      end
+
+      ##
+      # Return an instance of Color for a hex color code.
+      #
+      # @param hex [String] Hex color code such as "#ffff00"
+      # @param name [String] You can name the color to be created
+      # @return [Color] Instance of Color
+
+      def from_hex(hex, name = nil)
+        normalized_hex = Utils.normalize_hex(hex)
+        !name && List::HEX_TO_COLOR[normalized_hex] ||
+          Color.new(normalized_hex, name)
+      end
+
+      ##
+      # Return an instance of Color from an HSL value.
+      #
+      # @param hsl [Float] HSL value represented as an array of numbers
+      # @param name [String] You can name the color to be created
+      # @return [Color] Instance of Color
+
+      def from_hsl(hsl, name = nil)
+        rgb = Utils.hsl_to_rgb(hsl)
+        !name && List::HEX_TO_COLOR[Utils.rgb_to_hex(rgb)] ||
+          Color.new(rgb, name)
+      end
+
+      ##
+      # Return an instance of Color.
+      #
+      # As +color_value+, you can pass a predefined color name, or an
+      # RGB value represented as an array of integers or a hex code such
+      # as [255, 255, 0] or "#ffff00". +name+ is assigned to the returned
+      # instance.
+      # @param color_value [String, Array<Integer>] Name of a predefined
+      #   color, hex color code or RGB value
+      # @param name [String] Without specifying a name, a color keyword name
+      #   (if exists) or the value of normalized hex color code is assigned
+      #   to Color#name
+      # @return [Color] Instance of Color
+
+      def color_from(color_value, name = nil)
+        error_message = 'A color should be given as an array or string.'
+
+        if !color_value.is_a?(String) && !color_value.is_a?(Array)
+          raise InvalidColorRepresentationError, error_message
+        end
+
+        return color_from_rgb(color_value, name) if color_value.is_a?(Array)
+        color_from_str(color_value, name)
+      end
+
+      ##
+      # Return an instance of Color.
+      #
+      # As +color_value+, you can pass a Color instance, a predefined color
+      # name, or an RGB value represented as an array of integers or a hex
+      # code such as [255, 255, 0] or "#ffff00". +name+ is assigned to the
+      # returned instance.
+      # @param color_value [Color, String, Array<Integer>] An instance of
+      #   Color, a name of a predefined, color, hex color code or RGB value
+      # @param name [String] Without specifying a name, a color keyword name
+      #   (if exists) or the value of normalized hex color code is assigned
+      #   to Color#name
+      # @return [Color] Instance of Color
+
+      def as_color(color_value, name = nil)
+        if color_value.is_a? Color
+          return color_value if color_value.name == name
+          color_value = color_value.rgb
+        end
+
+        color_from(color_value, name)
+      end
+
+      def color_from_rgb(rgb_value, name = nil)
+        error_message = 'An RGB value should be given in form of [r, g, b].'
+
+        unless Utils.valid_rgb?(rgb_value)
+          raise InvalidColorRepresentationError, error_message
+        end
+
+        hex_code = Utils.rgb_to_hex(rgb_value)
+        !name && List::HEX_TO_COLOR[hex_code] || Color.new(rgb_value, name)
+      end
+
+      private :color_from_rgb
+
+      def color_from_str(color_value, name = nil)
+        error_message = 'A hex code is in form of "#xxxxxx" where 0 <= x <= f.'
+
+        named_color = !name && List::NAME_TO_COLOR[color_value]
+        return named_color if named_color
+
+        unless Utils.valid_hex?(color_value)
+          raise InvalidColorRepresentationError, error_message
+        end
+
+        hex_code = Utils.normalize_hex(color_value)
+        !name && List::HEX_TO_COLOR[hex_code] || Color.new(hex_code, name)
+      end
+
+      private :color_from_str
+    end
+
+    extend Factory
+
     # @private
     RGB_LIMITS = [0, 255].freeze
 
@@ -30,54 +173,20 @@ module ColorContrastCalc
 
     attr_reader :rgb, :hex, :name, :relative_luminance
 
-    ##
-    # Return an instance of Color for a predefined color name.
-    #
-    # Color names are defined at
-    # * {https://www.w3.org/TR/SVG/types.html#ColorKeywords}
-    # @param name [String] Name of color
-    # @return [Color] Instance of Color
-
-    def self.from_name(name)
-      List::NAME_TO_COLOR[name.downcase]
-    end
-
-    ##
-    # Return an instance of Color for a hex color code.
-    #
-    # @param hex [String] Hex color code such as "#ffff00"
-    # @return [Color] Instance of Color
-
-    def self.from_hex(hex)
-      normalized_hex = Utils.normalize_hex(hex)
-      List::HEX_TO_COLOR[normalized_hex] || Color.new(normalized_hex)
-    end
-
-    ##
-    # Create an instance of Color from an HSL value.
-    #
-    # @param hsl [Float] HSL value represented as an array of numbers
-    # @param name [String] You can name the color to be created
-    # @return [Color] Instance of Color
-
-    def self.new_from_hsl(hsl, name = nil)
-      new(Utils.hsl_to_rgb(hsl), name)
-    end
-
     ##
     # Create a new instance of Color.
     #
     # @param rgb [Array<Integer>, String] RGB value represented as an array
     #   of integers or hex color code such as [255, 255, 0] or "#ffff00".
     # @param name [String] You can name the color to be created.
-    #   Without this option, the value of normalized hex color code is
-    #   assigned instead.
+    #   Without this option, a color keyword name (if exists) or the value
+    #   of normalized hex color code is assigned instead.
     # @return [Color] New instance of Color
 
     def initialize(rgb, name = nil)
       @rgb = rgb.is_a?(String) ? Utils.hex_to_rgb(rgb) : rgb
       @hex = Utils.rgb_to_hex(@rgb)
-      @name = name || @hex
+      @name = name || common_name
       @relative_luminance = Checker.relative_luminance(@rgb)
     end
 
@@ -85,7 +194,7 @@ module ColorContrastCalc
     # Return HSL value of the color.
     #
     # The value is calculated from the RGB value, so if you create
-    # the instance by Color.new_from_hsl method, the value used to
+    # the instance by Color.from_hsl method, the value used to
     # create the color does not necessarily correspond to the value
     # of this property.
     #
@@ -95,6 +204,18 @@ module ColorContrastCalc
       @hsl ||= Utils.rgb_to_hsl(@rgb)
     end
 
+    ##
+    # Return a {https://www.w3.org/TR/SVG/types.html#ColorKeywords
+    # color keyword name} when the name corresponds to the hex code
+    # of the color. Otherwise the hex code will be returned.
+    #
+    # @return [String] Color keyword name or hex color code
+
+    def common_name
+      named_color = List::HEX_TO_COLOR[@hex]
+      named_color && named_color.name || @hex
+    end
+
     ##
     # Return a new instance of Color with adjusted contrast.
     #
@@ -402,7 +523,7 @@ module ColorContrastCalc
       #   saturation and lightness
 
       def self.hsl_colors(s: 100, l: 50, h_interval: 1)
-        0.step(360, h_interval).map {|h| Color.new_from_hsl([h, s, l]) }.freeze
+        0.step(360, h_interval).map {|h| Color.from_hsl([h, s, l]) }.freeze
       end
     end
 

data/lib/color_contrast_calc/converter.rb

@@ -33,7 +33,7 @@ module ColorContrastCalc
       ##
       # Return contrast adjusted RGB value of passed color.
       #
-      # THe calculation is based on the definition found at
+      # The calculation is based on the definition found at
       # https://www.w3.org/TR/filter-effects/#funcdef-contrast
       # https://www.w3.org/TR/SVG/filters.html#TransferFunctionElementAttributes
       # @param rgb [Array<Integer>] The Original RGB value before the adjustment
@@ -50,7 +50,7 @@ module ColorContrastCalc
       ##
       # Return brightness adjusted RGB value of passed color.
       #
-      # THe calculation is based on the definition found at
+      # The calculation is based on the definition found at
       # https://www.w3.org/TR/filter-effects/#funcdef-brightness
       # https://www.w3.org/TR/SVG/filters.html#TransferFunctionElementAttributes
       # @param rgb [Array<Integer>] The Original RGB value before the adjustment
@@ -100,7 +100,7 @@ module ColorContrastCalc
       ##
       # Return a hue rotation applied RGB value of passed color.
       #
-      # THe calculation is based on the definition found at
+      # The calculation is based on the definition found at
       # https://www.w3.org/TR/filter-effects/#funcdef-hue-rotate
       # https://www.w3.org/TR/SVG/filters.html#TransferFunctionElementAttributes
       # @param rgb [Array<Integer>] The Original RGB value before the rotation
@@ -166,7 +166,7 @@ module ColorContrastCalc
                           [-0.2126, -0.7152, 0.9278]]
 
       ##
-      # Convert passed a passed color to grayscale.
+      # Convert a passed color to grayscale.
       #
       # The calculation is based on the definition found at
       # https://www.w3.org/TR/filter-effects/#funcdef-grayscale

data/lib/color_contrast_calc/deprecated.rb

@@ -10,6 +10,15 @@ module ColorContrastCalc
     end
 
     module Color
+      module Factory
+        ##
+        # @deprecated Use Color.from_hsl() instead.
+        def new_from_hsl(hsl, name = nil)
+          Deprecated.warn(__method__, :from_hsl)
+          new(Utils.hsl_to_rgb(hsl), name)
+        end
+      end
+
       # @deprecated Use {#with_contrast} instead
       def new_contrast_color(ratio, name = nil)
         Deprecated.warn(__method__, :with_contrast)

data/lib/color_contrast_calc/shim.rb

@@ -11,9 +11,7 @@ module ColorContrastCalc
       # and the following implementation does not satisfy
       # the full specification of the original method.
 
-      def match?(str)
-        self === str
-      end
+      alias_method(:match?, :===)
     end
 
     refine Numeric do

data/lib/color_contrast_calc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: color_contrast_calc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - HASHIMOTO, Naoki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler