luminosity_contrast 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d5208e8c97547e595e4a1277a86f84138298b13
-  data.tar.gz: 62d2c8f2ccefb091733ce4a1539b48cb83603dff
+  metadata.gz: 4f3d154f90b97ea368aba6c9f1546e50c83ee878
+  data.tar.gz: 023801266540b5532fd9c9d5d70413e01b890197
 SHA512:
-  metadata.gz: 4d0d750948caae5290a2ea2ea825d9c9ab6561d61a6c56ba9c66c92acaca9fdd5ff6ea126bc211e2402622764a60c3798c465f89d80c9f0002ca3131ee446ef9
-  data.tar.gz: 345761d85c5bbd3b8224dc06df0226bc8e343941397522018c91bde27a766dc4bbdb9d8339d3d8a1d570681e402986f83d358120307a57dc8047589921e86bee
+  metadata.gz: 9bb5439bc49afe205a895732b9096f1fa6fb4189bfce4d915825fe4d6149652d5603197b2d60d6c304fe3431c76867f27a813f6a2c8bc7f1f621f067d1e7c84f
+  data.tar.gz: 5e0f9fac3a185deff38df95be40def5a66f45014adffa7d2a8f532c5b7680fd2b4611e1718c0fb49483e7847e9f6742df9f2831c7265fa7d59a9f9af634429c2

data/.gitignore

@@ -5,5 +5,5 @@
 /coverage/
 /doc/
 /pkg/
-/spec/reports/
 /tmp/
+/*.gem

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/README.md

@@ -1,5 +1,7 @@
 # LuminosityContrast
 
+[![Gem Version](https://badge.fury.io/rb/luminosity_contrast.svg)](https://badge.fury.io/rb/luminosity_contrast)
+
 Calculate the [Luminosity Contrast Ratio](https://www.w3.org/TR/WCAG20/#contrast-ratiodef) of two colors to determine whether text can be easily read. This quantifies the legibility of colored text on a colored background for accessibility purposes.
 
 Implements the formula in WCAG 2.0 guideline 1.4

data/lib/luminosity_contrast.rb

@@ -1,34 +1,44 @@
 require "luminosity_contrast/version"
 require "luminosity_contrast/color"
 
-
+# Namespace for the gem. Contains methods to implement the Luminosity Contrast
+# Ratio formula.
+#
+# This module is not designed to be included in a class.
 module LuminosityContrast
-
-  # module methods
   class << self
-    # expects two RGB values as Arrays of three numbers
-    #   example: [0, 0, 0], [255.0, 255.0, 255.0]
-    # or hex code strings (3 or 6 characters)
-    #   example: '000000', 'fff'
-    # returns the Luminosity Contrast Ratio between 1.0 and 21.0
+    # Calculate the Luminosity Contrast Ratio of two colors.
+    # This method is the gem's _raison d'être_.
+    #
+    # @param rgb1 either of two colors to compare
+    # @param rgb2 the other of two colors to compare
+    # @example two RGB values as Arrays of three numbers
+    #   LuminosityContrast.ratio([0, 0, 0], [255.0, 255.0, 255.0])
+    # @example two hex code strings (3 or 6 characters)
+    #   LuminosityContrast.ratio('000000', 'fff')
+    # @example two LuminosityContrast::Color objects
+    #   LuminosityContrast.ratio(color1, color2)
+    # @return [Float] the Luminosity Contrast Ratio between 1.0 and 21.0
     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
 
-    # expects RGB as three numeric values between 0.0 and 255.0
-    # returns relative luminance of a color between 0.0 and 1.0
+    # @param r [Numeric] red component between 0.0 and 255.0
+    # @param g [Numeric] green component between 0.0 and 255.0
+    # @param b [Numeric] blue component between 0.0 and 255.0
+    # @return [Float] relative luminance of a color between 0.0 and 1.0
     def relative_luminance(r, g, b)
       (0.2126 * f(r)) + (0.7152 * f(g)) + (0.0722 * f(b))
     end
 
     # assists calculation of relative luminance
-    # expects a single RGB component between 0.0 and 255.0
+    # @param a single RGB component between 0.0 and 255.0
+    # @returns [Float] a value needed for relative luminance calculation
     private def f(component)
       c = component / 255.0
       c <= 0.03928 ? c : ((c + 0.055) / 1.055) ** 2.4
     end
   end
 end
-

data/lib/luminosity_contrast/color.rb

@@ -1,29 +1,59 @@
 module LuminosityContrast
+
+  # @!attribute [r] r
+  #   @return [Float] the red component
+  # @!attribute [r] g
+  #   @return [Float] the green component
+  # @!attribute [r] b
+  #   @return [Float] the blue component
+  #
+  # Color object parses RGB formats like hex code string or array of numbers.
+  # Populates RGB attributes and provides convenience methods for comparing
+  # colors. This class is used by LuminosityContrast.ratio but can also be used
+  # on its own.
   class Color
+
     attr_reader :r, :g, :b
 
+    # @param args a representation of an RGB color
+    # @see .rgb_from
     def initialize(*args)
       input = args.size == 1 ? args[0] : args
       @r, @g, @b = Color.rgb_from(input)
     end
 
+    # @return [Float] between 0.0 and 1.0
+    # @see LuminosityContrast.relative_luminance
     def relative_luminance
       LuminosityContrast.relative_luminance(r,g,b)
     end
 
+    # @param color [Color] a second color contrasting with this one
+    # @return [Float] a ratio between 1.0 and 21.0
+    # @see LuminosityContrast.ratio
     def ratio(color)
       LuminosityContrast.ratio(self, color)
     end
 
+    # @return [Array] red, green, blue color components from 0.0 to 255.0
     def to_rgb
       [r, g, b]
     end
 
     class << self
-
-      # expects a 3 or 6 character hex color code
-      # or an array with 3 numbers between 0 and 255
-      # or an object that responds to .r, .g, .b
+      # Convert one of several RGB formats to an Array of components
+      # @return [Array] red, green, blue color components from 0.0 to 255.0
+      # @param input a representation of an RGB color
+      # @example 3 or 6 character hex color code String
+      #   rgb_from('fff')
+      #   rgb_from('000000')
+      # @example Array with 3 numbers between 0 and 255
+      #   rgb_from([0, 127.0, 255])
+      # @example a Hash with 3 numbers between 0 and 255
+      #   rgb_from(r: 0, g: 127.0, b: 255)
+      # @example an Object that responds to methods #r, #g, #b
+      #   color = Color.new('000')
+      #   rgb_from(color)
       def rgb_from(input)
         case input
         when String # hex code

data/lib/luminosity_contrast/version.rb

@@ -1,3 +1,4 @@
 module LuminosityContrast
-  VERSION = "0.2.0"
+  # gem version
+  VERSION = "0.2.1"
 end

data/luminosity_contrast.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.11"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: luminosity_contrast
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin Jones
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
@@ -54,14 +54,13 @@ dependencies:
         version: '5.0'
 description: 
 email: 
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt