human_colour 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f61159dfb6700a4655b71b7b0dde3d7dff974453210cdb74281e34bab78b1782
-  data.tar.gz: 9d65916d7129cb05ac2ead4db9d0e827fb9841ef59fecbfc681d19dffa50e472
+  metadata.gz: 47af2da1e39857844b4b6586da5dadb801036478f497a9f112cff41f563c1e70
+  data.tar.gz: 8327b50b7b74ce6f111b8d9eac377aca5646d929a718b3fd21084c6514ce6030
 SHA512:
-  metadata.gz: a0982688d4fc4046d24a1c50eec07f0c93439bcdf0cbd541802866b62e2b0f4635e996c2aa2c3ee3c69883b7bef45603fbb58acf9a66e8eca4a6adb21a096796
-  data.tar.gz: fac3b685fa6b7653881e9622705b1fac443bd00ac4725534daba4aee949ff5a7306fa79453db4a5c941c229b78ee90120e3e25c5a592c17d8b7443e001547d53
+  metadata.gz: 6e7aaba52e1d446819301ab65bd3fa57a93652a998ac0c81468ef4b000e7e1f784e42bb854dac040d5c1af0bfa64e5e40e1e398bfa6ec39936253c5d6cad9f0d
+  data.tar.gz: e9aa06df3f2ca7b42370a0ec7c85297a4cbf050fe6fd4d78c78576ac15045cb1119a53b675f3bd9f48c65dc4b76aa946f112d5ba7afb9fb90882592a7ba2834f

data/.rubocop.yml

@@ -28,6 +28,12 @@ Layout/LineContinuationSpacing: # new in 1.31
   Enabled: true
 Layout/LineEndStringConcatenationIndentation: # new in 1.18
   Enabled: true
+Layout/LineLength:
+  Exclude:
+    - "spec/**/*.rb"
+Layout/HashAlignment:
+  Exclude:
+    - "spec/**/*.rb"
 Layout/SpaceBeforeBrackets: # new in 1.7
   Enabled: true
 Lint/AmbiguousAssignment: # new in 1.7
@@ -293,5 +299,7 @@ Style/SuperWithArgsParentheses: # new in 1.58
   Enabled: true
 Style/SwapValues: # new in 1.1
   Enabled: true
+Style/SymbolArray:
+  Enabled: false
 Style/YAMLFileRead: # new in 1.53
   Enabled: true

data/README.md

@@ -19,8 +19,17 @@ gem install human_colour
 ## Usage
 
 ```ruby
+  require "human_colour"
+
   HumanColour.parse("rgb(128,64,0)")
-  #> "dark orange"
+  #=> "dark orange"
+
+  # Return a colour based on the provided locale (:de, :en, :es, :fr, :it, :pt)
+  HumanColour.parse("rgb(128,64,0)", locale: :es)
+  #=> "naranja oscuro"
+
+  HumanColour.parse("rgb(255, 128, 255", locale: :de)
+  #=> "hell lila"
 ```
 
 ![alt text](https://github.com/mconnell/human_colour/blob/main/doc/colours.png?raw=true)

data/lib/human_colour/locales.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ModuleLength
+module HumanColour
+  LOCALES = {
+    en: {
+      tone: {
+        light: "light",
+        dark: "dark"
+      },
+      colour: {
+        red: "red",
+        brown: "brown",
+        orange: "orange",
+        yellow: "yellow",
+        green: "green",
+        blue: "blue",
+        purple: "purple",
+        pink: "pink",
+        grey: "grey",
+        black: "black",
+        white: "white"
+      }
+    },
+
+    es: {
+      tone: {
+        light: "claro",
+        dark: "oscuro"
+      },
+      colour: {
+        red: "rojo",
+        brown: "marrón",
+        orange: "naranja",
+        yellow: "amarillo",
+        green: "verde",
+        blue: "azul",
+        purple: "morado",
+        pink: "rosa",
+        grey: "gris",
+        black: "negro",
+        white: "blanco"
+      }
+    },
+
+    it: {
+      tone: {
+        light: "chiaro",
+        dark: "scuro"
+      },
+      colour: {
+        red: "rosso",
+        brown: "marrone",
+        orange: "arancione",
+        yellow: "giallo",
+        green: "verde",
+        blue: "blu",
+        purple: "viola",
+        pink: "rosa",
+        grey: "grigio",
+        black: "nero",
+        white: "bianco"
+      }
+    },
+
+    fr: {
+      tone: {
+        light: "clair",
+        dark: "foncé"
+      },
+      colour: {
+        red: "rouge",
+        brown: "brun",
+        orange: "orange",
+        yellow: "jaune",
+        green: "vert",
+        blue: "bleu",
+        purple: "violet",
+        pink: "rose",
+        grey: "gris",
+        black: "noir",
+        white: "blanc"
+      }
+    },
+
+    de: {
+      tone: {
+        light: "hell",
+        dark: "dunkel"
+      },
+      colour: {
+        red: "rot",
+        brown: "braun",
+        orange: "orange",
+        yellow: "gelb",
+        green: "grün",
+        blue: "blau",
+        purple: "lila",
+        pink: "rosa",
+        grey: "grau",
+        black: "schwarz",
+        white: "weiß"
+      }
+    },
+
+    pt: {
+      tone: {
+        light: "claro",
+        dark: "escuro"
+      },
+      colour: {
+        red: "vermelho",
+        brown: "marrom",
+        orange: "laranja",
+        yellow: "amarelo",
+        green: "verde",
+        blue: "azul",
+        purple: "roxo",
+        pink: "rosa",
+        grey: "cinza",
+        black: "preto",
+        white: "branco"
+      }
+    }
+  }.freeze
+end
+# rubocop:enable Metrics/ModuleLength

data/lib/human_colour/version.rb

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

data/lib/human_colour.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
 require_relative "human_colour/version"
+require_relative "human_colour/locales"
 
 module HumanColour
   class Error < StandardError; end
 
   # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-  def self.parse(rgb_string)
+  def self.parse(rgb_string, locale: :en)
     matches = rgb_string.match(/rgb\((\d+),\s*(\d+),\s*(\d+)\)/i)
     raise Error if matches.nil?
 
+    return LOCALES[locale][:colour][:white] if rgb_string == "rgb(255,255,255)"
+    return LOCALES[locale][:colour][:black] if rgb_string == "rgb(0,0,0)"
+
     red   = matches[1].to_i / 255.0
     green = matches[2].to_i / 255.0
     blue  = matches[3].to_i / 255.0
@@ -18,16 +22,17 @@ module HumanColour
     d = delta(red: red, green: green, blue: blue)
     s = saturation(delta: d, lightness: l)
     h = hue(delta: d, red: red, green: green, blue: blue)
-    t = tone(lightness: l, hue: h)
-    c = colour(saturation: s, hue: h)
-
-    name = [t, c].compact.join(" ")
+    c = colour(saturation: s, hue: h, lightness: l)
+    t = tone(lightness: l, hue: h, base: c)
 
-    # alias extremes for nicer names
-    return "white" if rgb_string == "rgb(255,255,255)"
-    return "black" if rgb_string == "rgb(0,0,0)"
+    localised_tone   = LOCALES[locale][:tone][t]
+    localised_colour = LOCALES[locale][:colour][c]
 
-    name
+    if [:en, :de].include?(locale)
+      [localised_tone, localised_colour].compact.join(" ")
+    else
+      [localised_colour, localised_tone].compact.join(" ")
+    end
   end
   # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
@@ -65,28 +70,32 @@ module HumanColour
   end
   private_class_method :hue
 
-  def self.tone(lightness:, hue:)
-    return nil if (260..320).cover?(hue) && lightness >= 0.22 && lightness < 0.28
-    return "dark" if lightness < 0.28
-    return "light" if lightness > 0.74
+  def self.tone(lightness:, hue:, base:)
+    return nil if (260..320).cover?(hue) && lightness.between?(0.22, 0.28)
+    return nil if base == :brown
+
+    # All other hues
+    return :dark  if lightness < 0.28
+    return :light if lightness > 0.74
 
     nil
   end
   private_class_method :tone
 
   # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
-  def self.colour(saturation:, hue:)
-    return "grey" if saturation < 0.15
+  def self.colour(saturation:, hue:, lightness:)
+    return :grey if saturation < 0.15
+    return :brown if (15..50).cover?(hue) && lightness < 0.5
 
     case hue
-    when 0...15, 355..360 then "red"
-    when 15...45          then "orange"
-    when 45...70          then "yellow"
-    when 70...170         then "green"
-    when 170...250        then "blue"
-    when 250...320        then "purple"
-    when 320...355        then "pink"
-    else                       "grey"
+    when 0...15, 355..360 then :red
+    when 15...45          then :orange
+    when 45...70          then :yellow
+    when 70...170         then :green
+    when 170...250        then :blue
+    when 250...320        then :purple
+    when 320...355        then :pink
+    else                       :grey
     end
   end
   # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: human_colour
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Connell
@@ -22,6 +22,7 @@ files:
 - Rakefile
 - doc/colours.png
 - lib/human_colour.rb
+- lib/human_colour/locales.rb
 - lib/human_colour/version.rb
 - sig/human_colour.rbs
 homepage: https://github.com/mconnell/human_colour