chunky_png 1.3.8 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de005461c2c1664cf8c8328e5769415e26b365fe
-  data.tar.gz: 0cf85db842b733efc160097379b39af523930694
+  metadata.gz: 2cfe87146ba99f2c0cba5133d6f6009d4277cb28
+  data.tar.gz: a9ac39bc20556d7a8c26662e0fffb9e9fcd39dc2
 SHA512:
-  metadata.gz: 68ceb6232a10ad75694c1f908b2c7a16d9bb5b0f9c5cf0f2c017b02b60e5655e99341ab44d6135975888b8855ced580054365d670494f64ea35eeee2eabc1ed6
-  data.tar.gz: 791b4ce5e7e2228b5d3ba0c41edb1f9d0b649bbe15f6ea808bca5c716fad10205f1cff408a3f79daf8389664e58124f4e53e74018ece8da38afed0cf685e3ce7
+  metadata.gz: '0408de85990b63ddd1fe099ab6f35a2abe71b23b5d2aaa903de201f9e75e488a3f0c32cc379e01459eb248537d5867df00cf70dd5fc10a853e1e9a47dd8ad035'
+  data.tar.gz: 5ad5543e38c03b1a58c9dc777be40cf744fbe2c8fe5270884eacc51dcfbe497eb00f706a6d5b547699ed50ffa002e51b5c58f1b656c6ed738596212754f20c4b

data/CHANGELOG.rdoc

@@ -7,7 +7,11 @@ The file documents the changes to this library over the different versions.
 
 === Unreleased changes
 
-- Nothing yet!
+*Noething yet*
+
+=== 1.3.9 - 2018-01-23
+
+- Add support for reading and writing an international textual data (iTXt chunks).
 
 === 1.3.8 - 2016-08-31
 

data/lib/chunky_png.rb

@@ -7,7 +7,7 @@ require 'enumerator'
 # 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.
@@ -27,27 +27,27 @@ 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,6 +123,10 @@ 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
@@ -129,7 +143,7 @@ module ChunkyPNG
   def self.force_binary(str)
     str.respond_to?(:force_encoding) ? str.force_encoding('BINARY') : str
   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
@@ -137,7 +151,7 @@ module ChunkyPNG
   EMPTY_BYTEARRAY = force_binary(String.new).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(String.new("\0")).freeze
 end

data/lib/chunky_png/chunk.rb

@@ -170,7 +170,7 @@ module ChunkyPNG
       # @param content [String] The content read from the chunk. Should be
       #   empty.
       # @return [ChunkyPNG::Chunk::End] The new End chunk instance.
-      # @raise [RuntimeError] Raises an exception if the content was not empty.
+      # @raise [ChunkyPNG::ExpectationFailed] Raises an exception if the content was not empty.
       def self.read(type, content)
         raise ExpectationFailed, 'The IEND chunk should be empty!' if content.bytesize > 0
         self.new
@@ -323,8 +323,7 @@ module ChunkyPNG
     # ratio for display of the image.
     #
     # http://www.libpng.org/pub/png/spec/1.2/PNG-Chunks.html#C.pHYs
-    #
-    class Physical < Generic
+    class Physical < Base
       attr_accessor :ppux, :ppuy, :unit
 
       def initialize(ppux, ppuy, unit = :unknown)
@@ -349,10 +348,8 @@ module ChunkyPNG
         new(ppux, ppuy, unit)
       end
 
-      # Creates the content to write to the stream, by concatenating the
-      # keyword with the deflated value, joined by a null character.
-      #
-      # @return The content that should be written to the datastream.
+      # Assembles the content to write to the stream for this chunk.
+      # @return [String] The binary content that should be written to the datastream.
       def content
         [ppux, ppuy, unit == :meters ? 1 : 0].pack('NNC')
       end
@@ -360,21 +357,62 @@ module ChunkyPNG
       INCHES_PER_METER = 0.0254
     end
 
-    # The Text (iTXt) chunk contains keyword/value metadata about the PNG
-    # stream.
+    # The InternationalText (iTXt) chunk contains keyword/value metadata about the PNG
+    # stream, translated to a given locale.
     #
     # The metadata in this chunk can be encoded using UTF-8 characters.
     # Moreover, it is possible to define the language of the metadata, and give
     # a translation of the keyword name. Finally, it supports bot compressed
     # and uncompressed values.
     #
-    # @todo This chunk is currently not implemented, but merely read and
-    #   written back intact.
+    # http://www.libpng.org/pub/png/spec/1.2/PNG-Chunks.html#C.iTXt
     #
     # @see ChunkyPNG::Chunk::Text
     # @see ChunkyPNG::Chunk::CompressedText
-    class InternationalText < Generic
-      # TODO
+    class InternationalText < Base
+      attr_accessor :keyword, :text, :language_tag, :translated_keyword, :compressed, :compression
+
+      def initialize(keyword, text, language_tag = '', translated_keyword = '', compressed = ChunkyPNG::UNCOMPRESSED_CONTENT, compression = ChunkyPNG::COMPRESSION_DEFAULT)
+        super('iTXt')
+        @keyword = keyword
+        @text = text
+        @language_tag = language_tag
+        @translated_keyword = translated_keyword
+        @compressed = compressed
+        @compression = compression
+      end
+
+      # Reads the tTXt chunk.
+      # @param type [String] The four character chunk type indicator (= "iTXt").
+      # @param content [String] The content read from the chunk.
+      # @return [ChunkyPNG::Chunk::InternationalText] The new End chunk instance.
+      # @raise [ChunkyPNG::InvalidUTF8] If the chunk contains data that is not UTF8-encoded text.
+      # @raise [ChunkyPNG::NotSupported] If the chunk refers to an unsupported compression method.
+      #  Currently uncompressed data and deflate are supported.
+      def self.read(type, content)
+        keyword, compressed, compression, language_tag, translated_keyword, text = content.unpack('Z*CCZ*Z*a*')
+        raise ChunkyPNG::NotSupported, "Compression flag #{compressed.inspect} not supported!" unless compressed == ChunkyPNG::UNCOMPRESSED_CONTENT || compressed == ChunkyPNG::COMPRESSED_CONTENT
+        raise ChunkyPNG::NotSupported, "Compression method #{compression.inspect} not supported!" unless compression == ChunkyPNG::COMPRESSION_DEFAULT
+
+        text = Zlib::Inflate.inflate(text) if compressed == ChunkyPNG::COMPRESSED_CONTENT
+
+        text.force_encoding('utf-8')
+        raise ChunkyPNG::InvalidUTF8, "Invalid unicode encountered in iTXt chunk" unless text.valid_encoding?
+
+        translated_keyword.force_encoding('utf-8')
+        raise ChunkyPNG::InvalidUTF8, "Invalid unicode encountered in iTXt chunk" unless translated_keyword.valid_encoding?
+
+        new(keyword, text, language_tag, translated_keyword, compressed, compression)
+      end
+
+      # Assembles the content to write to the stream for this chunk.
+      # @return [String] The binary content that should be written to the datastream.
+      def content
+        text_field = text.encode('utf-8')
+        text_field = (compressed == ChunkyPNG::COMPRESSED_CONTENT) ? Zlib::Deflate.deflate(text_field) : text_field
+
+        [keyword, compressed, compression, language_tag, translated_keyword.encode('utf-8'), text_field].pack('Z*CCZ*Z*a*')
+      end
     end
 
     # Maps chunk types to classes, based on the four byte chunk type indicator

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.8"
+  VERSION = "1.3.9"
 end

data/spec/chunky_png/datastream_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe ChunkyPNG::Datastream do
@@ -58,4 +59,78 @@ describe ChunkyPNG::Datastream do
       expect{physical_chunk.dpiy}.to raise_error(ChunkyPNG::UnitsUnknown)
     end
   end
+
+  describe '#iTXt_chunk' do
+    it 'should read iTXt chunks correctly' do
+      filename = resource_file('itxt_chunk.png')
+      ds = ChunkyPNG::Datastream.from_file(filename)
+      int_text_chunks = ds.chunks.select { |chunk| chunk.is_a?(ChunkyPNG::Chunk::InternationalText) }
+      expect(int_text_chunks.length).to eq(2)
+
+      coach_uk = int_text_chunks.find { |chunk| chunk.language_tag == 'en-gb' }
+      coach_us = int_text_chunks.find { |chunk| chunk.language_tag == 'en-us' }
+      expect(coach_uk).to_not be_nil
+      expect(coach_us).to_not be_nil
+
+      expect(coach_uk.keyword).to eq('coach')
+      expect(coach_uk.text).to eq('bus with of higher standard of comfort, usually chartered or used for longer journeys')
+      expect(coach_uk.translated_keyword).to eq('bus')
+      expect(coach_uk.compressed).to eq(ChunkyPNG::UNCOMPRESSED_CONTENT)
+      expect(coach_uk.compression).to eq(ChunkyPNG::COMPRESSION_DEFAULT)
+
+      expect(coach_us.keyword).to eq('coach')
+      expect(coach_us.text).to eq('US extracurricular sports teacher at a school (UK: PE teacher) lowest class on a passenger aircraft (UK: economy)')
+      expect(coach_us.translated_keyword).to eq('trainer')
+      expect(coach_us.compressed).to eq(ChunkyPNG::COMPRESSED_CONTENT)
+      expect(coach_us.compression).to eq(ChunkyPNG::COMPRESSION_DEFAULT)
+    end
+
+    it 'should write iTXt chunks correctly' do
+      expected_hex = %w(0000 001d 6954 5874 436f 6d6d 656e 7400 0000 0000 4372 6561 7465 6420 7769 7468 2047 494d 5064 2e65 07).join('')
+      stream = StringIO.new
+      itext = ChunkyPNG::Chunk::InternationalText.new('Comment', 'Created with GIMP')
+      itext.write(stream)
+      generated_hex = stream.string.unpack('H*').join('')
+
+      expect(generated_hex).to eq(expected_hex)
+    end
+
+    it 'should handle incorrect UTF-8 encoding in iTXt chunks' do
+      incorrect_text_encoding = [0, 0, 0, 14, 105, 84, 88, 116, 67, 111, 109, 109, 101, 110, 116, 0, 0, 0, 0, 0, 195, 40, 17, 87, 97, 213].pack('C*')
+      incorrect_translated_keyword_encoding = [0, 0, 0, 19, 105, 84, 88, 116, 67, 111, 109, 109, 101, 110, 116, 0, 0, 0, 0, 226, 130, 40, 0, 116, 101, 115, 116, 228, 53, 113, 182].pack('C*')
+
+      expect { ChunkyPNG::Chunk.read(StringIO.new(incorrect_text_encoding)) }.to raise_error(ChunkyPNG::InvalidUTF8)
+      expect { ChunkyPNG::Chunk.read(StringIO.new(incorrect_translated_keyword_encoding)) }.to raise_error(ChunkyPNG::InvalidUTF8)
+    end
+
+    it 'should handle UTF-8 in iTXt compressed chunks correctly' do
+      parsed = serialized_chunk(ChunkyPNG::Chunk::InternationalText.new('Comment', '✨', '', '💩', ChunkyPNG::COMPRESSED_CONTENT))
+
+      expect(parsed.text).to eq('✨')
+      expect(parsed.text.encoding).to eq(Encoding::UTF_8)
+
+      expect(parsed.translated_keyword).to eq('💩')
+      expect(parsed.translated_keyword.encoding).to eq(Encoding::UTF_8)
+    end
+
+    it 'should handle UTF-8 in iTXt chunks correctly' do
+      parsed = serialized_chunk(ChunkyPNG::Chunk::InternationalText.new('Comment', '✨', '', '💩'))
+
+      expect(parsed.text).to eq('✨')
+      expect(parsed.text.encoding).to eq(Encoding::UTF_8)
+      
+      expect(parsed.translated_keyword).to eq('💩')      
+      expect(parsed.translated_keyword.encoding).to eq(Encoding::UTF_8)
+    end
+
+    it 'should transform non UTF-8 iTXt fields to UTF-8 on write' do
+      parsed = serialized_chunk(ChunkyPNG::Chunk::InternationalText.new('Comment', '®'.encode('Windows-1252'), '', 'ƒ'.encode('Windows-1252')))
+
+      expect(parsed.text).to eq('®')
+      expect(parsed.text.encoding).to eq(Encoding::UTF_8)
+
+      expect(parsed.translated_keyword).to eq('ƒ')
+      expect(parsed.translated_keyword.encoding).to eq(Encoding::UTF_8)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -45,10 +45,20 @@ module ResourceFileHelper
   end
 end
 
+module ChunkOperationsHelper
+
+  def serialized_chunk(chunk)
+    chunk.write(stream = StringIO.new)
+    stream.rewind
+    ChunkyPNG::Chunk.read(stream)
+  end
+end
+
 RSpec.configure do |config|
   config.extend PNGSuite
   config.include PNGSuite
   config.include ResourceFileHelper
+  config.include ChunkOperationsHelper
 
   config.expect_with :rspec do |c|
     c.syntax = [:should, :expect]

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: chunky_png
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.3.9
 platform: ruby
 authors:
 - Willem van Bergen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 description: |2
@@ -65,9 +65,9 @@ extra_rdoc_files:
 - CONTRIBUTING.rdoc
 - CHANGELOG.rdoc
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - BENCHMARKING.rdoc
 - CHANGELOG.rdoc
 - CONTRIBUTING.rdoc
@@ -366,6 +366,7 @@ files:
 - spec/resources/damaged_chunk.png
 - spec/resources/damaged_signature.png
 - spec/resources/empty.png
+- spec/resources/itxt_chunk.png
 - spec/resources/lines.png
 - spec/resources/operations.png
 - spec/resources/operations_border.png
@@ -394,27 +395,27 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --title
+- "--title"
 - chunky_png
-- --main
+- "--main"
 - README.rdoc
-- --line-numbers
-- --inline-source
+- "--line-numbers"
+- "--inline-source"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Pure ruby library for read/write, chunk-level access to PNG files
@@ -682,6 +683,7 @@ test_files:
 - spec/resources/damaged_chunk.png
 - spec/resources/damaged_signature.png
 - spec/resources/empty.png
+- spec/resources/itxt_chunk.png
 - spec/resources/lines.png
 - spec/resources/operations.png
 - spec/resources/operations_border.png