Complementary_Color 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a380970a605d79d87714bc1b170012bd7eb4582eea80ed232807c6638d82f84
-  data.tar.gz: afe9ddc86fd328eb4b90a7aa008e09a424ed93d07eb31f1adaf93004ed03cb3a
+  metadata.gz: fdbb722fb1da4e0fabc995ca007b9478d68104347ab4b396b9731be07b10b3d8
+  data.tar.gz: d136d63e85a53fbfc35e455801eae0a7c6d85b5e46b6978745ae196d464a8e9f
 SHA512:
-  metadata.gz: 67c6835e8679f615226ec4ec699440cabcfec133369c997fb4265779f4192438de35ead8cfdfc821bcf0d0326f8ad41cde30e673e7b6e6f89b01c9e4b17623d7
-  data.tar.gz: c359d74408e6bb159c6c15d336e5b602cb64d5b2100de28a54df178053341bbe2f2938d70fc1631eb79c6e93aeeef58ea8d3a11d24bd5fa9cae55c1131df1293
+  metadata.gz: 40b5ea2d69c6f06341d790bbc914d23c475fb9a7e188ee22ddd4e362f23370a78a8145c68e46e0787e201520e7e348c067407d96019029f03d4f082d67398c2a
+  data.tar.gz: c8a3e6f543460f31db7b4067cdaf4073e2e1706eefb910b2be1e45b1dcc4b85eb690ebd0b30c79208a5d8d73c6de950e18335b110f934e5cffaf5b297850d26d

data/CHANGELOG.md

@@ -1,56 +1,15 @@
-## [0.1.1] - 2022-06-24
+# Changelog
 
-- First functionality added
-
-## [0.7.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.6.0...v0.7.0) (2022-06-25)
-
-
-### Features
-
-* test ([90475db](https://www.github.com/TimHi/Compelementary-Color/commit/90475db7a6b65740e69d02004b058531aa86497c))
-
-## [0.6.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.5.0...v0.6.0) (2022-06-25)
-
-
-### Features
-
-* updating ci ([a50944c](https://www.github.com/TimHi/Compelementary-Color/commit/a50944c43d0dc3d3f996557b325a96ce17920aba))
-
-## [0.5.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.4.0...v0.5.0) (2022-06-25)
-
-
-### Features
-
-* dummy commit to test action ([bf86695](https://www.github.com/TimHi/Compelementary-Color/commit/bf8669576ce8bb18f423d5d840353cee657a1fdd))
-
-## [0.4.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.3.0...v0.4.0) (2022-06-25)
-
-
-### Features
-
-* test release ([eb004cd](https://www.github.com/TimHi/Compelementary-Color/commit/eb004cd523dbed9bf20d2b2d33eb0f4e1410771c))
-
-## [0.3.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.2.0...v0.3.0) (2022-06-25)
+## [0.10.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.9.0...v0.10.0) (2022-07-10)
 
 
 ### Features
 
-* dummy commit to test action ([4aa8117](https://www.github.com/TimHi/Compelementary-Color/commit/4aa81179154c56334191525e4dccb5ca054ea440))
+* adding analogous color function ([31691d6](https://www.github.com/TimHi/Compelementary-Color/commit/31691d6de3cf9eb69f0da4647e05a5ffc862672c))
 
-## [0.2.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.1.0...v0.2.0) (2022-06-25)
+## [0.9.0](https://www.github.com/TimHi/Compelementary-Color/compare/v0.8.0...v0.9.0) (2022-06-29)
 
 
 ### Features
 
-* adding new tests ([1c4807e](https://www.github.com/TimHi/Compelementary-Color/commit/1c4807e2a762d084bd0e089c0b09c31b2854b2b1))
-
-## 0.1.0 (2022-06-25)
-
-
-### Features
-
-* dummy commit to test action ([6779bd9](https://www.github.com/TimHi/Compelementary-Color/commit/6779bd92d9621a8ba1a63e1868ae4f9f82fab89a))
-
-## [0.1.0] - 2022-06-21
-
-- Initial release
+* creating release for monochromatic color generation ([06b84d0](https://www.github.com/TimHi/Compelementary-Color/commit/06b84d0e751238a103a2ede5e294588b811a8e54))

data/Gemfile

@@ -12,3 +12,5 @@ gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
 
 gem "simplecov", require: false, group: :test
+
+gem "shoulda", "~> 4.0"

data/lib/color/hsv.rb

@@ -0,0 +1,116 @@
+# 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
+
+  # Add a value to the hue component of a hsv color
+  # Ensures that the hue is still in the range 0..360
+  def self.add_hue_to_hsv(hue_value, hsv_color_to_add)
+    hsv_color_to_add[0] += hue_value
+    hsv_color_to_add[0] %= FULL_CIRCLE_DEG
+    hsv_color_to_add
+  end
+
+  # 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.3"
+  VERSION = "0.1.6"
 end

data/lib/color.rb

@@ -14,4 +14,33 @@ 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)
+
+    hue_color = hex_to_hsv(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
+
+  def self.get_analogous_scheme(color)
+    raise HexCodeError.new("Not a valid Hex Color"), color unless ::Hex.hex?(color)
+
+    hsv_color = hex_to_hsv(color)
+    analogous_colors = []
+    analogous_colors.push(hsv_to_hex(HSV.add_hue_to_hsv(15, [hsv_color[0], hsv_color[1], hsv_color[2]])))
+    analogous_colors.push(hsv_to_hex(HSV.add_hue_to_hsv(330, [hsv_color[0], hsv_color[1], hsv_color[2]])))
+    analogous_colors
+  end
+
+  def self.hex_to_hsv(hex_color)
+    rgb_color = ::RGB.hex_to_rgb(hex_color)
+    ::HSV.rgb_to_hsv(rgb_color)
+  end
+
+  def self.hsv_to_hex(hsv_color)
+    rgb_color = ::HSV.hsv_to_rgb(hsv_color[0], hsv_color[1], hsv_color[2])
+    ::RGB.rgb_to_hex(rgb_color)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Complementary_Color
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Tim Hiller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-25 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies: []
 description: Create complementary colors based on a given color.
 email:
@@ -26,6 +26,7 @@ files:
 - 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
@@ -36,7 +37,7 @@ metadata:
   homepage_uri: https://github.com/TimHi/coloR
   source_code_uri: https://github.com/TimHi/coloR
   changelog_uri: https://github.com/TimHi/coloR/blob/main/CHANGELOG.md
-  rubygems_mfa_required: 'false'
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -55,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: []