rgb_utils 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69a46dc13601a88ee4cb0202ed9da3b43a48aebc
+  data.tar.gz: 189bf69cd77c12e5945ae9f88cca072ee499bb70
+SHA512:
+  metadata.gz: 0e6d63fd0719d42e5c2d352337e5fdcefb09a88916732f392674df83486d9dd90f9d6bd49aaef83d968c02397b78700d1152b68aea3c51aa3f8955fbd9d583ce
+  data.tar.gz: 22a614e815b69deda80c9aed3295824311ba9d6abe8b421517cfd4b265edbe32f95101627ca670a90b64d35b13d01a7792368ef479b1b3d9bbe2951fd73c4a51

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrerpbts@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rgb_utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 andrerpbts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# RGB Utils
+
+A set of RGB functions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rgb_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rgb_utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrerpbts/rgb_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rgb_utils'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rgb_utils/attributes/color.rb

@@ -0,0 +1,15 @@
+module RGBUtils
+  class Color < Virtus::Attribute
+    MIN_VALUE = 0
+    MAX_VALUE = 255
+
+    def coerce(value)
+      value = value.to_i
+
+      return MIN_VALUE if value < MIN_VALUE
+      return MAX_VALUE if value > MAX_VALUE
+
+      value
+    end
+  end
+end

data/lib/rgb_utils/calculator.rb

@@ -0,0 +1,11 @@
+module RGBUtils
+  class Calculator
+    def self.calculate(*args)
+      new(*args).calculate
+    end
+
+    def calculate
+      fail NotImplementedError
+    end
+  end
+end

data/lib/rgb_utils/calculators/luma_calculator.rb

@@ -0,0 +1,21 @@
+module RGBUtils
+  class LumaCalculator < Calculator
+    RED_L = 0.299
+    GREEN_L = 0.587
+    BLUE_L = 0.114
+
+    delegate :red, :green, :blue, to: :rgb
+
+    def initialize(color)
+      @rgb = HexToRGBConverter.convert(color)
+    end
+
+    def calculate
+      @luma ||= ((RED_L * red) + (GREEN_L * green) + (BLUE_L * blue))/255
+    end
+
+    private
+
+    attr_reader :rgb
+  end
+end

data/lib/rgb_utils/calculators/relative_luminance_calculator.rb

@@ -0,0 +1,21 @@
+module RGBUtils
+  class RelativeLuminanceCalculator < Calculator
+    RED_Y = 0.2126
+    GREEN_Y = 0.7152
+    BLUE_Y = 0.0722
+
+    delegate :red, :green, :blue, to: :linear_rgb
+
+    def initialize(rgb)
+      @linear_rgb = RGBToLinearRGBConverter.convert(rgb)
+    end
+
+    def calculate
+      @luminance ||= (RED_Y * red) + (GREEN_Y * green) + (BLUE_Y * blue)
+    end
+
+    private
+
+    attr_reader :linear_rgb
+  end
+end

data/lib/rgb_utils/config.rb

@@ -0,0 +1,10 @@
+module RGBUtils
+  class Config
+    @light_color = '#ffffff'
+    @dark_color  = '#000000'
+
+    class << self
+      attr_accessor :light_color, :dark_color
+    end
+  end
+end

data/lib/rgb_utils/converter.rb

@@ -0,0 +1,11 @@
+module RGBUtils
+  class Converter
+    def self.convert(*args)
+      new(*args).convert
+    end
+
+    def convert
+      fail NotImplementedError
+    end
+  end
+end

data/lib/rgb_utils/converters/hex_to_rgb_converter.rb

@@ -0,0 +1,31 @@
+module RGBUtils
+  class HexToRGBConverter < Converter
+    def initialize(color)
+      @color = color
+    end
+
+    def convert
+      return color if color.is_a?(RGB)
+
+      @rgb ||= begin
+        red, green, blue = capture_colors
+
+        RGB.new(red: red, green: green, blue: blue)
+      end
+    end
+
+    private
+
+    attr_accessor :color
+
+    def capture_colors
+      @capture_colors ||= begin
+        WebSafeToHexConverter
+          .convert(color)
+          .match(/(\w{2})(\w{2})(\w{2})/)
+          .captures
+          .map { |color_node| color_node.to_i(16) }
+      end
+    end
+  end
+end

data/lib/rgb_utils/converters/rgb_to_hex_converter.rb

@@ -0,0 +1,25 @@
+module RGBUtils
+  class RGBToHexConverter < Converter
+    def initialize(color)
+      @color = color
+    end
+
+    def convert
+      WebSafeToHexConverter.convert(hex_color)
+    end
+
+    private
+
+    attr_reader :color
+
+    def hex_color
+      @hex_color ||= begin
+        return color unless color.is_a?(RGB)
+
+        [color.red, color.green, color.blue].map do |color_node|
+          '%02x' % color_node
+        end.join
+      end
+    end
+  end
+end

data/lib/rgb_utils/converters/rgb_to_linear_rgb_converter.rb

@@ -0,0 +1,33 @@
+module RGBUtils
+  class RGBToLinearRGBConverter < Converter
+    GAMMA = 2.4
+    CUTOFF_POINT = 0.03928
+    SLOPE = 12.92
+
+    def initialize(rgb)
+      @rgb = HexToRGBConverter.convert(rgb)
+    end
+
+    def convert
+      @linear_rgb ||= begin
+        linear_red, linear_green, linear_blue = calculate_linear_rgb
+
+        LinearRGB.new(red: linear_red, green: linear_green, blue: linear_blue)
+      end
+    end
+
+    private
+
+    attr_accessor :rgb
+
+    def calculate_linear_rgb
+      rgb.as_unit_range.map do |color|
+        if color <= CUTOFF_POINT
+          color / SLOPE
+        else
+          ((color + 0.055) / 1.055) ** GAMMA
+        end
+      end
+    end
+  end
+end

data/lib/rgb_utils/converters/web_safe_to_hex_converter.rb

@@ -0,0 +1,34 @@
+module RGBUtils
+  class WebSafeToHexConverter < Converter
+    DEFAULT_COLOR = '#000000'.freeze
+
+    def initialize(color)
+      @color = color
+    end
+
+    def convert
+      return DEFAULT_COLOR unless valid?
+
+      result = color_elements
+      result.map! { |c| c * 2 } if web_safe?
+
+      "##{result.join}"
+    end
+
+    private
+
+    attr_reader :color
+
+    def valid?
+      [3, 6].include?(color_elements.count)
+    end
+
+    def web_safe?
+      color_elements.count == 3
+    end
+
+    def color_elements
+      @color_elements ||= color.scan(/\h/)
+    end
+  end
+end

data/lib/rgb_utils/models/linear_rgb.rb

@@ -0,0 +1,9 @@
+module RGBUtils
+  class LinearRGB
+    include Virtus.model
+
+    attribute :red, Float
+    attribute :green, Float
+    attribute :blue, Float
+  end
+end

data/lib/rgb_utils/models/rgb.rb

@@ -0,0 +1,23 @@
+module RGBUtils
+  class RGB
+    include Virtus.model
+
+    attribute :red, Color
+    attribute :green, Color
+    attribute :blue, Color
+
+    def as_unit_range
+      [red, green, blue].map { |color| color / 255.0 }
+    end
+
+    def to_hex
+      RGBToHexConverter.convert(self)
+    end
+
+    def contrast_color(type = :simple)
+      return SimpleContrastColorResolver.for(self) if type == :simple
+
+      ComplexContrastColorResolver.for(self)
+    end
+  end
+end

data/lib/rgb_utils/resolver.rb

@@ -0,0 +1,11 @@
+module RGBUtils
+  class Resolver
+    def self.for(*args)
+      new(*args).for
+    end
+
+    def for
+      fail NotImplementedError
+    end
+  end
+end

data/lib/rgb_utils/resolvers/complex_contrast_color_resolver.rb

@@ -0,0 +1,29 @@
+module RGBUtils
+  class ComplexContrastColorResolver < Resolver
+    def initialize(color, options = {})
+      @color = color
+      @light_color = options.fetch(:light_color, Config.light_color)
+      @dark_color = options.fetch(:dark_color, Config.dark_color)
+    end
+
+    def for
+      @result ||= begin
+        return dark_color if luminance > luminance_cutoff
+
+        light_color
+      end
+    end
+
+    private
+
+    attr_reader :color, :light_color, :dark_color
+
+    def luminance
+      @luminance ||= RelativeLuminanceCalculator.calculate(color)
+    end
+
+    def luminance_cutoff
+      Math::sqrt(1.05 * 0.05) - 0.05
+    end
+  end
+end

data/lib/rgb_utils/resolvers/simple_contrast_color_resolver.rb

@@ -0,0 +1,27 @@
+module RGBUtils
+  class SimpleContrastColorResolver < Resolver
+    THRESHOLD_VALUE = 186/255.0
+
+    def initialize(color, options = {})
+      @color = color
+      @light_color = options.fetch(:light_color, Config.light_color)
+      @dark_color = options.fetch(:dark_color, Config.dark_color)
+    end
+
+    def for
+      @result ||= begin
+        return dark_color if luma > THRESHOLD_VALUE
+
+        light_color
+      end
+    end
+
+    private
+
+    attr_reader :color, :light_color, :dark_color
+
+    def luma
+      @luma ||= LumaCalculator.calculate(color)
+    end
+  end
+end

data/lib/rgb_utils/version.rb

@@ -0,0 +1,3 @@
+module RGBUtils
+  VERSION = '0.1.1'
+end

data/lib/rgb_utils.rb

@@ -0,0 +1,18 @@
+require 'virtus'
+require 'active_support'
+require 'active_support/core_ext'
+
+module RGBUtils
+  %w(
+    *.rb
+    attributes/**/*.rb
+    models/**/*.rb
+    converters/**/*.rb
+    calculators/**/*.rb
+    resolvers/**/*.rb
+  ).each do |pattern|
+    files = File.join(File.dirname(__FILE__), 'rgb_utils', pattern)
+
+    Dir[files].each { |file| require file }
+  end
+end

data/rgb_utils.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rgb_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rgb_utils'
+  spec.version       = RGBUtils::VERSION
+  spec.authors       = ['andrerpbts', 'brunohkbx']
+  spec.email         = ['andrerpbts@gmail.com', 'bruno.f.castro12@hotmail.com ']
+
+  spec.summary       = %q{A set of RGB functions}
+  spec.description   = %q{A set of RGB functions like luminance, converters and constrast resolvers}
+  spec.homepage      = 'https://github.com/andrerpbts/rgb_utils'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'activesupport', '>= 3.2'
+  spec.add_dependency 'virtus', '~> 1.0'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rgb_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- andrerpbts
+- brunohkbx
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A set of RGB functions like luminance, converters and constrast resolvers
+email:
+- andrerpbts@gmail.com
+- 'bruno.f.castro12@hotmail.com '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rgb_utils.rb
+- lib/rgb_utils/attributes/color.rb
+- lib/rgb_utils/calculator.rb
+- lib/rgb_utils/calculators/luma_calculator.rb
+- lib/rgb_utils/calculators/relative_luminance_calculator.rb
+- lib/rgb_utils/config.rb
+- lib/rgb_utils/converter.rb
+- lib/rgb_utils/converters/hex_to_rgb_converter.rb
+- lib/rgb_utils/converters/rgb_to_hex_converter.rb
+- lib/rgb_utils/converters/rgb_to_linear_rgb_converter.rb
+- lib/rgb_utils/converters/web_safe_to_hex_converter.rb
+- lib/rgb_utils/models/linear_rgb.rb
+- lib/rgb_utils/models/rgb.rb
+- lib/rgb_utils/resolver.rb
+- lib/rgb_utils/resolvers/complex_contrast_color_resolver.rb
+- lib/rgb_utils/resolvers/simple_contrast_color_resolver.rb
+- lib/rgb_utils/version.rb
+- rgb_utils.gemspec
+homepage: https://github.com/andrerpbts/rgb_utils
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: A set of RGB functions
+test_files: []