prawn 0.1.2 → 0.2.0

data/README

@@ -4,7 +4,7 @@ just like the majestic sea creature.
 Development on this library is made possible thanks to the many people who
 donated to the Ruby Mendicant project:
 
-http://rubymendicant.wikidot.com      
+http://rubymendicant.wikidot.com   
 
 RESOURCES:
 
@@ -26,5 +26,19 @@ http://groups.google.com/group/prawn-ruby
 
 IRC:
 
-I am <sandal> in #ruport, #prawn, or #rubymendicant on Freenode.
+Find us in #prawn on irc.freenode.net
+  Gregory Brown: <sandal>
+  James Healy: <yob>               
+  
+NOTES TO DEVELOPERS: 
 
+You will need the pdf-reader and test-spec gems to run Prawn.  Be sure to run
+the specs on both Ruby 1.8.6 and the latest Ruby 1.9 snapshot, as both versions
+are supported.  1.8.7 is *not* officially supported.
+
+Prawn relies on PDF::Inspector, a collection of PDF::Reader backed classes
+for analyzing PDF output.  This is provided as a submodule in Prawn's git
+repository, so be sure to do the following before running the specs:
+
+  git submodule init
+  git submodule update    

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 require "rake/rdoctask"
 require "rake/gempackagetask"  
 
-PRAWN_VERSION = "0.1.2" 
+PRAWN_VERSION = "0.2.0" 
 
 task :default => [:test]
        
@@ -35,9 +35,9 @@ end
 desc "run all examples, and then diff them against reference PDFs"
 task :examples do 
   mkdir_p "output"
-  examples = Dir["examples/*.rb"].reject { |e| e =~ /bench/ }   
+  examples = Dir["examples/*.rb"]
   t = Time.now
-  puts "Running Examples, skipping benchmark"
+  puts "Running Examples"
   examples.each { |file| `ruby -Ilib #{file}` }  
   puts "Ran in #{Time.now - t} s"        
   `mv *.pdf output`                     

data/examples/cell.rb

@@ -8,13 +8,13 @@ require "prawn"
 # stuff )
 Prawn::Document.generate("cell.pdf") do 
   cell = Prawn::Graphics::Cell.new(
-    :border => 3, :padding => 10, :width => 75,
+    :border_width => 3, :padding => 10, :width => 75,
     :text => "You know that kittens are made of mud!", :document => self)
   cell2 = Prawn::Graphics::Cell.new(
-    :border => 3, :padding => 10,
+    :border_width => 3, :padding => 10,
     :text => "And that puppies are made of gravy", :document => self)
   cell3 = Prawn::Graphics::Cell.new(
-    :border => 3, :padding => 10, :width => 100, 
+    :border_width => 3, :padding => 10, :width => 100, 
     :text => "This is simply the way of the world", :document => self)
 
     3.times do
@@ -22,6 +22,17 @@ Prawn::Document.generate("cell.pdf") do
       cellblock << cell << cell2 << cell3
       cellblock.draw
     end
+    
+  move_down(20)  
+    
+  cellblock = Prawn::Graphics::CellBlock.new(self)
+  cellblock << Prawn::Graphics::Cell.new(
+    :border_width => 3, 
+    :padding => 10, 
+    :borders => [:left, :top],
+    :width => 100, 
+    :text => "This is simply the way of the world", :document => self)
+  cellblock.draw
 
   stroke_line [100,100], [200,200]
 end

data/examples/chinese_text_wrapping.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require "prawn"
+
+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/family_based_styling.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require "prawn"
+
+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/examples/fancy_table.rb

@@ -30,7 +30,7 @@ Prawn::Document.generate("fancy_table.pdf", :page_layout => :landscape) do
           "Drawn Side"], ["By side",   "and stuff" ]], 
     :position         => 600, 
     :headers          => ["Col A", "Col B"],
-    :border           => 1,
+    :border_width     => 1,
     :vertical_padding => 5,
     :horizontal_padding => 3,
     :font_size        => 10,
@@ -41,7 +41,7 @@ Prawn::Document.generate("fancy_table.pdf", :page_layout => :landscape) do
 
   table [%w[1 2 3],%w[4 5 6],%w[7 8 9]], 
     :position => :center,
-    :border   => 0,
+    :border_width   => 0,
     :font_size => 40
 
   cell [500,300],
@@ -49,9 +49,9 @@ Prawn::Document.generate("fancy_table.pdf", :page_layout => :landscape) do
       "cells outside of a table with ease.  Think of a 'cell' as " +
       "simply a limited purpose bounding box that is meant for laying " +
       "out blocks of text and optionally placing a border around it",
-    :width => 225, :padding => 10, :border => 2
+    :width => 225, :padding => 10, :border_width => 2
 
-  font_size! 24
+  font.size = 24
   cell [50,75], 
     :text => "This document demonstrates a number of Prawn's table features",
     :border_style => :no_top, # :all, :no_bottom, :sides

data/examples/flowing_text_with_header_and_footer.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8       
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require "prawn"                                           
+
+Prawn::Document.generate("flow_with_headers_and_footers.pdf")  do
+
+  header margin_box.top_left do 
+    text "Here's My Fancy Header", :size => 25, :align => :center   
+    stroke_horizontal_rule
+  end   
+                
+  footer [margin_box.left, margin_box.bottom + 25] do
+    stroke_horizontal_rule
+    text "And here's a sexy footer", :size => 16
+  end
+                                      
+  bounding_box([bounds.left, bounds.top - 50], 
+      :width  => bounds.width, :height => bounds.height - 100) do                 
+   text "this is some flowing text " * 200    
+   
+   move_down(20)
+   
+   font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+   table [["ὕαλον ϕαγεῖν",    "baaar",             "1" ],
+          ["This is","a sample",          "2" ],
+          ["Table",  "dont\ncha\nknow?",  "3" ],
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules\nwith an iron fist", "x" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],   
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ],  
+          [ "It",    "Rules",             "4" ],     
+          [ "It",    "Rules",             "4" ]],     
+
+     :font_size          => 24, 
+     :horizontal_padding => 10,
+     :vertical_padding   => 3,
+     :border_width       => 2,
+     :position           => :center,
+     :headers            => ["Column A","Column B","#"]
+          
+ end    
+ 
+end       
+                

data/examples/font_size.rb

@@ -5,11 +5,11 @@ require "prawn"
 
 Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
   font 'Helvetica'
-  font_size! 16
+  font.size = 16
   
   text 'Font at 16 point'
   
-  font_size 9 do
+  font.size 9 do
     text 'Font at 9 point'
     text 'Font at manual override 20 point', :size => 20
     text 'Font at 9 point'

data/examples/lazy_bounding_boxes.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require "prawn"                                           
+                                                    
+file = "lazy_bounding_boxes.pdf"
+Prawn::Document.generate(file, :skip_page_creation => true) do                    
+  point = [bounds.right-50, bounds.bottom + 25]
+  page_counter = lazy_bounding_box(point, :width => 50) do   
+    text "Page: #{page_count}"
+  end 
+  
+  10.times do         
+    start_new_page
+    text "Some text"  
+    page_counter.draw
+  end
+end
+  
+   
+    

data/examples/table.rb

@@ -5,13 +5,13 @@ require "prawn"
 
 Prawn::Document.generate("table.pdf") do 
   font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
-  table [["ὕαλον ϕαγεῖν",    "baaar",             "1" ],
+  table [["ὕαλον ϕαγεῖν",    "baaar",    "1" ],
          ["This is","a sample",          "2" ],
          ["Table",  "dont\ncha\nknow?",  "3" ],
          [ "It",    "Rules",             "4" ],     
          [ "It",    "Rules",             "4" ],     
-         [ "It",    "Rules",             "4" ],     
-         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4123231" ],     
+         [ "It",    "Rules",             "22.5" ],     
          [ "It",    "Rules",             "4" ],     
          [ "It",    "Rules",             "4" ],     
          [ "It",    "Rules",             "4" ],     
@@ -30,14 +30,16 @@ Prawn::Document.generate("table.pdf") do
 
     :font_size  => 24, 
     :horizontal_padding => 10,
-    :vertical_padding => 3,
-    :border     => 2,
-    :position   => :center,
-    :headers    => ["Column A","Column B","#"]
-  pad(20) do
-    text "This should appear in the original font size"
-  end
-
+    :vertical_padding   => 3,
+    :border_width       => 2,
+    :position           => :center,
+    :headers            => ["Column A","Column B","#"],
+    :align              => {1 => :center},
+    :align_headers      => :center
+                            
+  text "This should appear in the original font size, just below the table"     
+  move_down 10
+  
   table [[ "Wide", "columns", "streeetch"], 
          ["are","mighty fine", "streeeeeeeech"]],
     :widths => { 0 => 200, 1 => 250 }, :position => 5

data/examples/text_flow.rb

@@ -54,7 +54,7 @@ Prawn::Document.generate("flow.pdf") do |pdf|
   
   pdf.text "Hooray! We've conquered the evil PDF gods", :size => 36
                
-  pdf.bounding_box([100,425], :width => 300) do
+  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 => 12, :spacing => 5

data/lib/prawn.rb

@@ -6,29 +6,58 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
            
-require "prawn/compatibility"
-require "prawn/errors"
-require "prawn/pdf_object"
-require "prawn/graphics"
-require "prawn/images"
-require "prawn/images/jpg"
-require "prawn/images/png"
-require "prawn/document"
-require "prawn/reference"
-require "prawn/font" 
-
 %w[font_ttf].each do |dep|
   $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../vendor/#{dep}")
 end
 
 require 'ttf'
 
-module Prawn   
+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.1.2"    
-end
+  BASEDIR = File.expand_path(File.join(dir, '..'))  
+  
+  VERSION = "0.2.0"
+  
+  extend self
+  
+  def verify_options(accepted,actual) #:nodoc:                    
+    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    
+  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/graphics"
+require "prawn/images"
+require "prawn/images/jpg"
+require "prawn/images/png"
+require "prawn/document"
+require "prawn/reference"
+require "prawn/font"

data/lib/prawn/compatibility.rb

@@ -3,30 +3,43 @@
 if RUBY_VERSION < "1.9"
   require "strscan"
   
-  class String
+  class String  #:nodoc:
     alias_method :lines, :to_a
     
     def each_char
       scanner, char = StringScanner.new(self), /./mu
       loop { yield(scanner.scan(char) || break) }
+    end       
+    
+  end
+  
+  class File  #:nodoc:  
+    def self.read_binary(file) 
+      File.open(file,"rb") { |f| f.read } 
     end
-  end 
+  end
   
-  def ruby_18
+  def ruby_18  #:nodoc:  
     yield
   end
   
-  def ruby_19
+  def ruby_19  #:nodoc:  
     false
   end
      
-else  
+else
+  
+  class File  #:nodoc:  
+    def self.read_binary(file) 
+      File.open(file,"rb:BINARY") { |f| f.read } 
+    end
+  end  
  
-  def ruby_18 
+  def ruby_18  #:nodoc:  
     false  
   end
   
-  def ruby_19
+  def ruby_19  #:nodoc:  
     yield
   end