sugar_png 0.0.1 → 0.4.0

data/spec/magic/zoom_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe SugarPNG do
+  describe "zoom" do
+    it "zooms 1x1 => 2x2" do
+      SugarPNG.new do |img|
+        img[0,0] = ZPNG::Color::RED
+        img.zoom = 2
+
+        img = ZPNG::Image.new(img.to_s)
+        img.width.should == 2
+        img.height.should == 2
+        img.pixels.each do |c|
+          c.should == ZPNG::Color::RED
+        end
+      end
+    end
+
+    it "zooms 2x1 => 4x2" do
+      SugarPNG.new do |img|
+        img[0,0] = ZPNG::Color::RED
+        img[1,0] = ZPNG::Color::GREEN
+        img.zoom = 2
+
+        img = ZPNG::Image.new(img.to_s)
+        img.width.should == 4
+        img.height.should == 2
+        img.each_pixel do |c,x,y|
+          if x < 2
+            c.should == ZPNG::Color::RED
+          else
+            c.should == ZPNG::Color::GREEN
+          end
+        end
+      end
+    end
+  end
+end

data/spec/png_suite_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe 'PNG testsuite' do
+
+#  context 'Decoding broken images' do
+#    png_suite_files(:broken).each do |fname|
+#      it "should report #{File.basename(fname)} as broken" do
+#        lambda { SugarPNG::Image.from_file(fname) }.should raise_error(SugarPNG::Exception)
+#      end
+#
+#      it "should not report #{File.basename(fname)} as unsupported" do
+#        lambda { SugarPNG::Image.from_file(fname) }.should_not raise_error(SugarPNG::NotSupported)
+#      end
+#    end
+#  end
+
+  context 'Decoding supported images' do
+    png_suite_files(:basic, '*.png').each do |fname|
+
+      reference = rgba_for(fname)
+      if fname =~ /[in](\d)[apgc](\d\d)\.png$/
+        color_mode, bit_depth = $1.to_i, $2.to_i
+      else
+        next
+      end
+
+      it "decodes #{File.basename(fname)} (color mode: #{color_mode}, bit depth: #{bit_depth}) exactly the same as the reference image" do
+        decoded = SugarPNG::Canvas.from_file(fname)
+        File.open(reference, 'rb') do |f|
+          if decoded.to_rgba_stream != f.read
+            File.open(reference+".my", 'wb') { |fo| fo<<decoded.to_rgba_stream }
+          end
+        end
+        File.open(reference, 'rb') { |f| decoded.to_rgba_stream.should == f.read }
+      end
+    end
+  end
+
+  context 'Decoding text chunks' do
+
+    it "should not find metadata in a file without text chunks" do
+      image = SugarPNG::Image.from_file(png_suite_file(:metadata, 'cm0n0g04.png'))
+      image.metadata.should be_empty
+    end
+
+    it "should find metadata in a file with uncompressed text chunks" do
+      image = SugarPNG::Image.from_file(png_suite_file(:metadata, 'ct1n0g04.png'))
+      image.metadata.should_not be_empty
+      image.metadata.size.should == 6 # zzz
+    end
+
+    it "should find metadata in a file with compressed text chunks" do
+      image = SugarPNG::Image.from_file(png_suite_file(:metadata, 'ctzn0g04.png'))
+      image.metadata.should_not be_empty
+      image.metadata.size.should == 6 # zzz
+    end
+
+    %w'cten0g04.png ctfn0g04.png ctgn0g04.png cthn0g04.png ctjn0g04.png'.each do |fname|
+      it "should find metadata in a file with intl text chunks (#{fname})" do
+        image = SugarPNG::Image.from_file(png_suite_file(:metadata, fname))
+        image.metadata.should_not be_empty
+        image.metadata.size.should == 6 # zzz
+      end
+    end
+  end
+
+  context 'Decoding filter methods' do
+    png_suite_files(:filtering, '*_reference.png').each do |reference_file|
+      fname = reference_file.sub(/_reference\.png$/, '.png')
+      filter_method = fname.match(/f(\d\d)[a-z0-9]+\.png/)[1].to_i
+
+      it "should decode #{File.basename(fname)} (filter method: #{filter_method}) exactly the same as the reference image" do
+        decoded   = SugarPNG::Canvas.from_file(fname)
+        reference = SugarPNG::Canvas.from_file(reference_file)
+        decoded.should == reference
+      end
+    end
+  end
+
+  context 'Decoding different chunk splits' do
+    it "should decode grayscale images successfully regardless of the data chunk ordering and splitting" do
+      reference = SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi1n0g16.png')).imagedata
+      SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi2n0g16.png')).imagedata.should == reference
+      SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi4n0g16.png')).imagedata.should == reference
+      SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi9n0g16.png')).imagedata.should == reference
+    end
+
+    it "should decode color images successfully regardless of the data chunk ordering and splitting" do
+      reference = SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi1n2c16.png')).imagedata
+      SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi2n2c16.png')).imagedata.should == reference
+      SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi4n2c16.png')).imagedata.should == reference
+      SugarPNG::Datastream.from_file(png_suite_file(:chunk_ordering, 'oi9n2c16.png')).imagedata.should == reference
+    end
+  end
+
+  context 'Decoding different compression levels' do
+    it "should decode the image successfully regardless of the compression level" do
+      reference = SugarPNG::Datastream.from_file(png_suite_file(:compression_levels, 'z00n2c08.png')).imagedata
+      SugarPNG::Datastream.from_file(png_suite_file(:compression_levels, 'z03n2c08.png')).imagedata.should == reference
+      SugarPNG::Datastream.from_file(png_suite_file(:compression_levels, 'z06n2c08.png')).imagedata.should == reference
+      SugarPNG::Datastream.from_file(png_suite_file(:compression_levels, 'z09n2c08.png')).imagedata.should == reference
+    end
+  end
+
+  context 'Decoding transparency' do
+    png_suite_files(:transparency, 'tp0*.png').each do |file|
+      it "should not have transparency in #{File.basename(file)}" do
+        SugarPNG::Color.a(SugarPNG::Image.from_file(file)[0,0]).should == 255
+      end
+    end
+
+    png_suite_files(:transparency, 'tp1*.png').each do |file|
+      it "should have transparency in #{File.basename(file)}" do
+        SugarPNG::Color.a(SugarPNG::Image.from_file(file)[0,0]).should == 0
+      end
+    end
+
+    png_suite_files(:transparency, 'tb*.png').each do |file|
+      it "should have transparency in #{File.basename(file)}" do
+        SugarPNG::Color.a(SugarPNG::Image.from_file(file)[0,0]).should == 0
+      end
+    end
+  end
+
+  context 'Decoding different sizes' do
+    png_suite_files(:sizes, '*n*.png').each do |fname|
+      if fname =~ /s(\d\d)n\dp\d\d/
+        dimension = $1.to_i
+      else
+        next
+      end
+
+      it "should create a canvas with a #{dimension}x#{dimension} size" do
+        canvas = SugarPNG::Image.from_file(fname)
+        canvas.width.should == dimension
+        canvas.height.should == dimension
+      end
+
+      it "should decode the #{dimension}x#{dimension} interlaced image exactly the same the non-interlaced version" do
+        interlaced_file = fname.sub(/n3p(\d\d)\.png$/, 'i3p\\1.png')
+        SugarPNG::Image.from_file(interlaced_file).should == SugarPNG::Image.from_file(fname)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,14 +2,54 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'sugar_png'
+require 'awesome_print'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+SAMPLES_DIR = File.expand_path("../samples", File.dirname(__FILE__))
+
+SAMPLES =
+  if ENV['SAMPLES']
+    ENV['SAMPLES'].split(' ')
+  else
+    Dir[File.join(SAMPLES_DIR,'qr_*.png')]
+  end
+
+PNGSuite.init( File.join(SAMPLES_DIR, "png_suite") )
+
+def png_suite_file(kind, file)
+  File.join(PNGSuite.dir, file)
+end
+
+def rgba_for fname
+  dir = File.expand_path "../samples/rgba", File.dirname(__FILE__)
+  unless Dir.exist?(dir)
+    system "tar", "xjf", dir+".tar.bz2", "-C", File.dirname(dir)
+  end
+  File.join( dir, File.basename(fname, ".png")) + ".rgba"
+end
+
+def png_suite_files(kind, pattern = "*.png")
+  kinds = {
+    :broken       => "x*",
+    :basic        => "bas*",
+    :filtering    => "f*",
+    :transparency => "t[bp]*",
+    :sizes        => "s*"
+  }
+  kind = kinds[kind] || raise("unknown kind: #{kind}")
+
+  a = Dir[File.join(PNGSuite.dir, pattern)]
+  a.keep_if{ |fname| File.fnmatch?(kind, File.basename(fname)) }
+  puts "[?] png_suite_files: no files for #{[kind, pattern].inspect}".yellow if a.empty?
+  a
+end
+
 module ResourceFileHelper
   def resource_file(name)
-    File.expand_path("./resources/#{name}", File.dirname(__FILE__))
+    File.expand_path("../samples/#{name}", File.dirname(__FILE__))
   end
 
   def resource_data(name)
@@ -20,5 +60,7 @@ module ResourceFileHelper
 end
 
 RSpec.configure do |config|
+  config.extend  PNGSuite
+  config.include PNGSuite
   config.include ResourceFileHelper
 end

data/spec/sugar_png/datastream_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SugarPNG::Datastream do
+
+  describe '.from_io'do
+    it "should raise an error when loading a file with a bad signature" do
+      filename = resource_file('damaged_signature.png')
+      lambda { SugarPNG::Datastream.from_file(filename) }.should raise_error
+    end
+
+    it "should NOT raise an error if the CRC of a chunk is incorrect" do
+      filename = resource_file('damaged_chunk.png')
+      lambda { SugarPNG::Datastream.from_file(filename) }.should_not raise_error
+    end
+  end
+
+  describe '#metadata' do
+    it "should load uncompressed tXTt chunks correctly" do
+      filename = resource_file('text_chunk.png')
+      ds = SugarPNG::Datastream.from_file(filename)
+      ds.metadata['Title'].should  == 'My amazing icon!'
+      ds.metadata['Author'].should == "Willem van Bergen"
+    end
+
+    it "should load compressed zTXt chunks correctly" do
+      filename = resource_file('ztxt_chunk.png')
+      ds = SugarPNG::Datastream.from_file(filename)
+      ds.metadata['Title'].should == 'PngSuite'
+      ds.metadata['Copyright'].should == "Copyright Willem van Schaik, Singapore 1995-96"
+    end
+  end
+end

data/spec/support/png_suite.rb

@@ -0,0 +1,43 @@
+module PNGSuite
+  PNG_SUITE_URL = "http://www.schaik.com/pngsuite/PngSuite-2011apr25.tgz"
+
+  class << self
+    attr_accessor :dir
+
+    def init dir
+      @dir = dir
+      if Dir.exist?(dir)
+        if Dir[File.join(dir, "*.png")].size > 100
+          # already fetched and unpacked
+          return
+        end
+      else
+        Dir.mkdir(dir)
+      end
+      require 'open-uri'
+      puts "[.] fetching PNG test-suite from #{PNG_SUITE_URL} .. "
+      data = open(PNG_SUITE_URL).read
+
+      fname = File.join(dir, "png_suite.tgz")
+      File.open(fname, "wb"){ |f| f<<data }
+      puts "[.] unpacking .. "
+      system "tar", "xzf", fname, "-C", dir
+    end
+
+    def each *prefixes
+      Dir[File.join(dir,"*.png")].each do |fname|
+        if prefixes.empty?
+          yield fname
+        elsif prefixes.any?{ |p| p[/[*?\[]/] ? File.fnmatch(p, File.basename(fname)) : File.basename(fname).start_with?(p) }
+          yield fname
+        end
+      end
+    end
+
+    def each_good
+      Dir[File.join(dir,"[^x]*.png")].each do |fname|
+        yield fname
+      end
+    end
+  end
+end

data/sugar_png.gemspec

@@ -5,14 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = "sugar_png"
-  s.version = "0.0.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrey \"Zed\" Zaikin"]
-  s.date = "2012-12-24"
+  s.date = "2013-01-02"
   s.email = "zed.0xff@gmail.com"
   s.extra_rdoc_files = [
-    "LICENSE.txt"
+    "LICENSE.txt",
+    "README.md",
+    "README.md.tpl"
   ]
   s.files = [
     ".document",
@@ -20,11 +22,275 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
+    "README.md",
+    "README.md.tpl",
     "Rakefile",
     "VERSION",
+    "data/1-dump-hex.rb",
+    "data/2-marshal-test.rb",
+    "data/3-hex2marshal.rb",
+    "data/font/00",
+    "data/font/01",
+    "data/font/02",
+    "data/font/03",
+    "data/font/04",
+    "data/font/05",
+    "data/font/06",
+    "data/font/07",
+    "data/font/09",
+    "data/font/0a",
+    "data/font/0b",
+    "data/font/0c",
+    "data/font/0d",
+    "data/font/0e",
+    "data/font/0f",
+    "data/font/10",
+    "data/font/11",
+    "data/font/12",
+    "data/font/13",
+    "data/font/14",
+    "data/font/15",
+    "data/font/16",
+    "data/font/17",
+    "data/font/18",
+    "data/font/19",
+    "data/font/1a",
+    "data/font/1b",
+    "data/font/1c",
+    "data/font/1d",
+    "data/font/1e",
+    "data/font/1f",
+    "data/font/20",
+    "data/font/21",
+    "data/font/22",
+    "data/font/23",
+    "data/font/24",
+    "data/font/25",
+    "data/font/26",
+    "data/font/27",
+    "data/font/28",
+    "data/font/29",
+    "data/font/2a",
+    "data/font/2b",
+    "data/font/2c",
+    "data/font/2d",
+    "data/font/2e",
+    "data/font/2f",
+    "data/font/30",
+    "data/font/31",
+    "data/font/32",
+    "data/font/33",
+    "data/font/34",
+    "data/font/35",
+    "data/font/36",
+    "data/font/37",
+    "data/font/38",
+    "data/font/39",
+    "data/font/3a",
+    "data/font/3b",
+    "data/font/3c",
+    "data/font/3d",
+    "data/font/3e",
+    "data/font/3f",
+    "data/font/40",
+    "data/font/41",
+    "data/font/42",
+    "data/font/43",
+    "data/font/44",
+    "data/font/45",
+    "data/font/46",
+    "data/font/47",
+    "data/font/48",
+    "data/font/49",
+    "data/font/4a",
+    "data/font/4b",
+    "data/font/4c",
+    "data/font/4d",
+    "data/font/4e",
+    "data/font/4f",
+    "data/font/50",
+    "data/font/51",
+    "data/font/52",
+    "data/font/53",
+    "data/font/54",
+    "data/font/55",
+    "data/font/56",
+    "data/font/57",
+    "data/font/58",
+    "data/font/59",
+    "data/font/5a",
+    "data/font/5b",
+    "data/font/5c",
+    "data/font/5d",
+    "data/font/5e",
+    "data/font/5f",
+    "data/font/60",
+    "data/font/61",
+    "data/font/62",
+    "data/font/63",
+    "data/font/64",
+    "data/font/65",
+    "data/font/66",
+    "data/font/67",
+    "data/font/68",
+    "data/font/69",
+    "data/font/6a",
+    "data/font/6b",
+    "data/font/6c",
+    "data/font/6d",
+    "data/font/6e",
+    "data/font/6f",
+    "data/font/70",
+    "data/font/71",
+    "data/font/72",
+    "data/font/73",
+    "data/font/74",
+    "data/font/75",
+    "data/font/76",
+    "data/font/77",
+    "data/font/78",
+    "data/font/79",
+    "data/font/7a",
+    "data/font/7b",
+    "data/font/7c",
+    "data/font/7d",
+    "data/font/7e",
+    "data/font/7f",
+    "data/font/80",
+    "data/font/81",
+    "data/font/82",
+    "data/font/83",
+    "data/font/84",
+    "data/font/85",
+    "data/font/86",
+    "data/font/87",
+    "data/font/88",
+    "data/font/89",
+    "data/font/8a",
+    "data/font/8b",
+    "data/font/8c",
+    "data/font/8d",
+    "data/font/8e",
+    "data/font/8f",
+    "data/font/90",
+    "data/font/91",
+    "data/font/92",
+    "data/font/93",
+    "data/font/94",
+    "data/font/95",
+    "data/font/96",
+    "data/font/97",
+    "data/font/98",
+    "data/font/99",
+    "data/font/9a",
+    "data/font/9b",
+    "data/font/9c",
+    "data/font/9d",
+    "data/font/9e",
+    "data/font/9f",
+    "data/font/a0",
+    "data/font/a1",
+    "data/font/a2",
+    "data/font/a3",
+    "data/font/a4",
+    "data/font/a5",
+    "data/font/a6",
+    "data/font/a7",
+    "data/font/a8",
+    "data/font/a9",
+    "data/font/aa",
+    "data/font/ac",
+    "data/font/ad",
+    "data/font/ae",
+    "data/font/af",
+    "data/font/b0",
+    "data/font/b1",
+    "data/font/b2",
+    "data/font/b3",
+    "data/font/b4",
+    "data/font/b5",
+    "data/font/b6",
+    "data/font/b7",
+    "data/font/b8",
+    "data/font/b9",
+    "data/font/ba",
+    "data/font/bb",
+    "data/font/bc",
+    "data/font/bd",
+    "data/font/be",
+    "data/font/bf",
+    "data/font/c0",
+    "data/font/c1",
+    "data/font/c2",
+    "data/font/c3",
+    "data/font/c4",
+    "data/font/c5",
+    "data/font/c6",
+    "data/font/c7",
+    "data/font/c8",
+    "data/font/c9",
+    "data/font/ca",
+    "data/font/cb",
+    "data/font/cc",
+    "data/font/cd",
+    "data/font/ce",
+    "data/font/cf",
+    "data/font/d0",
+    "data/font/d1",
+    "data/font/d2",
+    "data/font/d3",
+    "data/font/d4",
+    "data/font/d5",
+    "data/font/d6",
+    "data/font/d7",
+    "data/font/f9",
+    "data/font/fa",
+    "data/font/fb",
+    "data/font/fc",
+    "data/font/fd",
+    "data/font/fe",
+    "data/font/ff",
+    "data/unifont-5.1.20080820.7z",
+    "data/unused-4-read-tar.rb",
     "lib/sugar_png.rb",
+    "lib/sugar_png/border.rb",
+    "lib/sugar_png/color.rb",
     "lib/sugar_png/datastream.rb",
+    "lib/sugar_png/dyn_accessor.rb",
+    "lib/sugar_png/font.rb",
+    "lib/sugar_png/glyph.rb",
+    "lib/sugar_png/image.rb",
+    "samples/damaged_chunk.png",
+    "samples/png_suite/f00n0g08_reference.png",
+    "samples/png_suite/f00n2c08_reference.png",
+    "samples/png_suite/f01n0g08_reference.png",
+    "samples/png_suite/f01n2c08_reference.png",
+    "samples/png_suite/f02n0g08_reference.png",
+    "samples/png_suite/f02n2c08_reference.png",
+    "samples/png_suite/f03n0g08_reference.png",
+    "samples/png_suite/f03n2c08_reference.png",
+    "samples/png_suite/f04n0g08_reference.png",
+    "samples/png_suite/f04n2c08_reference.png",
+    "samples/readme/explicit_image_dimensions_bg_color.png",
+    "samples/readme/hello_world.png",
+    "samples/readme/japanese_text_with_rainbow_borders_zoomed_4x.png",
+    "samples/readme/pixels_can_be_set_using_ranges_enumerators_arrays.png",
+    "samples/readme/playing_with_transparency_16_bit_color_depth.png",
+    "samples/readme/white_noise.png",
+    "samples/rgba.tar.bz2",
+    "samples/text_chunk.png",
+    "samples/ztxt_chunk.png",
+    "spec/color_spec.rb",
+    "spec/font_spec.rb",
+    "spec/magic/border_spec.rb",
+    "spec/magic/create_spec.rb",
+    "spec/magic/pixels_spec.rb",
+    "spec/magic/text_spec.rb",
+    "spec/magic/zoom_spec.rb",
+    "spec/png_suite_spec.rb",
     "spec/spec_helper.rb",
+    "spec/sugar_png/datastream_spec.rb",
+    "spec/support/png_suite.rb",
     "sugar_png.gemspec"
   ]
   s.homepage = "http://github.com/zed-0xff/sugar_png"
@@ -37,21 +303,24 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<zpng>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<zpng>, [">= 0.2.1"])
       s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<awesome_print>, [">= 0"])
     else
-      s.add_dependency(%q<zpng>, [">= 0.2.0"])
+      s.add_dependency(%q<zpng>, [">= 0.2.1"])
       s.add_dependency(%q<rspec>, [">= 2.8.0"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<awesome_print>, [">= 0"])
     end
   else
-    s.add_dependency(%q<zpng>, [">= 0.2.0"])
+    s.add_dependency(%q<zpng>, [">= 0.2.1"])
     s.add_dependency(%q<rspec>, [">= 2.8.0"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<awesome_print>, [">= 0"])
   end
 end