pallete_png 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d085a91c6dff3c308277348b3e7378f4304589
-  data.tar.gz: 3ad138ed12a50b9b1b84f9f7aaefe8acb7d0eb64
+  metadata.gz: 1552cbc483b31d1edef2bfdd39e3b65f3e17afc6
+  data.tar.gz: d65dd59f5707d167d9cd30bf6faabc96724f8bb0
 SHA512:
-  metadata.gz: 3be4632c1339a4c0f5aee41a891c0882f3459c55e705a8d789de826743262aa3af0508682bb0f7334ef5720f1e2be1551a2220b5134f42fd7a9ceebe404dbec7
-  data.tar.gz: f9fb6b87f051ca04be25969d4feb21395af86cc0487482c398b6975d8507a2c9672377377c43f1b59294db5b7098a820454789ccf5f2f9aa523cc60e419bfd9f
+  metadata.gz: 1a79e56cb61c0095e2efa38b39f570ea84f107b69e642f988be608f815c0394668798d25ec8effa92857cfdc99b1c2cd8c9f15550006f109dd0752ac3443f4e9
+  data.tar.gz: fc5c46c576d8d3b04061f144622191c045909aeba825d300a0e860f48a8b529571ce71083e369b38cb3ec2e27e86753e91e12d6ecb8dafc0aac7bf31c4177f35

data/.gitignore

@@ -1,2 +1,3 @@
 /.bundle/
-/Gemfile.lock
+Gemfile.lock
+*.pdf

data/README.md

@@ -1,8 +1,9 @@
 # PalletePNG
 
+[![Gem Version](https://badge.fury.io/rb/pallete_png.svg)](https://badge.fury.io/rb/pallete_png)
 [![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.
+PalletePNG is a pure-ruby library that make it possible to render the transparent of a pallete-based PNG in PDF by converting the color-mode of the image.
 
 ## Installation
 
@@ -25,18 +26,35 @@ Or install it yourself as:
 ```ruby
 require 'pallete_png'
 
-image_data = File.binread('/path/to/pallete-based-w-transparency.png')
+image = File.binread('/path/to/pallete-based-w-transparency.png')
+converted_image = PalletePNG.to_transparency(image)
+```
+
+### Exception
+
+```ruby
+require 'pallete_png'
+
+not_a_png_image = File.binread('/path/to/not_a_png.jpg')
 
-PalletePNG.to_transparency(image_data) # => The converted image data
+begin
+  converted_image = PalletePNG.to_transparency(not_a_png_image)
+rescue PalletePNG::Image::NotPNG
+  puts 'The image is not a PNG.'
+end
 ```
 
+### Use with Prawn
+
+See [Example::Using in Prawn](https://github.com/hidakatsuya/pallete_png/tree/master/example).
+
 ## Supported versions
 
 Ruby 2.2, 2.3
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/transparency_png.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/pallete_png.
 
 ## License
 

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+gem 'prawn'

data/example/README.md

@@ -0,0 +1,28 @@
+# Example::Using in Prawn
+
+Currently, [Prawn](https://github.com/prawnpdf/prawn) does not support a pallete-based PNG with transparency.
+
+```ruby
+Prawn::Document.generate 'result.pdf' do
+  image 'images/pallete-based-w-transparency.png'
+  # =>
+  #   Pallete-based transparency in PNG is not currently supported.
+  #   (Prawn::Errors::UnsupportedImageType)
+end
+```
+
+But, you can draw the image using [PalletePNG](https://rubygems.org/gems/pallete_png) like below.
+
+```ruby
+require 'pallete_png'
+
+Prawn::Document.generate 'result.pdf' do |doc|
+  image_data = File.binread 'images/pallete-based-w-transparency.png'
+  doc.image StringIO.new(PalletePNG.to_transparency(image_data))
+end
+```
+
+## How to run
+
+    $ bundle install
+    $ bundle exec ruby prawn_image.rb

data/example/prawn_image.rb

@@ -0,0 +1,14 @@
+require 'prawn'
+require 'pallete_png'
+
+Prawn::Document.generate 'result.pdf' do |pdf|
+  image_data = File.read 'images/pallete-based-w-transparency.png'
+
+  # If you draw the original image, you will get the following Prawn's error:
+  # pdf.image 'images/pallete-based-w-transparency.png'
+  #
+  #   Pallete-based transparency in PNG is not currently supported.
+  #   (Prawn::Errors::UnsupportedImageType)
+
+  pdf.image StringIO.new(PalletePNG.to_transparency(image_data))
+end

data/lib/pallete_png/version.rb

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

data/pallete_png.gemspec

@@ -8,8 +8,11 @@ Gem::Specification.new do |spec|
   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.summary       = 'Make it possible to render the transparent of a pallete-based PNG in PDF'
+  spec.description   = <<-DESC
+    PalletePNG is a pure-ruby library that make it possible to render
+    the transparent of a pallete-based PNG in PDF by converting the color-mode of the image.
+  DESC
   spec.homepage      = 'https://github.com/hidakatsuya/pallete_png'
   spec.license       = 'MIT'
   spec.platform      = Gem::Platform::RUBY
@@ -24,5 +27,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1.0.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rr'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pallete_png
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Katsuya HIDAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -66,21 +66,9 @@ dependencies:
     - - ">="
       - !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.
+description: |2
+      PalletePNG is a pure-ruby library that make it possible to render
+      the transparent of a pallete-based PNG in PDF by converting the color-mode of the image.
 email:
 - hidakatsuya@gmail.com
 executables: []
@@ -93,6 +81,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- example/Gemfile
+- example/README.md
+- example/images/pallete-based-w-transparency.png
+- example/prawn_image.rb
 - lib/pallete_png.rb
 - lib/pallete_png/image.rb
 - lib/pallete_png/version.rb
@@ -127,6 +119,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Makes a pallete-based PNG transparency
+summary: Make it possible to render the transparent of a pallete-based PNG in PDF
 test_files: []
 has_rdoc: