color_namer_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99e55c151479cf0f2bdccedd02fe6e5632bf4cc2becc0c6bb35df9396429f53e
-  data.tar.gz: c1ed71d2712b45c0ec8174c8049995aceb5faeaf3a8552f108676e03c3b43156
+  metadata.gz: de06760f8ad6bed10d51aa558ac1c5eec436bb432d11e338020d293ce900516b
+  data.tar.gz: 9997efc3fb2e420b357d03d23f032df939019476d560759def9c316a93a76213
 SHA512:
-  metadata.gz: 598275d62f010ac8d7914644d284c7eee421509b8e3f38b98542adc0521037301ae092b87b986f11faac30cece71f2322ffcc9244d1ea29aa242061e1738e329
-  data.tar.gz: 29a288b098fa9de4f119b7a4b55a97bee14bf4a4cb47f7a18df9344ed801ed8df5859aa5b41f715edaad3fc59c54a394c1b5cc857c3bec97003fd73ce93bfd5c
+  metadata.gz: 1b26c67fcaf715ef105c2e38515ad54088af31edc2a4bbd0fabd2af160b55b7324594e055b527249eeefa0ec23103878fba08de05a69525f529bbc4862c7dcb9
+  data.tar.gz: 947105f26f503f32a92aca9a381787dac3553ef8ea50c0e6043b4049975c24ccee2d1c582f5b0a6502da7145ce306915d4f4fdbaaba2ff7ab7f296aa75b4cac5

data/README.md

@@ -12,14 +12,8 @@ Mike Bostock of [D3](http://d3js.org/) fame [explains it well](https://gist.gith
 
 ## 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.
+The color names are derived from several lists in the [ColorSwatchCollection gem](https://github.com/louiswdavis/color_swatch_collection).
+Because of the number of swatches, if you put in a "basic" colour like "blue" there are many interpretations across the lists of what that colour should be so it may not match your expectation.
 
 ## Installation
 
@@ -55,7 +49,7 @@ Get a list of the colour collections that can be checked against.
 
 ```ruby
 ColorNamerRuby.list_collections
-=> ['basic', 'html', 'ntc', 'pantone', 'roygbiv', 'x11']
+=> ["basic", "html", "ntc", "pantone", "roygbiv", "x11", "tailwind_v1", "tailwind_v2", "tailwind_v3", "tailwind_v4"]
 ```
 
 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.
@@ -63,31 +57,31 @@ When passing colours with their properties assigned to keys, you need to pass ni
 
 ```ruby
 ColorNamerRuby.get_name('#3672b4')
-=> ['azure']
+=> ["blue-700"]
 
 ColorNamerRuby.get_name('', r: 70, g: 130, b: 180, a: 0.5)
-=> ['steelblue']
+=> ["steelblue"]
 
 ColorNamerRuby.get_name('', r: 130, g: 180, b: 70)
-=> ['sushi']
+=> ["sushi"]
 
 ColorNamerRuby.get_name('', h: 20, s: 73, l: 20)
-=> ['cioccolato']
+=> ["cioccolato"]
 
 ColorNamerRuby.get_name(nil, h: 107, s: 61, v: 71)
-=> ['apple']
+=> ["apple"]
 
 ColorNamerRuby.get_name(nil, h: 61, s: 71, b: 32)
-=> ['camouflage']
+=> ["camouflage"]
 
 ColorNamerRuby.get_name(nil, c: 71, m: 15, y: 5, k: 54)
-=> ['blue dianne']
+=> ["blue dianne"]
 
 ColorNamerRuby.get_name('rgb(51, 102, 204)')
-=> ['denim']
+=> ["denim"]
 
 ColorNamerRuby.get_name('hsl(225, 73%, 57%)')
-=> ['royalblue']
+=> ["royalblue"]
 ```
 
 Get a list of colour names sorted by their perceptual similarity to the given color by using `.get_names`.
@@ -95,7 +89,7 @@ Again, when passing colours with their properties assigned to keys, you need to
 
 ```ruby
 ColorNamerRuby.get_names('#3672b4')
-=> ['azure', 'st tropaz', 'denim', 'steelblue', ...]
+=> ["blue-700", "azure", "blue-600", "st tropaz", "denim", "steelblue", ...]
 ```
 
 Get a list of all the colour names across the lists that can be checked against.
@@ -111,7 +105,7 @@ When passing colours with their properties assigned to keys, you need to pass ni
 
 ```ruby
 ColorNamerRuby.get_colour('#3672b4')
-=> [{ distance: 8.660254037844387, hex: '#315BA1', name: 'azure' }]
+=> [{ distance: 7.615773105863909, hex: "#2B6CB0", name: "blue-700" }]
 ```
 
 Get a list of colour hashes sorted by their perceptual similarity to the given color by using `.get_colours`.
@@ -120,9 +114,11 @@ Again, when passing colours with their properties assigned to keys, you need to
 ```ruby
 ColorNamerRuby.get_colours('#3672b4')
 => [
-=>   { distance: 8.660254037844387, hex: '#315BA1', name: 'azure' },
-=>   { distance: 9.9498743710662, hex: '#2D569B', name: 'st tropaz' },
-=>   { distance: 10.81665382639196, name: 'denim' },
+=>   { distance: 7.615773105863909, hex: "#2B6CB0", name: "blue-700" },
+=>   { distance: 8.660254037844387, hex: "#315BA1", name: "azure" },
+=>   { distance: 9.16515138991168, hex: "#3182CE", name: "blue-600" },
+=>   { distance: 9.9498743710662, hex: "#2D569B", name: "st tropaz" },
+=>   { distance: 10.816653826391969, hex: "#2B6CC4", name: "denim" },
 =>   .
 =>   .
 =>   .
@@ -152,6 +148,7 @@ It can be used for `get_name`, `get_names`, `get_all_names`, or `get_colour`, `g
 
 ```ruby
 ColorNamerRuby.get_names('#3672b4', pick: ['basic', 'x11'])
+=> ["steelblue", "royalblue", "cornflowerblue", "lightsteelblue", "mediumturquoise", ...]
 ```
 
 ### omit
@@ -160,7 +157,8 @@ The opposite of `options.pick`.
 It can be used for `get_name`, `get_names`, `get_all_names`, or `get_colour`, `get_colours`, `get_all_colours`.
 
 ```ruby
-ColorNamerRuby.get_names('#3672b4', omit: ['pantone', 'roygbiv'])
+ColorNamerRuby.get_names('#3672b4', omit: ['pantone', 'roygbiv', 'tailwind_v1'])
+=> ["azure", "st tropaz", "steelblue", "steelblue", "steel blue", ...]
 ```
 
 ### limit
@@ -169,7 +167,8 @@ This option allows us to limit the number of names that are returned to keep the
 It can be used for `get_names`, or `get_colours` (since `get_name` and  `get_colour` already have a limit of 1).
 
 ```ruby
-ColorNamerRuby.get_names('#3672b4', limit: 5)
+ColorNamerRuby.get_names('#3672b4', limit: 3)
+=> ["blue-700", "azure", "blue-600"]
 ```
 
 ###

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

@@ -2,6 +2,7 @@
 
 require 'color_conversion'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
 
 module ColorNamerRuby
   class Distance
@@ -13,7 +14,7 @@ module ColorNamerRuby
       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)
+        colour_lists += self.get_colour_distances_in_list(Object.const_get("ColorSwatchCollection::#{collection_name.classify}").colours)
       end
 
       colour_lists = colour_lists.flatten.compact.reject(&:empty?)

data/lib/color_namer_ruby/version.rb

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

data/lib/color_namer_ruby.rb

@@ -1,70 +1,70 @@
-# 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
+# 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: color_namer_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Louis Davis
 bindir: bin
 cert_chain: []
-date: 2025-08-19 00:00:00.000000000 Z
+date: 2025-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 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: