color-proximity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 488d3bfd9f4b8ebadea3e5d8bc25436ded1df9a3
+  data.tar.gz: 64026bab9444f1ec94d354e752e0763660b75030
+SHA512:
+  metadata.gz: 2b9ff497a438edd22b1e6fa0164bc3b62c88dd77b299d79be423873c96f655cc75b14206b5029bac605d27793a06b82a29c632456d821fd64f168ab1c3e587d3
+  data.tar.gz: ff97ac4face64b0b324768359a51618acbf544ffc4727b5e858e04f22be204de18dc635899765e9b6c920dec8a784407cf346cdc2ec486f8489c0f18ea598d54

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Garen Torikian
+
+MIT License
+
+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 @@
+# ColorProximity
+
+[![Build Status](https://travis-ci.org/gjtorikian/color-proximity.svg?branch=master)](https://travis-ci.org/gjtorikian/color-proximity)
+
+Given a threshold and a collection of colors, you'll be able to determine how close a given color is to matching a list.
+
+A [Euclidean distance algorithm](http://www.compuphase.com/cmetric.htm) is used to determine matches.
+
+## Usage
+
+``` ruby
+require 'color-proximity'
+cp = ColorProximity.new(0.5, ['000000'])
+cp.within_threshold?('000000') # [false, ['000000']]
+
+cp.collection = ['ffffff'])
+cp.within_threshold?('000000') # [true]
+
+cp.collection = ['000001', '000002', 'ffffff'])
+cp.thresholds('000003') # [3.3166247903554, 1.4142135623730951, 762.3437544835007]
+```
+
+A failure case returns an array with two elements: `false`, and the collection of colors that failed the threshold. Success cases return an array with one element: `true`. This is designed to make it easy to call `.first` on the result to validate it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'color-proximity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install color-proximity

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_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 "color/proximity"
+
+# 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

data/bin/setup

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

data/color-proximity.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'color-proximity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "color-proximity"
+  spec.version       = ColorProximity::VERSION
+  spec.authors       = ["Garen Torikian"]
+  spec.email         = ["gjtorikian@gmail.com"]
+
+  spec.summary       = %q{Match the threshold of a color against a collection of colors.}
+  spec.homepage      = 'https://github.com/gjtorikian/color-proximity'
+  spec.license        = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/color-proximity.rb

@@ -0,0 +1,55 @@
+require "color-proximity/version"
+
+class ColorProximity
+
+  attr_accessor :threshold, :collection
+
+  def initialize(threshold, collection)
+    @threshold = threshold
+    @collection = collection
+  end
+
+  def within_threshold?(color)
+    @collection.each_with_object([true]) do |collection_color, arr|
+      proximity = proximity_of(color, collection_color)
+      next unless @threshold > proximity
+      arr[0] = false
+      arr[1] = [] if arr[1].nil?
+      arr[1] << collection_color
+    end
+  end
+
+  def thresholds(color)
+    @collection.map { |collection_color| proximity_of(color, collection_color) }
+  end
+
+  private
+
+  def proximity_of(color, another_color)
+    color_red, color_green, color_blue = split_color(color)
+    another_color_red, another_color_green, another_color_blue = split_color(another_color)
+
+    color_red_mean = (color_red + another_color_red) / 2
+    color_red_gap  = color_red - another_color_red
+    color_green_gap = color_green - another_color_green
+    color_blue_gap  = color_blue - another_color_blue
+
+    euclidean_distance(color_red_mean, color_red_gap, color_green_gap, color_blue_gap)
+  end
+
+  def split_color(color)
+    red   = (color[0] + color[1]).to_i(16)
+    green = (color[2] + color[3]).to_i(16)
+    blue  = (color[4] + color[5]).to_i(16)
+
+    [red, green, blue]
+  end
+
+  def euclidean_distance(red_mean, red_gap, green_gap, blue_gap)
+    red_weight   = ((512 + red_mean) * red_gap**2) >> 8
+    green_weight = 4 * green_gap**2
+    blue_weight  = ((767 - red_mean) * blue_gap**2) >> 8
+
+    Math.sqrt(red_weight + green_weight + blue_weight)
+  end
+end

data/lib/color-proximity/version.rb

@@ -0,0 +1,3 @@
+class ColorProximity
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: color-proximity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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'
+description: 
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- color-proximity.gemspec
+- lib/color-proximity.rb
+- lib/color-proximity/version.rb
+homepage: https://github.com/gjtorikian/color-proximity
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Match the threshold of a color against a collection of colors.
+test_files: []