color_corrector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e949065e4e833524707fd819b09f952e84805dba
+  data.tar.gz: 5db4477bf399c53f7459fd04df3a76f9710a7057
+SHA512:
+  metadata.gz: 17221c17cecbca24f7707d81d575d8afdb396b8f41cb87a7ef6ca864aec62a720e996201d8183e376275c21c710f139c096a60aad1ef31586cba613218ffeb22
+  data.tar.gz: 8c8edb9e234148281c9100828b7017b777f2cbd61573a24330612373d521063c710e18dd981bd9c202a8a33dc2c880929517e956de2c47dd960244b737b51419

data/lib/color_corrector.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'color_corrector/color'
+require 'color_corrector/version'
+
+# # Color Corrector
+module ColorCorrector
+  ONE_SIXTH = 1 / 6.0
+  ONE_THIRD = 1 / 3.0
+  TWO_THIRDS = 2 / 3.0
+
+  class << self
+    def make_readable(background, foreground, level = 'AA', size = 'large')
+      until readable?(background, foreground, level, size)
+        background = if light?(foreground)
+                       darken(background)
+                     else
+                       lighten(background)
+                     end
+      end
+      background
+    end
+
+    def readable?(background, foreground, level = 'AA', size = 'large')
+      ratio = contrast_ratio(background, foreground)
+      contrast = case [level, size]
+                 when %w[AA large]
+                   3
+                 when %w[AAA small]
+                   7
+                 else # %w[AA small], %w[AAA large]
+                   4.5
+                 end
+      ratio >= contrast
+    end
+
+    def contrast_ratio(background, foreground)
+      background = background.delete('#')
+      foreground = foreground.delete('#')
+      ratio(background, foreground)
+    end
+
+    def darken(hex_color, amount = 0.01)
+      red, green, blue = hex_color.delete('#').scan(/../).map(&:hex)
+      hue, saturation, lightness = rgb_to_hsl(red, blue, green)
+      lightness -= amount
+      rgb = hsl_to_rgb(hue, saturation, lightness)
+      format '#%02x%02x%02x', *rgb
+    end
+
+    def lighten(hex_color, amount = 0.01)
+      red, green, blue = hex_color.delete('#').scan(/../).map(&:hex)
+      hue, saturation, lightness = rgb_to_hsl(red, blue, green)
+      lightness += amount
+      rgb = hsl_to_rgb(hue, saturation, lightness)
+      format '#%02x%02x%02x', *rgb
+    end
+
+    def rgb_to_hsl(red, blue, green)
+      components = [red, blue, green].map { |chroma| chroma / 255.0 }
+      max = components.max
+      min = components.min
+      red, blue, green = components
+      lightness = (max + min) / 2
+
+      if max == min
+        hue = saturation = 0
+      else
+        chroma = max - min
+        saturation =
+          lightness > 0.5 ? (chroma / (2 - max - min)) : (chroma / (max + min))
+        hue = case max
+              when red
+                (green - blue) / chroma + (green < blue ? 6 : 0)
+              when green
+                (blue - red) / chroma + 2
+              when blue
+                (red - green) / chroma + 4
+              end
+        hue /= 6
+      end
+      [hue, saturation, lightness]
+    end
+
+    # Variables papa, quebec and tango were originally designated by single
+    # letters but have been changed to match the NATO photonetic alphabet
+    def hsl_to_rgb(hue, saturation, lightness)
+      if saturation.zero?
+        red = green = blue = lightness
+      else
+        quebec = if lightness < 0.5
+                   lightness * (1 + saturation)
+                 else
+                   lightness + saturation - lightness * saturation
+                 end
+        papa = 2 * lightness - quebec
+        red, green, blue = [ONE_THIRD, 0, -ONE_THIRD].map do |offset|
+          hue_to_rgb papa, quebec, hue + offset
+        end
+      end
+      [red, green, blue].map { |component| (component * 255).round }
+    end
+
+    # :reek:FeatureEnvy
+    def hue_to_rgb(papa, quebec, tango)
+      tango = bound_hue_01(tango)
+      if tango < ONE_SIXTH
+        papa + (quebec - papa) * 6 * tango
+      elsif tango < 0.5 # (1 / 2.0)
+        quebec
+      elsif tango < TWO_THIRDS
+        papa + (quebec - papa) * (TWO_THIRDS - tango) * 6
+      else
+        papa
+      end
+    end
+
+    def bound_hue_01(hue)
+      if hue.negative?
+        hue + 1
+      elsif hue > 1
+        hue - 1
+      else
+        hue
+      end
+    end
+
+    # :reek:UncommunicativeVariableName and :reek:UncommunicativeParameterName
+    def ratio(rgb1, rgb2)
+      c1, c2 = [rgb1, rgb2].map { |rgb| Color.new(rgb) }
+      l1, l2 = [c1, c2].map(&:relative_luminance).sort
+      (l2 + 0.05) / (l1 + 0.05)
+    end
+
+    def relative_luminance(red, green, blue)
+      (0.2126 * f(red)) + (0.7152 * f(green)) + (0.0722 * f(blue))
+    end
+
+    # :reek:UncommunicativeVariableName and :reek:UncommunicativeMethodName
+    def f(component)
+      c = component / 255.0
+      c <= 0.03928 ? c : ((c + 0.055) / 1.055)**2.4
+    end
+
+    def light?(hex)
+      red, green, blue = hex.delete('#').scan(/../).map(&:hex)
+      luma = 0.2126 * red + 0.7152 * green + 0.0722 * blue
+      luma >= 128
+    end
+
+    def dark?(hex)
+      red, green, blue = hex.delete('#').scan(/../).map(&:hex)
+      luma = 0.2126 * red + 0.7152 * green + 0.0722 * blue
+      luma < 128
+    end
+  end
+end

data/lib/color_corrector/color.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Color Class
+class Color
+  attr_reader :r, :g, :b
+
+  def initialize(*args)
+    input = args.size == 1 ? args[0] : args
+    @r, @g, @b = Color.rgb_from(input)
+  end
+
+  def relative_luminance
+    ColorCorrector.relative_luminance(r, g, b)
+  end
+
+  def ratio(color)
+    ColorCorrector.ratio(self, color)
+  end
+
+  def to_rgb
+    [r, g, b]
+  end
+
+  class << self
+    def rgb_from(input)
+      case input
+      when String # hex code
+        raise 'Invalid hex code' unless input =~ /\A([0-9a-f]{3}){1,2}\z/i
+        rgb = if input.size == 3
+          input.split('').map { |h| h * 2 }
+        else
+          input.scan(/.{2}/)
+        end
+        rgb.map { |h| h.hex.to_i }
+      when Array # array of numbers
+        raise 'Invalid RGB array' unless input.size == 3
+        input.map(&:to_f)
+      when Hash
+        rgb = input.values_at(:r, :g, :b)
+        raise 'Invalid RGB hash' unless rgb.size == 3
+        rgb.map(&:to_f)
+      else
+        methods = [:r,:g, :b]
+        if methods.select { |m| input.respond_to?(m) }.size == methods.size
+          methods.map { |m| input.send(m) }
+        else
+          raise 'Invalid input'
+        end
+      end
+    end
+  end
+end

data/lib/color_corrector/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ColorCorrecter
+  # gem version
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: color_corrector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lukas Barry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: lukasbbarry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/color_corrector.rb
+- lib/color_corrector/color.rb
+- lib/color_corrector/version.rb
+homepage: https://github.com/LukasBarry/color_corrector
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Color Corrector allows you to revise your colors to be WCAG compliant
+test_files: []