prawn 0.2.3 → 0.3.0

data/lib/prawn/name_tree.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+
+# name_tree.rb : Implements NameTree for PDF
+#
+# Copyright November 2008, Jamis Buck. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+require 'prawn/literal_string'
+require 'prawn/reference'
+
+module Prawn
+  module NameTree #:nodoc:
+    class Node #:nodoc:
+      attr_reader :children
+      attr_reader :limit
+      attr_reader :document
+      attr_accessor :parent
+      attr_accessor :ref
+
+      def initialize(document, limit, parent=nil)
+        @document = document
+        @children = []
+        @limit = limit
+        @parent = parent
+        @ref = nil
+      end
+
+      def empty?
+        children.empty?
+      end
+
+      def size
+        leaf? ? children.size : children.inject(0) { |sum, child| sum + child.size }
+      end
+
+      def leaf?
+        children.empty? || children.first.is_a?(Value)
+      end
+
+      def add(name, value)
+        self << Value.new(name, value)
+      end
+
+      def to_hash
+        hash = {}
+
+        hash[:Limits] = [least, greatest] if parent
+        if leaf?
+          hash[:Names] = children if leaf?
+        else
+          hash[:Kids] = children.map { |child| child.ref }
+        end
+
+        return hash
+      end
+
+      def least
+        if leaf?
+          children.first.name
+        else
+          children.first.least
+        end
+      end
+
+      def greatest
+        if leaf?
+          children.last.name
+        else
+          children.last.greatest
+        end
+      end
+
+      def <<(value)
+        if children.empty?
+          children << value
+        elsif leaf?
+          children.insert(insertion_point(value), value)
+          split! if children.length > limit
+        else
+          fit = children.detect { |child| child >= value }
+          fit << value
+        end
+
+        value
+      end
+
+      def >=(value)
+        children.empty? || children.last >= value
+      end
+
+      def split!
+        if parent
+          parent.split(self)
+        else
+          left, right = new_node(self), new_node(self)
+          split_children(self, left, right)
+          children.replace([left, right])
+        end
+      end
+
+      protected
+
+        def split(node)
+          new_child = new_node(self)
+          split_children(node, node, new_child)
+          index = children.index(node)
+          children.insert(index+1, new_child)
+          split! if children.length > limit
+        end
+
+      private
+
+        def new_node(parent=nil)
+          node = Node.new(document, limit, parent)
+          node.ref = document.ref(node)
+          return node
+        end
+
+        def split_children(node, left, right)
+          half = (node.limit+1)/2
+
+          left_children, right_children = node.children[0...half], node.children[half..-1]
+
+          left.children.replace(left_children)
+          right.children.replace(right_children)
+
+          unless node.leaf?
+            left_children.each { |child| child.parent = left }
+            right_children.each { |child| child.parent = right }
+          end
+        end
+
+        def insertion_point(value)
+          children.each_with_index do |child, index|
+            return index if child >= value
+          end
+          return children.length
+        end
+    end
+
+    class Value #:nodoc:
+      include Comparable
+
+      attr_reader :name
+      attr_reader :value
+
+      def initialize(name, value)
+        @name, @value = Prawn::LiteralString.new(name), value
+      end
+
+      def <=>(leaf)
+        name <=> leaf.name
+      end
+
+      def inspect
+        "#<Value: #{name.inspect} : #{value.inspect}>"
+      end
+
+      def to_s
+        "#{name} : #{value}"
+      end
+    end
+  end
+end

data/lib/prawn/pdf_object.rb

@@ -34,7 +34,10 @@ module Prawn
     when Numeric    then String(obj)
     when Array
       "[" << obj.map { |e| PdfObject(e, in_content_stream) }.join(' ') << "]"
-    when String     
+    when Prawn::LiteralString
+      obj = obj.gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
+      "(#{obj})"
+    when String
       obj = "\xFE\xFF" + obj.unpack("U*").pack("n*") unless in_content_stream
       "<" << obj.unpack("H*").first << ">"
     when Symbol                                                         
@@ -57,6 +60,10 @@ module Prawn
       output << ">>"  
     when Prawn::Reference
       obj.to_s      
+    when Prawn::NameTree::Node
+      PdfObject(obj.to_hash)
+    when Prawn::NameTree::Value
+      PdfObject(obj.name) + " " + PdfObject(obj.value)
     else
       raise Prawn::Errors::FailedObjectConversion, 
         "This object cannot be serialized to PDF"

data/spec/annotations_spec.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+                               
+class PageAnnotations
+  attr_reader :pages
+
+  def self.parse(document)
+    receiver = new
+    PDF::Reader.string(document.render, receiver)
+    return receiver
+  end
+
+  def initialize
+    @pages = []
+  end
+
+  def begin_page(params)
+    @pages << params
+  end
+end
+
+describe "When creating annotations" do 
+ 
+  before(:each) { create_pdf }
+  
+  it "should append annotation to current page" do 
+    @pdf.start_new_page
+    @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
+    obj = PageAnnotations.parse(@pdf)
+    obj.pages[0][:Annots].nil?.should == true
+    obj.pages[1][:Annots].length.should == 1
+  end
+
+  it "should force :Type to be :Annot" do
+    opts = @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
+    opts[:Type].should == :Annot
+    opts = @pdf.annotate(:Type => :Bogus, :Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
+    opts[:Type].should == :Annot
+  end
+
+end
+
+describe "When creating text annotations" do
+ 
+  before(:each) do
+    @rect = [0,0,10,10]
+    @content = "Hello, world!"
+    create_pdf
+  end
+  
+  it "should build appropriate annotation" do 
+    opts = @pdf.text_annotation(@rect, @content)
+    opts[:Type].should == :Annot
+    opts[:Subtype].should == :Text
+    opts[:Rect].should == @rect
+    opts[:Contents].should == @content
+  end
+
+  it "should merge extra options" do 
+    opts = @pdf.text_annotation(@rect, @content, :Open => true, :Subtype => :Bogus)
+    opts[:Subtype].should == :Text
+    opts[:Open].should == true
+  end
+
+end
+
+describe "When creating link annotations" do
+ 
+  before(:each) do
+    @rect = [0,0,10,10]
+    @dest = "home"
+    create_pdf
+  end
+  
+  it "should build appropriate annotation" do 
+    opts = @pdf.link_annotation(@rect, :Dest => @dest)
+    opts[:Type].should == :Annot
+    opts[:Subtype].should == :Link
+    opts[:Rect].should == @rect
+    opts[:Dest].should == @dest
+  end
+
+  it "should merge extra options" do 
+    opts = @pdf.link_annotation(@rect, :Dest => @dest, :Subtype => :Bogus)
+    opts[:Subtype].should == :Link
+    opts[:Dest].should == @dest
+  end
+
+end

data/spec/destinations_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+
+describe "When creating destinations" do 
+ 
+  before(:each) { create_pdf }
+  
+  it "should add entry to Dests name tree" do 
+    @pdf.dests.data.empty?.should == true
+    @pdf.add_dest "candy", "chocolate"
+    @pdf.dests.data.size.should == 1
+  end
+
+end

data/spec/document_spec.rb

@@ -1,6 +1,16 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+
+describe "The cursor" do
+  it "should equal pdf.y - bounds.absolute_bottom" do
+    pdf = Prawn::Document.new
+    pdf.cursor.should == pdf.bounds.top
+    
+    pdf.y = 300
+    pdf.cursor.should == pdf.y - pdf.bounds.absolute_bottom 
+  end
+end 
                                
 describe "When creating multi-page documents" do 
  
@@ -38,7 +48,23 @@ describe "When beginning each new page" do
     pdf.render
     
     call_count.should == 3
-  end                   
+  end
+  describe "Background template feature" do
+    before(:each) do
+      @filename = "#{Prawn::BASEDIR}/data/images/pigs.jpg"
+      @pdf = Prawn::Document.new(:background => @filename)
+    end
+    it "should place a background image if it is in options block" do
+      output = @pdf.render
+      images = PDF::Inspector::XObject.analyze(output)
+      # there should be 2 images in the page resources
+      images.page_xobjects.first.size.should == 1
+    end
+    it "should place a background image if it is in options block" do
+      @pdf.instance_variable_defined?(:@background).should == true
+      @pdf.instance_variable_get(:@background).should == @filename
+    end
+  end
 
 end
 
@@ -84,6 +110,17 @@ describe "When ending each page" do
     pdf.render
   end
 
+  it "should result in a smaller file size when compressed" do
+    doc_uncompressed = Prawn::Document.new
+    doc_compressed   = Prawn::Document.new(:compress => true)
+    [doc_compressed, doc_uncompressed].each do |pdf|
+       pdf.font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+       pdf.text "更可怕的是，同质化竞争对手可以按照URL中后面这个ID来遍历" * 10
+    end
+
+    doc_compressed.render.length.should.be < doc_uncompressed.render.length
+  end 
+
 end                                 
 
 describe "When setting page size" do

data/spec/font_spec.rb

@@ -70,6 +70,28 @@ describe "font style support" do
       
 end
 
+describe "Transactional font handling" do
+  before(:each) { create_pdf }
+  
+  it "should allow setting of size directly when font is created" do
+    @pdf.font "Courier", :size => 16
+    @pdf.font.size.should == 16 
+  end
+  
+  it "should allow temporary setting of a new font using a transaction" do
+    original = @pdf.font
+    
+    @pdf.font "Courier", :size => 16 do
+      @pdf.font.name.should == "Courier"
+      @pdf.font.size.should == 16
+    end
+    
+    @pdf.font.should == original  
+  end
+  
+end
+
+
 describe "Document#page_fonts" do
   before(:each) { create_pdf } 
   

data/spec/graphics_spec.rb

@@ -1,58 +1,70 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
-  
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
 describe "When drawing a line" do
-   
+
   before(:each) { create_pdf }
- 
+
   it "should draw a line from (100,600) to (100,500)" do
     @pdf.line([100,600],[100,500])
-    
+
     line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
-    
-    line_drawing.points.should == [[100,600],[100,500]]       
-  end  
-  
+
+    line_drawing.points.should == [[100,600],[100,500]]
+  end
+
   it "should draw two lines at (100,600) to (100,500) " +
-     "and (75,100) to (50,125)" do 
-    @pdf.line(100,600,100,500) 
+     "and (75,100) to (50,125)" do
+    @pdf.line(100,600,100,500)
     @pdf.line(75,100,50,125)
-    
+
     line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
-    
-    line_drawing.points.should == 
+
+    line_drawing.points.should ==
       [[100.0, 600.0], [100.0, 500.0], [75.0, 100.0], [50.0, 125.0]]
   end
 
   it "should properly set line width via line_width=" do
      @pdf.line_width = 10
-     line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) 
-     line.widths.first.should == 10 
-  end  
-  
+     line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+     line.widths.first.should == 10
+  end
+
   it "should properly set line width via line_width(width)" do
      @pdf.line_width(10)
-     line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) 
-     line.widths.first.should == 10 
-  end 
-  
-  describe "(Horizontally)" do  
-   
-    before :each do
-      @pdf = Prawn::Document.new
+     line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+     line.widths.first.should == 10
+  end
+
+  describe "(Horizontally)" do
+    it "should draw from [x1,pdf.y],[x2,pdf.y]" do
       @pdf.horizontal_line(100,150)
       @line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
-    end
-   
-    it "should draw from [x1,pdf.y],[x2,pdf.y]" do
       @line.points.should == [[100.0 + @pdf.bounds.absolute_left, @pdf.y],
                               [150.0 + @pdf.bounds.absolute_left, @pdf.y]]
-    end      
-    
+    end
+
+    it "should draw a line from (200, 250) to (300, 250)" do
+      @pdf.horizontal_line(200,300,:at => 250)
+      line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+      line_drawing.points.should == [[200,250],[300,250]]
+    end
+  end
+
+  describe "(Vertically)" do
+    it "should draw a line from (350, 300) to (350, 400)" do
+      @pdf.vertical_line(300,400,:at => 350)
+      line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+      line_drawing.points.should == [[350,300],[350,400]]
+    end
+    it "should require a y coordinate" do
+      lambda { @pdf.vertical_line(400,500) }.
+        should.raise(ArgumentError)
+    end
   end
-        
-end                            
+
+end
 
 describe "When drawing a polygon" do
 
@@ -61,11 +73,11 @@ describe "When drawing a polygon" do
   it "should draw each line passed to polygon()" do
     @pdf.polygon([100,500],[100,400],[200,400])
 
-    line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) 
+    line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
     line_drawing.points.should == [[100,500],[100,400],[200,400],[100,500]]
   end
 
-end                                
+end
 
 describe "When drawing a rectangle" do
 
@@ -83,53 +95,53 @@ describe "When drawing a rectangle" do
 
   end
 
-end  
+end
+
+describe "When drawing a curve" do
 
-describe "When drawing a curve" do  
-    
   before(:each) { create_pdf }
-  
+
   it "should draw a bezier curve from 50,50 to 100,100" do
     @pdf.move_to  [50,50]
     @pdf.curve_to [100,100],:bounds => [[20,90], [90,70]]
     curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
-    curve.coords.should == [50.0, 50.0, 20.0, 90.0, 90.0, 70.0, 100.0, 100.0] 
-  end                             
-  
+    curve.coords.should == [50.0, 50.0, 20.0, 90.0, 90.0, 70.0, 100.0, 100.0]
+  end
+
   it "should draw a bezier curve from 100,100 to 50,50" do
-    @pdf.curve [100,100], [50,50], :bounds => [[20,90], [90,75]] 
-    curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)  
-    curve.coords.should == [100.0, 100.0, 20.0, 90.0, 90.0, 75.0, 50.0, 50.0] 
+    @pdf.curve [100,100], [50,50], :bounds => [[20,90], [90,75]]
+    curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+    curve.coords.should == [100.0, 100.0, 20.0, 90.0, 90.0, 75.0, 50.0, 50.0]
   end
-  
-end 
+
+end
 
 describe "When drawing an ellipse" do
-  before(:each) do 
+  before(:each) do
     create_pdf
     @pdf.ellipse_at [100,100], 25, 50
-    @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)  
-  end       
-  
+    @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+  end
+
   it "should move the pointer to the center of the ellipse after drawing" do
     @curve.coords[-2..-1].should == [100,100]
-  end 
-  
-end    
+  end
+
+end
 
 describe "When drawing a circle" do
-  before(:each) do 
+  before(:each) do
     create_pdf
-    @pdf.circle_at [100,100], :radius => 25 
+    @pdf.circle_at [100,100], :radius => 25
     @pdf.ellipse_at [100,100], 25, 25
-    @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)        
-  end       
-  
-  it "should stroke the same path as the equivalent ellipse" do 
+    @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+  end
+
+  it "should stroke the same path as the equivalent ellipse" do
     middle = @curve.coords.length / 2
-    @curve.coords[0...middle].should == @curve.coords[middle..-1] 
+    @curve.coords[0...middle].should == @curve.coords[middle..-1]
   end
-end    
+end
 
 describe "When setting colors" do
 
@@ -144,54 +156,54 @@ describe "When setting colors" do
 
   it "should set fill colors" do
     @pdf.fill_color "ccff00"
-    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) 
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
     # 80% red, 100% green, 0% blue
     colors.fill_color.should == [0.8,1.0,0]
-  end   
-  
+  end
+
   it "should reset the colors on each new page if they have been defined" do
     @pdf.fill_color "ccff00"
-    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) 
-    
-    colors.fill_color_count.should == 2   
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+
+    colors.fill_color_count.should == 2
     colors.stroke_color_count.should == 1
-    @pdf.start_new_page                
-    @pdf.stroke_color "ff00cc"  
-    
-    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) 
-    colors.fill_color_count.should == 3  
+    @pdf.start_new_page
+    @pdf.stroke_color "ff00cc"
+
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+    colors.fill_color_count.should == 3
     colors.stroke_color_count.should == 3
-    
+
     @pdf.start_new_page
-    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) 
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
     colors.fill_color_count.should == 4
     colors.stroke_color_count.should == 4
-    
+
     colors.fill_color.should   == [0.8,1.0,0.0]
-    colors.stroke_color.should == [1.0,0.0,0.8] 
-  end    
+    colors.stroke_color.should == [1.0,0.0,0.8]
+  end
 
 end
 
 describe "When using painting shortcuts" do
   before(:each) { create_pdf }
- 
+
   it "should convert stroke_some_method(args) into some_method(args); stroke" do
     @pdf.expects(:line_to).with([100,100])
     @pdf.expects(:stroke)
-    
+
     @pdf.stroke_line_to [100,100]
-  end  
-  
+  end
+
   it "should convert fill_some_method(args) into some_method(args); fill" do
-    @pdf.expects(:line_to).with([100,100]) 
+    @pdf.expects(:line_to).with([100,100])
     @pdf.expects(:fill)
-    
+
     @pdf.fill_line_to [100,100]
   end
-  
+
   it "should not break method_missing" do
     lambda { @pdf.i_have_a_pretty_girlfriend_named_jia }.
-      should.raise(NoMethodError) 
+      should.raise(NoMethodError)
   end
-end
+end