piglop-prawn 0.10.2.1

data/examples/text/rotated.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+#
+# Demonstrates transformations
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "rotated_text.pdf" do |pdf|
+  pdf.line_width = 1
+  width = 150
+  height = 200
+  half_width = width / 2
+  half_height = height / 2
+  angle = 30
+
+
+  # AROUND THE CENTER
+  
+  x = pdf.bounds.width / 2 - half_width
+  y = pdf.bounds.height / 2 + half_height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + half_width, y - half_height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around the center " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :center)
+
+  
+  # AROUND THE UPPER_LEFT_CORNER
+  
+  x = pdf.bounds.width - width
+  y = height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around upper left corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle)
+
+  
+  # AROUND THE UPPER_RIGHT_CORNER
+  
+  x = 0
+  y = height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + width, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around upper right corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :upper_right)
+
+  
+  # AROUND THE LOWER_RIGHT_CORNER
+  
+  x = 0
+  y = pdf.bounds.height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + width, y - height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around lower right corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :lower_right)
+
+  
+  # AROUND THE LOWER_LEFT_CORNER
+  
+  x = pdf.bounds.width - width
+  y = pdf.bounds.height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x, y - height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around lower left corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :lower_left)
+end

data/examples/text/shaped_text_box.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# Demonstrates extending Text::Box
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "shaped_text_box.pdf" do |pdf|
+  module ShapedBox
+    def available_width
+      height + 25
+    end
+  end
+
+  Prawn::Text::Box.extensions << ShapedBox
+  pdf.stroke_rectangle([10, pdf.bounds.top - 10], 300, 300)
+  pdf.text_box("A" * 500,
+               :at => [10, pdf.bounds.top - 10],
+               :width => 300,
+               :height => 300,
+               :align => :center)
+  
+  Prawn::Text::Formatted::Box.extensions << ShapedBox
+  pdf.stroke_rectangle([10, pdf.bounds.top - 330], 300, 300)
+  pdf.formatted_text_box([:text => "A" * 500,
+                          :color => "009900"],
+                         :at => [10, pdf.bounds.top - 330],
+                         :width => 300,
+                         :height => 300,
+                         :align => :center)
+end
+

data/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"
+  draw_text "Hello World", :at => [200,420], :size => 32, :rotate => 45
+  font "Times-Roman"     
+  fill_color "ff0000"
+  draw_text "Using Another Font", :at => [5,5]    
+  start_new_page        
+  font "Courier"       
+  draw_text "Goodbye World", :at => [288,50]     
+end

data/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" 
+  draw_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/examples/text/text_box.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+#
+
+require 'examples/example_helper'
+
+Prawn::Document.generate("text_box.pdf") do
+  def get_string(i, j)      
+    case i
+    when 0
+      text = "this is left text " * 30
+      text.insert(48, "\n\n")
+    when 1
+      text = "this is center text " * 30
+      text.insert(54, "\n\n")
+    when 2
+      text = "this is right text " * 30
+      text.insert(51, "\n\n")
+    end
+    
+    case j
+    when 0
+      text.split(" ").slice(0..47).join(" ")
+    when 3
+      text.delete(" ")
+    else
+      text
+    end
+  end
+
+  def get_options(i, j)
+    options = {
+      :width    => bounds.width * 0.3,
+      :height   => bounds.width * 0.3,
+      :overflow => :ellipses,
+      :at       => [0, 0],
+      :align    => :left,
+      :document => self
+    }
+    
+    case i
+    when 0
+      options[:valign] = :top if j == 0
+    when 1
+      options[:align] = :center
+      options[:valign] = :center if j == 0
+    when 2
+      options[:align] = :right
+      options[:valign] = :bottom if j == 0
+    end
+    
+    case j
+    when 1
+      options[:overflow] = :shrink_to_fit
+    when 2
+      options[:leading] = font.height * 0.5
+      options[:overflow] = :truncate
+    end
+    options
+  end
+
+  stroke_color("555555")
+  3.times do |i|
+    4.times do |j|
+      options = get_options(i, j)
+      options[:at][0] = (bounds.width  - options[:width]) * 0.5 * i
+      options[:at][1] = bounds.top - (bounds.height - options[:height]) * 0.33 * j
+      box = Prawn::Text::Box.new(get_string(i, j), options)
+
+      fill_color("ffeeee")
+      if i == 1
+        # bound with a box of a particular size, regardless of how
+        # much text it contains
+        fill_and_stroke_rectangle(options[:at],
+                                  options[:width],
+                                  options[:height])
+      else
+        # bound with a box that exactly fits the printed text using
+        # dry_run look-ahead
+        box.render(:dry_run => true)
+        fill_and_stroke_rectangle(options[:at],
+                                  options[:width],
+                                  box.height)
+      end
+      fill_color("000000")
+      box.render
+    end
+  end
+end

data/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/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/lib/prawn/compatibility.rb

@@ -0,0 +1,51 @@
+# 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:
+  def first_line
+    self.each_line { |line| return line }
+  end
+  unless "".respond_to?(:lines)
+    alias_method :lines, :to_a
+  end
+  unless "".respond_to?(:each_char)
+    def each_char #:nodoc:
+      # copied from jcode
+      if block_given?
+        scan(/./m) { |x| yield x }
+      else
+        scan(/./m)
+      end
+    end
+  end
+end
+
+unless File.respond_to?(:binread) 
+  def File.binread(file) #:nodoc:
+    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/lib/prawn/core/annotations.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+# annotations.rb : Implements low-level annotation support for PDF
+#
+# Copyright November 2008, Jamis Buck. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Core 
+    
+    # Provides very low-level support for annotations. 
+    #
+    module Annotations #:nodoc:
+      
+      # Adds a new annotation (section 8.4 in PDF spec) to the current page.
+      # +options+ must be a Hash describing the annotation.
+      #
+      def annotate(options)
+        state.page.dictionary.data[:Annots] ||= []
+        options = sanitize_annotation_hash(options)
+        state.page.dictionary.data[:Annots] << ref!(options)
+        return options
+      end
+
+      # A convenience method for creating Text annotations. +rect+ must be an array
+      # of four numbers, describing the bounds of the annotation. +contents+ should
+      # be a string, to be shown when the annotation is activated.
+      #
+      def text_annotation(rect, contents, options={})
+        options = options.merge(:Subtype => :Text, :Rect => rect, :Contents => contents)
+        annotate(options)
+      end
+
+      # A convenience method for creating Link annotations. +rect+ must be an array
+      # of four numbers, describing the bounds of the annotation. The +options+ hash
+      # should include either :Dest (describing the target destination, usually as a
+      # string that has been recorded in the document's Dests tree), or :A (describing
+      # an action to perform on clicking the link), or :PA (for describing a URL to
+      # link to).
+      #
+      def link_annotation(rect, options={})
+        options = options.merge(:Subtype => :Link, :Rect => rect)
+        annotate(options)
+      end
+
+      private
+
+      def sanitize_annotation_hash(options)
+        options = options.merge(:Type => :Annot)
+
+        if options[:Dest].is_a?(String)
+          options[:Dest] = Prawn::Core::LiteralString.new(options[:Dest])
+        end
+
+        options
+      end
+      
+    end
+  end
+end

data/lib/prawn/core/byte_string.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+module Prawn
+  module Core
+    # 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
+end

data/lib/prawn/core/destinations.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+# prawn/core/destinations.rb : Implements destination support for PDF
+#
+# Copyright November 2008, Jamis Buck. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  module Core
+    module Destinations #:nodoc:
+      
+      # The maximum number of children to fit into a single node in the Dests tree.
+      NAME_TREE_CHILDREN_LIMIT = 20 #:nodoc:
+      
+      # The Dests name tree in the Name dictionary (see Prawn::Document::Internal#names).
+      # This name tree is used to store named destinations (PDF spec 8.2.1).
+      # (For more on name trees, see section 3.8.4 in the PDF spec.)
+      #
+      def dests
+        names.data[:Dests] ||= ref!(Prawn::Core::NameTree::Node.new(self, NAME_TREE_CHILDREN_LIMIT))
+      end
+
+      # Adds a new destination to the dests name tree (see #dests). The
+      # +reference+ parameter will be converted into a Prawn::Reference if
+      # it is not already one.
+      #
+      def add_dest(name, reference)
+        reference = ref!(reference) unless reference.is_a?(Prawn::Core::Reference)
+        dests.data.add(name, reference)
+      end
+
+      # Return a Dest specification for a specific location (and optional zoom
+      # level).
+      #
+      def dest_xyz(left, top, zoom=nil, page=current_page)
+        [page, :XYZ, left, top, zoom]
+      end
+
+      # Return a Dest specification that will fit the given page into the
+      # viewport.
+      #
+      def dest_fit(page=current_page)
+        [page, :Fit]
+      end
+
+      # Return a Dest specification that will fit the given page horizontally
+      # into the viewport, aligned vertically at the given top coordinate.
+      #
+      def dest_fit_horizontally(top, page=current_page)
+        [page, :FitH, top]
+      end
+
+      # Return a Dest specification that will fit the given page vertically
+      # into the viewport, aligned horizontally at the given left coordinate.
+      #
+      def dest_fit_vertically(left, page=current_page)
+        [page, :FitV, left]
+      end
+
+      # Return a Dest specification that will fit the given rectangle into the
+      # viewport, for the given page.
+      #
+      def dest_fit_rect(left, bottom, right, top, page=current_page)
+        [page, :FitR, left, bottom, right, top]
+      end
+
+      # Return a Dest specfication that will fit the given page's bounding box
+      # into the viewport.
+      #
+      def dest_fit_bounds(page=current_page)
+        [page, :FitB]
+      end
+
+      # Same as #dest_fit_horizontally, but works on the page's bounding box
+      # instead of the entire page.
+      #
+      def dest_fit_bounds_horizontally(top, page=current_page)
+        [page, :FitBH, top]
+      end
+
+      # Same as #dest_fit_vertically, but works on the page's bounding box
+      # instead of the entire page.
+      #
+      def dest_fit_bounds_vertically(left, page=current_page)
+        [page, :FitBV, left]
+      end
+    end
+  end
+end

data/lib/prawn/core/document_state.rb

@@ -0,0 +1,84 @@
+module Prawn
+  module Core
+    class DocumentState #:nodoc:
+      def initialize(options)
+        normalize_metadata(options)
+
+        if options[:template]
+          @store = Prawn::Core::ObjectStore.new(:template => options[:template])
+        else
+          @store = Prawn::Core::ObjectStore.new(:info => options[:info])
+        end
+
+        @version                 = 1.3
+        @pages                   = []
+        @page                    = nil
+        @trailer                 = {}
+        @compress                = options.fetch(:compress, false)
+        @encrypt                 = options.fetch(:encrypt, false)
+        @encryption_key          = options[:encryption_key]
+        @optimize_objects        = options.fetch(:optimize_objects, false)
+        @skip_encoding           = options.fetch(:skip_encoding, false)
+        @before_render_callbacks = []
+        @on_page_create_callback = nil
+      end
+
+      attr_accessor :store, :version, :pages, :page, :trailer, :compress,
+        :encrypt, :encryption_key, :optimize_objects, :skip_encoding,
+        :before_render_callbacks, :on_page_create_callback
+
+      def populate_pages_from_store(document)
+        return 0 if @store.page_count <= 0 || @pages.size > 0
+
+        count = (1..@store.page_count)
+        @pages = count.map do |index|
+          orig_dict_id = @store.object_id_for_page(index)
+          Prawn::Core::Page.new(document, :object_id => orig_dict_id)
+        end
+
+      end
+
+      def normalize_metadata(options)
+        options[:info] ||= {}
+        options[:info][:Creator] ||= "Prawn"
+        options[:info][:Producer] = "Prawn"
+
+        info = options[:info]
+
+        info.keys.each do |key|
+          if info[key].kind_of?(String)
+            info[key] = Prawn::Core::LiteralString.new(info[key])
+          end
+        end
+      end
+
+      def insert_page(page, page_number)
+        pages.insert(page_number, page)
+        store.pages.data[:Kids].insert(page_number, page.dictionary)
+        store.pages.data[:Count] += 1
+      end
+
+      def on_page_create_action(doc)
+        on_page_create_callback[doc] if on_page_create_callback
+      end
+
+      def before_render_actions(doc)
+        before_render_callbacks.each{ |c| c.call(self) }
+      end
+
+      def page_count
+        pages.length
+      end
+
+      def render_body(output)
+        store.compact if optimize_objects
+        store.each do |ref|
+          ref.offset = output.size
+          output << (@encrypt ? ref.encrypted_object(@encryption_key) : 
+                                ref.object)
+        end
+      end
+
+    end
+  end
+end

data/lib/prawn/core/literal_string.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Prawn
+  module Core
+    # This is used to differentiate strings that must be encoded as
+    # a *literal* string, versus those that can be encoded in
+    # the PDF hexadecimal format.
+    #
+    # Some features of the PDF format appear to require that literal
+    # strings be used. One such feature is the /Dest key of a link
+    # annotation; if a hex encoded string is used there, the links
+    # do not work (as tested in Mac OS X Preview, and Adobe Acrobat
+    # Reader).
+    class LiteralString < String #:nodoc:
+    end
+  end
+end