prawn 0.2.3 → 0.3.0

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"
+   
+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/{line.rb → graphics/line.rb}

@@ -1,6 +1,8 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+# The very first Prawn example.  Here for nostalgia's sake.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
  
 pdf = Prawn::Document.new   

data/examples/{png_types.rb → graphics/png_types.rb}

@@ -1,9 +1,9 @@
 # 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 << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
 
 images = [
@@ -20,4 +20,4 @@ Prawn::Document.generate("png_types.pdf", :page_size => "A5") do
     text header
     image file, :at => [50,450]
   end
-end
+end

data/examples/{polygons.rb → graphics/polygons.rb}

@@ -1,6 +1,8 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+# 
+# Basic polygon drawing example.  See also: hexagon.rb
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
 
 pdf = Prawn::Document.new
@@ -12,5 +14,4 @@ pdf = Prawn::Document.new
   pdf.stroke_rectangle [0,600], 5*i, 10*i  
 end
 
-pdf.render_file "pretty_polygons.pdf"
-
+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"
+require "open-uri"
+
+Prawn::Document.generate("remote_images.pdf") do 
+  image open("http://prawn.majesticseacreature.com/media/prawn_logo.png")
+end

data/examples/{ruport_helpers.rb → graphics/ruport_style_helpers.rb}

@@ -1,6 +1,9 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+# 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"
 
 # Demonstrates some features stolen from Ruport::Formatter::PDF
@@ -12,6 +15,6 @@ Prawn::Document.generate("ruport.pdf") do
   pad(50) { text "I'm Padded" }
   text "I'm far away"
   stroke_horizontal_line 50, 100
-  stroke_vertical_line_at 300, 50, 250
-
-end
+  stroke_horizontal_line 50, 100, :at => 300
+  stroke_vertical_line 300, 50, :at => 250
+end

data/examples/graphics/stroke_bounds.rb

@@ -0,0 +1,23 @@
+# 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'
+
+Prawn::Document.generate("stroke_bounds.pdf") do 
+  stroke_bounds
+  
+  bounding_box [100,500], :width => 200, :height => 300 do
+    padded_box(10) do
+      text "Hey there, here's some text. " * 10
+    end
+    stroke_bounds
+  end
+end

data/examples/{chinese_text_wrapping.rb → m17n/chinese_text_wrapping.rb}

@@ -1,6 +1,9 @@
-# coding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+# 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"
 
 start = Time.now
@@ -14,4 +17,4 @@ Prawn::Document.generate("chinese_flow.pdf") do
   text_options.update(:wrap => :spaces)
   long_text = "Text with some spaces " * 25
   text long_text
-end
+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"
+
+Prawn::Document.generate "euro.pdf" do
+  text "A Euro! € ©", :size => 32
+end

data/examples/m17n/sjis.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+#
+# FIXME: Introducing TTFunk into Prawn broke this example and a cooresponding
+# test.  Ticket: #139
+#
+# Tests passing non utf-8 data into Prawns text function. Should
+# be transparently converted to utf-8 and rendered as usual.
+# 
+# NOTE: only works on ruby1.9 compatible VMs, and requires the current
+#       font to include japanese glyphs. On 1.8.x comaptible VMs, an exception
+#       will be raised.
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+begin
+  ruby_19 do  
+    datafile = File.join(File.dirname(__FILE__), "..", "..", "data", 
+      "shift_jis_text.txt")
+    sjis_str = File.open(datafile, "r:shift_jis") { |f| f.gets }
+
+    Prawn::Document.generate("sjis.pdf") do
+      font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+      text sjis_str
+    end       
+  end
+rescue
+  puts "\n FIXME: SJIS Broken due to TTFunk integration."
+end

data/examples/m17n/utf8.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+#
+# Shows that Prawn works out of the box with UTF-8 text, so long as you use
+# a TTF file with the necessary glyphs for your content.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+Prawn::Document.generate("utf8.pdf") do
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  text "ὕαλον ϕαγεῖν δύναμαι· τοῦτο οὔ με βλάπτει." * 20
+end
+
+      

data/examples/m17n/win_ansi_charset.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+#
+# Prints a list of all of the glyphs that can be rendered by Adobe's built
+# in fonts, along with their character widths and WinAnsi codes.  Be sure
+# to pass these glyphs as UTF-8, and Prawn will transcode them for you.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'prawn'
+
+FONT_SIZE = 9.5
+
+Prawn::Document.generate("win-ansi.pdf") do
+  @skip_encoding = true
+
+  x = 0
+  y = bounds.top
+
+  fields = [[20, :right], [8, :left], [12, :center], [30, :right], [8, :left], [0, :left]]
+
+  font "Helvetica", :size => FONT_SIZE
+
+  Prawn::Encoding::WinAnsi::CHARACTERS.each_with_index do |name, index|
+    next if name == ".notdef"
+    y -= FONT_SIZE
+
+    if y < FONT_SIZE
+      y = bounds.top - FONT_SIZE
+      x += 170
+    end
+
+    code = "%d." % index
+    char = index.chr
+
+    width = 1000 * font.metrics.string_width(char, FONT_SIZE) / FONT_SIZE
+    size = "%d" % width
+
+    data = [code, nil, char, size, nil, name]
+    dx = x
+    fields.zip(data).each do |(total_width, align), field|
+      if field
+        width = font.metrics.string_width(field, FONT_SIZE)
+
+        case align
+        when :left then offset = 0
+        when :right then offset = total_width - width
+        when :center then offset = (total_width - width)/2
+        end
+
+        text(field, :at => [dx + offset, y])
+      end
+
+      dx += total_width
+    end
+  end
+end

data/examples/{cell.rb → table/cell.rb}

@@ -1,18 +1,20 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+# Low level cell and row implementation, which form the basic building
+# blocks for Prawn tables.  Only necessary to know about if you plan on
+# building your own table implementation from scratch or heavily modify
+# the existing table system.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
 
-# If this looks a somewhat Byzantine, don't worry.  It's a temporary interface
-# to low level objects I'll be using for table building support (and other fun
-# stuff )
 Prawn::Document.generate("cell.pdf") do 
   cell = Prawn::Graphics::Cell.new(
     :border_width => 3, :padding => 10, :width => 75,
     :text => "You know that kittens are made of mud!", :document => self)
   cell2 = Prawn::Graphics::Cell.new(
     :border_width => 3, :padding => 10,
-    :text => "And that puppies are made of gravy", :document => self)
+    :text => "And that puppies are made of gravy", :document => self, :font_size => 9)
   cell3 = Prawn::Graphics::Cell.new(
     :border_width => 3, :padding => 10, :width => 100, 
     :text => "This is simply the way of the world", :document => self)

data/examples/{fancy_table.rb → table/fancy_table.rb}

@@ -1,6 +1,8 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+# Demonstrates various table and cell features.  
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
 require "rubygems"
    
@@ -8,17 +10,18 @@ headers, body = nil, nil
      
 ruby_18 do        
   require "fastercsv" 
-  headers, *body = FasterCSV.read("#{Prawn::BASEDIR}/examples/addressbook.csv")   
+  headers, *body = FasterCSV.read("#{Prawn::BASEDIR}/examples/table/addressbook.csv")   
 end
 
 ruby_19 do            
   require "csv"
-  headers, *body = CSV.read("#{Prawn::BASEDIR}/examples/addressbook.csv")
-  headers.map! { |e| e.encode("UTF-8") }
-  body.map! { |e| e.map! { |x| x.encode("UTF-8") } }
+  headers, *body = CSV.read("#{Prawn::BASEDIR}/examples/table/addressbook.csv", 
+                      :encoding => "utf-8")
 end
                                                                                   
 Prawn::Document.generate("fancy_table.pdf", :page_layout => :landscape) do
+  
+  #font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
 
   mask(:y) { table body, :headers      => headers, 
                          :align        => :center,

data/examples/{ruport_formatter.rb → table/ruport_formatter.rb}

@@ -1,6 +1,9 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+# A simple proof of concept of building a Prawn based PDF formatter for
+# Ruport tables.  Requires Ruby Reports to run.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"                                                 
 
 ruby_18 do
@@ -43,7 +46,7 @@ ruby_18 do
   end
 
   if __FILE__ == $PROGRAM_NAME
-    t = Table("#{Prawn::BASEDIR}/examples/addressbook.csv")
+    t = Table("#{Prawn::BASEDIR}/examples/table/addressbook.csv")
     headers = t.column_names.map { |c| c.capitalize }
     t.save_as "addressbook_ruport.pdf", :headers => headers
   end  

data/examples/{table.rb → table/table.rb}

@@ -1,6 +1,10 @@
 # encoding: utf-8
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+#
+# Generates a couple simple tables, including some UTF-8 text cells.
+# Although this does not show all of the options available to table, the most
+# common are used here.  See fancy_table.rb for a more comprehensive example.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
 
 Prawn::Document.generate("table.pdf") do 

data/examples/table/table_alignment.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# Demonstrates the many controls over alignment and positioning in Prawn
+# tables.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+Prawn::Document.generate "table_header_align.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'],
+	  ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 20,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid,
+  :align => { 0 => :right, 1 => :left, 2 => :right, 3 => :right, 4 => :right },
+  :align_headers => { 0 => :center, 2 => :left, 3 => :left, 4 => :right }
+end

data/examples/table/table_border_color.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+#
+# Demonstrates how to set the table border color with the :border_color
+# attribute.
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+Prawn::Document.generate "table_border_color.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+          ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 20,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid,
+  :border_color => "ff0000"
+end

data/examples/table/table_colspan.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+# Demonstrates the use of the :col_span option when using Document#table
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+Prawn::Document.generate "table_colspan.pdf" do
+  data = [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+           ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 5
+  
+  data << [{:text => 'Total', :colspan => 2}, '37.0', '1002.5', '3833']
+  
+  table data,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid
+end

data/examples/table/table_header_color.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+# Demonstrates explicitly setting the :header_color rather than inferring
+# it from :row_colors in Document#table
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+Prawn::Document.generate "table_header_color.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+          ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 20,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid,
+  :header_color => 'f07878',
+  :header_text_color  => "990000",
+  :row_colors => ["FFCCFF","CCFFCC"]
+end