prawn 0.3.0 → 0.4.0

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 require "rake/rdoctask"
 require "rake/gempackagetask"  
 
-PRAWN_VERSION = "0.3.0" 
+PRAWN_VERSION = "0.4.0" 
 
 task :default => [:test]
        
@@ -52,6 +52,8 @@ spec = Gem::Specification.new do |spec|
   spec.files =  Dir.glob("{examples,lib,spec,vendor,data}/**/**/*") +
                       ["Rakefile"]
   spec.require_path = "lib"
+
+  spec.add_dependency('prawn-layout')
   
   spec.test_files = Dir[ "test/*_test.rb" ]
   spec.has_rdoc = true

data/examples/general/measurement_units.rb

@@ -22,7 +22,7 @@ pdf = Prawn::Document.new(
 :top_margin => 0.1.dm,    # work
 :bottom_margin => 0.01.m) # well
 
-pdf.font.size = 6
+pdf.font_size = 6
 pdf.line_width = 0.05
 
 units_long = %w[Millimeters Centimeters Decimeters Inches Foot Points]
@@ -49,4 +49,4 @@ 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"
+pdf.render_file "measurement_units.pdf"

data/examples/graphics/image_flow.rb

@@ -9,7 +9,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require "prawn"
    
 Prawn::Document.generate("image-flow.pdf", :page_layout => :landscape) do  
-  font.size = 8                           
+  self.font_size = 8                           
   stef = "#{Prawn::BASEDIR}/data/images/stef.jpg"  
   
   text "Image at default position with no arguments"
@@ -35,4 +35,4 @@ Prawn::Document.generate("image-flow.pdf", :page_layout => :landscape) do
   text "Flowing image at x=50"     
   
   image stef, :position => 50
-end
+end

data/examples/graphics/stroke_bounds.rb

@@ -20,4 +20,4 @@ Prawn::Document.generate("stroke_bounds.pdf") do
     end
     stroke_bounds
   end
-end
+end

data/examples/m17n/win_ansi_charset.rb

@@ -31,14 +31,14 @@ Prawn::Document.generate("win-ansi.pdf") do
     code = "%d." % index
     char = index.chr
 
-    width = 1000 * font.metrics.string_width(char, FONT_SIZE) / FONT_SIZE
+    width = 1000 * font.width_of(char, :size => 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)
+        width = font.width_of(field, :size => FONT_SIZE)
 
         case align
         when :left then offset = 0
@@ -52,4 +52,4 @@ Prawn::Document.generate("win-ansi.pdf") do
       dx += total_width
     end
   end
-end
+end

data/examples/text/dfont.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require "prawn"
+
+DFONT_FILE = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+puts "There are #{Prawn::Font::DFont.font_count(DFONT_FILE)} fonts in #{DFONT_FILE}:"
+Prawn::Font::DFont.named_fonts(DFONT_FILE).each do |name|
+  puts "* #{name}"
+end
+
+puts
+puts "generating sample document in 'dfont.pdf'..."
+
+Prawn::Document.generate "dfont.pdf" do       
+  fill_color "0000ff"
+
+  font DFONT_FILE, :font => "ActionMan-Bold", :size => 24
+  text "Introducing Action Man!"
+
+  move_text_position 24
+
+  font_families["Action Man"] = {
+    :normal      => { :file => DFONT_FILE, :font => "ActionMan" },
+    :bold        => { :file => DFONT_FILE, :font => "ActionMan-Bold" },
+    :italic      => { :file => DFONT_FILE, :font => "ActionMan-Italic" },
+    :bold_italic => { :file => DFONT_FILE, :font => "ActionMan-BoldItalic" }
+  }
+
+  font "Action Man", :size => 16
+  text "Action Man is feeling normal here."
+
+  move_text_position 16
+
+  font "Action Man", :style => :bold, :size => 16
+  text "Action Man is feeling bold here!"
+
+  move_text_position 16
+
+  font "Action Man", :style => :italic, :size => 16
+  text "Here, we see Action Man feeling italicized. Slick!"
+
+  move_text_position 16
+
+  font "Action Man", :style => :bold_italic, :size => 16
+  text "Lastly, we observe Mr. Action Man being bold AND italicized. Excellent!"
+end
+
+puts "done"

data/examples/text/flowing_text_with_header_and_footer.rb

@@ -2,7 +2,7 @@
 # 
 # Multi-faceted example that demonstrates a document flowing between header
 # and footer regions.  At the moment, headers and footers in Prawn are run
-# using the current font settings (among other things), for each page.  THhis
+# using the current font settings (among other things), for each page.  This
 # means that it is important to non-destructively set your desired styling 
 # within your headers and footers, as shown below.  
 #
@@ -31,53 +31,7 @@ Prawn::Document.generate("flow_with_headers_and_footers.pdf")  do
       :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
+end

data/examples/text/font_calculations.rb

@@ -9,13 +9,14 @@ require 'prawn'
 
 Prawn::Document.generate('font_calculations.pdf') do
   
-  def demonstration(pos)
+  def demonstration
+    font_size 12
     move_down 10
 
     stroke_horizontal_rule
 
     text "When using flowing text, Prawn will position text\n" +
-         "starting font.#{pos} below the baseline, and leave\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
@@ -52,7 +53,7 @@ Prawn::Document.generate('font_calculations.pdf') do
     text "FONT_HEIGHT"
 
     fill_color "000000"
-    font.size = 20
+    font_size 16
 
     move_down 40
 
@@ -81,11 +82,11 @@ Prawn::Document.generate('font_calculations.pdf') do
   end
   
   text "Using AFM", :size => 20
-  demonstration("height")
+  demonstration
   
   move_down 75
   font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
   text "Using TTF", :size => 20
-  demonstration("ascender")
+  demonstration
   
-end
+end

data/examples/text/font_size.rb

@@ -9,12 +9,12 @@ Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
 
   # Explicit global changes
   font 'Helvetica'
-  font.size = 16
+  self.font_size = 16
 
   text 'Font at 16 point'
 
   # Transactional changes rolled back after block exit
-  font.size 9 do
+  font_size 9 do
     text 'Font at 9 point'
     # single line changes, not persisted.
     text 'Font at manual override 20 point', :size => 20
@@ -24,11 +24,11 @@ Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
   # 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" }
+    font_size(16) { text "Font in Times at 16" }
   end
 
   text 'Font at 16 point'
 
   font "Courier", :size => 40
   text "40 pt!"
-end
+end

data/examples/text/text_flow.rb

@@ -60,7 +60,7 @@ Prawn::Document.generate("flow.pdf") do |pdf|
   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
+    pdf.text poem, :size => 10, :spacing => 5
   end
   
   pdf.text "And this text automatically goes below the poem", :size => 18

data/lib/prawn.rb

@@ -20,10 +20,13 @@ module Prawn
   # The base source directory for Prawn as installed on the system
   BASEDIR = File.expand_path(File.join(dir, '..'))
   
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
   
   extend self
-  
+
+  # Whe set to true, Prawn will verify hash options to ensure only valid keys
+  # are used.  Off by default.
+  # 
   attr_accessor :debug
   
   def verify_options(accepted,actual) #:nodoc:
@@ -66,4 +69,4 @@ require "prawn/document"
 require "prawn/reference"
 require "prawn/font"
 require "prawn/encoding"
-require "prawn/measurements"
+require "prawn/measurements"

data/lib/prawn/compatibility.rb

@@ -1,26 +1,21 @@
+# coding: utf-8
+#
 # Why would we ever use Ruby 1.8.7 when we can backport with something
 # as simple as this?
 #
-# encoding: utf-8
-
-if RUBY_VERSION < "1.9"
-  require "strscan"
-  
-  class String  #:nodoc:
+class String  #:nodoc:
+  unless "".respond_to?(:lines)
     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.binread(file) 
-      File.open(file,"rb") { |f| f.read } 
-    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

data/lib/prawn/document.rb

@@ -9,26 +9,26 @@
 require "stringio"
 require "prawn/document/page_geometry" 
 require "prawn/document/bounding_box"
-require "prawn/document/text"
-require "prawn/document/table"
 require "prawn/document/internals"
 require "prawn/document/span"
+require "prawn/document/text"
 require "prawn/document/annotations"
 require "prawn/document/destinations"
 
 module Prawn
   class Document  
            
-    include Prawn::Document::Internals
-    include Prawn::Document::Annotations
-    include Prawn::Document::Destinations
-    include Prawn::Graphics
+    include Text                             
+    include PageGeometry  
+    include Internals
+    include Annotations
+    include Destinations
+    include Prawn::Graphics    
     include Prawn::Images
-    include Text
-    include PageGeometry
-    
+
     attr_accessor :y, :margin_box
     attr_reader   :margins, :page_size, :page_layout
+    attr_writer   :font_size
       
     # Creates and renders a PDF document. 
     #
@@ -96,6 +96,7 @@ module Prawn
        @compress        = options[:compress] || false                
        @skip_encoding   = options[:skip_encoding]
        @background      = options[:background]
+       @font_size       = 12
        
        text_options.update(options[:text_options] || {}) 
              
@@ -286,7 +287,6 @@ module Prawn
                           :Parent    => @pages, 
                           :MediaBox  => page_dimensions, 
                           :Contents  => @page_content)
-      font.add_to_current_page if @font
       update_colors
     end
     

data/lib/prawn/document/internals.rb

@@ -17,8 +17,13 @@ module Prawn
     module Internals    
       # Creates a new Prawn::Reference and adds it to the Document's object
       # list.  The +data+ argument is anything that Prawn::PdfObject() can convert.    
-      def ref(data)
-        @objects.push(Prawn::Reference.new(@objects.size + 1, data)).last
+      # 
+      # If a block is given, it will be invoked just before the object is written
+      # out to the PDF document stream. This allows you to do deferred processing
+      # on some references (such as fonts, which you might know all the details
+      # about until the last page of the document is finished).
+      def ref(data, &block)
+        @objects.push(Prawn::Reference.new(@objects.size + 1, data, &block)).last
       end                                               
       
       # Appends a raw string to the current page content.
@@ -103,7 +108,7 @@ module Prawn
         end
       end
 
-      # Write out the PDF Body, as per spec 3.4.4
+      # Write out the PDF Trailer, as per spec 3.4.4
       def render_trailer(output)
         trailer_hash = {:Size => @objects.size + 1, 
                         :Root => @root,

data/lib/prawn/document/text.rb

@@ -7,10 +7,12 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 require "zlib"
 require "prawn/document/text/box"
+require "prawn/document/text/wrapping"
 
 module Prawn
   class Document
     module Text
+      include Wrapping
       
       # Draws text on the page. If a point is specified via the +:at+
       # option the text will begin exactly at that point, and the string is
@@ -44,25 +46,8 @@ module Prawn
       # When using the :at parameter, Prawn will position your text by its
       # baseline, and flow along a single line.
       #
-      # When using automatic text flow, Prawn currently does a bunch of nasty
-      # hacks to get things to position nicely in bounding boxes, table cells,
-      # etc.
-      #
-      # For AFM fonts, the first line of text is positioned font.height below
-      # the baseline.
-      #
-      # For TTF fonts, the first line is possitioned font.ascender below the
-      # baseline.
-      #
-      # The issue here is that there are complex issues with determining the
-      # size of the glyphs above and below the baseline in TTF that we haven't
-      # figured out yet, and that AFM and TTF appear to handle things very
-      # differently.
-      #
-      # The moral of the story is that if you want reliable font positioning
-      # for your advanced needs, use :at, otherwise, just let Prawn do its
-      # positioning magic for you, or investigate and help us get rid of this 
-      # ugly issue.
+      # Otherwise, the text is positioned at font.ascender below the baseline,
+      # making it easy to use this method within bounding boxes and spans.
       #
       # == Rotation
       #
@@ -87,25 +72,22 @@ module Prawn
         # original string
         text = text.to_s.dup                      
         
-        # we might also mess with the font
-        original_font  = font.name   
-              
-        options = text_options.merge(options)
-        process_text_options(options) 
-         
-        font.normalize_encoding(text) unless @skip_encoding        
-
-        if options[:at]                
-          x,y = translate(options[:at])            
-          font.size(options[:size]) { add_text_content(text,x,y,options) }
-        else
-          if options[:rotate]
-            raise ArgumentError, "Rotated text may only be used with :at" 
-          end
-          wrapped_text(text,options)
-        end         
+        save_font do
+          options = text_options.merge(options)
+          process_text_options(options) 
+           
+          font.normalize_encoding(text) unless @skip_encoding        
 
-        font(original_font) 
+          if options[:at]                
+            x,y = translate(options[:at])            
+            font_size(options[:size]) { add_text_content(text,x,y,options) }
+          else
+            if options[:rotate]
+              raise ArgumentError, "Rotated text may only be used with :at" 
+            end
+            wrapped_text(text,options)
+          end         
+        end
       end 
                           
       # A hash of configuration options, to be used globally by text().
@@ -121,7 +103,7 @@ module Prawn
       
       def process_text_options(options)
         Prawn.verify_options [:style, :kerning, :size, :at, :wrap, 
-                              :spacing, :align, :rotate ], options                               
+                              :spacing, :align, :rotate, :final_gap ], options                               
         
         if options[:style]  
           raise "Bad font family" unless font.family
@@ -129,10 +111,10 @@ module Prawn
         end
 
         unless options.key?(:kerning)
-          options[:kerning] = font.metrics.has_kerning_data?
+          options[:kerning] = font.has_kerning_data?
         end                     
 
-        options[:size] ||= font.size
+        options[:size] ||= font_size
      end
 
       def move_text_position(dy)   
@@ -146,20 +128,17 @@ module Prawn
       def wrapped_text(text,options) 
         options[:align] ||= :left      
 
-        font.size(options[:size]) do
-          text = font.metrics.naive_wrap(text, bounds.right, font.size, 
+        font_size(options[:size]) do
+          text = naive_wrap(text, bounds.right, font_size, 
             :kerning => options[:kerning], :mode => options[:wrap]) 
 
           lines = text.lines.to_a
+          last_gap_before = options.fetch(:final_gap, true) ? lines.length : lines.length-1
                                                        
           lines.each_with_index do |e,i|         
-            if font.metrics.type0?     
-              move_text_position(font.ascender)
-            else                                     
-              move_text_position(font.height) 
-            end                               
+            move_text_position(font.ascender)
                            
-            line_width = font.width_of(e)
+            line_width = font.width_of(e, :kerning => options[:kerning])
             case(options[:align]) 
             when :left
               x = @bounding_box.absolute_left
@@ -172,20 +151,18 @@ module Prawn
                                
             add_text_content(e,x,y,options)
             
-            if font.metrics.type0? && i < lines.length - 1
-              move_text_position(font.height - font.ascender)
+            if i < last_gap_before
+              move_text_position(font.line_gap - font.descender)
+              move_text_position(options[:spacing]) if options[:spacing]
             end
-            
-            move_text_position(options[:spacing]) if options[:spacing]
           end 
         end
       end  
 
       def add_text_content(text, x, y, options)
-        text = font.metrics.convert_text(text,options)
+        chunks = font.encode_text(text,options)
 
         add_content "\nBT"
-        add_content "/#{font.identifier} #{font.size} Tf"
         if options[:rotate]
           rad = options[:rotate].to_i * Math::PI / 180
           arr = [ Math.cos(rad), Math.sin(rad), -Math.sin(rad), Math.cos(rad), x, y ]
@@ -193,9 +170,14 @@ module Prawn
         else
           add_content "#{x} #{y} Td"
         end
-        rad = 1.570796
-        add_content Prawn::PdfObject(text, true) <<
-          " #{options[:kerning] ? 'TJ' : 'Tj'}"
+
+        chunks.each do |(subset, string)|
+          font.add_to_current_page(subset)
+          add_content "/#{font.identifier_for(subset)} #{font_size} Tf"
+
+          operation = options[:kerning] && string.is_a?(Array) ? "TJ" : "Tj"
+          add_content Prawn::PdfObject(string, true) << " " << operation
+        end
         add_content "ET\n"
       end
     end