Complementary_Color 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec54df84e82c8d5385915c2bf31ad6bb7355221535c7c9124d2b16425dfa1b54
-  data.tar.gz: d356ac4c22b9d35541323924b5d041e596c368e897ed8ef5f8d5bd2ff22e3707
+  metadata.gz: 31fc734fd0d69856e69bf70761225878595b441d53ca0553d9fff8143ca1b018
+  data.tar.gz: e9289443a4de434a4c00a46745b3564f237d89f13f39c715fea591d2782efc65
 SHA512:
-  metadata.gz: 6117506e43ce939592afb5dc7e5e5e259502fd9b974d2532e53c21ba0b0fc649c00dfb77fafc0e6993f14f8213624da64d1aad9e44479f9257ed66ce74017071
-  data.tar.gz: c3d5e12cd38c69193a560c76ad7a06b18ca24062fc311ac2fa77a97a99c44d703a4e1aec54e58835a88f3ce0aeeed681a41bcd4d98395059163194bdd6dba60c
+  metadata.gz: ad43f1a51ccda5e578a3f330ddbcb309ca801211181c7dc3b67171b39ec06dbd31d37dc0a82d65a59830f3acde0fc21ff38dcc8e36245051bee94cef7e73c425
+  data.tar.gz: f8d7b4096909ef0c53d632bfdd89893a64f5bdd6123c08deffa3e0499d8d1473ee9ea9b5c0252554bfbdda2e66f85991a903e0fedd9ec62ecfb9ef1297b1d14d

data/CHANGELOG.md

@@ -1,7 +0,0 @@
-## [0.1.1] - 2022-06-24
-
-- First functionality added
-
-## [0.1.0] - 2022-06-21
-
-- Initial release

data/README.md

@@ -1,5 +1,8 @@
 # ColoR
 
+[![Gem Version](https://badge.fury.io/rb/Complementary_Color.svg)](https://badge.fury.io/rb/Complementary_Color)
+[![Test + Lint](https://github.com/TimHi/Compelementary-Color/actions/workflows/main.yml/badge.svg)](https://github.com/TimHi/Compelementary-Color/actions/workflows/main.yml)
+
 ColoR's main aspect is the creation of complementary color palettes. It also offers RGB to hex conversions.
 
 ## Installation

data/lib/color/error/hex_code_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Error class to capture illegal hex codes being passed to the class.
+class HexCodeError < StandardError
+  attr_reader :wrong_color
+
+  def initialize(wrong_color)
+    super
+    @wrong_color = wrong_color
+  end
+end

data/lib/color/hex.rb

@@ -9,7 +9,12 @@ module Hex
     long_hex_color.downcase
   end
 
-  def self.hex?(color)
-    color.match("^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$")
+  # Test wether a given color is a valid hex color.
+  def self.hex?(color_to_test)
+    if color_to_test.is_a? String
+      color_to_test.match("^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$")
+    else
+      false
+    end
   end
 end

data/lib/color/hsv.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Offering functionality related to the HSV color model.
+module HSV
+  HUE_MULTIPLIER = 60
+  RGB_MAX_VALUE = 255
+  ROUND_VALUE = 3
+  FULL_CIRCLE_DEG = 360
+  MONO_SATURATION = 0.2
+  MONO_VALUE = 0.1
+
+  # Hex Colors can be represented with three characters, to work
+  def self.rgb_to_hsv(rgb_color)
+    max = rgb_color.max()
+    min = rgb_color.min()
+    r = rgb_color[0]
+    g = rgb_color[1]
+    b = rgb_color[2]
+
+    value = (max.to_f / RGB_MAX_VALUE).round(ROUND_VALUE)
+    max_min_diff = max - min
+    hue = calculate_hue(r, g, b, max_min_diff)
+    hue += FULL_CIRCLE_DEG if hue.negative?
+    [hue.round, calculate_saturation(max_min_diff, max, value), value]
+  end
+
+  def self.calculate_saturation(max_min_diff, max, value)
+    saturation = 0
+    saturation = (max_min_diff.to_f / max).round(ROUND_VALUE) if value.positive?
+    saturation
+  end
+
+  # Method to calculate the hue value of three given rgb colors and the difference
+  # of the max - min color.
+  def self.calculate_hue(red, green, blue, max_min_diff)
+    if red > green && red > blue
+      HUE_MULTIPLIER * calculate_raw_hue_value(0, green, blue, max_min_diff)
+    elsif green > red && green > blue
+      HUE_MULTIPLIER * calculate_raw_hue_value(2, blue, red, max_min_diff)
+    elsif blue > red && blue > green
+      HUE_MULTIPLIER * calculate_raw_hue_value(4, red, green, max_min_diff)
+    else
+      0
+    end
+  end
+
+  def self.calculate_raw_hue_value(offset, first_color, second_color, max_min_diff)
+    offset + ((first_color - second_color).to_f / max_min_diff).round(ROUND_VALUE)
+  end
+
+  # Calculate the a monochromatic value to a given color
+  def self.calculate_monochromatic_color(hue_color)
+    saturation = hue_color[1]
+    value = hue_color[2]
+    if saturation > 0.7
+      saturation -= MONO_SATURATION
+    else
+      saturation += MONO_SATURATION
+    end
+    value -= MONO_VALUE
+    [hue_color[0], saturation.round(ROUND_VALUE), value]
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  def self.hsv_to_rgb(hue, saturation, value)
+    hue = hue.to_f / FULL_CIRCLE_DEG
+
+    hue_i = (hue * 6).to_i
+    f = (hue * 6) - hue_i
+    p = value * (1 - saturation)
+    q = value * (1 - (f * saturation))
+    t = value * (1 - ((1 - f) * saturation))
+    if hue_i.zero?
+      red = value
+      green = t
+      blue = p
+    end
+    if hue_i == 1
+      red = q
+      green = value
+      blue = p
+    end
+    if hue_i == 2
+      red = p
+      green = value
+      blue = t
+    end
+    if hue_i == 3
+      red = p
+      green = q
+      blue = value
+    end
+    if hue_i == 4
+      red = t
+      green = p
+      blue = value
+    end
+    if hue_i == 5
+      red = value
+      green = p
+      blue = q
+    end
+    [(red * RGB_MAX_VALUE).round.abs, (green * RGB_MAX_VALUE).round.abs, (blue * RGB_MAX_VALUE).round.abs]
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+end

data/lib/color/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ColoR
-  VERSION = "0.1.1"
+  VERSION = "0.1.5"
 end

data/lib/color.rb

@@ -1,21 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "color/version"
+require "color/error/hex_code_error"
 
 # Offering functionality to get the complementary colors of a given input.
 module ColoR
   class Error < StandardError; end
 
-  # Error class to capture illegal hex codes being passed to the class.
-  class HexCodeError < StandardError
-    attr_reader :wrong_color
-
-    def initialize(wrong_color)
-      super
-      @wrong_color = wrong_color
-    end
-  end
-
   def self.get_complementary_color(color)
     raise HexCodeError.new("Not a valid Hex Color"), color unless ::Hex.hex?(color)
 
@@ -23,4 +14,14 @@ module ColoR
     comp_r = [255 - rgb_color[0], 255 - rgb_color[1], 255 - rgb_color[2]]
     ::RGB.rgb_to_hex(comp_r)
   end
+
+  def self.get_monochromatic_color(color)
+    raise HexCodeError.new("Not a valid Hex Color"), color unless ::Hex.hex?(color)
+
+    rgb_color = ::RGB.hex_to_rgb(color)
+    hue_color = ::HSV.rgb_to_hsv(rgb_color)
+    mono_color = ::HSV.calculate_monochromatic_color(hue_color)
+    mono_rgb = ::HSV.hsv_to_rgb(mono_color[0], mono_color[1], mono_color[2])
+    ::RGB.rgb_to_hex(mono_rgb)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Complementary_Color
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Tim Hiller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies: []
 description: Create complementary colors based on a given color.
 email:
@@ -24,12 +24,15 @@ files:
 - README.md
 - Rakefile
 - lib/color.rb
+- lib/color/error/hex_code_error.rb
 - lib/color/hex.rb
+- lib/color/hsv.rb
 - lib/color/rgb.rb
 - lib/color/version.rb
 - sig/color.rbs
 homepage: https://github.com/TimHi/coloR
-licenses: []
+licenses:
+- AGPL-3.0-or-later
 metadata:
   homepage_uri: https://github.com/TimHi/coloR
   source_code_uri: https://github.com/TimHi/coloR
@@ -53,5 +56,5 @@ requirements: []
 rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
-summary: Create complementary colors based on a given color.
+summary: Generate complementary colors based on a given color.
 test_files: []