prawn 1.0.0.rc2 → 1.0.0

data/spec/bounding_box_spec.rb

@@ -109,15 +109,20 @@ describe "drawing bounding boxes" do
     x.should == [100, 500]
   end
 
-  it "should restore the margin box when bounding box exits" do
-    margin_box = @pdf.bounds
+  it "should restore Document#bounds to the correct margin box on exit" do
+    pdf = Prawn::Document.new(:margin => 200)
 
-    @pdf.bounding_box [100,500], :width => 100 do
-      #nothing
+    # add a multi-page bounding box
+    pdf.bounding_box([100, pdf.bounds.top], :width => 400) do
+      pdf.text "The rain in spain falls mainly in the plains.\n" * 30
     end
 
-    @pdf.bounds.should == margin_box
+    pdf.start_new_page(:margin => 0)
 
+    x_min, y_min, x_max, y_max = pdf.page.dimensions
+
+    pdf.bounds.absolute_top_left.should == [x_min, y_max]
+    pdf.bounds.absolute_bottom_right.should == [x_max, y_min]
   end
 
   it "should restore the parent bounding box when calls are nested" do
@@ -378,6 +383,18 @@ describe "A canvas" do
     end
     @pdf.y.should == 450
   end
+
+  it "should restore the original ypos after execution", :issue => 523 do
+    doc = Prawn::Document.new(:skip_page_creation => true)
+    doc.start_new_page
+
+    original_ypos = doc.y
+
+    doc.canvas {}
+
+    doc.y.should == original_ypos
+  end
+
 end
 
 describe "Deep-copying" do

data/spec/cell_spec.rb

@@ -87,6 +87,12 @@ describe "Prawn::Table::Cell" do
 
       c.style(:padding => 50, :size => 7)
     end
+
+    it "ignores unknown properties" do
+      c = cell(:content => 'text')
+
+      c.style(:foobarbaz => 'frobnitz')
+    end
   end
 
   describe "cell width" do
@@ -136,9 +142,6 @@ describe "Prawn::Table::Cell" do
       c = cell(:content => "text", :padding => 10)
       min_content_width = c.min_width - c.padding[1] - c.padding[3]
 
-      lambda { @pdf.height_of("text", :width => min_content_width) }.
-        should_not raise_error(Prawn::Errors::CannotFit)
-
       @pdf.height_of("text", :width => min_content_width).should be <
         (5 * @pdf.height_of("text"))
     end
@@ -409,7 +412,7 @@ describe "Prawn::Table::Cell" do
         :border_width => [2, 3, 4, 5])
       c.border_widths.should == [2, 3, 4, 5]
     end
-    
+
     it "should set default border lines to :solid" do
       c = @pdf.cell(:content => "text")
       c.border_top_line.should == :solid
@@ -418,7 +421,7 @@ describe "Prawn::Table::Cell" do
       c.border_left_line.should == :solid
       c.border_lines.should == [:solid] * 4
     end
-    
+
     it "should set border line with :border_..._line" do
       c = @pdf.cell(:content => "text", :border_bottom_line => :dotted)
       c.border_bottom_line.should == :dotted
@@ -466,6 +469,47 @@ describe "Prawn::Table::Cell" do
       c.draw
     end
 
+    it "supports variant styles of the current font" do
+      font_path = "#{Prawn::BASEDIR}/data/fonts/Panic+Sans.dfont"
+      @pdf.font_families.merge!("Panic Sans" => {
+        :normal    => { :file => font_path, :font => "PanicSans" },
+        :bold      => { :file => font_path, :font => "PanicSans-Bold" },
+      })
+      @pdf.font "Panic Sans"
+
+      c = cell(:content => "text", :font_style => :bold)
+
+      box = Prawn::Text::Box.new("text", :document => @pdf)
+      Prawn::Text::Box.expects(:new).checking do |text, options|
+        text.should == "text"
+        options[:style].should == :bold
+        @pdf.font.family.should == 'Panic Sans'
+      end.at_least_once.returns(box)
+
+      c.draw
+    end
+
+
+    it "uses the style of the current font if none given" do
+      font_path = "#{Prawn::BASEDIR}/data/fonts/Panic+Sans.dfont"
+      @pdf.font_families.merge!("Panic Sans" => {
+        :normal    => { :file => font_path, :font => "PanicSans" },
+        :bold      => { :file => font_path, :font => "PanicSans-Bold" },
+      })
+      @pdf.font "Panic Sans", :style => :bold
+
+      c = cell(:content => "text")
+
+      box = Prawn::Text::Box.new("text", :document => @pdf)
+      Prawn::Text::Box.expects(:new).checking do |text, options|
+        text.should == "text"
+        @pdf.font.family.should == 'Panic Sans'
+        @pdf.font.options[:style].should == :bold
+      end.at_least_once.returns(box)
+
+      c.draw
+    end
+
     it "should allow inline formatting in cells" do
       c = cell(:content => "foo <b>bar</b> baz", :inline_format => true)
 

data/spec/column_box_spec.rb

@@ -30,4 +30,36 @@ describe "A column box" do
         @pdf.bounds.right.should == 500
       end
   end
+
+  it "does not reset the top margin on a new page by default" do
+    create_pdf
+    page_top = @pdf.cursor
+    @pdf.move_down 50
+    init_column_top = @pdf.cursor
+    @pdf.column_box [0, @pdf.cursor], :width => 500,
+      :height => 200, :columns => 2 do
+
+        @pdf.bounds.move_past_bottom
+        @pdf.bounds.move_past_bottom
+
+        @pdf.bounds.absolute_top.should == init_column_top
+        @pdf.bounds.absolute_top.should_not == page_top
+      end
+  end
+
+  it "does reset the top margin when reflow_margins is set" do
+    create_pdf
+    page_top = @pdf.cursor
+    @pdf.move_down 50
+    init_column_top = @pdf.cursor
+    @pdf.column_box [0, @pdf.cursor], :width => 500, :reflow_margins => true,
+      :height => 200, :columns => 2 do
+
+        @pdf.bounds.move_past_bottom
+        @pdf.bounds.move_past_bottom
+
+        @pdf.bounds.absolute_top.should == page_top 
+        @pdf.bounds.absolute_top.should_not == init_column_top
+      end
+  end
 end

data/spec/destinations_spec.rb

@@ -1,12 +1,12 @@
 # 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 creating destinations" do
 
-describe "When creating destinations" do 
- 
   before(:each) { create_pdf }
-  
-  it "should add entry to Dests name tree" do 
+
+  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

data/spec/document_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "tempfile"
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
 describe "Prawn::Document.new" do
   it "should not modify its argument" do
@@ -15,9 +15,9 @@ describe "The cursor" do
   it "should == 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 
+    pdf.cursor.should == pdf.y - pdf.bounds.absolute_bottom
   end
 
   it "should be able to move relative to the bottom margin" do
@@ -27,12 +27,38 @@ describe "The cursor" do
     pdf.cursor.should == 10
     pdf.y.should == pdf.cursor + pdf.bounds.absolute_bottom
   end
-end 
+end
+
+describe "when generating a document with a custom text formatter" do
+  it "should use the provided text formatter" do
+    class TestTextFormatter
+      def self.format(string)
+        [
+          {
+            text: string.gsub("Dr. Who?", "Just 'The Doctor'."),
+            styles: [],
+            color: nil,
+            link: nil,
+            anchor: nil,
+            local: nil,
+            font: nil,
+            size: nil,
+            character_spacing: nil
+          }
+        ]
+      end
+    end
+    pdf = Prawn::Document.new text_formatter: TestTextFormatter
+    pdf.text "Dr. Who?", inline_format: true
+    text = PDF::Inspector::Text.analyze(pdf.render)
+    text.strings.first.should == "Just 'The Doctor'."
+  end
+end
 
 describe "when generating a document from a subclass" do
   it "should be an instance of the subclass" do
     custom_document = Class.new(Prawn::Document)
-    custom_document.generate(Tempfile.new("generate_test").path) do |e| 
+    custom_document.generate(Tempfile.new("generate_test").path) do |e|
       e.class.should == custom_document
       e.should be_a_kind_of(Prawn::Document)
     end
@@ -63,27 +89,27 @@ describe "when generating a document from a subclass" do
 
 end
 
-                               
-describe "When creating multi-page documents" do 
- 
+
+describe "When creating multi-page documents" do
+
   before(:each) { create_pdf }
-  
-  it "should initialize with a single page" do 
+
+  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  
+
+    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 }           
+    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   
+  end
+
+end
 
 describe "When beginning each new page" do
 
@@ -102,11 +128,11 @@ describe "When beginning each new page" do
       @pdf.instance_variable_defined?(:@background).should == true
       @pdf.instance_variable_get(:@background).should == @filename
     end
-    
-    
+
+
   end
-  
-  
+
+
 end
 
 describe "Prawn::Document#float" do
@@ -119,7 +145,7 @@ describe "Prawn::Document#float" do
 
   it "should teleport across pages if necessary" do
     create_pdf
-    
+
     @pdf.float do
       @pdf.text "Foo"
       @pdf.start_new_page
@@ -156,7 +182,7 @@ end
 
 describe "on_page_create callback" do
   before do
-    create_pdf 
+    create_pdf
   end
 
   it "should be invoked with document" do
@@ -177,34 +203,34 @@ describe "on_page_create callback" do
 
     5.times { @pdf.start_new_page }
   end
-  
+
   it "should be replaceable" do
       trigger1 = mock()
       trigger1.expects(:fire).times(1)
-      
+
       trigger2 = mock()
       trigger2.expects(:fire).times(1)
 
       @pdf.on_page_create { trigger1.fire }
-      
+
       @pdf.start_new_page
-      
+
       @pdf.on_page_create { trigger2.fire }
-      
+
       @pdf.start_new_page
   end
-  
+
   it "should be clearable by calling on_page_create without a block" do
       trigger = mock()
       trigger.expects(:fire).times(1)
 
       @pdf.on_page_create { trigger.fire }
 
-      @pdf.start_new_page 
-      
+      @pdf.start_new_page
+
       @pdf.on_page_create
-      
-      @pdf.start_new_page 
+
+      @pdf.start_new_page
   end
 
 end
@@ -214,8 +240,8 @@ describe "Document compression" do
   it "should not compress the page content stream if compression is disabled" do
 
     pdf = Prawn::Document.new(:compress => false)
-    pdf.page.content.stubs(:compress_stream).returns(true)
-    pdf.page.content.expects(:compress_stream).never
+    pdf.page.content.stream.stubs(:compress!).returns(true)
+    pdf.page.content.stream.expects(:compress!).never
 
     pdf.text "Hi There" * 20
     pdf.render
@@ -224,8 +250,8 @@ describe "Document compression" do
   it "should compress the page content stream if compression is enabled" do
 
     pdf = Prawn::Document.new(:compress => true)
-    pdf.page.content.stubs(:compress_stream).returns(true)
-    pdf.page.content.expects(:compress_stream).once
+    pdf.page.content.stream.stubs(:compress!).returns(true)
+    pdf.page.content.stream.expects(:compress!).once
 
     pdf.text "Hi There" * 20
     pdf.render
@@ -240,9 +266,9 @@ describe "Document compression" do
     end
 
     doc_compressed.render.length.should be < doc_uncompressed.render.length
-  end 
+  end
 
-end                                 
+end
 
 describe "Document metadata" do
   it "should output strings as UTF-16 with a byte order mark" do
@@ -262,11 +288,10 @@ describe "When reopening pages" do
       pdf.go_to_page 1
       pdf.text "More for page 1"
     end
-    
-    # MalformedPDFError raised if content stream actual length does not match
-    # dictionary length
-    lambda{ PDF::Inspector::Page.analyze(@pdf.render) }.
-      should_not raise_error(PDF::Reader::MalformedPDFError)
+
+    # Indirectly verify that the actual length does not match dictionary length.
+    # If it isn't, a MalformedPDFError will be raised
+    PDF::Inspector::Page.analyze(@pdf.render)
   end
 
   it "should insert pages after the current page when calling start_new_page" do
@@ -298,21 +323,21 @@ 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|
+    pages.first[:size].should == PDF::Core::PageGeometry::SIZES["LETTER"]
+  end
+
+  (PDF::Core::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]
+      pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+      pages.first[:size].should == PDF::Core::PageGeometry::SIZES[k]
     end
   end
-  
-  it "should allow custom page size" do 
+
+  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]   
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.first[:size].should == [1920, 1080]
   end
 
 
@@ -321,25 +346,25 @@ describe "When setting page size" do
     @pdf.start_new_page
     pages = PDF::Inspector::Page.analyze(@pdf.render).pages
     pages.each do |page|
-      page[:size].should == Prawn::Document::PageGeometry::SIZES["LEGAL"]
+      page[:size].should == PDF::Core::PageGeometry::SIZES["LEGAL"]
     end
   end
 
-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   
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.first[:size].should == PDF::Core::PageGeometry::SIZES["A4"].reverse
+  end
 
   it "should retain page layout by default when starting a new page" do
     @pdf = Prawn::Document.new(:page_layout => :landscape)
     @pdf.start_new_page(:trace => true)
     pages = PDF::Inspector::Page.analyze(@pdf.render).pages
     pages.each do |page|
-      page[:size].should == Prawn::Document::PageGeometry::SIZES["LETTER"].reverse
+      page[:size].should == PDF::Core::PageGeometry::SIZES["LETTER"].reverse
     end
   end
 
@@ -362,19 +387,19 @@ describe "The mask() feature" do
       @pdf.line_width.should_not == line_width
     end
     @pdf.y.should == y
-    @pdf.line_width.should == line_width 
+    @pdf.line_width.should == line_width
   end
 end
 
 describe "The group() feature" do
-  it "should return a true value if the content fits on one page" do
+  xit "should return a true value if the content fits on one page" do
     pdf = Prawn::Document.new do
       val = group { text "Hello"; text "World" }
       (!!val).should == true
     end
   end
 
-  it "should group a simple block on a single page" do
+  xit "should group a simple block on a single page" do
     pdf = Prawn::Document.new do
       self.y = 50
       val = group do
@@ -391,7 +416,7 @@ describe "The group() feature" do
     pages[1][:strings].should == ["Hello", "World"]
   end
 
-  it "should raise_error CannotGroup if the content is too tall" do
+  xit "should raise_error CannotGroup if the content is too tall" do
     lambda {
       Prawn::Document.new do
         group do
@@ -401,7 +426,7 @@ describe "The group() feature" do
     }.should raise_error(Prawn::Errors::CannotGroup)
   end
 
-   it "should group within individual column boxes" do
+   xit "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
@@ -422,25 +447,23 @@ describe "The group() feature" do
 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
+  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
 
   it "should trigger before_render callbacks just before rendering" do
     pdf = Prawn::Document.new
-    
+
     seq = sequence("callback_order")
 
     # Verify the order: finalize -> fire callbacks -> render body
     pdf.expects(:finalize_all_page_contents).in_sequence(seq)
     trigger = mock()
     trigger.expects(:fire).in_sequence(seq)
-    
+
     # Store away the render_body method to be called below
     render_body = pdf.method(:render_body)
     pdf.expects(:render_body).in_sequence(seq)
@@ -461,35 +484,6 @@ describe "The render() feature" do
   end
 end
 
-describe "The :optimize_objects option" do
-  before(:all) do
-    @wasteful_doc = lambda do |pdf|
-      pdf.transaction do 
-        pdf.start_new_page
-        pdf.text "Hidden text"
-        pdf.rollback 
-      end
-
-      pdf.text "Hello world"
-    end
-  end
-
-  it "should result in fewer objects when enabled" do
-    wasteful_pdf = Prawn::Document.new(&@wasteful_doc)
-    frugal_pdf   = Prawn::Document.new(:optimize_objects => true,
-                                       &@wasteful_doc)
-    frugal_pdf.render.size.should be < wasteful_pdf.render.size
-  end
-
-  it "should default to :false" do
-    default_pdf  = Prawn::Document.new(&@wasteful_doc)
-    wasteful_pdf = Prawn::Document.new(:optimize_objects => false, 
-                                       &@wasteful_doc)
-    default_pdf.render.size.should == wasteful_pdf.render.size
-  end
-
-end
-
 describe "PDF file versions" do
   it "should default to 1.3" do
     @pdf = Prawn::Document.new
@@ -565,25 +559,25 @@ describe "The number_pages method" do
   before do
     @pdf = Prawn::Document.new(:skip_page_creation => true)
   end
-  
+
   it "replaces the '<page>' string with the proper page number" do
     @pdf.start_new_page
     @pdf.expects(:text_box).with("1, test", { :height => 50 })
     @pdf.number_pages "<page>, test", {:page_filter => :all}
   end
-  
+
   it "replaces the '<total>' string with the total page count" do
     @pdf.start_new_page
     @pdf.expects(:text_box).with("test, 1", { :height => 50 })
     @pdf.number_pages "test, <total>", {:page_filter => :all}
   end
- 
+
   it "must print each page if given the :all page_filter" do
     10.times { @pdf.start_new_page }
     @pdf.expects(:text_box).times(10)
     @pdf.number_pages "test", {:page_filter => :all}
   end
-  
+
   it "must print each page if no :page_filter is specified" do
     10.times { @pdf.start_new_page }
     @pdf.expects(:text_box).times(10)
@@ -595,8 +589,8 @@ describe "The number_pages method" do
     @pdf.expects(:text_box).never
     @pdf.number_pages "test", {:page_filter => nil}
   end
-  
-  context "start_count_at option" do    
+
+  context "start_count_at option" do
     [1, 2].each do |startat|
       context "equal to #{startat}" do
         it "increments the pages" do
@@ -605,10 +599,10 @@ describe "The number_pages method" do
           @pdf.expects(:text_box).with("#{startat} 2", { :height => 50 })
           @pdf.expects(:text_box).with("#{startat+1} 2", { :height => 50 })
           @pdf.number_pages "<page> <total>", options
-        end  
+        end
       end
     end
-      
+
     [0, nil].each do |val|
       context "equal to #{val}" do
         it "defaults to start at page 1" do
@@ -622,7 +616,7 @@ describe "The number_pages method" do
       end
     end
   end
-  
+
   context "total_pages option" do
     it "allows the total pages count to be overridden" do
       2.times { @pdf.start_new_page }
@@ -631,7 +625,7 @@ describe "The number_pages method" do
       @pdf.number_pages "<page> <total>", :page_filter => :all, :total_pages => 10
     end
   end
-  
+
   context "special page filter" do
     context "such as :odd" do
       it "increments the pages" do
@@ -704,11 +698,11 @@ describe "The page_match? method" do
     @pdf = Prawn::Document.new(:skip_page_creation => true)
     10.times {@pdf.start_new_page}
   end
-  
+
   it "returns nil given no filter" do
     @pdf.page_match?(:nil, 1).should be_false
   end
-  
+
   it "must provide an :all filter" do
     (1..@pdf.page_count).all? { |i| @pdf.page_match?(:all, i) }.should be_true
   end
@@ -732,5 +726,5 @@ describe "The page_match? method" do
   it "must be able to filter by an arbitrary proc" do
     fltr = lambda { |x| x == 1 or x % 3 == 0 }
     (1..10).select { |i| @pdf.page_match?(fltr, i) }.should == [1,3,6,9]
-  end    
+  end
 end