ruby_color_contrast_checker 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fd5330a1a1884e0a960e1eac58998c665f7b48a31325f365d01adf7547e73c1
-  data.tar.gz: 9e5b4cac1f28ba6066903ed0d0ff4a3680f6845e9251a90eb95c435b928b35cf
+  metadata.gz: 41127405d0f39eaf9fa5f9ac4743232a3644fe4a0ce8cda366762fc74c4c4a28
+  data.tar.gz: d48a9034eb3f53f6fbbf8123c777a0ec53a75037fe8fe82942b9dc228d0cfa64
 SHA512:
-  metadata.gz: 68c4a10255ec90887ea0d107c70c969dba2b7d2333d563273b0db94da5e52481c9c8a1c4064a76c45c8fda92727965ab94317696f30b4e5efdaca819990f0802
-  data.tar.gz: 2af2e9180497133de98f1be80d09c9d36088b8636b83045b53d300d7fe6bf4f12640150cbe92ef6dd305a4c28d50d8965547031eb3d8fb3d7ce05ec208e578f1
+  metadata.gz: c5c5cf0bc32f2f378a929e298feedcf589efd4bf2d360b84040947093e8543c35dbb721087eb8192c5fd9607330a56988aafcef223e04f6f46019fdc4047a3bf
+  data.tar.gz: d75486f0d90127c0031e9fb8f5575b80a22cd242f30a26f6184c63af7e7f3f6ef0b0599d786da506de5edadaf444e45d84056f13977bc41379cf35fa88f80355

data/Gemfile

@@ -4,3 +4,9 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in ruby_color_contrast_checker.gemspec
 gemspec
+
+gem "rake"
+gem "rspec"
+gem "standard"
+gem "simplecov"
+gem "simplecov-cobertura"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_color_contrast_checker (0.1.0)
+    ruby_color_contrast_checker (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -52,6 +52,9 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     standard (1.28.4)
@@ -71,11 +74,12 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  rake
+  rspec
   ruby_color_contrast_checker!
-  simplecov (~> 0.21.2)
-  standard (~> 1.3)
+  simplecov
+  simplecov-cobertura
+  standard
 
 BUNDLED WITH
    2.4.7

data/README.md

@@ -1,39 +1,136 @@
-# RubyColorContrastChecker
+<div align="center">
+  <h1 align="center">Ruby Color Contrast Checker</h1>
+  <p align="center">CLI interface for checking WCAG2.0 Color Contrast Ratio in Ruby.</p>
+</div>
+
+<br />
+
+<div align="center">
+  <a href="https://badge.fury.io/rb/ruby_color_contrast_checker">
+    <img alt="Gem Version" src="https://badge.fury.io/rb/ruby_color_contrast_checker.svg" />
+  </a>
+  &nbsp;
+  <a href="https://github.com/cheehwatang/ruby_color_contrast_checker/blob/main/LICENSE.txt">
+    <img alt="GitHub license" src="https://img.shields.io/github/license/cheehwatang/ruby_color_contrast_checker" />
+  </a>
+  &nbsp;
+  <a href="#">
+    <img alt="Tests Passing" src="https://github.com/cheehwatang/ruby_color_contrast_checker/workflows/Test/badge.svg" />
+  </a>
+  &nbsp;
+  <a href="#">
+    <img alt="Lint Passing" src="https://github.com/cheehwatang/ruby_color_contrast_checker/workflows/Lint/badge.svg" />
+  </a>
+  &nbsp;
+  <a href="#">
+    <img alt="Code Coverage Percentage" src="https://codecov.io/gh/cheehwatang/ruby_color_contrast_checker/branch/master/graph/badge.svg" />
+  </a>
+  &nbsp;
+  <a href="https://github.com/standardrb/standard">
+    <img alt="Ruby Code Style" src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" />
+  </a>
+  &nbsp;
+  <a href="#">
+    <img alt="Repository Top Language" src="https://img.shields.io/github/languages/top/cheehwatang/ruby_color_contrast_checker" />
+  </a>
+</div>
+
+<br />
+
+<hr />
+
+<br />
+
+Check if the 2 colors provided pass the AA and AAA Levels (including for Large Text and Icons), according to [WCAG 2.1 guidelines](https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum.html).
+
+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
+
+Note:
+
+Large is for regular text with 18pt or larger, or bold text with 14pt or larger.
+
+Logo generally fall into the large category.
+
+It is recommended to fulfill at least Level AA for your projects.
+
+<br />
 
-TODO: Delete this and the text below, and describe your gem
+## Installation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby_color_contrast_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
+Install the gem:
 
-## Installation
+```console
+$ gem install ruby_color_contrast_checker
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+<br />
 
-Install the gem and add to the application's Gemfile by executing:
+## Usage
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Run the `contrast_checker` executable:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```shell
+$ contrast_checker
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+       ------------------------------------
+      |  Welcome to Color Contrast Checker  |
+       ------------------------------------
+                \   ^__^
+                 \  (oo)_______
+                    (__)\       )\/\
+                        ||----w |
+                        ||     ||
 
-## Usage
+Enter the first hex color string:
+> #000000
+Enter the second hex color string:
+> #FFFFFF
+
+Contrast Ratio    : 21
+
+Level AA          : PASS
+Level AA (Large)  : PASS
+Level AAA         : PASS
+Level AAA (Large) : PASS
+```
+
+![Color Contrast Checker CLI](./assets/color_contrast_checker_cli.png)
 
-TODO: Write usage instructions here
+<br />
 
 ## 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+<br />
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_color_contrast_checker. 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]/ruby_color_contrast_checker/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/cheehwatang/ruby_color_contrast_checker. 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/cheehwatang/ruby_color_contrast_checker/blob/master/CODE_OF_CONDUCT.md).
+
+<br />
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+<br />
+
 ## Code of Conduct
 
-Everyone interacting in the RubyColorContrastChecker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_color_contrast_checker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ruby Color Contrast Checker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cheehwatang/ruby_color_contrast_checker/blob/master/CODE_OF_CONDUCT.md).
+
+<br />
+
+## 🌟 Special Thanks
+
+- [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.1.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
+
+      if !valid_hex?(first) || !valid_hex?(second)
+        print_error_message
+      else
+        data = get_result(first, second)
+        print_data(data)
+      end
 
-    uri = URI.parse("https://webaim.org/resources/contrastchecker/?fcolor=#{hex1}&bcolor=#{hex2}&api")
-    response = Net::HTTP.get_response(uri)
+      puts
+      input = prompt_input("\e[33mContinue?\e[0m (\e[32myes\e[0m / \e[31mno\e[0m) ")
+      break if input.downcase == "no"
+    end
+  end
 
-    JSON.parse(response.body)
+  def valid_hex?(hex)
+    !!(hex =~ /^[a-f0-9]{6}$/i) || !!(hex =~ /^[a-f0-9]{3}$/i)
   end
 
   def convert_3hex_to_6hex(hex)
@@ -29,6 +38,54 @@ module RubyColorContrastChecker
     "#{chars[0]}#{chars[0]}#{chars[1]}#{chars[1]}#{chars[2]}#{chars[2]}"
   end
 
+  def calculate_contrast_ratio(hex1, hex2)
+    rgb1 = convert_6hex_to_rgb_hash(hex1)
+    rgb2 = convert_6hex_to_rgb_hash(hex2)
+
+    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
+
+  # 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 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
+
+    (rgb[:r] * 0.2126 + rgb[:g] * 0.7152 + rgb[:b] * 0.0722).round(4)
+  end
+
+  def pass_or_fail(value, threshold)
+    (value >= threshold) ? "PASS" : "FAIL"
+  end
+
+  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
+
+    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
@@ -36,34 +93,57 @@ module RubyColorContrastChecker
 
   def print_data(data)
     output = <<~MLS
-      Contrast Ratio    : #{data["ratio"]}
+      \e[36mContrast Ratio\e[0m    : #{colorize_float(data["ratio"])}
 
-      Level AA          : #{data["AA"].upcase}
-      Level AA (Large)  : #{data["AALarge"].upcase}
-      Level AAA         : #{data["AAA"].upcase}
-      Level AAA (Large) : #{data["AAALarge"].upcase}
+      \e[36mLevel AA\e[0m          : #{colorize_status(data["AA"])}
+      \e[36mLevel AA (Large)\e[0m  : #{colorize_status(data["AALarge"])}
+      \e[36mLevel AAA\e[0m         : #{colorize_status(data["AAA"])}
+      \e[36mLevel AAA (Large)\e[0m : #{colorize_status(data["AAALarge"])}
     MLS
 
     puts output
   end
 
-  def run
-    loop do
-      puts
-      first = prompt_input("Enter the first hex color string: \n> #")
-      second = prompt_input("Enter the second hex color string: \n> #")
-      puts
+  def print_welcome_message
+    welcome_message = <<~MLS
+      \e[36m   ------------------------------------   \e[0m
+      \e[36m  |  Welcome to Color Contrast Checker  | \e[0m
+      \e[36m   ------------------------------------   \e[0m
+                \\   ^__^
+                 \\  (oo)_______
+                    (__)\\       )\\/\\
+                        ||----w |
+                        ||     ||
+    MLS
 
-      if !valid_hex?(first) || !valid_hex?(second)
-        puts "The Hex color code is invalid."
-      else
-        data = fetch_data(first, second)
-        print_data(data)
-      end
+    puts welcome_message
+  end
 
-      puts
-      input = prompt_input("Continue? (yes / no) ")
-      break if input.downcase == "no"
-    end
+  def print_error_message
+    puts "\e[31mThe Hex color code is invalid.\e[0m"
+  end
+
+  # Helper methods to colorize string based on the conditions.
+  def colorize_float(float_string)
+    return red(float_string) if Float(float_string) < 4.5
+
+    green(float_string)
+  end
+
+  def colorize_status(status_string)
+    status_string = status_string.upcase
+
+    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

data/ruby_color_contrast_checker.gemspec

@@ -29,9 +29,4 @@ Gem::Specification.new do |spec|
   end
   spec.executables = ["contrast_checker"]
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 1.3"
-  spec.add_development_dependency "simplecov", "~> 0.21.2"
 end

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_color_contrast_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.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
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
+date: 2023-05-31 00:00:00.000000000 Z
+dependencies: []
 description: 'CLI interface for WCAG Color Contrast Checking in Ruby '
 email:
 - cheehwa.tang@gmail.com
@@ -83,6 +27,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/color_contrast_checker_cli.png
 - bin/contrast_checker
 - lib/ruby_color_contrast_checker.rb
 - lib/ruby_color_contrast_checker/version.rb