prawn 2.1.0 → 2.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +0 -0
- data/GPLv2 +20 -21
- data/Gemfile +3 -9
- data/Rakefile +9 -41
- data/lib/prawn.rb +37 -49
- data/lib/prawn/document.rb +193 -141
- data/lib/prawn/document/bounding_box.rb +50 -30
- data/lib/prawn/document/column_box.rb +7 -7
- data/lib/prawn/document/internals.rb +8 -6
- data/lib/prawn/document/span.rb +22 -16
- data/lib/prawn/encoding.rb +69 -68
- data/lib/prawn/errors.rb +12 -7
- data/lib/prawn/font.rb +104 -69
- data/lib/prawn/font_metric_cache.rb +20 -13
- data/lib/prawn/{font → fonts}/afm.rb +108 -72
- data/lib/prawn/{font → fonts}/dfont.rb +5 -11
- data/lib/prawn/fonts/otf.rb +11 -0
- data/lib/prawn/fonts/ttc.rb +36 -0
- data/lib/prawn/{font → fonts}/ttf.rb +126 -81
- data/lib/prawn/graphics.rb +119 -81
- data/lib/prawn/graphics/blend_mode.rb +9 -8
- data/lib/prawn/graphics/cap_style.rb +3 -3
- data/lib/prawn/graphics/color.rb +43 -39
- data/lib/prawn/graphics/dash.rb +23 -11
- data/lib/prawn/graphics/join_style.rb +9 -3
- data/lib/prawn/graphics/patterns.rb +204 -102
- data/lib/prawn/graphics/transformation.rb +15 -9
- data/lib/prawn/graphics/transparency.rb +17 -13
- data/lib/prawn/grid.rb +84 -48
- data/lib/prawn/image_handler.rb +5 -5
- data/lib/prawn/images.rb +60 -49
- data/lib/prawn/images/image.rb +2 -1
- data/lib/prawn/images/jpg.rb +31 -22
- data/lib/prawn/images/png.rb +67 -63
- data/lib/prawn/measurement_extensions.rb +10 -9
- data/lib/prawn/measurements.rb +19 -15
- data/lib/prawn/outline.rb +98 -77
- data/lib/prawn/repeater.rb +15 -11
- data/lib/prawn/security.rb +93 -70
- data/lib/prawn/security/arcfour.rb +2 -2
- data/lib/prawn/soft_mask.rb +26 -26
- data/lib/prawn/stamp.rb +20 -13
- data/lib/prawn/text.rb +76 -60
- data/lib/prawn/text/box.rb +18 -14
- data/lib/prawn/text/formatted.rb +5 -5
- data/lib/prawn/text/formatted/arranger.rb +80 -40
- data/lib/prawn/text/formatted/box.rb +140 -101
- data/lib/prawn/text/formatted/fragment.rb +11 -14
- data/lib/prawn/text/formatted/line_wrap.rb +128 -67
- data/lib/prawn/text/formatted/parser.rb +147 -123
- data/lib/prawn/text/formatted/wrap.rb +48 -32
- data/lib/prawn/transformation_stack.rb +7 -5
- data/lib/prawn/utilities.rb +7 -22
- data/lib/prawn/version.rb +2 -2
- data/lib/prawn/view.rb +17 -7
- data/manual/basic_concepts/adding_pages.rb +6 -7
- data/manual/basic_concepts/basic_concepts.rb +31 -22
- data/manual/basic_concepts/creation.rb +10 -11
- data/manual/basic_concepts/cursor.rb +4 -5
- data/manual/basic_concepts/measurement.rb +7 -8
- data/manual/basic_concepts/origin.rb +5 -6
- data/manual/basic_concepts/other_cursor_helpers.rb +11 -12
- data/manual/basic_concepts/view.rb +22 -16
- data/manual/bounding_box/bounding_box.rb +29 -24
- data/manual/bounding_box/bounds.rb +11 -12
- data/manual/bounding_box/canvas.rb +7 -8
- data/manual/bounding_box/creation.rb +6 -7
- data/manual/bounding_box/indentation.rb +14 -15
- data/manual/bounding_box/nesting.rb +25 -18
- data/manual/bounding_box/russian_boxes.rb +14 -13
- data/manual/bounding_box/stretchy.rb +12 -13
- data/manual/contents.rb +28 -22
- data/manual/cover.rb +33 -28
- data/manual/document_and_page_options/background.rb +15 -13
- data/manual/document_and_page_options/document_and_page_options.rb +25 -20
- data/manual/document_and_page_options/metadata.rb +18 -16
- data/manual/document_and_page_options/page_margins.rb +18 -20
- data/manual/document_and_page_options/page_size.rb +13 -12
- data/manual/document_and_page_options/print_scaling.rb +18 -15
- data/manual/example_helper.rb +5 -4
- data/manual/graphics/blend_mode.rb +12 -9
- data/manual/graphics/circle_and_ellipse.rb +4 -5
- data/manual/graphics/color.rb +7 -9
- data/manual/graphics/common_lines.rb +7 -8
- data/manual/graphics/fill_and_stroke.rb +5 -6
- data/manual/graphics/fill_rules.rb +10 -10
- data/manual/graphics/gradients.rb +27 -21
- data/manual/graphics/graphics.rb +48 -40
- data/manual/graphics/helper.rb +19 -9
- data/manual/graphics/line_width.rb +8 -7
- data/manual/graphics/lines_and_curves.rb +7 -8
- data/manual/graphics/polygon.rb +6 -8
- data/manual/graphics/rectangle.rb +4 -5
- data/manual/graphics/rotate.rb +6 -7
- data/manual/graphics/scale.rb +14 -15
- data/manual/graphics/soft_masks.rb +3 -4
- data/manual/graphics/stroke_cap.rb +6 -7
- data/manual/graphics/stroke_dash.rb +15 -16
- data/manual/graphics/stroke_join.rb +5 -6
- data/manual/graphics/translate.rb +10 -10
- data/manual/graphics/transparency.rb +7 -8
- data/manual/how_to_read_this_manual.rb +6 -6
- data/manual/images/absolute_position.rb +6 -7
- data/manual/images/fit.rb +7 -8
- data/manual/images/horizontal.rb +10 -11
- data/manual/images/images.rb +28 -24
- data/manual/images/plain_image.rb +5 -6
- data/manual/images/scale.rb +9 -10
- data/manual/images/vertical.rb +16 -14
- data/manual/images/width_and_height.rb +10 -11
- data/manual/layout/boxes.rb +5 -6
- data/manual/layout/content.rb +7 -8
- data/manual/layout/layout.rb +18 -16
- data/manual/layout/simple_grid.rb +6 -7
- data/manual/outline/add_subsection_to.rb +20 -21
- data/manual/outline/insert_section_after.rb +15 -16
- data/manual/outline/outline.rb +21 -17
- data/manual/outline/sections_and_pages.rb +17 -18
- data/manual/repeatable_content/alternate_page_numbering.rb +21 -17
- data/manual/repeatable_content/page_numbering.rb +17 -16
- data/manual/repeatable_content/repeatable_content.rb +25 -19
- data/manual/repeatable_content/repeater.rb +14 -15
- data/manual/repeatable_content/stamp.rb +14 -15
- data/manual/security/encryption.rb +9 -10
- data/manual/security/permissions.rb +21 -14
- data/manual/security/security.rb +19 -16
- data/manual/table.rb +3 -3
- data/manual/text/alignment.rb +16 -17
- data/manual/text/color.rb +12 -11
- data/manual/text/column_box.rb +9 -10
- data/manual/text/fallback_fonts.rb +25 -21
- data/manual/text/font.rb +11 -12
- data/manual/text/font_size.rb +13 -14
- data/manual/text/font_style.rb +10 -8
- data/manual/text/formatted_callbacks.rb +33 -24
- data/manual/text/formatted_text.rb +36 -25
- data/manual/text/free_flowing_text.rb +22 -23
- data/manual/text/inline.rb +18 -19
- data/manual/text/kerning_and_character_spacing.rb +14 -15
- data/manual/text/leading.rb +7 -8
- data/manual/text/line_wrapping.rb +37 -18
- data/manual/text/paragraph_indentation.rb +12 -14
- data/manual/text/positioned_text.rb +15 -16
- data/manual/text/registering_families.rb +20 -21
- data/manual/text/rendering_and_color.rb +9 -10
- data/manual/text/right_to_left_text.rb +26 -19
- data/manual/text/rotation.rb +33 -23
- data/manual/text/single_usage.rb +8 -9
- data/manual/text/text.rb +57 -52
- data/manual/text/text_box_excess.rb +20 -17
- data/manual/text/text_box_extensions.rb +18 -15
- data/manual/text/text_box_overflow.rb +20 -19
- data/manual/text/utf8.rb +11 -12
- data/manual/text/win_ansi_charset.rb +27 -25
- data/prawn.gemspec +41 -34
- data/spec/extensions/encoding_helpers.rb +3 -3
- data/spec/prawn/document/bounding_box_spec.rb +550 -0
- data/spec/prawn/document/column_box_spec.rb +75 -0
- data/spec/prawn/document/security_spec.rb +176 -0
- data/spec/prawn/document_annotations_spec.rb +76 -0
- data/spec/prawn/document_destinations_spec.rb +15 -0
- data/spec/prawn/document_grid_spec.rb +99 -0
- data/spec/prawn/document_reference_spec.rb +27 -0
- data/spec/prawn/document_span_spec.rb +44 -0
- data/spec/prawn/document_spec.rb +805 -0
- data/spec/prawn/font_metric_cache_spec.rb +54 -0
- data/spec/prawn/font_spec.rb +544 -0
- data/spec/prawn/graphics/blend_mode_spec.rb +63 -0
- data/spec/prawn/graphics/transparency_spec.rb +81 -0
- data/spec/prawn/graphics_spec.rb +872 -0
- data/spec/prawn/graphics_stroke_styles_spec.rb +229 -0
- data/spec/{image_handler_spec.rb → prawn/image_handler_spec.rb} +14 -14
- data/spec/prawn/images/jpg_spec.rb +20 -0
- data/spec/prawn/images/png_spec.rb +283 -0
- data/spec/prawn/images_spec.rb +229 -0
- data/spec/prawn/measurements_extensions_spec.rb +24 -0
- data/spec/prawn/outline_spec.rb +512 -0
- data/spec/prawn/repeater_spec.rb +166 -0
- data/spec/prawn/soft_mask_spec.rb +74 -0
- data/spec/prawn/stamp_spec.rb +173 -0
- data/spec/prawn/text/box_spec.rb +1110 -0
- data/spec/prawn/text/formatted/arranger_spec.rb +466 -0
- data/spec/prawn/text/formatted/box_spec.rb +849 -0
- data/spec/prawn/text/formatted/fragment_spec.rb +343 -0
- data/spec/prawn/text/formatted/line_wrap_spec.rb +495 -0
- data/spec/prawn/text/formatted/parser_spec.rb +697 -0
- data/spec/prawn/text_draw_text_spec.rb +150 -0
- data/spec/prawn/text_rendering_mode_spec.rb +48 -0
- data/spec/prawn/text_spacing_spec.rb +95 -0
- data/spec/prawn/text_spec.rb +603 -0
- data/spec/prawn/text_with_inline_formatting_spec.rb +35 -0
- data/spec/{transformation_stack_spec.rb → prawn/transformation_stack_spec.rb} +22 -19
- data/spec/prawn/view_spec.rb +63 -0
- data/spec/prawn_manual_spec.rb +35 -0
- data/spec/spec_helper.rb +18 -19
- metadata +102 -222
- metadata.gz.sig +0 -0
- data/data/images/16bit.alpha +0 -0
- data/data/images/16bit.color +0 -0
- data/data/images/16bit.png +0 -0
- data/data/images/arrow.png +0 -0
- data/data/images/arrow2.png +0 -0
- data/data/images/blend_modes_bottom_layer.jpg +0 -0
- data/data/images/blend_modes_top_layer.jpg +0 -0
- data/data/images/dice.alpha +0 -0
- data/data/images/dice.color +0 -0
- data/data/images/dice.png +0 -0
- data/data/images/dice_interlaced.png +0 -0
- data/data/images/fractal.jpg +0 -0
- data/data/images/indexed_color.dat +0 -0
- data/data/images/indexed_color.png +0 -0
- data/data/images/indexed_transparency.png +0 -0
- data/data/images/indexed_transparency_alpha.dat +0 -0
- data/data/images/indexed_transparency_color.dat +0 -0
- data/data/images/letterhead.jpg +0 -0
- data/data/images/license.md +0 -8
- data/data/images/page_white_text.alpha +0 -0
- data/data/images/page_white_text.color +0 -0
- data/data/images/page_white_text.png +0 -0
- data/data/images/pigs.jpg +0 -0
- data/data/images/prawn.png +0 -0
- data/data/images/ruport.png +0 -0
- data/data/images/ruport_data.dat +0 -0
- data/data/images/ruport_transparent.png +0 -0
- data/data/images/ruport_type0.png +0 -0
- data/data/images/stef.jpg +0 -0
- data/data/images/tru256.bmp +0 -0
- data/data/images/web-links.dat +0 -1
- data/data/images/web-links.png +0 -0
- data/data/pdfs/complex_template.pdf +0 -0
- data/data/pdfs/contains_ttf_font.pdf +0 -0
- data/data/pdfs/encrypted.pdf +0 -0
- data/data/pdfs/form.pdf +1 -819
- data/data/pdfs/hexagon.pdf +0 -61
- data/data/pdfs/indirect_reference.pdf +0 -86
- data/data/pdfs/multipage_template.pdf +0 -127
- data/data/pdfs/nested_pages.pdf +0 -118
- data/data/pdfs/page_without_mediabox.pdf +0 -193
- data/data/pdfs/resources_as_indirect_object.pdf +0 -83
- data/data/pdfs/two_hexagons.pdf +0 -90
- data/data/pdfs/version_1_6.pdf +0 -61
- data/data/shift_jis_text.txt +0 -1
- data/spec/acceptance/png_spec.rb +0 -35
- data/spec/annotations_spec.rb +0 -67
- data/spec/blend_mode_spec.rb +0 -71
- data/spec/bounding_box_spec.rb +0 -501
- data/spec/column_box_spec.rb +0 -59
- data/spec/destinations_spec.rb +0 -13
- data/spec/document_spec.rb +0 -738
- data/spec/font_metric_cache_spec.rb +0 -52
- data/spec/font_spec.rb +0 -475
- data/spec/formatted_text_arranger_spec.rb +0 -452
- data/spec/formatted_text_box_spec.rb +0 -716
- data/spec/formatted_text_fragment_spec.rb +0 -299
- data/spec/graphics_spec.rb +0 -705
- data/spec/grid_spec.rb +0 -95
- data/spec/images_spec.rb +0 -167
- data/spec/inline_formatted_text_parser_spec.rb +0 -568
- data/spec/jpg_spec.rb +0 -23
- data/spec/line_wrap_spec.rb +0 -366
- data/spec/measurement_units_spec.rb +0 -22
- data/spec/outline_spec.rb +0 -409
- data/spec/png_spec.rb +0 -257
- data/spec/reference_spec.rb +0 -25
- data/spec/repeater_spec.rb +0 -154
- data/spec/security_spec.rb +0 -151
- data/spec/soft_mask_spec.rb +0 -78
- data/spec/span_spec.rb +0 -43
- data/spec/stamp_spec.rb +0 -179
- data/spec/stroke_styles_spec.rb +0 -208
- data/spec/text_at_spec.rb +0 -142
- data/spec/text_box_spec.rb +0 -1042
- data/spec/text_rendering_mode_spec.rb +0 -45
- data/spec/text_spacing_spec.rb +0 -93
- data/spec/text_spec.rb +0 -543
- data/spec/text_with_inline_formatting_spec.rb +0 -35
- data/spec/transparency_spec.rb +0 -91
- data/spec/view_spec.rb +0 -42
data/manual/images/horizontal.rb
CHANGED
@@ -1,25 +1,24 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# The image may be positioned relatively to the current bounding box. The
|
4
4
|
# horizontal position may be set with the <code>:position</code> option.
|
5
5
|
#
|
6
6
|
# It may be <code>:left</code>, <code>:center</code>, <code>:right</code> or a
|
7
7
|
# number representing an x-offset from the left boundary.
|
8
|
-
|
9
|
-
|
10
|
-
%w[.. example_helper]))
|
8
|
+
|
9
|
+
require_relative '../example_helper'
|
11
10
|
|
12
11
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
13
12
|
Prawn::ManualBuilder::Example.generate(filename) do
|
14
|
-
bounding_box([50, cursor], :
|
13
|
+
bounding_box([50, cursor], width: 400, height: 450) do
|
15
14
|
stroke_bounds
|
16
15
|
|
17
|
-
[
|
18
|
-
text
|
19
|
-
image "#{Prawn::DATADIR}/images/stef.jpg", :
|
16
|
+
%i[left center right].each do |position|
|
17
|
+
text "Image aligned to the #{position}."
|
18
|
+
image "#{Prawn::DATADIR}/images/stef.jpg", position: position
|
20
19
|
end
|
21
20
|
|
22
|
-
text
|
23
|
-
image "#{Prawn::DATADIR}/images/stef.jpg", :
|
21
|
+
text 'The next image has a 50 point offset from the left boundary'
|
22
|
+
image "#{Prawn::DATADIR}/images/stef.jpg", position: 50
|
24
23
|
end
|
25
24
|
end
|
data/manual/images/images.rb
CHANGED
@@ -1,37 +1,41 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# Examples for embedding images.
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
s.example
|
12
|
-
s.example "absolute_position"
|
4
|
+
|
5
|
+
require_relative '../example_helper'
|
6
|
+
|
7
|
+
Prawn::ManualBuilder::Example.generate('images.pdf', page_size: 'FOLIO') do
|
8
|
+
package 'images' do |p|
|
9
|
+
p.section 'Basics' do |s|
|
10
|
+
s.example 'plain_image'
|
11
|
+
s.example 'absolute_position'
|
13
12
|
end
|
14
13
|
|
15
|
-
p.section
|
16
|
-
s.example
|
17
|
-
s.example
|
14
|
+
p.section 'Relative Positioning' do |s|
|
15
|
+
s.example 'horizontal'
|
16
|
+
s.example 'vertical'
|
18
17
|
end
|
19
18
|
|
20
|
-
p.section
|
21
|
-
s.example
|
22
|
-
s.example
|
23
|
-
s.example
|
19
|
+
p.section 'Size' do |s|
|
20
|
+
s.example 'width_and_height'
|
21
|
+
s.example 'scale'
|
22
|
+
s.example 'fit'
|
24
23
|
end
|
25
24
|
|
26
25
|
p.intro do
|
27
|
-
prose
|
26
|
+
prose <<-TEXT
|
27
|
+
Embedding images on PDF documents is fairly easy. Prawn supports both
|
28
|
+
JPG and PNG images.
|
28
29
|
|
29
|
-
|
30
|
+
The examples show:
|
31
|
+
TEXT
|
30
32
|
|
31
|
-
list(
|
32
|
-
|
33
|
-
|
34
|
-
|
33
|
+
list(
|
34
|
+
'How to add an image to a page',
|
35
|
+
'How place the image on a specific position',
|
36
|
+
'How to configure the image dimensions by setting the width and '\
|
37
|
+
'height or by scaling it'
|
38
|
+
)
|
35
39
|
end
|
36
40
|
end
|
37
41
|
end
|
@@ -1,5 +1,5 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# To embed images onto your PDF file use the <code>image</code> method.
|
4
4
|
# It accepts the file path of the image to be loaded and some optional
|
5
5
|
# arguments.
|
@@ -7,12 +7,11 @@
|
|
7
7
|
# If only the image path is provided the image will be rendered starting on
|
8
8
|
# the cursor position. No manipulation is done with the image even if it doesn't
|
9
9
|
# fit entirely on the page like the following snippet.
|
10
|
-
|
11
|
-
|
12
|
-
%w[.. example_helper]))
|
10
|
+
|
11
|
+
require_relative '../example_helper'
|
13
12
|
|
14
13
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
15
14
|
Prawn::ManualBuilder::Example.generate(filename) do
|
16
|
-
text
|
15
|
+
text 'The image will go right below this line of text.'
|
17
16
|
image "#{Prawn::DATADIR}/images/pigs.jpg"
|
18
17
|
end
|
data/manual/images/scale.rb
CHANGED
@@ -1,22 +1,21 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# To scale an image use the <code>:scale</code> option.
|
4
4
|
#
|
5
5
|
# It scales the image proportionally given the provided value.
|
6
|
-
|
7
|
-
|
8
|
-
%w[.. example_helper]))
|
6
|
+
|
7
|
+
require_relative '../example_helper'
|
9
8
|
|
10
9
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
11
10
|
Prawn::ManualBuilder::Example.generate(filename) do
|
12
|
-
text
|
11
|
+
text 'Normal size'
|
13
12
|
image "#{Prawn::DATADIR}/images/stef.jpg"
|
14
13
|
move_down 20
|
15
14
|
|
16
|
-
text
|
17
|
-
image "#{Prawn::DATADIR}/images/stef.jpg", :
|
15
|
+
text 'Scaled to 50%'
|
16
|
+
image "#{Prawn::DATADIR}/images/stef.jpg", scale: 0.5
|
18
17
|
move_down 20
|
19
18
|
|
20
|
-
text
|
21
|
-
image "#{Prawn::DATADIR}/images/stef.jpg", :
|
19
|
+
text 'Scaled to 200%'
|
20
|
+
image "#{Prawn::DATADIR}/images/stef.jpg", scale: 2
|
22
21
|
end
|
data/manual/images/vertical.rb
CHANGED
@@ -1,28 +1,30 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# To set the vertical position of an image use the <code>:vposition</code>
|
4
4
|
# option.
|
5
5
|
#
|
6
6
|
# It may be <code>:top</code>, <code>:center</code>, <code>:bottom</code> or a
|
7
7
|
# number representing the y-offset from the top boundary.
|
8
|
-
|
9
|
-
|
10
|
-
%w[.. example_helper]))
|
8
|
+
|
9
|
+
require_relative '../example_helper'
|
11
10
|
|
12
11
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
13
12
|
Prawn::ManualBuilder::Example.generate(filename) do
|
14
|
-
bounding_box([0, cursor], :
|
13
|
+
bounding_box([0, cursor], width: 500, height: 450) do
|
15
14
|
stroke_bounds
|
16
15
|
|
17
|
-
[
|
18
|
-
text "Image vertically aligned to the #{vposition}.", :
|
19
|
-
image "#{Prawn::DATADIR}/images/stef.jpg",
|
20
|
-
|
16
|
+
%i[top center bottom].each do |vposition|
|
17
|
+
text "Image vertically aligned to the #{vposition}.", valign: vposition
|
18
|
+
image "#{Prawn::DATADIR}/images/stef.jpg",
|
19
|
+
position: 250,
|
20
|
+
vposition: vposition
|
21
21
|
end
|
22
22
|
|
23
|
-
text_box
|
24
|
-
|
25
|
-
|
26
|
-
|
23
|
+
text_box 'The next image has a 100 point offset from the top boundary',
|
24
|
+
at: [bounds.width - 110, bounds.top - 10],
|
25
|
+
width: 100
|
26
|
+
image "#{Prawn::DATADIR}/images/stef.jpg",
|
27
|
+
position: :right,
|
28
|
+
vposition: 100
|
27
29
|
end
|
28
30
|
end
|
@@ -1,25 +1,24 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# The image size can be set with the <code>:width</code> and
|
4
4
|
# <code>:height</code> options.
|
5
5
|
#
|
6
6
|
# If only one of those is provided, the image will be scaled proportionally.
|
7
7
|
# When both are provided, the image will be stretched to fit the dimensions
|
8
8
|
# without maintaining the aspect ratio.
|
9
|
-
|
10
|
-
|
11
|
-
%w[.. example_helper]))
|
9
|
+
|
10
|
+
require_relative '../example_helper'
|
12
11
|
|
13
12
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
14
13
|
Prawn::ManualBuilder::Example.generate(filename) do
|
15
|
-
text
|
16
|
-
image "#{Prawn::DATADIR}/images/pigs.jpg", :
|
14
|
+
text 'Scale by setting only the width'
|
15
|
+
image "#{Prawn::DATADIR}/images/pigs.jpg", width: 150
|
17
16
|
move_down 20
|
18
17
|
|
19
|
-
text
|
20
|
-
image "#{Prawn::DATADIR}/images/pigs.jpg", :
|
18
|
+
text 'Scale by setting only the height'
|
19
|
+
image "#{Prawn::DATADIR}/images/pigs.jpg", height: 100
|
21
20
|
move_down 20
|
22
21
|
|
23
|
-
text
|
24
|
-
image "#{Prawn::DATADIR}/images/pigs.jpg", :
|
22
|
+
text 'Stretch to fit the width and height provided'
|
23
|
+
image "#{Prawn::DATADIR}/images/pigs.jpg", width: 500, height: 100
|
25
24
|
end
|
data/manual/layout/boxes.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# After defined the grid is there but nothing happens. To start taking effect
|
4
4
|
# we need to use the grid boxes.
|
5
5
|
#
|
@@ -7,15 +7,14 @@
|
|
7
7
|
# received. With no arguments it will return the grid itself. With integers it
|
8
8
|
# will return the grid box at those indices. With two arrays it will return a
|
9
9
|
# multi-box spanning the region of the two grid boxes at the arrays indices.
|
10
|
-
|
11
|
-
|
12
|
-
%w[.. example_helper]))
|
10
|
+
|
11
|
+
require_relative '../example_helper'
|
13
12
|
|
14
13
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
15
14
|
Prawn::ManualBuilder::Example.generate(filename) do
|
16
15
|
# The grid only need to be defined once, but since all the examples should be
|
17
16
|
# able to run alone we are repeating it on every example
|
18
|
-
define_grid(:
|
17
|
+
define_grid(columns: 5, rows: 8, gutter: 10)
|
19
18
|
|
20
19
|
grid(4, 0).show
|
21
20
|
grid(5, 1).show
|
data/manual/layout/content.rb
CHANGED
@@ -1,25 +1,24 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# Now that we know how to access the boxes we might as well add some content
|
4
4
|
# to them.
|
5
5
|
#
|
6
6
|
# This can be done by taping into the bounding box for a given grid box or
|
7
7
|
# multi-box with the <code>bounding_box</code> method.
|
8
|
-
|
9
|
-
|
10
|
-
%w[.. example_helper]))
|
8
|
+
|
9
|
+
require_relative '../example_helper'
|
11
10
|
|
12
11
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
13
12
|
Prawn::ManualBuilder::Example.generate(filename) do
|
14
13
|
# The grid only need to be defined once, but since all the examples should be
|
15
14
|
# able to run alone we are repeating it on every example
|
16
|
-
define_grid(:
|
15
|
+
define_grid(columns: 5, rows: 8, gutter: 10)
|
17
16
|
|
18
17
|
grid([5, 0], [7, 1]).bounding_box do
|
19
|
-
text "Adding some content to this multi_box.\n
|
18
|
+
text "Adding some content to this multi_box.\n#{' _ ' * 200}"
|
20
19
|
end
|
21
20
|
|
22
21
|
grid(6, 3).bounding_box do
|
23
|
-
text "Just a little snippet here.\n
|
22
|
+
text "Just a little snippet here.\n#{' _ ' * 10}"
|
24
23
|
end
|
25
24
|
end
|
data/manual/layout/layout.rb
CHANGED
@@ -1,25 +1,27 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# Examples for using grid layouts.
|
4
|
-
#
|
5
|
-
require File.expand_path(File.join(File.dirname(__FILE__),
|
6
|
-
%w[.. example_helper]))
|
7
4
|
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
p.example
|
5
|
+
require_relative '../example_helper'
|
6
|
+
|
7
|
+
Prawn::ManualBuilder::Example.generate('layout.pdf', page_size: 'FOLIO') do
|
8
|
+
package 'layout' do |p|
|
9
|
+
p.example 'simple_grid'
|
10
|
+
p.example 'boxes'
|
11
|
+
p.example 'content'
|
13
12
|
|
14
13
|
p.intro do
|
15
|
-
prose
|
14
|
+
prose <<-TEXT
|
15
|
+
Prawn has support for two-dimensional grid based layouts out of the box.
|
16
16
|
|
17
|
-
|
17
|
+
The examples show:
|
18
|
+
TEXT
|
18
19
|
|
19
|
-
list(
|
20
|
-
|
21
|
-
|
22
|
-
|
20
|
+
list(
|
21
|
+
'How to define the document grid',
|
22
|
+
'How to configure the grid rows and columns gutters',
|
23
|
+
'How to create boxes according to the grid'
|
24
|
+
)
|
23
25
|
end
|
24
26
|
end
|
25
27
|
end
|
@@ -1,5 +1,5 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# The document grid on Prawn is just a table-like structure with a defined
|
4
4
|
# number of rows and columns. There are some helpers to create boxes of content
|
5
5
|
# based on the grid coordinates.
|
@@ -7,16 +7,15 @@
|
|
7
7
|
# <code>define_grid</code> accepts the following options which are pretty much
|
8
8
|
# self-explanatory: <code>:rows</code>, <code>:columns</code>,
|
9
9
|
# <code>:gutter</code>, <code>:row_gutter</code>, <code>:column_gutter</code>
|
10
|
-
|
11
|
-
|
12
|
-
%w[.. example_helper]))
|
10
|
+
|
11
|
+
require_relative '../example_helper'
|
13
12
|
|
14
13
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
15
14
|
Prawn::ManualBuilder::Example.generate(filename) do
|
16
15
|
# The grid only need to be defined once, but since all the examples should be
|
17
16
|
# able to run alone we are repeating it on every example
|
18
|
-
define_grid(:
|
19
|
-
text
|
17
|
+
define_grid(columns: 5, rows: 8, gutter: 10)
|
18
|
+
text 'We defined the grid, roll over to the next page to see its outline'
|
20
19
|
|
21
20
|
start_new_page
|
22
21
|
grid.show_all
|
@@ -1,5 +1,5 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# We have already seen how to define an outline tree sequentially.
|
4
4
|
#
|
5
5
|
# If you'd like to add nodes to the middle of an outline tree the
|
@@ -16,9 +16,8 @@
|
|
16
16
|
#
|
17
17
|
# If the parent title provided is the title of a page. The page will be
|
18
18
|
# converted into a section to receive the subsection created.
|
19
|
-
|
20
|
-
|
21
|
-
%w[.. example_helper]))
|
19
|
+
|
20
|
+
require_relative '../example_helper'
|
22
21
|
|
23
22
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
24
23
|
Prawn::ManualBuilder::Example.generate(filename) do
|
@@ -29,33 +28,33 @@ Prawn::ManualBuilder::Example.generate(filename) do
|
|
29
28
|
end
|
30
29
|
|
31
30
|
outline.define do
|
32
|
-
section(
|
33
|
-
page :
|
34
|
-
page :
|
31
|
+
section('Section 1', destination: 1) do
|
32
|
+
page title: 'Page 2', destination: 2
|
33
|
+
page title: 'Page 3', destination: 3
|
35
34
|
end
|
36
35
|
end
|
37
36
|
|
38
37
|
# Now we will start adding nodes to the previous outline
|
39
|
-
outline.add_subsection_to(
|
40
|
-
outline.section(
|
41
|
-
outline.page :
|
42
|
-
outline.page :
|
38
|
+
outline.add_subsection_to('Section 1', :first) do
|
39
|
+
outline.section('Added later - first position') do
|
40
|
+
outline.page title: 'Page 4', destination: 4
|
41
|
+
outline.page title: 'Page 5', destination: 5
|
43
42
|
end
|
44
43
|
end
|
45
44
|
|
46
|
-
outline.add_subsection_to(
|
47
|
-
outline.page :
|
48
|
-
:
|
45
|
+
outline.add_subsection_to('Section 1') do
|
46
|
+
outline.page title: 'Added later - last position',
|
47
|
+
destination: 6
|
49
48
|
end
|
50
49
|
|
51
|
-
outline.add_subsection_to(
|
52
|
-
outline.page :
|
53
|
-
:
|
50
|
+
outline.add_subsection_to('Added later - first position') do
|
51
|
+
outline.page title: 'Another page added later',
|
52
|
+
destination: 7
|
54
53
|
end
|
55
54
|
|
56
55
|
# The title provided is for a page which will be converted into a section
|
57
|
-
outline.add_subsection_to(
|
58
|
-
outline.page :
|
59
|
-
:
|
56
|
+
outline.add_subsection_to('Page 3') do
|
57
|
+
outline.page title: 'Last page added',
|
58
|
+
destination: 8
|
60
59
|
end
|
61
60
|
end
|
@@ -1,5 +1,5 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
# Another way to insert nodes into an existing outline is the
|
4
4
|
# <code>insert_section_after</code> method.
|
5
5
|
#
|
@@ -8,9 +8,8 @@
|
|
8
8
|
#
|
9
9
|
# As is the case with <code>add_subsection_to</code> the section added
|
10
10
|
# doesn't need to be a section, it may be just a page.
|
11
|
-
|
12
|
-
|
13
|
-
%w[.. example_helper]))
|
11
|
+
|
12
|
+
require_relative '../example_helper'
|
14
13
|
|
15
14
|
filename = File.basename(__FILE__).gsub('.rb', '.pdf')
|
16
15
|
Prawn::ManualBuilder::Example.generate(filename) do
|
@@ -21,27 +20,27 @@ Prawn::ManualBuilder::Example.generate(filename) do
|
|
21
20
|
end
|
22
21
|
|
23
22
|
outline.define do
|
24
|
-
section(
|
25
|
-
page :
|
26
|
-
page :
|
23
|
+
section('Section 1', destination: 1) do
|
24
|
+
page title: 'Page 2', destination: 2
|
25
|
+
page title: 'Page 3', destination: 3
|
27
26
|
end
|
28
27
|
end
|
29
28
|
|
30
29
|
# Now we will start adding nodes to the previous outline
|
31
|
-
outline.insert_section_after(
|
32
|
-
outline.section(
|
33
|
-
outline.page :
|
30
|
+
outline.insert_section_after('Page 2') do
|
31
|
+
outline.section('Section after Page 2') do
|
32
|
+
outline.page title: 'Page 4', destination: 4
|
34
33
|
end
|
35
34
|
end
|
36
35
|
|
37
|
-
outline.insert_section_after(
|
38
|
-
outline.section(
|
39
|
-
outline.page :
|
36
|
+
outline.insert_section_after('Section 1') do
|
37
|
+
outline.section('Section after Section 1') do
|
38
|
+
outline.page title: 'Page 5', destination: 5
|
40
39
|
end
|
41
40
|
end
|
42
41
|
|
43
42
|
# Adding just a page
|
44
|
-
outline.insert_section_after(
|
45
|
-
outline.page :
|
43
|
+
outline.insert_section_after('Page 3') do
|
44
|
+
outline.page title: 'Page after Page 3', destination: 6
|
46
45
|
end
|
47
46
|
end
|