prawn-layout 0.2.1 → 0.3.1

data/vendor/prawn-core/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/vendor/prawn-core/spec/bounding_box_spec.rb

@@ -0,0 +1,185 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "A bounding box" do
+
+  before(:each) do
+    @x      = 100
+    @y      = 125
+    @width  = 50
+    @height = 75
+    @box = Prawn::Document::BoundingBox.new(nil, [@x,@y], :width  => @width,
+                                                          :height => @height )
+  end
+
+  it "should have an anchor at (x, y - height)" do
+    @box.anchor.should == [@x,@y-@height]           
+  end
+
+  it "should have a left boundary of 0" do
+    @box.left.should == 0
+  end
+  
+  it "should have a right boundary equal to the width" do
+    @box.right.should == @width
+  end
+  
+  it "should have a top boundary of height" do
+    @box.top.should == @height
+  end
+  
+  it "should have a bottom boundary of 0" do
+    @box.bottom.should == 0
+  end
+
+  it "should have a top-left of [0,height]" do
+    @box.top_left.should == [0,@height]
+  end
+
+  it "should have a top-right of [width,height]" do
+    @box.top_right.should == [@width,@height]
+  end
+
+  it "should have a bottom-left of [0,0]" do
+    @box.bottom_left.should == [0,0]
+  end
+
+  it "should have a bottom-right of [width,0]" do
+    @box.bottom_right.should == [@width,0]
+  end
+
+  it "should have an absolute left boundary of x" do
+    @box.absolute_left.should == @x
+  end
+  
+  it "should have an absolute right boundary of x + width" do
+    @box.absolute_right.should == @x + @width
+  end
+  
+  it "should have an absolute top boundary of y" do
+    @box.absolute_top.should == @y
+  end
+  
+  it "should have an absolute bottom boundary of y - height" do
+    @box.absolute_bottom.should == @y - @height
+  end
+
+  it "should have an absolute bottom-left of [x,y-height]" do
+    @box.absolute_bottom_left.should == [@x, @y - @height]
+  end
+
+  it "should have an absolute bottom-right of [x+width,y-height]" do
+    @box.absolute_bottom_right.should == [@x + @width , @y - @height]
+  end
+
+  it "should have an absolute top-left of [x,y]" do
+    @box.absolute_top_left.should == [@x, @y]
+  end
+
+  it "should have an absolute top-right of [x+width,y]" do
+    @box.absolute_top_right.should == [@x + @width, @y]
+  end
+  
+
+end
+
+describe "drawing bounding boxes" do    
+  
+  before(:each) { create_pdf }   
+
+  it "should restore the margin box when bounding box exits" do
+    margin_box = @pdf.bounds
+
+    @pdf.bounding_box [100,500] do
+      #nothing
+    end
+
+    @pdf.bounds.should == margin_box
+
+  end
+
+  it "should restore the parent bounding box when calls are nested" do
+    @pdf.bounding_box [100,500], :width => 300, :height => 300 do 
+
+      @pdf.bounds.absolute_top.should  == 500 + @pdf.margin_box.absolute_bottom
+      @pdf.bounds.absolute_left.should == 100 + @pdf.margin_box.absolute_left
+
+      parent_box = @pdf.bounds
+
+      @pdf.bounding_box [50,200], :width => 100, :height => 100 do
+        @pdf.bounds.absolute_top.should == 200 + parent_box.absolute_bottom
+        @pdf.bounds.absolute_left.should == 50 + parent_box.absolute_left
+      end
+
+      @pdf.bounds.absolute_top.should  == 500 + @pdf.margin_box.absolute_bottom
+      @pdf.bounds.absolute_left.should == 100 + @pdf.margin_box.absolute_left
+
+    end
+  end   
+  
+  it "should calculate a height if none is specified" do 
+    @pdf.bounding_box([100, 500], :width => 100) do
+      @pdf.text "The rain in Spain falls mainly on the plains." 
+    end     
+    
+    @pdf.y.should.be.close 458.384, 0.001 
+  end
+
+  it "should keep track of the max height the box was stretched to" do
+    box = @pdf.bounding_box(@pdf.bounds.top_left, :width => 100) do
+      @pdf.move_down 100
+      @pdf.move_up 15
+    end
+
+    assert_equal 100, box.height
+  end
+  
+end
+
+describe "Indentation" do
+  before(:each) { create_pdf }
+
+  it "should temporarily shift the x coordinate and width" do
+    @pdf.bounding_box([100,100], :width => 200) do
+      @pdf.indent(20) do
+        @pdf.bounds.absolute_left.should == 120
+        @pdf.bounds.width.should == 180
+      end
+    end
+  end
+
+  it "should restore the x coordinate and width after block exits" do
+    @pdf.bounding_box([100,100], :width => 200) do
+      @pdf.indent(20) do
+        # no-op
+      end
+      @pdf.bounds.absolute_left.should == 100
+      @pdf.bounds.width.should == 200
+    end
+  end
+
+  it "should restore the x coordinate and width on error" do
+    @pdf.bounding_box([100,100], :width => 200) do
+      begin
+        @pdf.indent(20) { raise }
+      rescue
+        @pdf.bounds.absolute_left.should == 100
+        @pdf.bounds.width.should == 200
+      end
+    end
+  end
+
+end
+
+describe "A canvas" do
+  before(:each) { create_pdf }
+  
+  it "should use whatever the last set y position is" do
+    @pdf.canvas do
+      @pdf.bounding_box([100,500],:width => 200) { @pdf.move_down 50 }
+    end
+    @pdf.y.should == 450
+  end
+end      
+  

data/vendor/prawn-core/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/vendor/prawn-core/spec/document_spec.rb

@@ -0,0 +1,231 @@
+# encoding: utf-8
+require "tempfile"
+
+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
+
+  it "should be able to move relative to the bottom margin" do
+    pdf = Prawn::Document.new
+    pdf.move_cursor_to(10)
+
+    pdf.cursor.should == 10
+    pdf.y.should == pdf.cursor + pdf.bounds.absolute_bottom
+  end
+end 
+
+describe "when generating a document from a subclass" do
+  it "should be an instance_eval of the subclass" do
+    custom_document = Class.new(Prawn::Document)
+    custom_document.generate(Tempfile.new("generate_test").path) do |e| 
+      e.class.should == custom_document
+      e.should.be.kind_of(Prawn::Document)
+    end
+  end
+end
+
+                               
+describe "When creating multi-page documents" do 
+ 
+  before(:each) { create_pdf }
+  
+  it "should initialize with a single page" do 
+    page_counter = PDF::Inspector::Page.analyze(@pdf.render)
+    
+    page_counter.pages.size.should == 1            
+    @pdf.page_count.should == 1  
+  end
+  
+  it "should provide an accurate page_count" do
+    3.times { @pdf.start_new_page }           
+    page_counter = PDF::Inspector::Page.analyze(@pdf.render)
+    
+    page_counter.pages.size.should == 4
+    @pdf.page_count.should == 4
+  end                 
+  
+end   
+
+describe "When beginning each new page" do
+
+  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
+
+describe "When ending each page" do
+
+  it "should not compress the page content stream if compression is disabled" do
+
+    pdf = Prawn::Document.new(:compress => false)
+    content_stub = pdf.ref!({})
+    content_stub.stubs(:compress_stream).returns(true)
+    content_stub.expects(:compress_stream).never
+
+    pdf.instance_variable_set("@page_content", content_stub.identifier)
+    pdf.text "Hi There" * 20
+    pdf.render
+  end
+
+  it "should compress the page content stream if compression is enabled" do
+
+    pdf = Prawn::Document.new(:compress => true)
+    content_stub = pdf.ref!({})
+    content_stub.stubs(:compress_stream).returns(true)
+    content_stub.expects(:compress_stream).once
+
+    pdf.instance_variable_set("@page_content", content_stub.identifier)
+    pdf.text "Hi There" * 20
+    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
+  it "should default to LETTER" do
+    @pdf = Prawn::Document.new
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.first[:size].should == Prawn::Document::PageGeometry::SIZES["LETTER"]    
+  end                                                                  
+  
+  (Prawn::Document::PageGeometry::SIZES.keys - ["LETTER"]).each do |k|
+    it "should provide #{k} geometry" do
+      @pdf = Prawn::Document.new(:page_size => k)
+      pages = PDF::Inspector::Page.analyze(@pdf.render).pages   
+      pages.first[:size].should == Prawn::Document::PageGeometry::SIZES[k]
+    end
+  end
+  
+  it "should allow custom page size" do 
+    @pdf = Prawn::Document.new(:page_size => [1920, 1080] )
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages   
+    pages.first[:size].should == [1920, 1080]   
+  end
+
+end       
+
+describe "When setting page layout" do
+  it "should reverse coordinates for landscape" do
+    @pdf = Prawn::Document.new(:page_size => "A4", :page_layout => :landscape)
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages    
+    pages.first[:size].should == Prawn::Document::PageGeometry::SIZES["A4"].reverse
+  end   
+end
+
+describe "The mask() feature" do
+  it "should allow transactional restoration of attributes" do
+    @pdf = Prawn::Document.new
+    y, line_width = @pdf.y, @pdf.line_width
+    @pdf.mask(:y, :line_width) do
+      @pdf.y = y + 1
+      @pdf.line_width = line_width + 1
+      @pdf.y.should.not == y
+      @pdf.line_width.should.not == line_width
+    end
+    @pdf.y.should == y
+    @pdf.line_width.should == line_width 
+  end
+end
+
+describe "The group() feature" do
+  it "should group a simple block on a single page" do
+    pdf = Prawn::Document.new do
+      self.y = 50
+      group do
+        text "Hello"
+        text "World"
+      end
+    end
+    
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 2
+    pages[0][:strings].should == []
+    pages[1][:strings].should == ["Hello", "World"]
+  end
+
+  it "should raise CannotGroup if the content is too tall" do
+    lambda {
+      Prawn::Document.new do
+        group do
+          100.times { text "Too long" }
+        end
+      end.render
+    }.should.raise(Prawn::Document::CannotGroup)
+  end
+
+  it "should group within individual column boxes" do
+    pdf = Prawn::Document.new do
+      # Set up columns with grouped blocks of 0..49. 0 to 49 is slightly short
+      # of the height of one page / column, so each column should get its own
+      # group (every column should start with zero).
+      column_box([0, bounds.top], :width => bounds.width, :columns => 7) do
+        10.times do
+          group { 50.times { |i| text(i.to_s) } }
+        end
+      end
+    end
+
+    # Second page should start with a 0 because it's a new group.
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 2
+    pages[1][:strings].first.should == '0'
+  end
+end
+
+describe "The render() feature" do
+  if "spec".respond_to?(:encode!)
+    it "should return a 8 bit encoded string on a m17n aware VM" do
+      @pdf = Prawn::Document.new(:page_size => "A4", :page_layout => :landscape)
+      @pdf.line [100,100], [200,200]
+      str = @pdf.render
+      str.encoding.to_s.should == "ASCII-8BIT"
+    end
+  end
+end
+
+describe "PDF file versions" do
+  it "should default to 1.3" do
+    @pdf = Prawn::Document.new
+    str = @pdf.render
+    str[0,8].should == "%PDF-1.3"
+  end
+
+  it "should allow the default to be changed" do
+    @pdf = Prawn::Document.new
+    @pdf.__send__(:min_version, 1.4)
+    str = @pdf.render
+    str[0,8].should == "%PDF-1.4"
+  end
+end