miro 0.2.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jon Buda
+
+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,74 @@
+# Miro
+
+Extract the dominant colors from an image.
+
+## Feedback
+
+Questions, Comments, Concerns, or Bugs?
+
+[GitHub Issues For All!](https://github.com/jonbuda/miro/issues)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'miro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install miro
+
+## Usage
+
+Configuration
+
+```ruby
+# Defaults
+Miro.options # => {:image_magick_path  => "/usr/bin/convert", :resolution => "150x150", :color_count => 8}
+```
+
+```ruby
+# Setting
+Miro.options[:image_magick_path] = '/usr/local/bin/convert'
+Miro.options[:resolution] = '100x100'
+Miro.options[:color_count] = 4
+```
+
+Initializing an image
+
+```ruby
+# Initialize with a local image
+colors = Miro::DominantColors.new('/path/to/local/image.jpg')
+
+# or Initialize with a remote image
+colors = Miro::DominantColors.new('http://domain.com/path/to/image.jpg')
+```
+
+Retrieving colors from an image
+
+```ruby
+# Hex
+colors.to_hex # => ["#51332a", "#2c1d18", "#6c4937", "#65514a", "#95644f", "#e0e7dc", "#a34d3a", "#9fa16b"]
+
+# RGB
+colors.to_rgb # => [[81, 51, 42], [44, 29, 24], [108, 73, 55], [101, 81, 74], [149, 100, 79], [224, 231, 220], [163, 77, 58], [159, 161, 107]]
+
+# RGB with Alpha channels
+colors.to_rgba # => [[82, 37, 40, 255], [48, 17, 19, 255], [109, 70, 71, 255], [221, 158, 48, 255], [168, 103, 48, 255], [226, 178, 79, 255], [191, 146, 65, 255], [199, 165, 150, 255]]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright 2012 Jon Buda. This is free software, and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/miro/dominant_colors.rb

@@ -0,0 +1,85 @@
+module Miro
+  class DominantColors
+    attr_accessor :src_image_path
+
+    def initialize(src_image_path)
+      @src_image_path = src_image_path
+    end
+
+    def to_hex
+      sorted_pixels.collect {|c| ChunkyPNG::Color.to_hex c, false }
+    end
+
+    def to_rgb
+      sorted_pixels.collect {|c| ChunkyPNG::Color.to_truecolor_bytes c }
+    end
+
+    def to_rgba
+      sorted_pixels.collect {|c| ChunkyPNG::Color.to_truecolor_alpha_bytes c }
+    end
+
+    def sorted_pixels
+      @sorted_pixels ||= extract_colors_from_image
+    end
+
+  private
+    def extract_colors_from_image
+      downsample_colors_and_convert_to_png!
+      colors = sort_by_dominant_color
+      cleanup_temporary_files!
+      return colors
+    end
+
+    def remote_source_image?
+      @src_image_path =~ /^https?:\/\//
+    end
+
+    def downsample_colors_and_convert_to_png!
+      @source_image = open_source_image
+      @downsampled_image = open_downsampled_image
+      command.run
+    end
+
+    def command
+      Cocaine::CommandLine.new(Miro.options[:image_magick_path], ":in -resize :resolution -colors :colors :out",
+                              :in => File.expand_path(@source_image.path),
+                              :resolution => Miro.options[:resolution],
+                              :colors => Miro.options[:color_count].to_s,
+                              :out => File.expand_path(@downsampled_image.path))
+    end
+
+    def open_source_image
+      if remote_source_image?
+        original_extension = URI.parse(@src_image_path).path.split('.').last
+        
+        tempfile = Tempfile.open(["source", ".#{original_extension}"])
+        remote_file_data = open(@src_image_path).read
+
+        tempfile.write(RUBY_VERSION =~ /1.9/ ? remote_file_data.force_encoding("UTF-8") : remote_file_data)
+        return tempfile
+      else
+        return File.open(@src_image_path)
+      end
+    end
+
+    def open_downsampled_image
+      tempfile = Tempfile.open(["downsampled", '.png'])
+      tempfile.binmode
+      tempfile
+    end
+
+    def group_pixels_by_color
+      chunky_png = ChunkyPNG::Image.from_file File.expand_path(@downsampled_image.path)
+      chunky_png.pixels.group_by { |pixel| pixel }
+    end
+
+    def sort_by_dominant_color
+      group_pixels_by_color.sort_by { |k,v| v.size }.reverse.flatten.uniq
+    end
+
+    def cleanup_temporary_files!
+      @source_image.close(true) if remote_source_image?
+      @downsampled_image.close(true)
+    end
+  end
+end

data/lib/miro/version.rb

@@ -0,0 +1,3 @@
+module Miro
+  VERSION = "0.2.0"
+end

data/lib/miro.rb

@@ -0,0 +1,19 @@
+require "miro/version"
+require "oily_png"
+require "cocaine"
+require "tempfile"
+require "open-uri"
+
+require "miro/dominant_colors"
+
+module Miro
+  class << self
+    def options
+      @options ||= {
+        :image_magick_path  => "/usr/bin/convert",
+        :resolution         => "150x150",
+        :color_count        => 8
+      }
+    end
+  end
+end

data/miro.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/miro/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jon Buda"]
+  gem.email         = ["jon.buda@gmail.com"]
+  gem.description   = %q{Extract the dominant colors from an image.}
+  gem.summary       = %q{Extract the dominant colors from an image.}
+  gem.homepage      = "https://github.com/jonbuda/miro"
+
+  gem.requirements  = 'ImageMagick'
+
+  gem.add_dependency "cocaine"
+  gem.add_dependency "oily_png"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "fakeweb"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "miro"
+  gem.require_paths = ["lib"]
+  gem.version       = Miro::VERSION
+end

data/spec/miro/dominant_colors_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Miro::DominantColors do
+  let(:subject) { Miro::DominantColors.new('/path/to/file') }
+  let(:mock_source_image) { double('file', :path => '/path/to/source_image').as_null_object }
+  let(:mock_downsampled_image) { double('file', :path => '/path/to/downsampled_image').as_null_object }
+  let(:pixel_data) { 
+    [ 2678156287,
+      1362307839, 1362307839, 1362307839, 1362307839, 1362307839, 1362307839, 1362307839, 1362307839,
+      2506379263, 2506379263, 2506379263, 2506379263,
+      2739747583, 2739747583,
+      1816737791, 1816737791, 1816737791, 1816737791, 1816737791, 1816737791,
+      1699826431, 1699826431, 1699826431, 1699826431, 1699826431,
+      3773291775, 3773291775, 3773291775,
+      740104447, 740104447, 740104447, 740104447, 740104447, 740104447, 740104447 ] }
+  let(:chunky_png_results) { double('chunkypng', :pixels => pixel_data) }
+  let(:expected_pixels) { [1362307839, 740104447, 1816737791, 1699826431, 2506379263, 3773291775, 2739747583, 2678156287] }
+  let(:expected_hex_values) { ["#51332a", "#2c1d18", "#6c4937", "#65514a", "#95644f", "#e0e7dc", "#a34d3a", "#9fa16b"] }
+  let(:expected_rgba_values) { [[81, 51, 42, 255], [44, 29, 24, 255], [108, 73, 55, 255], [101, 81, 74, 255], [149, 100, 79, 255], [224, 231, 220, 255], [163, 77, 58, 255], [159, 161, 107, 255]] }
+  let(:expected_rgb_values) { [[81, 51, 42], [44, 29, 24], [108, 73, 55], [101, 81, 74], [149, 100, 79], [224, 231, 220], [163, 77, 58], [159, 161, 107]] }
+
+  before do
+    Cocaine::CommandLine.stub(:new).and_return(double('command', :run => true))
+    ChunkyPNG::Image.stub(:from_file).and_return(chunky_png_results)
+  end
+
+  it "takes a paramter and sets the source image path" do
+    miro = Miro::DominantColors.new('path/to/file')
+    miro.src_image_path.should eq('path/to/file')
+  end
+
+  describe "#sorted_pixels" do
+    before { subject.stub(:extract_colors_from_image).and_return(expected_pixels) }
+
+    it "extracts colors from the image the first time it's called" do
+      subject.should_receive(:extract_colors_from_image).and_return(expected_pixels)
+      subject.sorted_pixels
+    end
+
+    it "returns previously extracted colors on subsequent calls" do
+      subject.should_receive(:extract_colors_from_image).once
+      subject.sorted_pixels
+      subject.sorted_pixels
+    end
+  end
+
+  context "when extracting colors" do
+    before do
+      File.stub(:open).and_return(mock_source_image)
+    end
+
+    it "opens the tempfile for the downsampled image" do
+      Tempfile.should_receive(:open).with(['downsampled', '.png']).and_return(mock_downsampled_image)
+      subject.sorted_pixels
+    end
+
+    it "runs the imagemagick command line with the correct arguments" do
+      subject.stub(:open_downsampled_image).and_return(mock_downsampled_image)
+      Cocaine::CommandLine.should_receive(:new).with(Miro.options[:image_magick_path],
+                                                     ":in -resize :resolution -colors :colors :out",
+                                                     :in => '/path/to/source_image',
+                                                     :resolution => Miro.options[:resolution],
+                                                     :colors => Miro.options[:color_count].to_s,
+                                                     :out => '/path/to/downsampled_image')
+      subject.sorted_pixels
+    end
+
+    it "sorts the colors from most dominant to least" do
+      subject.stub(:open_downsampled_image).and_return(mock_downsampled_image)
+      subject.sorted_pixels.should eq(expected_pixels)
+    end
+  end
+
+  context "when the source image is a local image file" do
+    let(:subject) { Miro::DominantColors.new('/path/to/image.jpg') }
+
+    before do
+      File.stub(:open).and_return(mock_source_image)
+      subject.stub(:open_downsampled_image).and_return(mock_downsampled_image)
+    end
+
+    it "opens for the file resource" do
+      File.should_receive(:open).with(subject.src_image_path)
+      subject.sorted_pixels
+    end
+
+    it "deletes only temporary downsampled file when finished" do
+       mock_downsampled_image.should_receive(:close).with(true)
+       mock_source_image.should_not_receive(:close)
+       subject.sorted_pixels
+     end
+  end
+
+  context "when the source image is a remote image" do
+    let(:subject) { Miro::DominantColors.new('http://domain.com/to/image.jpg') }
+
+    before do
+      subject.stub(:open_downsampled_image).and_return(mock_downsampled_image)
+      Tempfile.stub(:open).and_return(mock_source_image)
+    end
+
+    it "opens for the file resource" do
+      Tempfile.should_receive(:open).with(['source','.jpg']).and_return(mock_source_image)
+      subject.sorted_pixels
+    end
+
+    it "deletes the temporary source file when finished" do
+       mock_source_image.should_receive(:close).with(true)
+       subject.sorted_pixels
+     end
+  end
+
+  context "when retrieving various color values" do
+    before { subject.stub(:sorted_pixels).and_return(expected_pixels) }
+
+    describe "#to_hex" do
+      it "converts sorted pixel data into hex color values" do
+        subject.to_hex.should eq(expected_hex_values)
+      end
+    end
+
+    describe "#to_rgb" do
+      it "converts sorted pixel data into rgb color values" do
+        subject.to_rgb.should eq(expected_rgb_values)
+      end
+    end
+
+    describe "#to_rgba" do
+      it "converts sorted pixel data into rgba color values" do
+        subject.to_rgba.should eq(expected_rgba_values)
+      end
+    end
+  end
+end

data/spec/miro_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Miro do
+  describe '.options' do
+    it "has default options" do
+      Miro.options[:image_magick_path].should eq('/usr/bin/convert')
+      Miro.options[:color_count].should eq(8)
+      Miro.options[:resolution].should eq('150x150')
+    end
+
+    it "can override the default options" do
+      Miro.options[:image_magick_path] = '/path/to/command'
+      Miro.options[:image_magick_path].should == '/path/to/command'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+require 'miro'
+require 'fakeweb'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+FakeWeb.register_uri(:get, "http://domain.com/to/image.jpg", :body => "image data")

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: miro
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jon Buda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-25 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cocaine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oily_png
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Extract the dominant colors from an image.
+email: 
+- jon.buda@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/miro.rb
+- lib/miro/dominant_colors.rb
+- lib/miro/version.rb
+- miro.gemspec
+- spec/miro/dominant_colors_spec.rb
+- spec/miro_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/jonbuda/miro
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- ImageMagick
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Extract the dominant colors from an image.
+test_files: 
+- spec/miro/dominant_colors_spec.rb
+- spec/miro_spec.rb
+- spec/spec_helper.rb