prawn 0.4.1 → 0.5.0.1

data/lib/prawn/pdf_object.rb

@@ -1,73 +0,0 @@
-# encoding: utf-8
-#
-# pdf_object.rb : Handles Ruby to PDF object serialization
-#
-# Copyright April 2008, Gregory Brown.  All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-
-# Top level Module
-#
-module Prawn 
-                                             
-  module_function
-    
-  # Serializes Ruby objects to their PDF equivalents.  Most primitive objects
-  # will work as expected, but please note that Name objects are represented 
-  # by Ruby Symbol objects and Dictionary objects are represented by Ruby hashes
-  # (keyed by symbols)   
-  #
-  #  Examples:
-  #
-  #     PdfObject(true)      #=> "true"
-  #     PdfObject(false)     #=> "false" 
-  #     PdfObject(1.2124)    #=> "1.2124"
-  #     PdfObject("foo bar") #=> "(foo bar)"  
-  #     PdfObject(:Symbol)   #=> "/Symbol"
-  #     PdfObject(["foo",:bar, [1,2]]) #=> "[foo /bar [1 2]]"
-  # 
-  def PdfObject(obj, in_content_stream = false)
-    case(obj)        
-    when NilClass   then "null" 
-    when TrueClass  then "true"
-    when FalseClass then "false"
-    when Numeric    then String(obj)
-    when Array
-      "[" << obj.map { |e| PdfObject(e, in_content_stream) }.join(' ') << "]"
-    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                                                         
-       if (obj = obj.to_s) =~ /\s/
-         raise Prawn::Errors::FailedObjectConversion, 
-           "A PDF Name cannot contain whitespace"  
-       else
-         "/" << obj   
-       end 
-    when Hash           
-      output = "<< "
-      obj.each do |k,v|                                                        
-        unless String === k || Symbol === k
-          raise Prawn::Errors::FailedObjectConversion, 
-            "A PDF Dictionary must be keyed by names"
-        end                          
-        output << PdfObject(k.to_sym, in_content_stream) << " " << 
-                  PdfObject(v, in_content_stream) << "\n"
-      end   
-      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"
-    end     
-  end   
-  
-end

data/lib/prawn/reference.rb

@@ -1,59 +0,0 @@
-# encoding: utf-8
-
-# reference.rb : Implementation of PDF indirect objects
-#
-# Copyright April 2008, Gregory Brown.  All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-
-require 'zlib'
-
-module Prawn  
-  
-  class Reference #:nodoc:
-             
-   attr_accessor :gen, :data, :offset
-   attr_reader :identifier, :stream
-    
-    def initialize(id, data, &block)
-      @identifier = id 
-      @gen   = 0       
-      @data  = data     
-      @compressed = false
-      @on_encode = block
-    end            
-    
-    def object 
-      @on_encode.call(self) if @on_encode
-      output = "#{@identifier} #{gen} obj\n" <<
-               Prawn::PdfObject(data) << "\n"
-      if @stream
-        output << "stream\n" << @stream << "\nendstream\n" 
-      end
-      output << "endobj\n"
-    end  
-    
-    def <<(data)
-      raise 'Cannot add data to a stream that is compressed' if @compressed
-      (@stream ||= "") << data  
-    end  
-    
-    def to_s            
-      "#{@identifier} #{gen} R"
-    end
-
-    def compress_stream
-      @stream = Zlib::Deflate.deflate(@stream)
-      @data[:Filter] = :FlateDecode
-      @data[:Length] ||= @stream.length
-      @compressed = true
-    end
-  end         
-
-  module_function
-  
-  def Reference(*args, &block) #:nodoc:
-    Reference.new(*args, &block)
-  end     
-
-end

data/spec/annotations_spec.rb

@@ -1,90 +0,0 @@
-# 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/bounding_box_spec.rb

@@ -1,141 +0,0 @@
-# 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
-  
-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/spec/destinations_spec.rb

@@ -1,15 +0,0 @@
-# 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,193 +0,0 @@
-# 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
-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
-      assert e.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
-
-  it "should execute codeblock given to Document#header" do
-    call_count = 0    
-   
-    pdf = Prawn::Document.new      
-    pdf.header(pdf.margin_box.top_left) do 
-      call_count += 1   
-    end
-    
-    pdf.start_new_page 
-    pdf.start_new_page 
-    pdf.render
-    
-    call_count.should == 3
-  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
-
-describe "When ending each page" do
-
-  it "should execute codeblock given to Document#footer" do
-   
-    call_count = 0    
-   
-    pdf = Prawn::Document.new      
-    pdf.footer([pdf.margin_box.left, pdf.margin_box.bottom + 50]) do 
-      call_count += 1   
-    end
-    
-    pdf.start_new_page 
-    pdf.start_new_page 
-    pdf.render
-    
-    call_count.should == 3
-  end
-
-  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)
-    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)
-    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 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