Class: PdfFormFiller::Form

Inherits:
Object
  • Object
show all
Defined in:
lib/pdf_form_filler/form.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Form

Returns a new instance of Form.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/pdf_form_filler/form.rb', line 5

def initialize(options={})
  @template = options[:template]

  @definition_file = options[:definition]
  @definition = YAML.load_file(@definition_file)

  # Work around Prawn bug where using a multi-page template
  # results in 'Error 14' when the generated PDF is opened in
  # Adobe Reader.
  #
  # See: https://github.com/prawnpdf/prawn/issues/364
  @pdf = Prawn::Document.new(:template => @template)
  page_count = @pdf.page_count
  @pdf = Prawn::Document.new(:skip_page_creation => true)
  1.upto(page_count) do |page_number|
    @pdf.start_new_page(:template => @template, :template_page => page_number)
  end

  @pdf.font(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'fonts', 'LiberationSans-Regular.ttf')))

  # x_offset, y_offset is the position of the Prawn origin, as expressed
  # in the co-ordinate system used for the rest of the measurements.
  #
  # In Prawn, x runs left to right, and y runs bottom to top. If either
  # of the axes in your co-ordinate system run opposite to this, set
  # invert_x and/or invert_y to true.

  if @definition['defaults']
    @font_size = @definition['defaults']['font_size'] || 12
    @horizontal_padding = @definition['defaults']['horizontal_padding'] || 5
    @vertical_padding = @definition['defaults']['vertical_padding'] || 1
    @text_align = (@definition['defaults']['text_align'] || :left).to_sym
    @vertical_align = (@definition['defaults']['vertical_align'] || :center).to_sym
  else
    @font_size = 12
    @horizontal_padding = 5
    @vertical_padding = 1
    @text_align = :left
    @vertical_align = :center
  end

end

Instance Method Details

#fill_form(data) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/pdf_form_filler/form.rb', line 48

def fill_form(data)
  1.upto(@pdf.page_count) do |page_number|
    @pdf.go_to_page(page_number)

    if @definition[page_number] && @definition[page_number].respond_to?(:each)
      @definition[page_number].each do |name, box_definition|
        if box_definition.is_a?(Hash)
          box_coords = box_definition['box']
          font_size = box_definition['font_size'] || @font_size
          check_box = box_definition['check_box']

          if check_box
            text_align = :center
            vertical_align = :center
            font_size = box_coords[3]
            horizontal_padding = 0
            vertical_padding = 0
          end

          if box_definition['text_align']
            text_align = box_definition['text_align'].to_sym
          end
          text_align ||= @text_align

          if box_definition['vertical_align']
            vertical_align = box_definition['vertical_align'].to_sym
          end
          vertical_align ||= @vertical_align

          if box_definition['font_size']
            font_size = box_definition['font_size']
          end
          font_size ||= @font_size

          if box_definition['horizontal_padding']
            horizontal_padding = box_definition['horizontal_padding']
          end
          horizontal_padding ||= @horizontal_padding

          if box_definition['vertical_padding']
            vertical_padding = box_definition['vertical_padding']
          end
          vertical_padding ||= @vertical_padding
        else
          box_coords = box_definition
          font_size = @font_size
          text_align = @text_align
          vertical_align = @vertical_align
          horizontal_padding = @horizontal_padding
          vertical_padding = @vertical_padding
        end
        local_box_coords = convert_to_local(box_coords)

        if check_box
          value = (data[name.to_s] || data[name.to_sym]) ? 'X ' : ''
        else
          value = (data[name.to_s] || data[name.to_sym] || '').to_s
        end

        @pdf.font_size(font_size)
        @pdf.fill_color = "000000"
        @pdf.text_box(value,
          :at => [local_box_coords[0] + (horizontal_padding / 2.0), local_box_coords[1] - (vertical_padding / 2.0)],
          :width => local_box_coords[2] - horizontal_padding,
          :height => local_box_coords[3] - vertical_padding,
          :align => text_align,
          :valign => vertical_align
        )
      end
    end

  end
end

#highlight_fields ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/pdf_form_filler/form.rb', line 122

def highlight_fields
  1.upto(@pdf.page_count) do |page_number|
    @pdf.go_to_page(page_number)

    if @definition[page_number] && @definition[page_number].respond_to?(:each)
      @definition[page_number].each do |name, box_definition|
        if box_definition.is_a?(Hash)
          box_coords = box_definition['box']
          font_size = box_definition['font_size'] || @font_size
          check_box = box_definition['check_box']

          if check_box
            text_align = :center
            vertical_align = :center
            font_size = box_coords[3] + 0.5
            horizontal_padding = 0
            vertical_padding = 0
          end

          if box_definition['text_align']
            text_align = box_definition['text_align'].to_sym
          end
          text_align ||= @text_align

          if box_definition['vertical_align']
            vertical_align = box_definition['vertical_align'].to_sym
          end
          vertical_align ||= @vertical_align

          if box_definition['font_size']
            font_size = box_definition['font_size']
          end
          font_size ||= @font_size

          if box_definition['horizontal_padding']
            horizontal_padding = box_definition['horizontal_padding']
          end
          horizontal_padding ||= @horizontal_padding

          if box_definition['vertical_padding']
            vertical_padding = box_definition['vertical_padding']
          end
          vertical_padding ||= @vertical_padding
        else
          box_coords = box_definition
          font_size = @font_size
          text_align = @text_align
          vertical_align = @vertical_align
          horizontal_padding = @horizontal_padding
          vertical_padding = @vertical_padding
        end
        local_box_coords = convert_to_local(box_coords)

        @pdf.fill_color = "ff0000"
        @pdf.transparent(0.5) do
          @pdf.fill_rectangle([local_box_coords[0], local_box_coords[1]], local_box_coords[2], local_box_coords[3])
        end

        @pdf.font_size(font_size)
        @pdf.fill_color = "000000"
        @pdf.text_box(name,
          :at => [local_box_coords[0] + (horizontal_padding / 2.0), local_box_coords[1] - (vertical_padding / 2.0)],
          :width => local_box_coords[2] - horizontal_padding,
          :height => local_box_coords[3] - vertical_padding,
          :align => text_align,
          :valign => vertical_align,
          :overflow => :shrink_to_fit
        )
      end
    end

  end
end

#render ⇒ Object 



200
201
202
 
# File 'lib/pdf_form_filler/form.rb', line 200

def render
  @pdf.render
end

#render_file(output) ⇒ Object 



196
197
198
 
# File 'lib/pdf_form_filler/form.rb', line 196

def render_file(output)
  @pdf.render_file(output)
end