svg_profiler 1.1.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 403478f11dec0b9d0c87c8446fc723c0b40014a2
+  data.tar.gz: 60c06392446473c358969008666e971377493260
+SHA512:
+  metadata.gz: 6d18996cd7623910260042b1238d98119c0b7a01637b10fdefee528fb36add99263d96d674e7ac9710bc121f22588a2e69d71b46bcc8bdcf260896863419c97d
+  data.tar.gz: 1fe9346efa9380632229012c407079c36e991222c1893575982519d0516c641ef06352b2b6b48d0a3f493df9fad60e57fe7c6a7be3500df59c18199c2f4ead74

data/README.md

@@ -28,21 +28,13 @@ profile.height
 profile.aspect
 #=> 1.5
 
-# The #colors method calculates the histogram for the SVG.
-profile.colors
+profile.histogram
 #=> { "#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.
+When calculating the histogram, the SVG is rasterized to a PNG and anti-aliased.
 
-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.
+This may have a small impact on the color ratios.
 
 ## Contribution
 

data/lib/svg_profiler.rb

@@ -1,6 +1,7 @@
 require "tempfile"
 
 require "rmagick"
+require "svg_palette"
 
 require "svg_profiler/base"
 require "svg_profiler/inkscape"

data/lib/svg_profiler/base.rb

@@ -1,6 +1,7 @@
 class SVGProfiler
 
   def initialize(xml_string)
+    @xml_string = xml_string
     @inkscape = Inkscape.new(xml_string)
   end
 
@@ -20,8 +21,8 @@ class SVGProfiler
     width.to_f / height
   end
 
-  def histogram(threshold = 0)
-    @inkscape.yield_png { |png| Histogram.for(png, threshold) }
+  def histogram
+    @inkscape.yield_png { |png| Histogram.for(@xml_string, png) }
   end
 
 end

data/lib/svg_profiler/histogram.rb

@@ -1,15 +1,18 @@
 class SVGProfiler::Histogram
 
-  def self.for(png, threshold)
-    new(png).histogram(threshold)
+  WARN_THRESHOLD = 0.02
+
+  def self.for(xml_string, png)
+    new(xml_string, png).histogram
   end
 
-  def initialize(png)
+  def initialize(xml_string, png)
     check_for_imagemagick
     @image = Magick::Image.read(png.path).first
+    @palette = SVGPalette.parse(xml_string)
   end
 
-  def histogram(threshold)
+  def histogram
     @image.quantize(8) # 00-FF is 8-bits.
 
     histogram = @image.color_histogram
@@ -17,11 +20,8 @@ class SVGProfiler::Histogram
       hash.merge(to_hex(p) => f)
     end
 
-    ratios = normalize(frequencies)
-    ratios.reject! { |_, v| v < threshold }
-
-    # Re-normalize after thresholding.
-    normalize(ratios)
+    filter_by_palette!(frequencies)
+    normalize(frequencies)
   end
 
   private
@@ -38,6 +38,30 @@ class SVGProfiler::Histogram
     pixel.to_color(Magick::AllCompliance, false, 8, true)
   end
 
+  # When the png is created, it gets anti-aliased.
+  # If it is down-sampled, you'll end up with many midway colors.
+  # These have a negligible pixel count and could be thresholded out.
+  # This seems like a better approach, assuming the palette is correct.
+  def filter_by_palette!(hash)
+    hex_codes = @palette.map(&:html)
+    pre_filter = normalize(hash)
+
+    hash.reject! do |k, v|
+      if !hex_codes.include?(k.downcase)
+        warn_if_filtering_a_prominent_color(k, pre_filter)
+        true
+      end
+    end
+  end
+
+  def warn_if_filtering_a_prominent_color(hex, normalized)
+    if normalized[hex] > WARN_THRESHOLD
+      puts "\n#{__FILE__}:#{__LINE__}"
+      puts "WARNING: '#{hex}' was been assumed to be an artifact of anti-aliasing when perhaps it was not."
+      puts "Please email your SVG to chris@patuzzo.co.uk, with a subject of `SVG Filter Threshold'."
+    end
+  end
+
   def normalize(frequencies)
     sum = frequencies.values.inject(:+)
     frequencies.inject({}) do |hash, (k, v)|

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svg_profiler
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Patuzzo
@@ -14,33 +13,43 @@ 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
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: svg_palette
+  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
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   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.
@@ -56,27 +65,25 @@ files:
 - lib/svg_profiler.rb
 homepage: https://github.com/cpatuzzo/svg_profiler
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SVG Profiler
 test_files: []
-has_rdoc: