gbdev-pdf_filler 0.1.0

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,84 @@
+= 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 hash of parameters for filling the PDF form. The hash must contain all of the required options:
+  * :data (required) - A hash or array of hashes of fields to fill the pdf template with. Example: [{:field => 'value'}, {:field => 'value'}].
+  * :template (required) - The full path to the PDF form to fill.
+  * :dir (required) - The directory to write filled form to.
+  * :file_name (optional) The name of the output file to create. If not specified a random file name will be used.
+
+3. Example
+  opts = {:data => {:full_name => 'Wes Hays'},
+          :template => '/path/to/templates/certificate_template.pdf'),
+          :dir => '/path/to/templates/output/'),
+          :file_name => 'wes_hays.pdf'}
+  PdfFiller(opts)
+
+
+== 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 'form_filler'

data/lib/pdf_filler.rb

@@ -0,0 +1,35 @@
+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')
+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')
+
+require 'pdf_filler/util_methods'
+require 'pdf_filler/fill_pdf_template'
+require 'pdf_filler/fill_pdf_collection'
+
+
+module Kernel
+
+  def PdfFiller(pdf_options = {})
+    if(pdf_options.has_key?(:data) and pdf_options[:data].class.to_s == 'Array')
+      p = Gbdev::PdfOperations::FillCollection.new(pdf_options)
+    else  
+      p = Gbdev::PdfOperations::FillTemplate.new(pdf_options)
+    end
+    p.compile_pdf
+  end
+  
+end

data/spec/lib/pdf_builder_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe 'PdfFiller' do
+  it 'should be initialized without errors' do
+    opts = {:data => {:full_name => 'Wes Hays'},
+            :template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'),
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/')}
+    ff = PdfFiller(opts)
+  end
+  
+  it 'should be use the output filename specified' do
+    opts = {:data => {:full_name => 'Wes Hays'},
+            :template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'),
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/'),
+            :file_name => 'wes_hays.pdf'}
+    ff = PdfFiller(opts)
+    File.exist?([opts[:dir], opts[:file_name]].join('/')).should be_true
+  end
+  
+  it 'should raise exception if options[:data] not set' do
+    opts = {:template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'),
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/')}
+    doing {PdfFiller(opts)}.should raise_error('Option parameters data, template, dir are required')
+  end
+  
+  it 'should raise exception if options[:template] not set' do
+    opts = {:data => {:full_name => 'Wes Hays'},
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/')}
+    doing {PdfFiller(opts)}.should raise_error('Option parameters data, template, dir are required')
+  end
+  
+  it 'should raise exception if options[:dir] not set' do
+    opts = {:data => {:full_name => 'Wes Hays'},
+            :template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf')}
+    doing {PdfFiller(opts)}.should raise_error('Option parameters data, template, dir are required')
+  end
+  
+  
+  it 'should raise exception if options[:data] is not a hash or an array of hashes' do
+    opts = {:data => 'dog',
+            :template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'),
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/')}
+    doing {PdfFiller(opts)}.should raise_error('Data must be a hash')
+  end  
+  
+  it 'should raise exception if certificate template does not exist' do
+    opts = {:data => {:full_name => 'Wes Hays'},
+            :template => 'dog/templates/certificate_template.pdf',
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/')}
+    doing {PdfFiller(opts)}.should raise_error('Template file does not exist or path is wrong')
+  end  
+  
+  it 'should raise exception if options[:dir] is not a directory' do
+    opts = {:data => {:full_name => 'Wes Hays'},
+            :template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'),
+            :dir => '/../output/'}
+    doing {PdfFiller(opts)}.should raise_error('Output directory does not exist or path is wrong')
+  end  
+  
+end

data/spec/lib/pdf_collection_builder_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe 'FormCollection' do
+  it 'should be initialized without errors' do
+    opts = {:data => [{:full_name => 'Wes Hays'}, {:full_name => 'Darren Johnson'}],
+            :template => File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'),
+            :dir => File.expand_path(File.dirname(__FILE__) + '/../output/'),
+            :file_name => 'people.pdf'}
+    ff = PdfFiller(opts)
+    File.exist?([opts[:dir], opts[:file_name]].join('/')).should be_true
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+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'
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    class Client < ActiveRecord::Base
+      has_many :addresses, :dependent => :destroy
+    end
+    
+    class Address < ActiveRecord::Base
+      belongs_to :client
+    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/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    = 'scoped_search'  
+  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,82 @@
+--- !ruby/object:Gem::Specification 
+name: gbdev-pdf_filler
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wes Hays
+- Darrne Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-24 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: 
+- weshays@gbdev.com
+- djohnson@gbdev.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/iText-2.1.7.jar
+- lib/pdf_filler.rb
+- spec/lib/pdf_builder_spec.rb
+- spec/lib/pdf_collection_builder_spec.rb
+- spec/spec_helper.rb
+- spec/templates/certificate_template.pdf
+- tasks/documentation.rake
+has_rdoc: false
+homepage: http://wiki.github.com/gbdev/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_builder_spec.rb
+- spec/lib/pdf_collection_builder_spec.rb