davebenvenuti-prawn 0.11.1.pre

data/examples/general/page_geometry.rb

@@ -0,0 +1,32 @@
+# 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.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+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,16 @@
+# encoding: utf-8
+#
+# This example demonstrates how to add a "page k of n"
+# template to your documents.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+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,48 @@
+# 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.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+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,42 @@
+# encoding: utf-8
+#
+# Demonstrate use of stamps
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+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,14 @@
+# 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.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+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,24 @@
+# encoding: utf-8
+#
+# Demonstrates basic image embedding and positioning functionality.
+# For positioning images alongside flowing text, see the image_flow.rb
+# example.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+   
+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

data/examples/graphics/cmyk.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+#
+# Demonstrates Prawn's support for CMYK images and colors.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("cmyk.pdf", :page_layout => :landscape) do
+  fill_color 50, 100, 0, 0
+  text "Prawn is CYMK Friendly"
+  fractal = "#{Prawn::BASEDIR}/data/images/fractal.jpg"
+  image fractal, :at => [50,450]
+end

data/examples/graphics/curves.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+#
+# Demonstrates simple curve and circle usage
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+pdf = Prawn::Document.new
+pdf.move_to [100,100]
+pdf.stroke_curve_to [50,50], :bounds => [[60,90], [60, 90]]  
+pdf.fill_circle_at [200,200], :radius => 10
+pdf.render_file "curves.pdf"

data/examples/graphics/hexagon.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+#
+# Draws and fills a Hexagon using Document#polygon
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+pdf = Prawn::Document.new
+                        
+pdf.fill_color "ff0000"
+pdf.fill_polygon [100, 250], [200, 300], [300, 250],
+                 [300, 150], [200, 100], [100, 150]            
+
+pdf.render_file "hexagon.pdf"

data/examples/graphics/image_fit.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+# Demonstrates fitting an image within a rectangular width and height.
+# The image will be scaled down to fit within the box, while preserving
+# the aspect ratio.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+   
+Prawn::Document.generate("image_fit.pdf", :page_layout => :landscape) do
+
+  pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" 
+  stroke_rectangle [50,450], 200, 200
+  image pigs, :at => [50,450], :fit => [200,200]
+
+end

data/examples/graphics/image_flow.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+#
+# Demonstrates automated flowing and positioning of images, as well as
+# aligining images along the x-axis via the :position argument.  This is
+# useful when used in combination with flowing text, where the exact final
+# position of the image is not known ahead of time.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+   
+Prawn::Document.generate("image-flow.pdf", :page_layout => :landscape) do  
+  self.font_size = 8                           
+  stef = "#{Prawn::BASEDIR}/data/images/stef.jpg"  
+  
+  text "Image at default position with no arguments"
+  
+  move_down 10
+  
+  image stef 
+  
+  text "Centered image flowing" 
+  
+  image stef, :position => :center   
+  
+  text "Right aligned image flowing"
+                 
+  image stef, :position => :right  
+  
+  text "Explicitly left aligned image flowing"
+                 
+  move_down 10                 
+                 
+  image stef, :position => :left     
+  
+  text "Flowing image at x=50"     
+  
+  image stef, :position => 50
+end

data/examples/graphics/image_position.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# Demonstrates vertical and horizontal positioning of images.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("image_position.pdf", :page_layout => :landscape) do
+
+  dice = "#{Prawn::BASEDIR}/data/images/dice.png"
+
+  image dice, :scale => 0.2, :position => :left,   :vposition => :top
+  image dice, :scale => 0.2, :position => :right,  :vposition => :top
+  image dice, :scale => 0.2, :position => :center, :vposition => :top
+  image dice, :scale => 0.2, :position => :center, :vposition => :center
+  image dice, :scale => 0.2, :position => :center, :vposition => :bottom
+  
+end

data/examples/graphics/line.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+# The very first Prawn example.  Here for nostalgia's sake.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+ 
+pdf = Prawn::Document.new   
+pdf.line_width = 10    
+
+[[100,741,100,641], 
+ [100,691,150,691],
+ [150,741,150,641],
+ [200,741,200,641],   
+ [100,600,100,500],
+ [100,600,150,550],
+ [100,550,150,550],
+ [175,600,175,500], 
+ [175,600,225,550], 
+ [175,550,225,550],
+ [175,550,225,500],
+ [275,600,250,500],
+ [275,600,300,500],   
+ [250,550,300,550],
+ [315,600,350,500],
+ [350,500,365,550], 
+ [365,550,380,500],
+ [380,500,415,600], 
+ [430,600,430,500],
+ [430,600,465,500],
+ [465,600,465,500]].each { |points| pdf.stroke_line(*points) }
+
+pdf.render_file "lines.pdf"

data/examples/graphics/png_types.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# PNG files come in different flavours - 5 of them. This example embeds
+# one of each type as proof that they all work.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+images = [
+          ["Type 0", "#{Prawn::BASEDIR}/data/images/web-links.png"],
+          ["Type 2", "#{Prawn::BASEDIR}/data/images/ruport.png"],
+          ["Type 3", "#{Prawn::BASEDIR}/data/images/rails.png"],
+          ["Type 4", "#{Prawn::BASEDIR}/data/images/page_white_text.png"],
+          ["Type 6", "#{Prawn::BASEDIR}/data/images/dice.png"],
+]
+
+Prawn::Document.generate("png_types.pdf", :page_size => "A5") do
+  images.each do |header, file|
+    start_new_page unless header.include?("0")
+    text header
+    image file, :at => [50,450]
+  end
+end

data/examples/graphics/polygons.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# 
+# Basic polygon drawing example.  See also: hexagon.rb
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+pdf = Prawn::Document.new
+
+10.times do |i|
+  pdf.stroke_polygon [ 50 + i*25,   50 + i*25], 
+                     [100 + i*25,   50 + i*25],
+                     [100 + i*25,  100 + i*25] 
+  pdf.stroke_rectangle [0,600], 5*i, 10*i  
+end
+
+pdf.render_file "pretty_polygons.pdf"

data/examples/graphics/remote_images.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+#
+# Demonstrates how to use open-uri and Document#image to embed remote image
+# files.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+require "open-uri"
+
+Prawn::Document.generate("remote_images.pdf") do 
+  image open("http://prawn.majesticseacreature.com/images/prawn.png")
+end

data/examples/graphics/rounded_polygons.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+def radian(degree)
+  Math::PI/180*degree
+end
+
+def point_on_circle(center, radius, degrees)
+  [center[0] + radius*(Math.cos(radian(degrees))), center[1] - radius*(Math.sin(radian(degrees)))]
+end
+
+pdf = Prawn::Document.new
+
+pentagon_points = (0..4).map{|i| point_on_circle([200, 400], 100, i * 72)}
+pentagram_points = [0, 2, 4, 1, 3].map{|i| pentagon_points[i]}
+pdf.stroke_rounded_polygon(20, *pentagram_points)
+pdf.fill_and_stroke_rounded_polygon(10, [100, 250], [200, 300], [300, 250],
+                 [300, 150], [200, 100], [100, 150])
+
+pdf.render_file "rounded_polygon.pdf"

data/examples/graphics/rounded_rectangle.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+# 
+# Rounded rectangle example demonstrating both stroke and stroke and fill. 
+# A rectangle with rounded join_style is added just for comparison.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+pdf = Prawn::Document.new
+pdf.font_size 8
+pdf.draw_text "a stroked rounded rectangle:", :at => [30, 575]
+pdf.stroke_rounded_rectangle([50, 550], 50, 100, 10)
+pdf.draw_text "a stroked and filled rounded rectangle:", :at => [180, 575]
+pdf.fill_and_stroke_rounded_rectangle([200, 550], 50, 100, 10)
+pdf.draw_text "a regular rectangle with rounded join style;", :at => [330, 575]
+pdf.draw_text "needs thick line width for similar result:", :at => [330, 565]
+pdf.join_style :round
+pdf.line_width 10
+pdf.stroke_rectangle([350, 550], 50, 100)
+
+pdf.render_file "rounded_rectangle.pdf"

data/examples/graphics/ruport_style_helpers.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+#
+# These helpers will be familiar to Ruport users, and now are supported
+# directly in Prawn.   Run the example to see how they work.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+# Demonstrates some features stolen from Ruport::Formatter::PDF
+Prawn::Document.generate("ruport.pdf") do
+  move_down 50
+  # TODO: Figure out where to set the y cursor to.
+  stroke_horizontal_rule
+  text "Hi there"
+  pad(50) { text "I'm Padded" }
+  text "I'm far away"
+  stroke_horizontal_line 50, 100
+  stroke_horizontal_line 50, 100, :at => 300
+  stroke_vertical_line 300, 50, :at => 250
+end