millisami-pdf-stamper 0.0.0

data/lib/pdf/stamper.rb

@@ -0,0 +1,104 @@
+# = pdf/stamper.rb -- PDF template stamping.
+#
+#  Copyright (c) 2007 Jason Yates
+
+require 'fileutils'
+require 'java'
+require 'tmpdir'
+
+include FileUtils
+
+include_class 'java.io.FileOutputStream'
+include_class 'java.io.ByteArrayOutputStream'
+include_class 'com.lowagie.text.pdf.AcroFields'
+include_class 'com.lowagie.text.pdf.PdfReader'
+include_class 'com.lowagie.text.pdf.PdfStamper'
+include_class 'com.lowagie.text.Image'
+include_class 'com.lowagie.text.Rectangle'
+
+# PDF::Stamper provides an interface into iText's PdfStamper allowing for
+# the editing of existing PDF's as templates.  Unlike the available PDF 
+# generators, PDF::Stamper, via RJB and iText, allows you to edit
+# existing PDF's and use them as templates.
+#
+# == Creation of templates
+#
+# Templates currently can only be created using Adobe LiveCycle
+# Designer which comes with the lastest versions of Adobe Acrobat
+# Professional.  Using LiveCycle Designer you can create a form and
+# add textfield's for text and button's for images.
+#
+module PDF
+  # PDF::Stamper
+  #
+  # == Example
+  #
+  # pdf = PDF::Stamper.new("my_template.pdf")
+  # pdf.text :first_name, "Jason"
+  # pdf.text :last_name, "Yates"
+  # pdf.image :photo, "photo.jpg"
+  # pdf.save_as "my_output"
+  class Stamper
+    
+    def initialize(pdf = nil)
+      template(pdf) if ! pdf.nil?
+    end
+    
+    def template(template)
+      # NOTE I'd rather use a ByteArrayOutputStream.  However I
+      # couldn't get it working.  Patches welcome.
+      #@tmp_path = File.join(Dir::tmpdir, 'pdf-stamper-' + rand(10000).to_s + '.pdf')
+      reader = PdfReader.new(template)
+      @baos = ByteArrayOutputStream.new
+      @stamp = PdfStamper.new(reader, @baos)#FileOutputStream.new(@tmp_path))
+      @form = @stamp.getAcroFields()
+    end
+
+    # Set a textfield defined by key and text to value.
+    def text(key, value)
+      @form.setField(key.to_s, value.to_s) # Value must be a string or itext will error.
+    end
+
+    # Set a button field defined by key and replaces with an image.
+    def image(key, image_path)
+      # Idea from here http://itext.ugent.be/library/question.php?id=31 
+      # Thanks Bruno for letting me know about it.
+      img = Image.getInstance(image_path)
+      img_field = @form.getFieldPositions(key.to_s)
+ 
+      rect = Rectangle.new(img_field[1], img_field[2], img_field[3], img_field[4])
+      img.scaleToFit(rect.width, rect.height)
+      img.setAbsolutePosition(
+        img_field[1] + (rect.width - img.scaledWidth) / 2,
+        img_field[2] + (rect.height - img.scaledHeight) /2
+      )
+
+      cb = @stamp.getOverContent(img_field[0].to_i)
+      cb.addImage(img)
+    end
+
+    # Takes the PDF output and sends as a string.  Basically it's sole
+    # purpose is to be used with send_data in rails.
+    def to_s
+      fill
+      String.from_java_bytes(@baos.toByteArray)
+      #File.open(@tmp_path).read
+    end
+
+    # Saves the PDF into a file defined by path given.
+    def save_as(file)
+      f = File.new(file, "w")
+      f.syswrite to_s
+      #fill
+      #mv(@tmp_path, file) # NOTE what if someone tries to duplicate the file by saving twice?
+      #@tmp_path = file # Just in case you decide to do "to_s" also.
+    end
+
+    private
+
+    def fill
+      @stamp.setFormFlattening(true)
+      @stamp.close
+    end
+  end
+end

data/lib/pdf/stamper/rjb.rb

@@ -0,0 +1,108 @@
+# = pdf/stamper.rb -- PDF template stamping.
+#
+#  Copyright (c) 2007 Jason Yates
+
+require 'fileutils'
+require 'rubygems'
+require 'rjb'
+require 'tmpdir'
+
+include FileUtils
+
+Rjb::load(File.join(File.dirname(__FILE__), '..', '..', '..', 'ext', 'itext-2.0.6.jar'))
+
+# PDF::Stamper provides an interface into iText's PdfStamper allowing for
+# the editing of existing PDF's as templates.  Unlike the available PDF 
+# generators, PDF::Stamper, via RJB and iText, allows you to edit
+# existing PDF's and use them as templates.
+#
+# == Creation of templates
+#
+# Templates currently can only be created using Adobe LiveCycle
+# Designer which comes with the lastest versions of Adobe Acrobat
+# Professional.  Using LiveCycle Designer you can create a form and
+# add textfield's for text and button's for images.
+#
+# == Caveats
+#
+# RJB needs the LD_LIBRARY_PATH and JAVA_HOME environment set for it
+# to work correctly.  For example on my system:
+#
+# export LD_LIBRARY_PATH=/usr/java/jdk1.6.0/jre/lib/i386/:/usr/java/jdk1.6.0/jre/lib/i386/client/:./
+# export JAVA_HOME=/usr/java/jdk1.6.0/
+#
+# Check the RJB documentation if you are having issues with this.
+module PDF
+  # PDF::Stamper
+  #
+  # == Example
+  #
+  # pdf = PDF::Stamper.new("my_template.pdf")
+  # pdf.text :first_name, "Jason"
+  # pdf.text :last_name, "Yates"
+  # pdf.image :photo, "photo.jpg"
+  # pdf.save_as "my_output"
+  class Stamper    
+    def initialize(pdf = nil, options = {})
+      @bytearray    = Rjb::import('java.io.ByteArrayOutputStream')
+      @filestream   = Rjb::import('java.io.FileOutputStream')
+      @acrofields   = Rjb::import('com.lowagie.text.pdf.AcroFields')
+      @pdfreader    = Rjb::import('com.lowagie.text.pdf.PdfReader')
+      @pdfstamper   = Rjb::import('com.lowagie.text.pdf.PdfStamper')
+
+      template(pdf) if ! pdf.nil?
+    end
+    
+    def template(template)
+      reader = @pdfreader.new(template)
+      @baos = @bytearray.new
+      @stamp = @pdfstamper.new(reader, @baos)
+      @form = @stamp.getAcroFields()
+    end
+
+    # Set a textfield defined by key and text to value.
+    def text(key, value)
+      @form.setField(key.to_s, value.to_s) # Value must be a string or itext will error.
+    end
+
+    # Set a button field defined by key and replaces with an image.
+    def image(key, image_path)
+      # Idea from here http://itext.ugent.be/library/question.php?id=31 
+      # Thanks Bruno for letting me know about it.
+      image = Rjb::import('com.lowagie.text.Image')
+      img = image.getInstance(image_path)
+      img_field = @form.getFieldPositions(key.to_s)
+
+      rectangle = Rjb::import('com.lowagie.text.Rectangle')
+      rect = rectangle.new(img_field[1], img_field[2], img_field[3], img_field[4])
+      img.scaleToFit(rect.width, rect.height)
+      img.setAbsolutePosition(
+        img_field[1] + (rect.width - img.scaledWidth) / 2,
+        img_field[2] + (rect.height - img.scaledHeight) /2
+      )
+
+      cb = @stamp.getOverContent(img_field[0].to_i)
+      cb.addImage(img)
+    end
+
+    # Takes the PDF output and sends as a string.  Basically it's sole
+    # purpose is to be used with send_data in rails.
+    def to_s
+      fill
+      @baos.toByteArray
+    end
+
+    # Saves the PDF into a file defined by path given.
+    def save_as(file)
+      f = File.new(file, "w")
+      f.syswrite to_s
+    end
+
+    private
+
+    def fill
+      @stamp.setFormFlattening(true)
+      @stamp.close
+    end
+  end
+end

data/spec/pdf_stamper_spec.rb

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'pdf/stamper'
+
+describe PDF::Stamper do
+  before(:each) do
+    @pdf = PDF::Stamper.new(File.join(File.dirname(__FILE__), "test_template.pdf"))
+    @pdf.text :text_field01, "test"
+    @pdf.text :text_field02, "test2"
+    @pdf.image :button_field01, File.join(File.dirname(__FILE__), "logo.gif")
+  end
+
+  it "should create PDF document" do
+    @pdf.to_s.should_not be_nil
+  end
+
+  it "should save PDF document" do
+    @pdf.save_as "test_output.pdf"
+    File.exist?("test_output.pdf").should be_true
+    #File.delete("test_output.pdf") # Comment this out to view the output
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: millisami-pdf-stamper
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Millisami
+- Jason Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rjb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+description: PDF::Stamper provides an interface into iText's PdfStamper allowing for the editing of existing PDF's as templates.
+email: millisami@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pdf/stamper/rjb.rb
+- lib/pdf/stamper.rb
+- spec/pdf_stamper_spec.rb
+has_rdoc: true
+homepage: http://github.com/millisami/pdf-stamper
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: PDF::Stamper provides an interface into iText's PdfStamper allowing for the editing of existing PDF's as templates.
+test_files: 
+- spec/pdf_stamper_spec.rb