prawn-fillform 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,30 @@
+# Prawn/Fillform: Fill Text and Images through Acroform Fields
+
+## Install
+
+```bash
+$ gem install prawn-fillform
+```
+
+## Usage
+Create a PDF form with Scribus, Adobe Products or something else. I have only tested this with Scribus.
+Currently only text fields and buttons are supported. Buttons are replaced by images.
+
+
+```ruby
+require 'prawn-fillform'
+
+data = {}
+data[:page_1] = {}
+data[:page_1][:firstname] = "Max"
+data[:page_1][:lastname] = "Mustermann"
+data[:page_1][:photo] = "test.jpg"
+
+# Create a PDF file with predefined data Fields
+Prawn::Document.generate "output.pdf", :template => "template.pdf"  do |pdf|
+  pdf.fill_form_with(data)
+end
+```
+
+Take a look in `examples` folder
+

data/lib/prawn-fillform.rb

@@ -2,121 +2,116 @@ require 'prawn-fillform/version'
 
 module Prawn
   module Fillform
-    def form_fields(page=nil)
-    specifications = acroform_specifications.first
-    if page
-      page_number = "page_#{page}".to_sym
-      page = specifications.fetch(page_number)
-      fields = page.fetch(:fields)
-    else
-      specifications
-    end
-  end
 
-  def fill_form_with(data={})
+    def fill_form_with(data={})
 
-    1.upto(acroform_number_of_pages).each do |page|
-      fields = form_fields(page)
+      1.upto(acroform_number_of_pages).each do |page|
 
-      page_number = "page_#{page}".to_sym
 
-      fields.each do |field|
-        x = field[:x]
-        y = field[:y]
-        value = data[page_number][field.fetch(:name)] rescue nil
-        go_to_page(field[:page_number])
+        page_number = "page_#{page}".to_sym
+        fields = acroform_fields_for(page_number)
+        fields.each do |field|
+          x = field[:x]
+          y = field[:y]
+          value = data[page_number][field.fetch(:name)] rescue nil
+          go_to_page(field[:page_number])
 
-        if field[:type] == :image
-          image value, :at => [x, y], :position => :center, :vposition => :center, :fit => [field[:width], field[:height]] if value
-        else
-          text_box value, :at => [x, y], :align => field[:align],
-                          :width => field[:width], :height => field[:height],
-                          :valign => :center, :align => :left, :single_line => !field[:multi_line], :size => field[:size] if value
+          if field[:type] == :image
+            image value, :at => [x, y], :position => :center, :vposition => :center, :fit => [field[:width], field[:height]] if value
+          else
+            text_box value, :at => [x, y], :align => field[:align],
+                            :width => field[:width], :height => field[:height],
+                            :valign => :center, :align => :left, :single_line => !field[:multi_line], :size => field[:size] if value
+          end
         end
       end
-    end
 
-    # delete acroform references
-    acroform_specifications.last.each do |reference|
-      reference[:acroform_fields].delete(reference[:field])
+      # delete acroform references
+      acroform_specifications.last.each do |reference|
+        reference[:acroform_fields].delete(reference[:field])
+      end
     end
-  end
 
 
-  private
+    private
+      def acroform_fields_for(page)
+        acroform_specifications.first.fetch(page).fetch(:fields)
+      end
 
-    def acroform_number_of_pages
-      acroform_specifications.first.keys.length
-    end
+      def acroform_number_of_pages
+        acroform_specifications.first.keys.length
+      end
 
-    def acroform_field_info(form_fields, field_ref, page)
-
-      field_dict = deref(field_ref)
-
-      field = {}
-
-      field_type = deref(field_dict[:FT])
-
-      field[:name] = deref(field_dict[:T]).to_sym
-      field[:type] = field_type == :Tx ? :text : :image
-      field[:rect] = deref(field_dict[:Rect])
-      field[:x] = field[:rect][0]
-      field[:y] = field[:rect][3]
-      field[:width] = field[:rect][2] - field[:rect][0]
-      field[:height] = field[:rect][3] - field[:rect][1]
-      field[:page_number] = page
-
-      if field[:type] == :text
-        field[:description] = deref(field_dict[:TU])
-        field[:default_value] = deref(field_dict[:DV])
-        field[:value] = deref(field_dict[:V])
-        field[:size] = deref(field_dict[:DA]).split(" ")[1].to_i
-        field[:style] = deref(field_dict[:DA].split(" ")[0])
-        field[:align] = case deref(field_dict[:Q])
-        when 0 then :left
-        when 2 then :center
-        when 4 then :right
+      def acroform_field_info(form_fields, field_ref, page)
+
+        field_dict = deref(field_ref)
+
+        field = {}
+
+        field_type = deref(field_dict[:FT])
+
+        field[:name] = deref(field_dict[:T]).to_sym
+        field[:type] = field_type == :Tx ? :text : :image
+        field[:rect] = deref(field_dict[:Rect])
+        field[:x] = field[:rect][0]
+        field[:y] = field[:rect][3]
+        field[:width] = field[:rect][2] - field[:rect][0]
+        field[:height] = field[:rect][3] - field[:rect][1]
+        field[:page_number] = page
+
+        if field[:type] == :text
+          field[:description] = deref(field_dict[:TU])
+          field[:default_value] = deref(field_dict[:DV])
+          field[:value] = deref(field_dict[:V])
+          field[:size] = deref(field_dict[:DA]).split(" ")[1].to_i
+          field[:style] = deref(field_dict[:DA].split(" ")[0])
+          field[:align] = case deref(field_dict[:Q])
+          when 0 then :left
+          when 2 then :center
+          when 4 then :right
+          end
+          field[:max_length] = deref(field_dict[:MaxLen])
+          field[:multi_line] = deref(field_dict[:Ff]).to_i > 0 ? :true : :false
+          field[:border_width] = deref(field_dict[:BS]).fetch(:W, nil) if deref(field_dict[:BS])
+          field[:border_style] = deref(field_dict[:BS]).fetch(:S, nil) if deref(field_dict[:BS])
+          field[:border_color] = deref(field_dict[:MK]).fetch(:BC, nil) if deref(field_dict[:MK])
+          field[:background_color] = deref(field_dict[:MK]).fetch(:BG, nil) if deref(field_dict[:MK])
         end
-        field[:max_length] = deref(field_dict[:MaxLen])
-        field[:multi_line] = deref(field_dict[:Ff]).to_i > 0 ? :true : :false
-        field[:border_width] = deref(field_dict[:BS]).fetch(:W, nil)
-        field[:border_style] = deref(field_dict[:BS]).fetch(:S, nil)
-        field[:border_color] = deref(field_dict[:MK]).fetch(:BC, nil)
-        field[:background_color] = deref(field_dict[:MK]).fetch(:BG, nil)
+
+        field
+
       end
-      field
-    end
 
-    def acroform_specifications
+      def acroform_specifications
 
-      specifications = {}
-      references = []
+        specifications = {}
+        references = []
 
-      state.pages.each_with_index do |page, i|
-        form_fields = deref(page.dictionary.data[:Annots])
+        state.pages.each_with_index do |page, i|
+          form_fields = deref(page.dictionary.data[:Annots])
 
-        page_number = "page_#{i+1}".to_sym
-        specifications[page_number] = {}
-        specifications[page_number][:fields] = []
+          page_number = "page_#{i+1}".to_sym
+          specifications[page_number] = {}
+          specifications[page_number][:fields] = []
 
-        form_fields.map do |field_ref|
-          field_dict = deref(field_ref)
-          next unless deref(field_dict[:Type]) == :Annot and deref(field_dict[:Subtype]) == :Widget
-          next unless (deref(field_dict[:FT]) == :Tx || deref(field_dict[:FT]) == :Btn)
+          form_fields.map do |field_ref|
+            field_dict = deref(field_ref)
+            next unless deref(field_dict[:Type]) == :Annot and deref(field_dict[:Subtype]) == :Widget
+            next unless (deref(field_dict[:FT]) == :Tx || deref(field_dict[:FT]) == :Btn)
 
-          field = acroform_field_info(form_fields, field_ref, i+1)
-          specifications[page_number][:fields] << field
+            field = acroform_field_info(form_fields, field_ref, i+1)
+            specifications[page_number][:fields] << field
 
-          reference = {}
-          reference[:field] = field_ref
-          reference[:acroform_fields] = form_fields
-          references << reference
+            reference = {}
+            reference[:field] = field_ref
+            reference[:acroform_fields] = form_fields
+            references << reference
+          end
         end
+        [specifications, references]
       end
-      [specifications, references]
-    end
 
-  end
+    end
 end
 
 require 'prawn/document'

data/lib/prawn-fillform/version.rb

@@ -1,6 +1,6 @@
 module Prawn
   module Fillform
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-fillform
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-26 00:00:00.000000000Z
+date: 2011-09-27 00:00:00.000000000Z
 dependencies: []
 description: 
 email:
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - data/template.pdf
 - data/test.jpg