prawn-core 0.7.2 → 0.8.4

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 require "rake/rdoctask"
 require "rake/gempackagetask"  
 
-PRAWN_VERSION = "0.7.2" 
+PRAWN_VERSION = "0.8.4" 
 
 task :default => [:test]
        

data/examples/general/background.rb

@@ -8,7 +8,7 @@ require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 img = "#{Prawn::BASEDIR}/data/images/letterhead.jpg"
 
-Prawn::Document.generate("background.pdf", :background => img) do
+Prawn::Document.generate("background.pdf", :background => img, :margin => 100) do
   text "My report caption", :size => 18, :align => :right
 
   move_down font.height * 2

data/examples/general/measurement_units.rb

@@ -34,13 +34,13 @@ units.each_with_index do |unit, unit_index| #iterate through all units that make
   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.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.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
+    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
 

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/repeaters.rb

@@ -10,32 +10,36 @@ require "#{File.dirname(__FILE__)}/../example_helper.rb"
 Prawn::Document.generate("repeat.pdf", :skip_page_creation => true) do
 
   repeat :all do
-    text "ALLLLLL", :at => bounds.top_left
+    draw_text "ALLLLLL", :at => bounds.top_left
   end
 
   repeat :odd do
-    text "ODD", :at => [0,0]
+    draw_text "ODD", :at => [0,0]
   end
 
   repeat :even do
-    text "EVEN", :at => [0,0]
+    draw_text "EVEN", :at => [0,0]
   end
 
   repeat [1,2] do 
-    text "[1,2]", :at => [100,0]
+    draw_text "[1,2]", :at => [100,0]
   end
 
   repeat 2..4 do
-    text "2..4", :at => [200,0]
+    draw_text "2..4", :at => [200,0]
   end
 
   repeat(lambda { |pg| pg % 3 == 0 }) do
-    text "Every third", :at => [250, 20]
+    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
-    text "A wonderful page", :at => [400,400]
+    draw_text "A wonderful page", :at => [400,400]
   end
 
 end

data/examples/general/stamp.rb

@@ -7,15 +7,15 @@ require "#{File.dirname(__FILE__)}/../example_helper.rb"
 Prawn::Document.generate("stamp.pdf", :skip_page_creation => true) do
 
   create_stamp("odd_page_template") do
-    text "This is the odd page template", 
-      :at => [0, bounds.top - font.height] 
-    text "This is also in the odd page template", :at => [0, 0] 
+    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
-    text "This is the even page template", 
-      :at => [0, bounds.top - font.height] 
-    text "This is also in the even page template", :at => [0, 0] 
+    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

data/examples/graphics/basic_images.rb

@@ -13,7 +13,7 @@ Prawn::Document.generate("basic_images.pdf", :page_layout => :landscape) do
   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]   
+  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 

data/examples/graphics/curves.rb

@@ -6,6 +6,6 @@ require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 pdf = Prawn::Document.new
 pdf.move_to [100,100]
-pdf.stroke_curve_to [50,50], :bounds => [[20,90], [90,90]]  
+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/rounded_polygons.rb

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+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,20 @@
+# 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.dirname(__FILE__)}/../example_helper.rb"
+
+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/transformations.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+#
+# Demonstrates transformations
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "transformations.pdf" do |pdf|
+  width = 50
+  height = 100
+
+  # ROTATION
+  x = 50
+  y = pdf.bounds.top - 50
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.draw_text("reference rectangle", :at => [x + width, y - height])
+  pdf.rotate(30, :origin => [x, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+    pdf.draw_text("rectangle rotated around upper-left corner", :at => [x + width, y - height])
+  end
+
+  x = 50
+  y = pdf.bounds.top - 200
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.draw_text("reference rectangle", :at => [x + width, y - height])
+  pdf.rotate(30, :origin => [x + width / 2, y - height / 2]) do
+    pdf.stroke_rectangle([x, y], width, height)
+    pdf.draw_text("rectangle rotated around center", :at => [x + width, y - height])
+  end
+
+  # SCALE
+  x = 0
+  y = pdf.bounds.top - 500
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.draw_text("reference rectangle", :at => [x + width, y - height])
+  pdf.scale(2, :origin => [x, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+    pdf.draw_text("rectangle scaled from upper-left corner", :at => [x + width, y - height])
+  end
+
+  x = 150
+  y = pdf.bounds.top - 400
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.draw_text("reference rectangle", :at => [x + width, y - height])
+  pdf.scale(2, :origin => [x + width / 2, y - height / 2]) do
+    pdf.stroke_rectangle([x, y], width, height)
+    pdf.draw_text("rectangle scaled from center", :at => [x + width, y - height])
+  end
+end

data/examples/m17n/win_ansi_charset.rb

@@ -45,7 +45,7 @@ Prawn::Document.generate("win-ansi.pdf") do
         when :center then offset = (total_width - width)/2
         end
 
-        text(field, :at => [dx + offset, y])
+        draw_text(field, :at => [dx + offset, y])
       end
 
       dx += total_width

data/examples/text/font_calculations.rb

@@ -25,9 +25,9 @@ Prawn::Document.generate('font_calculations.pdf') do
     bl = y - bounds.absolute_bottom
 
     stroke_horizontal_rule
-    text "When using text positioned with :at, the baseline is used", :at => [0, bl]
+    draw_text "When using text positioned with :at, the baseline is used", :at => [0, bl]
 
-    text "(and the Y-cursor is not moved)", :at => [350, bl]
+    draw_text "(and the Y-cursor is not moved)", :at => [350, bl]
 
     colors = { :ascender    => "ff0000", 
                :descender   => "00ff00",
@@ -57,7 +57,7 @@ Prawn::Document.generate('font_calculations.pdf') do
     move_down 40
 
     bl = y - bounds.absolute_bottom
-    text "The quick brown fox jumps over the lazy dog.", :at => [0, bl]
+    draw_text "The quick brown fox jumps over the lazy dog.", :at => [0, bl]
 
     stroke_color colors[:ascender]
     stroke_line [0, bl], [0, bl + font.ascender]

data/examples/text/indent_paragraphs.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# An early example of basic text generation at absolute positions.
+# Mostly kept for nostalgia.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "indent_paragraphs.pdf" do |pdf|
+  hello = "hello " * 50
+  world = "world " * 50
+  pdf.text(hello + "\n" + world, :indent_paragraphs => 60)
+
+  pdf.move_cursor_to(pdf.font.height)
+  pdf.text(hello + "\n" + world, :indent_paragraphs => 60)
+
+  pdf.move_cursor_to(pdf.font.height * 3)
+  pdf.text(hello + "\n" + world, :indent_paragraphs => 60)
+end

data/examples/text/kerning.rb

@@ -5,8 +5,8 @@
 require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "kerning.pdf" do
-  text "To kern?", :at => [200,720], :size => 24, :kerning => true
-  text "To not kern?", :at => [200,690], :size => 24, :kerning => false 
+  draw_text "To kern?", :at => [200,720], :size => 24, :kerning => true
+  draw_text "To not kern?", :at => [200,690], :size => 24, :kerning => false 
   
   move_down 100
                                                                      
@@ -18,8 +18,8 @@ Prawn::Document.generate "kerning.pdf" do
 
   font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
   
-  text "To kern?", :at => [200,660], :size => 24, :kerning => true
-  text "To not kern?", :at => [200,630], :size => 24, :kerning => false     
+  draw_text "To kern?", :at => [200,660], :size => 24, :kerning => true
+  draw_text "To not kern?", :at => [200,630], :size => 24, :kerning => false     
   
   pad(30) do
     text "To kern and wrap. " * 5, :size => 24, :kerning => true   

data/examples/text/rotated.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+#
+# Demonstrates transformations
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "rotated_text.pdf" do |pdf|
+  pdf.line_width = 1
+  width = 150
+  height = 200
+  half_width = width / 2
+  half_height = height / 2
+  angle = 30
+
+
+  # AROUND THE CENTER
+  
+  x = pdf.bounds.width / 2 - half_width
+  y = pdf.bounds.height / 2 + half_height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + half_width, y - half_height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around the center " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :center)
+
+  
+  # AROUND THE UPPER_LEFT_CORNER
+  
+  x = pdf.bounds.width - width
+  y = height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around upper left corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle)
+
+  
+  # AROUND THE UPPER_RIGHT_CORNER
+  
+  x = 0
+  y = height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + width, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around upper right corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :upper_right)
+
+  
+  # AROUND THE LOWER_RIGHT_CORNER
+  
+  x = 0
+  y = pdf.bounds.height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + width, y - height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around lower right corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :lower_right)
+
+  
+  # AROUND THE LOWER_LEFT_CORNER
+  
+  x = pdf.bounds.width - width
+  y = pdf.bounds.height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x, y - height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around lower left corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :lower_left)
+end

data/examples/text/simple_text.rb

@@ -7,11 +7,11 @@ require "#{File.dirname(__FILE__)}/../example_helper.rb"
 
 Prawn::Document.generate "simple_text.pdf" do       
   fill_color "0000ff"
-  text "Hello World", :at => [200,420], :size => 32, :rotate => 45
+  draw_text "Hello World", :at => [200,420], :size => 32, :rotate => 45
   font "Times-Roman"     
   fill_color "ff0000"
-  text "Using Another Font", :at => [5,5]    
+  draw_text "Using Another Font", :at => [5,5]    
   start_new_page        
   font "Courier"       
-  text "Goodbye World", :at => [288,50]     
+  draw_text "Goodbye World", :at => [288,50]     
 end