prawn 1.0.0.rc1 → 1.0.0.rc2

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+gem "ttfunk", "~>1.0.3"
+gem "pdf-reader", "~> 1.2"
+gem "ruby-rc4"
+gem "afm"
+
+group :development do
+  gem "coderay", "~> 1.0.7"
+  gem "rdoc"
+end
+
+group :test do
+  gem "pdf-inspector", "~> 1.0.2", :require => "pdf/inspector"
+  gem "rspec"
+  gem "mocha", :require => false
+  gem "rake"
+end

data/README.md

@@ -1,5 +1,7 @@
 # Prawn: Fast, Nimble PDF Generation For Ruby
 
+[![Build Status](https://secure.travis-ci.org/prawnpdf/prawn.png)](http://travis-ci.org/prawnpdf/prawn)
+
 Prawn is a pure Ruby PDF generation library that provides a lot of great functionality while trying to remain simple and reasonably performant. Here are some of the important features we provide:
 
 * Vector drawing support, including lines, polygons, curves, ellipses, etc.
@@ -33,7 +35,7 @@ You can also install from git if you'd like, the _master_ branch contains the la
 
 ## Release Policies
 
-We may introduce backwards incompatible changes each time our minor version number is bumped, but that any tiny version number bump should be bug fixes and internal changes only. Be sure to read the release notes each time we cut a new release and lock your gems accordingly. You can find the project CHANGELOG at: https://github.com/sandal/prawn/wiki/CHANGELOG
+We may introduce backwards incompatible changes each time our minor version number is bumped, but that any tiny version number bump should be bug fixes and internal changes only. Be sure to read the release notes each time we cut a new release and lock your gems accordingly. You can find the project CHANGELOG at: https://github.com/prawnpdf/prawn/wiki/CHANGELOG
 
 ## Hello World!
 
@@ -73,7 +75,7 @@ Please make your posts to the list as specific as possible, including code sampl
 
 If you've found a bug, want to submit a patch, or have a feature request, please enter a ticket into our github tracker:
 
-<http://github.com/sandal/prawn/issues>
+<http://github.com/prawnpdf/prawn/issues>
 
 We strongly encourage bug reports to come with failing tests or at least a reduced example that demonstrates the problem. Similarly, patches should include tests, API documentation, and an update to the manual where relevant. Feel free to send a pull request early though, if you just want some feedback or a code review before preparing your code to be merged.
 
@@ -87,7 +89,7 @@ Over the last several years, we've received code contributions from over 50 peop
 
 While he was only with us for a short time before moving on to other things, we'd also like to thank Prawn core team emeritus Jamis Buck for his contributions. He was responsible for introducing font subsetting as well as the first implementation of our inline formatting support.
 
-You can find the full list of folks who have at least one patch accepted to Prawn on github at https://github.com/sandal/prawn/contributors
+You can find the full list of folks who have at least one patch accepted to Prawn on github at https://github.com/prawnpdf/prawn/contributors
 
 ## License
 

data/Rakefile

@@ -1,21 +1,15 @@
-require "rubygems"
 require "bundler"
 Bundler.setup
 
 require 'rake'
-require 'rake/testtask'
-require "rake/rdoctask"
-require "rake/gempackagetask"  
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'rubygems/package_task'
 
-task :default => [:test]
+task :default => [:spec]
        
-desc "Run all tests, test-spec, mocha, and pdf-reader required"
-Rake::TestTask.new do |test|
-  # test.ruby_opts  << "-w"  # .should == true triggers a lot of warnings
-  test.libs       << "spec"
-  test.test_files =  Dir[ "spec/*_spec.rb" ]
-  test.verbose    =  true
-end
+desc "Run all rspec files"
+RSpec::Core::RakeTask.new("spec")
 
 desc "Show library's code statistics"
 task :stats do
@@ -26,7 +20,7 @@ task :stats do
 end
 
 desc "genrates documentation"
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include( "README",
                            "COPYING",
                            "LICENSE", 
@@ -45,7 +39,7 @@ task :manual do
 end
 
 spec = Gem::Specification.load "prawn.gemspec"
-Rake::GemPackageTask.new(spec) do |pkg|
+Gem::PackageTask.new(spec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
 end

data/data/pdfs/nested_pages.pdf

@@ -49,7 +49,7 @@ endobj
 >>
 /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
 >>
-/Parent 4 0 R
+/Parent 3 0 R
 >>
 endobj
 7 0 obj
@@ -85,7 +85,7 @@ endobj
 >>
 /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
 >>
-/Parent 4 0 R
+/Parent 3 0 R
 >>
 endobj
 10 0 obj
@@ -97,17 +97,17 @@ endobj
 endobj
 xref
 0 11
-0000000000 65535 f 
-0000000015 00000 n 
-0000000071 00000 n 
-0000000120 00000 n 
-0000000183 00000 n 
-0000000240 00000 n 
-0000000494 00000 n 
-0000000672 00000 n 
-0000000769 00000 n 
-0000000994 00000 n 
-0000001173 00000 n 
+0000000000 65535 f
+0000000015 00000 n
+0000000071 00000 n
+0000000120 00000 n
+0000000183 00000 n
+0000000240 00000 n
+0000000494 00000 n
+0000000672 00000 n
+0000000769 00000 n
+0000000994 00000 n
+0000001173 00000 n
 trailer
 << /Root 2 0 R
 /Size 11

data/lib/prawn.rb

@@ -5,9 +5,10 @@
 # into the lib/prawn/core/* source tree.
 #
 module Prawn #:nodoc:
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end
 
+require "prawn/utilities"
 require "prawn/core"
 require "prawn/text"
 require "prawn/graphics"
@@ -16,6 +17,7 @@ require "prawn/images/image"
 require "prawn/images/jpg"
 require "prawn/images/png"
 require "prawn/stamp"
+require "prawn/soft_mask"
 require "prawn/security"
 require "prawn/document"
 require "prawn/font"

data/lib/prawn/compatibility.rb

@@ -1,24 +1,60 @@
 # coding: utf-8
 #
-# Why would we ever use Ruby 1.8.7 when we can backport with something
-# as simple as this?
-#
+# Compatibility layer to smooth over differences between Ruby implementations
+# The oldest version of Ruby which is supported is MRI 1.8.7
+# Ideally, all version-specific or implementation-specific code should be
+#   kept in this file (but that ideal has not been attained yet)
+
 class String  #:nodoc:
   def first_line
     self.each_line { |line| return line }
   end
-  unless "".respond_to?(:lines)
-    alias_method :lines, :to_a
+
+  unless "".respond_to?(:codepoints)
+    def codepoints(&block)
+      if block_given?
+        unpack("U*").each(&block)
+      else
+        unpack("U*")
+      end
+    end
   end
-  unless "".respond_to?(:each_char)
-    def each_char #:nodoc:
-      # copied from jcode
+
+  if "".respond_to?(:encode)
+    def normalize_to_utf8
+      begin
+        encode(Encoding::UTF_8)
+      rescue
+        raise Prawn::Errors::IncompatibleStringEncoding, "Encoding " +
+        "#{text.encoding} can not be transparently converted to UTF-8. " +
+        "Please ensure the encoding of the string you are attempting " +
+        "to use is set correctly"
+      end      
+    end
+    alias :unicode_characters :each_char
+    alias :unicode_length     :length
+
+  else
+    def normalize_to_utf8
+      begin
+        # use unpack as a hackish way to verify the string is valid utf-8
+        unpack("U*")
+        return dup
+      rescue
+        raise Prawn::Errors::IncompatibleStringEncoding, "The string you " +
+        "are attempting to render is not encoded in valid UTF-8."
+      end
+    end
+    def unicode_characters
       if block_given?
-        scan(/./m) { |x| yield x }
+        unpack("U*").each { |c| yield [c].pack("U") }
       else
-        scan(/./m)
+        unpack("U*").map { |c| [c].pack("U") }
       end
     end
+    def unicode_length
+      unpack("U*").length
+    end
   end
 end
 

data/lib/prawn/core.rb

@@ -29,7 +29,9 @@ module Prawn
                           
   # The base source directory for Prawn as installed on the system
   #
-  BASEDIR = File.expand_path(File.join(dir, '..', '..'))
+  # 
+  BASEDIR = File.expand_path(File.join(dir, '..','..'))
+  DATADIR = File.expand_path(File.join(dir, '..', '..', 'data'))
 
   # Whe set to true, Prawn will verify hash options to ensure only valid keys
   # are used.  Off by default.

data/lib/prawn/core/document_state.rb

@@ -6,6 +6,7 @@ module Prawn
 
         if options[:template]
           @store = Prawn::Core::ObjectStore.new(:template => options[:template])
+          @store.info.data.merge!(options[:info]) if options[:info]
         else
           @store = Prawn::Core::ObjectStore.new(:info => options[:info])
         end
@@ -41,7 +42,7 @@ module Prawn
       def normalize_metadata(options)
         options[:info] ||= {}
         options[:info][:Creator] ||= "Prawn"
-        options[:info][:Producer] = "Prawn"
+        options[:info][:Producer] ||= "Prawn"
 
         info = options[:info]
       end

data/lib/prawn/core/object_store.rb

@@ -141,16 +141,32 @@ module Prawn
       # Imports nothing and returns nil if the requested page number doesn't
       # exist. page_num is 1 indexed, so 1 indicates the first page.
       #
-      def import_page(filename, page_num)
+      def import_page(input, page_num)
         @loaded_objects = {}
-        unless File.file?(filename)
-          raise ArgumentError, "#{filename} does not exist"
+        if template_id = indexed_template(input, page_num)
+          return template_id
         end
 
-        hash = PDF::Reader::ObjectHash.new(filename)
+        io = if input.respond_to?(:seek) && input.respond_to?(:read)
+               input
+             elsif File.file?(input.to_s)
+               StringIO.new(File.binread(input.to_s))
+             else
+               raise ArgumentError, "input must be an IO-like object or a filename"
+             end
+
+                # unless File.file?(filename)
+        #   raise ArgumentError, "#{filename} does not exist"
+        # end
+
+        hash = indexed_hash(input, io)
         ref  = hash.page_references[page_num - 1]
 
-        ref.nil? ? nil : load_object_graph(hash, ref).identifier
+        if ref.nil?
+          nil
+        else
+          index_template(input, page_num, load_object_graph(hash, ref).identifier)
+        end
 
       rescue PDF::Reader::MalformedPDFError, PDF::Reader::InvalidObjectError
         msg = "Error reading template file. If you are sure it's a valid PDF, it may be a bug."
@@ -162,6 +178,46 @@ module Prawn
 
       private
 
+      # An index for page templates so that their loaded object graph
+      # can be reused without multiple loading
+      def template_index
+        @template_index ||= {}
+      end
+
+      # An index for the read object hash of a pdf template so that the
+      # object hash does not need to be parsed multiple times when using
+      # different pages of the pdf as page templates
+      def hash_index
+        @hash_index ||= {}
+      end
+
+      # returns the indexed object graph identifier for a template page if
+      # it exists
+      def indexed_template(input, page_number)
+        key = indexing_key(input)
+        template_index[key] && template_index[key][page_number]
+      end
+
+      # indexes the identifier for a page from a template
+      def index_template(input, page_number, id)
+        (template_index[indexing_key(input)] ||= {})[page_number] ||= id
+      end
+
+      # reads and indexes a new IO for a template
+      # if the IO has been indexed already then the parsed object hash
+      # is returned directly
+      def indexed_hash(input, io)
+        hash_index[indexing_key(input)] ||= PDF::Reader::ObjectHash.new(io)
+      end
+
+      # the index key for the input.
+      # uses object_id so that both a string filename or an IO stream can be
+      # indexed and reused provided the same object gets used in multiple page
+      # template calls.
+      def indexing_key(input)
+        input.object_id
+      end
+
       # returns a nested array of object IDs for all pages in this object store.
       #
       def get_page_objects(obj)

data/lib/prawn/core/page.rb

@@ -63,7 +63,6 @@ module Prawn
           document.restore_graphics_state
         end
 
-        @stamp_dictionary.data[:Length] = @stamp_stream.length + 1
         @stamp_dictionary << @stamp_stream
 
         @stamp_stream      = nil
@@ -84,7 +83,7 @@ module Prawn
         unless dictionary.data[:Contents].is_a?(Array)
           dictionary.data[:Contents] = [content]
         end
-        @content    = document.ref(:Length => 0)
+        @content    = document.ref({})
         dictionary.data[:Contents] << document.state.store[@content]
         document.open_graphics_state
       end
@@ -129,11 +128,9 @@ module Prawn
         if dictionary.data[:Contents].is_a?(Array)
           dictionary.data[:Contents].each do |stream|
             stream.compress_stream if document.compression_enabled?
-            stream.data[:Length] = stream.stream.size
           end
         else
           content.compress_stream if document.compression_enabled?
-          content.data[:Length] = content.stream.size
         end
       end
 
@@ -160,7 +157,7 @@ module Prawn
 
       def init_from_object(options)
         @dictionary = options[:object_id].to_i
-        dictionary.data[:Parent] = document.state.store.pages
+        dictionary.data[:Parent] = document.state.store.pages if options[:page_template]
 
         unless dictionary.data[:Contents].is_a?(Array) # content only on leafs
           @content    = dictionary.data[:Contents].identifier
@@ -175,7 +172,7 @@ module Prawn
         @size     = options[:size]    ||  "LETTER"
         @layout   = options[:layout]  || :portrait
 
-        @content    = document.ref(:Length      => 0)
+        @content    = document.ref({})
         content << "q" << "\n"
         @dictionary = document.ref(:Type        => :Page,
                                    :Parent      => document.state.store.pages,

data/lib/prawn/core/pdf_object.rb

@@ -16,14 +16,21 @@ module Prawn
     if "".respond_to?(:encode)
       # Ruby 1.9+
       def utf8_to_utf16(str)
-        "\xFE\xFF".force_encoding("UTF-16BE") + str.encode("UTF-16BE")
+        utf16 = "\xFE\xFF".force_encoding("UTF-16BE") + str.encode("UTF-16BE")
+      end
+
+      # encodes any string into a hex representation. The result is a string
+      # with only 0-9 and a-f characters. That result is valid ASCII so tag
+      # it as such to account for behaviour of different ruby VMs
+      def string_to_hex(str)
+        str.unpack("H*").first.force_encoding("ascii")
       end
     else
       # Ruby 1.8
       def utf8_to_utf16(str)
         utf16 = "\xFE\xFF"
 
-        str.unpack("U*").each do |cp|
+        str.codepoints do |cp|
           if cp < 0x10000 # Basic Multilingual Plane
             utf16 << [cp].pack("n")
           else
@@ -36,6 +43,10 @@ module Prawn
 
         utf16
       end
+
+      def string_to_hex(str)
+        str.unpack("H*").first
+      end
     end
       
     # Serializes Ruby objects to their PDF equivalents.  Most primitive objects
@@ -57,7 +68,13 @@ module Prawn
       when NilClass   then "null" 
       when TrueClass  then "true"
       when FalseClass then "false"
-      when Numeric    then String(obj)
+      when Numeric
+        if (str = String(obj)) =~ /e/i
+          # scientific notation is not supported in PDF
+          sprintf("%.16f", obj).gsub(/\.?0+\z/, "")
+        else
+          str
+        end
       when Array
         "[" << obj.map { |e| PdfObject(e, in_content_stream) }.join(' ') << "]"
       when Prawn::Core::LiteralString
@@ -71,7 +88,7 @@ module Prawn
         "<" << obj.unpack("H*").first << ">"
       when String
         obj = utf8_to_utf16(obj) unless in_content_stream
-        "<" << obj.unpack("H*").first << ">"
+        "<" << string_to_hex(obj) << ">"
        when Symbol                                                         
          "/" + obj.to_s.unpack("C*").map { |n|
           if n < 33 || n > 126 || [35,40,41,47,60,62].include?(n)