pallete_png 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77d085a91c6dff3c308277348b3e7378f4304589
+  data.tar.gz: 3ad138ed12a50b9b1b84f9f7aaefe8acb7d0eb64
+SHA512:
+  metadata.gz: 3be4632c1339a4c0f5aee41a891c0882f3459c55e705a8d789de826743262aa3af0508682bb0f7334ef5720f1e2be1551a2220b5134f42fd7a9ceebe404dbec7
+  data.tar.gz: f9fb6b87f051ca04be25969d4feb21395af86cc0487482c398b6975d8507a2c9672377377c43f1b59294db5b7098a820454789ccf5f2f9aa523cc60e419bfd9f

data/.gitignore

@@ -0,0 +1,2 @@
+/.bundle/
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.2.4
+  - 2.3.0
+
+script: bundle exec rake test
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Katsuya HIDAKA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# PalletePNG
+
+[![Build Status](https://travis-ci.org/hidakatsuya/pallete_png.svg?branch=master)](https://travis-ci.org/hidakatsuya/pallete_png)
+
+PalletePNG is a pure-ruby library that makes a pallete-based PNG transparency.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pallete_png'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pallete_png
+
+## Usage
+
+```ruby
+require 'pallete_png'
+
+image_data = File.binread('/path/to/pallete-based-w-transparency.png')
+
+PalletePNG.to_transparency(image_data) # => The converted image data
+```
+
+## Supported versions
+
+Ruby 2.2, 2.3
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/transparency_png.
+
+## License
+
+© 2016 Katsuya HIDAKA. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/pallete_png/image.rb

@@ -0,0 +1,35 @@
+require 'chunky_png'
+
+module PalletePNG
+  class Image
+    NotPNG = Class.new StandardError
+
+    # @return [ChunkyPNG::Image]
+    attr_reader :image
+
+    # @param [String] image_data The PNG image data
+    # @raise [ChunkyPNG::SignatureMismatch] if image_data is not a PNG image
+    def initialize(image_data)
+      @image = ChunkyPNG::Image.from_blob(image_data)
+    end
+
+    # @return [String] The new image data that the color_mode is converted to TRUE COLOR alpha
+    def to_truecolor_alpha
+      image.to_blob color_mode: ChunkyPNG::COLOR_TRUECOLOR_ALPHA
+    end
+
+    def pallete_based?
+      color_mode, _depth = image.palette.best_color_settings
+      color_mode == ChunkyPNG::COLOR_INDEXED
+    end
+
+    def transparency_chunk?
+      !datastream.transparency_chunk.nil?
+    end
+
+    # @return [ChunkyPNG::Datastream]
+    def datastream
+      @datastream ||= image.to_datastream
+    end
+  end
+end

data/lib/pallete_png/version.rb

@@ -0,0 +1,3 @@
+module PalletePNG
+  VERSION = '1.0.0'
+end

data/lib/pallete_png.rb

@@ -0,0 +1,22 @@
+require 'pallete_png/version'
+require 'pallete_png/image'
+
+module PalletePNG
+  # @param [String] image_data The PNG image data
+  # @return [String] The PNG image data
+  # @raise [PalletePNG::Image::NotPNG] if image_data is not a PNG image
+  # @example
+  #   image_data = PalletePNG.to_transparency File.binread('pallete-based-w-transparency.png')
+  def self.to_transparency(image_data)
+    begin
+      image = Image.new image_data
+    rescue ChunkyPNG::SignatureMismatch
+      raise Image::NotPNG
+    end
+
+    # Returns the raw image data if image is not a pallete-based PNG with transparency
+    return image_data unless image.pallete_based? && image.transparency_chunk?
+
+    image.to_truecolor_alpha
+  end
+end

data/pallete_png.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'pallete_png/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pallete_png'
+  spec.version       = PalletePNG::VERSION
+  spec.authors       = ['Katsuya HIDAKA']
+  spec.email         = ['hidakatsuya@gmail.com']
+
+  spec.summary       = 'Makes a pallete-based PNG transparency'
+  spec.description   = 'PalletePNG is a pure-ruby library that makes a pallete-based PNG transparency.'
+  spec.homepage      = 'https://github.com/hidakatsuya/pallete_png'
+  spec.license       = 'MIT'
+  spec.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'chunky_png', '~> 1.3.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.0.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rr'
+end

data/test/pallete_png/image_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+module PalletePNG
+  class ImageTest < Minitest::Test
+    include TestHelpers
+
+    def test_init
+      assert_raises ChunkyPNG::SignatureMismatch do
+        Image.new image_data('not-a-png.jpg')
+      end
+
+      begin
+        Image.new image_data('pallete-png-with-transparency.png')
+      rescue ChunkyPNG::SignatureMismatch
+        refute
+      end
+    end
+
+    def test_pallete_based?
+      image = Image.new image_data('pallete-png-with-transparency.png')
+      assert image.pallete_based?
+
+      image = Image.new image_data('not-a-pallete-png.png')
+      refute image.pallete_based?
+    end
+
+    def test_transparency_chunk?
+      image = Image.new image_data('pallete-png-with-transparency.png')
+      assert image.transparency_chunk?
+
+      image = Image.new image_data('pallete-png-without-transparency.png')
+      refute image.transparency_chunk?
+    end
+
+    def test_to_truecolor_alpha
+      image = Image.new image_data('pallete-png-with-transparency.png')
+
+      datastream = ChunkyPNG::Datastream.from_blob image.to_truecolor_alpha
+      assert_equal ChunkyPNG::COLOR_TRUECOLOR_ALPHA, datastream.header_chunk.color
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pallete_png'
+require 'minitest/autorun'
+
+module PalletePNG
+  module TestHelpers
+    def image_data(filename)
+      image_path = File.join File.expand_path('../files', __FILE__), filename
+      File.binread(image_path)
+    end
+  end
+end

data/test/to_transparency_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+module PalletePNG
+  class ToTransparencyTest < Minitest::Test
+    include TestHelpers
+
+    def test_not_a_png
+      assert_raises Image::NotPNG do
+        PalletePNG.to_transparency image_data('not-a-png.jpg')
+      end
+    end
+
+    def test_not_a_pallete_png
+      raw_blob = image_data('not-a-pallete-png.png')
+      assert_equal raw_blob, PalletePNG.to_transparency(raw_blob)
+    end
+
+    def test_pallete_png_without_transparency
+      raw_blob = image_data('pallete-png-without-transparency.png')
+      assert_equal raw_blob, PalletePNG.to_transparency(raw_blob)
+    end
+
+    def test_pallete_png_with_transparency
+      raw_blob = image_data('pallete-png-with-transparency.png')
+      result_blob = PalletePNG.to_transparency(raw_blob)
+
+      refute_equal result_blob, raw_blob
+
+      result_datastream = ChunkyPNG::Datastream.from_blob(result_blob)
+      assert_equal ChunkyPNG::COLOR_TRUECOLOR_ALPHA, result_datastream.header_chunk.color
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: pallete_png
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katsuya HIDAKA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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: minitest
+  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: rr
+  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'
+description: PalletePNG is a pure-ruby library that makes a pallete-based PNG transparency.
+email:
+- hidakatsuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/pallete_png.rb
+- lib/pallete_png/image.rb
+- lib/pallete_png/version.rb
+- pallete_png.gemspec
+- test/files/not-a-pallete-png.png
+- test/files/not-a-png.jpg
+- test/files/pallete-png-with-transparency.png
+- test/files/pallete-png-without-transparency.png
+- test/pallete_png/image_test.rb
+- test/test_helper.rb
+- test/to_transparency_test.rb
+homepage: https://github.com/hidakatsuya/pallete_png
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Makes a pallete-based PNG transparency
+test_files: []
+has_rdoc: