number_to_color 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be64228ca77648ab10e5c239d226580f8854abd8a1dae15fdd0bbb4359c62c70
-  data.tar.gz: 1a35483bb28f5432f19f4fbbdfecb57ed0a273f96c9943dc8bb461ff2e1b9225
+  metadata.gz: 4dc4be64719ba2808fd343499ee264d95c461160078d3399ae9df996fca16f2e
+  data.tar.gz: 54bca5fad8a30171842732d1f8d181c5eb334c5a39c88445aa726c7d87e8528d
 SHA512:
-  metadata.gz: 226c9da9e7d3181d1c9741b543265619f2a9250b75dbea40defeae64dad93962ab51b5293d62833cbb8a0b096767248e17d6f365332371589101ccb61be7c2ab
-  data.tar.gz: 8175102c43d3e21c12d59134e664884daa716bdf3f49beb49392a2a5535bd3d0e5f38e7b6b96502c3a8d4ffa8134813daadd36b3fa35c4f96b652992e30b9f8d
+  metadata.gz: 2d5310460412589e1455124d4775242b05b1a0195cc15181fd88c235f8d4e861368a3acce5ee04563dc12d7a4cfc31fa23a2e4a549619fa366686956daaa47df
+  data.tar.gz: 727bcb12d1bad08aa3fde47c71bd56ecadc4649a60daccc852d17eca65f26da64cacab6b2b2c9c1341eeb1cbd401b65409fdcee01e50d0f14bbde72e5bce9415

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    number_to_color (1.0.0)
+    number_to_color (2.0.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/number_to_color/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NumberToColor
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/number_to_color.rb

@@ -6,24 +6,17 @@ require_relative "number_to_color/version"
 #
 # @author Luke Fair <fair@hey.com>
 class ColorCode
-  # '#0ea5e9'
-  DEFAULT_END = [14, 165, 233].freeze
-  # 'f87171'
-  DEFAULT_START = [248, 113, 113].freeze
-  # 'fff'
-  DEFAULT_MIDDLE = [255, 255, 255].freeze
-
   # @param [Number] value The table cell's numerical value
   # @param [Array] domain - Two or three-element arrays (e.g., [0, 20], [-20, 0, 20])
-  # @param [String|Array] middle_color - The hex or rgb code to use for the middle color.
-  # @param [String|Array] end_color - The hex or rgb code to use for the end color.
-  # @param [String|Array] start_color - The hex or rgb code to use for the start color.
+  # @param [String|Array] middle_color - The hex or rgb code to use for the middle color (default `white`).
+  # @param [String|Array] end_color - The hex or rgb code to use for the end color (default `blue`).
+  # @param [String|Array] start_color - The hex or rgb code to use for the start color  (default `red`).
   def initialize(
     value:,
     domain: nil,
-    middle_color: nil,
-    end_color: nil,
-    start_color: nil
+    middle_color: [255, 255, 255],
+    end_color: [14, 165, 233],
+    start_color: [248, 113, 113]
   )
     @value = value.to_f
     @domain = domain
@@ -46,9 +39,9 @@ class ColorCode
               :middle_rgb
 
   def set_colors
-    @end_rgb = end_color ? format_color(end_color) : DEFAULT_END
-    @start_rgb = start_color ? format_color(start_color) : DEFAULT_START
-    @middle_rgb = middle_color ? format_color(middle_color) : DEFAULT_MIDDLE
+    @end_rgb = format_color(end_color)
+    @start_rgb = format_color(start_color)
+    @middle_rgb = format_color(middle_color)
   end
 
   # Returns the hex code for any RGB color.
@@ -61,9 +54,9 @@ class ColorCode
   # @param [String|Array] color The hex or rgb code.
   # @return [Array].
   def format_color(color)
-    return color.scan(/.{2}/).map(&:hex) if color.instance_of? String
+    return color.gsub("#", "").scan(/../).map(&:hex) if color.instance_of? String
 
-    color
+    color unless color.nil?
   end
 
   # If the domain is inverted, switch its order.
@@ -115,9 +108,9 @@ class ColorCode
   # Returns the start color in RGB format.
   # @return [Array].
   def start_color_rgb
-    return end_rgb if inverted_order? && value_is_start?
+    return end_rgb if inverted_order? && (value_is_in_starting_half? || two_item_domain?)
 
-    return start_rgb if value_is_start?
+    return start_rgb if value_is_in_starting_half? || two_item_domain?
 
     middle_rgb
   end
@@ -125,31 +118,31 @@ class ColorCode
   # Returns the end color in RGB format.
   # @return [Array].
   def end_color_rgb
-    return middle_rgb if value_is_start?
+    return middle_rgb if value_is_in_starting_half? && three_item_domain?
 
     return start_rgb if inverted_order?
 
     end_rgb
   end
 
-  # Returns if the value is considered start.
+  # Returns if the value is considered in the first half of the domain.
   # @return [Boolean].
-  def value_is_start?
-    clamped_value.between?(normalized_domain.first, mean_value) || clamped_value == mean_value
+  def value_is_in_starting_half?
+    three_item_domain? && (clamped_value.between?(normalized_domain.first, mean_value) || clamped_value == mean_value)
   end
 
-  # Returns the domain's min value, or what is considered 'start'.
+  # Returns the domain's min value.
   # @return [Number].
   def min_value
-    return mean_value unless value_is_start?
+    return mean_value unless value_is_in_starting_half? || two_item_domain?
 
     normalized_domain.first
   end
 
-  # Returns the domain's min value, or what is considered 'start'.
+  # Returns the domain's max value.
   # @return [Number].
   def max_value
-    return mean_value if value_is_start?
+    return mean_value if value_is_in_starting_half? && three_item_domain?
 
     normalized_domain.last
   end
@@ -185,4 +178,16 @@ class ColorCode
   def distance_difference
     1 - distance_from_min_value
   end
+
+  # Returns if the domain has two values.
+  # @return [Boolean].
+  def two_item_domain?
+    domain.length == 2
+  end
+
+  # Returns if the domain has three values.
+  # @return [Boolean].
+  def three_item_domain?
+    domain.length == 3
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: number_to_color
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Luke Fair
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-30 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies: []
 description:
 email: