prawn-layout 0.2.1 → 0.3.1

data/vendor/prawn-core/examples/text/family_based_styling.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+#
+# This example demonstrates using the :style option for Document#text.
+# If you are working with TTF fonts, you'll want to check out the 
+# documentation for Document#font_families and register your fonts with it.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("family_style.pdf") do
+  ["Courier","Helvetica","Times-Roman"].each do |f|
+    [:bold,:bold_italic,:italic,:normal].each do |s|
+      font f, :style => s
+      text "I'm writing in #{f} (#{s})"
+    end
+  end
+  
+  font "Helvetica"
+  
+  text "Normal"
+  text "Bold",        :style => :bold
+  text "Bold Italic", :style => :bold_italic
+  text "Italic",      :style => :italic
+  text "Normal"
+end

data/vendor/prawn-core/examples/text/font_calculations.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+# 
+# This example is a demonstration of how Prawn does its text positioning,
+# meant to assist those that need to do advanced positioning calculations.
+# Run the example for a clearer picture of how things work
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate('font_calculations.pdf') do
+  
+  def demonstration
+    font_size 12
+    move_down 10
+
+    stroke_horizontal_rule
+
+    text "When using flowing text, Prawn will position text\n" +
+         "starting font.ascender below the baseline, and leave\n" +
+         "the y-cursor at the baseline of the next line of text"
+
+    stroke_horizontal_rule
+
+    move_down 20
+
+    bl = y - bounds.absolute_bottom
+
+    stroke_horizontal_rule
+    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]
+
+    colors = { :ascender    => "ff0000", 
+               :descender   => "00ff00",
+               :line_gap    => "0000ff",
+               :font_height => "005500" }
+
+
+    pad(20) do                    
+      text "Calculations Demo", :size => 16
+    end
+
+    fill_color colors[:ascender]
+    text "ASCENDER"
+
+    fill_color colors[:descender]
+    text "DESCENDER"
+
+    fill_color colors[:line_gap]
+    text "LINEGAP" 
+
+    fill_color colors[:font_height]
+    text "FONT_HEIGHT"
+
+    fill_color "000000"
+    font_size 16
+
+    move_down 40
+
+    bl = y - bounds.absolute_bottom
+    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]
+    stroke_line [0, bl + font.ascender], [bounds.width, bl + font.ascender]
+
+    stroke_color colors[:descender]
+    stroke_line [0,bl], [0, bl + font.descender]
+    stroke_line [0, bl + font.descender], [bounds.width, bl + font.descender]
+
+    stroke_color colors[:line_gap]
+    stroke_line [0, bl + font.descender], [0,bl + font.descender - font.line_gap]
+    stroke_line [0, bl + font.descender - font.line_gap], 
+                [bounds.width,bl + font.descender - font.line_gap]
+
+    stroke_color colors[:font_height]
+    stroke_line [bounds.width, bl + font.ascender],
+                [bounds.width, bl + font.descender - font.line_gap]
+                
+    stroke_color "000000"
+    fill_color "000000"
+  end
+  
+  text "Using AFM", :size => 20
+  demonstration
+  
+  move_down 75
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  text "Using TTF", :size => 20
+  demonstration
+  
+end

data/vendor/prawn-core/examples/text/font_size.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+# This example shows the many ways of setting font sizes in Prawn
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
+
+  # Explicit global changes
+  font 'Helvetica'
+  self.font_size = 16
+
+  text 'Font at 16 point'
+
+  # Transactional changes rolled back after block exit
+  font_size 9 do
+    text 'Font at 9 point'
+    # single line changes, not persisted.
+    text 'Font at manual override 20 point', :size => 20
+    text 'Font at 9 point'
+  end
+
+  # Transactional changes rolled back after block exit on full fonts.
+  font("Times-Roman", :style => :italic, :size => 12) do
+    text "Font in times at 12"
+    font_size(16) { text "Font in Times at 16" }
+  end
+
+  text 'Font at 16 point'
+
+  font "Courier", :size => 40
+  text "40 pt!"
+end

data/vendor/prawn-core/examples/text/kerning.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# Demonstration of enabling and disabling kerning support
+#
+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 
+  
+  move_down 100
+                                                                     
+  pad(30) do
+    text "To kern and wrap. " * 5, :size => 24, :kerning => true   
+  end
+  
+  text "To not kern and wrap. " * 5, :size => 24, :kerning => false
+
+  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     
+  
+  pad(30) do
+    text "To kern and wrap. " * 5, :size => 24, :kerning => true   
+  end
+  
+  text "To not kern and wrap. " * 5, :size => 24, :kerning => false
+  
+end

data/vendor/prawn-core/examples/text/simple_text.rb

@@ -0,0 +1,17 @@
+# 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 "simple_text.pdf" do       
+  fill_color "0000ff"
+  text "Hello World", :at => [200,420], :size => 32, :rotate => 45
+  font "Times-Roman"     
+  fill_color "ff0000"
+  text "Using Another Font", :at => [5,5]    
+  start_new_page        
+  font "Courier"       
+  text "Goodbye World", :at => [288,50]     
+end

data/vendor/prawn-core/examples/text/simple_text_ttf.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+#
+# An early example of TTF font embedding.  Mostly kept for nostalgia's sake.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "simple_text_ttf.pdf" do       
+  fill_color "0000ff"
+  font "#{Prawn::BASEDIR}/data/fonts/comicsans.ttf" 
+  text "Hello World", :at => [200,720], :size => 32         
+
+  font "#{Prawn::BASEDIR}/data/fonts/Chalkboard.ttf"
+
+  pad(20) do
+    text "This is chalkboard wrapping " * 20
+  end
+end

data/vendor/prawn-core/examples/text/span.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+#
+# Demonstration of Document#span, which is used for generating flowing
+# columns of text.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("span.pdf") do
+  
+  # Spans will typically be used outside of bounding boxes as a way to build
+  # single columns of flowing text that span across pages.
+  #
+  span(350, :position => :center) do
+    text "Here's some centered text in a 350 point column. " * 100
+  end
+  
+  # Spans are not really compatible with bounding boxes because they break
+  # the nesting chain and also may position text outside of the bounding box
+  # boundaries, but sometimes you may wish to use them anyway for convenience
+  # Here's an example of how to do that dynamically.
+  # 
+  bounding_box([50,300], :width => 400) do
+    text "Here's some default bounding box text. " * 10 
+    span(bounds.width, 
+      :position => bounds.absolute_left - margin_box.absolute_left) do
+      text "The rain in spain falls mainly on the plains. " * 300
+    end
+  end
+end

data/vendor/prawn-core/examples/text/text_box.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# A text box is positioned by a top-left corner, width, and height and is
+# essentially an invisible rectangle that the text will flow within.  If the
+# text exceeds the boundaries, it is either truncated, replaced with some
+# ellipses, or set to expand beyond the bottom boundary.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("text_box.pdf") do
+
+  text_box "Oh hai text box. " * 200, 
+    :width    => 300, :height => font.height * 5,
+    :overflow => :ellipses, 
+    :at       => [100,bounds.top]
+
+  text_box "Oh hai text box. " * 200,
+    :width    => 250, :height => font.height * 10,
+    :overflow => :truncate,
+    :at       => [50, 300]
+
+  move_down 20
+
+  text_box "Oh hai text box. " * 100, :overflow => :expand
+end

data/vendor/prawn-core/examples/text/text_box_returning_excess.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+#
+# A text box is positioned by a top-left corner, width, and height and is
+# essentially an invisible rectangle that the text will flow within.  If the
+# text exceeds the boundaries, it is either truncated, replaced with some
+# ellipses, or set to expand beyond the bottom boundary.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("text_box_returning_excess.pdf") do
+
+  # Note that without the initial space in p_break, newlines may be eaten by
+  # the wrap/unwrap process that happens inside the text box.
+  p_break = " \n\n"
+  callout = "Lorem ipsum dolor sit amet"
+  lorem   = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.#{p_break}Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.#{p_break}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."
+
+  box_height = font.height * 5
+
+  # Add a callout box that the rest of the text should flow around
+  font_size(18) do
+    text_box callout, {
+      :width    => 100,
+      :height   => font.height * 3,
+      :overflow => :truncate,
+      :at       => [100, bounds.top - box_height - 4]
+    }
+  end
+
+  excess_text = text_box lorem + p_break + lorem, {
+    :width    => 300,
+    :height   => box_height,
+    :overflow => :truncate,
+    :at       => [100, bounds.top],
+  }
+
+  excess_text = text_box excess_text, {
+    :width    => 200,
+    :height   => box_height,
+    :overflow => :truncate,
+    :at       => [200, bounds.top - box_height],
+  }
+
+  text_box excess_text, {
+    :width    => 300,
+    :height   => box_height,
+    :overflow => :expand,
+    :at       => [100, bounds.top - box_height * 2],
+  }
+
+end

data/vendor/prawn-core/examples/text/text_flow.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+# 
+# Basic text flowing example including the use of bounding boxes.  A somewhat
+# old example, mostly retained for nostalgia.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+content = <<-EOS
+How does
+Prawn    deal     with
+   white
+     space 
+     
+       and
+       
+       line
+       breaks?
+EOS
+
+poem = <<-EOS
+GOOD-BYE
+
+Good-bye, proud world! I'm going home: Thou art not my friend, and I'm not thine. Long through thy weary crowds I roam; A river-ark on the ocean brine, Long I've been tossed like the driven foam: But now, proud world! I'm going home.
+
+Good-bye to Flattery's fawning face; To Grandeur with his wise grimace; To upstart Wealth's averted eye; To supple Office, low and high; To crowded halls, to court and street; To frozen hearts and hasting feet; To those who go, and those who come; Good-bye, proud world! I'm going home.
+
+I am going to my own hearth-stone, Bosomed in yon green hills alone,-- secret nook in a pleasant land, Whose groves the frolic fairies planned; Where arches green, the livelong day, Echo the blackbird's roundelay, And vulgar feet have never trod A spot that is sacred to thought and God.
+
+O, when I am safe in my sylvan home, I tread on the pride of Greece and Rome; And when I am stretched beneath the pines, Where the evening star so holy shines, I laugh at the lore and the pride of man, At the sophist schools and the learned clan; For what are they all, in their high conceit, When man in the bush with God may meet?
+EOS
+
+overflow = "This text should flow gracefully onto the next page, like a stream"+
+           " flows elegantly from a mountain lake down into the village below."
+
+Prawn::Document.generate("flow.pdf") do |pdf|
+
+  pdf.font "Times-Roman"
+  pdf.stroke_line [pdf.bounds.left,  pdf.bounds.top],
+                  [pdf.bounds.right, pdf.bounds.top]
+  
+  pdf.text content, :size => 10
+               
+  pdf.bounding_box([100,600], :width => 200, :height => 525) do
+    pdf.stroke_line [pdf.bounds.left,  pdf.bounds.top],
+                    [pdf.bounds.right, pdf.bounds.top]
+    pdf.text poem, :size => 12
+  end
+  
+  pdf.bounding_box([325,600], :width => 200, :height => 525) do
+    pdf.stroke_line [pdf.bounds.left,  pdf.bounds.top],
+                    [pdf.bounds.right, pdf.bounds.top]
+    pdf.text poem.reverse, :size => 12
+  end
+  
+  pdf.text overflow * 10, :size => 14
+  
+  pdf.text "Hooray! We've conquered the evil PDF gods", :size => 36
+               
+  pdf.bounding_box([100,450], :width => 300) do
+    pdf.stroke_line [pdf.bounds.left,  pdf.bounds.top],
+                    [pdf.bounds.right, pdf.bounds.top]
+    pdf.text poem, :size => 10, :leading => 5
+  end
+  
+  pdf.text "And this text automatically goes below the poem", :size => 18
+  
+end

data/vendor/prawn-core/lib/prawn/byte_string.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module Prawn
+  # This is used to differentiate strings that must be encoded as
+  # a byte string, such as binary data from encrypted strings.
+  class ByteString < String #:nodoc:
+  end
+end

data/vendor/prawn-core/lib/prawn/compatibility.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+#
+# Why would we ever use Ruby 1.8.7 when we can backport with something
+# as simple as this?
+#
+class String  #:nodoc:
+  unless "".respond_to?(:lines)
+    alias_method :lines, :to_a
+  end
+end
+
+unless File.respond_to?(:binread)
+  def File.binread(file) 
+    File.open(file,"rb") { |f| f.read } 
+  end
+end
+
+if RUBY_VERSION < "1.9"
+  
+  def ruby_18  #:nodoc:  
+    yield
+  end
+  
+  def ruby_19  #:nodoc:  
+    false
+  end
+     
+else  
+ 
+  def ruby_18  #:nodoc:  
+    false  
+  end
+  
+  def ruby_19  #:nodoc:  
+    yield
+  end 
+  
+end 

data/vendor/prawn-core/lib/prawn/core.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+# Prawn : A library for PDF generation in Ruby
+#
+# Copyright April 2008, Gregory Brown. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+%w[ttfunk/lib].each do |dep|
+  $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../../vendor/#{dep}")
+end
+
+begin
+  require 'ttfunk'
+rescue LoadError
+  puts "Failed to load ttfunk. If you are running Prawn from git:"
+  puts "  git submodule init"
+  puts "  git submodule update"
+  exit
+end
+
+module Prawn
+  file = __FILE__
+  file = File.readlink(file) if File.symlink?(file)
+  dir = File.dirname(file)
+                          
+  # The base source directory for Prawn as installed on the system
+  BASEDIR = File.expand_path(File.join(dir, '..', '..'))
+  
+  VERSION = "0.6.1"
+  
+  extend self
+
+  # Whe set to true, Prawn will verify hash options to ensure only valid keys
+  # are used.  Off by default.
+  #
+  # Example:
+  #   >> Prawn::Document.new(:tomato => "Juicy")
+  #   Prawn::Errors::UnknownOption: 
+  #   Detected unknown option(s): [:tomato]
+  #   Accepted options are: [:page_size, :page_layout, :left_margin, ...]
+  #
+  attr_accessor :debug
+  
+  def verify_options(accepted,actual) #:nodoc:
+    return unless debug || $DEBUG
+    require "set"
+    unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
+      raise Prawn::Errors::UnknownOption,
+        "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
+        "Accepted options are: #{accepted.inspect}"
+    end
+    yield if block_given?
+  end
+  
+  module Configurable #:nodoc:
+    def configuration(*args)
+      @config ||= Marshal.load(Marshal.dump(default_configuration))
+      if Hash === args[0]
+        @config.update(args[0])
+      elsif args.length > 1
+        @config.values_at(*args)
+      elsif args.length == 1
+        @config[args[0]]
+      else
+        @config
+      end
+    end
+    
+    alias_method :C, :configuration
+  end
+end
+ 
+require "prawn/compatibility"
+require "prawn/errors"
+require "prawn/pdf_object"
+require "prawn/object_store"
+require "prawn/graphics"
+require "prawn/images"
+require "prawn/images/jpg"
+require "prawn/images/png"
+require "prawn/stamp"
+require "prawn/document"
+require "prawn/reference"
+require "prawn/font"
+require "prawn/encoding"
+require "prawn/measurements"