color_namer_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb8445c3407dff549f27e518515249fbe4dc5c3a5de0a7b388bc14968d8118f9
+  data.tar.gz: 4f684c4a7fc9e8f01f301c538692252c893de978d0fafca53ac95604357c7759
+SHA512:
+  metadata.gz: 3cfc740a65645606ce24fabf1b0fb583ee445953f5cbe64f7cdd1b4e08b0fc51321bb4d7a6156f64e65d90d260cb2a2ef10b89242a3340feab27b063d719baea
+  data.tar.gz: c4cf7454c3a41dda0011cd2bf953a1a78503e115a79c507a9b9a91bb80a48620c1436e1724072111e050e9ad367508e5bfedd6793bbd106f63e4a36c7b74e062

data/README.md

@@ -0,0 +1,143 @@
+# Color Namer Ruby
+
+> Give me a color and I'll name it.
+
+Color Namer Ruby is an ruby gem package for use in ruby or other projects that provides names for colours based on calculated color distances using the [Delta-E](http://www.colorwiki.com/wiki/Delta_E%3a_The_Color_Difference) color difference technique.
+Given a color in [Hexadecimal, RGA(A), HSL(A), HSV, HSB, or CMYK format](https://github.com/devrieda/color_conversion), it converts the color to the [HSL color space](https://en.wikipedia.org/wiki/HSL_and_HSV) (for now),
+then calculates the color's [Euclidean distance](https://npmjs.org/package/euclidean-distance) from a set of colors with known names to find the closest matching colour and it's name.
+
+Mike Bostock of [D3](http://d3js.org/) fame [explains it well](https://gist.github.com/mbostock/3014589):
+
+> Lab and HCL color spaces are special in that the perceived difference between two colors is proportional to their Euclidean distance in color space. This special property, called perceptual uniformity, makes them ideal for accurate visual encoding of data. In contrast, the more familiar RGB and HSL color spaces distort data when used for visualization.
+
+## Lists
+
+The color names are derived from several lists:
+
+- [roygbiv](lib/color_namer_rails/roygbiv.rb)
+- [basic](lib/color_namer_rails/basic.rb)
+- [html](lib/color_namer_rails/html.rb) - the HTML color names.
+- [x11](lib/color_namer_rails/x11.rb) - The list that preceded the HTML color names
+- [pantone](lib/color_namer_rails/pantone.rb)
+- [ntc](lib/color_namer_rails/ntc.rb), an [astounding collection](http://chir.ag/projects/ntc/) of over 1500 named colors.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add color_name_ruby
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install color_name_ruby
+```
+
+## Usage
+
+Get a single name for a colour using `.get_name` by passing a colour in a way that [ColorConversion]((https://github.com/devrieda/color_conversion)) accepts.
+When passing colours with their properties assigned to keys, you need to pass nil or an empty string as the first parameter.
+
+```ruby
+ColorNamerRuby::Namer.get_name('#3672b4')
+=> 'Azure'
+
+ColorNamerRuby::Namer.get_name('', r: 70, g: 130, b: 180, a: 0.5)
+=> 'steelblue'
+
+ColorNamerRuby:Namer.get_name('', r: 130, g: 180, b: 70)
+=> 'Sushi'
+
+ColorNamerRuby:Namer.get_name('', h: 20, s: 73, l: 20)
+=> 'Cioccolato'
+
+ColorNamerRuby:Namer.get_name(nil, h: 107, s: 61, v: 71)
+=> 'Apple'
+
+ColorNamerRuby::Namer.get_name(nil, h: 61, s: 71, b: 32)
+=> 'Camouflage'
+
+ColorNamerRuby::Namer.get_name(nil, c: 71, m: 15, y: 5, k: 54)
+=> 'Blue Dianne'
+
+ColorNamerRuby::Namer.get_name('rgb(51, 102, 204)')
+=> 'Denim'
+
+ColorNamerRuby::Namer.get_name('hsl(225, 73%, 57%)')
+=> 'royalblue'
+```
+
+Get a list of colour names sorted by their perceptual similarity to the given color by using `.get_names`.
+Again, when passing colours with their properties assigned to keys, you need to pass nil or an empty string as the first parameter.
+
+```ruby
+ColorNamerRuby::Namer.get_names('#3672b4')
+=> [
+=>   { name: 'Azure', hex: '#315BA1', distance: 8.660254037844387 },
+=>   { name: 'St Tropaz', hex: '#2D569B', distance: 9.9498743710662 },
+=>   { name: 'Denim', hex: '#2B6CC4', distance: 10.816653826391969 },
+=>   { name: 'steelblue', hex: '#4682B4', distance: 11.180339887498949 },
+=>   { name: 'Steel Blue', hex: '#4682B4', distance: 11.180339887498949 },
+=>   .
+=>   .
+=>   .
+=> ]
+```
+
+Get a list of the colour lists that can be checked against.
+
+```ruby
+ColorNamerRuby::Namer.list_names
+=> ['basic', 'html', 'ntc', 'pantone', 'roygbiv', 'x11']
+```
+
+## Options
+
+### pick
+
+This parameter allows you to filter names from the dedicated lists for faster computation.
+It can be used for both `get_name` and `get_names`.
+
+```ruby
+ColorNamerRuby::Namer.get_names('#3672b4', pick: ['basic', 'x11'])
+```
+
+### omit
+
+The opposite of `options.pick`.
+It can be used for both `get_name` and `get_names`.
+
+```ruby
+ColorNamerRuby::Namer.get_names('#3672b4', omit: ['pantone', 'roygbiv'])
+```
+
+### limit
+
+This option allows us to limit the number of names that are returned to keep the returned output manageable.
+It can be used for `get_names` (since `get_name` already has a limit of 1).
+
+```ruby
+ColorNamerRuby::Namer.get_names('#3672b4', limit: 5)
+```
+
+###
+
+## 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/[USERNAME]/color_namer_ruby>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/color_namer_ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ColorNamerRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/color_namer_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/color_namer_ruby/basic.rb

@@ -0,0 +1,36 @@
+module ColorNamerRuby
+  class Basic
+    def self.get_name_from_hex(hex)
+      self.colours.select { |swatch| swatch[:hex] == hex.upcase }.first&.dig(:name)
+    end
+
+    private
+
+    def self.colours
+      [
+        { name: 'black', hex: '#000000' },
+        { name: 'blue', hex: '#0000FF' },
+        { name: 'cyan', hex: '#00FFFF' },
+        { name: 'green', hex: '#008000' },
+        { name: 'teal', hex: '#008080' },
+        { name: 'turquoise', hex: '#40E0D0' },
+        { name: 'indigo', hex: '#4B0082' },
+        { name: 'gray', hex: '#808080' },
+        { name: 'purple', hex: '#800080' },
+        { name: 'brown', hex: '#A52A2A' },
+        { name: 'tan', hex: '#D2B48C' },
+        { name: 'violet', hex: '#EE82EE' },
+        { name: 'beige', hex: '#F5F5DC' },
+        { name: 'fuchsia', hex: '#FF00FF' },
+        { name: 'gold', hex: '#FFD700' },
+        { name: 'magenta', hex: '#FF00FF' },
+        { name: 'orange', hex: '#FFA500' },
+        { name: 'pink', hex: '#FFC0CB' },
+        { name: 'red', hex: '#FF0000' },
+        { name: 'white', hex: '#FFFFFF' },
+        { name: 'yellow', hex: '#FFFF00' },
+      ]
+    end
+  end
+end
+

data/lib/color_namer_ruby/distance.rb

@@ -0,0 +1,44 @@
+require 'color_conversion'
+require 'active_support/core_ext/object/blank'
+
+module ColorNamerRuby
+  class Distance
+    def self.get_names_from_hex(hex, pick, omit, limit)
+      @colour = ColorConversion::Color.new(hex)
+
+      colour_lists = []
+
+      ColorNamerRuby::Namer.list_names.each do |list_name|
+        if (pick.empty? || pick.include?(list_name)) && !omit.include?(list_name)
+          colour_lists += self.get_colour_distances_in_list(Object.const_get("ColorNamerRuby::#{list_name.capitalize}").colours)
+        end
+      end
+
+      colour_lists = colour_lists.flatten.compact.reject(&:empty?)
+
+      limit = colour_lists.length if limit < 0
+      
+      colour_lists.sort_by { |swatch| swatch[:distance] }.take(limit)
+    end
+    
+    private
+
+    def self.get_colour_distances_in_list(colour_list)
+      colour_list.map do |swatch|
+        swatch[:distance] = self.distance_between_colours(ColorConversion::Color.new(swatch.dig(:hex)))
+      end
+
+      colour_list
+    end
+
+    def self.distance_between_colours(comparison_colour)
+      # https://en.wikipedia.org/wiki/Euclidean_distance#Higher_dimensions
+      # closest colours across the different arrays
+      # TODO use LAB or HCL instead of HSL
+      hsl_1 = @colour.hsl
+      hsl_2 = comparison_colour.hsl
+      
+      Math.sqrt((hsl_1[:h] - hsl_2[:h])**2 + (hsl_1[:s] - hsl_2[:s])**2 + (hsl_1[:l] - hsl_2[:l])**2)
+    end
+  end
+end

data/lib/color_namer_ruby/html.rb

@@ -0,0 +1,163 @@
+module ColorNamerRuby
+  class Html
+    def self.get_name_from_hex(hex)
+      self.colours.select { |swatch| swatch[:hex] == hex.upcase }.first&.dig(:name)
+    end
+
+    private
+
+    def self.colours
+      [
+        { name: 'aqua', hex: '#00FFFF' },
+        { name: 'aliceblue', hex: '#F0F8FF' },
+        { name: 'antiquewhite', hex: '#FAEBD7' },
+        { name: 'black', hex: '#000000' },
+        { name: 'blue', hex: '#0000FF' },
+        { name: 'cyan', hex: '#00FFFF' },
+        { name: 'darkblue', hex: '#00008B' },
+        { name: 'darkcyan', hex: '#008B8B' },
+        { name: 'darkgreen', hex: '#006400' },
+        { name: 'darkturquoise', hex: '#00CED1' },
+        { name: 'deepskyblue', hex: '#00BFFF' },
+        { name: 'green', hex: '#008000' },
+        { name: 'lime', hex: '#00FF00' },
+        { name: 'mediumblue', hex: '#0000CD' },
+        { name: 'mediumspringgreen', hex: '#00FA9A' },
+        { name: 'navy', hex: '#000080' },
+        { name: 'springgreen', hex: '#00FF7F' },
+        { name: 'teal', hex: '#008080' },
+        { name: 'midnightblue', hex: '#191970' },
+        { name: 'dodgerblue', hex: '#1E90FF' },
+        { name: 'lightseagreen', hex: '#20B2AA' },
+        { name: 'forestgreen', hex: '#228B22' },
+        { name: 'seagreen', hex: '#2E8B57' },
+        { name: 'darkslategray', hex: '#2F4F4F' },
+        { name: 'darkslategrey', hex: '#2F4F4F' },
+        { name: 'limegreen', hex: '#32CD32' },
+        { name: 'mediumseagreen', hex: '#3CB371' },
+        { name: 'turquoise', hex: '#40E0D0' },
+        { name: 'royalblue', hex: '#4169E1' },
+        { name: 'steelblue', hex: '#4682B4' },
+        { name: 'darkslateblue', hex: '#483D8B' },
+        { name: 'mediumturquoise', hex: '#48D1CC' },
+        { name: 'indigo', hex: '#4B0082' },
+        { name: 'darkolivegreen', hex: '#556B2F' },
+        { name: 'cadetblue', hex: '#5F9EA0' },
+        { name: 'cornflowerblue', hex: '#6495ED' },
+        { name: 'mediumaquamarine', hex: '#66CDAA' },
+        { name: 'dimgray', hex: '#696969' },
+        { name: 'dimgrey', hex: '#696969' },
+        { name: 'slateblue', hex: '#6A5ACD' },
+        { name: 'olivedrab', hex: '#6B8E23' },
+        { name: 'slategray', hex: '#708090' },
+        { name: 'slategrey', hex: '#708090' },
+        { name: 'lightslategray', hex: '#778899' },
+        { name: 'lightslategrey', hex: '#778899' },
+        { name: 'mediumslateblue', hex: '#7B68EE' },
+        { name: 'lawngreen', hex: '#7CFC00' },
+        { name: 'aquamarine', hex: '#7FFFD4' },
+        { name: 'chartreuse', hex: '#7FFF00' },
+        { name: 'gray', hex: '#808080' },
+        { name: 'grey', hex: '#808080' },
+        { name: 'maroon', hex: '#800000' },
+        { name: 'olive', hex: '#808000' },
+        { name: 'purple', hex: '#800080' },
+        { name: 'lightskyblue', hex: '#87CEFA' },
+        { name: 'skyblue', hex: '#87CEEB' },
+        { name: 'blueviolet', hex: '#8A2BE2' },
+        { name: 'darkmagenta', hex: '#8B008B' },
+        { name: 'darkred', hex: '#8B0000' },
+        { name: 'saddlebrown', hex: '#8B4513' },
+        { name: 'darkseagreen', hex: '#8FBC8F' },
+        { name: 'lightgreen', hex: '#90EE90' },
+        { name: 'mediumpurple', hex: '#9370DB' },
+        { name: 'darkviolet', hex: '#9400D3' },
+        { name: 'palegreen', hex: '#98FB98' },
+        { name: 'darkorchid', hex: '#9932CC' },
+        { name: 'yellowgreen', hex: '#9ACD32' },
+        { name: 'sienna', hex: '#A0522D' },
+        { name: 'brown', hex: '#A52A2A' },
+        { name: 'darkgray', hex: '#A9A9A9' },
+        { name: 'darkgrey', hex: '#A9A9A9' },
+        { name: 'greenyellow', hex: '#ADFF2F' },
+        { name: 'lightblue', hex: '#ADD8E6' },
+        { name: 'paleturquoise', hex: '#AFEEEE' },
+        { name: 'lightsteelblue', hex: '#B0C4DE' },
+        { name: 'powderblue', hex: '#B0E0E6' },
+        { name: 'firebrick', hex: '#B22222' },
+        { name: 'darkgoldenrod', hex: '#B8860B' },
+        { name: 'mediumorchid', hex: '#BA55D3' },
+        { name: 'rosybrown', hex: '#BC8F8F' },
+        { name: 'darkkhaki', hex: '#BDB76B' },
+        { name: 'silver', hex: '#C0C0C0' },
+        { name: 'mediumvioletred', hex: '#C71585' },
+        { name: 'indianred', hex: '#CD5C5C' },
+        { name: 'peru', hex: '#CD853F' },
+        { name: 'chocolate', hex: '#D2691E' },
+        { name: 'tan', hex: '#D2B48C' },
+        { name: 'lightgray', hex: '#D3D3D3' },
+        { name: 'lightgrey', hex: '#D3D3D3' },
+        { name: 'thistle', hex: '#D8BFD8' },
+        { name: 'goldenrod', hex: '#DAA520' },
+        { name: 'orchid', hex: '#DA70D6' },
+        { name: 'palevioletred', hex: '#DB7093' },
+        { name: 'crimson', hex: '#DC143C' },
+        { name: 'gainsboro', hex: '#DCDCDC' },
+        { name: 'plum', hex: '#DDA0DD' },
+        { name: 'burlywood', hex: '#DEB887' },
+        { name: 'lightcyan', hex: '#E0FFFF' },
+        { name: 'lavender', hex: '#E6E6FA' },
+        { name: 'darksalmon', hex: '#E9967A' },
+        { name: 'palegoldenrod', hex: '#EEE8AA' },
+        { name: 'violet', hex: '#EE82EE' },
+        { name: 'azure', hex: '#F0FFFF' },
+        { name: 'honeydew', hex: '#F0FFF0' },
+        { name: 'khaki', hex: '#F0E68C' },
+        { name: 'lightcoral', hex: '#F08080' },
+        { name: 'sandybrown', hex: '#F4A460' },
+        { name: 'beige', hex: '#F5F5DC' },
+        { name: 'mintcream', hex: '#F5FFFA' },
+        { name: 'wheat', hex: '#F5DEB3' },
+        { name: 'whitesmoke', hex: '#F5F5F5' },
+        { name: 'ghostwhite', hex: '#F8F8FF' },
+        { name: 'lightgoldenrodyellow', hex: '#FAFAD2' },
+        { name: 'linen', hex: '#FAF0E6' },
+        { name: 'salmon', hex: '#FA8072' },
+        { name: 'oldlace', hex: '#FDF5E6' },
+        { name: 'bisque', hex: '#FFE4C4' },
+        { name: 'blanchedalmond', hex: '#FFEBCD' },
+        { name: 'coral', hex: '#FF7F50' },
+        { name: 'cornsilk', hex: '#FFF8DC' },
+        { name: 'darkorange', hex: '#FF8C00' },
+        { name: 'deeppink', hex: '#FF1493' },
+        { name: 'floralwhite', hex: '#FFFAF0' },
+        { name: 'fuchsia', hex: '#FF00FF' },
+        { name: 'gold', hex: '#FFD700' },
+        { name: 'hotpink', hex: '#FF69B4' },
+        { name: 'ivory', hex: '#FFFFF0' },
+        { name: 'lavenderblush', hex: '#FFF0F5' },
+        { name: 'lemonchiffon', hex: '#FFFACD' },
+        { name: 'lightpink', hex: '#FFB6C1' },
+        { name: 'lightsalmon', hex: '#FFA07A' },
+        { name: 'lightyellow', hex: '#FFFFE0' },
+        { name: 'magenta', hex: '#FF00FF' },
+        { name: 'mistyrose', hex: '#FFE4E1' },
+        { name: 'moccasin', hex: '#FFE4B5' },
+        { name: 'navajowhite', hex: '#FFDEAD' },
+        { name: 'orange', hex: '#FFA500' },
+        { name: 'orangered', hex: '#FF4500' },
+        { name: 'papayawhip', hex: '#FFEFD5' },
+        { name: 'peachpuff', hex: '#FFDAB9' },
+        { name: 'pink', hex: '#FFC0CB' },
+        { name: 'red', hex: '#FF0000' },
+        { name: 'seashell', hex: '#FFF5EE' },
+        { name: 'snow', hex: '#FFFAFA' },
+        { name: 'tomato', hex: '#FF6347' },
+        { name: 'white', hex: '#FFFFFF' },
+        { name: 'yellow', hex: '#FFFF00' },
+      ]
+    end
+  end
+end
+
+

data/lib/color_namer_ruby/namer.rb

@@ -0,0 +1,44 @@
+require 'color_conversion'
+require 'active_support/core_ext/object/blank'
+
+module ColorNamerRuby
+  class Namer
+    def self.get_name(colour_value, pick: [], omit: [], **alt_colour_value)
+      # alt_colour_value are used to collect colour paramaters when they are passed in the key format
+      @hex = ColorConversion::Color.new(colour_value.presence || alt_colour_value).hex
+
+      name = self.check_lists(pick, omit)
+      return name if name.present?
+
+      name_object = ColorNamerRuby::Distance.get_names_from_hex(@hex, pick, omit, 1).first
+      return name_object.dig(:name)
+    end
+
+    def self.get_names(colour_value, pick: [], omit: [], limit: -1, **alt_colour_value)
+      @hex = ColorConversion::Color.new(colour_value.presence || alt_colour_value).hex
+
+      name_objects = ColorNamerRuby::Distance.get_names_from_hex(@hex, pick, omit, limit)
+      return name_objects
+    end
+
+    def self.list_names
+      ['basic', 'html', 'ntc', 'pantone', 'roygbiv', 'x11']
+    end
+
+    private
+
+    def self.check_lists(pick, omit)
+      name = nil
+
+      self.list_names.each do |list_name|
+        if (pick.empty? || pick.include?(list_name)) && !omit.include?(list_name)
+          name = Object.const_get("ColorNamerRuby::#{list_name.capitalize}").get_name_from_hex(@hex)
+        end
+
+        break if name.present?
+      end
+
+      name || ''
+    end
+  end
+end