alphasights-prawn 0.10.0

data/examples/example_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn'
+
+Prawn.debug = true

data/examples/general/background.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# This example demonstrates the use of the new :background option when
+# generating a new Document.  Image is assumed to be pre-fit for your page
+# size, and will not be rescaled.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+img = "#{Prawn::BASEDIR}/data/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/examples/general/canvas.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# Demonstrates how to enable absolute positioning in Prawn by temporarily
+# removing the margin_box via Document#canvas()
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("canvas.pdf") do
+  canvas do
+    text "This text should appear at the absolute top left"
+
+    # stroke a line to show that the relative coordinates are the same as absolute
+    stroke_line [bounds.left,bounds.bottom], [bounds.right,bounds.top]
+  end
+end

data/examples/general/context_sensitive_headers.rb

@@ -0,0 +1,37 @@
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+# Ex. Generate a roster of meeting attendees given a set of meetings.
+# Attendees for a meeting may overflow to accross page boundaries but 
+# each meeting starts on a separate page. Each page for any given
+# meeting will have the heading for that meeting. 
+
+#dummying up some meetings
+meetings = []
+5.times do |i|
+  meetings << "Meeting number #{i}"
+end
+
+Prawn::Document.generate('context_sensitive_headers.pdf', :margin => [100, 100], :skip_page_creation => true) do
+  meetings.each_with_index do |meeting,i|
+    
+    create_stamp(meeting.to_s) do
+      canvas do
+        text_box("header for #{meeting}",
+          :at => [bounds.left + 50, bounds.top - 20],
+          :height => 50,
+          :width => margin_box.width)
+      end
+    end
+    on_page_create { stamp(meeting.to_s) }
+
+    start_new_page
+
+    #simulate some meetings with content over multiple pages
+    (15 + 20*i).times do |i|
+      text "#{meeting} attendee #{i}"
+    end
+    
+  end
+
+end
+

data/examples/general/float.rb

@@ -0,0 +1,11 @@
+require "#{File.dirname(__FILE__)}/../example_helper"
+
+Prawn::Document.generate('float.pdf') do
+  float do
+    bounding_box [bounds.width / 2.0, bounds.top], :width => 100 do
+      text "Hello world. " * 50
+    end
+  end
+
+  text "Hello world again"
+end

data/examples/general/margin.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+#
+# This demonstrates the Prawn options for document and page margin, similar to CSS shorthand.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+LOREM = ("Lorem ipsum dolor sit amet, consectetur adipisicing elit, "+
+"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. "+
+"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris "+
+"nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in "+
+"reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla "+
+"pariatur. Excepteur sint occaecat cupidatat non proident, sunt in " +
+"culpa qui officia deserunt mollit anim id est laborum. ") * 20
+
+Prawn::Document.generate("margin.pdf", :margin => 100) do |pdf|
+
+  pdf.text "100 on all sides", :style => :bold
+  pdf.text LOREM
+  
+  pdf.start_new_page(:margin => 100, :left_margin => 0)
+  pdf.text "100 on all sides but 0 on the left", :style => :bold
+  pdf.text LOREM
+
+  pdf.start_new_page(:margin => [100, 0])
+  pdf.text "100 top and bottom, 0 left and right.", :style => :bold
+  pdf.text LOREM
+  
+  pdf.start_new_page(:margin => [100, 0, 50])
+  pdf.text "100 top, 0 left and right, 50 bottom.", :style => :bold
+  pdf.text LOREM
+  
+  pdf.start_new_page(:margin => [0, 50, 100, 150])
+  pdf.text "0 top, 50 right, 100 bottom, 150 left.", :style => :bold
+  pdf.text LOREM
+
+end

data/examples/general/measurement_units.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+#
+# Generates a ruler and also demonstrates prawn/measurement_extensions.
+# It's better to run this example and examine its output than to worry about
+# its particular implementation, though some might find that interesting as
+# well.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+require "prawn/measurement_extensions"
+
+# this makes the following units available (Millimeters, Centimeters, Decimeters, Meters, Inches, Foot, Yards, Points)
+# Methodname is the common abbravation for the unit (mm, cm, dm, m, in, ft, yd, pt)
+# Usage: '10.mm'. 
+# This converts 10mm to PDF points, which Prawn uses internally.
+
+pdf = Prawn::Document.new(
+:page_size => "A4", 
+:left_margin => 10.mm,    # different
+:right_margin => 1.cm,    # units
+:top_margin => 0.1.dm,    # work
+:bottom_margin => 0.01.m) # well
+
+pdf.font_size = 6
+pdf.line_width = 0.05
+
+units_long = %w[Millimeters Centimeters Decimeters Inches Foot Points]
+units = %w[mm cm dm in ft pt]
+offset_multiplier = 2.cm
+temp = "Units\n"
+
+units.each_with_index do |unit, unit_index| #iterate through all units that make sense to display on a sheet of paper
+  one_unit_in_pt = eval "1.#{unit}" # calc the width of one unit
+  temp << "1#{unit} => #{one_unit_in_pt}pt\n" #puts converted unit in points
+  
+  offset = offset_multiplier * unit_index
+  pdf.draw_text units[unit_index], :at => [offset + 0.5.mm, pdf.bounds.top - 2.mm]
+  
+  pdf.stroke_line(offset, pdf.bounds.top, offset, pdf.bounds.bottom)
+  
+  0.upto(((pdf.bounds.height - 5.mm) / one_unit_in_pt).to_i) do |i| # checks, how many strokes can be drawn
+    pdf.stroke_line(offset, i * one_unit_in_pt, (i % 5 == 0 ? 6.mm : 3.mm) + offset, i * one_unit_in_pt) # every fifth stroke is twice as large like on a real ruler
+    pdf.draw_text "#{i}#{unit}", :at => [7.mm + offset, i * one_unit_in_pt] unless unit == "mm" && i % 5 != 0 || unit == "pt" && i % 10 != 0 # avoid text too close to each other
+  end    
+end
+
+pdf.text_box temp,
+  :width    => 5.cm, :height => pdf.font.height * units_long.length,
+  :at       => [offset_multiplier * units_long.length, pdf.bounds.top]
+
+pdf.render_file "measurement_units.pdf"

data/examples/general/metadata-info.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+# Demonstrates how to set metadata properties via the info option
+# It allows one to specify no standard properties
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "metadata-info.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, :Grok => "Test Property"
+  } do       
+  text "This is a test of setting metadata properties via the info option"
+  text "It allows one to specify no standard properties like 'Grok'"
+end

data/examples/general/multi_page_layout.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# This demonstrates that Prawn can modify page size, margins and layout for 
+# each individual page, via Document#start_new_page()
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("multi-layout.pdf", :page_layout => :landscape) do |pdf|
+   pdf.text "This is on a landscaped page" 
+   pdf.start_new_page(:layout => :portrait)
+   pdf.text "This is on a portrait page"   
+   pdf.start_new_page(:size => "LEGAL")
+   pdf.text "This is on legal paper size"      
+   pdf.start_new_page(:left_margin => 150, :right_margin => 150)
+   pdf.text "This page has very wide left and right margins, causing a squeeze"
+   pdf.start_new_page(:margin => 300, :right_margin => 0)
+   pdf.text "This page has even wider margins on all sides except for the right side, where it's 0"
+end

data/examples/general/outlines.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#
+# This example demonstrates the use of the the outlines option for a new document
+# it sets an initial outline item with a title
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate('outlines.pdf') do
+  text "Page 1. This is the first Chapter. "
+  start_new_page
+  text "Page 2. More in the first Chapter. "
+  start_new_page
+  text "Page 3. This is the second Chapter. It has a subsection. "
+  start_new_page
+  text  "Page 4. More in the second Chapter. "
+  define_outline do
+    section 'Chapter 1', :page => 1, :closed => true do 
+      page 1, :title => 'Page 1'
+      page 2, :title => 'Page 2'
+    end
+    section 'Chapter 2', :page => 3 do 
+      section 'Chapter 2 Subsection' do
+        page nil,  :title => 'Page 3'
+      end
+      page 4, :title => 'Page 4'
+    end
+  end
+  start_new_page
+  text "Page 5. Appendix"
+  start_new_page 
+  text "Page 6. More in the Appendix"
+  outline.add_section do
+    section 'Appendix', :page => 5 do
+      page 5, :title => 'Page 5'
+      page 6, :title => 'Page 6'
+    end
+  end
+  go_to_page 4
+  start_new_page 
+  text "inserted before the Appendix"
+  outline.insert_section_after 'Chapter 2' do
+    page page_number, :title => "Pre-Appendix"
+  end
+  go_to_page 7
+  start_new_page
+  text "One last page"
+  outline.insert_section_after 'Page 6' do 
+    page page_number, :title => "Inserted after 6"
+  end
+end

data/examples/general/page_geometry.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# This demonstrates basic page layout and landscape options for Prawn
+# documents.  The style used here is a bit out of date, see 
+# multi_page_layout.rb for a more modern example.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+def pdf(*options)  
+  Prawn::Document.new(*options)
+end
+                                     
+# defaults to portrait and US letter
+portrait_letter = pdf 
+portrait_letter.render_file "portrait_letter.pdf"
+
+landscape_letter = pdf(:page_layout => :landscape)
+landscape_letter.render_file "landscape_letter.pdf"  
+
+portrait_legal = pdf(:page_size => "LEGAL")
+portrait_legal.render_file "portrait_legal.pdf" 
+
+landscape_legal = pdf(:page_size => "LEGAL", :page_layout => :landscape)
+landscape_legal.render_file "landscape_legal.pdf"
+
+portrait_a4 = pdf(:page_size => "A4")
+portrait_a4.render_file "portrait_a4.pdf"
+
+landscape_a4 = pdf(:page_size => "A4", :page_layout => :landscape)
+landscape_a4.render_file("landscape_a4.pdf")
+

data/examples/general/page_numbering.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# This example demonstrates how to add a "page k of n"
+# template to your documents.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("page_with_numbering.pdf") do
+  text "Hai"
+  start_new_page
+  text "bai"
+  start_new_page
+  text "-- Hai again"
+  number_pages "<page> in a total of <total>", [bounds.right - 50, 0]  
+end

data/examples/general/repeaters.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+#
+# This example demonstrates how to make use of Prawn's repeating element
+# support.  Note that all repeated elements are generated using XObjects, so
+# they should be pretty efficient.
+#
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("repeat.pdf", :skip_page_creation => true) do
+
+  repeat :all do
+    draw_text "ALLLLLL", :at => bounds.top_left
+  end
+
+  repeat :odd do
+    draw_text "ODD", :at => [0,0]
+  end
+
+  repeat :even do
+    draw_text "EVEN", :at => [0,0]
+  end
+
+  repeat [1,2] do 
+    draw_text "[1,2]", :at => [100,0]
+  end
+
+  repeat 2..4 do
+    draw_text "2..4", :at => [200,0]
+  end
+
+  repeat(lambda { |pg| pg % 3 == 0 }) do
+    draw_text "Every third", :at => [250, 20]
+  end
+  
+  repeat(:all, :dynamic => true) do
+    draw_text page_number, :at => [500, 0]
+  end
+
+  10.times do 
+    start_new_page
+    draw_text "A wonderful page", :at => [400,400]
+  end
+
+end
+
+

data/examples/general/stamp.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#
+# Demonstrate use of stamps
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("stamp.pdf", :skip_page_creation => true) do
+
+  create_stamp("odd_page_template") do
+    draw_text "This is the odd page template", 
+            :at => [0, bounds.top - font.height] 
+    draw_text "This is also in the odd page template", :at => [0, 0] 
+  end
+
+  create_stamp("even_page_template") do
+    draw_text "This is the even page template", 
+            :at => [0, bounds.top - font.height] 
+    draw_text "This is also in the even page template", :at => [0, 0] 
+  end
+  
+  start_new_page
+  stamp("odd_page_template")
+
+  create_stamp("MyStamp") do
+    fill_color("ff0000")
+    fill_circle_at([0, 0], :radius => 20)
+    fill_color("000000")
+    fill_circle_at([10, 10], :radius => 20)
+  end
+
+  10.times do |i|
+    10.times do |j|
+      stamp_at("MyStamp", [100 + j * 50, bounds.top - 100 - i * 50])
+    end
+  end
+
+  4.times do |i|
+    start_new_page
+    stamp("#{i % 2 == 0 ? 'even' : 'odd'}_page_template")
+  end
+end

data/examples/general/templates.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+#
+# This sample demonstrates the use of the :template option when generating
+# a new Document. The template PDF file is imported into a new document.
+
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+filename = "#{Prawn::BASEDIR}/reference_pdfs/curves.pdf"
+
+Prawn::Document.generate("template.pdf", :template => filename) do
+  text "Previous pages and content imported", :size => 18, :align => :center
+  text "This page and content is brand new", :size => 18, :align => :center
+end

data/examples/graphics/basic_images.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# Demonstrates basic image embedding and positioning functionality.
+# For positioning images alongside flowing text, see the image_flow.rb
+# example.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+   
+Prawn::Document.generate("basic_images.pdf", :page_layout => :landscape) do     
+  stef = "#{Prawn::BASEDIR}/data/images/stef.jpg"
+  image stef, :at => [75, 75] 
+  
+  stef = "#{Prawn::BASEDIR}/data/images/stef.jpg"
+  image stef, :at => [500, 400], :width => 200, :height => 200 
+  
+  draw_text "Please enjoy the pigs", :size => 36, :at => [200,15]   
+  
+  ruport = "#{Prawn::BASEDIR}/data/images/ruport.png"  
+  image ruport, :at => [400,200], :width => 150 
+
+  ruport = "#{Prawn::BASEDIR}/data/images/ruport_transparent.png"  
+  image ruport, :at => [50,525] 
+end