color_namer_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb8445c3407dff549f27e518515249fbe4dc5c3a5de0a7b388bc14968d8118f9
-  data.tar.gz: 4f684c4a7fc9e8f01f301c538692252c893de978d0fafca53ac95604357c7759
+  metadata.gz: 99e55c151479cf0f2bdccedd02fe6e5632bf4cc2becc0c6bb35df9396429f53e
+  data.tar.gz: c1ed71d2712b45c0ec8174c8049995aceb5faeaf3a8552f108676e03c3b43156
 SHA512:
-  metadata.gz: 3cfc740a65645606ce24fabf1b0fb583ee445953f5cbe64f7cdd1b4e08b0fc51321bb4d7a6156f64e65d90d260cb2a2ef10b89242a3340feab27b063d719baea
-  data.tar.gz: c4cf7454c3a41dda0011cd2bf953a1a78503e115a79c507a9b9a91bb80a48620c1436e1724072111e050e9ad367508e5bfedd6793bbd106f63e4a36c7b74e062
+  metadata.gz: 598275d62f010ac8d7914644d284c7eee421509b8e3f38b98542adc0521037301ae092b87b986f11faac30cece71f2322ffcc9244d1ea29aa242061e1738e329
+  data.tar.gz: 29a288b098fa9de4f119b7a4b55a97bee14bf4a4cb47f7a18df9344ed801ed8df5859aa5b41f715edaad3fc59c54a394c1b5cc857c3bec97003fd73ce93bfd5c

data/README.md

@@ -37,60 +37,110 @@ gem install color_name_ruby
 
 ## Usage
 
+## Methods
+
+Possible methods:
+
+```ruby
+ColorNamerRuby.list_collections
+ColorNamerRuby.get_name
+ColorNamerRuby.get_names
+ColorNamerRuby.get_all_names
+ColorNamerRuby.get_colour
+ColorNamerRuby.get_colours
+ColorNamerRuby.get_all_colours
+```
+
+Get a list of the colour collections that can be checked against.
+
+```ruby
+ColorNamerRuby.list_collections
+=> ['basic', 'html', 'ntc', 'pantone', 'roygbiv', 'x11']
+```
+
 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.get_name('#3672b4')
+=> ['azure']
 
-ColorNamerRuby::Namer.get_name('', r: 70, g: 130, b: 180, a: 0.5)
-=> 'steelblue'
+ColorNamerRuby.get_name('', r: 70, g: 130, b: 180, a: 0.5)
+=> ['steelblue']
 
-ColorNamerRuby:Namer.get_name('', r: 130, g: 180, b: 70)
-=> 'Sushi'
+ColorNamerRuby.get_name('', r: 130, g: 180, b: 70)
+=> ['sushi']
 
-ColorNamerRuby:Namer.get_name('', h: 20, s: 73, l: 20)
-=> 'Cioccolato'
+ColorNamerRuby.get_name('', h: 20, s: 73, l: 20)
+=> ['cioccolato']
 
-ColorNamerRuby:Namer.get_name(nil, h: 107, s: 61, v: 71)
-=> 'Apple'
+ColorNamerRuby.get_name(nil, h: 107, s: 61, v: 71)
+=> ['apple']
 
-ColorNamerRuby::Namer.get_name(nil, h: 61, s: 71, b: 32)
-=> 'Camouflage'
+ColorNamerRuby.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.get_name(nil, c: 71, m: 15, y: 5, k: 54)
+=> ['blue dianne']
 
-ColorNamerRuby::Namer.get_name('rgb(51, 102, 204)')
-=> 'Denim'
+ColorNamerRuby.get_name('rgb(51, 102, 204)')
+=> ['denim']
 
-ColorNamerRuby::Namer.get_name('hsl(225, 73%, 57%)')
-=> 'royalblue'
+ColorNamerRuby.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')
+ColorNamerRuby.get_names('#3672b4')
+=> ['azure', 'st tropaz', 'denim', 'steelblue', ...]
+```
+
+Get a list of all the colour names across the lists that can be checked against.
+
+```ruby
+ColorNamerRuby.get_all_names
+=> ['black', 'blue', 'cyan', 'green', 'teal', ...]
+```
+
+You can also get the entire swatch object(s) to view the hex values and distance the colours are from the source colour you provided. These methods are all related/similar to their 'name' named method counterparts, except they provide the colour hash instead of just the name, and can be called in a similar way too.
+
+When passing colours with their properties assigned to keys, you need to pass nil or an empty string as the first parameter.
+
+```ruby
+ColorNamerRuby.get_colour('#3672b4')
+=> [{ distance: 8.660254037844387, hex: '#315BA1', name: 'azure' }]
+```
+
+Get a list of colour hashes sorted by their perceptual similarity to the given color by using `.get_colours`.
+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.get_colours('#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 },
+=>   { distance: 8.660254037844387, hex: '#315BA1', name: 'azure' },
+=>   { distance: 9.9498743710662, hex: '#2D569B', name: 'st tropaz' },
+=>   { distance: 10.81665382639196, name: 'denim' },
 =>   .
 =>   .
 =>   .
 => ]
 ```
 
-Get a list of the colour lists that can be checked against.
+Get a list of all the colour hashes across the lists that can be checked against.
 
 ```ruby
-ColorNamerRuby::Namer.list_names
-=> ['basic', 'html', 'ntc', 'pantone', 'roygbiv', 'x11']
+ColorNamerRuby.get_all_colours
+=> [
+=>   { name: 'black', hex: '#000000', collection: 'basic' },
+=>   { name: 'blue', hex: '#0000FF', collection: 'basic' },
+=>   { name: 'cyan', hex: '#00FFFF', collection: 'basic' },
+=>   .
+=>   .
+=>   .
+=> ]
 ```
 
 ## Options
@@ -98,28 +148,28 @@ ColorNamerRuby::Namer.list_names
 ### 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`.
+It can be used for `get_name`, `get_names`, `get_all_names`, or `get_colour`, `get_colours`, `get_all_colours`.
 
 ```ruby
-ColorNamerRuby::Namer.get_names('#3672b4', pick: ['basic', 'x11'])
+ColorNamerRuby.get_names('#3672b4', pick: ['basic', 'x11'])
 ```
 
 ### omit
 
 The opposite of `options.pick`.
-It can be used for both `get_name` and `get_names`.
+It can be used for `get_name`, `get_names`, `get_all_names`, or `get_colour`, `get_colours`, `get_all_colours`.
 
 ```ruby
-ColorNamerRuby::Namer.get_names('#3672b4', omit: ['pantone', 'roygbiv'])
+ColorNamerRuby.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).
+It can be used for `get_names`, or `get_colours` (since `get_name` and  `get_colour` already have a limit of 1).
 
 ```ruby
-ColorNamerRuby::Namer.get_names('#3672b4', limit: 5)
+ColorNamerRuby.get_names('#3672b4', limit: 5)
 ```
 
 ###
@@ -132,7 +182,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/louiswdavis/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/louiswdavis/color_namer_ruby/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -140,4 +190,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/louiswdavis/color_namer_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+# 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/distance.rb

@@ -1,44 +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
+# frozen_string_literal: true
+
+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.list_collections.each do |collection_name|
+        next unless (pick.empty? || pick.include?(collection_name)) && !omit.include?(collection_name)
+
+        colour_lists += self.get_colour_distances_in_list(Object.const_get("ColorSwatchCollection::#{collection_name.capitalize}").colours)
+      end
+
+      colour_lists = colour_lists.flatten.compact.reject(&:empty?)
+
+      limit = colour_lists.length if limit.negative?
+
+      colour_lists.sort_by { |swatch| swatch[:distance] }.take(limit)
+    end
+
+    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
+      conversion_1 = @colour.hsl
+      conversion_2 = comparison_colour.hsl
+
+      Math.sqrt((conversion_1[:h] - conversion_2[:h])**2 + (conversion_1[:s] - conversion_2[:s])**2 + (conversion_1[:l] - conversion_2[:l])**2)
+    end
+  end
+end

data/lib/color_namer_ruby/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module ColorNamerRuby
-  VERSION = "0.1.0"
-end
+# frozen_string_literal: true
+
+module ColorNamerRuby
+  VERSION = '0.1.1'
+end

data/lib/color_namer_ruby.rb

@@ -1,18 +1,70 @@
-# frozen_string_literal: true
-
-require_relative 'color_namer_ruby/version'
-
-require_relative 'color_namer_ruby/basic'
-require_relative 'color_namer_ruby/html'
-require_relative 'color_namer_ruby/ntc'
-require_relative 'color_namer_ruby/pantone'
-require_relative 'color_namer_ruby/roygbiv'
-require_relative 'color_namer_ruby/x11'
-
-require_relative 'color_namer_ruby/namer'
-require_relative 'color_namer_ruby/distance'
-
-module ColorNamerRuby
-  class Error < StandardError; end
-  # Your code goes here...
-end
+# frozen_string_literal: true
+
+require 'color_swatch_collection'
+
+require_relative 'color_namer_ruby/version'
+require_relative 'color_namer_ruby/distance'
+
+module ColorNamerRuby
+  class Error < StandardError; end
+
+  def self.list_collections
+    ColorSwatchCollection.list_collections
+  end
+
+  def self.get_name(colour_value, pick: [], omit: [], **alt_colour_value)
+    self.get_colour(colour_value, pick: pick, omit: omit, **alt_colour_value).map { |h| h[:name] } || []
+  end
+
+  def self.get_names(colour_value, pick: [], omit: [], limit: -1, **alt_colour_value)
+    self.get_colours(colour_value, pick: pick, omit: omit, limit: limit, **alt_colour_value).map { |h| h[:name] } || []
+  end
+
+  def self.get_all_names(pick: [], omit: [])
+    self.get_all_colours(pick: pick, omit: omit).map { |h| h[:name] } || []
+  end
+
+  def self.get_colour(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
+
+    # if we get an exact match, return it
+    colour = self.get_colour_from_collections(hex, pick, omit)
+
+    if colour.present?
+      colour[:distance] = 0.0
+      return [colour]
+    end
+
+    # if we don't get an exact match, try to find the closest match
+    ColorNamerRuby::Distance.get_names_from_hex(hex, pick, omit, 1)
+  end
+
+  def self.get_colours(colour_value, pick: [], omit: [], limit: -1, **alt_colour_value)
+    hex = ColorConversion::Color.new(colour_value.presence || alt_colour_value).hex
+
+    # get the closest matches up to the count limit
+    ColorNamerRuby::Distance.get_names_from_hex(hex, pick, omit, limit)
+  end
+
+  # if the same names appear in multiple lists, they could still appear even if certain lists they are in are omitted
+  def self.get_all_colours(pick: [], omit: [])
+    ColorSwatchCollection.get_colours(pick: pick, omit: omit)
+  end
+
+  private
+
+  def self.get_colour_from_collections(hex, pick, omit)
+    colour = nil
+
+    self.list_collections.each do |collection_name|
+      next unless (pick.empty? || pick.include?(collection_name)) && !omit.include?(collection_name)
+
+      colour = ColorSwatchCollection.get_from_hex(hex, pick: [collection_name])
+
+      break if colour.present?
+    end
+
+    colour || {}
+  end
+end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: color_namer_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Louis Davis
 bindir: bin
 cert_chain: []
-date: 2025-06-21 00:00:00.000000000 Z
+date: 2025-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3
 - !ruby/object:Gem::Dependency
   name: color_conversion
   requirement: !ruby/object:Gem::Requirement
@@ -24,19 +38,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.2
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: color_swatch_collection
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 description: Provide a color in a variety of formats and get a name back based on
   a range of colour options and see how closely they match your color.
 email:
@@ -48,15 +62,8 @@ files:
 - README.md
 - Rakefile
 - lib/color_namer_ruby.rb
-- lib/color_namer_ruby/basic.rb
 - lib/color_namer_ruby/distance.rb
-- lib/color_namer_ruby/html.rb
-- lib/color_namer_ruby/namer.rb
-- lib/color_namer_ruby/ntc.rb
-- lib/color_namer_ruby/pantone.rb
-- lib/color_namer_ruby/roygbiv.rb
 - lib/color_namer_ruby/version.rb
-- lib/color_namer_ruby/x11.rb
 homepage: https://github.com/louiswdavis/color_namer_ruby
 licenses:
 - MIT

data/lib/color_namer_ruby/basic.rb

@@ -1,36 +0,0 @@
-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
-