ruby_color_contrast_checker 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40345e8b055888a53d71039c61513b0d6db1dd83acdf35657921bc9a303eed9f
-  data.tar.gz: 47be0542a7799e2b788596e395ac989fddee8035bb66561c61cea513a298c157
+  metadata.gz: 41127405d0f39eaf9fa5f9ac4743232a3644fe4a0ce8cda366762fc74c4c4a28
+  data.tar.gz: d48a9034eb3f53f6fbbf8123c777a0ec53a75037fe8fe82942b9dc228d0cfa64
 SHA512:
-  metadata.gz: 5fb1724ffe3dab3f991e1a896c83282b5cb997be99faecd2eaa27ec814f38417d75bd1166113e50333e351eaa76544bc315762dbacefbe588c3d55047150878f
-  data.tar.gz: 1c340332128989b61e3a4460d052597664e8ec46389c5d259ee01c4e88e71435b5aa713a89dad184e49a36e5fae431937aa0786f6fd8619ae33fd990949e8cea
+  metadata.gz: c5c5cf0bc32f2f378a929e298feedcf589efd4bf2d360b84040947093e8543c35dbb721087eb8192c5fd9607330a56988aafcef223e04f6f46019fdc4047a3bf
+  data.tar.gz: d75486f0d90127c0031e9fb8f5575b80a22cd242f30a26f6184c63af7e7f3f6ef0b0599d786da506de5edadaf444e45d84056f13977bc41379cf35fa88f80355

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_color_contrast_checker (0.2.0)
+    ruby_color_contrast_checker (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -47,10 +47,10 @@ Further information can be found [here](https://webaim.org/articles/contrast/).
 
 In summary:
 
-- Level AA : Ratio > 4.5
-- Level AA (Large) : Ratio > 3.0
-- Level AAA : Ratio > 7.0
-- Level AAA (Large) : Ratio > 4.5
+- Level AA : Ratio >= 4.5
+- Level AA (Large) : Ratio >= 3.0
+- Level AAA : Ratio >= 7.0
+- Level AAA (Large) : Ratio >= 4.5
 
 Note:
 
@@ -133,5 +133,4 @@ Everyone interacting in the Ruby Color Contrast Checker project's codebases, iss
 
 ## 🌟 Special Thanks
 
-- [WebAIM Contrast Checker API](https://webaim.org/resources/contrastchecker/) for the contrast checker API.
 - [Richard Bates](https://github.com/richo225) for the [blog post](https://richardbates.dev/blog/2023-05-05) on releasing a gem.

data/lib/ruby_color_contrast_checker/version.rb

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

data/lib/ruby_color_contrast_checker.rb

@@ -1,27 +1,36 @@
 # frozen_string_literal: true
 
 require_relative "ruby_color_contrast_checker/version"
-require "uri"
-require "net/http"
-require "json"
 
 module RubyColorContrastChecker
   def self.run
     Class.new { extend RubyColorContrastChecker }.run
   end
 
-  def valid_hex?(hex)
-    !!(hex =~ /^[a-f0-9]{6}$/i) || !!(hex =~ /^[a-f0-9]{3}$/i)
-  end
+  def run
+    print_welcome_message
 
-  def fetch_data(hex1, hex2)
-    hex1 = convert_3hex_to_6hex(hex1) if hex1.length == 3
-    hex2 = convert_3hex_to_6hex(hex2) if hex2.length == 3
+    loop do
+      puts
+      first = prompt_input("\e[36mEnter the first hex color string:\e[0m \n\e[30m> #\e[0m")
+      second = prompt_input("\e[36mEnter the second hex color string:\e[0m \n\e[30m> #\e[0m")
+      puts
 
-    uri = URI.parse("https://webaim.org/resources/contrastchecker/?fcolor=#{hex1}&bcolor=#{hex2}&api")
-    response = Net::HTTP.get_response(uri)
+      if !valid_hex?(first) || !valid_hex?(second)
+        print_error_message
+      else
+        data = get_result(first, second)
+        print_data(data)
+      end
 
-    JSON.parse(response.body)
+      puts
+      input = prompt_input("\e[33mContinue?\e[0m (\e[32myes\e[0m / \e[31mno\e[0m) ")
+      break if input.downcase == "no"
+    end
+  end
+
+  def valid_hex?(hex)
+    !!(hex =~ /^[a-f0-9]{6}$/i) || !!(hex =~ /^[a-f0-9]{3}$/i)
   end
 
   def convert_3hex_to_6hex(hex)
@@ -29,31 +38,57 @@ module RubyColorContrastChecker
     "#{chars[0]}#{chars[0]}#{chars[1]}#{chars[1]}#{chars[2]}#{chars[2]}"
   end
 
-  def prompt_input(message)
-    print message
-    gets.chomp
-  end
+  def calculate_contrast_ratio(hex1, hex2)
+    rgb1 = convert_6hex_to_rgb_hash(hex1)
+    rgb2 = convert_6hex_to_rgb_hash(hex2)
 
-  def red(string)
-    "\e[31m#{string}\e[0m"
+    luminance1 = calculate_luminance(rgb1)
+    luminance2 = calculate_luminance(rgb2)
+
+    ((luminance1 > luminance2) ? ((luminance1 + 0.05) / (luminance2 + 0.05)) : ((luminance2 + 0.05) / (luminance1 + 0.05))).round(2)
   end
 
-  def green(string)
-    "\e[32m#{string}\e[0m"
+  # Helper methods to calculate contrast ratio
+  def convert_6hex_to_rgb_hash(hex)
+    value = Integer(hex, 16)
+    r = (value >> 16) & 255
+    g = (value >> 8) & 255
+    b = value & 255
+
+    {r:, g:, b:}
   end
 
-  def colorize_float(float_string)
-    return red(float_string) if Float(float_string) < 4.5
+  def calculate_luminance(rgb)
+    rgb.each do |key, value|
+      value /= 255.0
+      rgb[key] = ((value <= 0.03928) ? value / 12.92 : ((value + 0.055) / 1.055)**2.4)
+    end
 
-    green(float_string)
+    (rgb[:r] * 0.2126 + rgb[:g] * 0.7152 + rgb[:b] * 0.0722).round(4)
   end
 
-  def colorize_status(status_string)
-    status_string = status_string.upcase
+  def pass_or_fail(value, threshold)
+    (value >= threshold) ? "PASS" : "FAIL"
+  end
 
-    return red(status_string) if status_string == "FAIL"
+  def get_result(hex1, hex2)
+    hex1 = convert_3hex_to_6hex(hex1) if hex1.length == 3
+    hex2 = convert_3hex_to_6hex(hex2) if hex2.length == 3
 
-    green(status_string)
+    contrast_ratio = calculate_contrast_ratio(hex1, hex2)
+
+    {
+      "ratio" => contrast_ratio.to_s,
+      "AA" => pass_or_fail(contrast_ratio, 4.5),
+      "AALarge" => pass_or_fail(contrast_ratio, 3.0),
+      "AAA" => pass_or_fail(contrast_ratio, 7.0),
+      "AAALarge" => pass_or_fail(contrast_ratio, 4.5)
+    }
+  end
+
+  def prompt_input(message)
+    print message
+    gets.chomp
   end
 
   def print_data(data)
@@ -88,25 +123,27 @@ module RubyColorContrastChecker
     puts "\e[31mThe Hex color code is invalid.\e[0m"
   end
 
-  def run
-    print_welcome_message
+  # Helper methods to colorize string based on the conditions.
+  def colorize_float(float_string)
+    return red(float_string) if Float(float_string) < 4.5
 
-    loop do
-      puts
-      first = prompt_input("\e[36mEnter the first hex color string:\e[0m \n\e[30m> #\e[0m")
-      second = prompt_input("\e[36mEnter the second hex color string:\e[0m \n\e[30m> #\e[0m")
-      puts
+    green(float_string)
+  end
 
-      if !valid_hex?(first) || !valid_hex?(second)
-        print_error_message
-      else
-        data = fetch_data(first, second)
-        print_data(data)
-      end
+  def colorize_status(status_string)
+    status_string = status_string.upcase
 
-      puts
-      input = prompt_input("\e[33mContinue?\e[0m (\e[32myes\e[0m / \e[31mno\e[0m) ")
-      break if input.downcase == "no"
-    end
+    return red(status_string) if status_string == "FAIL"
+
+    green(status_string)
+  end
+
+  # Helper methods to colorize string.
+  def red(string)
+    "\e[31m#{string}\e[0m"
+  end
+
+  def green(string)
+    "\e[32m#{string}\e[0m"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_color_contrast_checker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chee Hwa Tang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies: []
 description: 'CLI interface for WCAG Color Contrast Checking in Ruby '
 email: