prawn-core 0.5.0.1

data/examples/general/measurement_units.rb

@@ -0,0 +1,52 @@
+# 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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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.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.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,17 @@
+# encoding: utf-8
+#
+# Demonstrates how to set metadata properties via the info option
+# It allows one to specify no standard properties
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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,17 @@
+# encoding: utf-8
+#
+# This demonstrates that Prawn can modify page size, margins and layout for 
+# each individual page, via Document#start_new_page()
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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"
+end

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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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/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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+   
+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 
+  
+  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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+pdf = Prawn::Document.new
+pdf.move_to [100,100]
+pdf.stroke_curve_to [50,50], :bounds => [[20,90], [90,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
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+   
+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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+   
+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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+   
+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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+ 
+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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+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,12 @@
+# encoding: utf-8
+#
+# Demonstrates how to use open-uri and Document#image to embed remote image
+# files.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+require "open-uri"
+
+Prawn::Document.generate("remote_images.pdf") do 
+  image open("http://prawn.majesticseacreature.com/media/prawn_logo.png")
+end

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.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+# 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

data/examples/graphics/stroke_bounds.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+#
+# Demonstrates Document#stroke_bounds, which will stroke a rectange outlining
+# the boundaries of the current bounding box.  This is useful for debugging
+# and can also be used as a light-weight and lower level alternative to
+# Cells.  
+#
+# Feature borrowed from Josh Knowle's pt at:
+# http://github.com/joshknowles/pt/tree/master
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'prawn/core'
+
+Prawn::Document.generate("stroke_bounds.pdf") do 
+  stroke_bounds
+  
+  bounding_box [100,500], :width => 200, :height => 300 do
+    text "Hey there, here's some text. " * 10
+    stroke_bounds
+  end
+end

data/examples/m17n/chinese_text_wrapping.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+#
+# Some text is not usefully wrapped by our naive_wrap which depends on 
+# spaces.  This example shows how to wrap by character instead.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+start = Time.now
+Prawn::Document.generate("chinese_flow.pdf") do  
+  font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"   
+  text_options.update(:wrap => :character, :size => 16)
+  long_text = "更可怕的是，同质化竞争对手可以按照URL中后面这个ID来遍历您的DB中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，这样的话，你就非常被动了。写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事"                                                       
+  text long_text
+  
+  # be sure to restore space based wrapping when dealing with latin scripts
+  text_options.update(:wrap => :spaces)
+  long_text = "Text with some spaces " * 25
+  text long_text
+end

data/examples/m17n/euro.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+# As of Prawn 0.3, it is possible to generate a Euro using the built-in
+# AFM files.  However, you need to be sure to manually add spacing around it,
+# as its calculated width in the AFM files seem to be wrong.
+#
+# We are investigating this issue, but it does not seem to be Prawn specific.
+# If you need precision spacing, use a TTF file instead and the issue will
+# go away.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn/core"
+
+Prawn::Document.generate "euro.pdf" do
+  text "A Euro! € ©", :size => 32
+end