chunky_png 1.3.9 → 1.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2cfe87146ba99f2c0cba5133d6f6009d4277cb28
-  data.tar.gz: a9ac39bc20556d7a8c26662e0fffb9e9fcd39dc2
+SHA256:
+  metadata.gz: e3886829e15fc95fe5233136b1f7ecd373b6996aa7d272ea23a7118b2f686da9
+  data.tar.gz: f43c2996448bce3e0dd614b19e228ead043be3f1fbc60ca128d7a242f4f74692
 SHA512:
-  metadata.gz: '0408de85990b63ddd1fe099ab6f35a2abe71b23b5d2aaa903de201f9e75e488a3f0c32cc379e01459eb248537d5867df00cf70dd5fc10a853e1e9a47dd8ad035'
-  data.tar.gz: 5ad5543e38c03b1a58c9dc777be40cf744fbe2c8fe5270884eacc51dcfbe497eb00f706a6d5b547699ed50ffa002e51b5c58f1b656c6ed738596212754f20c4b
+  metadata.gz: 610eacb3d1e369c824bd4b7e9305358790be1837281be84f44ff12e4020bced6fd9ef44b10391578eb74b50a0e28b24595ac0aa64b82433477a05b43a37bd491
+  data.tar.gz: e4857a8bb6217e5416b93bcd125dd7e99a90f0bb2714628016d6e44af9b34a03230913e30955a4f72ff2005fb9b9e6f50d1087d6cb89d9370cc735288d98193b

data/.standard.yml

@@ -0,0 +1,16 @@
+# ChunkyPNG uses and enforces standard.rb as code style (see https://github.com/testdouble/standard).
+# For backwards compatilibity and idiosyncratic preferences of the main author,
+# there are some minor differences listed in here.
+
+ruby_version: 2.2
+
+ignore:
+- lib/chunky_png/**/*.rb:
+  # We allow `for` loops in the codebase, especially in hot paths,
+  # because they perform better than `each` blocks.
+  - "Style/For"
+
+- spec/chunky_png/**/*.rb:
+  # In RSpec, having to follow this rule will cause expectations to
+  # be less readable, specifically blocks for the `change` matcher.
+  - "Lint/AmbiguousBlockAssociation"

data/.travis.yml

@@ -1,16 +1,18 @@
 language: ruby
-script: bundle exec rake
-sudo: false
+
+script:
+- bin/rake
+- bin/standardrb
 
 rvm:
-- "2.0"
-- "2.1"
 - "2.2"
+- "2.3"
+- "2.4"
+- "2.5"
+- "2.6"
 - ruby-head
-- rbx-19mode
 - jruby-19mode
 
 matrix:
   allow_failures:
-  - rvm: rbx-19mode
   - rvm: ruby-head

data/.yardopts

@@ -1,5 +1,5 @@
 --title "ChunkyPNG - The pure Ruby PNG library"
 lib/**/*.rb -
-BENCHMARKS.rdoc
+BENCHMARKING.rdoc
 --no-private
 --hide-void-return

data/CHANGELOG.rdoc

@@ -7,7 +7,15 @@ The file documents the changes to this library over the different versions.
 
 === Unreleased changes
 
-*Noething yet*
+- Implemented <tt>ChunkyPNG::Dimension#hash</tt> to fix some specs after a behavior change in RSpec.
+
+=== 1.3.11 - 2018-11-21
+
+- Updated project metadata as published on Rubygems.org
+
+=== 1.3.10 - 2018-01-23
+
+- Fixed a regression in Datastream#metadata, which was not able to deal with iTXt chunks.
 
 === 1.3.9 - 2018-01-23
 

data/CONTRIBUTING.rdoc

@@ -1,21 +1,30 @@
 = 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.
+I will gladly accept any contributions from anybody to improve this library. However, this is a
+personal open source project, without an active community around it. As a result I am the only
+maintainer, and I’d like to keep the scope and complexity of this project 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.
 
 
 == Project 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.
+1. Reading and writing any PNG image that conforms to the spec, with proper error handling of
+  images that do not conform to the spec.
 2. Basic canvas drawing and compositing operations to create new or edit existing images.
+  However, I will generally be hesitant to add new drawing and compositing methods, because
+  the list could be endless to support every niche use case.
 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!
+I generally consider this gem to be feature complete based on this scope. 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 accepted, feel free to reach out to me by opening an issue before committing your time.
+
+For functionality that goes beyond the scope, I would suggest making it available as a separate
+“plugin” gem (e.g. chunky_png-<my-feature>). If anything in the gem needs to be refactored
+to support this kind of extensibility, I am happy to accept PRs for that.
 
 
 == Reporting bugs
@@ -38,7 +47,7 @@ Title and description:
 Code:
 
 - Don't break backwards compatibility.
-- Follow code conventions. They are not defined, so look at the code around you.
+- Follow code conventions. They are enforced through Rubocop.
 - Add Yardoc comments as documentation.
 
 Specs:

data/Gemfile

@@ -1,10 +1,10 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
 platforms :jruby do
-  gem 'jruby-openssl'
+  gem "jruby-openssl"
 end
 
 platform :rbx do
-  gem 'rubysl'
+  gem "rubysl"
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Willem van Bergen
+Copyright (c) 2010-2019 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/README.md

@@ -80,7 +80,12 @@ background processing library.
 
 The library is written by Willem van Bergen for Floorplanner.com, and released
 under the MIT license (see LICENSE). Please contact me for questions or
-remarks. Patches are greatly appreciated!
+remarks. 
+
+I generally consider this library to be feature complete. I will gladly accept 
+patches to fix bugs and improve performance, but I will generally be hesitant 
+to accept new features or API endpoints. Before contributing, please read 
+[CONTRIBUTING.rdoc](CONTRIBUTING.rdoc) that explains this in more detail.
 
 Please check out CHANGELOG.rdoc to see what changed in all versions.
 

data/Rakefile

@@ -1,11 +1,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-Dir['tasks/*.rake'].each { |file| load(file) }
+Dir["tasks/*.rake"].each { |file| load(file) }
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = "./spec/**/*_spec.rb"
-  task.rspec_opts = ['--color']
+  task.rspec_opts = ["--color"]
 end
 
-task :default => [:spec]
+task default: [:spec]

data/benchmarks/decoding_benchmark.rb

@@ -1,26 +1,26 @@
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-require 'benchmark'
-require 'chunky_png'
+require "benchmark"
+require "chunky_png"
 
 def image_file(name)
-  File.join(File.dirname(__FILE__), '..', 'spec', 'resources', name)
+  File.join(File.dirname(__FILE__), "..", "spec", "resources", name)
 end
 
 def image_data(name)
   data = nil
-  File.open(image_file(name), 'rb') { |f| data = f.read }
+  File.open(image_file(name), "rb") { |f| data = f.read }
   data
 end
 
-no_filtering_stream    = image_data('pixelstream_fast_rgba.png')
-up_filtering_stream    = image_data('pixelstream_reference.png')
-paeth_filtering_stream = image_data('pixelstream_best_compression.png')
-rgba_pixelstream       = image_data('pixelstream.rgba')
-rgb_pixelstream        = image_data('pixelstream.rgb')
+no_filtering_stream    = image_data("pixelstream_fast_rgba.png")
+up_filtering_stream    = image_data("pixelstream_reference.png")
+paeth_filtering_stream = image_data("pixelstream_best_compression.png")
+rgba_pixelstream       = image_data("pixelstream.rgba")
+rgb_pixelstream        = image_data("pixelstream.rgb")
 
-n = (ENV['N'] || '5').to_i
+n = (ENV["N"] || "5").to_i
 
 puts "---------------------------------------------"
 puts "ChunkyPNG (#{ChunkyPNG::VERSION}) decoding benchmark (n=#{n})"
@@ -28,9 +28,9 @@ puts "---------------------------------------------"
 puts
 
 Benchmark.bmbm do |x|
-  x.report('PNG - no filtering')    { n.times { ChunkyPNG::Image.from_blob(no_filtering_stream) } }
-  x.report('PNG - UP filtering')    { n.times { ChunkyPNG::Image.from_blob(up_filtering_stream) } }
-  x.report('PNG - PAETH filtering') { n.times { ChunkyPNG::Image.from_blob(paeth_filtering_stream) } }
-  x.report('From RGBA pixelstream') { n.times { ChunkyPNG::Image.from_rgba_stream(240, 180, rgba_pixelstream) } }
-  x.report('From RGB pixelstream')  { n.times { ChunkyPNG::Image.from_rgb_stream(240, 180, rgb_pixelstream) } }
+  x.report("PNG - no filtering")    { n.times { ChunkyPNG::Image.from_blob(no_filtering_stream) } }
+  x.report("PNG - UP filtering")    { n.times { ChunkyPNG::Image.from_blob(up_filtering_stream) } }
+  x.report("PNG - PAETH filtering") { n.times { ChunkyPNG::Image.from_blob(paeth_filtering_stream) } }
+  x.report("From RGBA pixelstream") { n.times { ChunkyPNG::Image.from_rgba_stream(240, 180, rgba_pixelstream) } }
+  x.report("From RGB pixelstream")  { n.times { ChunkyPNG::Image.from_rgb_stream(240, 180, rgb_pixelstream) } }
 end

data/benchmarks/encoding_benchmark.rb

@@ -1,17 +1,20 @@
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-require 'benchmark'
-require 'chunky_png'
+require "benchmark"
+require "chunky_png"
 
 image = ChunkyPNG::Image.new(240, 180, ChunkyPNG::Color::TRANSPARENT)
 
 # set some random pixels
+
+# rubocop:disable Layout/ExtraSpacing, Layout/SpaceInsideParens
 image[10, 20] = ChunkyPNG::Color.rgba(255,   0,   0, 255)
 image[50, 87] = ChunkyPNG::Color.rgba(  0, 255,   0, 255)
 image[33, 99] = ChunkyPNG::Color.rgba(  0,   0, 255, 255)
+# rubocop:enable Layout/ExtraSpacing, Layout/SpaceInsideParens
 
-n = (ENV['N'] || '5').to_i
+n = (ENV["N"] || "5").to_i
 
 puts "---------------------------------------------"
 puts "ChunkyPNG (#{ChunkyPNG::VERSION}) encoding benchmark (n=#{n})"
@@ -19,22 +22,22 @@ puts "---------------------------------------------"
 puts
 
 Benchmark.bmbm do |x|
-  x.report('Autodetect (indexed)')  { n.times { image.to_blob } }
+  x.report("Autodetect (indexed)") { n.times { image.to_blob } }
 
   # Presets
-  x.report(':no_compression')    { n.times { image.to_blob(:no_compression) } }
-  x.report(':fast_rgba')         { n.times { image.to_blob(:fast_rgba) } }
-  x.report(':fast_rgb')          { n.times { image.to_blob(:fast_rgb) } }
-  x.report(':good_compression')  { n.times { image.to_blob(:good_compression) } }
-  x.report(':best_compression')  { n.times { image.to_blob(:best_compression) } }
-  
+  x.report(":no_compression")    { n.times { image.to_blob(:no_compression) } }
+  x.report(":fast_rgba")         { n.times { image.to_blob(:fast_rgba) } }
+  x.report(":fast_rgb")          { n.times { image.to_blob(:fast_rgb) } }
+  x.report(":good_compression")  { n.times { image.to_blob(:good_compression) } }
+  x.report(":best_compression")  { n.times { image.to_blob(:best_compression) } }
+
   # Some options
-  x.report(':rgb')        { n.times { image.to_blob(:color_mode => ChunkyPNG::COLOR_TRUECOLOR) } }
-  x.report(':rgba')       { n.times { image.to_blob(:color_mode => ChunkyPNG::COLOR_TRUECOLOR_ALPHA) } }
-  x.report(':indexed')    { n.times { image.to_blob(:color_mode => ChunkyPNG::COLOR_INDEXED) } }
-  x.report(':interlaced') { n.times { image.to_blob(:interlaced => true) } }
-  
+  x.report(":rgb")        { n.times { image.to_blob(color_mode: ChunkyPNG::COLOR_TRUECOLOR) } }
+  x.report(":rgba")       { n.times { image.to_blob(color_mode: ChunkyPNG::COLOR_TRUECOLOR_ALPHA) } }
+  x.report(":indexed")    { n.times { image.to_blob(color_mode: ChunkyPNG::COLOR_INDEXED) } }
+  x.report(":interlaced") { n.times { image.to_blob(interlaced: true) } }
+
   # Exports
-  x.report('to RGBA pixelstream') { n.times { image.to_rgba_stream } }
-  x.report('to RGB pixelstream')  { n.times { image.to_rgb_stream } }
+  x.report("to RGBA pixelstream") { n.times { image.to_rgba_stream } }
+  x.report("to RGB pixelstream")  { n.times { image.to_rgb_stream } }
 end

data/benchmarks/filesize_benchmark.rb

@@ -1,10 +1,10 @@
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-require 'benchmark'
-require 'chunky_png'
+require "benchmark"
+require "chunky_png"
 
-files = ['pixelstream_reference.png', 'operations.png', 'clock.png']
+files = ["pixelstream_reference.png", "operations.png", "clock.png"]
 
 def encode_png(image, constraints = {})
   filesize = nil
@@ -13,7 +13,7 @@ def encode_png(image, constraints = {})
 end
 
 files.each do |file|
-  filename = File.join(File.dirname(__FILE__), '..', 'spec', 'resources', file)
+  filename = File.join(File.dirname(__FILE__), "..", "spec", "resources", file)
   image = ChunkyPNG::Canvas.from_file(filename)
 
   puts "#{file}: #{image.width}x#{image.height} - #{image.palette.size} colors"

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/standardrb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/chunky_png.gemspec

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'chunky_png/version'
+require "chunky_png/version"
 
 Gem::Specification.new do |s|
-  s.name    = 'chunky_png'
+  s.name    = "chunky_png"
 
   # Do not change the version and date fields by hand. This will be done
   # automatically by the gem release script.
@@ -31,16 +29,22 @@ Gem::Specification.new do |s|
     provides a massive speed boost to encoding and decoding.
   EOT
 
-  s.authors  = ['Willem van Bergen']
-  s.email    = ['willem@railsdoctors.com']
-  s.homepage = 'http://wiki.github.com/wvanbergen/chunky_png'
-  s.license  = 'MIT'
-
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec', '~> 3')
-
-  s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
-  s.extra_rdoc_files = ['README.md', 'BENCHMARKING.rdoc', 'CONTRIBUTING.rdoc', 'CHANGELOG.rdoc']
+  s.authors  = ["Willem van Bergen"]
+  s.email    = ["willem@railsdoctors.com"]
+  s.homepage = "https://github.com/wvanbergen/chunky_png/wiki"
+  s.license  = "MIT"
+  s.metadata = {
+    "source_code_uri" => "https://github.com/wvanbergen/chunky_png",
+    "wiki_uri" => "https://github.com/wvanbergen/chunky_png/wiki",
+  }
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("standard")
+  s.add_development_dependency("yard", "~> 0.9")
+  s.add_development_dependency("rspec", "~> 3")
+
+  s.rdoc_options << "--title" << s.name << "--main" << "README.rdoc" << "--line-numbers" << "--inline-source"
+  s.extra_rdoc_files = ["README.md", "BENCHMARKING.rdoc", "CONTRIBUTING.rdoc", "CHANGELOG.rdoc"]
 
   s.files = `git ls-files`.split($/)
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

data/lib/chunky_png.rb

@@ -1,8 +1,7 @@
 # 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.
 #
@@ -22,7 +21,6 @@ require 'enumerator'
 #
 # @author Willem van Bergen
 module ChunkyPNG
-
   ###################################################
   # PNG international standard defined constants
   ###################################################
@@ -131,7 +129,7 @@ module ChunkyPNG
   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
 
@@ -140,40 +138,33 @@ module ChunkyPNG
   class UnitsUnknown < ChunkyPNG::Exception
   end
 
-  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
   # @private
-  EMPTY_BYTEARRAY = force_binary(String.new).freeze
+  EMPTY_BYTEARRAY = "".force_encoding(Encoding::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.
   # @private
-  EXTRA_BYTE = force_binary(String.new("\0")).freeze
+  EXTRA_BYTE = "\0".force_encoding(Encoding::BINARY).freeze
 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"