Merge pull request #8 from technicool/master

Version 0.6.0 - Adding PDF-417 barcodes & JRuby support

Author: technicool

.gitignore

@@ -1 +1,7 @@
-.DS_Store
+.DS_Store
+
+.idea
+
+spec/coverage
+
+spec/test_output.pdf

History.txt

@@ -1,3 +1,9 @@
+== 0.6.0 2013-10-28
+* Adding PDF 417 Barcodes
+* Cleaning up some other changes since last official release of 0.3.3.
+* Checkboxes now work in JRuby (from https://github.com/paulschreiber/pdf-stamper/commit/e5098c670aa4b2b387c66411fa7b3f63c6511224)
+
+
 == 0.3.3 2010-09-24
 * iText downgraded to 4.2.0 due to license incompatibility
 

Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 ext/iText-4.2.0.jar
 lib/pdf/stamper.rb

README.md

@@ -6,6 +6,16 @@
 
 Fill out PDF forms (templates) using iText's PdfStamper.
 
+Features include:
+
+* Text fields
+* Checkboxes
+* Circles, ellipses, rectangles
+* PDF-417 Barcodes
+
+You have to use JRuby or RJB. You need Adobe LiveCycle Designer
+or Acrobat Professional to create the templates.
+
 ## Example
     pdf = PDF::Stamper.new("my_template.pdf")
 
@@ -17,7 +27,10 @@ Fill out PDF forms (templates) using iText's PdfStamper.
     pdf.ellipse(140, 380, 50, 13)
     pdf.rectangle(140, 380, 50, 13)
     pdf.circle(140, 380)
-  
+    
+    # PDF-417 barcodes
+    pdf.barcode("PDF417", "2d_barcode", "Barcode data...", AspectRatio: 0.5)
+    
     pdf.save_as "my_output.pdf"
 
 Here is how you use it in Rails.
@@ -36,20 +49,20 @@ Here is how you use it in Rails.
 
 ## Code
 
-
   git clone http://github.com/jaywhy/pdf-stamper/
 
 ## Contributors
 
 Paul Schreiber
 Joe Steele
 Ronny Hanssen
+Marshall Anschutz
 
 ## License
 
 (The MIT License)
 
-Copyright (c) 2007-2012 Jason Yates
+Copyright (c) 2007-2013 Jason Yates
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

lib/pdf/stamper.rb

@@ -4,30 +4,22 @@
 
 require 'rbconfig'
 require 'fileutils'
-require 'tmpdir'
+#require 'tmpdir'
+#require 'active_support/inflector/methods'
 
 include FileUtils
 
 if RUBY_PLATFORM =~ /java/ # ifdef to check if your using JRuby
-  $:.unshift(File.join(File.dirname(__FILE__), '..', '..', '..', 'ext'))
-  require 'java'
-  require 'iText-4.2.0.jar'
-  
-  java_import 'java.io.FileOutputStream'
-  java_import 'java.io.ByteArrayOutputStream'
-  java_import 'com.lowagie.text.pdf.AcroFields'
-  java_import 'com.lowagie.text.pdf.PdfReader'
-  java_import 'com.lowagie.text.pdf.PdfStamper'
-  java_import 'com.lowagie.text.Image'
-  java_import 'com.lowagie.text.Rectangle'
-  java_import 'com.lowagie.text.pdf.GrayColor'
+  require 'pdf/stamper/jruby'
 else
   require 'pdf/stamper/rjb'
 end
 
 module PDF
   class Stamper
-    VERSION = "0.5"
+    VERSION = "0.6.0"
+    
+    
     # PDF::Stamper provides an interface into iText's PdfStamper allowing for the
     # editing of existing PDFs as templates. PDF::Stamper is not a PDF generator,
     # it allows you to edit existing PDFs and use them as templates.
@@ -77,6 +69,32 @@ def image(key, image_path)
       cb.addImage(img)
     end
 
+    # PDF::Stamper allows setting metadata on the created PDF by passing
+    # the parameters to the set_more_info function. Our implementation here
+    # is slightly different from iText, in that we only receive a single key/value
+    # pair at a time, instead of a Map<string,string> since that is slightly
+    # more complex to bridge properly from ruby to java.
+    # 
+    # Possible keys include "Creator". All values here are strings.
+    # 
+    def set_metadata(key, value)
+      params = java.util.HashMap.new()
+      params.put(key.to_s, value)
+      @stamp.setMoreInfo(params)
+    end
+    
+    # If you want to have iText reset some of the metadata, this function will
+    # cause iText to use its default xml metadata.
+    def reset_xmp_metadata()
+      @stamp.setXmpMetadata("".to_java_bytes)
+    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
+
+    
     # Takes the PDF output and sends as a string.
     #
     # Here is how to use it in rails:
@@ -92,15 +110,11 @@ def to_s
       String.from_java_bytes(@baos.toByteArray)
     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 checkbox to checked
     def checkbox(key)
       field_type = @form.getFieldType(key.to_s)
-      return unless field_type == @acrofields.FIELD_TYPE_CHECKBOX
+      return unless is_checkbox(field_type)
 
       all_states = @form.getAppearanceStates(key.to_s)
       yes_state = all_states.reject{|x| x == "Off"}
@@ -112,7 +126,7 @@ def checkbox(key)
     # Get checkbox values
     def get_checkbox_values(key)
       field_type = @form.getFieldType(key.to_s)
-      return unless field_type == @acrofields.FIELD_TYPE_CHECKBOX
+      return unless is_checkbox(field_type)
 
       @form.getAppearanceStates(key.to_s)
     end
@@ -128,8 +142,42 @@ def ellipse(x, y, width, height)
     def rectangle(x, y,  width, height)
       @canvas.rectangle(x, y, width, height)
     end
+
+    # Example
+    # barcode("PDF417", "2d_barcode", "Barcode data...", AspectRatio: 0.5)
+    def barcode(format, key, value, opts = {})
+      bar = create_barcode(format)
+      bar.setText(value)
+      opts.each do |name, opt|
+        #bar.send("set#{name.to_s.camelize}", opt) #Camelize is not present outside of Rails by default
+        bar.send("set#{name.to_s}", opt)
+      end
+
+      coords = @form.getFieldPositions(key.to_s)
+      rect = create_rectangle(coords)
+
+      barcode_img = bar.getImage
+      barcode_img.scalePercent(100, 100 * bar.getYHeight)
+      barcode_img.setAbsolutePosition(
+          coords[1] + (rect.getWidth - barcode_img.getScaledWidth) / 2,
+          coords[2] + (rect.getHeight - barcode_img.getScaledHeight) / 2
+      )
+
+      cb = @stamp.getOverContent(coords[0].to_i)
+      cb.addImage(barcode_img)
+    end
+
+    # this has to be called *before* setting field values
+    def set_font(font_name)
+      itr = @form.getFields.keySet.iterator
+      while itr.hasNext
+        field = itr.next
+        @form.setFieldProperty(field, 'textfont', create_font(font_name), nil)
+      end
+    end
 
-    # Saves the PDF into a file defined by path given.
+    # Saves the PDF into a file defined by path given. If you want to save
+    # to a string/buffer, just use .to_s directly.
     def save_as(file)
       File.open(file, "wb") { |f| f.write to_s }
     end

lib/pdf/stamper/jruby.rb

@@ -0,0 +1,79 @@
+# = pdf/stamper/rjb.rb -- PDF template stamping.
+#
+#  Copyright (c) 2007-2009 Jason Yates
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', '..', 'ext'))
+require 'java'
+require 'iText-4.2.0.jar'
+
+java_import 'java.io.FileOutputStream'
+java_import 'java.io.ByteArrayOutputStream'
+java_import 'com.lowagie.text.pdf.AcroFields'
+java_import 'com.lowagie.text.pdf.PdfReader'
+java_import 'com.lowagie.text.pdf.PdfStamper'
+java_import 'com.lowagie.text.Image'
+java_import 'com.lowagie.text.Rectangle'
+java_import 'com.lowagie.text.pdf.GrayColor'
+
+module PDF
+  include_package 'com.lowagie.text.pdf'
+
+  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 = PDF::PdfReader.new(template)
+      @baos = ByteArrayOutputStream.new
+      @stamp = PDF::PdfStamper.new(@reader, @baos)#FileOutputStream.new(@tmp_path))
+      @form = @stamp.getAcroFields()
+      @black = GrayColor.new(0.0)
+      @canvas = @stamp.getOverContent(1)
+    end
+    
+    def is_checkbox(field_type)
+      field_type == AcroFields::FIELD_TYPE_CHECKBOX
+    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
+
+    def create_barcode(format)
+      PDF.const_get("Barcode#{format}").new
+    end
+
+    def create_rectangle(coords)
+      Rectangle.new(coords[1], coords[2], coords[3], coords[4])
+    end
+
+    def create_font(font_name)
+      BaseFont.createFont(font_name, BaseFont.CP1252, false)
+    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)
+    end
+  end
+end

pdf-stamper.gemspec

@@ -1,17 +1,15 @@
 Gem::Specification.new do |s|
   s.name = %q{pdf-stamper}
-  s.version = "0.3.3"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jason Yates"]
-  s.date = %q{2010-09-24}
-  s.description = %q{Fill out PDF forms (templates) using iText's PdfStamper. == EXAMPLE: pdf = PDF::Stamper.new("my_template.pdf") pdf.text :first_name, "Jason" pdf.text :last_name, "Yates" pdf.image :photo, "photo.jpg" pdf.checkbox :hungry pdf.save_as "my_output.pdf"}
+  s.authors = ["Jason Yates", "Marshall Anschutz"]
+  s.date = %q{2013-10-28}
+  s.description = %q{Fill out PDF forms (templates) using iText's PdfStamper.}
   s.email = %q{jaywhy@gmail.com}
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
-  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "ext/iText-4.2.0.jar", "lib/pdf/stamper.rb", "lib/pdf/stamper/jruby.rb", "lib/pdf/stamper/rjb.rb", "spec/logo.gif", "spec/pdf_stamper_spec.rb", "spec/test_template.pdf"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/paulschreiber/pdf-stamper/}
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.md", "Rakefile", "ext/iText-4.2.0.jar", "lib/pdf/stamper.rb", "lib/pdf/stamper/jruby.rb", "lib/pdf/stamper/rjb.rb", "spec/logo.gif", "spec/pdf_stamper_spec.rb", "spec/test_template.pdf"]
+  s.homepage = %q{http://github.com/jaywhy/pdf-stamper/}
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{pdf-stamper}
   s.rubygems_version = %q{1.3.1}