prawn 0.11.1 → 0.15.0

data/lib/prawn/text.rb

@@ -5,15 +5,18 @@
 # Copyright May 2008, Gregory Brown. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
-require "prawn/core/text"
-require "prawn/text/formatted"
-require "prawn/text/box"
+
 require "zlib"
 
+require "pdf/core/text"
+
+require_relative "text/formatted"
+require_relative "text/box"
+
 module Prawn
   module Text
 
-    include Prawn::Core::Text
+    include PDF::Core::Text
     include Prawn::Text::Formatted
 
     # No-Break Space
@@ -23,11 +26,13 @@ module Prawn
     # Soft Hyphen (invisible, except when causing a line break)
     Prawn::Text::SHY = "­"
 
+    # @group Stable API
+    
     # If you want text to flow onto a new page or between columns, this is the
     # method to use. If, instead, if you want to place bounded text outside of
     # the flow of a document (for captions, labels, charts, etc.), use Text::Box
     # or its convenience method text_box.
-    # 
+    #
     # Draws text on the page. Prawn attempts to wrap the text to fit within your
     # current bounding box (or margin_box if no bounding box is being used).
     # Text will flow onto the next page when it reaches the bottom of the
@@ -49,28 +54,29 @@ module Prawn
     # entire document, set default_kerning = false for that document
     #
     # === Text Positioning Details
-    # 
+    #
     # The text is positioned at font.ascender below the baseline,
     # making it easy to use this method within bounding boxes and spans.
     #
     # == Encoding
     #
     # Note that strings passed to this function should be encoded as UTF-8.
-    # If you get unexpected characters appearing in your rendered document, 
+    # If you get unexpected characters appearing in your rendered document,
     # check this.
     #
     # If the current font is a built-in one, although the string must be
     # encoded as UTF-8, only characters that are available in WinAnsi
     # are allowed.
     #
-    # If an empty box is rendered to your PDF instead of the character you 
+    # If an empty box is rendered to your PDF instead of the character you
     # wanted it usually means the current font doesn't include that character.
     #
     # == Options (default values marked in [])
     #
     # <tt>:inline_format</tt>::
     #      <tt>boolean</tt>. If true, then the string parameter is interpreted
-    #      as a HTML-esque string that recognizes the following tags:
+    #      as a HTML-esque string that recognizes the following tags
+    #      (assuming the default text formatter is used):
     #      <tt>\<b></b></tt>:: bold
     #      <tt>\<i></i></tt>:: italic
     #      <tt>\<u></u></tt>:: underline
@@ -97,8 +103,8 @@ module Prawn
     #            <tt>anchor="ToC"</tt>::
     #                where the value of the anchor attribute is the name of a
     #                destination that has already been or will be registered
-    #                using Prawn::Core::Destinations#add_dest. A clickable link
-    #                will be created to that destination. 
+    #                using PDF::Core::Destinations#add_dest. A clickable link
+    #                will be created to that destination.
     #          Note that you must explicitly underline and color using the
     #          appropriate tags if you which to draw attention to the link
     #
@@ -107,6 +113,7 @@ module Prawn
     #                     [value of document.default_kerning?]
     # <tt>:size</tt>:: <tt>number</tt>. The font size to use. [current font
     #                  size]
+    # <tt>:color</tt>:: an RGB color ("ff0000") or CMYK array [10, 20, 30, 40].
     # <tt>:character_spacing</tt>:: <tt>number</tt>. The amount of space to add
     #                               to or remove from the default character
     #                               spacing. [0]
@@ -142,7 +149,7 @@ module Prawn
     #                  text should render with the fill color, stroke color or
     #                  both. See the comments to text_rendering_mode() to see
     #                  a list of valid options. [0]
-    #                        
+    #
     # == Exceptions
     #
     # Raises <tt>ArgumentError</tt> if <tt>:at</tt> option included
@@ -151,12 +158,14 @@ module Prawn
     # any text
     #
     def text(string, options={})
+      return false if string.nil?
       # we modify the options. don't change the user's hash
       options = options.dup
 
-      if options[:inline_format]
+      if p = options[:inline_format]
+        p = [] unless p.is_a?(Array)
         options.delete(:inline_format)
-        array = Text::Formatted::Parser.to_array(string)
+        array = self.text_formatter.format(string, *p)
       else
         array = [{ :text => string }]
       end
@@ -164,7 +173,6 @@ module Prawn
       formatted_text(array, options)
     end
 
-
     # Draws formatted text to the page.
     # Formatted text is comprised of an array of hashes, where each hash defines
     # text and format information. See Text::Formatted#formatted_text_box for
@@ -175,7 +183,7 @@ module Prawn
     #   text([{ :text => "hello" },
     #         { :text => "world",
     #           :size => 24,
-    #           :style => [:bold, :italic] }])
+    #           :styles => [:bold, :italic] }])
     #
     # == Options
     #
@@ -188,8 +196,14 @@ module Prawn
     def formatted_text(array, options={})
       options = inspect_options_for_text(options.dup)
 
+      if color = options.delete(:color)
+        array = array.map do |fragment|
+          fragment[:color] ? fragment : fragment.merge(:color => color)
+        end
+      end
+
       if @indent_paragraphs
-        Text::Formatted::Parser.array_paragraphs(array).each do |paragraph|
+        self.text_formatter.array_paragraphs(array).each do |paragraph|
           options[:skip_encoding] = false
           remaining_text = draw_indented_formatted_line(paragraph, options)
           options[:skip_encoding] = true
@@ -216,7 +230,7 @@ module Prawn
 
     # Draws text on the page, beginning at the point specified by the :at option
     # the string is assumed to be pre-formatted to properly fit the page.
-    # 
+    #
     #   pdf.draw_text "Hello World", :at => [100,100]
     #   pdf.draw_text "Goodbye World", :at => [50,50], :size => 16
     #
@@ -238,14 +252,14 @@ module Prawn
     # == Encoding
     #
     # Note that strings passed to this function should be encoded as UTF-8.
-    # If you get unexpected characters appearing in your rendered document, 
+    # If you get unexpected characters appearing in your rendered document,
     # check this.
     #
     # If the current font is a built-in one, although the string must be
     # encoded as UTF-8, only characters that are available in WinAnsi
     # are allowed.
     #
-    # If an empty box is rendered to your PDF instead of the character you 
+    # If an empty box is rendered to your PDF instead of the character you
     # wanted it usually means the current font doesn't include that character.
     #
     # == Options (default values marked in [])
@@ -274,7 +288,7 @@ module Prawn
       text = text.to_s.dup
       save_font do
         process_text_options(options)
-        font.normalize_encoding!(text) unless @skip_encoding
+        font.normalize_encoding!(text)
         font_size(options[:size]) { draw_text!(text, options) }
       end
     end
@@ -307,7 +321,7 @@ module Prawn
     #   height_of_formatted([{ :text => "hello" },
     #                        { :text => "world",
     #                          :size => 24,
-    #                          :style => [:bold, :italic] }])
+    #                          :styles => [:bold, :italic] }])
     #
     def height_of_formatted(array, options={})
       if options[:indent_paragraphs]
@@ -318,7 +332,7 @@ module Prawn
       box = Text::Formatted::Box.new(array,
                           options.merge(:height   => 100000000,
                                         :document => self))
-      printed = box.render(:dry_run => true)
+      box.render(:dry_run => true)
 
       height = box.height
       height += box.line_gap + box.leading if @final_gap
@@ -374,7 +388,7 @@ module Prawn
       if options[:kerning].nil? then
         options[:kerning] = default_kerning?
       end
-      valid_options = Prawn::Core::Text::VALID_OPTIONS + [:at, :rotate]
+      valid_options = PDF::Core::Text::VALID_OPTIONS + [:at, :rotate]
       Prawn.verify_options(valid_options, options)
       options
     end

data/lib/prawn/utilities.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+# utilities.rb : General-purpose utility classes which don't fit anywhere else
+#
+# Copyright August 2012, Alex Dowad. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'thread'
+
+module Prawn
+
+  # Throughout the Prawn codebase, repeated calculations which can benefit from caching are made
+  # In some cases, caching and reusing results can not only save CPU cycles but also greatly
+  #   reduce memory requirements
+  # But at the same time, we don't want to throw away thread safety
+  # We have two interchangeable thread-safe cache implementations:
+
+  # @private
+  class SynchronizedCache 
+    # As an optimization, this could access the hash directly on VMs with a global interpreter lock (like MRI)
+    def initialize
+      @cache = {}
+      @mutex = Mutex.new
+    end
+    def [](key)
+      @mutex.synchronize { @cache[key] }
+    end
+    def []=(key,value)
+      @mutex.synchronize { @cache[key] = value }
+    end
+  end
+  
+  # @private
+  class ThreadLocalCache     
+    def initialize
+      @cache_id = "cache_#{self.object_id}".to_sym
+    end
+    def [](key)
+      (Thread.current[@cache_id] ||= {})[key]
+    end
+    def []=(key,value)
+      (Thread.current[@cache_id] ||= {})[key] = value
+    end
+  end
+end

data/lib/prawn.rb

@@ -1,26 +1,91 @@
 # Welcome to Prawn, the best PDF Generation library ever.
 # This documentation covers user level functionality.
 #
-# Those looking to contribute code or write extensions should look
-# into the lib/prawn/core/* source tree.
-#
-module Prawn #:nodoc:
-  VERSION = "0.11.1"
+require "set"
+
+require 'ttfunk'
+require "pdf/core"
+
+module Prawn
+  VERSION = "0.15.0"
+
+  extend self
+
+  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, '..'))
+  DATADIR = File.expand_path(File.join(dir, '..', 'data'))
+  
+  FLOAT_PRECISION = 1.0e-9
+
+  # 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 # @private
+
+  def verify_options(accepted, actual) # @private
+    return unless debug || $DEBUG
+    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 # @private
+    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/core"
-require "prawn/text"
-require "prawn/graphics"
-require "prawn/images"
-require "prawn/images/jpg"
-require "prawn/images/png"
-require "prawn/stamp"
-require "prawn/security"
-require "prawn/document"
-require "prawn/font"
-require "prawn/encoding"
-require "prawn/measurements"
-require "prawn/repeater"
-require "prawn/outline"
-require "prawn/layout"
+require_relative "prawn/errors"
+
+
+require_relative "prawn/utilities"
+require_relative "prawn/text"
+require_relative "prawn/graphics"
+require_relative "prawn/images"
+require_relative "prawn/images/image"
+require_relative "prawn/images/jpg"
+require_relative "prawn/images/png"
+require_relative "prawn/stamp"
+require_relative "prawn/soft_mask"
+require_relative "prawn/security"
+require_relative "prawn/document"
+require_relative "prawn/font"
+require_relative "prawn/encoding"
+require_relative "prawn/measurements"
+require_relative "prawn/repeater"
+require_relative "prawn/outline"
+require_relative "prawn/layout"
+
+require_relative "prawn/image_handler"
+
+
 
+Prawn.image_handler.register(Prawn::Images::PNG)
+Prawn.image_handler.register(Prawn::Images::JPG)

data/manual/basic_concepts/adding_pages.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+#
+# A PDF document is a collection of pages. When we create a new document be it
+# with <code>Document.new</code> or on a <code>Document.generate</code> block
+# one initial page is created for us.
+#
+# Some methods might create new pages automatically like <code>text</code> which
+# will create a new page whenever the text string cannot fit on the current
+# page.
+#
+# But what if you want to go to the next page by yourself? That is easy.
+#
+# Just use the <code>start_new_page</code> method and a shiny new page will be
+# created for you just like in the following snippet.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  text "We are still on the initial page for this example. Now I'll ask " +
+       "Prawn to gently start a new page. Please follow me to the next page."
+  
+  start_new_page
+  
+  text "See. We've left the previous page behind."
+end

data/manual/basic_concepts/basic_concepts.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+#
+# Examples for Prawn basic concepts.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
+  
+  package "basic_concepts" do |p|
+    
+    p.example "creation", :eval_source => false, :full_source => true
+    p.example "origin"
+    p.example "cursor"
+    p.example "other_cursor_helpers"
+    p.example "adding_pages"
+    p.example "measurement"
+    
+    p.intro do
+      prose("This chapter covers the minimum amount of functionality you'll need to start using Prawn.
+
+      If you are new to Prawn this is the first chapter to read. Once you are comfortable with the concepts shown here you might want to check the Basics section of the Graphics, Bounding Box and Text sections.
+
+      The examples show:")
+
+      list( "How to create new pdf documents in every possible way",
+            "Where the origin for the document coordinates is. What are Bounding Boxes and how they interact with the origin",
+            "How the cursor behaves",
+            "How to start new pages",
+            "What the base unit for measurement and coordinates is and how to use other convenient measures"
+          )
+    end
+  end
+end

data/manual/basic_concepts/creation.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+# There are three ways to create a PDF Document in Prawn: creating a new
+# <code>Prawn::Document</code> instance, or using the
+# <code>Prawn::Document.generate</code> method with and without block arguments.
+#
+# The following snippet showcase each way by creating a simple document with
+# some text drawn.
+#
+# When we instantiate the <code>Prawn::Document</code> object the actual pdf
+# document will only be created after we call <code>render_file</code>.
+#
+# The generate method will render the actual pdf object after exiting the block.
+# When we use it without a block argument the provided block is evaluated in the
+# context of a newly created <code>Prawn::Document</code> instance. When we use
+# it with a block argument a <code>Prawn::Document</code> instance is created
+# and passed to the block.
+#
+# The generate method without block arguments requires
+# less typing and defines and renders the pdf document in one shot.
+# Almost all of the examples are coded this way.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+# Assignment
+pdf = Prawn::Document.new
+pdf.text "Hello World"
+pdf.render_file "assignment.pdf"
+
+# Implicit Block
+Prawn::Document.generate("implicit.pdf") do
+  text "Hello World"
+end
+
+# Explicit Block
+Prawn::Document.generate("explicit.pdf") do |pdf|
+  pdf.text "Hello World"
+end

data/manual/basic_concepts/cursor.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+# We normally write our documents from top to bottom and it is no different with
+# Prawn. Even if the origin is on the bottom left corner we still fill the page
+# from the top to the bottom. In other words the cursor for inserting content
+# starts on the top of the page.
+#
+# Most of the functions that insert content on the page will start at the
+# current cursor position and proceed to the bottom of the page.
+#
+# The following snippet shows how the cursor behaves when we add some text to
+# the page and demonstrates some of the helpers to manage the cursor position.
+# The <code>cursor</code> method returns the current cursor position.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  stroke_axis
+  
+  text "the cursor is here: #{cursor}"
+  text "now it is here: #{cursor}"
+  
+  move_down 200
+  text "on the first move the cursor went down to: #{cursor}"
+  
+  move_up 100
+  text "on the second move the cursor went up to: #{cursor}"
+  
+  move_cursor_to 50
+  text "on the last move the cursor went directly to: #{cursor}"
+end

data/manual/basic_concepts/measurement.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+#
+# The base unit in Prawn is the PDF Point. One PDF Point is equal to 1/72 of
+# an inch.
+#
+# There is no need to waste time converting this measures. Prawn provides
+# helpers for converting from other measurements
+# to PDF Points.
+#
+# Just <code>require "prawn/measurement_extensions"</code> and it will mix some
+# helpers onto <code>Numeric</code> for converting common measurement units to
+# PDF Points.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  require "prawn/measurement_extensions"
+  
+  [:mm, :cm, :dm, :m, :in, :yd, :ft].each do |measurement|
+    text "1 #{measurement} in PDF Points: #{1.send(measurement)} pt"
+    move_down 5.mm
+  end
+end

data/manual/basic_concepts/origin.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+#
+# This is the most important concept you need to learn about Prawn:
+#
+# PDF documents have the origin <code>[0,0]</code> at the bottom-left corner of
+# the page.
+#
+# A bounding box is a structure which provides boundaries for inserting content.
+# A bounding box also has the property of relocating the origin to its relative
+# bottom-left corner. However, be aware that the location specified when
+# creating a bounding box is its top-left corner, not bottom-left (hence the
+# <code>[100, 300]</code> coordinates below).
+#
+# Even if you never create a bounding box explictly, each document already comes
+# with one called the margin box. This initial bounding box is the one
+# responsible for the document margins.
+#
+# So practically speaking the origin of a page on a default generated document
+# isn't the absolute bottom left corner but the bottom left corner of the margin
+# box.
+#
+# The following snippet strokes a circle on the margin box origin. Then strokes
+# the boundaries of a bounding box and a circle on its origin.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  stroke_axis
+  
+  stroke_circle [0, 0], 10
+  
+  bounding_box([100, 300], :width => 300, :height => 200) do
+    stroke_bounds
+    stroke_circle [0, 0], 10
+  end
+end

data/manual/basic_concepts/other_cursor_helpers.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# Another group of helpers for changing the cursor position are the pad methods.
+# They accept a numeric value and a block. <code>pad</code> will use the numeric
+# value to move the cursor down both before and after the block content.
+# <code>pad_top</code> will only move the cursor before the block while
+# <code>pad_bottom</code> will only move after.
+#
+# <code>float</code> is a method for not changing the cursor. Pass it a block
+# and the cursor will remain on the same place when the block returns.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  stroke_horizontal_rule
+  pad(20) { text "Text padded both before and after." }
+  
+  stroke_horizontal_rule
+  pad_top(20) { text "Text padded on the top." }
+  
+  stroke_horizontal_rule
+  pad_bottom(20) { text "Text padded on the bottom." }
+  
+  stroke_horizontal_rule
+  move_down 30
+  
+  text "Text written before the float block."
+  
+  float do
+    move_down 30
+    bounding_box([0, cursor], :width => 200) do
+      text "Text written inside the float block."
+      stroke_bounds
+    end
+  end
+
+  text "Text written after the float block."
+end

data/manual/bounding_box/bounding_box.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+# Examples for bounding boxes.
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
+  
+  package "bounding_box" do |p|
+    
+    p.section "Basics" do |s|
+      s.example "creation"
+      s.example "bounds"
+    end
+    
+    p.section "Advanced" do |s|
+      s.example "stretchy"
+      s.example "nesting"
+      s.example "indentation"
+      s.example "canvas"
+      s.example "russian_boxes"
+    end
+    
+    p.intro do
+      prose("Bounding boxes are the basic containers for structuring the content flow. Even being low level building blocks sometimes their simplicity is very welcome.
+
+      The examples show:")
+
+      list( "How to create bounding boxes with specific dimensions",
+            "How to inspect the current bounding box for its coordinates",
+            "Stretchy bounding boxes",
+            "Nested bounding boxes",
+            "Indent blocks"
+          )
+    end
+    
+  end
+end