chunky_png 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 323e9e7a7ff35bce40522c1f9f26763168fef3e0
-  data.tar.gz: a82e301e630948b3ecdc34bc7edfc3dc89bbdb93
+  metadata.gz: dba372d700355f7ad31ef72fc4615c6425ffbfeb
+  data.tar.gz: 090bfa0d2238e1568fffd5b21cc0d12f0c69106a
 SHA512:
-  metadata.gz: 2a62b78538767364a849f3c555e1cc3d8204a9dfb58638cf264033bb65d265ff7858c0c873858699906b627a0bcdbf7fbe46ab481a502663a01086470ae70420
-  data.tar.gz: 8be957364e9c0e2aae3b1a4789f370e24db4a5fc62e2458dab4d3e416b93bffd099a43f0bc3934177dfa0d22dfb222ed91a6db279d304655560da41f17a8131f
+  metadata.gz: b8fb329422a0509b8707321d15ef5c5a7cd6e3082e2cbdee61b490825b1bc1902cdbb8b484e1003c2dc5990435a935c391b76f86addb587f57424651e145b3a8
+  data.tar.gz: a2e0bbfc3a15c46e0f2d43ea1724d3821936ccc79c4957acf4f27f31f090e9902b33bae5a9cb6a72008d3ccae09aef6fb695498c5a55b1ecb03d6b8e954ca26e

data/BENCHMARKING.md

@@ -0,0 +1,38 @@
+# ChunkyPNG benchmark suite
+
+I would like the performance of this library as good as possible, and I will
+gladly accept changes to this library that improves performance.
+
+The library comes with a basic benchmark suite is intended to test the speed
+of PNG decoding and encoding against different ruby interpreters. Execute them
+using rake. You can set the number of runs by passing the N environment variable.
+
+    bundle exec rake benchmark:encoding
+    bundle exec rake benchmark:decoding
+
+    bundle exec rake benchmark N=10      # Run all of them with 10 iterations
+
+You can use rvm to run the benchmarks against different interpreters. Of course,
+make sure that the chunky_png is installed for all your interpreters.
+
+    rvm 1.8.7,1.9.3,rbx bundle exec rake benchmark N=10
+
+## Results
+
+What is a speed improvement on one interpreter doesn't necessarily mean the
+performance will be better on other interpreters as well. Please make sure to
+benchamrk different RUby interpreters. When it comes to different Ruby
+interpreters, the priority is the performance on recent MRI versions.
+
+Some very old benchmark result (using N=50) on my 2007 iMac can be found in
+[this gist](https://gist.github.com/wvanbergen/495323).
+
+## Why is this relevant?
+
+ChunkyPNG is a pure Ruby library to handle PNG files. Decoding a PNG requires
+a lot of integer math and bitwise operations, and moderate use of the unpack
+method to read binary data. Encoding is a good test for `Array#pack`, and
+depending on the encoding options, also requires a lot of calculations.
+Therefore, the library is a good benchmark candidate for these methods and
+algorithms. It has been used to improve the `Array#pack` and `String#unpack`
+methods in Rubinius.

data/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to ChunkyPNG
+
+I will gladly accept any contributions from anybody to improve this library. However, I like to keep
+the scope and complexity of this project relatively small. This way, with the limited amount of time I
+dedicate to this project, this library remains a solid piece of software that many people rely on in
+their workflow.
+
+## Scope
+
+The scope of this library is defined as:
+
+1. Reading and writing any PNG image that conforms to the spec, with proper handling of images that do not.
+2. Basic canvas drawing and compositing operations to create new or edit existing images.
+3. Remain compatible with Ruby versions that are widely used.
+
+I will close issues and pull requests that go beyond this scope. If you want to work on something,
+but are not sure if it will be in scope, feel free to reach out to me!
+
+## Reporting bugs
+
+- First, see if somebody else has reported the problem already.
+- Try to include as much relevant information as possible, so I can recreate the problem.
+- If possible, include the PNG image that is causing the issue.
+- If possible, include a code snippet that exposes the problem.
+
+## Pull requests
+
+Title and description:
+
+- If you are not yet done, please include `[WIP]` in the title of your pull request.
+- Explain why your changes are relevant in the description of your pull request.
+- If your changes improve performance, include benchmark methodology and results in the PR.
+  See BENCHMARKING.md for more information.
+
+Code:
+
+- Don't break backwards compatibility.
+- Follow code conventions. They are not defined, so look at the code around you.
+- Add Yardoc comments as documentation.
+
+Specs:
+
+- Always include specs that test your changes, to prevent me from breaking your code later.
+- If your specs use PNG files, try to keep them as small as possible to keep the test suite snappy.
+- Make sure that the specs are passing for all Rubies on [Travis CI](https://travis-ci.org/wvanbergen/chunky_png/).
+
+Misc:
+
+- Add an entry to CHANGELOG.md.
+- Do not change `ChunkyPNG::VERSION`

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2013 Willem van Bergen
+Copyright (c) 2010-2014 Willem van Bergen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/chunky_png.gemspec

@@ -13,21 +13,21 @@ Gem::Specification.new do |s|
 
   s.summary     = "Pure ruby library for read/write, chunk-level access to PNG files"
   s.description = <<-EOT
-    This pure Ruby library can read and write PNG images without depending on an external 
+    This pure Ruby library can read and write PNG images without depending on an external
     image library, like RMagick. It tries to be memory efficient and reasonably fast.
-    
-    It supports reading and writing all PNG variants that are defined in the specification, 
-    with one limitation: only 8-bit color depth is supported. It supports all transparency, 
-    interlacing and filtering options the PNG specifications allows. It can also read and 
+
+    It supports reading and writing all PNG variants that are defined in the specification,
+    with one limitation: only 8-bit color depth is supported. It supports all transparency,
+    interlacing and filtering options the PNG specifications allows. It can also read and
     write textual metadata from PNG files. Low-level read/write access to PNG chunks is
     also possible.
-    
+
     This library supports simple drawing on the image canvas and simple operations like
-    alpha composition and cropping. Finally, it can import from and export to RMagick for 
+    alpha composition and cropping. Finally, it can import from and export to RMagick for
     interoperability.
-    
-    Also, have a look at OilyPNG at http://github.com/wvanbergen/oily_png. OilyPNG is a 
-    drop in mixin module that implements some of the ChunkyPNG algorithms in C, which 
+
+    Also, have a look at OilyPNG at http://github.com/wvanbergen/oily_png. OilyPNG is a
+    drop in mixin module that implements some of the ChunkyPNG algorithms in C, which
     provides a massive speed boost to encoding and decoding.
   EOT
 
@@ -37,10 +37,10 @@ Gem::Specification.new do |s|
   s.license  = 'MIT'
 
   s.add_development_dependency('rake')
-  s.add_development_dependency('rspec', '~> 2.2')
+  s.add_development_dependency('rspec', '~> 3')
 
   s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
-  s.extra_rdoc_files = ['README.rdoc', 'BENCHMARKS.rdoc']
+  s.extra_rdoc_files = ['README.rdoc']
 
   s.files = `git ls-files`.split($/)
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

data/lib/chunky_png/canvas/operations.rb

@@ -177,7 +177,7 @@ module ChunkyPNG
 
         new_pixels = []
         for cy in 0...crop_height do
-          new_pixels += pixels.slice((cy + y) * width + x, crop_width)
+          new_pixels.concat pixels.slice((cy + y) * width + x, crop_width)
         end
         replace_canvas!(crop_width, crop_height, new_pixels)
       end

data/lib/chunky_png/color.rb

@@ -582,16 +582,16 @@ module ChunkyPNG
     # @param [Integer] color The ChunkyPNG color to convert.
     # @param [Boolean] include_alpha Flag indicates whether a fourth element
     #    representing alpha channel should be included in the returned array.
-    # @return [Array<Fixnum>[0]] The hue of the color (0-360)
-    # @return [Array<Fixnum>[1]] The saturation of the color (0-1)
-    # @return [Array<Fixnum>[2]] The value of the color (0-1)
-    # @return [Array<Fixnum>[3]] Optional fourth element for alpha, included if
+    # @return [Array[0]] The hue of the color (0-360)
+    # @return [Array[1]] The saturation of the color (0-1)
+    # @return [Array[2]] The value of the color (0-1)
+    # @return [Array[3]] Optional fourth element for alpha, included if
     #    include_alpha=true (0-255)
     # @see http://en.wikipedia.org/wiki/HSL_and_HSV
     def to_hsv(color, include_alpha = false)
       hue, chroma, max, min = hue_and_chroma(color)
       value      = max
-      saturation = chroma.zero? ? 0 : chroma.fdiv(value)
+      saturation = chroma.zero? ? 0.0 : chroma.fdiv(value)
 
       include_alpha ? [hue, saturation, value, a(color)] :
                       [hue, saturation, value]
@@ -619,7 +619,7 @@ module ChunkyPNG
     def to_hsl(color, include_alpha = false)
       hue, chroma, max, min = hue_and_chroma(color)
       lightness  = 0.5 * (max + min)
-      saturation = chroma.zero? ? 0 : chroma.fdiv(1 - (2*lightness-1).abs)
+      saturation = chroma.zero? ? 0.0 : chroma.fdiv(1 - (2 * lightness - 1).abs)
 
       include_alpha ? [hue, saturation, lightness, a(color)] :
                       [hue, saturation, lightness]
@@ -650,7 +650,7 @@ module ChunkyPNG
                                      end
       hue = 60 * hue_prime
 
-      return hue, chroma, max, min
+      return hue.round, chroma, max, min
     end
     private :hue_and_chroma
 

data/lib/chunky_png/dimension.rb

@@ -1,8 +1,8 @@
 module ChunkyPNG
-  
-  # Creates a {ChunkyPNG::Dimension} instance using arguments that can be interpreted 
+
+  # Creates a {ChunkyPNG::Dimension} instance using arguments that can be interpreted
   # as width and height.
-  # 
+  #
   # @overload Dimension(width, height)
   #   @param [Integer] width The width-component of the dimension.
   #   @param [Integer] height The height-component of the dimension.
@@ -15,7 +15,7 @@ module ChunkyPNG
   #
   # @overload Dimension(ary)
   #   @param [Array] ary An array with the desired width as first element and the
-  #      desired height as second element, e.g. <tt>[10, 20]</tt>. 
+  #      desired height as second element, e.g. <tt>[10, 20]</tt>.
   #   @return [ChunkyPNG::Dimension] The instantiated dimension.
   #
   # @overload Dimension(hash)
@@ -31,7 +31,7 @@ module ChunkyPNG
     case args.length
     when 2; ChunkyPNG::Dimension.new(*args)
     when 1; build_dimension_from_object(args.first)
-    else raise ArgumentError, 
+    else raise ArgumentError,
       "Don't know how to construct a dimension from #{args.inspect}"
     end
   end
@@ -59,7 +59,7 @@ module ChunkyPNG
     end
   end
   private_class_method :build_dimension_from_object
-  
+
   # Class that represents the dimension of something, e.g. a {ChunkyPNG::Canvas}.
   #
   # This class contains some methods to simplify performing dimension related checks.
@@ -71,23 +71,23 @@ module ChunkyPNG
 
     # @return [Integer] The width-component of this dimension.
     attr_accessor :width
-    
+
     # @return [Integer] The height-component of this dimension.
     attr_accessor :height
-    
+
     # Initializes a new dimension instance.
     # @param [Integer] width The width-component of the new dimension.
     # @param [Integer] height The height-component of the new dimension.
     def initialize(width, height)
       @width, @height = width.to_i, height.to_i
     end
-    
+
     # Returns the area of this dimension.
     # @return [Integer] The area in number of pixels.
     def area
       width * height
     end
-    
+
     # Checks whether a point is within bounds of this dimension.
     # @param [ChunkyPNG::Point, ...] A point-like to bounds-check.
     # @return [true, false] True iff the x and y coordinate fall in this dimension.
@@ -96,16 +96,17 @@ module ChunkyPNG
       point = ChunkyPNG::Point(*point_like)
       point.x >= 0 && point.x < width && point.y >= 0 && point.y < height
     end
-    
+
     # Checks whether 2 dimensions are identical.
     # @param [ChunkyPNG::Dimension] The dimension to compare with.
     # @return [true, false] <tt>true</tt> iff width and height match.
     def eql?(other)
+      return false unless other.respond_to?(:width) && other.respond_to?(:height)
       other.width == width && other.height == height
     end
-    
+
     alias_method :==, :eql?
-    
+
     # Compares the size of 2 dimensions.
     # @param [ChunkyPNG::Dimension] The dimension to compare with.
     # @return [-1, 0, 1] -1 if the other dimension has a larger area, 1 of this
@@ -113,13 +114,13 @@ module ChunkyPNG
     def <=>(other)
       other.area <=> area
     end
-    
+
     # Casts this dimension into an array.
     # @return [Array<Integer>] <tt>[width, height]</tt> for this dimension.
     def to_a
       [width, height]
     end
-    
+
     alias_method :to_ary, :to_a
   end
 end

data/lib/chunky_png/version.rb

@@ -1,5 +1,5 @@
 module ChunkyPNG
   # The current version of ChunkyPNG.
   # Set it and commit the change this before running rake release.
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/spec/chunky_png/canvas/adam7_interlacing_spec.rb

@@ -5,31 +5,31 @@ describe ChunkyPNG::Canvas::Adam7Interlacing do
 
   describe '#adam7_pass_sizes' do
     it "should get the pass sizes for a 8x8 image correctly" do
-      adam7_pass_sizes(8, 8).should == [
+      expect(adam7_pass_sizes(8, 8)).to eql [
           [1, 1], [1, 1], [2, 1], [2, 2], [4, 2], [4, 4], [8, 4]
         ]
     end
 
     it "should get the pass sizes for a 12x12 image correctly" do
-      adam7_pass_sizes(12, 12).should == [
+      expect(adam7_pass_sizes(12, 12)).to eql [
           [2, 2], [1, 2], [3, 1], [3, 3], [6, 3], [6, 6], [12, 6]
         ]
     end
 
     it "should get the pass sizes for a 33x47 image correctly" do
-      adam7_pass_sizes(33, 47).should == [
+      expect(adam7_pass_sizes(33, 47)).to eql [
           [5, 6], [4, 6], [9, 6], [8, 12], [17, 12], [16, 24], [33, 23]
         ]
     end
 
     it "should get the pass sizes for a 1x1 image correctly" do
-      adam7_pass_sizes(1, 1).should == [
+      expect(adam7_pass_sizes(1, 1)).to eql [
           [1, 1], [0, 1], [1, 0], [0, 1], [1, 0], [0, 1], [1, 0]
         ]
     end
 
     it "should get the pass sizes for a 0x0 image correctly" do
-      adam7_pass_sizes(0, 0).should == [
+      expect(adam7_pass_sizes(0, 0)).to eql [
           [0, 0], [0, 0], [0, 0], [0, 0], [0, 0], [0, 0], [0, 0]
         ]
     end
@@ -37,38 +37,38 @@ describe ChunkyPNG::Canvas::Adam7Interlacing do
     it "should always maintain the same amount of pixels in total" do
       [[8, 8], [12, 12], [33, 47], [1, 1], [0, 0]].each do |(width, height)|
         pass_sizes = adam7_pass_sizes(width, height)
-        pass_sizes.inject(0) { |sum, (w, h)| sum + (w*h) }.should == width * height
+        expect(pass_sizes.inject(0) { |sum, (w, h)| sum + (w*h) }).to eql width * height
       end
     end
   end
 
   describe '#adam7_multiplier_offset' do
     it "should get the multiplier and offset values for pass 1 correctly" do
-      adam7_multiplier_offset(0).should == [3, 0, 3, 0]
+      expect(adam7_multiplier_offset(0)).to eql [3, 0, 3, 0]
     end
-    
+
     it "should get the multiplier and offset values for pass 2 correctly" do
-      adam7_multiplier_offset(1).should == [3, 4, 3, 0]
+      expect(adam7_multiplier_offset(1)).to eql [3, 4, 3, 0]
     end
-    
+
     it "should get the multiplier and offset values for pass 3 correctly" do
-      adam7_multiplier_offset(2).should == [2, 0, 3, 4]
+      expect(adam7_multiplier_offset(2)).to eql [2, 0, 3, 4]
     end
-    
+
     it "should get the multiplier and offset values for pass 4 correctly" do
-      adam7_multiplier_offset(3).should == [2, 2, 2, 0]
+      expect(adam7_multiplier_offset(3)).to eql [2, 2, 2, 0]
     end
-    
+
     it "should get the multiplier and offset values for pass 5 correctly" do
-      adam7_multiplier_offset(4).should == [1, 0, 2, 2]
+      expect(adam7_multiplier_offset(4)).to eql [1, 0, 2, 2]
     end
 
     it "should get the multiplier and offset values for pass 6 correctly" do
-      adam7_multiplier_offset(5).should == [1, 1, 1, 0]
+      expect(adam7_multiplier_offset(5)).to eql [1, 1, 1, 0]
     end
-    
+
     it "should get the multiplier and offset values for pass 7 correctly" do
-      adam7_multiplier_offset(6).should == [0, 0, 1, 1]
+      expect(adam7_multiplier_offset(6)).to eql [0, 0, 1, 1]
     end
   end
 
@@ -83,10 +83,10 @@ describe ChunkyPNG::Canvas::Adam7Interlacing do
         ChunkyPNG::Canvas.new(4, 4, 1023344895), # r = 60
         ChunkyPNG::Canvas.new(8, 4, 1175063295), # r = 70
       ]
-      
+
       canvas = ChunkyPNG::Image.new(8,8)
       submatrices.each_with_index { |m, pass| adam7_merge_pass(pass, canvas, m) }
-      canvas.should == reference_image('adam7')
+      expect(canvas).to eql reference_image('adam7')
     end
   end
 
@@ -96,11 +96,11 @@ describe ChunkyPNG::Canvas::Adam7Interlacing do
     1.upto(7) do |pass|
       it "should extract pass #{pass} correctly" do
         sm = adam7_extract_pass(pass - 1, @canvas)
-        sm.pixels.length.should == sm.width * sm.height
-        sm.pixels.uniq.length.should == 1
-        ChunkyPNG::Color.r(sm[0,0]).should == pass * 10
+        expect(sm.pixels.length).to eql sm.width * sm.height
+        expect(sm.pixels.uniq.length).to eql 1
+        expect(ChunkyPNG::Color.r(sm[0,0])).to eql pass * 10
       end
     end
   end
 
-end
+end

data/spec/chunky_png/canvas/data_url_exporting_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 describe ChunkyPNG::Canvas do
-  
+
   describe '#to_data_url' do
     it "should export a sample canvas to an RGBA stream correctly" do
       canvas = ChunkyPNG::Canvas.new(2, 2, [ChunkyPNG::Color.rgba(1,2,3,4), ChunkyPNG::Color.rgba(5,6,7,8),
                                             ChunkyPNG::Color.rgba(4,3,2,1), ChunkyPNG::Color.rgba(8,7,6,5)])
 
-      canvas.to_data_url.should == "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACAgMAAAAP2OW3AAAADFBMVEUBAgMEAwIFBgcIBwazgAAdAAAABHRSTlMEAQgFhYDlfQAAAAxJREFUeJxjUmAKAAAAwAB1GNhIEwAAAABJRU5ErkJggg=="
+      expect(canvas.to_data_url).to eql "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACAgMAAAAP2OW3AAAADFBMVEUBAgMEAwIFBgcIBwazgAAdAAAABHRSTlMEAQgFhYDlfQAAAAxJREFUeJxjUmAKAAAAwAB1GNhIEwAAAABJRU5ErkJggg=="
     end
   end
 end

data/spec/chunky_png/canvas/data_url_importing_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
 describe ChunkyPNG::Canvas do
-  
+
   describe '.from_data_url' do
     it "should import an image from a data URL" do
       data_url = reference_canvas('operations').to_data_url
-      ChunkyPNG::Canvas.from_data_url(data_url).should == reference_canvas('operations')
+      expect(ChunkyPNG::Canvas.from_data_url(data_url)).to eql reference_canvas('operations')
     end
-    
+
     it "should raise an exception if the string is not a proper data URL" do
-      lambda { ChunkyPNG::Canvas.from_data_url('whatever') }.should raise_error(ChunkyPNG::SignatureMismatch)
+      expect { ChunkyPNG::Canvas.from_data_url('whatever') }.to raise_error(ChunkyPNG::SignatureMismatch)
     end
   end
 end