gbdev-pdf_filler 0.1.2 → 0.2.0

data/lib/pdf_filler.rb

@@ -17,19 +17,18 @@ 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'
+require 'pdf_filler/page'
+require 'pdf_filler/book'
 
 
 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
+  def PDFPage(template)
+    GBDev::PDF::Page.new(template)
   end
   
+  def PDFBook()
+    GBDev::PDF::Book.new
+  end  
+  
 end

data/lib/pdf_filler/book.rb

@@ -0,0 +1,59 @@
+module GBDev
+  
+  module PDF
+  
+    # A book that represents collection of PDF page.
+    class Book
+      
+      def initialize()
+        @pages = []
+      end
+      
+      # Add a page to the book
+      def add_page(new_page)
+        @pages << new_page
+      end
+      
+      # Renders the book with the given pages and saves to the given filename path.
+      #
+      # String 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
+      
+      def display
+      end
+      
+      def save_and_display(filename)
+        save(filename)
+        display
+      end
+      
+      include Gbdev::Utils::PrivateMethods
+      
+    end # End Filler
+
+  end # End PDF
+
+end # End GBDev

data/lib/pdf_filler/page.rb

@@ -0,0 +1,69 @@
+module GBDev
+  
+  module PDF
+  
+    # A page that represents a PDF page.
+    class Page
+      
+      # String template : A path to the template file
+      def initialize(template)
+        @template = template
+        @fields = {}
+        @images = {}
+      end
+      
+      # Sets a known text field in the PDF template.
+      #
+      # key : A known field in the PDF.
+      # value : The value to apply to the know field.
+      def set_text(key, value)
+        @fields[key] = value
+      end
+      
+      # Alias for set_text method
+      alias :text :set_text
+      
+      # Sets a know image area in the PDF template.
+      #
+      # key : A known field in the PDF.
+      # value : The image to apply to the know image area.
+      def set_image(key, value)
+        @images[key] = value
+      end
+      
+      # Alias for the set_image method
+      alias :image :set_image    
+      
+      # Renders the template with the given data and saves to the given filename path.
+      #
+      # String 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)
+
+        @fields.each do |field, value|
+          form.setField(field.to_s, value.to_s)
+        end
+
+        stamper.setFormFlattening(true)
+        stamper.close                    
+      end
+      
+      def display
+      end
+      
+      def save_and_display(filename)
+        save(filename)
+        display
+      end
+      
+      include Gbdev::Utils::PrivateMethods
+      
+    end # End Page
+
+  end # End PDF
+
+end # End GBDev

data/lib/pdf_filler/util_methods.rb

@@ -1,10 +1,15 @@
 module Gbdev
   module Utils
+    
     module PrivateMethods
   
-      def build_random_file_name # :nodoc:
+      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 << '.pdf'
+        (1..10).collect{ letters_array[ rand(letters_array.length) ] }.join 
+      end
+      
+      def build_random_file_name # :nodoc:
+        build_random_string << '.pdf'
       end              
   
     end

data/spec/lib/pdf_book_spec.rb

@@ -0,0 +1,53 @@
+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 = GBDev::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 = GBDev::PDF::Page.new(template_file)
+    page1.set_text(:full_name, 'Wes Hays')
+
+    page2 = GBDev::PDF::Page.new(template_file)
+    page2.set_text(:full_name, 'Darren Johnson')
+
+    page3 = GBDev::PDF::Page.new(template_file)
+    page3.set_text(: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 = GBDev::PDF::Page.new(template_file)
+    page1.set_text(:full_name, 'Wes Hays')
+
+    page2 = GBDev::PDF::Page.new(template_file)
+    page2.set_text(:full_name, 'Darren Johnson')
+
+    page3 = GBDev::PDF::Page.new(template_file)
+    page3.set_text(: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  
+  
+end

data/spec/lib/pdf_page_spec.rb

@@ -0,0 +1,19 @@
+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 = GBDev::PDF::Page.new(File.expand_path(File.dirname(__FILE__) + '/../templates/certificate_template.pdf'))
+    page.set_text(: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(: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
+  
+end

data/tasks/build_gem.rake

@@ -25,19 +25,19 @@ begin
                  '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/page.rb',
+                 'lib/pdf_filler/book.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/lib/pdf_page_spec.rb',
+                 'spec/lib/pdf_book_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.test_files = ['spec/lib/pdf_page_spec.rb',
+                      'spec/lib/pdf_book_spec.rb']    
     
     gem.add_dependency 'rjb', '>= 1.1.7'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gbdev-pdf_filler
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Wes Hays
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-24 00:00:00 -07:00
+date: 2009-08-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,17 +40,18 @@ 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/book.rb
+- lib/pdf_filler/page.rb
 - lib/pdf_filler/util_methods.rb
-- spec/lib/pdf_builder_spec.rb
-- spec/lib/pdf_collection_builder_spec.rb
+- spec/lib/pdf_book_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/gbdev/pdf-filler
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -77,10 +78,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 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
+- spec/lib/pdf_page_spec.rb
+- spec/lib/pdf_book_spec.rb

data/lib/pdf_filler/fill_pdf_collection.rb

@@ -1,79 +0,0 @@
-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

@@ -1,65 +0,0 @@
-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/spec/lib/pdf_builder_spec.rb

@@ -1,60 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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