prawn 0.15.0 → 1.0.0.rc1

data/lib/prawn/measurement_extensions.rb

@@ -5,17 +5,13 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require_relative 'measurements'
-
-# @group Stable API
+require 'prawn/measurements'
 
 class Numeric
-  include Prawn::Measurements
-  # prawns' basic unit is PostScript-Point
+  include Prawn::Measurements        
+  # prawns' basic unit is PostScript-Point        
   # 72 points per inch
 
-  # @group Experimental API
-  
   def mm
     return mm2pt(self)
   end
@@ -43,8 +39,8 @@ class Numeric
   def ft
     return ft2pt(self)
   end
-
+  
   def pt
-    return pt2pt(self)
+    return self
   end
-end
+end        

data/lib/prawn/measurements.rb

@@ -3,75 +3,69 @@
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.
 #
-module Prawn
-  # @group Stable API
-
+module Prawn  
   module Measurements
-
+  
     # ============================================================================
     #metric conversions
     def cm2mm(cm)
       return cm*10
     end
-
+  
     def dm2mm(dm)
-      return dm*100
+      return dm*100  
     end
-
+  
     def m2mm(m)
       return m*1000
     end
-
+  
     # ============================================================================
-    # imperial conversions
+    # imperial conversions    
     # from http://en.wikipedia.org/wiki/Imperial_units
-
+  
     def ft2in(ft)
       return ft * 12
-    end
+    end  
 
     def yd2in(yd)
       return yd*36
     end
 
-
+  
     # ============================================================================
     # PostscriptPoint-converisons
-
-    def pt2pt(pt)
-      return pt
-    end
-
+  
     def in2pt(inch)
-      return inch * 72
+      return inch * 72    
     end
-
+  
     def ft2pt(ft)
       return in2pt(ft2in(ft))
     end
-
+  
     def yd2pt(yd)
       return in2pt(yd2in(yd))
     end
-
+  
     def mm2pt(mm)
         return mm*(72 / 25.4)
     end
-
+  
     def cm2pt(cm)
       return mm2pt(cm2mm(cm))
     end
-
+  
     def dm2pt(dm)
       return mm2pt(dm2mm(dm))
     end
-
+  
     def m2pt(m)
       return mm2pt(m2mm(m))
     end
-
-    def pt2mm(pt)
+  
+    def pt2mm(pt)    
       return pt * 1 / mm2pt(1)# (25.4 / 72)
     end
   end
-end
+end

data/lib/prawn/outline.rb

@@ -5,20 +5,322 @@
 # Author Jonathan Greenberg
 
 require 'forwardable'
-require "pdf/core/outline"
 
 module Prawn
-
+  
   class Document
 
-    # @group Experimental API
-
     # Lazily instantiates an Outline object for document. This is used as point of entry
     # to methods to build the outline tree.
     def outline
-      @outline ||= PDF::Core::Outline.new(self)
-    end
+      @outline ||= Outline.new(self)
+    end 
 
   end
+  
+  # The Outline class organizes the outline tree items for the document.
+  # Note that the prev and parent instance variables are adjusted while navigating 
+  # through the nested blocks. These variables along with the presence or absense 
+  # of blocks are the primary means by which the relations for the various
+  # OutlineItems and the OutlineRoot are set. Unfortunately, the best way to
+  # understand how this works is to follow the method calls through a real example.
+  #
+  # Some ideas for the organization of this class were gleaned from name_tree. In 
+  # particular the way in which the OutlineItems are finally rendered into document 
+  # objects in PdfObject through a hash.
+  #
+  class Outline
+    
+    extend Forwardable
+    def_delegator :@document, :page_number
+    
+    attr_accessor :parent
+    attr_accessor :prev
+    attr_accessor :document
+    attr_accessor :items
+    
+    def initialize(document)
+      @document = document
+      @parent = root
+      @prev = nil
+      @items = {}
+    end 
+    
+    # Defines/Updates an outline for the document.
+    # The outline is an optional nested index that appears on the side of a PDF 
+    # document usually with direct links to pages. The outline DSL is defined by nested 
+    # blocks involving two methods: section and page; see the documentation on those methods 
+    # for their arguments and options. Note that one can also use outline#update 
+    # to add more sections to the end of the outline tree using the same syntax and scope. 
+    #
+    # The syntax is best illustrated with an example:
+    #
+    # Prawn::Document.generate(outlined_document.pdf) do
+    #   text "Page 1. This is the first Chapter. "
+    #   start_new_page
+    #   text "Page 2. More in the first Chapter. "
+    #   start_new_page
+    #   outline.define do
+    #     section 'Chapter 1', :destination => 1, :closed => true do 
+    #       page :destination => 1, :title => 'Page 1'
+    #       page :destination => 2, :title => 'Page 2'
+    #     end
+    #   end 
+    #   start_new_page do
+    #   outline.update do 
+    #     section 'Chapter 2', :destination =>  2, do
+    #       page :destination => 3, :title => 'Page 3'
+    #     end
+    #   end
+    # end 
+    #
+    def define(&block)
+      instance_eval(&block)  if block
+    end
+    
+    alias :update :define 
+         
+    # Inserts an outline section to the outline tree (see outline#define).
+    # Although you will probably choose to exclusively use outline#define so 
+    # that your outline tree is contained and easy to manage, this method
+    # gives you the option to insert sections to the outline tree at any point
+    # during document generation. This method allows you to add a child subsection 
+    # to any other item at any level in the outline tree. 
+    # Currently the only way to locate the place of entry is with the title for the 
+    # item. If your title names are not unique consider using define_outline.
+    # The method takes the following arguments:
+    #   title: a string that must match an outline title to add the subsection to
+    #   position: either :first or :last(the default) where the subsection will be placed relative 
+    #      to other child elements. If you need to position your subsection in between 
+    #      other elements then consider using #insert_section_after   
+    #   block: uses the same DSL syntax as outline#define, for example: 
+    #
+    # Consider using this method inside of outline.update if you want to have the outline object
+    # to be scoped as self (see #insert_section_after example).
+    # 
+    #   go_to_page 2
+    #   start_new_page
+    #   text "Inserted Page"
+    #   outline.add_subsection_to :title => 'Page 2', :first do 
+    #     outline.page :destination => page_number, :title => "Inserted Page"
+    #   end
+    # 
+    def add_subsection_to(title, position = :last, &block)
+      @parent = items[title]
+      raise Prawn::Errors::UnknownOutlineTitle, 
+        "\n No outline item with title: '#{title}' exists in the outline tree" unless @parent
+      @prev = position == :first ? nil : @parent.data.last
+      nxt = position == :first ? @parent.data.first : nil
+      insert_section(nxt, &block)  
+    end
+      
+    # Inserts an outline section to the outline tree (see outline#define).
+    # Although you will probably choose to exclusively use outline#define so 
+    # that your outline tree is contained and easy to manage, this method
+    # gives you the option to insert sections to the outline tree at any point
+    # during document generation. Unlike outline.add_section, this method allows 
+    # you to enter a section after any other item at any level in the outline tree. 
+    # Currently the only way to locate the place of entry is with the title for the 
+    # item. If your title names are not unique consider using define_outline.
+    # The method takes the following arguments:
+    #   title: the title of other section or page to insert new section after
+    #   block: uses the same DSL syntax as outline#define, for example: 
+    # 
+    #   go_to_page 2
+    #   start_new_page
+    #   text "Inserted Page"
+    #   update_outline do
+    #     insert_section_after :title => 'Page 2' do 
+    #       page :destination => page_number, :title => "Inserted Page" 
+    #     end
+    #   end
+    #
+    def insert_section_after(title, &block)
+      @prev = items[title]
+      raise Prawn::Errors::UnknownOutlineTitle, 
+        "\n No outline item with title: '#{title}' exists in the outline tree" unless @prev
+      @parent = @prev.data.parent
+      nxt = @prev.data.next
+      insert_section(nxt, &block)   
+    end
+     
+    # See outline#define above for documentation on how this is used in that context
+    #
+    # Adds an outine section to the outline tree.
+    # Although you will probably choose to exclusively use outline#define so 
+    # that your outline tree is contained and easy to manage, this method
+    # gives you the option to add sections to the outline tree at any point
+    # during document generation. When not being called from within another #section block 
+    # the section will be added at the top level after the other root elements of the outline. 
+    # For more flexible placement try using outline#insert_section_after and/or      
+    # outline#add_subsection_to 
+    # Takes the following arguments:
+    #   title: the outline text that appears for the section.
+    #   options: destination - optional integer defining the page number for a destination link.
+    #                 - currently only :FIT destination supported with link to top of page.
+    #            closed - whether the section should show its nested outline elements.
+    #                   - defaults to false. 
+    #            block: more nested subsections and/or page blocks 
+    #   
+    # example usage:
+    #
+    #   outline.section 'Added Section', :destination => 3 do
+    #     outline.page :destionation => 3, :title => 'Page 3'
+    #   end
+    def section(title, options = {}, &block)
+      add_outline_item(title, options, &block)
+    end 
+    
+    # See Outline#define above for more documentation on how it is used in that context
+    #
+    # Adds a page to the outline.
+    # Although you will probably choose to exclusively use outline#define so 
+    # that your outline tree is contained and easy to manage, this method also
+    # gives you the option to add pages to the root of outline tree at any point
+    # during document generation. Note that the page will be added at the 
+    # top level after the other root outline elements. For more flexible placement try
+    # using outline#insert_section_after and/or outline#add_subsection_to.
+    # 
+    # Takes the following arguments:
+    #     options:
+    #            title - REQUIRED. The outline text that appears for the page. 
+    #            destination - integer defining the page number for the destination link.
+    #              currently only :FIT destination supported with link to top of page.
+    #            closed - whether the section should show its nested outline elements.
+    #                   - defaults to false.
+    # example usage:
+    #
+    #   outline.page :title => "Very Last Page" 
+    # Note: this method is almost identical to section except that it does not accept a block 
+    # thereby defining the outline item as a leaf on the outline tree structure. 
+    def page(options = {})
+      if options[:title]
+        title = options[:title] 
+      else
+        raise Prawn::Errors::RequiredOption, 
+          "\nTitle is a required option for page"
+      end
+      add_outline_item(title, options)
+    end
+      
+  private 
+  
+    # The Outline dictionary (12.3.3) for this document.  It is
+    # lazily initialized, so that documents that do not have an outline
+    # do not incur the additional overhead.
+    def root
+      document.state.store.root.data[:Outlines] ||= document.ref!(OutlineRoot.new)
+    end
+     
+    def add_outline_item(title, options, &block)
+      outline_item = create_outline_item(title, options)
+      set_relations(outline_item)
+      increase_count
+      set_variables_for_block(outline_item, block)
+      block.call if block
+      reset_parent(outline_item)
+    end
+    
+    def create_outline_item(title, options)
+      outline_item = OutlineItem.new(title, parent, options)
 
+      if options[:destination]
+        page_index = options[:destination] - 1
+        outline_item.dest = [document.state.pages[page_index].dictionary, :Fit] 
+      end
+
+      outline_item.prev = prev if @prev
+      items[title] = document.ref!(outline_item)
+    end
+    
+    def set_relations(outline_item)
+      prev.data.next = outline_item if prev
+      parent.data.first = outline_item unless prev
+      parent.data.last = outline_item
+    end
+    
+    def increase_count
+      counting_parent = parent
+      while counting_parent
+        counting_parent.data.count += 1
+        if counting_parent == root
+          counting_parent = nil
+        else
+          counting_parent = counting_parent.data.parent
+        end
+      end
+    end
+    
+    def set_variables_for_block(outline_item, block)
+      self.prev = block ? nil : outline_item
+      self.parent = outline_item if block
+    end
+    
+    def reset_parent(outline_item)
+      if parent == outline_item
+        self.prev = outline_item
+        self.parent = outline_item.data.parent
+      end
+    end 
+    
+    def insert_section(nxt, &block)
+      last = @parent.data.last
+      if block
+        block.call
+      end
+      adjust_relations(nxt, last)
+      reset_root_positioning
+    end
+    
+    def adjust_relations(nxt, last)
+      if nxt 
+        nxt.data.prev = @prev
+        @prev.data.next = nxt
+        @parent.data.last = last
+      end
+    end 
+    
+    def reset_root_positioning
+      @parent = root
+      @prev = root.data.last
+    end
+    
+  end
+  
+  class OutlineRoot #:nodoc:
+    attr_accessor :count, :first, :last
+    
+    def initialize
+      @count = 0
+    end
+        
+    def to_hash
+      {:Type => :Outlines, :Count => count, :First => first, :Last => last}
+    end
+  end
+  
+  class OutlineItem #:nodoc:
+    attr_accessor :count, :first, :last, :next, :prev, :parent, :title, :dest, :closed
+  
+    def initialize(title, parent, options)
+      @closed = options[:closed]
+      @title = title
+      @parent = parent
+      @count = 0
+    end
+  
+    def to_hash
+      hash = { :Title => title,
+               :Parent => parent,
+               :Count => closed ? -count : count }
+      [{:First => first}, {:Last => last}, {:Next => @next}, 
+       {:Prev => prev}, {:Dest => dest}].each do |h|
+        unless h.values.first.nil?
+          hash.merge!(h)
+        end
+      end
+      hash 
+    end
+  end    
 end
+