gbdev-pdf_filler 0.1.1 → 0.1.2

data/lib/pdf_filler/fill_pdf_collection.rb

@@ -0,0 +1,79 @@
+module Gbdev
+  
+  module PdfOperations
+
+    class FillCollection
+            
+      # Fill a PDF form based on the options specified.
+      # 
+      # Hash pdf_options : A hash of parameters for filling the PDF form. 
+      #                    [data] An array of hashes of fields to fill the pdf template with. Example: [{:field => 'value'}, {:field => 'value'}].
+      #                    [template] The full path to the PDF form to fill.
+      #                    [dir] 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.
+      #
+      # Exceptons : 
+      #   1) If any of the required hash options from pdf_options is missing.
+      def initialize(pdf_options = {})
+        if !pdf_options.has_key?(:data) or !pdf_options.has_key?(:template) or !pdf_options.has_key?(:dir)
+          raise 'All options parameters (data, template, dir) are required'
+        end
+            
+        unless File.exist?(pdf_options[:template])
+          raise 'Template file does not exist or path is wrong'
+        end
+            
+        if pdf_options[:data].class.to_s != 'Array' or 
+           (pdf_options[:data].class.to_s == 'Array' and pdf_options[:data][0].class.to_s != 'Hash')
+          raise 'Data must array of hashes'
+        end
+            
+        unless File.directory?(pdf_options[:dir])
+          raise 'Output directory does not exist or path is wrong'
+        end
+              
+        @data      = pdf_options[:data]
+        @template  = pdf_options[:template]
+        @dir       = pdf_options[:dir]
+        @file_name = pdf_options.has_key?(:file_name) ? pdf_options[:file_name] : build_random_file_name
+      end  
+      
+      def compile_pdf
+        temp_dir = [@dir, 'collection_temp'].join('/')
+        Dir.mkdir(temp_dir)
+        @data.each do |hash_data|
+          opts = {:data => hash_data,
+                  :template => @template,
+                  :dir => temp_dir}
+          p = Gbdev::PdfOperations::FillTemplate.new(opts)
+          p.compile_pdf
+        end
+        
+        temp_files = Dir[[temp_dir,'*'].join('/')]      
+        
+        document = Document.new
+        copier = PdfCopy.new(document, FileOutputStream.new([@dir,@file_name].join('/')))
+        
+        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
+      
+      private
+      
+        include Gbdev::Utils::PrivateMethods
+        
+    end # End FillCollection
+    
+  end # End PdfOperations
+  
+end # End Gbdev

data/lib/pdf_filler/fill_pdf_template.rb

@@ -0,0 +1,65 @@
+module Gbdev
+  
+  module PdfOperations
+  
+    class FillTemplate
+
+      # Fills a PDF form based on the options specified.
+      # 
+      # Hash pdf_options : A hash of parameters for filling the PDF form. 
+      #                    [data] Hash of fields to fill and what to fill them with. Example: {:field => 'value'}.
+      #                    [template] The full path to the PDF form to fill.
+      #                    [dir] 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.
+      #
+      # Exceptons : 
+      #   1) If any of the required hash options from pdf_options is missing.
+      def initialize(pdf_options = {})
+        if !pdf_options.has_key?(:data) or !pdf_options.has_key?(:template) or !pdf_options.has_key?(:dir)
+          raise 'Option parameters data, template, dir are required'
+        end
+  
+        unless File.exist?(pdf_options[:template])
+          raise 'Template file does not exist or path is wrong'
+        end
+  
+        if ['Hash'].index(pdf_options[:data].class.to_s).nil?
+          raise 'Data must be a hash'
+        end
+  
+        unless File.directory?(pdf_options[:dir])
+          raise 'Output directory does not exist or path is wrong'
+        end
+    
+        @data      = pdf_options[:data]
+        @template  = pdf_options[:template]
+        @dir       = pdf_options[:dir]
+        @file_name = pdf_options.has_key?(:file_name) ? pdf_options[:file_name] : build_random_file_name
+      end  
+    
+      # Compiles the new PDF from the template and data given
+      def compile_pdf
+        field_cache = HashMap.new
+        reader = PdfReader.new(@template)
+        stamper = PdfStamper.new( reader, FileOutputStream.new([@dir, @file_name].join('/')) )
+        form = stamper.getAcroFields()
+        form.setFieldCache(field_cache)
+      
+        @data.each do |field,value|
+          form.setField(field.to_s, value.to_s)
+        end
+    
+        stamper.setFormFlattening(true)
+        stamper.close        
+      end
+    
+      private
+    
+        include Gbdev::Utils::PrivateMethods
+    
+    end # End FillTemplate
+    
+  end # End PdfOperations
+  
+end # End Gbdev

data/lib/pdf_filler/util_methods.rb

@@ -0,0 +1,12 @@
+module Gbdev
+  module Utils
+    module PrivateMethods
+  
+      def build_random_file_name # :nodoc:
+        letters_array = [('a'..'z'),('A'..'Z')].collect{|i| i.to_a}.flatten
+        (1..10).collect{ letters_array[ rand(letters_array.length) ] }.join << '.pdf'
+      end              
+  
+    end
+  end
+end

data/tasks/build_gem.rake

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name    = 'pdf_filler'
+    gem.version = '0.0.2'
+    gem.date    = '2009-07-24'
+
+    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  = ['Wes Hays', 'Darrne Johnson']
+    gem.email    = ['weshays@gbdev.com', 'djohnson@gbdev.com']
+    gem.homepage = 'http://wiki.github.com/gbdev/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/fill_pdf_collection.rb',
+                 'lib/pdf_filler/fill_pdf_template.rb',
+                 'lib/pdf_filler/util_methods.rb',
+                 'tasks/documentation.rake',
+                 'tasks/build_gem.rake',
+                 'spec/spec_helper.rb',
+                 'spec/lib/pdf_builder_spec.rb',
+                 'spec/lib/pdf_collection_builder_spec.rb',
+                 'spec/output',
+                 'spec/templates/certificate_template.pdf']
+
+    gem.test_files = ['spec/lib/pdf_builder_spec.rb',
+                      'spec/lib/pdf_collection_builder_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gbdev-pdf_filler
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Wes Hays
@@ -40,10 +40,14 @@ files:
 - init.rb
 - lib/iText-2.1.7.jar
 - lib/pdf_filler.rb
+- lib/pdf_filler/fill_pdf_collection.rb
+- lib/pdf_filler/fill_pdf_template.rb
+- lib/pdf_filler/util_methods.rb
 - spec/lib/pdf_builder_spec.rb
 - spec/lib/pdf_collection_builder_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/gbdev/pdf-filler