svg_profiler 1.0.1 → 1.1.0

data/README.md

@@ -4,10 +4,8 @@ Profiles a Scalable Vector Graphics xml string.
 
 ## Setup
 
-SVG Profiler depends on an open-source application called Inkscape.
-
 ```
-brew install inkscape
+brew install imagemagick inkscape
 gem install svg_profiler
 ```
 
@@ -29,8 +27,23 @@ profile.height
 
 profile.aspect
 #=> 1.5
+
+# The #colors method calculates the histogram for the SVG.
+profile.colors
+#=> { "#FF0000" => 0.7, "#FFFFFF" => 0.29, "#000000" => 0.01 }
+```
+
+You may find that the SVG is [antialiased](http://en.wikipedia.org/wiki/Spatial_anti-aliasing) before the histogram is calculated.
+
+You can pass an optional threshold to the `#colors` method, to help cope with this:
+
+```ruby
+profile.colors(0.02)
+#=> { "#FF0000" => 0.7070707070707071, "#FFFFFF" => 0.29292929292929293 }
 ```
 
+The sum of the values in the hash will always add up to one.
+
 ## Contribution
 
 If there's a metric you'd like to see implemented, please send a pull request or open an issue.

data/lib/svg_profiler.rb

@@ -1,4 +1,7 @@
 require "tempfile"
 
+require "rmagick"
+
 require "svg_profiler/base"
 require "svg_profiler/inkscape"
+require "svg_profiler/histogram"

data/lib/svg_profiler/base.rb

@@ -20,4 +20,8 @@ class SVGProfiler
     width.to_f / height
   end
 
+  def colors(threshold = 0)
+    @inkscape.yield_png { |png| Histogram.for(png, threshold) }
+  end
+
 end

data/lib/svg_profiler/histogram.rb

@@ -0,0 +1,48 @@
+class SVGProfiler::Histogram
+
+  def self.for(png, threshold)
+    new(png).histogram(threshold)
+  end
+
+  def initialize(png)
+    check_for_imagemagick
+    @image = Magick::Image.read(png.path).first
+  end
+
+  def histogram(threshold)
+    @image.quantize(8) # 00-FF is 8-bits.
+
+    histogram = @image.color_histogram
+    frequencies = histogram.inject({}) do |hash, (p, f)|
+      hash.merge(to_hex(p) => f)
+    end
+
+    ratios = normalize(frequencies)
+    ratios.reject! { |_, v| v < threshold }
+
+    # Re-normalize after thresholding.
+    normalize(ratios)
+  end
+
+  private
+  def check_for_imagemagick
+    unless system("which convert &>/dev/null")
+      raise DependencyError.new(
+        "Could not locate Imagemagick, try `brew install imagemagick'"
+      )
+    end
+  end
+
+  def to_hex(pixel)
+    # The first two parameters are ignored by RMagick.
+    pixel.to_color(Magick::AllCompliance, false, 8, true)
+  end
+
+  def normalize(frequencies)
+    sum = frequencies.values.inject(:+)
+    frequencies.inject({}) do |hash, (k, v)|
+      hash.merge(k => v.to_f / sum)
+    end
+  end
+
+end

data/lib/svg_profiler/inkscape.rb

@@ -2,11 +2,7 @@ class SVGProfiler::Inkscape
 
   def initialize(xml)
     check_for_inkscape
-
-    input = Tempfile.new(["input", ".svg"])
-    input.write(xml.to_s)
-    input.close
-    @path = input.path
+    @xml = xml
   end
 
   def width
@@ -17,6 +13,15 @@ class SVGProfiler::Inkscape
     exec("-H").to_i
   end
 
+  def yield_png(&block)
+    tmp = Tempfile.new(["tmp", ".png"])
+    write_png(tmp.path)
+    yield tmp
+  ensure
+    tmp.close
+    tmp.unlink
+  end
+
   private
   def check_for_inkscape
     unless system("which inkscape &>/dev/null")
@@ -27,7 +32,17 @@ class SVGProfiler::Inkscape
   end
 
   def exec(command)
-    `inkscape -z #{command} #@path`
+    input = Tempfile.new(["input", ".svg"])
+    input.write(@xml.to_s)
+    input.close
+
+    `inkscape -z #{command} #{input.path}`
+  ensure
+    input.unlink
+  end
+
+  def write_png(path)
+    exec("-e #{path}")
   end
 
   class DependencyError < StandardError; end

metadata

@@ -1,83 +1,82 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: svg_profiler
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Chris Patuzzo
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-09 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
+date: 2013-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Profiles a Scalable Vector Graphics xml string.
 email: chris@patuzzo.co.uk
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - lib/svg_profiler/base.rb
+- lib/svg_profiler/histogram.rb
 - lib/svg_profiler/inkscape.rb
 - lib/svg_profiler.rb
-has_rdoc: true
 homepage: https://github.com/cpatuzzo/svg_profiler
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: SVG Profiler
 test_files: []
-
+has_rdoc: