prawn-pdfimage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 780170bcc691bd1849d090a2dd267484ce5d8614
+  data.tar.gz: ba40f161d698ea03de36ab598e8d2f30f74f901d
+SHA512:
+  metadata.gz: 193f130eb069f5b6678b624e28bb31f9b974a1704e3c0f29200283ce2225d10999c062712a9e9b45da5439e779f556cccf66cfb037cb54c3bfc0cb6b9d47f7e2
+  data.tar.gz: 281fbd70b1f88235a2845b7ca3f1db64afa5a8aed4a2fe262362f73df1018b67d7b7ec4831ac3bd346214ece6266c24a3265120a68500dbc86d122b748237b63

data/README.markdown

@@ -0,0 +1,49 @@
+# prawn-pdfimage
+
+Adds support for a [prawn](https://github.com/prawnpdf/prawn) to use
+a PDF that contains an image as an image.
+
+
+## Usage
+
+**Gemfile**
+```ruby
+gem 'prawn-pdfimage'
+```
+
+**Your code**
+```ruby
+require 'prawn'
+require 'prawn-pdfimage'
+
+Prawn::Document.generate('output.pdf') do |pdf|
+  pdf.image 'image.pdf'
+end
+```
+
+
+## Limitations
+The current code will add the first xobject on the first page as the image to
+the Prawn document. For the common case (someone exporting an image as a PDF)
+this works just fine. If you need more control over which object is inserted
+into your Prawn document, PRs are welcome.
+
+
+## Found a bug?
+Open a [github issue](https://github.com/packetmonkey/prawn-pdfimage/issues)
+
+
+## Contributing & Development
+1. Fork the project.
+2. Make your feature addition or bug fix. All specs should pass.
+3. Add specs for your changes.
+4. Commit
+5. Send a pull request. Bonus points for topic branches.
+
+
+## Licence
+prawn-pdfimage is released under the [MIT Licence](http://choosealicense.com/licenses/mit/)
+
+
+## Authors
+prawn-pdfimage is written and maintained by Evan Sharp.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/prawn-pdfimage.rb

@@ -0,0 +1,122 @@
+require 'prawn'
+require 'pdf-reader'
+
+# Implements support for pulling an image out of an existing PDF and adds
+# that image to a prawn document.
+#
+# In this file, the pdf_* prefix refers to the PDF that contains the image
+# we are adding to our document, prawn_* refers to the objects we are creating
+# to be added to our prawn document.
+class PrawnPDFImage < Prawn::Images::Image
+  def self.can_render?(image_blob)
+    image_blob.unpack('C5') == [37, 80, 68, 70, 45]
+  end
+
+  def initialize(image_blob)
+    self.image_blob = image_blob
+    self.reader = ::PDF::Reader.new StringIO.new(image_blob)
+  end
+
+  def build_pdf_object(document)
+    self.document = document
+
+    prawn_image_reference
+  end
+
+  private
+
+  attr_accessor :image_blob, :reader, :document
+
+  def prawn_image_reference
+    document.ref!(prawn_image_reference_options).tap do |ref|
+      ref << pdf_image_data
+      ref.stream.filters << { pdf_image_filter => nil }
+      ref.data[:SMask] = prawn_soft_mask if pdf_soft_mask
+    end
+  end
+
+  def prawn_image_reference_options
+    {
+      Type:             :XObject,
+      Subtype:          :Image,
+      ColorSpace:       pdf_image_colorspace,
+      Height:           pdf_image_height,
+      Width:            pdf_image_width,
+      BitsPerComponent: pdf_image_bits_per_component
+    }
+  end
+
+  def prawn_soft_mask
+    document.ref!(prawn_soft_mask_options).tap do |ref|
+      ref.stream << pdf_soft_mask.unfiltered_data
+      ref.stream.filters << { FlateDecode: nil }
+    end
+  end
+
+  def prawn_soft_mask_options
+    {
+      Type:             :XObject,
+      Subtype:          :Image,
+      Width:            pdf_image_width,
+      Height:           pdf_image_height,
+      BitsPerComponent: pdf_image_bits_per_component,
+      ColorSpace:       :DeviceGray
+    }
+  end
+
+  def pdf_soft_mask
+    pdf_image_stream.hash[:SMask]
+  end
+
+  def pdf_image_filter
+    pdf_image_stream.hash[:Filter]
+  end
+
+  # In my tests all the PDF color spaces where contained in an ICCBased
+  # PDF reference to a dictionary with an Alternate key.
+  #
+  # If images are not displaying correctly this is the first place to start
+  # looking.
+  def pdf_image_colorspace
+    cs = pdf_image_stream.hash[:ColorSpace]
+
+    if cs.is_a? Symbol
+      cs
+    else
+      return cs[1].hash[:Alternate]
+    end
+  end
+
+  def pdf_image_data
+    pdf_image_stream.unfiltered_data
+  end
+
+  def pdf_image_bits_per_component
+    pdf_image_stream.hash[:BitsPerComponent]
+  end
+
+  def pdf_image_height
+    pdf_image_stream.hash[:Height]
+  end
+
+  def pdf_image_width
+    pdf_image_stream.hash[:Width]
+  end
+
+  def pdf_image_stream
+    page.xobjects.first[1]
+  end
+
+  def page
+    reader.page 1
+  end
+
+  # These methods are to conform to the API expected by Prawn Images and
+  # are not used internally.
+  attr_accessor :scaled_width, :scaled_height
+
+  alias_method :width, :pdf_image_width
+  alias_method :height, :pdf_image_height
+end
+
+Prawn.image_handler.register PrawnPDFImage

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: prawn-pdfimage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- Rakefile
+- lib/prawn-pdfimage.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Add PDF 'images' as images in prawn documents
+test_files: []
+has_rdoc: