renorb-pdf_filler 0.3.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Great Basin Solutions, LLC dba Great Basin Development
+ 
+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.rdoc

@@ -0,0 +1,117 @@
+= pdf_filler
+
+The <b>pdf_filler</b> Rails plugin makes it easy to update existing PDFs that have form fields defined. 
+Rather then building PDFs in Ruby using something like PDF-Writer, it is much easier to create a PDF in Acrobat, 
+define fields, and update those fields using pdf_filler. An example would be a First/Last name field on a PDF that is possible to update.
+
+
+== Requirements
+
+This plugin requires RJB (Ruby Java Bridge), so you will need to set your JAVA_HOME environment variable to point your installation of Java.  
+
+If your JAVA_HOME environment variable is not setup correctly you will get something like:
+
+  
+  Building native extensions.  This could take a while...
+  ERROR:  Error installing pdf_filler-0.1.0.gem:
+          ERROR: Failed to build gem native extension.
+
+  /opt/local/bin/ruby extconf.rb
+  *** extconf.rb failed ***
+  Could not create Makefile due to some reason, probably lack of
+  necessary libraries and/or headers.  Check the mkmf.log file for more
+  details.  You may need configuration options.
+
+  Provided configuration options:
+          --with-opt-dir
+          --without-opt-dir
+          --with-opt-include
+          --without-opt-include=${opt-dir}/include
+          --with-opt-lib
+          --without-opt-lib=${opt-dir}/lib
+          --with-make-prog
+          --without-make-prog
+          --srcdir=.
+          --curdir
+          --ruby=/opt/local/bin/ruby
+  extconf.rb:45: JAVA_HOME is not set. (RuntimeError)
+
+  Gem files will remain installed in /opt/local/lib/ruby/gems/1.8/gems/rjb-1.1.7 for inspection.
+  Results logged to /opt/local/lib/ruby/gems/1.8/gems/rjb-1.1.7/ext/gem_make.out
+
+
+
+<b>On my Mac I set JAVA_HOME to be "/System/Library/Frameworks/JavaVM.framework/Versions/1.5/Home".</b>
+
+
+== Installing
+
+The recommended method to enable pdf_filler in your project is adding the pdf_filler gem to your environment. Add the following code to your Rails configuration in <tt>config/environment.rb</tt>:
+
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'gbdev-pdf_filler', :lib => 'pdf_filler', source => 'http://gems.github.com/'
+  end
+
+Run <tt>sudo rake gems:install</tt> to install the gem.
+
+Another alternative is to install pdf_filler as a Rails plugin:
+
+  script/plugin install git://github.com/gbdev/pdf_filler.git
+
+
+== Usage
+
+1. You will need a PDF that has form fields to fill.
+
+2. A writable directory to store the generated PDFs.
+
+3. For a single page use the Page object?
+
+    // ** Single page **
+    page = GBDev::PDF::Page.new('/path/to/template.pdf')
+    page.set_text(:full_name, 'Wes Hays')
+    page.save_to('/path/to/save.pdf')
+  
+4. For a collection of pages to be added to a single PDF use a Book object.
+
+    book = GBDev::PDF::Book.new
+  
+    page1 = GBDev::PDF::Page.new('/path/to/template1.pdf')
+    page1.set_text(:full_name, 'Wes Hays')
+  
+    page2 = GBDev::PDF::Page.new('/path/to/template2.pdf')
+    page2.set_text(:full_name, 'Darren Johnson')
+  
+    book.add_page(page1)
+    book.add_page(page2)
+  
+    book.save_to('/page/to/book.pdf')
+  
+5. Rather then setting all the fields manually a PDF can be mapped to an ActiveRecord model. 
+   The model must use the acts_as_pdf_db_mapper module. (<b><i>See rdocs on acts_as_pdf_db_mapper for more options</i></b>)
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_pdf_db_mapper
+      ...
+    end
+    
+    user = User.first
+    page = GBDev::PDF::Page.new('/path/to/template1.pdf')
+    page.map_to_object(user)
+    page.save_to('/path/to/save.pdf)
+    
+
+Note: You can use the shorter kernel methods PDFPage instead of GBDev::PDF::Page.new.  The same goes for PDFBook instead of GBDev::PDF::Book.new.
+
+Example:
+  
+  page = PDFPage('/path/to/template.pdf')
+  book = PDFBook()
+
+
+== License
+
+This plugin is released under the MIT license. Please contact weshays (http://github.com/weshays) 
+or djohnson (http://github.com/djohnson) for any questions.

data/Rakefile

@@ -0,0 +1,4 @@
+Dir['tasks/*.rake'].each { |file| load(file) }
+ 
+desc 'Default: run spec tests.' 
+task :default => [:spec]

data/init.rb

@@ -0,0 +1 @@
+require 'pdf_filler'

data/lib/pdf_filler.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+require 'rjb'
+
+load_path = File.expand_path(File.dirname(__FILE__) + '/iText-2.1.7.jar')
+options = ['-Djava.awt.headless=true'] 
+Rjb::load load_path, options
+
+FileOutputStream      = Rjb::import('java.io.FileOutputStream')
+ByteArrayOutputStream = Rjb::import('java.io.ByteArrayOutputStream')
+ByteArrayInputStream  = Rjb::import('java.io.ByteArrayInputStream')
+PdfWriter             = Rjb::import('com.lowagie.text.pdf.PdfWriter')
+PdfReader             = Rjb::import('com.lowagie.text.pdf.PdfReader')
+PdfCopy               = Rjb::import('com.lowagie.text.pdf.PdfCopy')
+PdfImportedPage       = Rjb::import('com.lowagie.text.pdf.PdfImportedPage')
+Document              = Rjb::import('com.lowagie.text.Document')
+Paragraph             = Rjb::import('com.lowagie.text.Paragraph')
+AcroFields            = Rjb::import('com.lowagie.text.pdf.AcroFields')
+PdfStamper            = Rjb::import('com.lowagie.text.pdf.PdfStamper')
+HashMap               = Rjb::import('java.util.HashMap')
+Iterator              = Rjb::import('java.util.Iterator')
+
+require 'pdf_filler/util_methods'
+require 'pdf_filler/page'
+require 'pdf_filler/book'
+require 'pdf_filler/pdf_db_mapper'
+
+
+module Kernel
+
+  # A shortcut kernel method for creating a new PDF Page without having to specify the full path to the page.
+  # Therefore, 
+  # * PDFPage(template)
+  # and
+  # * RenoRB::PDF::Page.new(template)
+  # are the same thing.
+  def PDFPage(template)
+    RenoRB::PDF::Page.new(template)
+  end
+  
+  # A shortcut kernel method for creating a new PDF Book without having to specify the full path to the book.
+  # Therefore, 
+  # * PDFBook()
+  # and
+  # * RenoRB::PDF::Book.new
+  # are the same thing.  
+  def PDFBook()
+    RenoRB::PDF::Book.new
+  end  
+  
+end

data/lib/pdf_filler/book.rb

@@ -0,0 +1,94 @@
+module RenoRB
+  
+  module PDF
+  
+    # A book that represents collection of PDF page.
+    class Book
+      
+      def initialize()
+        @pages = []
+      end
+      
+      # Add a page to the book
+      #
+      # * new_page - The page object of type RenoRB::PDF::Page
+      def add_page(new_page)
+        @pages << new_page
+      end
+      
+      # Renders the PDF Book and saves it to the specified file.
+      #
+      # * filename - A path to the file to be created.      
+      def save_to(filename)
+        dir = File.dirname(filename)             
+        temp_dir = [dir, "collection_temp_#{build_random_string}"].join('/')
+        Dir.mkdir(temp_dir)
+        @pages.each_with_index do |page, indx| 
+          page.save_to([temp_dir, "#{indx}_#{build_random_file_name}"].join('/'))
+        end
+        temp_files = Dir[[temp_dir,'*'].join('/')].sort                 
+            
+        document = Document.new
+        copier = PdfCopy.new(document, FileOutputStream.new(filename))
+      
+        document.open        
+        temp_files.each do |read_target|
+          reader = PdfReader.new(read_target)
+          n_pages = reader.getNumberOfPages
+          n_pages.times do |i|
+            copier.addPage( copier.getImportedPage(reader, i+1)) if copier
+          end
+        end        
+        document.close
+              
+        FileUtils.rm_rf(temp_dir, {:secure => true})        
+      end      
+      
+      # Renders the template with the given data and returns that buffer.    
+      def to_buffer
+        dir = defined?(RAILS_ROOT) ? [RAILS_ROOT, 'tmp'].join('/') : File.expand_path(File.dirname(__FILE__) + '/../../spec/output')         
+        temp_dir = [dir, "collection_temp_#{build_random_string}"].join('/')
+        Dir.mkdir(temp_dir)
+        @pages.each_with_index do |page, indx| 
+          page.save_to([temp_dir, "#{indx}_#{build_random_file_name}"].join('/'))
+        end
+        temp_files = Dir[[temp_dir,'*'].join('/')].sort                 
+            
+        document = Document.new        
+        baos = ByteArrayOutputStream.new
+        copier = PdfCopy.new(document, baos)
+      
+        document.open        
+        
+        # This did not work but try working on it again later.
+        # @pages.each do |page|
+        #   bais = ByteArrayInputStream.new_with_sig(page.to_buffer)
+        #   reader = PdfReader.new(bais)
+        #   reader = page.get_pdf_reader
+        #   n_pages = reader.getNumberOfPages
+        #   n_pages.times do |i|
+        #     copier.addPage( copier.getImportedPage(reader, i+1)) if copier
+        #   end
+        # end        
+        
+        temp_files.each do |read_target|
+          reader = PdfReader.new(read_target)
+          n_pages = reader.getNumberOfPages
+          n_pages.times do |i|
+            copier.addPage( copier.getImportedPage(reader, i+1)) if copier
+          end
+        end        
+        document.close
+              
+        #FileUtils.rm_rf(temp_dir, {:secure => true})       
+              
+        return baos.toByteArray()
+      end      
+      
+      include RenoRB::Utils::PrivateMethods
+      
+    end # End Filler
+
+  end # End PDF
+
+end # End RenoRB

data/lib/pdf_filler/page.rb

@@ -0,0 +1,246 @@
+module RenoRB
+  
+  module PDF
+  
+    # A page that represents a PDF page.
+    class Page
+      
+      CHECK_BOX    = 'Check Box'
+      COMBO_BOX    = 'Combo Box'
+      LIST         = 'List'
+      PUSH_BUTTON  = 'Push Button'
+      RADIO_BUTTON = 'Radio Button'
+      SIGNATURE    = 'Signature'
+      TEXT_FIELD   = 'Text Field'
+      NONE         = 'None'
+      UNKNOWN      = '?'
+      
+      # String template : A path to the template file
+      def initialize(template)
+        @template = template
+        
+        @pdf_fields = {}
+        
+        @check_boxes = {}
+        @images = {}
+        @radio_buttons = {}
+        @signature_fields = {}
+        @text_fields = {}
+        
+        @pdf_reader = nil
+      end
+      
+      # Returns a hash where the keys are the field names in the template PDF and the values are the field types.
+      def get_pdf_fields
+        return @pdf_fields unless @pdf_fields.empty?
+        
+        reader = PdfReader.new(@template)
+        form = reader.getAcroFields()
+        fields = form.getFields()
+        i = fields.keySet().iterator()
+        
+        while(i.hasNext())
+          key = i.next()
+
+          case(form.getFieldType(key))
+            when AcroFields.FIELD_TYPE_CHECKBOX
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::CHECK_BOX
+            when AcroFields.FIELD_TYPE_COMBO
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::COMBO_BOX
+            when AcroFields.FIELD_TYPE_LIST 
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::LIST
+            when AcroFields.FIELD_TYPE_NONE 
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::NONE
+            when AcroFields.FIELD_TYPE_PUSHBUTTON
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::PUSH_BUTTON
+            when AcroFields.FIELD_TYPE_RADIOBUTTON
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::RADIO_BUTTON
+            when AcroFields.FIELD_TYPE_SIGNATURE
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::SIGNATURE
+            when AcroFields.FIELD_TYPE_TEXT
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::TEXT_FIELD
+            else 
+              @pdf_fields[key.to_string().to_sym] = RenoRB::PDF::Page::UNKNOWN
+          end
+        end
+        
+        return @pdf_fields
+      end
+      
+      # Returns an array of field states.  For example if the field type is a list an array
+      # with all possible choices in the list will be returned.
+      #
+      # * field_name - The field name to get all the possible states for.
+      def get_field_states(field_name)
+        reader = PdfReader.new(@template)
+        form = reader.getAcroFields()
+        form.getAppearanceStates(field_name.to_s);
+      end
+      
+      
+      # Sets a know checkbox in the PDF template.
+      #
+      # * key - A known checkbox in the PDF.
+      # * value - The checkbox to update.
+      def set_checkbox(key, value)
+        @check_boxes[key] = value
+      end
+      
+      # Alias for the set_checkbox method
+      alias :checkbox :set_checkbox      
+      
+      # NOT WORING YET
+      # Sets a known image area in the PDF template.
+      #
+      # * key - A known image in the PDF.
+      # * value - The image to apply to the know image area.
+      def set_image(key, value)
+        raise 'Image not working yet'
+        @images[key] = value
+      end     
+      
+      # Alias for the set_image method
+      alias :image :set_image      
+      
+      
+      # Sets a known radio button in the PDF template.
+      #
+      # * key - A known radio button group in the PDF.
+      # * value - The radio button group to update.
+      def set_radio_button(key, value)
+        @radio_buttons[key] = value
+      end
+      
+      # Alias for the set_checkbox method
+      alias :radio_button :set_radio_button
+
+      
+      # NOT WORKING YET
+      # Sets a known signature field in the PDF template.
+      #
+      # * key - A known signature field in the PDF.
+      # * value - The value to apply to the know field.
+      def set_signature_field(key, value)
+        raise 'Signature field not working yet'
+        @signature_fields[key] = value
+      end
+      
+      # Alias for set_signature_field method
+      alias :signature_field :set_signature_field
+            
+      
+      # Sets a known text field in the PDF template.
+      #
+      # * key - A known text field in the PDF.
+      # * value - The value to apply to the know field.
+      def set_text_field(key, value)
+        @text_fields[key] = value
+      end
+      
+      # Alias for set_text method
+      alias :text_field :set_text_field
+      
+      # Maps PDF fields to an ActiveRecord object. The ActiveRecord object must use the
+      # acts_as_pdf_db_mapper module.
+      #
+      # * object - An ActiveRecord object that uses the acts_as_pdf_db_mapper module.
+      def map_to_object(object)
+        if object.methods.include?('mapped_fields')
+          fields = self.get_pdf_fields
+          object.mapped_fields.each do |mapped_field|
+            
+            if mapped_field.class.to_s == 'Hash'
+              key_value_pair = mapped_field.first.to_a.flatten
+              key = key_value_pair[0]
+              value = key_value_pair[1]
+            else
+              key = mapped_field
+              value = mapped_field
+            end
+
+            case(fields[key])
+              when RenoRB::PDF::Page::CHECK_BOX
+                self.set_checkbox(key, object.send(value))
+              when RenoRB::PDF::Page::COMBO_BOX
+                #self.set_combobox(key, object.send(value))
+              when RenoRB::PDF::Page::LIST
+                #self.set_list(key, object.send(value))
+              when RenoRB::PDF::Page::NONE
+                #self.set_none(key, object.send(value))
+              when RenoRB::PDF::Page::PUSH_BUTTON
+                #self.set_push_button(key, object.send(value))
+              when RenoRB::PDF::Page::RADIO_BUTTON
+                self.set_radio_button(key, object.send(value))
+              when RenoRB::PDF::Page::SIGNATURE
+                self.set_signature_field(key, object.send(value))
+              when RenoRB::PDF::Page::TEXT_FIELD
+                self.set_text_field(key, object.send(value))
+            end            
+            
+          end
+        end
+      end
+      
+      
+      # Renders the template with the given data and saves to the given filename path.
+      #
+      # * filename - A path to the file to be created.  
+      def save_to(filename)                      
+        field_cache = HashMap.new
+        reader = PdfReader.new(@template)
+        stamper = PdfStamper.new( reader, FileOutputStream.new(filename) )
+        form = stamper.getAcroFields()
+        form.setFieldCache(field_cache)
+        
+        all_fields = {}
+        all_fields.merge!(@check_boxes)
+        all_fields.merge!(@radio_buttons)
+        all_fields.merge!(@signature_fields)
+        all_fields.merge!(@text_fields)
+
+        all_fields.each do |field, value|
+          form.setField(field.to_s, value.to_s)
+        end        
+
+        # TODO: do something with @images 
+
+        stamper.setFormFlattening(true)
+        stamper.close                    
+      end
+      
+      
+      # Renders the template with the given data and returns that buffer.    
+      def to_buffer
+        field_cache = HashMap.new
+        reader = PdfReader.new(@template)
+        baos = ByteArrayOutputStream.new 
+        stamper = PdfStamper.new( reader, baos )
+        form = stamper.getAcroFields()
+        form.setFieldCache(field_cache)
+        
+        all_fields = {}
+        all_fields.merge!(@check_boxes)
+        all_fields.merge!(@radio_buttons)
+        all_fields.merge!(@signature_fields)
+        all_fields.merge!(@text_fields)
+
+        all_fields.each do |field, value|
+          form.setField(field.to_s, value.to_s)
+        end        
+
+        # TODO: do something with @images 
+
+        stamper.setFormFlattening(true)
+        stamper.close
+        
+        return baos.toByteArray()
+      end
+  
+      
+      include RenoRB::Utils::PrivateMethods
+      
+    end # End Page
+
+  end # End PDF
+
+end # End RenoRB

data/lib/pdf_filler/pdf_db_mapper.rb

@@ -0,0 +1,74 @@
+require 'active_record'
+
+module RenoRB #:nodoc:
+  module PDF #:nodoc:
+    module Acts #:nodoc:
+      module PDFDBMapper # :nodoc:
+
+        def self.included(mod)
+          mod.extend(ClassMethods)
+        end
+
+        module ClassMethods  
+         
+          # Automatically maps database fields to fields found in the template PDF with the same name.
+          # Database fields not found in the template PDF are ignored.  If no options are specified then
+          # by default all table fields will attempt to be mapped.
+          #
+          # Configuration options are: 
+          #
+          # * :only - Only map the database fields specified. i.e :only => [:first_name, :last_name]
+          # * :except - Map all the table fields except those specified.  i.e. :except => [:middle_name]
+          # * :include - Allows for a method to map to a field in the PDF. If you have a method called full_name 
+          #   that combines the first name and last name, you could map that method to a PDF text field called full_name.
+          #   :include => [:full_name].  
+          #   You could all specify a model attribute/method to map to a different PDF field. 
+          #   i.e. :include => [{:full_name => :dog_name}]
+          #   :include will still work with :only and :except.
+          # * :only_include - Will ignore :only and :except and only includes the manual mappings specified.
+          #   i.e. :only_include => [:full_name, {:animal_name => :dog_name}]
+          def acts_as_pdf_db_mapper(*fields) 
+ 
+            # Make sure that the table to be mapped actually exists
+            if self.table_exists?
+
+              # Get a collection of fields to be searched on.
+              if fields.first.class.to_s == 'Hash'
+                
+                if fields.first.has_key?(:only_include)
+                  fields_to_map = fields.first[:only_include]
+                else
+                  if fields.first.has_key?(:only)
+                    # only map on these fields.
+                    fields_to_map = fields.first[:only]
+                  elsif fields.first.has_key?(:except)
+                    # Get all the fields and remove any that are in the -except- list.
+                    fields_to_map = self.column_names.collect { |column| fields.first[:except].include?(column.to_sym) ? nil : column.to_sym }.compact
+                  else
+                    fields_to_map = self.column_names.collect { |column| column.to_sym }
+                  end
+                
+                  if fields.first.has_key?(:include)
+                    fields_to_map += fields.first[:include]
+                  end
+                end
+              else 
+                fields_to_map = self.column_names.collect { |column| column.to_sym }
+              end            
+
+              # Set the appropriate class attributes. 
+              self.cattr_accessor :mapped_fields
+              self.mapped_fields = fields_to_map    
+              
+            end # End table exists check
+            
+          end # acts_as_pdf_db_mapper
+  
+        end # ClassMethods
+     
+      end # PDFDBMapper
+    end # Acts
+  end # PDF
+end # RenoRB
+
+ActiveRecord::Base.send(:include, RenoRB::PDF::Acts::PDFDBMapper)

data/lib/pdf_filler/util_methods.rb

@@ -0,0 +1,50 @@
+module RenoRB #:nodoc: all
+
+  module Utils
+    
+    module PrivateMethods
+  
+      def build_random_string # :nodoc:
+        letters_array = [('a'..'z'),('A'..'Z')].collect{|i| i.to_a}.flatten
+        (1..10).collect{ letters_array[ rand(letters_array.length) ] }.join 
+      end
+      
+      def build_random_file_name # :nodoc:
+        build_random_string << '.pdf'
+      end              
+  
+    end
+    
+    
+    # Include these controller methods to prompt the user to download the PDF.
+    #
+    # * include RenoRB::Utils::ControllerMethods
+    module ControllerMethods
+      
+      # Used to display the PDF without saving it to disk.
+      # 
+      # * buffer - A Page buffer or Book buffer.
+      # * filename - The filename to apply to the buffer when prompted to download.
+      def display_pdf(buffer, filename)
+        send_data(buffer, {:type        => 'application/pdf',
+                           :disposition => 'attachment',
+                           :filename    => filename} )
+      end
+      
+
+      # From here: http://railspdfplugin.rubyforge.org/wiki/wiki.pl
+      # Suggested code so errors will always show in browser
+      def rescue_action_in_public(exception) # :nodoc:
+        headers.delete("Content-Disposition")
+        super
+      end
+
+      def rescue_action_locally(exception) # :nodoc:
+        headers.delete("Content-Disposition")
+        super
+      end
+      
+    end
+    
+  end
+end

data/spec/lib/pdf_book_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe 'Book' do
+  
+  it 'should create the book of pages and write to the output directory' do
+    book = RenoRB::PDF::Book.new
+    
+    template_file = File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf')
+    pdf_book = File.expand_path(File.dirname(__FILE__) + '/../output/certs.pdf')
+
+    page1 = RenoRB::PDF::Page.new(template_file)
+    page1.set_text_field(:full_name, 'Wes Hays')
+
+    page2 = RenoRB::PDF::Page.new(template_file)
+    page2.set_text_field(:full_name, 'Darren Johnson')
+
+    page3 = RenoRB::PDF::Page.new(template_file)
+    page3.set_text_field(:full_name, 'John Dell')
+    
+    book.add_page(page1)
+    book.add_page(page2)
+    book.add_page(page3)
+    
+    book.save_to(pdf_book)
+    
+    File.exist?(pdf_book).should be_true
+  end  
+  
+  it 'should create the book of pages and write to the output directory with Kernel method' do
+    book = PDFBook()
+    
+    template_file = File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf')
+    pdf_book = File.expand_path(File.dirname(__FILE__) + '/../output/certs.pdf')
+
+    page1 = RenoRB::PDF::Page.new(template_file)
+    page1.set_text_field(:full_name, 'Wes Hays')
+
+    page2 = RenoRB::PDF::Page.new(template_file)
+    page2.set_text_field(:full_name, 'Darren Johnson')
+
+    page3 = RenoRB::PDF::Page.new(template_file)
+    page3.set_text_field(:full_name, 'John Dell')
+    
+    book.add_page(page1)
+    book.add_page(page2)
+    book.add_page(page3)
+    
+    book.save_to(pdf_book)
+    
+    File.exist?(pdf_book).should be_true
+  end  
+  
+  it 'should return the buffer without writing to disk' do
+    book = PDFBook()
+    
+    template_file = File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf')
+
+    page1 = RenoRB::PDF::Page.new(template_file)
+    page1.set_text_field(:full_name, 'Wes Hays')
+
+    page2 = RenoRB::PDF::Page.new(template_file)
+    page2.set_text_field(:full_name, 'Darren Johnson')
+
+    page3 = RenoRB::PDF::Page.new(template_file)
+    page3.set_text_field(:full_name, 'John Dell')
+    
+    book.add_page(page1)
+    book.add_page(page2)
+    book.add_page(page3)
+    
+    book.to_buffer.should_not be_blank
+  end  
+  
+end

data/spec/lib/pdf_db_mapper_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe 'PDF_DB_Mapper' do
+  
+  before(:each) do
+    Address.create_corpus!
+  end
+  
+  after(:each) do
+    Address.destroy_all
+  end
+  
+  it 'should allow all database columns to be mapped if no :only or :except is specified' do
+    address = Address.first
+    fields_array = address.mapped_fields.collect{|f| f.to_s}.sort
+    fields_array.should == ['id', 'address1', 'address2', 'city', 'state', 'postal_code'].sort
+  end
+  
+  it 'should only map the fields specified by :only' do
+    address = ClientAddress.first
+    fields_array = address.mapped_fields.collect{|f| f.to_s}.sort
+    fields_array.should == ['city', 'state'].sort
+  end
+  
+  it 'should map all the fields except the fields specified by :except' do
+    address = ContactAddress.first
+    fields_array = address.mapped_fields.collect{|f| f.to_s}.sort
+    fields_array.should == ['address2', 'city', 'state'].sort    
+  end
+  
+  it 'should include the additional mappings specified by :include' do
+    address = UserAddress.first
+    fields_array = address.mapped_fields.collect{|f| f.class.to_s == 'Hash' ? f.first.to_a.flatten.join('::') : f.to_s}.sort
+    fields_array.should == ['id', 'address1', 'address2', 'city', 'state', 'postal_code','full_address::address'].sort    
+  end
+  
+  it 'should only include the mappings specified by :only_include' do
+    address = FamilyAddress.first
+    fields_array = address.mapped_fields.collect{|f| f.first.to_a.flatten.join('::')}.sort
+    fields_array.should == ['full_address::address'].sort    
+  end  
+  
+  it 'should map the specified fields for a single record to a single page' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/address_template.pdf'))
+    address = Address.first
+    page.map_to_object(address)
+    page.save_to(File.expand_path(File.dirname(__FILE__) + '/../output/db_address.pdf'))
+    File.exist?(File.dirname(__FILE__) + '/../output/db_address.pdf').should be_true
+  end    
+  
+end

data/spec/lib/pdf_page_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe 'Page' do
+  
+  it 'should create the page and write to the output directory' do    
+    page = RenoRB::PDF::Page.new(File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'))
+    page.set_text_field(:full_name, 'Wes Hays')
+    page.save_to(File.expand_path(File.dirname(__FILE__) + '/../output/wes_hays.pdf'))
+    File.exist?(File.dirname(__FILE__) + '/../output/wes_hays.pdf').should be_true
+  end
+  
+  it 'should create the page and write to the output directory with Kernel method' do    
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'))
+    page.set_text_field(:full_name, 'Wes Hays')
+    page.save_to(File.expand_path(File.dirname(__FILE__) + '/../output/wes_hays.pdf'))
+    File.exist?(File.dirname(__FILE__) + '/../output/wes_hays.pdf').should be_true
+  end
+  
+  it 'should find all three fields: text field, checkbox and radio buttons' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/form_template.pdf'))
+    fields = page.get_pdf_fields
+    
+    fields.has_key?(:full_name).should be_true
+    fields[:full_name].should == RenoRB::PDF::Page::TEXT_FIELD
+    
+    fields.has_key?(:home_owner).should be_true
+    fields[:home_owner].should == RenoRB::PDF::Page::RADIO_BUTTON
+    
+    fields.has_key?(:newsletter).should be_true
+    fields[:newsletter].should == RenoRB::PDF::Page::CHECK_BOX
+    
+    fields.has_key?(:car_types).should be_true
+    fields[:car_types].should == RenoRB::PDF::Page::LIST
+    
+    fields.has_key?(:sibling_count).should be_true
+    fields[:sibling_count].should == RenoRB::PDF::Page::COMBO_BOX   
+    
+    # fields.has_key?(:owner_signature).should be_true
+    # fields[:owner_signature].should == RenoRB::PDF::Page::SIGNATURE
+    #
+    # fields.has_key?(:submit_button).should be_true
+    # fields[:submit_button].should == RenoRB::PDF::Page::PUSH_BUTTON
+    #
+    # fields.has_key?(:photo).should be_true
+    # fields[:photo].should == RenoRB::PDF::Page::IMAGE     
+  end
+   
+  it 'should find all the valid states for the check box' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/form_template.pdf'))
+    states = page.get_field_states(:newsletter) # Checkbox
+    states.should == ['Yes','Off']  
+  end
+  
+  it 'should find all the valid states for the radio button' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/form_template.pdf'))
+    states = page.get_field_states(:home_owner) # radio button
+    states.should == ['Yes','No','Off']  # Off will not be used but AcroFields returns it anyway.
+  end  
+  
+  it 'should find all the valid states for the list' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/form_template.pdf'))
+    states = page.get_field_states(:car_types) # List
+    states.sort.should == ['Chevy', 'Ford', 'Honda', 'Jeep', 'Toyota'].sort
+  end  
+  
+  it 'should find all the valid states for the combo box' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/form_template.pdf'))
+    states = page.get_field_states(:sibling_count) # List
+    states.sort.should == ['Zero','One','Two','Three','Four','Five','Six','Seven','Eight','Nine','Ten'].sort
+  end  
+  
+  it 'should fill all fields' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/form_template.pdf'))
+    page.set_text_field(:full_name, 'Anna Hays')        
+    page.set_checkbox(:home_owner, 'Yes') 
+    page.set_checkbox(:newsletter, 'Yes')
+    page.set_checkbox(:car_types, 'Jeep')
+    page.set_checkbox(:sibling_count, 'One')
+    page.save_to(File.expand_path(File.dirname(__FILE__) + '/../output/form_test.pdf'))
+    File.exist?(File.dirname(__FILE__) + '/../output/form_test.pdf').should be_true    
+  end
+  
+  it 'should return the buffer without writing to disk' do
+    page = PDFPage(File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'))
+    page.set_text_field(:full_name, 'Wes Hays')
+    pdf_data = page.to_buffer
+    pdf_data.should_not be_blank
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+require 'spec'
+require 'rubygems'
+require 'ruby-debug'
+require 'activerecord'
+
+##################
+#### <CUSTOM> ####
+##################
+# Aliased "lambda" with "doing" so that when checking
+# whether or not something raises an exception it will
+# read like other rspec operations.  For example:
+# instead of
+# lambda { ... }.should_not raise_error
+# you can have
+# doing { ... }.should_not raise_error
+alias :doing :lambda
+###################
+#### </CUSTOM> ####
+###################
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ActiveRecord::Base.configurations = true
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :clients do |t|
+    t.string :first_name
+    t.string :last_name
+  end
+  
+  create_table :addresses do |t|
+    t.string :address1
+    t.string :address2
+    t.string :city
+    t.string :state
+    t.string :postal_code
+  end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'pdf_filler'
+
+
+module RenoRB
+  module TestData
+    module Addresses
+      def create_corpus!
+        create!(:address1 => '111 AAA St', :address2 => 'Suite 444', :city => 'Reno',    :state => 'Nevada', :postal_code => '89506')
+        create!(:address1 => '222 BBB St', :address2 => 'Suite 555', :city => 'Sparks',  :state => 'Nevada', :postal_code => '89434')
+        create!(:address1 => '333 CCC St', :address2 => 'Suite 666', :city => 'Fernley', :state => 'Nevada', :postal_code => '89408')
+      end
+    end
+  end
+end
+
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    class Client < ActiveRecord::Base
+      acts_as_pdf_db_mapper :only => [:first_name, :last_name]
+      has_many :addresses, :dependent => :destroy
+      
+      def full_name
+        [self.first_name, self.last_name].join(' ')
+      end
+    end
+    
+    class Address < ActiveRecord::Base
+      acts_as_pdf_db_mapper
+      belongs_to :client      
+      extend RenoRB::TestData::Addresses
+    end
+    
+    class ClientAddress < ActiveRecord::Base
+      set_table_name :addresses
+      acts_as_pdf_db_mapper :only => [:state, :city]
+    end
+
+    class ContactAddress < ActiveRecord::Base
+      set_table_name :addresses
+      acts_as_pdf_db_mapper :except => [:id, :address1, :postal_code]
+    end
+
+    class UserAddress < ActiveRecord::Base
+      set_table_name :addresses
+      acts_as_pdf_db_mapper :include => [{:full_address => :address}]
+      
+      def full_address
+        [self.address1, self.address2].join(', ')
+      end
+    end    
+    
+    class FamilyAddress < ActiveRecord::Base
+      set_table_name :addresses
+      acts_as_pdf_db_mapper :only_include => [{:full_address => :address}]
+      
+      def full_address
+        [self.address1, self.address2].join(', ')
+      end
+    end    
+    
+    Client.destroy_all
+    Address.destroy_all
+  end
+  
+  config.after(:each) do
+    Object.send(:remove_const, :Client)
+    Object.send(:remove_const, :Address)
+  end
+end

data/tasks/build_gem.rake

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name    = 'pdf_filler'
+    #gem.version = '0.1.1'  # In version file
+    gem.date    = '2009-08-25'
+
+    gem.summary = "A Rails plugin to fill a PDF form using RJB and iText."
+    gem.description = "PDF Filler makes it easy to file your PDFs."
+
+    gem.authors  = ['Reno Ruby Group']
+    gem.email    = ['renorb@renorb.org']
+    gem.homepage = 'http://wiki.github.com/renorb/pdf_filler'
+
+    gem.has_rdoc = true
+    gem.rdoc_options << '--title' << gem.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
+    gem.extra_rdoc_files = ['README.rdoc']
+
+    gem.files = ['LICENSE', 
+                 'README.rdoc',
+                 'Rakefile',
+                 'init.rb',
+                 'lib/iText-2.1.7.jar',
+                 'lib/pdf_filler.rb',
+                 'lib/pdf_filler/page.rb',
+                 'lib/pdf_filler/book.rb',
+                 'lib/pdf_filler/pdf_db_mapper.rb',
+                 'lib/pdf_filler/util_methods.rb',
+                 'tasks/documentation.rake',
+                 'tasks/build_gem.rake',
+                 'spec/spec_helper.rb',
+                 'spec/lib/pdf_page_spec.rb',
+                 'spec/lib/pdf_book_spec.rb',
+                 'spec/lib/pdf_db_mapper_spec.rb',
+                 'spec/output',
+                 'spec/templates/certificate_template.pdf']
+
+    gem.test_files = ['spec/lib/pdf_page_spec.rb',
+                      'spec/lib/pdf_book_spec.rb']    
+    
+    gem.add_dependency 'rjb', '>= 1.1.7'
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end

data/tasks/documentation.rake

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for PDF-Filler.'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/html'
+  rdoc.title    = 'pdf_filler'  
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('LICENSE', 'lib/')
+end
+
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = Dir[ "spec/**/*_spec.rb" ]
+  end
+rescue LoadError
+  nil
+end
+
+begin
+  require 'rcov/rcovtask'
+  desc 'Runs spec:rcov and then displays the coverage/index.html file in the browser.' 
+  task :rcov_display => [:clobber_rcov, :rcov] do 
+    system("open coverage/index.html")
+  end
+rescue LoadError
+  nil
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: renorb-pdf_filler
+version: !ruby/object:Gem::Version 
+  version: 0.3.4
+platform: ruby
+authors: 
+- Reno Ruby Group
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rjb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: 
+description: PDF Filler makes it easy to file your PDFs.
+email: 
+- renorb@renorb.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/iText-2.1.7.jar
+- lib/pdf_filler.rb
+- lib/pdf_filler/book.rb
+- lib/pdf_filler/page.rb
+- lib/pdf_filler/pdf_db_mapper.rb
+- lib/pdf_filler/util_methods.rb
+- spec/lib/pdf_book_spec.rb
+- spec/lib/pdf_db_mapper_spec.rb
+- spec/lib/pdf_page_spec.rb
+- spec/spec_helper.rb
+- spec/templates/certificate_template.pdf
+- tasks/build_gem.rake
+- tasks/documentation.rake
+has_rdoc: false
+homepage: http://wiki.github.com/renorb/pdf_filler
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- pdf_filler
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
+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: 3
+summary: A Rails plugin to fill a PDF form using RJB and iText.
+test_files: 
+- spec/lib/pdf_page_spec.rb
+- spec/lib/pdf_book_spec.rb