shade 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e76ed33f294a3425fec4200212fab8ac0779346
+  data.tar.gz: 3300038187fe56a73f705cd3fd42a2ecb9de7d84
+SHA512:
+  metadata.gz: e30ae1f5c6a901f3733eac133b9f79f62977897fb48b2e0c0beaa57c8eeb8513378cfb53f25426821e63163ce35b85c4cd3bb1831f83cefed65537fa074d19cb
+  data.tar.gz: bf5f650f46bc8fa9aaf25494f9b02d5692c5ec37414597543fc58eccb70d68cc6451fb5e00e106e11dfda882d7c28f552d7cc72b57e8fbd80043a24a69dce433

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew McEachen
+
+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,55 @@
+# Shade
+
+Rubygem to find the closest color from a given palette.
+
+[![Build Status](https://api.travis-ci.org/mceachen/shade.png?branch=master)](https://travis-ci.org/mceachen/shade)
+[![Gem Version](https://badge.fury.io/rb/shade.png)](http://rubygems.org/gems/shade)
+[![Code Climate](https://codeclimate.com/github/mceachen/shade.png)](https://codeclimate.com/github/mceachen/shade)
+[![Dependency Status](https://gemnasium.com/mceachen/shade.png)](https://gemnasium.com/mceachen/shade)
+
+This was created to help migrate Twitter's Advertising webapp from more than a thousand
+different colors into a small well-considered palette of colors. 
+
+Both the [CIE76 color difference algorithm](http://en.wikipedia.org/wiki/Color_difference#CIE76), via
+`Shade::Palette.nearest_value`, and the 
+[CIE94 color difference algorithm](http://en.wikipedia.org/wiki/Color_difference#CIE94), via 
+`Shade::Palette.nearest_value_cie94` implementations are available.
+
+The CIE94 implementation is slower, but may have better results, as saturation perception is better
+accounted for in that algorithm. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shade
+
+## Usage
+
+```ruby
+p = Shade::Palette.new do |p|
+  p.add('#663399', 'deepPurple')
+  p.add('#5BA636', 'darkGreen')
+end
+
+p.nearest_value('green')
+=> #<struct Shade::Palette::Value name="#5BA636", css_color="darkGreen">
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mceachen/shade/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.md']
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/bin/shade

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'shade'
+require 'shade/cli'
+
+Shade::CLI.new(ARGV).convert_files

data/lib/shade.rb

@@ -0,0 +1,5 @@
+require 'shade/version'
+require 'shade/palette'
+
+module Shade
+end

data/lib/shade/cli.rb

@@ -0,0 +1,76 @@
+require 'optparse'
+
+module Shade
+  class CLI
+    def initialize(argv)
+      @verbose = false
+      @palette_files = []
+      @inputs = option_parser.parse!(argv)
+
+      if palette.empty?
+        puts 'No colors are in the target palette. Please provide at least one valid --palette file.'
+        puts option_parser
+        exit 1
+      end
+    end
+
+    def convert_files(files = @inputs)
+      files.each do |file|
+        File.foreach(file) do |line|
+          m = COLOR_VAR_RE.match(line)
+          if m
+            var_name, css_color = m.captures
+            good = palette.nearest_value(css_color)
+            puts "Replace all references of @#{var_name} with @#{good.name} because #{good.css_color} is closest to #{css_color}."
+          end
+        end
+      end
+    end
+
+    private
+
+    # This assumes colors use a variable name, something like:
+    # @deepOrange: #ED4E00;
+
+    COLOR_VAR_RE = /@(\w+):\W*(#\h{3,8}|\w+);/i
+
+    def palette
+      @palette ||= read_palette_files(@palette_files)
+    end
+
+    def read_palette_files(palette_files)
+      p = Shade::Palette.new
+      palette_files.each do |ea|
+        File.foreach(ea) do |line|
+          m = COLOR_VAR_RE.match(line)
+          if m
+            var_name, css_color = m.captures
+            p.add(css_color, var_name)
+          end
+        end
+      end
+      p
+    end
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |opts|
+        opts.banner = 'Usage: shade --palette=[LESS-formatted file] [file to translate] ...'
+        opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+          @verbose = v
+        end
+        opts.on('-p', '--palette pallete.less',
+          'Read colors from pallete.less as the target palette') do |palette|
+          (@palette_files ||= []) << palette
+        end
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+        opts.on_tail('--version', 'Show version') do
+          puts Shade::VERSION
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/shade/palette.rb

@@ -0,0 +1,66 @@
+require 'color'
+require 'geokdtree'
+
+module Shade
+  class Palette
+    def initialize
+      @tree = Geokdtree::Tree.new(3)
+      @empty = true
+      yield self if block_given?
+    end
+
+    def add(css_color, name = nil)
+      @empty = false
+      value = Value.new(css_color, name)
+      @tree.insert(value.coords, value)
+    end
+
+    def empty?
+      @empty
+    end
+
+    # This implements the CIE76 color difference algorithm.
+    # See http://en.wikipedia.org/wiki/Color_difference#CIE76
+    def nearest_value(css_color)
+      value = Value.new(css_color)
+      result = @tree.nearest(value.coords)
+      result.data if result
+    end
+
+    # This implements the CIE94 color difference algorithm.
+    # See http://en.wikipedia.org/wiki/Color_difference#CIE94
+    # threshold_distance defaults to 40. Perceptible differences are > 2.3
+    def nearest_value_cie94(css_color, threshold_distance = 100)
+      value = Value.new(css_color)
+      result_points = @tree.nearest_range(value.coords, threshold_distance)
+      colors_to_values = Hash[result_points.map { |ea| [ea.data.color, ea.data] }]
+      best_match_color = value.color.closest_match(colors_to_values.keys)
+      colors_to_values[best_match_color]
+    end
+
+    class Value
+      attr_reader :css_color, :name
+
+      def initialize(css_color, name = nil)
+        @css_color = css_color
+        @name = name
+      end
+
+      def color
+        @color ||= Color::RGB.by_css(css_color)
+      end
+
+      def lab
+        @lab ||= color.to_lab
+      end
+
+      def coords
+        @coords ||= [lab[:L], lab[:a], lab[:b]]
+      end
+
+      def ==(e)
+        e.css_color == css_color && e.name == name
+      end
+    end
+  end
+end

data/lib/shade/version.rb

@@ -0,0 +1,3 @@
+module Shade
+  VERSION = Gem::Version.new('0.0.1')
+end

data/shade.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shade'
+  spec.version       = Shade::VERSION
+  spec.authors       = ['Matthew McEachen']
+  spec.email         = ['matthew+github@mceachen.org']
+  spec.summary       = %q{Coalesce colors to a given palette}
+  spec.description   = %q{Using CIE L*a*b* and kdtrees, take a color (from LESS, SCSS, or other
+                       inputs) and find the nearest shade of color from a given palette}
+  spec.homepage      = 'https://github.com/mceachen/shade'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'geokdtree'
+  spec.add_runtime_dependency 'color'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-great_expectations'
+  spec.add_development_dependency 'minitest-reporters'
+end

data/test/minitest_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'minitest'
+rescue LoadError
+  puts 'Failed to load the minitest gem; built-in version will be used.'
+end
+require 'minitest/autorun'
+require 'minitest/great_expectations'
+require 'minitest/reporters'
+require 'shade'
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new

data/test/palette_test.rb

@@ -0,0 +1,52 @@
+require 'minitest_helper'
+
+describe Shade::Palette do
+  describe 'small palette' do
+    let(:colors) { %w(purple orange olive crimson darkcyan indianred).shuffle }
+    let(:subject) { Shade::Palette.new { |p| colors.each { |ea| p.add(ea, ea.upcase) } } }
+    let(:purple) {Shade::Palette::Value.new('purple', 'PURPLE')}
+    let(:orange) {Shade::Palette::Value.new('orange', 'ORANGE')}
+    let(:crimson) {Shade::Palette::Value.new('crimson', 'CRIMSON')}
+    let(:darkcyan) {Shade::Palette::Value.new('darkcyan', 'DARKCYAN')}
+    let(:indianred) {Shade::Palette::Value.new('indianred', 'INDIANRED')}
+    it 'finds exact match colors' do
+      subject.nearest_value('purple').must_equal Shade::Palette::Value.new('purple', 'PURPLE')
+    end
+    it 'finds nearest by named color' do
+      subject.nearest_value('MediumPurple').must_equal purple
+      subject.nearest_value('Orchid').must_equal purple
+      subject.nearest_value('FireBrick').must_equal crimson
+      subject.nearest_value('SandyBrown').must_equal orange
+      subject.nearest_value_cie94('SandyBrown').must_equal orange
+      subject.nearest_value('MediumSeaGreen').must_equal darkcyan
+      subject.nearest_value_cie94('MediumSeaGreen').must_equal darkcyan
+      subject.nearest_value('LightCoral').must_equal indianred
+      subject.nearest_value_cie94('LightCoral').must_equal indianred
+    end
+  end
+  describe 'large palette' do
+    let(:subject) do
+      Shade::Palette.new do |p|
+        Color::RGB.send(:__by_name).keys.each do |color|
+          p.add(color)
+        end
+      end
+    end
+    it 'finds the best white' do
+      subject.nearest_value("#fff").must_equal Shade::Palette::Value.new('white')
+    end
+    it 'finds the nearest turquoise' do
+      subject.nearest_value("#00B7AF").must_equal Shade::Palette::Value.new('lightseagreen')
+    end
+    it 'finds the nearest ferrari red' do
+      subject.nearest_value("#FF2800").must_equal Shade::Palette::Value.new('red')
+    end
+  end
+  describe 'Fuschias' do
+    let(:subject) { Shade::Palette.new { |p| %w(#FF367E #E03894 #B6388B #CE3E7C).each { |ea| p.add(ea) } } }
+    it 'finds the most similar fuschia' do
+      subject.nearest_value('#E14BAC').must_equal Shade::Palette::Value.new('#E03894')
+      subject.nearest_value_cie94('#E14BAC').must_equal Shade::Palette::Value.new('#E03894')
+    end
+  end
+end

data/test/test.html

@@ -0,0 +1,32 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Test</title>
+  <style>
+    p {padding:1em; font-weight: bold; color: white}
+  </style>
+</head>
+<body>
+  <h2>Small palette</h2>
+  <p style="background-color:olive">olive</p>
+  <p style="background-color:mediumseagreen">mediumseagreen</p>
+  <p style="background-color:darkcyan">darkcyan</p>
+  <p style="background-color:purple">purple</p>
+  <p style="background-color:mediumpurple">mediumpurple</p>
+  <p style="background-color:orchid">orchid</p>
+  <p style="background-color:crimson">crimson</p>
+  <p style="background-color:firebrick">firebrick</p>
+  <p style="background-color:indianred">indianred</p>
+  <p style="background-color:lightcoral">lightcoral</p>
+  <p style="background-color:sandybrown">sandybrown</p>
+  <p style="background-color:orange">orange</p>
+
+  <h2>Fuschia</h2>
+  <p style="background-color:#FF367E">#FF367E</p>
+  <p style="background-color:#E14BAC">#E14BAC</p>
+  <p style="background-color:#E03894">#E03894</p>
+  <p style="background-color:#B6388B">#B6388B</p>
+  <p style="background-color:#CE3E7C">#CE3E7C</p>
+</body>
+</html>

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: shade
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew McEachen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geokdtree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-great_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Using CIE L*a*b* and kdtrees, take a color (from LESS, SCSS, or other
+                         inputs) and find the nearest shade of color from a given palette
+email:
+- matthew+github@mceachen.org
+executables:
+- shade
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/shade
+- lib/shade.rb
+- lib/shade/cli.rb
+- lib/shade/palette.rb
+- lib/shade/version.rb
+- shade.gemspec
+- test/minitest_helper.rb
+- test/palette_test.rb
+- test/test.html
+homepage: https://github.com/mceachen/shade
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Coalesce colors to a given palette
+test_files:
+- test/minitest_helper.rb
+- test/palette_test.rb
+- test/test.html
+has_rdoc: