prawn-git 2.0.1

data/manual/bounding_box/nesting.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+#
+# Normally when we provide the top left corner of a bounding box we
+# express the coordinates relative to the margin box. This is not the
+# case when we have nested bounding boxes. Once nested the inner bounding box
+# coordinates are relative to the outter bounding box.
+#
+# This example shows some nested bounding boxes with fixed and stretchy heights.
+# Note how the <code>cursor</code> method returns coordinates relative to
+# the current bounding box.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  def box_content(string)
+    text string
+    transparent(0.5) { stroke_bounds }
+  end
+
+  gap = 20
+  bounding_box([50, cursor], :width => 400, :height => 200) do
+    box_content("Fixed height")
+
+    bounding_box([gap, cursor - gap], :width => 300) do
+      text "Stretchy height"
+
+      bounding_box([gap, bounds.top - gap], :width => 100) do
+        text "Stretchy height"
+        transparent(0.5) { dash(1); stroke_bounds; undash }
+      end
+
+      bounding_box([gap * 7, bounds.top - gap], :width => 100, :height => 50) do
+        box_content("Fixed height")
+      end
+
+      transparent(0.5) { dash(1); stroke_bounds; undash }
+    end
+
+    bounding_box([gap, cursor - gap], :width => 300, :height => 50) do
+      box_content("Fixed height")
+    end
+  end
+end

data/manual/bounding_box/russian_boxes.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# This example is mostly just for fun, and shows how nested bounding boxes
+# can simplify calculations. See the "Bounding Box" section of the manual
+# for more basic uses.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  def combine(a1, a2)
+    output = []
+    a1.each do |i1|
+      a2.each do |i2|
+        output += [[i1,i2]]
+      end
+    end
+    output
+  end
+
+  def recurse_bounding_box(max_depth=4, depth=1)
+    width = (bounds.width-15)/2
+    height = (bounds.height-15)/2
+    left_top_corners = combine([5, bounds.right-width-5],
+                               [bounds.top-5, height+5])
+    left_top_corners.each do |lt|
+      bounding_box(lt, :width => width, :height => height) do
+        stroke_bounds
+        recurse_bounding_box(max_depth, depth+1) if depth < max_depth
+      end
+    end
+  end
+
+  # Set up a bbox from the dashed line to the bottom of the page
+  bounding_box([0, cursor], :width => bounds.width, :height => cursor) do
+    recurse_bounding_box
+  end
+end
+

data/manual/bounding_box/stretchy.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# Bounding Boxes accept an optional <code>:height</code> parameter. Unless it
+# is provided the bounding box will be stretchy. It will expand the height to
+# fit all content generated inside it.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  y_position = cursor
+  bounding_box([0, y_position], :width => 200, :height => 100) do
+    text "This bounding box has a height of 100. If this text gets too large " +
+         "it will flow to the next page."
+
+    transparent(0.5) { stroke_bounds }
+  end
+
+  bounding_box([300, y_position], :width => 200) do
+    text "This bounding box has variable height. No matter how much text is " +
+         "written here, the height will expand to fit."
+
+    text " _" * 100
+
+    text " *" * 100
+
+    transparent(0.5) { stroke_bounds }
+  end
+
+end

data/manual/contents.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+#
+# Generates the Prawn by example manual.
+
+require_relative "example_helper"
+
+Encoding.default_external = Encoding::UTF_8
+
+Prawn::ManualBuilder::Example.generate("manual.pdf",
+  :skip_page_creation => true, :page_size => "FOLIO") do
+
+  load_page "", "cover"
+  load_page "", "how_to_read_this_manual"
+
+  # Core chapters
+  load_package "basic_concepts"
+  load_package "graphics"
+  load_package "text"
+  load_package "bounding_box"
+
+  # Remaining chapters
+  load_package "layout"
+  load_page "", "table"
+  load_package "images"
+  load_package "document_and_page_options"
+  load_package "outline"
+  load_package "repeatable_content"
+  load_package "security"
+end

data/manual/cover.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+# Prawn manual how to read this manual page.
+#
+
+require_relative "example_helper"
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  move_down 200
+
+  image "#{Prawn::DATADIR}/images/prawn.png",
+        :scale => 0.9,
+        :at => [10, cursor]
+
+  formatted_text_box([ {:text => "Prawn\n",
+                        :styles => [:bold],
+                        :size => 100}
+                     ], :at => [170, cursor - 50])
+
+  formatted_text_box([ {:text => "by example",
+                        :font => 'Courier',
+                        :size => 60}
+                     ], :at => [170, cursor - 160])
+
+  if Dir.exist?("#{Prawn::BASEDIR}/.git")
+    commit = `git show --pretty=%h`
+    git_commit = "git commit: #{commit.lines.first}"
+  else
+    git_commit = ""
+  end
+
+  formatted_text_box([  {:text => "Last Update: #{Time.now.strftime("%Y-%m-%d")}\n"+
+                                  "Prawn Version: #{Prawn::VERSION}\n"+
+                                  git_commit,
+                         :size => 12}
+                    ],   :at => [390, cursor - 620])
+
+end

data/manual/document_and_page_options/background.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+#
+# Pass an image path to the <code>:background</code> option and it will be used
+# as the background for all pages.
+# This option can only be used on document creation.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+img = "#{Prawn::DATADIR}/images/letterhead.jpg"
+
+Prawn::Document.generate("background.pdf",
+                         :background => img,
+                         :margin => 100
+) do
+  text "My report caption", :size => 18, :align => :right
+
+  move_down font.height * 2
+
+  text "Here is my text explaning this report. " * 20,
+       :size => 12, :align => :left, :leading => 2
+
+  move_down font.height
+
+  text "I'm using a soft background. " * 40,
+       :size => 12, :align => :left, :leading => 2
+end

data/manual/document_and_page_options/document_and_page_options.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+#
+# Examples for stamps and repeaters.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::ManualBuilder::Example.generate("document_and_page_options.pdf",
+                        :page_size => "FOLIO") do
+
+  package "document_and_page_options" do |p|
+
+    p.example "page_size",    :eval_source => false, :full_source => true
+    p.example "page_margins", :eval_source => false, :full_source => true
+    p.example "background",   :eval_source => false, :full_source => true
+    p.example "metadata",     :eval_source => false, :full_source => true
+    p.example "print_scaling",:eval_source => false, :full_source => true
+
+    p.intro do
+      prose("So far we've already seen how to create new documents and start new pages. This chapter expands on the previous examples by showing other options avialable. Some of the options are only available when creating new documents.
+
+      The examples show:")
+
+      list( "How to configure page size",
+            "How to configure page margins",
+            "How to use a background image",
+            "How to add metadata to the generated PDF"
+          )
+    end
+
+  end
+end

data/manual/document_and_page_options/metadata.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# To set the document metadata just pass a hash to the <code>:info</code>
+# option when creating new documents.
+# The keys in the example below are arbitrary, so you may add whatever keys you want
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("metadata.pdf",
+  :info => {
+    :Title        => "My title",
+    :Author       => "John Doe",
+    :Subject      => "My Subject",
+    :Keywords     => "test metadata ruby pdf dry",
+    :Creator      => "ACME Soft App",
+    :Producer     => "Prawn",
+    :CreationDate => Time.now
+  }) do
+
+  text "This is a test of setting metadata properties via the info option."
+  text "While the keys are arbitrary, the above example sets common attributes."
+end

data/manual/document_and_page_options/page_margins.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+#
+# The default margin for pages is 0.5 inch but you can change that with the
+# <code>:margin</code> option or if you'd like to have different margins you
+# can use the <code>:left_margin</code>, <code>:right_margin</code>,
+# <code>:top_margin</code>, <code>:bottom_margin</code> options.
+#
+# These options are available both for starting new pages and creating new
+# documents.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("page_margins.pdf",
+                         :margin => 100
+) do
+  text "100 pts margins."
+  stroke_bounds
+
+  start_new_page(:left_margin => 300)
+  text "300 pts margin on the left."
+  stroke_bounds
+
+  start_new_page(:top_margin => 300)
+  text "300 pts margin both on the top and on the left. Notice that whenever " +
+       "you set an option for a new page it will remain the default for the " +
+       "following pages."
+  stroke_bounds
+
+  start_new_page(:margin => 50)
+  text "50 pts margins. Using the margin option will reset previous specific " +
+       "calls to left, right, top and bottom margins."
+  stroke_bounds
+
+  start_new_page(:margin => [50, 100, 150, 200])
+  text "There is also the shorthand CSS like syntax used here."
+  stroke_bounds
+end

data/manual/document_and_page_options/page_size.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+#
+# Prawn comes with support for most of the common page sizes so you'll only need
+# to provide specific values if your intended format is not supported. To see a
+# list with all supported sizes take a look at PDF::Core::PageGeometry
+#
+# # To define the size use <code>:page_size</code> when creating new documents
+# and <code>:size</code> when starting new pages. The default page size for new
+# documents is LETTER (612.00 x 792.00).
+#
+# You may also define the orientation of the page to be either portrait
+# (default) or landscape. Use <code>:page_layout</code> when creating new
+# documents and <code>:layout</code> when starting new pages.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("page_size.pdf",
+                         :page_size   => "EXECUTIVE",
+                         :page_layout => :landscape
+) do
+  text "EXECUTIVE landscape page."
+
+  custom_size = [275, 326]
+
+  ["A4", "TABLOID", "B7", custom_size ].each do |size|
+
+    start_new_page(:size => size, :layout => :portrait)
+    text "#{size} portrait page."
+
+    start_new_page(:size => size, :layout => :landscape)
+    text "#{size} landscape page."
+  end
+end

data/manual/document_and_page_options/print_scaling.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+#
+# (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document.
+# Valid values are <code>None</code>, which indicates that the print dialog should reflect no page scaling,
+# and <code>AppDefault</code>, which indicates that applications should use the current print scaling.
+# If this entry has an unrecognized value, applications should use the current print scaling.
+# Default value: <code>AppDefault</code>.
+#
+# Note: If the print dialog is suppressed and its parameters are provided directly by the application, the value of this entry should still be used.
+#
+
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("print_scaling.pdf",
+                         :page_layout => :landscape,
+                         :print_scaling => :none
+) do
+  text "When you print this document, the scale to fit in print preview should be disabled by default."
+end

data/manual/example_helper.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+require_relative "../lib/prawn"
+require "prawn/manual_builder"
+
+Prawn::ManualBuilder.manual_dir = File.dirname(__FILE__)
+Prawn::Font::AFM.hide_m17n_warning = true

data/manual/graphics/circle_and_ellipse.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+#
+# To define a <code>circle</code> all you need is the center point and the
+# radius.
+#
+# To define an <code>ellipse</code> you provide the center point and two radii
+# (or axes) values. If the second radius value is ommitted, both radii will be
+# equal and you will end up drawing a circle.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  stroke_axis
+
+  stroke_circle [100, 300], 100
+
+  fill_ellipse [200, 100], 100, 50
+
+  fill_ellipse [400, 100], 50
+end

data/manual/graphics/color.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+#
+# We can change the stroke and fill colors providing an HTML rgb 6 digit color
+# code string ("AB1234") or 4 values for CMYK.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  stroke_axis
+
+  # Fill with Yellow using RGB
+  fill_color "FFFFCC"
+  fill_polygon [50, 150], [150, 200], [250, 150],
+               [250, 50], [150, 0], [50, 50]
+
+  # Stroke with Purple using CMYK
+  stroke_color 50, 100, 0, 0
+  stroke_rectangle [300, 300], 200, 100
+
+  # Both together
+  fill_and_stroke_circle [400, 100], 50
+end

data/manual/graphics/common_lines.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# Prawn provides helpers for drawing some commonly used lines:
+#
+# <code>vertical_line</code> and <code>horizontal_line</code> do just what their
+# names imply. Specify the start and end point at a fixed coordinate to define
+# the line.
+#
+# <code>horizontal_rule</code> draws a horizontal line on the current bounding
+# box from border to border, using the current y position.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  stroke_axis
+
+  stroke_color "ff0000"
+
+  stroke do
+    # just lower the current y position
+    move_down 50
+    horizontal_rule
+
+    vertical_line   100, 300, :at => 50
+
+    horizontal_line 200, 500, :at => 150
+  end
+end