chunky_png 1.3.5 → 1.3.15

data/lib/chunky_png/vector.rb

@@ -1,9 +1,10 @@
-module ChunkyPNG
+# frozen-string-literal: true
 
+module ChunkyPNG
   # Factory method for {ChunkyPNG::Vector} instances.
   #
   # @overload Vector(x0, y0, x1, y1, x2, y2, ...)
-  #   Creates a vector by parsing two subsequent values in the argument list 
+  #   Creates a vector by parsing two subsequent values in the argument list
   #   as x- and y-coordinate of a point.
   #   @return [ChunkyPNG::Vector] The instantiated vector.
   # @overload Vector(string)
@@ -17,27 +18,25 @@ module ChunkyPNG
   # @raise [ArgumentError] If the given arguments could not be understood as a vector.
   # @see ChunkyPNG::Vector
   def self.Vector(*args)
-    
-    return args.first if args.length == 1 && args.first.kind_of?(ChunkyPNG::Vector)
-    
+    return args.first if args.length == 1 && args.first.is_a?(ChunkyPNG::Vector)
+
     if args.length == 1 && args.first.respond_to?(:scan)
       ChunkyPNG::Vector.new(ChunkyPNG::Vector.multiple_from_string(args.first)) # e.g. ['1,1 2,2 3,3']
     else
       ChunkyPNG::Vector.new(ChunkyPNG::Vector.multiple_from_array(args)) # e.g. [[1,1], [2,2], [3,3]] or [1,1,2,2,3,3]
     end
   end
-  
+
   # Class that represents a vector of points, i.e. a list of {ChunkyPNG::Point} instances.
   #
-  # Vectors can be created quite flexibly. See the {ChunkyPNG.Vector} factory methods for 
+  # Vectors can be created quite flexibly. See the {ChunkyPNG.Vector} factory methods for
   # more information on how to construct vectors.
   class Vector
-    
     include Enumerable
-    
+
     # @return [Array<ChunkyPNG::Point>] The array that holds all the points in this vector.
     attr_reader :points
-    
+
     # Initializes a vector based on a list of Point instances.
     #
     # You usually do not want to use this method directly, but call {ChunkyPNG.Vector} instead.
@@ -47,7 +46,7 @@ module ChunkyPNG
     def initialize(points = [])
       @points = points
     end
-    
+
     # Iterates over all the edges in this vector.
     #
     # An edge is a combination of two subsequent points in the vector. Together, they will form
@@ -63,14 +62,14 @@ module ChunkyPNG
       points.each_cons(2) { |a, b| yield(a, b) }
       yield(points.last, points.first) if close
     end
-    
+
     # Returns the point with the given indexof this vector.
     # @param [Integer] index The 0-based index of the point in this vector.
-    # @param [ChunkyPNG::Point] The point instance.
+    # @return [ChunkyPNG::Point] The point instance.
     def [](index)
       points[index]
     end
-    
+
     # Returns an enumerator that will iterate over all the edges in this vector.
     # @param (see #each_edge)
     # @return [Enumerator] The enumerator that iterates over the edges.
@@ -79,28 +78,28 @@ module ChunkyPNG
     def edges(close = true)
       to_enum(:each_edge, close)
     end
-    
+
     # Returns the number of points in this vector.
     # @return [Integer] The length of the points array.
     def length
       points.length
     end
-    
+
     # Iterates over all the points in this vector
     # @yield [ChunkyPNG::Point] The points in the correct order.
     # @return [void]
     def each(&block)
       points.each(&block)
     end
-    
+
     # Comparison between two vectors for quality.
     # @param [ChunkyPNG::Vector] other The vector to compare with.
     # @return [true, false] true if the list of points are identical
     def eql?(other)
       other.points == points
     end
-    
-    alias_method :==, :eql?
+
+    alias == eql?
 
     # Returns the range in x-coordinates for all the points in this vector.
     # @return [Range] The (inclusive) range of x-coordinates.
@@ -113,13 +112,13 @@ module ChunkyPNG
     def y_range
       Range.new(*points.map { |p| p.y }.minmax)
     end
-    
+
     # Finds the lowest x-coordinate in this vector.
     # @return [Integer] The lowest x-coordinate of all the points in the vector.
     def min_x
       x_range.first
     end
-    
+
     # Finds the highest x-coordinate in this vector.
     # @return [Integer] The highest x-coordinate of all the points in the vector.
     def max_x
@@ -131,13 +130,13 @@ module ChunkyPNG
     def min_y
       y_range.first
     end
-    
+
     # Finds the highest y-coordinate in this vector.
     # @return [Integer] The highest y-coordinate of all the points in the vector.
     def max_y
       y_range.last
     end
-    
+
     # Returns the offset from (0,0) of the minimal bounding box of all the
     # points in this vector
     # @return [ChunkyPNG::Point] A point that describes the top left corner if a
@@ -145,7 +144,7 @@ module ChunkyPNG
     def offset
       ChunkyPNG::Point.new(min_x, min_y)
     end
-    
+
     # Returns the width of the minimal bounding box of all the points in this vector.
     # @return [Integer] The x-distance between the points that are farthest from each other.
     def width
@@ -157,17 +156,17 @@ module ChunkyPNG
     def height
       1 + (max_y - min_y)
     end
-    
+
     # Returns the dimension of the minimal bounding rectangle of the points in this vector.
-    # @return [ChunkyPNG::Dimension] The dimension instance with the width and height 
+    # @return [ChunkyPNG::Dimension] The dimension instance with the width and height
     def dimension
       ChunkyPNG::Dimension.new(width, height)
     end
-    
+
     # @return [Array<ChunkyPNG::Point>] The list of points interpreted from the input array.
     def self.multiple_from_array(source)
       return [] if source.empty?
-      if source.first.kind_of?(Numeric) || source.first =~ /^\d+$/
+      if source.first.is_a?(Numeric) || source.first =~ /^\d+$/
         raise ArgumentError, "The points array is expected to have an even number of items!" if source.length % 2 != 0
 
         points = []
@@ -177,7 +176,7 @@ module ChunkyPNG
         source.map { |p| ChunkyPNG::Point(p) }
       end
     end
-    
+
     # @return [Array<ChunkyPNG::Point>] The list of points parsed from the string.
     def self.multiple_from_string(source_str)
       multiple_from_array(source_str.scan(/[\(\[\{]?(\d+)\s*[,x]?\s*(\d+)[\)\]\}]?/))

data/lib/chunky_png/version.rb

@@ -1,5 +1,7 @@
+# frozen-string-literal: true
+
 module ChunkyPNG
   # The current version of ChunkyPNG.
   # Set it and commit the change this before running rake release.
-  VERSION = "1.3.5"
+  VERSION = "1.3.15"
 end

data/lib/chunky_png.rb

@@ -1,13 +1,14 @@
+# frozen-string-literal: true
+
 # Basic requirements from standard library
-require 'set'
-require 'zlib'
-require 'stringio'
-require 'enumerator'
+require "set"
+require "zlib"
+require "stringio"
 
 # ChunkyPNG - the pure ruby library to access PNG files.
 #
 # The ChunkyPNG module defines some constants that are used in the
-# PNG specification, specifies some exception classes, and serves as 
+# PNG specification, specifies some exception classes, and serves as
 # a namespace for all the other modules and classes in this library.
 #
 # {ChunkyPNG::Image}::      class to represent PNG images, including metadata.
@@ -22,32 +23,31 @@ require 'enumerator'
 #
 # @author Willem van Bergen
 module ChunkyPNG
-
   ###################################################
   # PNG international standard defined constants
   ###################################################
 
-  # Indicates that the PNG image uses grayscale colors, i.e. only a 
+  # Indicates that the PNG image uses grayscale colors, i.e. only a
   # single teint channel.
   # @private
   COLOR_GRAYSCALE       = 0
-  
+
   # Indicates that the PNG image uses true color, composed of a red
   # green and blue channel.
   # @private
   COLOR_TRUECOLOR       = 2
-  
+
   # Indicates that the PNG image uses indexed colors, where the values
   # point to colors defined on a palette.
   # @private
   COLOR_INDEXED         = 3
-  
+
   # Indicates that the PNG image uses grayscale colors with opacity, i.e.
   # a teint channel with an alpha channel.
   # @private
   COLOR_GRAYSCALE_ALPHA = 4
-  
-  # Indicates that the PNG image uses true color with opacity, composed of 
+
+  # Indicates that the PNG image uses true color with opacity, composed of
   # a red, green and blue channel, and an alpha value.
   # @private
   COLOR_TRUECOLOR_ALPHA = 6
@@ -57,12 +57,22 @@ module ChunkyPNG
   # @private
   COMPRESSION_DEFAULT   = 0
 
+  # Indicates that the PNG chunk content is not compressed
+  # flag used in iTXt chunk
+  # @private
+  UNCOMPRESSED_CONTENT  = 0
+
+  # Indicates that the PNG chunk content is compressed
+  # flag used in iTXt chunk
+  # @private
+  COMPRESSED_CONTENT    = 1
+
   # Indicates that the image does not use interlacing.
   # @private
   INTERLACING_NONE      = 0
-  
+
   # Indicates that the image uses Adam7 interlacing.
-  # @private  
+  # @private
   INTERLACING_ADAM7     = 1
 
   ### Filter method constants
@@ -75,19 +85,19 @@ module ChunkyPNG
   # Indicates that no filtering is used for the scanline.
   # @private
   FILTER_NONE           = 0
-  
+
   # Indicates that SUB filtering is used for the scanline.
   # @private
   FILTER_SUB            = 1
-  
+
   # Indicates that UP filtering is used for the scanline.
   # @private
   FILTER_UP             = 2
-  
+
   # Indicates that AVERAGE filtering is used for the scanline.
   # @private
   FILTER_AVERAGE        = 3
-  
+
   # Indicates that PAETH filtering is used for the scanline.
   # @private
   FILTER_PAETH          = 4
@@ -104,7 +114,7 @@ module ChunkyPNG
   class NotSupported < ChunkyPNG::Exception
   end
 
-  # Exception that is raised if the PNG signature is not encountered at the 
+  # Exception that is raised if the PNG signature is not encountered at the
   # beginning of the file.
   class SignatureMismatch < ChunkyPNG::Exception
   end
@@ -113,48 +123,44 @@ module ChunkyPNG
   class CRCMismatch < ChunkyPNG::Exception
   end
 
+  # Exception that is raised if an tTXt chunk does not contain valid UTF-8 data.
+  class InvalidUTF8 < ChunkyPNG::Exception
+  end
+
   # Exception that is raised if an expectation fails.
   class ExpectationFailed < ChunkyPNG::Exception
   end
 
-  # Exception that is raised if an expectation fails.
+  # Exception that when provided coordinates are out of bounds for the canvas
   class OutOfBounds < ChunkyPNG::ExpectationFailed
   end
 
-  def self.force_binary(str)
-    str.respond_to?(:force_encoding) ? str.force_encoding('BINARY') : str
+  # Exception that is raised when requesting the DPI of a PNG that doesn't
+  # specify the units of its physical pixel dimensions.
+  class UnitsUnknown < ChunkyPNG::Exception
   end
-  
-  # Empty byte array. This basically is an empty string, but with the encoding
-  # set correctly to ASCII-8BIT (binary) in Ruby 1.9.
-  # @return [String] An empty string, with encoding set to binary in Ruby 1.9
-  # @private
-  EMPTY_BYTEARRAY = force_binary("").freeze
 
   # Null-byte, with the encoding set correctly to ASCII-8BIT (binary) in Ruby 1.9.
-  # @return [String] A binary string, consisting of one NULL-byte. 
+  # @return [String] A binary string, consisting of one NULL-byte.
   # @private
-  EXTRA_BYTE = force_binary("\0").freeze
+  EXTRA_BYTE = "\0".b
 end
 
-require 'chunky_png/version'
-
-# Ruby 1.8 / 1.9 compatibility
-require 'chunky_png/compatibility'
+require "chunky_png/version"
 
 # PNG file structure
-require 'chunky_png/datastream'
-require 'chunky_png/chunk'
+require "chunky_png/datastream"
+require "chunky_png/chunk"
 
 # Colors
-require 'chunky_png/palette'
-require 'chunky_png/color'
+require "chunky_png/palette"
+require "chunky_png/color"
 
 # Geometry
-require 'chunky_png/point'
-require 'chunky_png/vector'
-require 'chunky_png/dimension'
+require "chunky_png/point"
+require "chunky_png/vector"
+require "chunky_png/dimension"
 
 # Canvas / Image classes
-require 'chunky_png/canvas'
-require 'chunky_png/image'
+require "chunky_png/canvas"
+require "chunky_png/image"

data/spec/chunky_png/canvas/adam7_interlacing_spec.rb

@@ -1,48 +1,48 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ChunkyPNG::Canvas::Adam7Interlacing do
   include ChunkyPNG::Canvas::Adam7Interlacing
 
-  describe '#adam7_pass_sizes' do
+  describe "#adam7_pass_sizes" do
     it "should get the pass sizes for a 8x8 image correctly" do
       expect(adam7_pass_sizes(8, 8)).to eql [
-          [1, 1], [1, 1], [2, 1], [2, 2], [4, 2], [4, 4], [8, 4]
-        ]
+        [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
       expect(adam7_pass_sizes(12, 12)).to eql [
-          [2, 2], [1, 2], [3, 1], [3, 3], [6, 3], [6, 6], [12, 6]
-        ]
+        [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
       expect(adam7_pass_sizes(33, 47)).to eql [
-          [5, 6], [4, 6], [9, 6], [8, 12], [17, 12], [16, 24], [33, 23]
-        ]
+        [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
       expect(adam7_pass_sizes(1, 1)).to eql [
-          [1, 1], [0, 1], [1, 0], [0, 1], [1, 0], [0, 1], [1, 0]
-        ]
+        [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
       expect(adam7_pass_sizes(0, 0)).to eql [
-          [0, 0], [0, 0], [0, 0], [0, 0], [0, 0], [0, 0], [0, 0]
-        ]
+        [0, 0], [0, 0], [0, 0], [0, 0], [0, 0], [0, 0], [0, 0],
+      ]
     end
 
     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)
-        expect(pass_sizes.inject(0) { |sum, (w, h)| sum + (w*h) }).to eql 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
+  describe "#adam7_multiplier_offset" do
     it "should get the multiplier and offset values for pass 1 correctly" do
       expect(adam7_multiplier_offset(0)).to eql [3, 0, 3, 0]
     end
@@ -72,7 +72,7 @@ describe ChunkyPNG::Canvas::Adam7Interlacing do
     end
   end
 
-  describe '#adam7_merge_pass' do
+  describe "#adam7_merge_pass" do
     it "should merge the submatrices correctly" do
       submatrices = [
         ChunkyPNG::Canvas.new(1, 1,  168430335), # r = 10
@@ -84,23 +84,22 @@ describe ChunkyPNG::Canvas::Adam7Interlacing do
         ChunkyPNG::Canvas.new(8, 4, 1175063295), # r = 70
       ]
 
-      canvas = ChunkyPNG::Image.new(8,8)
+      canvas = ChunkyPNG::Image.new(8, 8)
       submatrices.each_with_index { |m, pass| adam7_merge_pass(pass, canvas, m) }
-      expect(canvas).to eql reference_image('adam7')
+      expect(canvas).to eql reference_image("adam7")
     end
   end
 
-  describe '#adam7_extract_pass' do
-    before(:each) { @canvas = reference_canvas('adam7') }
+  describe "#adam7_extract_pass" do
+    before(:each) { @canvas = reference_canvas("adam7") }
 
     1.upto(7) do |pass|
       it "should extract pass #{pass} correctly" do
         sm = adam7_extract_pass(pass - 1, @canvas)
         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
+        expect(ChunkyPNG::Color.r(sm[0, 0])).to eql pass * 10
       end
     end
   end
-
 end

data/spec/chunky_png/canvas/data_url_exporting_spec.rb

@@ -1,11 +1,14 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ChunkyPNG::Canvas do
-
-  describe '#to_data_url' 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 = 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),
+      ])
 
       expect(canvas.to_data_url).to eql "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACAgMAAAAP2OW3AAAADFBMVEUBAgMEAwIFBgcIBwazgAAdAAAABHRSTlMEAQgFhYDlfQAAAAxJREFUeJxjUmAKAAAAwAB1GNhIEwAAAABJRU5ErkJggg=="
     end

data/spec/chunky_png/canvas/data_url_importing_spec.rb

@@ -1,15 +1,14 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ChunkyPNG::Canvas do
-
-  describe '.from_data_url' do
+  describe ".from_data_url" do
     it "should import an image from a data URL" do
-      data_url = reference_canvas('operations').to_data_url
-      expect(ChunkyPNG::Canvas.from_data_url(data_url)).to eql reference_canvas('operations')
+      data_url = reference_canvas("operations").to_data_url
+      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
-      expect { ChunkyPNG::Canvas.from_data_url('whatever') }.to raise_error(ChunkyPNG::SignatureMismatch)
+      expect { ChunkyPNG::Canvas.from_data_url("whatever") }.to raise_error(ChunkyPNG::SignatureMismatch)
     end
   end
 end