chunky_png 1.3.11 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b1a5a676ccb350678ea927646fdebcf089e851d
-  data.tar.gz: cf36f18b367bfd58ce1b7210cdd4f67226509e4f
+SHA256:
+  metadata.gz: 83fc1d331bcc0afc882b5ff2df1c0601e42f6551cfaff2b7c7ae9d0b4386b122
+  data.tar.gz: 1f80013e9aeb9daa25ed0a968b5d82877483113ebd22442226e0e8ee269a3105
 SHA512:
-  metadata.gz: f20401d384c2b2f3c641c32d51eb437ccee200cd557e2837576ae246b1ebee36ac2b488c47e35e9527953bc9288f6fec7e3b76c3a41af51b6e8832b947b2cc9d
-  data.tar.gz: b0ef89444d5b87dcaeb18354009a598a45c60bc3650363d363c507b82f919a9da4a498f4e82c28d5290c7f36b569278f77e79f43db24059f1b7ed8f8c94d8a7a
+  metadata.gz: 1fcb07937d255014cba405bc018c9889b5fd7cd652e25f0768b21ef58a48f604033551f3fa822329387a3dcecb46263906c1043ecb5a7e0007fba22f90dbeb5f
+  data.tar.gz: dd57be8a9ce7db0333dad21f03f9ea056feaed4a785f3e0d21b7a1efb3123bacf6fb58f73cbde9d46f2aa2032b39dd5e06e25a4e48aeb9d5dad993ad99f886e9

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', 'ruby-head' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bin/rake
+    # Skip the linter for now.
+    # - name: Lint Ruby code
+    #   run: bin/standardrb

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/.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,11 @@ 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
 
@@ -42,7 +46,7 @@ The file documents the changes to this library over the different versions.
 === 1.3.4 - 2015-02-16
 
 - Assert compatibility with Ruby 2.2
-- Improved documentation using RDoc, so it is included on http://www.rubydoc.info/gems/chunky_png
+- Improved documentation using RDoc, so it is included on https://www.rubydoc.info/gems/chunky_png
 - Update chunkypng.com website; migrate some stuff from the wiki.
 
 === 1.3.3 - 2014-10-24
@@ -150,7 +154,7 @@ There are some API changes for this release. If you are using <tt>Canvas#compose
 - Added a list of HTML named colors. Get them by calling <tt>ChunkyPNG::Color(:teal)</tt> or <tt>ChunkyPNG::Color('red @ 0.8')</tt>
 - Added encoding support for 1-, 2-, and 4-bit grayscale images.
 - Cleaned up auto-detection of color mode settings. It will now choose 1 bit grayscale mode if an image only contains black and white. (The other low bitrate grayscale modes are never chosen automatically.)
-- RDoc improvements. See http://rdoc.info/gems/chunky_png/frames.
+- RDoc improvements. See https://rdoc.info/gems/chunky_png.
 - ChunkyPNG is now also tested on Ruby 1.8.6.
 
 === 0.12.0 - 2010-12-12
@@ -210,7 +214,7 @@ There are some API changes for this release. If you are using <tt>Canvas#compose
 
 === 0.7.3 - 2010-04-28
 
-- Based on the suggestion of [Dirkjan Bussink](http://github.com/dbussink), introduced custom exception classes:
+- Based on the suggestion of [Dirkjan Bussink](https://github.com/dbussink), introduced custom exception classes:
   - <tt>ChunkyPNG::SignatureMismatch</tt> is raised when the PNG signature could not be found. Usually this means the the file is not a PNG image.
   - <tt>ChunkyPNG::CRCMismatch</tt> is raised when the a CRC check for a chunk in the PNG file fails.
   - <tt>ChunkyPNG::NotSupported</tt> is raised when the PNG image uses a feature that ChunkyPNG does not support.

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,18 @@
-source 'https://rubygems.org'
+# frozen-string-literal: true
+
+source "https://rubygems.org"
 gemspec
 
 platforms :jruby do
-  gem 'jruby-openssl'
+  gem "jruby-openssl"
 end
 
-platform :rbx do
-  gem 'rubysl'
+group :jekyll do
+  gem "jekyll", "~> 3.3"
+  gem "kramdown-parser-gfm"
 end
+
+group :jekyll_plugins do
+  gem "jekyll-commonmark"
+  gem "jekyll-theme-cayman"
+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

@@ -1,13 +1,13 @@
-# ChunkyPNG [![Build Status](https://travis-ci.org/wvanbergen/chunky_png.svg?branch=master)](https://travis-ci.org/wvanbergen/chunky_png)
+# ChunkyPNG
 
 This library can read and write PNG files. It is written in pure Ruby for
 maximum portability. Let me rephrase: it does NOT require RMagick or any other
 memory leaking image library.
 
-- [Source code](http://github.com/wvanbergen/chunky_png/tree)
-- [RDoc](http://rdoc.info/gems/chunky_png/frames)
-- [Wiki](http://github.com/wvanbergen/chunky_png/wiki)
-- [Issue tracker](http://github.com/wvanbergen/chunky_png/issues)
+- [Source code](https://github.com/wvanbergen/chunky_png/tree/master)
+- [RDoc](https://rdoc.info/gems/chunky_png)
+- [Wiki](https://github.com/wvanbergen/chunky_png/wiki)
+- [Issue tracker](https://github.com/wvanbergen/chunky_png/issues)
 
 ## Features
 
@@ -23,9 +23,10 @@ memory leaking image library.
   depending on the hardware)
 - Reasonably fast for Ruby standards, by only using integer math and a highly
   optimized saving routine.
+- Works on every currently supported Ruby version (2.5+)
 - Interoperability with RMagick if you really have to.
 
-Also, have a look at [OilyPNG](http://github.com/wvanbergen/oily_png) which
+Also, have a look at [OilyPNG](https://github.com/wvanbergen/oily_png) which
 is a mixin module that implements some of the ChunkyPNG algorithms in C, which
 provides a massive speed boost to encoding and decoding.
 
@@ -59,11 +60,11 @@ png_stream.each_chunk { |chunk| p chunk.type }
 
 Also check out the screencast on the ChunkyPNG homepage by John Davison,
 which illustrates basic usage of the library on the [ChunkyPNG
-website](http://chunkypng.com/).
+website](https://chunkypng.com/).
 
 For more information, see the [project
 wiki](https://github.com/wvanbergen/chunky_png/wiki) or the [RDOC
-documentation](http://www.rubydoc.info/gems/chunky_png/frames).
+documentation](https://www.rubydoc.info/gems/chunky_png).
 
 ## Security warning
 
@@ -80,7 +81,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,13 @@
+# frozen-string-literal: true
+
 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")