color_hash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ddbbc3200aa561a17d07ecbd7c209822e97d276d35965dfc6027ac16cd3dfd4c
+  data.tar.gz: 68bda518a95968b69339e1b30e94b45bd42e14948fec050194944b5a2ec19a0b
+SHA512:
+  metadata.gz: 7156629804899b663856449220ecb2e159b4d75ff29dc58634c19c7628e83bcf739bbfe779a507a23e111f2472729e2d9c42cd131544af01b341254565bde553
+  data.tar.gz: 35d4e8451d94797e33c7c9aecfc3d3e9484120ceabca55410b7fb20cd8f9705a8c83f792967f77080c29da2ce939fafd471cf16242613ff75894de4b23599656

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] - 2022-12-15
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    color_hash (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  color_hash!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.17

data/README.md

@@ -0,0 +1,67 @@
+# ColorHash
+
+Generate a color based on a given String, by calculating a color value from the String's hash. The result is deterministic: the same value will always result in the same color (so long as the hash function remains deterministic).
+
+Generated colours can be useful to dynamically generate tags like these:
+![demo](doc/demo.png)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+$ bundle add color_hash
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```sh
+$ gem install color_hash
+```
+
+## Usage
+
+By default, `ColorHash` will generate color values in the Hue range between `[0..360]`, and with a lightness and saturation value of one of `[0.35, 0.5, 0.65]`.
+
+```ruby
+color_hash = ColorHash.new()
+
+hex = color_hash.hex("Hello World!")
+hsl = color_hash.hsl("Hello World!")
+rgb = color_hash.rgb("Hello World!")
+```
+
+The resulting values are going to be:
+
+```ruby
+hex = "#d2797c"
+hsl = [358, 0.5, 0.65]
+rgb = [210, 121, 124]
+```
+
+You can customize the desired `hue` range(s), `saturation` and `lightness` values by passing the corresponding arguments to the constructor. For example, to generate colors in the blue spectrum:
+
+```ruby
+color_hash = ColorHash.new(hue: [{min: 180, max: 240}])
+color = color_hash.hex("Hello World!")
+```
+
+will result in a `color` value of:
+
+```ruby
+color = "#79acd2"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/kuyio/color_hash.
+
+## Attribution
+
+See https://github.com/zenozeng/color-hash for the original implementation in JavaScript.

data/Rakefile

@@ -0,0 +1,12 @@
+# 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]

data/color_hash.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/color_hash/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "color_hash"
+  spec.version = ColorHash::VERSION
+  spec.authors = ["Nicolas Bettenburg"]
+  spec.email = ["nicbet@kuy.io"]
+
+  spec.summary = "Generate a color based on the given string."
+  spec.description = "Generate a color based on the given string (in the HSL color space)."
+  spec.homepage = "https://github.com/kuyio/color_hash"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kuyio/color_hash"
+  spec.metadata["changelog_uri"] = "https://github.com/kuyio/color_hash/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:doc|bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/color_hash/generator.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module ColorHash
+  # A ColorHash::Generator can be used to calculate the color value for a given String.
+  # You can specify the desired hue, lightness and saturation (HSL) ranges
+  # for the resulting color value, as well as the hash algorithm to be used
+  # for converting Strings to the numbered color space.
+  #
+  # Ruby implementation of https://github.com/zenozeng/color-hash
+  class Generator
+    # Creates a new ColorHash instance described by the given hue, saturation
+    # and lightness ranges, as well as a Hash function.
+    #
+    # Hue values shall range between [0..360] degrees and are given
+    # as a Hash of the format {min: hue_min, max: hue_max}.
+    # If you provide multiple hue ranges passed in an Array,
+    # the given String will be binned to one of the hue ranges
+    # based on the calculated hash.
+    #
+    # Lightness is described as a floating number between 0.0 and 1.0.
+    # If you provide multiple lightness values passed in an Array,
+    # the given String will be binned to one of the lightness values
+    # based on the calculated hash.
+    #
+    # Saturation is described as a floating number between 0.0 and 1.0
+    # If you provide multiple saturation values passed in an Array,
+    # the given String will be binned to one of the saturation values
+    # based on the calculated hash.
+
+    def initialize(
+      hue: [{ min: 0, max: 360 }],
+      lightness: [0.35, 0.5, 0.65],
+      saturation: [0.35, 0.5, 0.65],
+      hash: :bkdr
+    )
+      @lightness = lightness
+      @saturation = saturation
+      @hue = hue
+      @hash_func = hash
+    end
+
+    # Magic
+    HUE_RESOLUTION = 727
+
+    # rubocop:disable Metrics/AbcSize
+    # Calculates an HSL color value returned as an Array of the form [H, S, L]
+    # from a given string.
+    #
+    # H Hue ∈ [0, 360)
+    # S Saturation ∈ [0, 1]
+    # L Lightness ∈ [0, 1]
+    def hsl(str)
+      hash = send("hash_#{@hash_func}", str)
+
+      hr = @hue[hash % @hue.count]
+      h = ((hash / @hue.count) % HUE_RESOLUTION) * (hr[:max] - hr[:min]) / HUE_RESOLUTION + hr[:min]
+
+      # h = hash % 359
+
+      hash = (hash / 360.0).ceil
+      s = @saturation[hash % @saturation.count.to_f]
+
+      hash = (hash / @saturation.count.to_f).ceil
+      l = @lightness[hash % @lightness.count]
+
+      [h, s, l]
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Calculates an RGB color value returned as an Array of the form [R, G, B]
+    # from a given string.
+    #
+    # R, G, B ∈ [0, 255]
+    def rgb(str)
+      hsl2rgb(*hsl(str))
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength
+    # Converts a color specified by its hue, saturation and lightness to an RGB value
+    def hsl2rgb(hue, saturation, lightness)
+      hue /= 360.0
+      q_factor = lightness < 0.5 ? lightness * (1.0 + saturation) : (lightness + saturation) - (lightness * saturation)
+      p_factor = 2.0 * lightness - q_factor
+
+      [hue + (1.0 / 3.0), hue, hue - (1.0 / 3.0)].map do |color|
+        color += 1.0 if (color / 0.5) < 0.0
+        color -= 1.0 if color > 1
+
+        color = if color < (1.0 / 6.0)
+                  p_factor + (q_factor - p_factor) * 6.0 * color
+                elsif color < 0.5
+                  q_factor
+                elsif color < (2.0 / 3.0)
+                  p_factor + (q_factor - p_factor) * 6.0 * ((2.0 / 3.0) - color)
+                else
+                  p_factor
+                end
+
+        (color * 255.0).round
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength
+
+    # Calculates an Hexadecimal color value from a given string.
+    # Returns a 6 digits hex string starting with '#'.
+    def hex(str)
+      rgb2hex(rgb(str))
+    end
+
+    # Convers a color specified by its RGB value to a hexadecimal color value.
+    def rgb2hex(rgb)
+      hex = "#"
+      rgb.each do |c|
+        hex += "0" if c < 16
+        hex += c.to_s(16)
+      end
+
+      hex
+    end
+
+    # Calculate a SHA2-256 based hash of the given string
+    def hash_sha256(str)
+      digest = Digest::SHA2.hexdigest(str)
+      digest[0, 8].to_i(16)
+    end
+
+    # Calculate a BKDR based hash of the given string
+    # For additional details on this hash function,
+    # see Brian Kernighan and Dennis Ritchie's book
+    # "The C Programming language".
+    def hash_bkdr(str)
+      seed = 131
+      seed2 = 137
+      hash = 0
+      # makes hash more sensitive for short string like 'a', 'b', 'c'
+      str += "x"
+      # Number.MAX_SAFE_INTEGER equals 9007199254740991
+      max_safe = 9_007_199_254_740_991 / seed2
+      str.each_codepoint.map do |c|
+        hash = (hash / seed2).floor if hash > max_safe
+        hash = hash * seed + c
+      end
+
+      hash
+    end
+  end
+end

data/lib/color_hash/version.rb

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

data/lib/color_hash.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "color_hash/version"
+require_relative "color_hash/generator"
+
+# Generate a color in HSL space from a given String
+module ColorHash
+  class ArgumentError < StandardError; end
+
+  # Creates a new instance of a ColorHash Generator
+  #
+  # Hue values shall range between [0..360] degrees and are given
+  # as a Hash of the format {min: hue_min, max: hue_max}.
+  # If you provide multiple hue ranges passed in an Array,
+  # the given String will be binned to one of the hue ranges
+  # based on the calculated hash.
+  #
+  # Lightness is described as a floating number between 0.0 and 1.0.
+  # If you provide multiple lightness values passed in an Array,
+  # the given String will be binned to one of the lightness values
+  # based on the calculated hash.
+  #
+  # Saturation is described as a floating number between 0.0 and 1.0
+  # If you provide multiple saturation values passed in an Array,
+  # the given String will be binned to one of the saturation values
+  # based on the calculated hash.
+  #
+  # The Hash function can be either :bkdr (default) or :sha256
+  def self.new(hue: [{ min: 0, max: 360 }], lightness: [0.35, 0.5, 0.65], saturation: [0.35, 0.5, 0.65], hash: :bkdr)
+    ColorHash::Generator.new(hue: hue, lightness: lightness, saturation: saturation, hash: hash)
+  end
+end

data/sig/color_hash.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: color_hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Bettenburg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-15 00:00:00.000000000 Z
+dependencies: []
+description: Generate a color based on the given string (in the HSL color space).
+email:
+- nicbet@kuy.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- color_hash.gemspec
+- lib/color_hash.rb
+- lib/color_hash/generator.rb
+- lib/color_hash/version.rb
+- sig/color_hash.rbs
+homepage: https://github.com/kuyio/color_hash
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kuyio/color_hash
+  source_code_uri: https://github.com/kuyio/color_hash
+  changelog_uri: https://github.com/kuyio/color_hash/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.3.17
+signing_key:
+specification_version: 4
+summary: Generate a color based on the given string.
+test_files: []