css_color_contrast 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f9cc746835363817c13f2501387b3c0cb8463568296a0e8ce07f82cb8a793e
-  data.tar.gz: 1bf6ca7654c957b64e7290c46dfe04b6c9c851f4fc821413e56079c451c5706d
+  metadata.gz: 2c0c2ebbd18a381d1ec4d2ac300a727539a019e8fb7cdea9361a293a15ed79f1
+  data.tar.gz: 27a1a2a1219fd0b2badfcc2c294ff2b1a9674010983716626e5db74318645c02
 SHA512:
-  metadata.gz: 7c0419c7968a6087f961500697869436acfd685e38fe4228c95e23f50b8b6538cb00364ea0bd942cc809efca896b1a99b0e8983b95f47f5f1bb0596926c634fe
-  data.tar.gz: 848d70b305f39f98d20164c4c724396bf63f9af9b6167c010e99f7cdc55e57d3e6fe0f6f01d3e80f2d930db2869833a502569b3a72b62d296265ecbebc945e8a
+  metadata.gz: a1236571f2bdad8aefc191a76870ccfec244cb63bbf5ee47050ecc9c31a63efe17fe75f17989f078f9732bb21aeb7493020b9846ab2be1cbb7a8fdcc06f3e494
+  data.tar.gz: 99858a144c1ca5bccc9d363c3f0d393ab392f4c215a37b7bd97f5abab3fac4fc70e475305cc2910d794ba545845e4e737a3d1b555a628c918012d957a8f44582

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,12 +1,20 @@
 ---
 language: ruby
 cache: bundler
+install: bundle install --jobs=3 --retry=3
 rvm:
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.0
-  - 2.7.0
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
   - ruby-head
-  - jruby-head
-before_install: gem install bundler -v 2.1.2
+before_install: gem install bundler -v '~>2.0'
+jobs:
+  include:
+  - rvm: 2.4
+    before_install:
+      - yes | gem update --system --force
+      - gem install bundler
+  - rvm: jruby-head
+    before_install:
+      - bundle add rake --version "13.0.0"

data/Gemfile.lock

@@ -2,43 +2,48 @@ PATH
   remote: .
   specs:
     css_color_contrast (0.1.0)
-      color_contrast_calc (~> 0.7.0)
+      color_contrast_calc (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    color_contrast_calc (0.7.0)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.4)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
+    ast (2.4.1)
+    color_contrast_calc (0.9.0)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
-    yard (0.9.24)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -47,9 +52,9 @@ DEPENDENCIES
   bundler (~> 2.1)
   css_color_contrast!
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.79)
+  rspec (~> 3.10)
+  rubocop (~> 1.8)
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -59,6 +59,83 @@ CssColorContrast.relative_luminance('#ff0')
 # => 0.9278
 ```
 
+## Command-line interface
+
+A command-line tool, ```css_color_contrast``` is provided for a demonstration purpose.
+
+Invoke it as follows:
+
+```bash
+$ css_color_contrast
+To calculate the contrast ratio between 2 colors, enter the following command:
+
+  > ratio: color1 color2
+
+For the values of color1 and color2, hexadecimal notation, RGB/HSL/HWB
+functions and the extended color keywords are supported.
+
+To finish the program, enter 'exit'.
+> 
+```
+
+### Commands
+
+#### ratio:
+
+Calculate the contrast ratio between two colors as in the next case:
+
+```bash
+> ratio: rgb(255 255 0) black
+19.555999999999997
+> 
+```
+
+#### adjust:
+
+It takes 3 arguments, 2 colors and a contrast ratio to be satisfied.
+
+In the example below, it tries to adjust the lightness of the second color so
+that the contrast ratio between the 2 colors is just above the target ratio.
+
+```bash
+> adjust: white red 4.5
+#ee0000
+> 
+```
+#### info:
+
+Print the properties of a given color:
+
+```bash
+> info: #ff0
+---
+name: yellow
+hex: #ffff00
+rgb: rgb(255,255,0)
+hsl: hsl(60.00,100.00%,50.00%)
+hwb: hwb(60.00,0.00%,0.00%)
+> 
+```
+
+When the 3rd argument is omitted, it defaults to 4.5.
+
+#### Assignment to a variable
+
+You can assign a color value to a varible. Variable names begin with @.
+
+```
+> @deeper_red: #e00
+#e00
+> ratio: white @deeper_red
+4.530325445433122
+> info: @deeper_red
+---
+name: #ee0000
+hex: #ee0000
+rgb: rgb(238,0,0)
+hsl: hsl(0.00,100.00%,46.67%)
+hwb: hwb(0.00,0.00%,6.67%)
+```
 ## 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.

data/css_color_contrast.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
     Utility to calculate the contrast ratio between 2 colors, for checking
     the level of conformance to the WCAG 2.0 criteria.
     Hexadecimal notation, RGB/HSL/HWB functions are supported as input formats.
+    And a command-line interface is provided for a demonstration purpose.
   SUMMARY
   #spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/nico-hn/css_color_contrast/"
@@ -31,11 +32,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "color_contrast_calc", "~> 0.7.0"
+  spec.add_runtime_dependency "color_contrast_calc", "~> 0.9"
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.79'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.8'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/exe/css_color_contrast

@@ -1,3 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'css_color_contrast'
+require 'css_color_contrast/cli'
+
+module CssColorContrast
+  Cli.start
+end

data/lib/css_color_contrast.rb

@@ -2,6 +2,7 @@
 
 require 'css_color_contrast/version'
 require 'color_contrast_calc'
+require 'css_color_contrast/color'
 
 ##
 # Provide methods to calculate the contrast ratio
@@ -27,6 +28,27 @@ module CssColorContrast
     ColorContrastCalc.contrast_ratio(color1, color2)
   end
 
+  ##
+  # Calculate the contrast ratio between two transparent colors.
+  #
+  # For the calculation of contrast ratio between foreground and
+  # background colors, you need another color which is placed below
+  # the former two colors, because the third color filters through
+  # the overlaid colors.
+  #
+  # @param foreground [String, Array<Integer>, Color] The uppermost
+  #   color such as "rgb(255, 255, 0, 0.5)" or "hsl(60 100% 50% / 50%)"
+  # @param background [String, Array<Integer>, Color] The color placed
+  #   between the others
+  # @param base [String, Array<Integer>, Color] The color placed in
+  #   the bottom. When the backgound is completely opaque, this color
+  #   is ignored.
+  # @return [Float] Contrast ratio
+
+  def self.ratio_with_opacity(foreground, background, base = Color::WHITE)
+    ColorContrastCalc.contrast_ratio_with_opacity(foreground, background, base)
+  end
+
   ##
   # Calculate the relative luminance of a color.
   #
@@ -40,6 +62,30 @@ module CssColorContrast
   # @return [Float] Relative luminance of the passed color.
 
   def self.relative_luminance(color)
-    ColorContrastCalc::Color.as_color(color).relative_luminance
+    Color.as_color(color).relative_luminance
+  end
+
+  ##
+  # Adjust the lightness of the second color to satisfy a specified
+  # level of contrast ratio.
+  #
+  # @param fixed_color [String, Array<Integer, Float>] The color that
+  #   remains unchanged
+  # @param color_to_adjust [String, Array<Integer, Float>] The color of
+  #   which the lightness is to be adjusted
+  # @param level [Integer, Float] The contrast ratio to be satisfied,
+  #   such as 3.0, 4.5, 7.0
+  # @return [Color, nil] The color of which the contrast ratio against
+  #   fixed_color equals or is slightly greater than the specified level.
+
+  def self.adjust_lightness(fixed_color, color_to_adjust, level = 4.5)
+    fixed, to_adjust = [fixed_color, color_to_adjust].map do |color|
+      Color.as_color(color)
+    end
+
+    adjusted = fixed.find_lightness_threshold(to_adjust, level)
+    if_satisfied = fixed.contrast_ratio_against(adjusted) >= level
+
+    if_satisfied ? adjusted : nil
   end
 end

data/lib/css_color_contrast/cli.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'readline'
+require 'css_color_contrast/command_interpreter'
+
+module CssColorContrast
+  module Cli
+    BANNER = <<~BANNER
+    To calculate the contrast ratio between 2 colors, enter the following command:
+
+      > ratio: color1 color2
+
+    For the values of color1 and color2, hexadecimal notation, RGB/HSL/HWB
+    functions and the extended color keywords are supported.
+
+    To finish the program, enter 'exit'.
+    BANNER
+
+    def self.print_banner
+      $stdout.print BANNER
+    end
+
+    def self.read_commands
+      env = {}
+
+      while line = Readline.readline('> ', true)
+        begin
+          exit if line.chomp == 'exit'
+          func = CommandInterpreter::Parser.parse!(line.chomp, env)
+          $stdout.puts func.evaluate
+        rescue => e
+          puts e
+        end
+      end
+    end
+
+    def self.start
+      print_banner
+      read_commands
+    end
+  end
+end

data/lib/css_color_contrast/color.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'color_contrast_calc'
+
+module CssColorContrast
+  class Color < ColorContrastCalc::Color
+  end
+end

data/lib/css_color_contrast/command_interpreter.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'strscan'
+require 'stringio'
+require 'css_color_contrast'
+
+module CssColorContrast
+  module CommandInterpreter
+    module TokenRe
+      FUNC_HEAD = /:\s*/.freeze
+      LABEL = /[^\s:()]+/.freeze
+      SPACE = /\s+/.freeze
+      COLOR_SCHEME = /(rgba?|hsl|hwb)/i.freeze
+    end
+
+    class Value
+      attr_reader :source
+
+      def self.assign(source, env, value = nil)
+        new(source, env, value)
+      end
+
+      def initialize(source, env, value = nil)
+        @source = source
+        @env = env
+        @value = value
+      end
+
+      def evaluate
+        return @env[@source] if @source.start_with?('@')
+
+        @value || @source
+      end
+    end
+
+    class Function
+      attr_reader :name, :params
+
+      def initialize(name, env = {})
+        @name = name
+        @env = env
+        @params = []
+      end
+
+      def push(param)
+        @params.push(param)
+      end
+
+      def param_values
+        @params.map(&:evaluate).flatten
+      end
+
+      class AssignVariable < self
+        def evaluate
+          @env[@name] = param_values
+        end
+      end
+
+      class Ratio < self
+        def evaluate
+          ColorContrastCalc.contrast_ratio(*param_values)
+        end
+      end
+
+      class AdjustLightness < self
+        DEFAULT_RATIO = 4.5
+        def ratio_given(ratio)
+          ratio && /\A\d+(\.\d+)?/.match?(ratio)
+        end
+
+        def evaluate
+          fixed, to_adjust, ratio = param_values
+
+          ratio = ratio_given(ratio) ? ratio.to_f : DEFAULT_RATIO
+
+          CssColorContrast.adjust_lightness(fixed, to_adjust, ratio)
+        end
+      end
+
+      class Info < self
+        def evaluate
+          colors = param_values.map {|c| Color.as_color(c) }
+          out = StringIO.new
+
+          colors.each do |c|
+            out.puts '---'
+            out.puts labeled_rgb_values(c)
+            out.puts format_color_function(:hsl, c.hsl)
+            out.puts format_color_function(:hwb, c.hwb)
+          end
+          out.string
+        end
+
+        def labeled_rgb_values(color)
+          %i[name hex rgb]
+            .zip([color.name, color.hex, color.to_s(10)])
+            .map {|v| v.join(': ') }
+        end
+
+        private :labeled_rgb_values
+
+        def format_color_function(scheme, components)
+          format("#{scheme}: #{scheme}(%3.2f,%3.2f%%,%3.2f%%)", *components)
+        end
+
+        private :format_color_function
+      end
+
+      FUNCTION_TABLE = {
+        'ratio' => Ratio,
+        'adjust' => AdjustLightness,
+        'info' => Info
+      }.freeze
+
+      private_constant :FUNCTION_TABLE
+
+      def self.create(name, env = {})
+        return AssignVariable.new(name, env) if name.start_with?('@')
+
+        FUNCTION_TABLE[name].new(name, env)
+      end
+    end
+
+    class Parser
+      def self.parse!(line, env = {})
+        new(line, env).parse!.root_node
+      end
+
+      attr_reader :tokens, :node_tree
+
+      def initialize(line, env = {})
+        @scanner = StringScanner.new(line)
+        @env = env
+        @tokens = []
+        @node_tree = []
+      end
+
+      def root_node
+        @node_tree.first
+      end
+
+      def current_node
+        @node_tree.last
+      end
+
+      private :current_node
+
+      def read_label
+        cur_pos = @scanner.pos
+        label = @scanner.scan(TokenRe::LABEL)
+        return unless label
+
+        if TokenRe::COLOR_SCHEME.match?(label)
+          @tokens.push read_color_function(cur_pos)
+        else
+          @tokens.push label
+        end
+      end
+
+      def read_color_function(cur_pos)
+        @scanner.pos = cur_pos
+        color = Color.as_color(@scanner.scan_until(/\)/))
+        source = @scanner.string[cur_pos..(@scanner.pos)]
+        Value.assign(source, @env, color)
+      end
+
+      def read_separator
+        if @scanner.scan(TokenRe::FUNC_HEAD)
+          @node_tree.push(Function.create(@tokens.pop, @env))
+        elsif @scanner.scan(TokenRe::SPACE) || @scanner.eos?
+          token = @tokens.pop
+          value = token.is_a?(Value) ? token : Value.assign(token, @env)
+          current_node.push(value)
+        end
+
+        read_label
+        read_separator unless @tokens.empty?
+      end
+
+      def ignore_space
+        @scanner.scan(TokenRe::SPACE)
+      end
+
+      def parse!
+        ignore_space
+        read_label
+        read_separator
+        self
+      end
+    end
+  end
+end

data/lib/css_color_contrast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CssColorContrast
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: css_color_contrast
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HASHIMOTO, Naoki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: color_contrast_calc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +104,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -116,6 +117,9 @@ files:
 - css_color_contrast.gemspec
 - exe/css_color_contrast
 - lib/css_color_contrast.rb
+- lib/css_color_contrast/cli.rb
+- lib/css_color_contrast/color.rb
+- lib/css_color_contrast/command_interpreter.rb
 - lib/css_color_contrast/version.rb
 homepage: https://github.com/nico-hn/css_color_contrast/
 licenses:
@@ -143,5 +147,6 @@ signing_key:
 specification_version: 4
 summary: Utility to calculate the contrast ratio between 2 colors, for checking the
   level of conformance to the WCAG 2.0 criteria. Hexadecimal notation, RGB/HSL/HWB
-  functions are supported as input formats.
+  functions are supported as input formats. And a command-line interface is provided
+  for a demonstration purpose.
 test_files: []