piglop-prawn 0.10.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (276) hide show
  1. data/COPYING +340 -0
  2. data/HACKING +49 -0
  3. data/LICENSE +56 -0
  4. data/README +140 -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/resources_as_indirect_object.pdf +83 -0
  62. data/data/pdfs/two_hexagons.pdf +90 -0
  63. data/data/pdfs/version_1_6.pdf +61 -0
  64. data/data/shift_jis_text.txt +1 -0
  65. data/examples/bounding_box/bounding_boxes.rb +43 -0
  66. data/examples/bounding_box/indentation.rb +34 -0
  67. data/examples/bounding_box/russian_boxes.rb +36 -0
  68. data/examples/bounding_box/stretched_nesting.rb +67 -0
  69. data/examples/example_helper.rb +4 -0
  70. data/examples/general/background.rb +23 -0
  71. data/examples/general/canvas.rb +15 -0
  72. data/examples/general/context_sensitive_headers.rb +37 -0
  73. data/examples/general/float.rb +11 -0
  74. data/examples/general/margin.rb +36 -0
  75. data/examples/general/measurement_units.rb +51 -0
  76. data/examples/general/metadata-info.rb +16 -0
  77. data/examples/general/multi_page_layout.rb +18 -0
  78. data/examples/general/outlines.rb +50 -0
  79. data/examples/general/page_geometry.rb +31 -0
  80. data/examples/general/page_numbering.rb +15 -0
  81. data/examples/general/repeaters.rb +47 -0
  82. data/examples/general/stamp.rb +41 -0
  83. data/examples/general/templates.rb +13 -0
  84. data/examples/graphics/basic_images.rb +23 -0
  85. data/examples/graphics/cmyk.rb +12 -0
  86. data/examples/graphics/curves.rb +11 -0
  87. data/examples/graphics/hexagon.rb +13 -0
  88. data/examples/graphics/image_fit.rb +15 -0
  89. data/examples/graphics/image_flow.rb +37 -0
  90. data/examples/graphics/image_position.rb +17 -0
  91. data/examples/graphics/line.rb +32 -0
  92. data/examples/graphics/png_types.rb +22 -0
  93. data/examples/graphics/polygons.rb +16 -0
  94. data/examples/graphics/remote_images.rb +12 -0
  95. data/examples/graphics/rounded_polygons.rb +19 -0
  96. data/examples/graphics/rounded_rectangle.rb +20 -0
  97. data/examples/graphics/ruport_style_helpers.rb +19 -0
  98. data/examples/graphics/stroke_bounds.rb +20 -0
  99. data/examples/graphics/stroke_cap_and_join.rb +45 -0
  100. data/examples/graphics/stroke_dash.rb +42 -0
  101. data/examples/graphics/transformations.rb +52 -0
  102. data/examples/graphics/transparency.rb +26 -0
  103. data/examples/m17n/chinese_text_wrapping.rb +17 -0
  104. data/examples/m17n/euro.rb +15 -0
  105. data/examples/m17n/sjis.rb +28 -0
  106. data/examples/m17n/utf8.rb +13 -0
  107. data/examples/m17n/win_ansi_charset.rb +54 -0
  108. data/examples/security/hello_foo.rb +8 -0
  109. data/examples/table/bill.rb +53 -0
  110. data/examples/table/cell.rb +12 -0
  111. data/examples/table/checkerboard.rb +22 -0
  112. data/examples/table/header.rb +14 -0
  113. data/examples/table/inline_format_table.rb +12 -0
  114. data/examples/table/multi_page_table.rb +9 -0
  115. data/examples/table/simple_table.rb +24 -0
  116. data/examples/table/subtable.rb +12 -0
  117. data/examples/table/widths.rb +20 -0
  118. data/examples/text/alignment.rb +18 -0
  119. data/examples/text/dfont.rb +48 -0
  120. data/examples/text/family_based_styling.rb +24 -0
  121. data/examples/text/font_calculations.rb +91 -0
  122. data/examples/text/font_size.rb +33 -0
  123. data/examples/text/hyphenation.rb +45 -0
  124. data/examples/text/indent_paragraphs.rb +18 -0
  125. data/examples/text/inline_format.rb +72 -0
  126. data/examples/text/kerning.rb +30 -0
  127. data/examples/text/rotated.rb +98 -0
  128. data/examples/text/shaped_text_box.rb +31 -0
  129. data/examples/text/simple_text.rb +17 -0
  130. data/examples/text/simple_text_ttf.rb +17 -0
  131. data/examples/text/text_box.rb +88 -0
  132. data/examples/text/text_box_returning_excess.rb +51 -0
  133. data/examples/text/text_flow.rb +67 -0
  134. data/lib/prawn/compatibility.rb +51 -0
  135. data/lib/prawn/core/annotations.rb +61 -0
  136. data/lib/prawn/core/byte_string.rb +9 -0
  137. data/lib/prawn/core/destinations.rb +90 -0
  138. data/lib/prawn/core/document_state.rb +84 -0
  139. data/lib/prawn/core/literal_string.rb +16 -0
  140. data/lib/prawn/core/name_tree.rb +165 -0
  141. data/lib/prawn/core/object_store.rb +219 -0
  142. data/lib/prawn/core/page.rb +179 -0
  143. data/lib/prawn/core/pdf_object.rb +83 -0
  144. data/lib/prawn/core/reference.rb +112 -0
  145. data/lib/prawn/core/text/formatted/arranger.rb +260 -0
  146. data/lib/prawn/core/text/formatted/line_wrap.rb +127 -0
  147. data/lib/prawn/core/text/formatted/wrap.rb +113 -0
  148. data/lib/prawn/core/text/line_wrap.rb +198 -0
  149. data/lib/prawn/core/text/wrap.rb +80 -0
  150. data/lib/prawn/core/text.rb +115 -0
  151. data/lib/prawn/core.rb +89 -0
  152. data/lib/prawn/document/bounding_box.rb +425 -0
  153. data/lib/prawn/document/graphics_state.rb +48 -0
  154. data/lib/prawn/document/internals.rb +176 -0
  155. data/lib/prawn/document/page_geometry.rb +136 -0
  156. data/lib/prawn/document/snapshot.rb +87 -0
  157. data/lib/prawn/document.rb +573 -0
  158. data/lib/prawn/encoding.rb +121 -0
  159. data/lib/prawn/errors.rb +94 -0
  160. data/lib/prawn/font/afm.rb +225 -0
  161. data/lib/prawn/font/dfont.rb +42 -0
  162. data/lib/prawn/font/ttf.rb +350 -0
  163. data/lib/prawn/font.rb +342 -0
  164. data/lib/prawn/graphics/cap_style.rb +38 -0
  165. data/lib/prawn/graphics/color.rb +205 -0
  166. data/lib/prawn/graphics/dash.rb +71 -0
  167. data/lib/prawn/graphics/join_style.rb +38 -0
  168. data/lib/prawn/graphics/transformation.rb +156 -0
  169. data/lib/prawn/graphics/transparency.rb +99 -0
  170. data/lib/prawn/graphics.rb +321 -0
  171. data/lib/prawn/images/jpg.rb +46 -0
  172. data/lib/prawn/images/png.rb +226 -0
  173. data/lib/prawn/images.rb +348 -0
  174. data/lib/prawn/measurement_extensions.rb +46 -0
  175. data/lib/prawn/measurements.rb +71 -0
  176. data/lib/prawn/outline.rb +278 -0
  177. data/lib/prawn/repeater.rb +129 -0
  178. data/lib/prawn/security/arcfour.rb +51 -0
  179. data/lib/prawn/security.rb +262 -0
  180. data/lib/prawn/stamp.rb +126 -0
  181. data/lib/prawn/table/accessors.rb +180 -0
  182. data/lib/prawn/table/cell/in_table.rb +27 -0
  183. data/lib/prawn/table/cell/subtable.rb +65 -0
  184. data/lib/prawn/table/cell/text.rb +128 -0
  185. data/lib/prawn/table/cell.rb +330 -0
  186. data/lib/prawn/table.rb +421 -0
  187. data/lib/prawn/text/box.rb +380 -0
  188. data/lib/prawn/text/formatted/box.rb +215 -0
  189. data/lib/prawn/text/formatted/fragment.rb +127 -0
  190. data/lib/prawn/text/formatted/parser.rb +202 -0
  191. data/lib/prawn/text/formatted.rb +4 -0
  192. data/lib/prawn/text.rb +442 -0
  193. data/lib/prawn.rb +25 -0
  194. data/spec/annotations_spec.rb +90 -0
  195. data/spec/bounding_box_spec.rb +190 -0
  196. data/spec/cell_spec.rb +337 -0
  197. data/spec/destinations_spec.rb +15 -0
  198. data/spec/document_spec.rb +461 -0
  199. data/spec/font_spec.rb +314 -0
  200. data/spec/formatted_text_arranger_spec.rb +400 -0
  201. data/spec/formatted_text_box_spec.rb +659 -0
  202. data/spec/formatted_text_fragment_spec.rb +211 -0
  203. data/spec/graphics_spec.rb +446 -0
  204. data/spec/images_spec.rb +96 -0
  205. data/spec/inline_formatted_text_parser_spec.rb +446 -0
  206. data/spec/jpg_spec.rb +25 -0
  207. data/spec/line_wrap_spec.rb +341 -0
  208. data/spec/measurement_units_spec.rb +23 -0
  209. data/spec/name_tree_spec.rb +112 -0
  210. data/spec/object_store_spec.rb +160 -0
  211. data/spec/outline_spec.rb +229 -0
  212. data/spec/pdf_object_spec.rb +127 -0
  213. data/spec/png_spec.rb +237 -0
  214. data/spec/reference_spec.rb +82 -0
  215. data/spec/repeater_spec.rb +96 -0
  216. data/spec/security_spec.rb +120 -0
  217. data/spec/snapshot_spec.rb +138 -0
  218. data/spec/spec_helper.rb +26 -0
  219. data/spec/stamp_spec.rb +108 -0
  220. data/spec/stroke_styles_spec.rb +163 -0
  221. data/spec/table_spec.rb +583 -0
  222. data/spec/template_spec.rb +158 -0
  223. data/spec/text_at_spec.rb +119 -0
  224. data/spec/text_box_spec.rb +675 -0
  225. data/spec/text_spacing_spec.rb +57 -0
  226. data/spec/text_spec.rb +328 -0
  227. data/spec/text_with_inline_formatting_spec.rb +193 -0
  228. data/spec/transparency_spec.rb +75 -0
  229. data/vendor/pdf-inspector/README +18 -0
  230. data/vendor/pdf-inspector/lib/pdf/inspector/extgstate.rb +18 -0
  231. data/vendor/pdf-inspector/lib/pdf/inspector/graphics.rb +131 -0
  232. data/vendor/pdf-inspector/lib/pdf/inspector/page.rb +25 -0
  233. data/vendor/pdf-inspector/lib/pdf/inspector/text.rb +46 -0
  234. data/vendor/pdf-inspector/lib/pdf/inspector/xobject.rb +19 -0
  235. data/vendor/pdf-inspector/lib/pdf/inspector.rb +26 -0
  236. data/vendor/ttfunk/data/fonts/DejaVuSans.ttf +0 -0
  237. data/vendor/ttfunk/data/fonts/comicsans.ttf +0 -0
  238. data/vendor/ttfunk/example.rb +45 -0
  239. data/vendor/ttfunk/lib/ttfunk/directory.rb +17 -0
  240. data/vendor/ttfunk/lib/ttfunk/encoding/mac_roman.rb +88 -0
  241. data/vendor/ttfunk/lib/ttfunk/encoding/windows_1252.rb +69 -0
  242. data/vendor/ttfunk/lib/ttfunk/reader.rb +44 -0
  243. data/vendor/ttfunk/lib/ttfunk/resource_file.rb +78 -0
  244. data/vendor/ttfunk/lib/ttfunk/subset/base.rb +141 -0
  245. data/vendor/ttfunk/lib/ttfunk/subset/mac_roman.rb +50 -0
  246. data/vendor/ttfunk/lib/ttfunk/subset/unicode.rb +48 -0
  247. data/vendor/ttfunk/lib/ttfunk/subset/unicode_8bit.rb +63 -0
  248. data/vendor/ttfunk/lib/ttfunk/subset/windows_1252.rb +55 -0
  249. data/vendor/ttfunk/lib/ttfunk/subset.rb +18 -0
  250. data/vendor/ttfunk/lib/ttfunk/subset_collection.rb +72 -0
  251. data/vendor/ttfunk/lib/ttfunk/table/cmap/format00.rb +54 -0
  252. data/vendor/ttfunk/lib/ttfunk/table/cmap/format04.rb +126 -0
  253. data/vendor/ttfunk/lib/ttfunk/table/cmap/subtable.rb +79 -0
  254. data/vendor/ttfunk/lib/ttfunk/table/cmap.rb +34 -0
  255. data/vendor/ttfunk/lib/ttfunk/table/glyf/compound.rb +81 -0
  256. data/vendor/ttfunk/lib/ttfunk/table/glyf/simple.rb +37 -0
  257. data/vendor/ttfunk/lib/ttfunk/table/glyf.rb +64 -0
  258. data/vendor/ttfunk/lib/ttfunk/table/head.rb +44 -0
  259. data/vendor/ttfunk/lib/ttfunk/table/hhea.rb +41 -0
  260. data/vendor/ttfunk/lib/ttfunk/table/hmtx.rb +47 -0
  261. data/vendor/ttfunk/lib/ttfunk/table/kern/format0.rb +62 -0
  262. data/vendor/ttfunk/lib/ttfunk/table/kern.rb +79 -0
  263. data/vendor/ttfunk/lib/ttfunk/table/loca.rb +43 -0
  264. data/vendor/ttfunk/lib/ttfunk/table/maxp.rb +40 -0
  265. data/vendor/ttfunk/lib/ttfunk/table/name.rb +125 -0
  266. data/vendor/ttfunk/lib/ttfunk/table/os2.rb +78 -0
  267. data/vendor/ttfunk/lib/ttfunk/table/post/format10.rb +43 -0
  268. data/vendor/ttfunk/lib/ttfunk/table/post/format20.rb +35 -0
  269. data/vendor/ttfunk/lib/ttfunk/table/post/format25.rb +23 -0
  270. data/vendor/ttfunk/lib/ttfunk/table/post/format30.rb +17 -0
  271. data/vendor/ttfunk/lib/ttfunk/table/post/format40.rb +17 -0
  272. data/vendor/ttfunk/lib/ttfunk/table/post.rb +91 -0
  273. data/vendor/ttfunk/lib/ttfunk/table/simple.rb +14 -0
  274. data/vendor/ttfunk/lib/ttfunk/table.rb +46 -0
  275. data/vendor/ttfunk/lib/ttfunk.rb +102 -0
  276. metadata +364 -0
@@ -0,0 +1,380 @@
1
+ # encoding: utf-8
2
+
3
+ # text/box.rb : Implements text boxes
4
+ #
5
+ # Copyright November 2009, Daniel Nelson. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+
10
+ module Prawn
11
+ module Text
12
+
13
+ # Draws the requested text into a box. When the text overflows
14
+ # the rectangle, you can display ellipses, shrink to fit, or
15
+ # truncate the text. Text boxes are independent of the document
16
+ # y position.
17
+ #
18
+ # == Encoding
19
+ #
20
+ # Note that strings passed to this function should be encoded as UTF-8.
21
+ # If you get unexpected characters appearing in your rendered document,
22
+ # check this.
23
+ #
24
+ # If the current font is a built-in one, although the string must be
25
+ # encoded as UTF-8, only characters that are available in WinAnsi
26
+ # are allowed.
27
+ #
28
+ # If an empty box is rendered to your PDF instead of the character you
29
+ # wanted it usually means the current font doesn't include that character.
30
+ #
31
+ # == Options (default values marked in [])
32
+ #
33
+ # <tt>:kerning</tt>:: <tt>boolean</tt>. Whether or not to use kerning (if it
34
+ # is available with the current font)
35
+ # [value of document.default_kerning?]
36
+ # <tt>:size</tt>:: <tt>number</tt>. The font size to use. [current font
37
+ # size]
38
+ # <tt>:style</tt>:: The style to use. The requested style must be part of
39
+ # the current font familly. [current style]
40
+ #
41
+ # <tt>:at</tt>::
42
+ # <tt>[x, y]</tt>. The upper left corner of the box
43
+ # [@document.bounds.left, @document.bounds.top]
44
+ # <tt>:width</tt>::
45
+ # <tt>number</tt>. The width of the box [@document.bounds.right - @at[0]]
46
+ # <tt>:height</tt>::
47
+ # <tt>number</tt>. The height of the box [@at[1] - @document.bounds.bottom]
48
+ # <tt>:align</tt>::
49
+ # <tt>:left</tt>, <tt>:center</tt>, <tt>:right</tt>, or
50
+ # <tt>:justify</tt> Alignment within the bounding box [:left]
51
+ # <tt>:valign</tt>::
52
+ # <tt>:top</tt>, <tt>:center</tt>, or <tt>:bottom</tt>. Vertical
53
+ # alignment within the bounding box [:top]
54
+ #
55
+ # <tt>:rotate</tt>::
56
+ # <tt>number</tt>. The angle to rotate the text
57
+ # <tt>:rotate_around</tt>::
58
+ # <tt>:center</tt>, <tt>:upper_left</tt>, <tt>:upper_right</tt>,
59
+ # <tt>:lower_right</tt>, or <tt>:lower_left</tt>. The point around which
60
+ # to rotate the text [:upper_left]
61
+ # <tt>:leading</tt>::
62
+ # <tt>number</tt>. Additional space between lines [0]
63
+ # <tt>:single_line</tt>::
64
+ # <tt>boolean</tt>. If true, then only the first line will be drawn [false]
65
+ # <tt>:skip_encoding</tt>::
66
+ # <tt>boolean</tt> [false]
67
+ # <tt>:overflow</tt>::
68
+ # <tt>:truncate</tt>, <tt>:shrink_to_fit</tt>, <tt>:expand</tt>, or
69
+ # <tt>:ellipses</tt>. This controls the behavior when the amount of text
70
+ # exceeds the available space. <tt>:ellipses</tt> [:truncate]
71
+ # <tt>:min_font_size</tt>::
72
+ # <tt>number</tt>. The minimum font size to use when :overflow is set to
73
+ # :shrink_to_fit (that is the font size will not be reduced to less than
74
+ # this value, even if it means that some text will be cut off). [5]
75
+ #
76
+ # == Returns
77
+ #
78
+ # Returns any text that did not print under the current settings.
79
+ #
80
+ # NOTE: if an AFM font is used, then the returned text is encoded in
81
+ # WinAnsi. Subsequent calls to text_box that pass this returned text back
82
+ # into text box must include a :skip_encoding => true option. This is
83
+ # unnecessary when using TTF fonts because those operate on UTF-8 encoding.
84
+ #
85
+ # == Exceptions
86
+ #
87
+ # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
88
+ # any text
89
+ #
90
+ def text_box(string, options)
91
+ Text::Box.new(string, options.merge(:document => self)).render
92
+ end
93
+
94
+ # Generally, one would use the Prawn::Text#text_box convenience
95
+ # method. However, using Text::Box.new in conjunction with
96
+ # #render(:dry_run=> true) enables one to do look-ahead calculations prior
97
+ # to placing text on the page, or to determine how much vertical space was
98
+ # consumed by the printed text
99
+ #
100
+ class Box
101
+ include Prawn::Core::Text::Wrap
102
+
103
+ def valid_options
104
+ Prawn::Core::Text::VALID_OPTIONS + [:at, :height, :width,
105
+ :align, :valign,
106
+ :rotate, :rotate_around,
107
+ :overflow, :min_font_size,
108
+ :leading, :single_line,
109
+ :skip_encoding,
110
+ :document]
111
+ end
112
+
113
+ # The text that was successfully printed (or, if <tt>dry_run</tt> was
114
+ # used, the test that would have been successfully printed)
115
+ attr_reader :text
116
+ # The upper left corner of the text box
117
+ attr_reader :at
118
+ # The line height of the last line printed
119
+ attr_reader :line_height
120
+ # The height of the ascender of the last line printed
121
+ attr_reader :ascender
122
+ # The height of the descender of the last line printed
123
+ attr_reader :descender
124
+ # The leading used during printing
125
+ attr_reader :leading
126
+
127
+
128
+ # Extend Prawn::Text::Box
129
+ #
130
+ # Example (see Prawn::Text::Core::Wrap for what is required
131
+ # of the wrap method if you want to override the default
132
+ # wrapping algorithm):
133
+ #
134
+ # module MyWrap
135
+ #
136
+ # def wrap
137
+ # @text = nil
138
+ # @line_height = @document.font.height
139
+ # @descender = @document.font.descender
140
+ # @ascender = @document.font.ascender
141
+ # @baseline_y = -@ascender
142
+ # draw_line("all your base are belong to us")
143
+ # ""
144
+ # end
145
+ #
146
+ # end
147
+ #
148
+ # Prawn::Text::Box.extensions << MyWrap
149
+ #
150
+ # box = Prawn::Text::Box.new('hello world')
151
+ # box.render('why can't I print anything other than' +
152
+ # '"all your base are belong to us"?')
153
+ #
154
+ #
155
+ def self.extensions
156
+ @extensions ||= []
157
+ end
158
+
159
+ def self.inherited(base) #:nodoc:
160
+ extensions.each { |e| base.extensions << e }
161
+ end
162
+
163
+ # See Prawn::Text#text_box for valid options
164
+ #
165
+ def initialize(text, options={})
166
+ @inked = false
167
+ Prawn.verify_options(valid_options, options)
168
+ options = options.dup
169
+
170
+ self.class.extensions.reverse_each { |e| extend e }
171
+
172
+ @overflow = options[:overflow] || :truncate
173
+
174
+ self.original_text = text
175
+ @text = nil
176
+
177
+ @document = options[:document]
178
+ @at = options[:at] ||
179
+ [@document.bounds.left, @document.bounds.top]
180
+ @width = options[:width] ||
181
+ @document.bounds.right - @at[0]
182
+ @height = options[:height] ||
183
+ @at[1] - @document.bounds.bottom
184
+ @align = options[:align] || :left
185
+ @vertical_align = options[:valign] || :top
186
+ @leading = options[:leading] || 0
187
+ @rotate = options[:rotate] || 0
188
+ @rotate_around = options[:rotate_around] || :upper_left
189
+ @single_line = options[:single_line]
190
+ @skip_encoding = options[:skip_encoding] || @document.skip_encoding
191
+
192
+ if @overflow == :expand
193
+ # if set to expand, then we simply set the bottom
194
+ # as the bottom of the document bounds, since that
195
+ # is the maximum we should expand to
196
+ @height = @at[1] - @document.bounds.bottom
197
+ @overflow = :truncate
198
+ end
199
+ @min_font_size = options[:min_font_size] || 5
200
+ if options[:kerning].nil? then
201
+ options[:kerning] = @document.default_kerning?
202
+ end
203
+ @options = { :kerning => options[:kerning],
204
+ :size => options[:size],
205
+ :style => options[:style] }
206
+
207
+ super(text, options)
208
+ end
209
+
210
+ # Render text to the document based on the settings defined in initialize.
211
+ #
212
+ # In order to facilitate look-ahead calculations, <tt>render</tt> accepts
213
+ # a <tt>:dry_run => true</tt> option. If provided, then everything is
214
+ # executed as if rendering, with the exception that nothing is drawn on
215
+ # the page. Useful for look-ahead computations of height, unprinted text,
216
+ # etc.
217
+ #
218
+ # Returns any text that did not print under the current settings
219
+ #
220
+ def render(flags={})
221
+ unprinted_text = ''
222
+ @document.save_font do
223
+ process_options
224
+
225
+ if @skip_encoding
226
+ text = original_text
227
+ else
228
+ text = normalize_encoding
229
+ end
230
+
231
+ @document.font_size(@font_size) do
232
+ shrink_to_fit(text) if @overflow == :shrink_to_fit
233
+ process_vertical_alignment(text)
234
+ @inked = true unless flags[:dry_run]
235
+ if @rotate != 0 && @inked
236
+ unprinted_text = render_rotated(text)
237
+ else
238
+ unprinted_text = wrap(text)
239
+ end
240
+ @inked = false
241
+ end
242
+ end
243
+
244
+ unprinted_text
245
+ end
246
+
247
+ # The height actually used during the previous <tt>render</tt>
248
+ #
249
+ def height
250
+ return 0 if @baseline_y.nil? || @descender.nil?
251
+ # baseline is already pushed down one line below the current
252
+ # line, so we need to subtract line line_height and leading,
253
+ # but we need to add in the descender since baseline is
254
+ # above the descender
255
+ @baseline_y.abs - @ascender - @leading
256
+ end
257
+
258
+ # The width available at this point in the box
259
+ #
260
+ def available_width
261
+ @width
262
+ end
263
+
264
+ def draw_line(line_to_print, line_width=0, word_spacing=0, include_ellipses=false) #:nodoc:
265
+ insert_ellipses(line_to_print) if include_ellipses
266
+
267
+ case(@align)
268
+ when :left, :justify
269
+ x = @at[0]
270
+ when :center
271
+ x = @at[0] + @width * 0.5 - line_width * 0.5
272
+ when :right
273
+ x = @at[0] + @width - line_width
274
+ end
275
+
276
+ y = @at[1] + @baseline_y
277
+
278
+ if @inked
279
+ if @align == :justify
280
+ @document.word_spacing(word_spacing) {
281
+ @document.draw_text!(line_to_print, :at => [x, y],
282
+ :kerning => @kerning)
283
+ }
284
+ else
285
+ @document.draw_text!(line_to_print, :at => [x, y],
286
+ :kerning => @kerning)
287
+ end
288
+ end
289
+
290
+ line_to_print
291
+ end
292
+
293
+ private
294
+
295
+ def normalize_encoding
296
+ @document.font.normalize_encoding(@original_string)
297
+ end
298
+
299
+ def original_text
300
+ @original_string
301
+ end
302
+
303
+ def original_text=(string)
304
+ @original_string = string.dup
305
+ end
306
+
307
+ def process_vertical_alignment(text)
308
+ return if @vertical_align == :top
309
+ wrap(text)
310
+ case @vertical_align
311
+ when :center
312
+ @at[1] = @at[1] - (@height - height) * 0.5
313
+ when :bottom
314
+ @at[1] = @at[1] - (@height - height)
315
+ end
316
+ @height = height
317
+ end
318
+
319
+ # Decrease the font size until the text fits or the min font
320
+ # size is reached
321
+ def shrink_to_fit(text)
322
+ while (unprinted_text = wrap(text)).length > 0 &&
323
+ @font_size > @min_font_size
324
+ @font_size -= 0.5
325
+ @document.font_size = @font_size
326
+ end
327
+ end
328
+
329
+ def process_options
330
+ # must be performed within a save_font bock because
331
+ # document.process_text_options sets the font
332
+ @document.process_text_options(@options)
333
+ @font_size = @options[:size]
334
+ @kerning = @options[:kerning]
335
+ end
336
+
337
+ def render_rotated(text)
338
+ unprinted_text = ''
339
+
340
+ case @rotate_around
341
+ when :center
342
+ x = @at[0] + @width * 0.5
343
+ y = @at[1] - @height * 0.5
344
+ when :upper_right
345
+ x = @at[0] + @width
346
+ y = @at[1]
347
+ when :lower_right
348
+ x = @at[0] + @width
349
+ y = @at[1] - @height
350
+ when :lower_left
351
+ x = @at[0]
352
+ y = @at[1] - @height
353
+ else
354
+ x = @at[0]
355
+ y = @at[1]
356
+ end
357
+
358
+ @document.rotate(@rotate, :origin => [x, y]) do
359
+ unprinted_text = wrap(text)
360
+ end
361
+ unprinted_text
362
+ end
363
+
364
+ def last_line?
365
+ @baseline_y.abs + @descender > @height - @line_height
366
+ end
367
+
368
+ def insert_ellipses(line_to_print)
369
+ if @document.width_of(line_to_print + "...",
370
+ :kerning => @kerning) < available_width
371
+ line_to_print.insert(-1, "...")
372
+ else
373
+ line_to_print[-3..-1] = "..." if line_to_print.length > 3
374
+ end
375
+ end
376
+
377
+ end
378
+
379
+ end
380
+ end
@@ -0,0 +1,215 @@
1
+ # encoding: utf-8
2
+
3
+ # text/formatted/rectangle.rb : Implements text boxes with formatted text
4
+ #
5
+ # Copyright February 2010, Daniel Nelson. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+
10
+ module Prawn
11
+ module Text
12
+ module Formatted
13
+
14
+ # Draws the requested formatted text into a box. When the text overflows
15
+ # the rectangle shrink to fit or truncate the text. Text boxes are
16
+ # independent of the document y position.
17
+ #
18
+ # == Formatted Text Array
19
+ #
20
+ # Formatted text is comprised of an array of hashes, where each hash
21
+ # defines text and format information. As of the time of writing, the
22
+ # following hash options are supported:
23
+ #
24
+ # <tt>:text</tt>::
25
+ # the text to format according to the other hash options
26
+ # <tt>:styles</tt>::
27
+ # an array of styles to apply to this text. Available styles include
28
+ # :bold, :italic, :underline, :strikethrough, :subscript, and
29
+ # :superscript
30
+ # <tt>:size</tt>::
31
+ # an integer denoting the font size to apply to this text
32
+ # <tt>:font</tt>::
33
+ # the name of a font. The name must be an AFM font with the desired
34
+ # faces or must be a font that is already registered using
35
+ # Prawn::Document#font_families
36
+ # <tt>:color</tt>::
37
+ # anything compatible with Prawn::Graphics::Color#fill_color and
38
+ # Prawn::Graphics::Color#stroke_color
39
+ # <tt>:link</tt>::
40
+ # a URL to which to create a link. A clickable link will be created
41
+ # to that URL. Note that you must explicitly underline and color using
42
+ # the appropriate tags if you which to draw attention to the link
43
+ # <tt>:anchor</tt>::
44
+ # a destination that has already been or will be registered using
45
+ # Prawn::Core::Destinations#add_dest. A clickable link will be
46
+ # created to that destination. Note that you must explicitly underline
47
+ # and color using the appropriate tags if you which to draw attention
48
+ # to the link
49
+ # <tt>:callback</tt>::
50
+ # a hash with the following options
51
+ # <tt>:object</tt>:: required. the object to target
52
+ # <tt>:method</tt>:: required. the method to call on the target object
53
+ # <tt>:arguments</tt>:: optional. the arguments to pass to the
54
+ # callback method
55
+ #
56
+ # == Example
57
+ #
58
+ # formatted_text_box([{ :text => "hello" },
59
+ # { :text => "world",
60
+ # :size => 24,
61
+ # :styles => [:bold, :italic] }])
62
+ #
63
+ # == Options
64
+ #
65
+ # Accepts the same options as Text::Box with the below exceptions
66
+ #
67
+ # <tt>:overflow</tt>::
68
+ # does not accept :ellipses
69
+ #
70
+ # == Returns
71
+ #
72
+ # Returns a formatted text array representing any text that did not print
73
+ # under the current settings.
74
+ #
75
+ # == Exceptions
76
+ #
77
+ # Raises "Bad font family" if no font family is defined for the current font
78
+ #
79
+ # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
80
+ # any text
81
+ #
82
+ # Raises <tt>NotImplementedError</tt> if <tt>:ellipses</tt> <tt>overflow</tt>
83
+ # option included
84
+ #
85
+ def formatted_text_box(array, options)
86
+ Text::Formatted::Box.new(array, options.merge(:document => self)).render
87
+ end
88
+
89
+ # Generally, one would use the Prawn::Text::Formatted#formatted_text_box
90
+ # convenience method. However, using Text::Formatted::Box.new in
91
+ # conjunction with #render(:dry_run => true) enables one to do look-ahead
92
+ # calculations prior to placing text on the page, or to determine how much
93
+ # vertical space was consumed by the printed text
94
+ #
95
+ class Box < Prawn::Text::Box
96
+ include Prawn::Core::Text::Formatted::Wrap
97
+
98
+ def initialize(array, options={})
99
+ super(array, options)
100
+ if @overflow == :ellipses
101
+ raise NotImplementedError, "ellipses overflow unavailable with" +
102
+ "formatted box"
103
+ end
104
+ end
105
+
106
+ # The height actually used during the previous <tt>render</tt>
107
+ #
108
+ def height
109
+ return 0 if @baseline_y.nil? || @descender.nil?
110
+ @baseline_y.abs + @line_height - @ascender
111
+ end
112
+
113
+ # <tt>fragment</tt> is a Prawn::Text::Formatted::Fragment object
114
+ #
115
+ def draw_fragment(fragment, accumulated_width=0, line_width=0, word_spacing=0) #:nodoc:
116
+ case(@align)
117
+ when :left, :justify
118
+ x = @at[0]
119
+ when :center
120
+ x = @at[0] + @width * 0.5 - line_width * 0.5
121
+ when :right
122
+ x = @at[0] + @width - line_width
123
+ end
124
+
125
+ x += accumulated_width
126
+
127
+ y = @at[1] + @baseline_y
128
+
129
+ y += fragment.y_offset
130
+
131
+ fragment.left = x
132
+ fragment.baseline = y
133
+
134
+ if @inked
135
+ if @align == :justify
136
+ @document.word_spacing(word_spacing) {
137
+ @document.draw_text!(fragment.text, :at => [x, y],
138
+ :kerning => @kerning)
139
+ }
140
+ else
141
+ @document.draw_text!(fragment.text, :at => [x, y],
142
+ :kerning => @kerning)
143
+ end
144
+
145
+ draw_fragment_overlays(fragment)
146
+ end
147
+ end
148
+
149
+ private
150
+
151
+ def original_text
152
+ @original_array.collect { |hash| hash.dup }
153
+ end
154
+
155
+ def original_text=(array)
156
+ @original_array = array
157
+ end
158
+
159
+ def normalize_encoding
160
+ array = original_text
161
+ array.each do |hash|
162
+ hash[:text] = @document.font.normalize_encoding(hash[:text])
163
+ end
164
+ array
165
+ end
166
+
167
+ def move_baseline_down
168
+ if @baseline_y == 0
169
+ @baseline_y = -@ascender
170
+ else
171
+ @baseline_y -= (@line_height + @leading)
172
+ end
173
+ end
174
+
175
+ def draw_fragment_overlays(fragment)
176
+ draw_fragment_overlay_styles(fragment)
177
+ draw_fragment_overlay_link(fragment)
178
+ draw_fragment_overlay_anchor(fragment)
179
+ end
180
+
181
+ def draw_fragment_overlay_link(fragment)
182
+ return unless fragment.link
183
+ box = fragment.absolute_bounding_box
184
+ @document.link_annotation(box,
185
+ :Border => [0, 0, 0],
186
+ :A => { :Type => :Action,
187
+ :S => :URI,
188
+ :URI => Prawn::Core::LiteralString.new(fragment.link) })
189
+ end
190
+
191
+ def draw_fragment_overlay_anchor(fragment)
192
+ return unless fragment.anchor
193
+ box = fragment.absolute_bounding_box
194
+ @document.link_annotation(box,
195
+ :Border => [0, 0, 0],
196
+ :Dest => fragment.anchor)
197
+ end
198
+
199
+ def draw_fragment_overlay_styles(fragment)
200
+ underline = fragment.styles.include?(:underline)
201
+ if underline
202
+ @document.stroke_line(fragment.underline_points)
203
+ end
204
+
205
+ strikethrough = fragment.styles.include?(:strikethrough)
206
+ if strikethrough
207
+ @document.stroke_line(fragment.strikethrough_points)
208
+ end
209
+ end
210
+
211
+ end
212
+
213
+ end
214
+ end
215
+ end