number_to_color 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be64228ca77648ab10e5c239d226580f8854abd8a1dae15fdd0bbb4359c62c70
+  data.tar.gz: 1a35483bb28f5432f19f4fbbdfecb57ed0a273f96c9943dc8bb461ff2e1b9225
+SHA512:
+  metadata.gz: 226c9da9e7d3181d1c9741b543265619f2a9250b75dbea40defeae64dad93962ab51b5293d62833cbb8a0b096767248e17d6f365332371589101ccb61be7c2ab
+  data.tar.gz: 8175102c43d3e21c12d59134e664884daa716bdf3f49beb49392a2a5535bd3d0e5f38e7b6b96502c3a8d4ffa8134813daadd36b3fa35c4f96b652992e30b9f8d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in number_to_color.gemspec
+gemspec
+
+gem "minitest"
+gem "rake", "~> 13.0"
+gem "rspec"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    number_to_color (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  minitest
+  number_to_color!
+  rake (~> 13.0)
+  rspec
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Luke Fair
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+
+# NumberToColor
+Color code a value within a numerical range.
+
+All colors are customizable, but defaults to a linear gradient between red (![#ef4444](https://placehold.co/15x15/ef4444/ef4444.png) "negative") and blue (![#0ea5e9](https://placehold.co/15x15/0ea5e9/0ea5e9.png) "positive"), with white as the midpoint for "neutral" or average.
+
+  
+
+## Usage
+
+### Params
+* `value`: The numerical value to color code for.
+
+* `domain`: The numerical domain, or "range", for the color gradient. This can be a 2 or 3-item array. In a 2-item array, the midpoint is automatically set as the "neutral" value/color. In a 3-item array, you can set the midpoint to be anywhere between the first and last item (e.g., `[0, 5, 7]`).
+
+* `neutral_color` / `positive_color` / `negative_color`: (optional) Custom colors that can be passed in to override the defaults. These can be hex or RGB codes.
+<br>
+
+To get started, require the gem in your file.
+```
+
+require 'number_to_color'
+
+```
+
+ 
+### Examples
+#### Simple linear range between two numbers
+```
+ColorCode.new(value: 2, domain: [1, 3]).to_hex
+
+// #ffffff (neutral color)
+```
+
+  
+
+#### Non-linear range
+```
+ColorCode.new(value: 5, domain: [1, 5, 7]).to_hex
+
+// #ffffff (neutral color)
+```
+
+  
+
+#### Inverted domain
+```
+ColorCode.new(value: 1, domain: [7, 1]).to_hex
+
+// #0ea5e9 ("good" color)
+```
+
+  
+
+#### Custom "positive" color
+```
+ColorCode.new(value: 1, domain: [0, 1], positive_color: '#ffffff").to_hex
+
+// #ffffff (our new "positive" color)
+```
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/nonlocalize/number_to_color.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/lib/number_to_color/version.rb

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

data/lib/number_to_color.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require_relative "number_to_color/version"
+
+# Class to generate a hex color code based on a value and domain.
+#
+# @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.
+  def initialize(
+    value:,
+    domain: nil,
+    middle_color: nil,
+    end_color: nil,
+    start_color: nil
+  )
+    @value = value.to_f
+    @domain = domain
+    @middle_color = middle_color
+    @start_color = start_color
+    @end_color = end_color
+
+    set_colors
+  end
+
+  # The public method to return the hex code.
+  # @return [String].
+  def hex_color
+    rgb_to_hex(red: final_rgb[:r], green: final_rgb[:g], blue: final_rgb[:b])
+  end
+
+  private
+
+  attr_reader :value, :domain, :end_color, :start_color, :middle_color, :end_rgb, :start_rgb,
+              :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
+
+  # Returns the hex code for any RGB color.
+  # @return [String].
+  def rgb_to_hex(red:, green:, blue:)
+    "##{Kernel.format("%02x%02x%02x", red, green, blue)}"
+  end
+
+  # Returns the hex code for any RGB color.
+  # @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
+
+    color
+  end
+
+  # If the domain is inverted, switch its order.
+  # @return [Array].
+  def normalized_domain
+    return domain.reverse if inverted_order?
+
+    domain
+  end
+
+  # Calcluate the final RGB value.
+  # @return [Hash].
+  def final_rgb
+    r_start, g_start, b_start = start_color_rgb
+
+    r_end, g_end, b_end = end_color_rgb
+
+    {
+      r: calculate_rgb_level(r_start, r_end),
+      g: calculate_rgb_level(g_start, g_end),
+      b: calculate_rgb_level(b_start, b_end)
+    }
+  end
+
+  # Returns if the domain is reversed (lower number = good).
+  # @return [Boolean].
+  def inverted_order?
+    domain.first > domain.last
+  end
+
+  # Calculate the specific level (R, G, or B) based on the start and end value.
+  # @return [Integer].
+  def calculate_rgb_level(start_level, end_level)
+    r = ((end_level * distance_from_min_value) + (start_level * distance_difference)).to_i
+
+    [[0, r].max, 255].min
+  end
+
+  # Clamp the value if it falls above or below the min.
+  # @return [Number].
+  def clamped_value
+    return normalized_domain.first if value < normalized_domain.first
+
+    return normalized_domain.last if value > normalized_domain.last
+
+    value
+  end
+
+  # Returns the start color in RGB format.
+  # @return [Array].
+  def start_color_rgb
+    return end_rgb if inverted_order? && value_is_start?
+
+    return start_rgb if value_is_start?
+
+    middle_rgb
+  end
+
+  # Returns the end color in RGB format.
+  # @return [Array].
+  def end_color_rgb
+    return middle_rgb if value_is_start?
+
+    return start_rgb if inverted_order?
+
+    end_rgb
+  end
+
+  # Returns if the value is considered start.
+  # @return [Boolean].
+  def value_is_start?
+    clamped_value.between?(normalized_domain.first, mean_value) || clamped_value == mean_value
+  end
+
+  # Returns the domain's min value, or what is considered 'start'.
+  # @return [Number].
+  def min_value
+    return mean_value unless value_is_start?
+
+    normalized_domain.first
+  end
+
+  # Returns the domain's min value, or what is considered 'start'.
+  # @return [Number].
+  def max_value
+    return mean_value if value_is_start?
+
+    normalized_domain.last
+  end
+
+  # Returns the range's mean. This will be the median of a two-value domain,
+  # or the middle value of a three-value domain.
+  # @return [Number].
+  def mean_value
+    return normalized_domain[1] if normalized_domain.length == 3
+
+    normalized_domain.sum(0.0) / normalized_domain.size
+  end
+
+  # Normalize the range in end values [0, a_end_value].
+  # @return [Number].
+  def normalized_max_value
+    max_value - min_value
+  end
+
+  # Normalize the range in end values [0, a_end_value].
+  # This ensures the value is end.
+  # @return [Number].
+  def normalized_value
+    clamped_value - min_value
+  end
+
+  # Calculate distance to min value on a 0,1 scale.
+  # @return [Number].
+  def distance_from_min_value
+    normalized_value / normalized_max_value
+  end
+
+  def distance_difference
+    1 - distance_from_min_value
+  end
+end

data/sig/number_to_color.rbs

@@ -0,0 +1,4 @@
+module NumberToColor
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: number_to_color
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Luke Fair
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-30 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- fair@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/number_to_color.rb
+- lib/number_to_color/version.rb
+- sig/number_to_color.rbs
+homepage: https://github.com/nonlocalize/number_to_color
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nonlocalize/number_to_color
+  source_code_uri: https://github.com/nonlocalize/number_to_color
+  changelog_uri: https://github.com/nonlocalize/number_to_color/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Color code a numerical value based on a range.
+test_files: []