miro 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8da79a7879154e553ec78af76e25f2a9d8a6b232
-  data.tar.gz: d180f86a6a43976d2d0ef84455aca46b109e36af
+  metadata.gz: 269d3bca169bf72e9496cf0b019b2f39d844f05b
+  data.tar.gz: 7ca804e24f8f4433fb01064c98477b3c56ac8804
 SHA512:
-  metadata.gz: 85e2a88179149a9afd9e4f62ad5a997115d705c72dd8d649a98b1cf157ee1e12fc756cf006a9f688f6e3a39c3aab8a6c4c03b8679fa2ba5765bb43c4330f0ee5
-  data.tar.gz: b870d98b936ebc868b49d5771ae7e6a402c640becc21bbd5c84c3abc81e5da488dc37298277c900fe2de9bef94b1c1fd52badf2fa0cfbfd8d8b81fa6000fffd6
+  metadata.gz: c2391941d1a5fe148ca76c0807fa78db23ac7b86ff00df2a95b5d420217c06aecc354242dc8b1ae49162cb9cdf3f185b5b50a84d3c46ee44d8c8ee976b077801
+  data.tar.gz: 4f9ac4fb9fccf3ad157411175860a62c1dc935ea5b6b8df1e754204d6b58fa730802d4500c4a7c90733b4dce90935eaa91fea27d74fead5817ac0b7d5a5a3c84

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Miro Changelog
+
+## 0.3.0
+
+* Enhancements
+  * new `:histogram` option for improved performance [#19][]
+  * Updated README
+
+[#19]: https://github.com/jonbuda/miro/pull/19

data/README.md

@@ -34,7 +34,9 @@ Miro.options # => {:image_magick_path  => "/usr/bin/convert", :resolution => "15
 Miro.options[:image_magick_path] = '/usr/local/bin/convert'
 Miro.options[:resolution] = '100x100'
 Miro.options[:color_count] = 4
+Miro.options[:method] = 'histogram'
 ```
+By default the method option is configured with 'pixel_group' to improve performance change to 'histogram', this will fetch directly from imagemagick the image histogram without any disk operation(read/write) but read the original file.
 
 Initializing an image
 
@@ -58,8 +60,18 @@ colors.to_rgb # => [[81, 51, 42], [44, 29, 24], [108, 73, 55], [101, 81, 74], [1
 # 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]]
 ```
+**Aditional methods only aviable when histogram method is enabled**
 
-Retrieving percentages of colors
+```ruby
+# HSL
+  colors.to_hsl # => [[0.03846153846153848, 0.3170731707317073, 0.24117647058823527], [0.041666666666666664, 0.29411764705882354, 0.13333333333333333], [0.056603773584905634, 0.32515337423312884, 0.3196078431372549], [0.043209876543209826, 0.15428571428571422, 0.3431372549019608], [0.04999999999999999, 0.30701754385964913, 0.4470588235294118], [0.2727272727272729, 0.18644067796610145, 0.884313725490196], [0.030158730158730152, 0.47511312217194573, 0.4333333333333333], [0.17283950617283947, 0.22314049586776857, 0.5254901960784314]]
+# CMYL
+  colors.to_cmyk # => [[0.15772788927335635, 0.2753749480968858, 0.3106690657439446, 0.5246250519031143], [0.10680607458669744, 0.16562960399846216, 0.1852374471357171, 0.7206449058054594], [0.18404784313725486, 0.32130274509803924, 0.39189098039215686, 0.3924227450980392], [0.20410654363706265, 0.2825379161860822, 0.30998889657823897, 0.3998150249903884], [0.18299487889273353, 0.37515174163783166, 0.4575046828143022, 0.23269139561707036], [0.11147515570934258, 0.0840241753171857, 0.12716143021914644, 0.010093471741637827], [0.14225937716262976, 0.479514279123414, 0.5540240830449827, 0.21852493656286048], [0.23082082276047672, 0.22297768550557479, 0.43474239138792764, 0.1456497654748174]] 
+# YIQ
+  colors.to_yiq # =>  => [[0.23115294117647056, 0.08144705882352937, 0.013964705882352914], [0.129078431372549, 0.04135294117647058, 0.006372549019607841], [0.31926666666666664, 0.10446274509803921, 0.007145098039215689], [0.33796862745098033, 0.05555686274509804, 0.008090196078431366], [0.4402235294117646, 0.14096078431372547, 0.015125490196078437], [0.892756862745098, 0.0, 0.0], [0.3943058823529411, 0.2249215686274509, 0.0483254901960784], [0.6048862745098039, 0.06330196078431369, 0.0]]
+```
+
+Retrieving percentages of colors *disabled on histogram method*
 
 ```ruby
 # percentage of each color in an image. matches sorting from to_hex,

data/lib/miro.rb

@@ -1,6 +1,7 @@
 require "miro/version"
 require "oily_png"
 require "cocaine"
+require "color"
 require "tempfile"
 require "open-uri"
 
@@ -14,8 +15,16 @@ module Miro
         :image_magick_path  => convert.length > 0 ? convert : '/usr/bin/convert',
         :resolution         => "150x150",
         :color_count        => 8,
-        :quantize           => 'RGB'
+        :quantize           => 'RGB',
+        :method             => 'pixel_group'
       }
     end
+    def pixel_group?
+      options[:method] == 'pixel_group'
+    end
+
+    def histogram?
+      options[:method] == 'histogram'
+    end
   end
 end

data/lib/miro/dominant_colors.rb

@@ -8,18 +8,34 @@ module Miro
     end
 
     def to_hex
-      sorted_pixels.collect {|c| ChunkyPNG::Color.to_hex c, false }
+      return histogram.map{ |item| item[1].html } if Miro.histogram?
+      sorted_pixels.collect { |pixel| ChunkyPNG::Color.to_hex(pixel, false) }
     end
 
     def to_rgb
-      sorted_pixels.collect {|c| ChunkyPNG::Color.to_truecolor_bytes c }
+      return histogram.map { |item| item[1].to_rgb.to_a } if Miro.histogram?
+      sorted_pixels.collect { |pixel| ChunkyPNG::Color.to_truecolor_bytes(pixel) }
     end
 
     def to_rgba
-      sorted_pixels.collect {|c| ChunkyPNG::Color.to_truecolor_alpha_bytes c }
+      return histogram.map { |item| item[1].css_rgba } if Miro.histogram?
+      sorted_pixels.collect { |pixel| ChunkyPNG::Color.to_truecolor_alpha_bytes(pixel) }
+    end
+
+   def to_hsl
+      histogram.map { |item| item[1].to_hsl.to_a } if Miro.histogram?
+    end
+
+    def to_cmyk
+      histogram.map { |item| item[1].to_cmyk.to_a } if Miro.histogram?
+    end
+
+    def to_yiq
+      histogram.map { |item| item[1].to_yiq.to_a } if Miro.histogram?
     end
 
     def by_percentage
+      return nil if Miro.histogram?
       sorted_pixels
       pixel_count = @pixels.size
       sorted_pixels.collect { |pixel| @grouped_pixels[pixel].size / pixel_count.to_f }
@@ -29,23 +45,40 @@ module Miro
       @sorted_pixels ||= extract_colors_from_image
     end
 
+    def histogram
+      @histogram || downsample_and_histogram.sort_by { |item| item[0]  }.reverse
+    end
   private
+
+    def downsample_and_histogram
+      @source_image = open_source_image
+      hstring = Cocaine::CommandLine.new(Miro.options[:image_magick_path], image_magick_params).
+        run(:in => File.expand_path(@source_image.path),
+            :resolution => Miro.options[:resolution],
+            :colors => Miro.options[:color_count].to_s,
+            :quantize => Miro.options[:quantize])
+      cleanup_temporary_files!
+      parse_result(hstring)
+    end
+
+    def parse_result(hstring)
+      hstring.scan(/(\d*):.*(#[0-9A-Fa-f]*)/).collect do |match|
+        [match[0].to_i, Object.const_get("Color::#{Miro.options[:quantize].upcase}").from_html(match[1])]
+      end
+    end
+
     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?:\/\//
+      colors
     end
 
     def downsample_colors_and_convert_to_png!
       @source_image = open_source_image
       @downsampled_image = open_downsampled_image
 
-      Cocaine::CommandLine.new(Miro.options[:image_magick_path], "':in[0]' -resize :resolution -colors :colors -colorspace :quantize -quantize :quantize :out").
+      Cocaine::CommandLine.new(Miro.options[:image_magick_path], image_magick_params).
         run(:in => File.expand_path(@source_image.path),
             :resolution => Miro.options[:resolution],
             :colors => Miro.options[:color_count].to_s,
@@ -54,22 +87,20 @@ module Miro
     end
 
     def open_source_image
-      if remote_source_image?
-        original_extension = @image_type || URI.parse(@src_image_path).path.split('.').last
+      return File.open(@src_image_path) unless remote_source_image?
 
-        tempfile = Tempfile.open(["source", ".#{original_extension}"])
-        remote_file_data = open(@src_image_path).read
+      original_extension = @image_type || URI.parse(@src_image_path).path.split('.').last
 
-        tempfile.write(should_force_encoding? ? remote_file_data.force_encoding("UTF-8") : remote_file_data)
-        tempfile.close
-        return tempfile
-      else
-        return File.open(@src_image_path)
-      end
+      tempfile = Tempfile.open(["source", ".#{original_extension}"])
+      remote_file_data = open(@src_image_path).read
+
+      tempfile.write(should_force_encoding? ? remote_file_data.force_encoding("UTF-8") : remote_file_data)
+      tempfile.close
+      tempfile
     end
 
     def should_force_encoding?
-      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9')
+      Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('1.9')
     end
 
     def open_downsampled_image
@@ -78,6 +109,14 @@ module Miro
       tempfile
     end
 
+    def image_magick_params
+      if Miro.histogram?
+        "':in[0]' -resize :resolution -colors :colors -colorspace :quantize -quantize :quantize -alpha remove -format %c histogram:info:"
+      else
+        "':in[0]' -resize :resolution -colors :colors -colorspace :quantize -quantize :quantize :out"
+      end
+    end
+
     def group_pixels_by_color
       @pixels ||= ChunkyPNG::Image.from_file(File.expand_path(@downsampled_image.path)).pixels
       @grouped_pixels ||= @pixels.group_by { |pixel| pixel }
@@ -88,8 +127,12 @@ module Miro
     end
 
     def cleanup_temporary_files!
-      @source_image.close(true) if remote_source_image?
-      @downsampled_image.close(true)
+      @source_image.close! if remote_source_image?
+      @downsampled_image.close! if @downsampled_image
+    end
+
+    def remote_source_image?
+      @src_image_path =~ /^https?:\/\//
     end
   end
 end

data/lib/miro/version.rb

@@ -1,3 +1,3 @@
 module Miro
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/miro.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "cocaine"
   gem.add_dependency "oily_png"
+  gem.add_dependency "color"
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "fakeweb"
@@ -22,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.name          = "miro"
   gem.require_paths = ["lib"]
   gem.version       = Miro::VERSION
+  gem.license       = "MIT"
 end

data/spec/miro/dominant_colors_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
 
 describe Miro::DominantColors do
+  context "colors_group method" 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) { 
+  let(:pixel_data) {
     [ 2678156287,
       1362307839, 1362307839, 1362307839, 1362307839, 1362307839, 1362307839, 1362307839, 1362307839,
       2506379263, 2506379263, 2506379263, 2506379263,
@@ -20,6 +21,7 @@ describe Miro::DominantColors do
   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
+    Miro.stub(:histogram?).and_return(false)
     Cocaine::CommandLine.stub(:new).and_return(double('command', :run => true))
     ChunkyPNG::Image.stub(:from_file).and_return(chunky_png_results)
   end
@@ -88,8 +90,8 @@ describe Miro::DominantColors do
     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)
+       mock_downsampled_image.should_receive(:close!)
+       mock_source_image.should_not_receive(:close!)
        subject.sorted_pixels
      end
   end
@@ -108,7 +110,7 @@ describe Miro::DominantColors do
     end
 
     it "deletes the temporary source file when finished" do
-       mock_source_image.should_receive(:close).with(true)
+       mock_source_image.should_receive(:close!)
        subject.sorted_pixels
      end
   end
@@ -155,5 +157,88 @@ describe Miro::DominantColors do
       end
     end
   end
-  
+  end
+
+  context "histogram method" do
+  let(:subject) { Miro::DominantColors.new(File.expand_path('spec/data/test.png')) }
+  let(:hex_colors){["#00ff02","#0000ff","#ff009a","#fa0000","#878787","#585858","#001a6b","#8f0074"]}
+  let(:object_colors){ hex_colors.map{|c| Color::RGB.from_html(c) } }
+
+  before do
+    Miro.stub(:histogram?).and_return(true)
+  end
+
+  describe "#downsample_and_histogram" do
+    it "should return an array" do
+      subject.send(:downsample_and_histogram).should be_an_instance_of(Array)
+    end
+
+    it "should contain colors" do
+      subject.send(:downsample_and_histogram).each do |item|
+       item[1].should be_an_instance_of(Color::RGB)
+      end
+    end
+
+    it "should have the max length of the color config" do
+      subject.send(:downsample_and_histogram).count.should <= Miro.options[:color_count]
+    end
+  end
+
+  describe "#histogram" do 
+    it "should return a hash" do
+      subject.histogram.should be_an_instance_of(Array)
+    end
+
+    it "should start with the most used color" do
+      subject.histogram.first[1].should == Color::RGB.from_html('#00FF02')
+    end
+
+    it "should end with the less used color" do
+      subject.histogram.last[1].should == Color::RGB.from_html('#8F0074')
+    end
+  end
+
+  describe "#to_hex" do
+    it "should be #00FF02 at the first element" do
+      subject.to_hex.first.should == hex_colors.first
+    end
+    it "should be #8F0074 at the first element" do
+      subject.to_hex.last.should == hex_colors.last
+    end
+    it "should have the right values" do
+      subject.to_hex.should == hex_colors
+    end
+  end
+
+  describe "#to_rgb" do
+    it "should have the right values" do
+      subject.to_rgb.should == object_colors.map(&:to_rgb).map(&:to_a)
+    end
+  end
+
+  describe "#to_rgba" do
+    it "should have the right values" do
+      subject.to_rgba.should == object_colors.map(&:css_rgba)
+    end
+  end
+
+  describe "#to_hsl" do
+    it "should have the right values" do
+      subject.to_hsl.should == object_colors.map(&:to_hsl).map(&:to_a)
+    end
+  end
+
+  describe "#to_cmyk" do
+    it "should have the right values" do
+      subject.to_cmyk.should == object_colors.map(&:to_cmyk).map(&:to_a)
+    end
+  end
+
+  describe "#to_yiq" do
+    it "should have the right values" do
+      subject.to_yiq.should == object_colors.map(&:to_yiq).map(&:to_a)
+    end
+  end
+
+  end
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: miro
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Jon Buda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
   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: oily_png
   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: rspec
   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: fakeweb
   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: Extract the dominant colors from an image.
@@ -73,8 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -83,11 +98,13 @@ files:
 - lib/miro/dominant_colors.rb
 - lib/miro/version.rb
 - miro.gemspec
+- spec/data/test.png
 - spec/miro/dominant_colors_spec.rb
 - spec/miro_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jonbuda/miro
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -95,22 +112,23 @@ 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:
 - ImageMagick
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Extract the dominant colors from an image.
 test_files:
+- spec/data/test.png
 - spec/miro/dominant_colors_spec.rb
 - spec/miro_spec.rb
 - spec/spec_helper.rb