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,160 @@
1
+ # encoding: utf-8
2
+
3
+ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
4
+
5
+ describe "Prawn::ObjectStore" do
6
+ before(:each) do
7
+ @store = Prawn::Core::ObjectStore.new
8
+ end
9
+
10
+ it "should create required roots by default, including info passed to new" do
11
+ store = Prawn::Core::ObjectStore.new(:info => {:Test => 3})
12
+ store.size.should == 3 # 3 default roots
13
+ store.info.data[:Test].should == 3
14
+ store.pages.data[:Count].should == 0
15
+ store.root.data[:Pages].should == store.pages
16
+ end
17
+
18
+ it "should import objects from an existing PDF" do
19
+ filename = "#{Prawn::BASEDIR}/reference_pdfs/curves.pdf"
20
+ store = Prawn::Core::ObjectStore.new(:template => filename)
21
+ store.size.should == 5
22
+ end
23
+
24
+ it "should point to existing roots when importing objects from an existing PDF" do
25
+ filename = "#{Prawn::BASEDIR}/reference_pdfs/curves.pdf"
26
+ store = Prawn::Core::ObjectStore.new(:template => filename)
27
+ store.info.class.should == Prawn::Core::Reference
28
+ store.root.class.should == Prawn::Core::Reference
29
+ end
30
+
31
+ it "should initialize with pages when importing objects from an existing PDF" do
32
+ filename = "#{Prawn::BASEDIR}/reference_pdfs/curves.pdf"
33
+ store = Prawn::Core::ObjectStore.new(:template => filename)
34
+ store.pages.data[:Count].should == 1
35
+ end
36
+
37
+ it "should import all objects from a PDF that has an indirect reference in a stream dict" do
38
+ filename = "#{Prawn::BASEDIR}/data/pdfs/indirect_reference.pdf"
39
+ store = Prawn::Core::ObjectStore.new(:template => filename)
40
+ store.size.should == 8
41
+ end
42
+
43
+ it "should raise ArgumentError when given a file that doesn exist as a template" do
44
+ filename = "not_really_there.pdf"
45
+
46
+ lambda { Prawn::Core::ObjectStore.new(:template => filename) }.should.raise(ArgumentError)
47
+ end
48
+
49
+ it "should raise Prawn::Errors::TemplateError when given a non PDF as a template" do
50
+ filename = "#{Prawn::BASEDIR}/data/images/dice.png"
51
+
52
+ lambda { Prawn::Core::ObjectStore.new(:template => filename) }.should.raise(Prawn::Errors::TemplateError)
53
+ end
54
+
55
+ it "should raise Prawn::Errors::TemplateError when given an encrypted PDF as a template" do
56
+ filename = "#{Prawn::BASEDIR}/data/pdfs/encrypted.pdf"
57
+
58
+ lambda { Prawn::Core::ObjectStore.new(:template => filename) }.should.raise(Prawn::Errors::TemplateError)
59
+ end
60
+
61
+ it "should add to its objects when ref() is called" do
62
+ count = @store.size
63
+ @store.ref("blah")
64
+ @store.size.should == count + 1
65
+ end
66
+
67
+ it "should accept push with a Prawn::Reference" do
68
+ r = Prawn::Core::Reference(123, "blah")
69
+ @store.push(r)
70
+ @store[r.identifier].should == r
71
+ end
72
+
73
+ it "should accept arbitrary data and use it to create a Prawn::Reference" do
74
+ @store.push(123, "blahblah")
75
+ @store[123].data.should == "blahblah"
76
+ end
77
+
78
+ it "should be Enumerable, yielding in order of submission" do
79
+ # higher IDs to bypass the default roots
80
+ [10, 11, 12].each do |id|
81
+ @store.push(id, "some data #{id}")
82
+ end
83
+ @store.map{|ref| ref.identifier}[-3..-1].should == [10, 11, 12]
84
+ end
85
+ end
86
+
87
+ describe "Prawn::ObjectStore#compact" do
88
+ it "should do nothing to an ObjectStore with all live refs" do
89
+ store = Prawn::Core::ObjectStore.new
90
+ store.info.data[:Blah] = store.ref(:some => "structure")
91
+ old_size = store.size
92
+ store.compact
93
+
94
+ store.size.should == old_size
95
+ end
96
+
97
+ it "should remove dead objects, renumbering live objects from 1" do
98
+ store = Prawn::Core::ObjectStore.new
99
+ store.ref(:some => "structure")
100
+ old_size = store.size
101
+ store.compact
102
+
103
+ store.size.should.be < old_size
104
+ store.map{ |o| o.identifier }.should == (1..store.size).to_a
105
+ end
106
+
107
+ it "should detect and remove dead objects that were once live" do
108
+ store = Prawn::Core::ObjectStore.new
109
+ store.info.data[:Blah] = store.ref(:some => "structure")
110
+ store.info.data[:Blah] = :overwritten
111
+ old_size = store.size
112
+ store.compact
113
+
114
+ store.size.should.be < old_size
115
+ store.map{ |o| o.identifier }.should == (1..store.size).to_a
116
+ end
117
+ end
118
+
119
+ describe "Prawn::ObjectStorie#object_id_for_page" do
120
+ it "should return the object ID of an imported template page" do
121
+ filename = "#{Prawn::BASEDIR}/data/pdfs/hexagon.pdf"
122
+ store = Prawn::Core::ObjectStore.new(:template => filename)
123
+ store.object_id_for_page(0).should == 4
124
+ end
125
+
126
+ it "should return the object ID of the first imported template page" do
127
+ filename = "#{Prawn::BASEDIR}/data/pdfs/two_hexagons.pdf"
128
+ store = Prawn::Core::ObjectStore.new(:template => filename)
129
+ store.object_id_for_page(1).should == 4
130
+ end
131
+
132
+ it "should return the object ID of the last imported template page" do
133
+ filename = "#{Prawn::BASEDIR}/data/pdfs/two_hexagons.pdf"
134
+ store = Prawn::Core::ObjectStore.new(:template => filename)
135
+ store.object_id_for_page(-1).should == 6
136
+ end
137
+
138
+ it "should return the object ID of the first page of a template that uses nested Pages" do
139
+ filename = "#{Prawn::BASEDIR}/data/pdfs/nested_pages.pdf"
140
+ store = Prawn::Core::ObjectStore.new(:template => filename)
141
+ store.object_id_for_page(1).should == 5
142
+ end
143
+
144
+ it "should return the object ID of the last page of a template that uses nested Pages" do
145
+ filename = "#{Prawn::BASEDIR}/data/pdfs/nested_pages.pdf"
146
+ store = Prawn::Core::ObjectStore.new(:template => filename)
147
+ store.object_id_for_page(-1).should == 8
148
+ end
149
+
150
+ it "should return nil if given an invalid page number" do
151
+ filename = "#{Prawn::BASEDIR}/data/pdfs/hexagon.pdf"
152
+ store = Prawn::Core::ObjectStore.new(:template => filename)
153
+ store.object_id_for_page(10).should == nil
154
+ end
155
+
156
+ it "should return nil if given an invalid page number" do
157
+ store = Prawn::Core::ObjectStore.new
158
+ store.object_id_for_page(10).should == nil
159
+ end
160
+ end
@@ -0,0 +1,404 @@
1
+ # encoding: utf-8
2
+ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
3
+
4
+ describe "Outline" do
5
+ before(:each) do
6
+ @pdf = Prawn::Document.new() do
7
+ text "Page 1. This is the first Chapter. "
8
+ start_new_page
9
+ text "Page 2. More in the first Chapter. "
10
+ start_new_page
11
+ outline.define do
12
+ section 'Chapter 1', :destination => 1, :closed => true do
13
+ page :destination => 1, :title => 'Page 1'
14
+ page :destination => 2, :title => 'Page 2'
15
+ end
16
+ end
17
+ end
18
+ end
19
+ if RUBY_VERSION >= "1.9"
20
+ describe "outline encoding" do
21
+ it "should store all outline titles as UTF-16" do
22
+ render_and_find_objects
23
+ @hash.values.each do |obj|
24
+ if obj.is_a?(Hash) && obj[:Title]
25
+ title = obj[:Title].dup
26
+ title.force_encoding("UTF-16LE")
27
+ title.valid_encoding?.should == true
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
33
+ describe "#generate_outline" do
34
+ before(:each) do
35
+ render_and_find_objects
36
+ end
37
+
38
+ it "should create a root outline dictionary item" do
39
+ assert_not_nil @outline_root
40
+ end
41
+
42
+ it "should set the first and last top items of the root outline dictionary item" do
43
+ referenced_object(@outline_root[:First]).should == @section_1
44
+ referenced_object(@outline_root[:Last]).should == @section_1
45
+ end
46
+
47
+ describe "#create_outline_item" do
48
+ it "should create outline items for each section and page" do
49
+ [@section_1, @page_1, @page_2].each {|item| assert_not_nil item}
50
+ end
51
+ end
52
+
53
+ describe "#set_relations, #set_variables_for_block, and #reset_parent" do
54
+ it "should link sibling items" do
55
+ referenced_object(@page_1[:Next]).should == @page_2
56
+ referenced_object(@page_2[:Prev]).should == @page_1
57
+ end
58
+
59
+ it "should link child items to parent item" do
60
+ [@page_1, @page_2].each {|page| referenced_object(page[:Parent]).should == @section_1 }
61
+ end
62
+
63
+ it "should set the first and last child items for parent item" do
64
+ referenced_object(@section_1[:First]).should == @page_1
65
+ referenced_object(@section_1[:Last]).should == @page_2
66
+ end
67
+ end
68
+
69
+ describe "#increase_count" do
70
+
71
+ it "should add the count of all descendant items" do
72
+ @outline_root[:Count].should == 3
73
+ @section_1[:Count].should.abs == 2
74
+ @page_1[:Count].should == 0
75
+ @page_2[:Count].should == 0
76
+ end
77
+
78
+ end
79
+
80
+ describe "closed option" do
81
+
82
+ it "should set the item's integer count to negative" do
83
+ @section_1[:Count].should == -2
84
+ end
85
+
86
+ end
87
+
88
+ end
89
+
90
+ describe "addding a section later with outline#section" do
91
+ before(:each) do
92
+ @pdf.start_new_page
93
+ @pdf.text "Page 3. An added section "
94
+ @pdf.outline.update do
95
+ section 'Added Section', :destination => 3 do
96
+ page :destination => 3, :title => 'Page 3'
97
+ end
98
+ end
99
+ render_and_find_objects
100
+ end
101
+
102
+ it "should add new outline items to document" do
103
+ [@section_2, @page_3].each { |item| assert_not_nil item}
104
+ end
105
+
106
+ it "should reset the last items for root outline dictionary" do
107
+ referenced_object(@outline_root[:First]).should == @section_1
108
+ referenced_object(@outline_root[:Last]).should == @section_2
109
+ end
110
+
111
+ it "should reset the next relation for the previous last top level item" do
112
+ referenced_object(@section_1[:Next]).should == @section_2
113
+ end
114
+
115
+ it "should set the previous relation of the addded to section" do
116
+ referenced_object(@section_2[:Prev]).should == @section_1
117
+ end
118
+
119
+ it "should increase the count of root outline dictionary" do
120
+ @outline_root[:Count].should == 5
121
+ end
122
+
123
+ end
124
+
125
+ describe "#outline.add_subsection_to" do
126
+ context "positioned last" do
127
+
128
+ before(:each) do
129
+ @pdf.start_new_page
130
+ @pdf.text "Page 3. An added subsection "
131
+ @pdf.outline.update do
132
+ add_subsection_to 'Chapter 1' do
133
+ section 'Added SubSection', :destination => 3 do
134
+ page :destination => 3, :title => 'Added Page 3'
135
+ end
136
+ end
137
+ end
138
+ render_and_find_objects
139
+ end
140
+
141
+ it "should add new outline items to document" do
142
+ [@subsection, @added_page_3].each { |item| assert_not_nil item}
143
+ end
144
+
145
+ it "should reset the last item for parent item dictionary" do
146
+ referenced_object(@section_1[:First]).should == @page_1
147
+ referenced_object(@section_1[:Last]).should == @subsection
148
+ end
149
+
150
+ it "should set the prev relation for the new subsection to its parent's old last item" do
151
+ referenced_object(@subsection[:Prev]).should == @page_2
152
+ end
153
+
154
+
155
+ it "the subsection should become the next relation for its parent's old last item" do
156
+ referenced_object(@page_2[:Next]).should == @subsection
157
+ end
158
+
159
+ it "should set the first relation for the new subsection" do
160
+ referenced_object(@subsection[:First]).should == @added_page_3
161
+ end
162
+
163
+ it "should set the correct last relation of the added to section" do
164
+ referenced_object(@subsection[:Last]).should == @added_page_3
165
+ end
166
+
167
+ it "should increase the count of root outline dictionary" do
168
+ @outline_root[:Count].should == 5
169
+ end
170
+
171
+ end
172
+
173
+ context "positioned first" do
174
+
175
+ before(:each) do
176
+ @pdf.start_new_page
177
+ @pdf.text "Page 3. An added subsection "
178
+ @pdf.outline.update do
179
+ add_subsection_to 'Chapter 1', :first do
180
+ section 'Added SubSection', :destination => 3 do
181
+ page :destination => 3, :title => 'Added Page 3'
182
+ end
183
+ end
184
+ end
185
+ render_and_find_objects
186
+ end
187
+
188
+ it "should add new outline items to document" do
189
+ [@subsection, @added_page_3].each { |item| assert_not_nil item}
190
+ end
191
+
192
+ it "should reset the first item for parent item dictionary" do
193
+ referenced_object(@section_1[:First]).should == @subsection
194
+ referenced_object(@section_1[:Last]).should == @page_2
195
+ end
196
+
197
+ it "should set the next relation for the new subsection to its parent's old first item" do
198
+ referenced_object(@subsection[:Next]).should == @page_1
199
+ end
200
+
201
+ it "the subsection should become the prev relation for its parent's old first item" do
202
+ referenced_object(@page_1[:Prev]).should == @subsection
203
+ end
204
+
205
+ it "should set the first relation for the new subsection" do
206
+ referenced_object(@subsection[:First]).should == @added_page_3
207
+ end
208
+
209
+ it "should set the correct last relation of the added to section" do
210
+ referenced_object(@subsection[:Last]).should == @added_page_3
211
+ end
212
+
213
+ it "should increase the count of root outline dictionary" do
214
+ @outline_root[:Count].should == 5
215
+ end
216
+
217
+ end
218
+
219
+ it "should require an existing title" do
220
+ assert_raise Prawn::Errors::UnknownOutlineTitle do
221
+ @pdf.go_to_page 1
222
+ @pdf.start_new_page
223
+ @pdf.text "Inserted Page"
224
+ @pdf.outline.update do
225
+ add_subsection_to 'Wrong page' do
226
+ page page_number, :title => "Inserted Page"
227
+ end
228
+ end
229
+ render_and_find_objects
230
+ end
231
+ end
232
+ end
233
+
234
+ describe "#outline.insert_section_after" do
235
+ describe "inserting in the middle of another section" do
236
+ before(:each) do
237
+ @pdf.go_to_page 1
238
+ @pdf.start_new_page
239
+ @pdf.text "Inserted Page"
240
+ @pdf.outline.update do
241
+ insert_section_after 'Page 1' do
242
+ page :destination => page_number, :title => "Inserted Page"
243
+ end
244
+ end
245
+ render_and_find_objects
246
+ end
247
+
248
+ it "should insert new outline items to document" do
249
+ assert_not_nil @inserted_page
250
+ end
251
+
252
+ it "should adjust the count of all ancestors" do
253
+ @outline_root[:Count].should == 4
254
+ @section_1[:Count].should.abs == 3
255
+ end
256
+
257
+ describe "#adjust_relations" do
258
+
259
+ it "should reset the sibling relations of adjoining items to inserted item" do
260
+ referenced_object(@page_1[:Next]).should == @inserted_page
261
+ referenced_object(@page_2[:Prev]).should == @inserted_page
262
+ end
263
+
264
+ it "should set the sibling relation of added item to adjoining items" do
265
+ referenced_object(@inserted_page[:Next]).should == @page_2
266
+ referenced_object(@inserted_page[:Prev]).should == @page_1
267
+ end
268
+
269
+ it "should not affect the first and last relations of parent item" do
270
+ referenced_object(@section_1[:First]).should == @page_1
271
+ referenced_object(@section_1[:Last]).should == @page_2
272
+ end
273
+
274
+ end
275
+
276
+
277
+ context "when adding another section afterwards" do
278
+ it "should have reset the root position so that a new section is added at the end of root sections" do
279
+ @pdf.start_new_page
280
+ @pdf.text "Another Inserted Page"
281
+ @pdf.outline.update do
282
+ section 'Added Section' do
283
+ page :destination => page_number, :title => "Inserted Page"
284
+ end
285
+ end
286
+ render_and_find_objects
287
+ referenced_object(@outline_root[:Last]).should == @section_2
288
+ referenced_object(@section_1[:Next]).should == @section_2
289
+ end
290
+ end
291
+
292
+ end
293
+
294
+
295
+ describe "inserting at the end of another section" do
296
+
297
+ before(:each) do
298
+ @pdf.go_to_page 2
299
+ @pdf.start_new_page
300
+ @pdf.text "Inserted Page"
301
+ @pdf.outline.update do
302
+ insert_section_after 'Page 2' do
303
+ page :destination => page_number, :title => "Inserted Page"
304
+ end
305
+ end
306
+ render_and_find_objects
307
+ end
308
+
309
+ describe "#adjust_relations" do
310
+
311
+ it "should reset the sibling relations of adjoining item to inserted item" do
312
+ referenced_object(@page_2[:Next]).should == @inserted_page
313
+ end
314
+
315
+ it "should set the sibling relation of added item to adjoining items" do
316
+ assert_nil referenced_object(@inserted_page[:Next])
317
+ referenced_object(@inserted_page[:Prev]).should == @page_2
318
+ end
319
+
320
+ it "should adjust the last relation of parent item" do
321
+ referenced_object(@section_1[:Last]).should == @inserted_page
322
+ end
323
+
324
+ end
325
+ end
326
+
327
+ it "should require an existing title" do
328
+ assert_raise Prawn::Errors::UnknownOutlineTitle do
329
+ @pdf.go_to_page 1
330
+ @pdf.start_new_page
331
+ @pdf.text "Inserted Page"
332
+ @pdf.outline.update do
333
+ insert_section_after 'Wrong page' do
334
+ page :destination => page_number, :title => "Inserted Page"
335
+ end
336
+ end
337
+ render_and_find_objects
338
+ end
339
+ end
340
+
341
+ end
342
+
343
+ describe "#page" do
344
+ it "should require a title option to be set" do
345
+ assert_raise Prawn::Errors::RequiredOption do
346
+ @pdf = Prawn::Document.new() do
347
+ text "Page 1. This is the first Chapter. "
348
+ outline.define do
349
+ page :destination => 1, :title => nil
350
+ end
351
+ end
352
+ end
353
+ end
354
+ end
355
+ end
356
+
357
+ context "foreign character encoding" do
358
+ before(:each) do
359
+ pdf = Prawn::Document.new() do
360
+ outline.define do
361
+ section 'La pomme croquée', :destination => 1, :closed => true
362
+ end
363
+ end
364
+ @hash = PDF::Hash.new(StringIO.new(pdf.render, 'r+'))
365
+ end
366
+
367
+ it "should handle other encodings for the title" do
368
+ object = find_by_title('La pomme croquée')
369
+ object.should.not == nil
370
+ end
371
+ end
372
+
373
+ def render_and_find_objects
374
+ output = StringIO.new(@pdf.render, 'r+')
375
+ @hash = PDF::Hash.new(output)
376
+ @outline_root = @hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Outlines}
377
+ @pages = @hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
378
+ @section_1 = find_by_title('Chapter 1')
379
+ @page_1 = find_by_title('Page 1')
380
+ @page_2 = find_by_title('Page 2')
381
+ @section_2 = find_by_title('Added Section')
382
+ @page_3 = find_by_title('Page 3')
383
+ @inserted_page = find_by_title('Inserted Page')
384
+ @subsection = find_by_title('Added SubSection')
385
+ @added_page_3 = find_by_title('Added Page 3')
386
+ end
387
+
388
+ # Outline titles are stored as UTF-16. This method accepts a UTF-8 outline title
389
+ # and returns the PDF Object that contains an outline with that name
390
+ def find_by_title(title)
391
+ @hash.values.find {|obj|
392
+ if obj.is_a?(Hash) && obj[:Title]
393
+ title_codepoints = obj[:Title].unpack("n*")
394
+ title_codepoints.shift
395
+ utf8_title = title_codepoints.pack("U*")
396
+ utf8_title == title ? obj : nil
397
+ end
398
+ }
399
+ end
400
+
401
+ def referenced_object(reference)
402
+ @hash[reference]
403
+ end
404
+