davebenvenuti-prawn 0.11.1.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (291) hide show
  1. data/COPYING +340 -0
  2. data/HACKING +50 -0
  3. data/LICENSE +56 -0
  4. data/README +141 -0
  5. data/Rakefile +52 -0
  6. data/data/encodings/win_ansi.txt +29 -0
  7. data/data/fonts/Action Man.dfont +0 -0
  8. data/data/fonts/Activa.ttf +0 -0
  9. data/data/fonts/Chalkboard.ttf +0 -0
  10. data/data/fonts/Courier-Bold.afm +342 -0
  11. data/data/fonts/Courier-BoldOblique.afm +342 -0
  12. data/data/fonts/Courier-Oblique.afm +342 -0
  13. data/data/fonts/Courier.afm +342 -0
  14. data/data/fonts/DejaVuSans.ttf +0 -0
  15. data/data/fonts/Dustismo_Roman.ttf +0 -0
  16. data/data/fonts/Helvetica-Bold.afm +2827 -0
  17. data/data/fonts/Helvetica-BoldOblique.afm +2827 -0
  18. data/data/fonts/Helvetica-Oblique.afm +3051 -0
  19. data/data/fonts/Helvetica.afm +3051 -0
  20. data/data/fonts/MustRead.html +19 -0
  21. data/data/fonts/Symbol.afm +213 -0
  22. data/data/fonts/Times-Bold.afm +2588 -0
  23. data/data/fonts/Times-BoldItalic.afm +2384 -0
  24. data/data/fonts/Times-Italic.afm +2667 -0
  25. data/data/fonts/Times-Roman.afm +2419 -0
  26. data/data/fonts/ZapfDingbats.afm +225 -0
  27. data/data/fonts/comicsans.ttf +0 -0
  28. data/data/fonts/gkai00mp.ttf +0 -0
  29. data/data/images/16bit.alpha +0 -0
  30. data/data/images/16bit.dat +0 -0
  31. data/data/images/16bit.png +0 -0
  32. data/data/images/arrow.png +0 -0
  33. data/data/images/arrow2.png +0 -0
  34. data/data/images/barcode_issue.png +0 -0
  35. data/data/images/dice.alpha +0 -0
  36. data/data/images/dice.dat +0 -0
  37. data/data/images/dice.png +0 -0
  38. data/data/images/dice_interlaced.png +0 -0
  39. data/data/images/fractal.jpg +0 -0
  40. data/data/images/letterhead.jpg +0 -0
  41. data/data/images/page_white_text.alpha +0 -0
  42. data/data/images/page_white_text.dat +0 -0
  43. data/data/images/page_white_text.png +0 -0
  44. data/data/images/pigs.jpg +0 -0
  45. data/data/images/rails.dat +0 -0
  46. data/data/images/rails.png +0 -0
  47. data/data/images/ruport.png +0 -0
  48. data/data/images/ruport_data.dat +0 -0
  49. data/data/images/ruport_transparent.png +0 -0
  50. data/data/images/ruport_type0.png +0 -0
  51. data/data/images/stef.jpg +0 -0
  52. data/data/images/tru256.bmp +0 -0
  53. data/data/images/web-links.dat +1 -0
  54. data/data/images/web-links.png +0 -0
  55. data/data/pdfs/complex_template.pdf +0 -0
  56. data/data/pdfs/contains_ttf_font.pdf +0 -0
  57. data/data/pdfs/encrypted.pdf +0 -0
  58. data/data/pdfs/hexagon.pdf +61 -0
  59. data/data/pdfs/indirect_reference.pdf +86 -0
  60. data/data/pdfs/nested_pages.pdf +118 -0
  61. data/data/pdfs/page_without_mediabox.pdf +193 -0
  62. data/data/pdfs/resources_as_indirect_object.pdf +83 -0
  63. data/data/pdfs/two_hexagons.pdf +90 -0
  64. data/data/pdfs/version_1_6.pdf +61 -0
  65. data/data/shift_jis_text.txt +1 -0
  66. data/examples/bounding_box/bounding_boxes.rb +44 -0
  67. data/examples/bounding_box/indentation.rb +35 -0
  68. data/examples/bounding_box/russian_boxes.rb +37 -0
  69. data/examples/bounding_box/stretched_nesting.rb +68 -0
  70. data/examples/example_helper.rb +8 -0
  71. data/examples/general/background.rb +24 -0
  72. data/examples/general/canvas.rb +16 -0
  73. data/examples/general/context_sensitive_headers.rb +38 -0
  74. data/examples/general/float.rb +12 -0
  75. data/examples/general/margin.rb +37 -0
  76. data/examples/general/measurement_units.rb +52 -0
  77. data/examples/general/metadata-info.rb +17 -0
  78. data/examples/general/multi_page_layout.rb +19 -0
  79. data/examples/general/outlines.rb +67 -0
  80. data/examples/general/page_geometry.rb +32 -0
  81. data/examples/general/page_numbering.rb +16 -0
  82. data/examples/general/repeaters.rb +48 -0
  83. data/examples/general/stamp.rb +42 -0
  84. data/examples/general/templates.rb +14 -0
  85. data/examples/graphics/basic_images.rb +24 -0
  86. data/examples/graphics/cmyk.rb +13 -0
  87. data/examples/graphics/curves.rb +12 -0
  88. data/examples/graphics/hexagon.rb +14 -0
  89. data/examples/graphics/image_fit.rb +16 -0
  90. data/examples/graphics/image_flow.rb +38 -0
  91. data/examples/graphics/image_position.rb +18 -0
  92. data/examples/graphics/line.rb +33 -0
  93. data/examples/graphics/png_types.rb +23 -0
  94. data/examples/graphics/polygons.rb +17 -0
  95. data/examples/graphics/remote_images.rb +13 -0
  96. data/examples/graphics/rounded_polygons.rb +20 -0
  97. data/examples/graphics/rounded_rectangle.rb +21 -0
  98. data/examples/graphics/ruport_style_helpers.rb +20 -0
  99. data/examples/graphics/stroke_bounds.rb +21 -0
  100. data/examples/graphics/stroke_cap_and_join.rb +46 -0
  101. data/examples/graphics/stroke_dash.rb +43 -0
  102. data/examples/graphics/transformations.rb +53 -0
  103. data/examples/graphics/transparency.rb +27 -0
  104. data/examples/grid/bounding_boxes.rb +22 -0
  105. data/examples/grid/column_gutter_grid.rb +21 -0
  106. data/examples/grid/multi_boxes.rb +52 -0
  107. data/examples/grid/show_grid.rb +14 -0
  108. data/examples/grid/simple_grid.rb +21 -0
  109. data/examples/m17n/chinese_text_wrapping.rb +18 -0
  110. data/examples/m17n/euro.rb +16 -0
  111. data/examples/m17n/sjis.rb +29 -0
  112. data/examples/m17n/utf8.rb +14 -0
  113. data/examples/m17n/win_ansi_charset.rb +55 -0
  114. data/examples/security/hello_foo.rb +9 -0
  115. data/examples/table/bill.rb +54 -0
  116. data/examples/table/cell.rb +13 -0
  117. data/examples/table/checkerboard.rb +23 -0
  118. data/examples/table/header.rb +15 -0
  119. data/examples/table/inline_format_table.rb +13 -0
  120. data/examples/table/multi_page_table.rb +10 -0
  121. data/examples/table/simple_table.rb +25 -0
  122. data/examples/table/subtable.rb +13 -0
  123. data/examples/table/widths.rb +21 -0
  124. data/examples/text/alignment.rb +19 -0
  125. data/examples/text/character_spacing.rb +13 -0
  126. data/examples/text/dfont.rb +49 -0
  127. data/examples/text/family_based_styling.rb +25 -0
  128. data/examples/text/font_calculations.rb +92 -0
  129. data/examples/text/font_size.rb +34 -0
  130. data/examples/text/hyphenation.rb +46 -0
  131. data/examples/text/indent_paragraphs.rb +23 -0
  132. data/examples/text/inline_format.rb +104 -0
  133. data/examples/text/kerning.rb +31 -0
  134. data/examples/text/rotated.rb +99 -0
  135. data/examples/text/shaped_text_box.rb +32 -0
  136. data/examples/text/simple_text.rb +18 -0
  137. data/examples/text/simple_text_ttf.rb +18 -0
  138. data/examples/text/span.rb +30 -0
  139. data/examples/text/text_box.rb +89 -0
  140. data/examples/text/text_box_returning_excess.rb +52 -0
  141. data/examples/text/text_flow.rb +68 -0
  142. data/lib/prawn.rb +26 -0
  143. data/lib/prawn/compatibility.rb +51 -0
  144. data/lib/prawn/core.rb +85 -0
  145. data/lib/prawn/core/annotations.rb +61 -0
  146. data/lib/prawn/core/byte_string.rb +9 -0
  147. data/lib/prawn/core/destinations.rb +90 -0
  148. data/lib/prawn/core/document_state.rb +78 -0
  149. data/lib/prawn/core/literal_string.rb +16 -0
  150. data/lib/prawn/core/name_tree.rb +165 -0
  151. data/lib/prawn/core/object_store.rb +236 -0
  152. data/lib/prawn/core/page.rb +199 -0
  153. data/lib/prawn/core/pdf_object.rb +108 -0
  154. data/lib/prawn/core/reference.rb +112 -0
  155. data/lib/prawn/core/text.rb +140 -0
  156. data/lib/prawn/core/text/formatted/arranger.rb +266 -0
  157. data/lib/prawn/core/text/formatted/line_wrap.rb +127 -0
  158. data/lib/prawn/core/text/formatted/wrap.rb +112 -0
  159. data/lib/prawn/core/text/line_wrap.rb +211 -0
  160. data/lib/prawn/core/text/wrap.rb +82 -0
  161. data/lib/prawn/document.rb +575 -0
  162. data/lib/prawn/document/bounding_box.rb +428 -0
  163. data/lib/prawn/document/graphics_state.rb +48 -0
  164. data/lib/prawn/document/internals.rb +170 -0
  165. data/lib/prawn/document/page_geometry.rb +136 -0
  166. data/lib/prawn/document/snapshot.rb +87 -0
  167. data/lib/prawn/document/span.rb +55 -0
  168. data/lib/prawn/encoding.rb +121 -0
  169. data/lib/prawn/errors.rb +86 -0
  170. data/lib/prawn/font.rb +368 -0
  171. data/lib/prawn/font/afm.rb +225 -0
  172. data/lib/prawn/font/dfont.rb +42 -0
  173. data/lib/prawn/font/ttf.rb +350 -0
  174. data/lib/prawn/graphics.rb +325 -0
  175. data/lib/prawn/graphics/cap_style.rb +38 -0
  176. data/lib/prawn/graphics/color.rb +205 -0
  177. data/lib/prawn/graphics/dash.rb +71 -0
  178. data/lib/prawn/graphics/join_style.rb +38 -0
  179. data/lib/prawn/graphics/transformation.rb +156 -0
  180. data/lib/prawn/graphics/transparency.rb +99 -0
  181. data/lib/prawn/images.rb +217 -0
  182. data/lib/prawn/images/jpg.rb +85 -0
  183. data/lib/prawn/images/png.rb +356 -0
  184. data/lib/prawn/layout.rb +20 -0
  185. data/lib/prawn/layout/grid.rb +259 -0
  186. data/lib/prawn/measurement_extensions.rb +46 -0
  187. data/lib/prawn/measurements.rb +71 -0
  188. data/lib/prawn/outline.rb +326 -0
  189. data/lib/prawn/repeater.rb +129 -0
  190. data/lib/prawn/security.rb +262 -0
  191. data/lib/prawn/security/arcfour.rb +51 -0
  192. data/lib/prawn/stamp.rb +126 -0
  193. data/lib/prawn/table.rb +451 -0
  194. data/lib/prawn/table/cell.rb +395 -0
  195. data/lib/prawn/table/cell/in_table.rb +27 -0
  196. data/lib/prawn/table/cell/subtable.rb +65 -0
  197. data/lib/prawn/table/cell/text.rb +135 -0
  198. data/lib/prawn/table/cells.rb +206 -0
  199. data/lib/prawn/text.rb +449 -0
  200. data/lib/prawn/text/box.rb +397 -0
  201. data/lib/prawn/text/formatted.rb +4 -0
  202. data/lib/prawn/text/formatted/box.rb +222 -0
  203. data/lib/prawn/text/formatted/fragment.rb +181 -0
  204. data/lib/prawn/text/formatted/parser.rb +213 -0
  205. data/prawn.gemspec +28 -0
  206. data/spec/annotations_spec.rb +90 -0
  207. data/spec/bounding_box_spec.rb +190 -0
  208. data/spec/cell_spec.rb +430 -0
  209. data/spec/destinations_spec.rb +15 -0
  210. data/spec/document_spec.rb +476 -0
  211. data/spec/extensions/mocha.rb +32 -0
  212. data/spec/font_spec.rb +324 -0
  213. data/spec/formatted_text_arranger_spec.rb +426 -0
  214. data/spec/formatted_text_box_spec.rb +756 -0
  215. data/spec/formatted_text_fragment_spec.rb +211 -0
  216. data/spec/graphics_spec.rb +446 -0
  217. data/spec/grid_spec.rb +85 -0
  218. data/spec/images_spec.rb +119 -0
  219. data/spec/inline_formatted_text_parser_spec.rb +502 -0
  220. data/spec/jpg_spec.rb +25 -0
  221. data/spec/line_wrap_spec.rb +341 -0
  222. data/spec/measurement_units_spec.rb +23 -0
  223. data/spec/name_tree_spec.rb +112 -0
  224. data/spec/object_store_spec.rb +160 -0
  225. data/spec/outline_spec.rb +404 -0
  226. data/spec/pdf_object_spec.rb +170 -0
  227. data/spec/png_spec.rb +237 -0
  228. data/spec/reference_spec.rb +82 -0
  229. data/spec/repeater_spec.rb +96 -0
  230. data/spec/security_spec.rb +120 -0
  231. data/spec/snapshot_spec.rb +154 -0
  232. data/spec/span_spec.rb +49 -0
  233. data/spec/spec_helper.rb +34 -0
  234. data/spec/stamp_spec.rb +108 -0
  235. data/spec/stroke_styles_spec.rb +163 -0
  236. data/spec/table_spec.rb +687 -0
  237. data/spec/template_spec.rb +165 -0
  238. data/spec/text_at_spec.rb +125 -0
  239. data/spec/text_box_spec.rb +777 -0
  240. data/spec/text_spacing_spec.rb +75 -0
  241. data/spec/text_spec.rb +349 -0
  242. data/spec/text_with_inline_formatting_spec.rb +193 -0
  243. data/spec/transparency_spec.rb +89 -0
  244. data/vendor/pdf-inspector/README +18 -0
  245. data/vendor/pdf-inspector/lib/pdf/inspector.rb +26 -0
  246. data/vendor/pdf-inspector/lib/pdf/inspector/extgstate.rb +18 -0
  247. data/vendor/pdf-inspector/lib/pdf/inspector/graphics.rb +131 -0
  248. data/vendor/pdf-inspector/lib/pdf/inspector/page.rb +25 -0
  249. data/vendor/pdf-inspector/lib/pdf/inspector/text.rb +46 -0
  250. data/vendor/pdf-inspector/lib/pdf/inspector/xobject.rb +19 -0
  251. data/vendor/ttfunk/data/fonts/DejaVuSans.ttf +0 -0
  252. data/vendor/ttfunk/data/fonts/comicsans.ttf +0 -0
  253. data/vendor/ttfunk/example.rb +45 -0
  254. data/vendor/ttfunk/lib/ttfunk.rb +102 -0
  255. data/vendor/ttfunk/lib/ttfunk/directory.rb +17 -0
  256. data/vendor/ttfunk/lib/ttfunk/encoding/mac_roman.rb +88 -0
  257. data/vendor/ttfunk/lib/ttfunk/encoding/windows_1252.rb +69 -0
  258. data/vendor/ttfunk/lib/ttfunk/reader.rb +44 -0
  259. data/vendor/ttfunk/lib/ttfunk/resource_file.rb +78 -0
  260. data/vendor/ttfunk/lib/ttfunk/subset.rb +18 -0
  261. data/vendor/ttfunk/lib/ttfunk/subset/base.rb +141 -0
  262. data/vendor/ttfunk/lib/ttfunk/subset/mac_roman.rb +50 -0
  263. data/vendor/ttfunk/lib/ttfunk/subset/unicode.rb +48 -0
  264. data/vendor/ttfunk/lib/ttfunk/subset/unicode_8bit.rb +63 -0
  265. data/vendor/ttfunk/lib/ttfunk/subset/windows_1252.rb +55 -0
  266. data/vendor/ttfunk/lib/ttfunk/subset_collection.rb +72 -0
  267. data/vendor/ttfunk/lib/ttfunk/table.rb +46 -0
  268. data/vendor/ttfunk/lib/ttfunk/table/cmap.rb +34 -0
  269. data/vendor/ttfunk/lib/ttfunk/table/cmap/format00.rb +54 -0
  270. data/vendor/ttfunk/lib/ttfunk/table/cmap/format04.rb +126 -0
  271. data/vendor/ttfunk/lib/ttfunk/table/cmap/subtable.rb +79 -0
  272. data/vendor/ttfunk/lib/ttfunk/table/glyf.rb +64 -0
  273. data/vendor/ttfunk/lib/ttfunk/table/glyf/compound.rb +81 -0
  274. data/vendor/ttfunk/lib/ttfunk/table/glyf/simple.rb +37 -0
  275. data/vendor/ttfunk/lib/ttfunk/table/head.rb +44 -0
  276. data/vendor/ttfunk/lib/ttfunk/table/hhea.rb +41 -0
  277. data/vendor/ttfunk/lib/ttfunk/table/hmtx.rb +47 -0
  278. data/vendor/ttfunk/lib/ttfunk/table/kern.rb +79 -0
  279. data/vendor/ttfunk/lib/ttfunk/table/kern/format0.rb +62 -0
  280. data/vendor/ttfunk/lib/ttfunk/table/loca.rb +43 -0
  281. data/vendor/ttfunk/lib/ttfunk/table/maxp.rb +40 -0
  282. data/vendor/ttfunk/lib/ttfunk/table/name.rb +125 -0
  283. data/vendor/ttfunk/lib/ttfunk/table/os2.rb +78 -0
  284. data/vendor/ttfunk/lib/ttfunk/table/post.rb +91 -0
  285. data/vendor/ttfunk/lib/ttfunk/table/post/format10.rb +43 -0
  286. data/vendor/ttfunk/lib/ttfunk/table/post/format20.rb +35 -0
  287. data/vendor/ttfunk/lib/ttfunk/table/post/format25.rb +23 -0
  288. data/vendor/ttfunk/lib/ttfunk/table/post/format30.rb +17 -0
  289. data/vendor/ttfunk/lib/ttfunk/table/post/format40.rb +17 -0
  290. data/vendor/ttfunk/lib/ttfunk/table/simple.rb +14 -0
  291. metadata +379 -0
@@ -0,0 +1,259 @@
1
+ module Prawn
2
+ class Document
3
+
4
+ # Defines the grid system for a particular document. Takes the number of
5
+ # rows and columns and the width to use for the gutter as the
6
+ # keys :rows, :columns, :gutter, :row_gutter, :column_gutter
7
+ #
8
+ def define_grid(options = {})
9
+ @grid = Grid.new(self, options)
10
+ end
11
+
12
+ # A method that can either be used to access a particular grid on the page
13
+ # or work with the grid system directly.
14
+ #
15
+ # @pdf.grid # Get the Grid directly
16
+ # @pdf.grid([0,1]) # Get the box at [0,1]
17
+ # @pdf.grid([0,1], [1,2]) # Get a multi-box spanning from [0,1] to [1,2]
18
+ #
19
+ def grid(*args)
20
+ @boxes ||= {}
21
+ @boxes[args] ||= if args.empty?
22
+ @grid
23
+ else
24
+ g1, g2 = args
25
+ if(g1.class == Array && g2.class == Array &&
26
+ g1.length == 2 && g2.length == 2)
27
+ multi_box(single_box(*g1), single_box(*g2))
28
+ else
29
+ single_box(g1, g2)
30
+ end
31
+ end
32
+ end
33
+
34
+ # A Grid represents the entire grid system of a Page and calculates
35
+ # the column width and row height of the base box.
36
+ class Grid
37
+ attr_reader :pdf, :columns, :rows, :gutter, :row_gutter, :column_gutter
38
+ def initialize(pdf, options = {}) # :nodoc:
39
+ valid_options = [:columns, :rows, :gutter, :row_gutter, :column_gutter]
40
+ Prawn.verify_options valid_options, options
41
+
42
+ @pdf = pdf
43
+ @columns = options[:columns]
44
+ @rows = options[:rows]
45
+ set_gutter(options)
46
+ end
47
+
48
+ # Calculates the base width of boxes.
49
+ def column_width
50
+ @column_width ||= subdivide(pdf.bounds.width, columns, column_gutter)
51
+ end
52
+
53
+ # Calculates the base height of boxes.
54
+ def row_height
55
+ @row_height ||= subdivide(pdf.bounds.height, rows, row_gutter)
56
+ end
57
+
58
+ # Diagnostic tool to show all of the grids. Defaults to gray.
59
+ def show_all(color = "CCCCCC")
60
+ self.rows.times do |i|
61
+ self.columns.times do |j|
62
+ pdf.grid(i,j).show(color)
63
+ end
64
+ end
65
+ end
66
+
67
+ private
68
+
69
+ def subdivide(total, num, gutter)
70
+ (total.to_f - (gutter * (num - 1).to_f)) / num.to_f
71
+ end
72
+
73
+ def set_gutter(options)
74
+ if options.has_key?(:gutter)
75
+ @gutter = options[:gutter].to_f
76
+ @row_gutter, @column_gutter = @gutter, @gutter
77
+ else
78
+ @row_gutter = options[:row_gutter].to_f
79
+ @column_gutter = options[:column_gutter].to_f
80
+ @gutter = 0
81
+ end
82
+ end
83
+ end
84
+
85
+ # A Box is a class that represents a bounded area of a page.
86
+ # A Grid object has methods that allow easy access to the coordinates of
87
+ # its corners, which can be plugged into most existing prawnmethods.
88
+ #
89
+ class Box #:nodoc:
90
+ attr_reader :pdf
91
+
92
+ def initialize(pdf, i, j)
93
+ @pdf = pdf
94
+ @i = i
95
+ @j = j
96
+ end
97
+
98
+ # Mostly diagnostic method that outputs the name of a box as
99
+ # col_num, row_num
100
+ #
101
+ def name
102
+ "#{@i.to_s},#{@j.to_s}"
103
+ end
104
+
105
+ # :nodoc
106
+ def total_height
107
+ pdf.bounds.height.to_f
108
+ end
109
+
110
+ # Width of a box
111
+ def width
112
+ grid.column_width.to_f
113
+ end
114
+
115
+ # Height of a box
116
+ def height
117
+ grid.row_height.to_f
118
+ end
119
+
120
+ # Width of the gutter
121
+ def gutter
122
+ grid.gutter.to_f
123
+ end
124
+
125
+ # x-coordinate of left side
126
+ def left
127
+ @left ||= (width + grid.column_gutter) * @j.to_f
128
+ end
129
+
130
+ # x-coordinate of right side
131
+ def right
132
+ @right ||= left + width
133
+ end
134
+
135
+ # y-coordinate of the top
136
+ def top
137
+ @top ||= total_height - ((height + grid.row_gutter) * @i.to_f)
138
+ end
139
+
140
+ # y-coordinate of the bottom
141
+ def bottom
142
+ @bottom ||= top - height
143
+ end
144
+
145
+ # x,y coordinates of top left corner
146
+ def top_left
147
+ [left, top]
148
+ end
149
+
150
+ # x,y coordinates of top right corner
151
+ def top_right
152
+ [right, top]
153
+ end
154
+
155
+ # x,y coordinates of bottom left corner
156
+ def bottom_left
157
+ [left, bottom]
158
+ end
159
+
160
+ # x,y coordinates of bottom right corner
161
+ def bottom_right
162
+ [right, bottom]
163
+ end
164
+
165
+ # Creates a standard bounding box based on the grid box.
166
+ def bounding_box(&blk)
167
+ pdf.bounding_box(top_left, :width => width, :height => height, &blk)
168
+ end
169
+
170
+ # Diagnostic method
171
+ def show(grid_color = "CCCCCC")
172
+ self.bounding_box do
173
+ original_stroke_color = pdf.stroke_color
174
+
175
+ pdf.stroke_color = grid_color
176
+ pdf.text self.name
177
+ pdf.stroke_bounds
178
+
179
+ pdf.stroke_color = original_stroke_color
180
+ end
181
+ end
182
+
183
+ private
184
+ def grid
185
+ pdf.grid
186
+ end
187
+ end
188
+
189
+ # A MultiBox is specified by 2 Boxes and spans the areas between.
190
+ class MultiBox < Box #:nodoc:
191
+ def initialize(pdf, b1, b2)
192
+ @pdf = pdf
193
+ @bs = [b1, b2]
194
+ end
195
+
196
+ def name
197
+ @bs.map {|b| b.name}.join(":")
198
+ end
199
+
200
+ def total_height
201
+ @bs[0].total_height
202
+ end
203
+
204
+ def width
205
+ right_box.right - left_box.left
206
+ end
207
+
208
+ def height
209
+ top_box.top - bottom_box.bottom
210
+ end
211
+
212
+ def gutter
213
+ @bs[0].gutter
214
+ end
215
+
216
+ def left
217
+ left_box.left
218
+ end
219
+
220
+ def right
221
+ right_box.right
222
+ end
223
+
224
+ def top
225
+ top_box.top
226
+ end
227
+
228
+ def bottom
229
+ bottom_box.bottom
230
+ end
231
+
232
+ private
233
+ def left_box
234
+ @left_box ||= @bs.min {|a,b| a.left <=> b.left}
235
+ end
236
+
237
+ def right_box
238
+ @right_box ||= @bs.max {|a,b| a.right <=> b.right}
239
+ end
240
+
241
+ def top_box
242
+ @top_box ||= @bs.max {|a,b| a.top <=> b.top}
243
+ end
244
+
245
+ def bottom_box
246
+ @bottom_box ||= @bs.min {|a,b| a.bottom <=> b.bottom}
247
+ end
248
+ end
249
+
250
+ private
251
+ def single_box(i, j)
252
+ Box.new(self, i, j)
253
+ end
254
+
255
+ def multi_box(b1, b2)
256
+ MultiBox.new(self, b1, b2)
257
+ end
258
+ end
259
+ end
@@ -0,0 +1,46 @@
1
+ # encoding: utf-8
2
+ # measurement_extensions.rb: Core extensions for Prawn::Measurements
3
+ #
4
+ # Copyright December 2008, Florian Witteler. All Rights Reserved.
5
+ #
6
+ # This is free software. Please see the LICENSE and COPYING files for details.
7
+
8
+ require 'prawn/measurements'
9
+
10
+ class Numeric
11
+ include Prawn::Measurements
12
+ # prawns' basic unit is PostScript-Point
13
+ # 72 points per inch
14
+
15
+ def mm
16
+ return mm2pt(self)
17
+ end
18
+
19
+ def cm
20
+ return cm2pt(self)
21
+ end
22
+
23
+ def dm
24
+ return dm2pt(self)
25
+ end
26
+
27
+ def m
28
+ return m2pt(self)
29
+ end
30
+
31
+ def in
32
+ return in2pt(self)
33
+ end
34
+
35
+ def yd
36
+ return yd2pt(self)
37
+ end
38
+
39
+ def ft
40
+ return ft2pt(self)
41
+ end
42
+
43
+ def pt
44
+ return self
45
+ end
46
+ end
@@ -0,0 +1,71 @@
1
+ # encoding: utf-8
2
+ # measurements.rb: Conversions from other measurements to PDF points
3
+ #
4
+ # Copyright December 2008, Florian Witteler. All Rights Reserved.
5
+ #
6
+ module Prawn
7
+ module Measurements
8
+
9
+ # ============================================================================
10
+ #metric conversions
11
+ def cm2mm(cm)
12
+ return cm*10
13
+ end
14
+
15
+ def dm2mm(dm)
16
+ return dm*100
17
+ end
18
+
19
+ def m2mm(m)
20
+ return m*1000
21
+ end
22
+
23
+ # ============================================================================
24
+ # imperial conversions
25
+ # from http://en.wikipedia.org/wiki/Imperial_units
26
+
27
+ def ft2in(ft)
28
+ return ft * 12
29
+ end
30
+
31
+ def yd2in(yd)
32
+ return yd*36
33
+ end
34
+
35
+
36
+ # ============================================================================
37
+ # PostscriptPoint-converisons
38
+
39
+ def in2pt(inch)
40
+ return inch * 72
41
+ end
42
+
43
+ def ft2pt(ft)
44
+ return in2pt(ft2in(ft))
45
+ end
46
+
47
+ def yd2pt(yd)
48
+ return in2pt(yd2in(yd))
49
+ end
50
+
51
+ def mm2pt(mm)
52
+ return mm*(72 / 25.4)
53
+ end
54
+
55
+ def cm2pt(cm)
56
+ return mm2pt(cm2mm(cm))
57
+ end
58
+
59
+ def dm2pt(dm)
60
+ return mm2pt(dm2mm(dm))
61
+ end
62
+
63
+ def m2pt(m)
64
+ return mm2pt(m2mm(m))
65
+ end
66
+
67
+ def pt2mm(pt)
68
+ return pt * 1 / mm2pt(1)# (25.4 / 72)
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,326 @@
1
+ # encoding: utf-8
2
+ #
3
+ # generates outline dictionary and items for document
4
+ #
5
+ # Author Jonathan Greenberg
6
+
7
+ require 'forwardable'
8
+
9
+ module Prawn
10
+
11
+ class Document
12
+
13
+ # Lazily instantiates an Outline object for document. This is used as point of entry
14
+ # to methods to build the outline tree.
15
+ def outline
16
+ @outline ||= Outline.new(self)
17
+ end
18
+
19
+ end
20
+
21
+ # The Outline class organizes the outline tree items for the document.
22
+ # Note that the prev and parent instance variables are adjusted while navigating
23
+ # through the nested blocks. These variables along with the presence or absense
24
+ # of blocks are the primary means by which the relations for the various
25
+ # OutlineItems and the OutlineRoot are set. Unfortunately, the best way to
26
+ # understand how this works is to follow the method calls through a real example.
27
+ #
28
+ # Some ideas for the organization of this class were gleaned from name_tree. In
29
+ # particular the way in which the OutlineItems are finally rendered into document
30
+ # objects in PdfObject through a hash.
31
+ #
32
+ class Outline
33
+
34
+ extend Forwardable
35
+ def_delegator :@document, :page_number
36
+
37
+ attr_accessor :parent
38
+ attr_accessor :prev
39
+ attr_accessor :document
40
+ attr_accessor :items
41
+
42
+ def initialize(document)
43
+ @document = document
44
+ @parent = root
45
+ @prev = nil
46
+ @items = {}
47
+ end
48
+
49
+ # Defines/Updates an outline for the document.
50
+ # The outline is an optional nested index that appears on the side of a PDF
51
+ # document usually with direct links to pages. The outline DSL is defined by nested
52
+ # blocks involving two methods: section and page; see the documentation on those methods
53
+ # for their arguments and options. Note that one can also use outline#update
54
+ # to add more sections to the end of the outline tree using the same syntax and scope.
55
+ #
56
+ # The syntax is best illustrated with an example:
57
+ #
58
+ # Prawn::Document.generate(outlined_document.pdf) do
59
+ # text "Page 1. This is the first Chapter. "
60
+ # start_new_page
61
+ # text "Page 2. More in the first Chapter. "
62
+ # start_new_page
63
+ # outline.define do
64
+ # section 'Chapter 1', :destination => 1, :closed => true do
65
+ # page :destination => 1, :title => 'Page 1'
66
+ # page :destination => 2, :title => 'Page 2'
67
+ # end
68
+ # end
69
+ # start_new_page do
70
+ # outline.update do
71
+ # section 'Chapter 2', :destination => 2, do
72
+ # page :destination => 3, :title => 'Page 3'
73
+ # end
74
+ # end
75
+ # end
76
+ #
77
+ def define(&block)
78
+ instance_eval(&block) if block
79
+ end
80
+
81
+ alias :update :define
82
+
83
+ # Inserts an outline section to the outline tree (see outline#define).
84
+ # Although you will probably choose to exclusively use outline#define so
85
+ # that your outline tree is contained and easy to manage, this method
86
+ # gives you the option to insert sections to the outline tree at any point
87
+ # during document generation. This method allows you to add a child subsection
88
+ # to any other item at any level in the outline tree.
89
+ # Currently the only way to locate the place of entry is with the title for the
90
+ # item. If your title names are not unique consider using define_outline.
91
+ # The method takes the following arguments:
92
+ # title: a string that must match an outline title to add the subsection to
93
+ # position: either :first or :last(the default) where the subsection will be placed relative
94
+ # to other child elements. If you need to position your subsection in between
95
+ # other elements then consider using #insert_section_after
96
+ # block: uses the same DSL syntax as outline#define, for example:
97
+ #
98
+ # Consider using this method inside of outline.update if you want to have the outline object
99
+ # to be scoped as self (see #insert_section_after example).
100
+ #
101
+ # go_to_page 2
102
+ # start_new_page
103
+ # text "Inserted Page"
104
+ # outline.add_subsection_to :title => 'Page 2', :first do
105
+ # outline.page :destination => page_number, :title => "Inserted Page"
106
+ # end
107
+ #
108
+ def add_subsection_to(title, position = :last, &block)
109
+ @parent = items[title]
110
+ raise Prawn::Errors::UnknownOutlineTitle,
111
+ "\n No outline item with title: '#{title}' exists in the outline tree" unless @parent
112
+ @prev = position == :first ? nil : @parent.data.last
113
+ nxt = position == :first ? @parent.data.first : nil
114
+ insert_section(nxt, &block)
115
+ end
116
+
117
+ # Inserts an outline section to the outline tree (see outline#define).
118
+ # Although you will probably choose to exclusively use outline#define so
119
+ # that your outline tree is contained and easy to manage, this method
120
+ # gives you the option to insert sections to the outline tree at any point
121
+ # during document generation. Unlike outline.add_section, this method allows
122
+ # you to enter a section after any other item at any level in the outline tree.
123
+ # Currently the only way to locate the place of entry is with the title for the
124
+ # item. If your title names are not unique consider using define_outline.
125
+ # The method takes the following arguments:
126
+ # title: the title of other section or page to insert new section after
127
+ # block: uses the same DSL syntax as outline#define, for example:
128
+ #
129
+ # go_to_page 2
130
+ # start_new_page
131
+ # text "Inserted Page"
132
+ # update_outline do
133
+ # insert_section_after :title => 'Page 2' do
134
+ # page :destination => page_number, :title => "Inserted Page"
135
+ # end
136
+ # end
137
+ #
138
+ def insert_section_after(title, &block)
139
+ @prev = items[title]
140
+ raise Prawn::Errors::UnknownOutlineTitle,
141
+ "\n No outline item with title: '#{title}' exists in the outline tree" unless @prev
142
+ @parent = @prev.data.parent
143
+ nxt = @prev.data.next
144
+ insert_section(nxt, &block)
145
+ end
146
+
147
+ # See outline#define above for documentation on how this is used in that context
148
+ #
149
+ # Adds an outine section to the outline tree.
150
+ # Although you will probably choose to exclusively use outline#define so
151
+ # that your outline tree is contained and easy to manage, this method
152
+ # gives you the option to add sections to the outline tree at any point
153
+ # during document generation. When not being called from within another #section block
154
+ # the section will be added at the top level after the other root elements of the outline.
155
+ # For more flexible placement try using outline#insert_section_after and/or
156
+ # outline#add_subsection_to
157
+ # Takes the following arguments:
158
+ # title: the outline text that appears for the section.
159
+ # options: destination - optional integer defining the page number for a destination link.
160
+ # - currently only :FIT destination supported with link to top of page.
161
+ # closed - whether the section should show its nested outline elements.
162
+ # - defaults to false.
163
+ # block: more nested subsections and/or page blocks
164
+ #
165
+ # example usage:
166
+ #
167
+ # outline.section 'Added Section', :destination => 3 do
168
+ # outline.page :destionation => 3, :title => 'Page 3'
169
+ # end
170
+ def section(title, options = {}, &block)
171
+ add_outline_item(title, options, &block)
172
+ end
173
+
174
+ # See Outline#define above for more documentation on how it is used in that context
175
+ #
176
+ # Adds a page to the outline.
177
+ # Although you will probably choose to exclusively use outline#define so
178
+ # that your outline tree is contained and easy to manage, this method also
179
+ # gives you the option to add pages to the root of outline tree at any point
180
+ # during document generation. Note that the page will be added at the
181
+ # top level after the other root outline elements. For more flexible placement try
182
+ # using outline#insert_section_after and/or outline#add_subsection_to.
183
+ #
184
+ # Takes the following arguments:
185
+ # options:
186
+ # title - REQUIRED. The outline text that appears for the page.
187
+ # destination - integer defining the page number for the destination link.
188
+ # currently only :FIT destination supported with link to top of page.
189
+ # closed - whether the section should show its nested outline elements.
190
+ # - defaults to false.
191
+ # example usage:
192
+ #
193
+ # outline.page :title => "Very Last Page"
194
+ # Note: this method is almost identical to section except that it does not accept a block
195
+ # thereby defining the outline item as a leaf on the outline tree structure.
196
+ def page(options = {})
197
+ if options[:title]
198
+ title = options[:title]
199
+ else
200
+ raise Prawn::Errors::RequiredOption,
201
+ "\nTitle is a required option for page"
202
+ end
203
+ add_outline_item(title, options)
204
+ end
205
+
206
+ private
207
+
208
+ # The Outline dictionary (12.3.3) for this document. It is
209
+ # lazily initialized, so that documents that do not have an outline
210
+ # do not incur the additional overhead.
211
+ def root
212
+ document.state.store.root.data[:Outlines] ||= document.ref!(OutlineRoot.new)
213
+ end
214
+
215
+ def add_outline_item(title, options, &block)
216
+ outline_item = create_outline_item(title, options)
217
+ set_relations(outline_item)
218
+ increase_count
219
+ set_variables_for_block(outline_item, block)
220
+ block.call if block
221
+ reset_parent(outline_item)
222
+ end
223
+
224
+ def create_outline_item(title, options)
225
+ outline_item = OutlineItem.new(title, parent, options)
226
+
227
+ if options[:destination]
228
+ page_index = options[:destination] - 1
229
+ outline_item.dest = [document.state.pages[page_index].dictionary, :Fit]
230
+ end
231
+
232
+ outline_item.prev = prev if @prev
233
+ items[title] = document.ref!(outline_item)
234
+ end
235
+
236
+ def set_relations(outline_item)
237
+ prev.data.next = outline_item if prev
238
+ parent.data.first = outline_item unless prev
239
+ parent.data.last = outline_item
240
+ end
241
+
242
+ def increase_count
243
+ counting_parent = parent
244
+ while counting_parent
245
+ counting_parent.data.count += 1
246
+ if counting_parent == root
247
+ counting_parent = nil
248
+ else
249
+ counting_parent = counting_parent.data.parent
250
+ end
251
+ end
252
+ end
253
+
254
+ def set_variables_for_block(outline_item, block)
255
+ self.prev = block ? nil : outline_item
256
+ self.parent = outline_item if block
257
+ end
258
+
259
+ def reset_parent(outline_item)
260
+ if parent == outline_item
261
+ self.prev = outline_item
262
+ self.parent = outline_item.data.parent
263
+ end
264
+ end
265
+
266
+ def insert_section(nxt, &block)
267
+ last = @parent.data.last
268
+ if block
269
+ block.call
270
+ end
271
+ adjust_relations(nxt, last)
272
+ reset_root_positioning
273
+ end
274
+
275
+ def adjust_relations(nxt, last)
276
+ if nxt
277
+ nxt.data.prev = @prev
278
+ @prev.data.next = nxt
279
+ @parent.data.last = last
280
+ end
281
+ end
282
+
283
+ def reset_root_positioning
284
+ @parent = root
285
+ @prev = root.data.last
286
+ end
287
+
288
+ end
289
+
290
+ class OutlineRoot #:nodoc:
291
+ attr_accessor :count, :first, :last
292
+
293
+ def initialize
294
+ @count = 0
295
+ end
296
+
297
+ def to_hash
298
+ {:Type => :Outlines, :Count => count, :First => first, :Last => last}
299
+ end
300
+ end
301
+
302
+ class OutlineItem #:nodoc:
303
+ attr_accessor :count, :first, :last, :next, :prev, :parent, :title, :dest, :closed
304
+
305
+ def initialize(title, parent, options)
306
+ @closed = options[:closed]
307
+ @title = title
308
+ @parent = parent
309
+ @count = 0
310
+ end
311
+
312
+ def to_hash
313
+ hash = { :Title => title,
314
+ :Parent => parent,
315
+ :Count => closed ? -count : count }
316
+ [{:First => first}, {:Last => last}, {:Next => @next},
317
+ {:Prev => prev}, {:Dest => dest}].each do |h|
318
+ unless h.values.first.nil?
319
+ hash.merge!(h)
320
+ end
321
+ end
322
+ hash
323
+ end
324
+ end
325
+ end
326
+