nurettin-prawn 1.0.0.rc1

data/spec/table_spec.rb

@@ -0,0 +1,1209 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+require 'set'
+
+describe "Prawn::Table" do
+
+  describe "converting data to Cell objects" do
+    before(:each) do
+      @pdf = Prawn::Document.new
+      @table = @pdf.table([%w[R0C0 R0C1], %w[R1C0 R1C1]])
+    end
+
+    it "should return a Prawn::Table" do
+      @table.should be_a_kind_of Prawn::Table
+    end
+
+    it "should flatten the data into the @cells array in row-major order" do
+      @table.cells.map { |c| c.content }.should == %w[R0C0 R0C1 R1C0 R1C1]
+    end
+
+    it "should add row and column numbers to each cell" do
+      c = @table.cells.to_a.first
+      c.row.should == 0
+      c.column.should == 0
+    end
+
+    it "should allow empty fields" do
+      lambda {
+        data = [["foo","bar"],["baz",""]]
+        @pdf.table(data)
+      }.should_not raise_error
+    end
+
+    it "should allow a table with a header but no body" do
+      lambda { @pdf.table([["Header"]], :header => true) }.should_not raise_error
+    end
+
+    it "should accurately count columns from data" do
+      # First data row may contain colspan which would hide true column count
+      data = [["Name:", {:content => "Some very long name", :colspan => 5}]]
+      pdf = Prawn::Document.new
+      table = Prawn::Table.new data, pdf
+      table.column_widths.length.should == 6
+    end
+  end
+
+  describe "#initialize" do
+    before(:each) do
+      @pdf = Prawn::Document.new
+    end
+
+    it "should instance_eval a 0-arg block" do
+      initializer = mock()
+      initializer.expects(:kick).once
+
+      @pdf.table([["a"]]){
+        initializer.kick
+      }
+    end
+
+    it "should call a 1-arg block with the document as the argument" do
+      initializer = mock()
+      initializer.expects(:kick).once
+
+      @pdf.table([["a"]]){ |doc|
+        doc.should be_a_kind_of(Prawn::Table); initializer.kick }
+    end
+
+    it "should proxy cell methods to #cells" do
+      table = @pdf.table([["a"]], :cell_style => { :padding => 11 })
+      table.cells[0, 0].padding.should == [11, 11, 11, 11]
+    end
+
+    it "should set row and column length" do
+      table = @pdf.table([["a", "b", "c"], ["d", "e", "f"]])
+      table.row_length.should == 2
+      table.column_length.should == 3
+    end
+
+    it "should generate a text cell based on a String" do
+      t = @pdf.table([["foo"]])
+      t.cells[0,0].should be_a_kind_of(Prawn::Table::Cell::Text)
+    end
+
+    it "should pass through a text cell" do
+      c = Prawn::Table::Cell::Text.new(@pdf, [0,0], :content => "foo")
+      t = @pdf.table([[c]])
+      t.cells[0,0].should == c
+    end
+  end
+
+  describe "cell accessors" do
+    before(:each) do
+      @pdf = Prawn::Document.new
+      @table = @pdf.table([%w[R0C0 R0C1], %w[R1C0 R1C1]])
+    end
+
+    it "should select rows by number or range" do
+      Set.new(@table.row(0).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1])
+      Set.new(@table.rows(0..1).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+    end
+
+    it "should select rows by array" do
+      Set.new(@table.rows([0, 1]).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+    end
+
+    it "should allow negative row selectors" do
+      Set.new(@table.row(-1).map { |c| c.content }).should ==
+        Set.new(%w[R1C0 R1C1])
+      Set.new(@table.rows(-2..-1).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+      Set.new(@table.rows(0..-1).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+    end
+
+    it "should select columns by number or range" do
+      Set.new(@table.column(0).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R1C0])
+      Set.new(@table.columns(0..1).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+    end
+
+    it "should select columns by array" do
+      Set.new(@table.columns([0, 1]).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+    end
+
+    it "should allow negative column selectors" do
+      Set.new(@table.column(-1).map { |c| c.content }).should ==
+        Set.new(%w[R0C1 R1C1])
+      Set.new(@table.columns(-2..-1).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+      Set.new(@table.columns(0..-1).map { |c| c.content }).should ==
+        Set.new(%w[R0C0 R0C1 R1C0 R1C1])
+    end
+
+    it "should allow rows and columns to be combined" do
+      @table.row(0).column(1).map { |c| c.content }.should == ["R0C1"]
+    end
+
+    it "should accept a filter block, returning a cell proxy" do
+      @table.cells.filter { |c| c.content =~ /R0/ }.column(1).map{ |c|
+        c.content }.should == ["R0C1"]
+    end
+
+    it "should accept the [] method, returning a Cell or nil" do
+      @table.cells[0, 0].content.should == "R0C0"
+      @table.cells[12, 12].should be_nil
+    end
+
+    it "should proxy unknown methods to the cells" do
+      @table.cells.height = 200
+      @table.row(1).height = 100
+
+      @table.cells[0, 0].height.should == 200
+      @table.cells[1, 0].height.should == 100
+    end
+
+    it "should ignore non-setter methods" do
+      lambda {
+        @table.cells.content_width
+      }.should raise_error(NoMethodError)
+    end
+
+    it "skips cells that don't respond to the given method" do
+      table = @pdf.make_table([[{:content => "R0", :colspan => 2}],
+                               %w[R1C0 R1C1]])
+      lambda {
+        table.row(0).font_style = :bold
+      }.should_not raise_error
+    end
+
+    it "should accept the style method, proxying its calls to the cells" do
+      @table.cells.style(:height => 200, :width => 200)
+      @table.column(0).style(:width => 100)
+
+      @table.cells[0, 1].width.should == 200
+      @table.cells[1, 0].height.should == 200
+      @table.cells[1, 0].width.should == 100
+    end
+
+    it "style method should accept a block, passing each cell to be styled" do
+      @table.cells.style { |c| c.height = 200 }
+      @table.cells[0, 1].height.should == 200
+    end
+
+    it "should return the width of selected columns for #width" do
+      c0_width = @table.column(0).map{ |c| c.width }.max
+      c1_width = @table.column(1).map{ |c| c.width }.max
+
+      @table.column(0).width.should == c0_width
+      @table.column(1).width.should == c1_width
+
+      @table.columns(0..1).width.should == c0_width + c1_width
+      @table.cells.width.should == c0_width + c1_width
+    end
+
+    it "should return the height of selected rows for #height" do
+      r0_height = @table.row(0).map{ |c| c.height }.max
+      r1_height = @table.row(1).map{ |c| c.height }.max
+
+      @table.row(0).height.should == r0_height
+      @table.row(1).height.should == r1_height
+
+      @table.rows(0..1).height.should == r0_height + r1_height
+      @table.cells.height.should == r0_height + r1_height
+    end
+  end
+
+  describe "layout" do
+    before(:each) do
+      @pdf = Prawn::Document.new
+      @long_text = "The quick brown fox jumped over the lazy dogs. " * 5
+    end
+
+    describe "width" do
+      it "should raise_error an error if the given width is outside of range" do
+        lambda do
+          @pdf.table([["foo"]], :width => 1)
+        end.should raise_error(Prawn::Errors::CannotFit)
+
+        lambda do
+          @pdf.table([[@long_text]], :width => @pdf.bounds.width + 100)
+        end.should raise_error(Prawn::Errors::CannotFit)
+      end
+
+      it "should accept the natural width for small tables" do
+        pad = 10 # default padding
+        @table = @pdf.table([["a"]])
+        @table.width.should == @table.cells[0, 0].natural_content_width + pad
+      end
+
+      it "width should == sum(column_widths)" do
+        table = Prawn::Table.new([%w[ a b c ], %w[d e f]], @pdf) do
+          column(0).width = 50
+          column(1).width = 100
+          column(2).width = 150
+        end
+        table.width.should == 300
+      end
+
+      it "should accept Numeric for column_widths" do
+        table = Prawn::Table.new([%w[ a b c ], %w[d e f]], @pdf) do |t|
+          t.column_widths = 50
+        end
+        table.width.should == 150
+      end
+
+      it "should calculate unspecified column widths as "+
+         "(max(string_width) + 2*horizontal_padding)" do
+        hpad, fs = 3, 12
+        columns = 2
+        table = Prawn::Table.new( [%w[ foo b ], %w[d foobar]], @pdf,
+          :cell_style => { :padding => hpad, :size => fs } )
+
+        col0_width = @pdf.width_of("foo", :size => fs)
+        col1_width = @pdf.width_of("foobar", :size => fs)
+
+        table.width.should == col0_width + col1_width + 2*columns*hpad
+      end
+
+      it "should allow mixing autocalculated and preset"+
+         "column widths within a single table" do
+        hpad, fs = 10, 6
+        stretchy_columns = 2
+
+        col0_width = 50
+        col1_width = @pdf.width_of("foo", :size => fs)
+        col2_width = @pdf.width_of("foobar", :size => fs)
+        col3_width = 150
+
+        table = Prawn::Table.new( [%w[snake foo b apple],
+                                   %w[kitten d foobar banana]], @pdf,
+          :cell_style => { :padding => hpad, :size => fs }) do
+
+          column(0).width = col0_width
+          column(3).width = col3_width
+        end
+
+        table.width.should == col1_width + col2_width +
+                              2*stretchy_columns*hpad +
+                              col0_width + col3_width
+      end
+
+      it "should preserve all manually requested column widths" do
+        col0_width = 50
+        col1_width = 20
+        col3_width = 60
+
+        table = Prawn::Table.new( [["snake", "foo", "b",
+                                      "some long, long text that will wrap"],
+                                   %w[kitten d foobar banana]], @pdf,
+                                 :width => 150) do
+
+          column(0).width = col0_width
+          column(1).width = col1_width
+          column(3).width = col3_width
+        end
+
+        table.draw
+
+        table.column(0).width.should == col0_width
+        table.column(1).width.should == col1_width
+        table.column(3).width.should == col3_width
+      end
+
+      it "should_not exceed the maximum width of the margin_box" do
+        expected_width = @pdf.margin_box.width
+        data = [
+          ['This is a column with a lot of text that should comfortably exceed '+
+          'the width of a normal document margin_box width', 'Some more text',
+          'and then some more', 'Just a bit more to be extra sure']
+        ]
+        table = Prawn::Table.new(data, @pdf)
+
+        table.width.should == expected_width
+      end
+
+      it "should_not exceed the maximum width of the margin_box even with" +
+        "manual widths specified" do
+        expected_width = @pdf.margin_box.width
+        data = [
+          ['This is a column with a lot of text that should comfortably exceed '+
+          'the width of a normal document margin_box width', 'Some more text',
+          'and then some more', 'Just a bit more to be extra sure']
+        ]
+        table = Prawn::Table.new(data, @pdf) { column(1).width = 100 }
+
+        table.width.should == expected_width
+      end
+
+      it "scales down only the non-preset column widths when the natural width" +
+        "exceeds the maximum width of the margin_box" do
+        expected_width = @pdf.margin_box.width
+        data = [
+          ['This is a column with a lot of text that should comfortably exceed '+
+          'the width of a normal document margin_box width', 'Some more text',
+          'and then some more', 'Just a bit more to be extra sure']
+        ]
+        table = Prawn::Table.new(data, @pdf) { column(1).width = 100; column(3).width = 50 }
+
+        table.width.should == expected_width
+        table.column_widths[1].should == 100
+        table.column_widths[3].should == 50
+      end
+
+      it "should allow width to be reset even after it has been calculated" do
+        @table = @pdf.table([[@long_text]])
+        @table.width
+        @table.width = 100
+        @table.width.should == 100
+      end
+
+      it "should shrink columns evenly when two equal columns compete" do
+        @table = @pdf.table([["foo", @long_text], [@long_text, "foo"]])
+        @table.cells[0, 0].width.should == @table.cells[0, 1].width
+      end
+
+      it "should grow columns evenly when equal deficient columns compete" do
+        @table = @pdf.table([["foo", "foobar"], ["foobar", "foo"]], :width => 500)
+        @table.cells[0, 0].width.should == @table.cells[0, 1].width
+      end
+
+      it "should respect manual widths" do
+        @table = @pdf.table([%w[foo bar baz], %w[baz bar foo]], :width => 500) do
+          column(1).width = 60
+        end
+        @table.column(1).width.should == 60
+        @table.column(0).width.should == @table.column(2).width
+      end
+
+      it "should allow table cells to be resized in block" do
+        lambda do
+          @pdf.table([%w[1 2 3 4 5]]) do |t|
+            t.width = 40
+            t.cells.size = 8
+            t.cells.padding = 0
+          end
+        end.should_not raise_error(Prawn::Errors::CannotFit)
+      end
+
+      it "should be the width of the :width parameter" do
+        expected_width = 300
+        table = Prawn::Table.new( [%w[snake foo b apple],
+                                   %w[kitten d foobar banana]], @pdf,
+                                 :width => expected_width)
+
+        table.width.should == expected_width
+      end
+
+      it "should_not exceed the :width option" do
+        expected_width = 400
+        data = [
+          ['This is a column with a lot of text that should comfortably exceed '+
+          'the width of a normal document margin_box width', 'Some more text',
+          'and then some more', 'Just a bit more to be extra sure']
+        ]
+        table = Prawn::Table.new(data, @pdf, :width => expected_width)
+
+        table.width.should == expected_width
+      end
+
+      it "should_not exceed the :width option even with manual widths specified" do
+        expected_width = 400
+        data = [
+          ['This is a column with a lot of text that should comfortably exceed '+
+          'the width of a normal document margin_box width', 'Some more text',
+          'and then some more', 'Just a bit more to be extra sure']
+        ]
+        table = Prawn::Table.new(data, @pdf, :width => expected_width) do
+          column(1).width = 100
+        end
+
+        table.width.should == expected_width
+      end
+
+      it "should calculate unspecified column widths even " +
+         "with colspan cells declared" do
+        pdf = Prawn::Document.new
+        hpad, fs = 3, 5
+        columns  = 3
+
+        data = [ [ { :content => 'foo', :colspan => 2 }, "foobar" ],
+                 [ "foo", "foo", "foo" ] ]
+        table = Prawn::Table.new( data, pdf,
+          :cell_style => {
+            :padding_left => hpad, :padding_right => hpad,
+            :size => fs
+          })
+
+        col0_width = pdf.width_of("foo",    :size => fs) # cell 1, 0
+        col1_width = pdf.width_of("foo",    :size => fs) # cell 1, 1
+        col2_width = pdf.width_of("foobar", :size => fs) # cell 0, 1 (at col 2)
+
+        table.width.should == col0_width + col1_width +
+                              col2_width + 2*columns*hpad
+      end
+    end
+
+    describe "height" do
+      it "should set all cells in a row to the same height" do
+        @table = @pdf.table([["foo", @long_text]])
+        @table.cells[0, 0].height.should == @table.cells[0, 1].height
+      end
+
+      it "should move y-position to the bottom of the table after drawing" do
+        old_y = @pdf.y
+        table = @pdf.table([["foo"]])
+        @pdf.y.should == old_y - table.height
+      end
+
+      it "should_not wrap unnecessarily" do
+        # Test for FP errors and glitches
+        t = @pdf.table([["Bender Bending Rodriguez"]])
+        h = @pdf.height_of("one line")
+        (t.height - 10).should be < h*1.5
+      end
+
+      it "should have a height of n rows" do
+        data = [["foo"],["bar"],["baaaz"]]
+
+        vpad = 4
+        origin = @pdf.y
+        @pdf.table data, :cell_style => { :padding => vpad }
+
+        table_height = origin - @pdf.y
+        font_height = @pdf.font.height
+        line_gap = @pdf.font.line_gap
+
+        num_rows = data.length
+        table_height.should be_within(0.001).of(
+          num_rows * font_height + 2*vpad*num_rows )
+      end
+
+    end
+
+    describe "position" do
+      it "should center tables with :position => :center" do
+        @pdf.expects(:bounding_box).with do |(x, y), opts|
+          expected = (@pdf.bounds.width - 500) / 2.0
+          (x - expected).abs < 0.001
+        end
+
+        @pdf.table([["foo"]], :column_widths => 500, :position => :center)
+      end
+
+      it "should right-align tables with :position => :right" do
+        @pdf.expects(:bounding_box).with do |(x, y), opts|
+          expected = @pdf.bounds.width - 500
+          (x - expected).abs < 0.001
+        end
+
+        @pdf.table([["foo"]], :column_widths => 500, :position => :right)
+      end
+
+      it "should accept a Numeric" do
+        @pdf.expects(:bounding_box).with do |(x, y), opts|
+          expected = 123
+          (x - expected).abs < 0.001
+        end
+
+        @pdf.table([["foo"]], :column_widths => 500, :position => 123)
+      end
+
+      it "should raise_error an ArgumentError on unknown :position" do
+        lambda do
+          @pdf.table([["foo"]], :position => :bratwurst)
+        end.should raise_error(ArgumentError)
+      end
+    end
+
+  end
+
+  describe "Multi-page tables" do
+    it "should flow to the next page when hitting the bottom of the bounds" do
+      Prawn::Document.new { table([["foo"]] * 30) }.page_count.should == 1
+      Prawn::Document.new { table([["foo"]] * 31) }.page_count.should == 2
+      Prawn::Document.new { table([["foo"]] * 31); table([["foo"]] * 35) }.
+        page_count.should == 3
+    end
+
+    it "should respect the containing bounds" do
+      Prawn::Document.new do
+        bounding_box([0, cursor], :width => bounds.width, :height => 72) do
+          table([["foo"]] * 4)
+        end
+      end.page_count.should == 2
+    end
+
+    it "should_not start a new page before finishing out a row" do
+      Prawn::Document.new do
+        table([[ (1..80).map{ |i| "Line #{i}" }.join("\n"), "Column 2" ]])
+      end.page_count.should == 1
+    end
+
+    it "should only start new page on long cells if it would gain us height" do
+      Prawn::Document.new do
+        text "Hello"
+        table([[ (1..80).map{ |i| "Line #{i}" }.join("\n"), "Column 2" ]])
+      end.page_count.should == 2
+    end
+
+    it "should_not start a new page to gain height when at the top of " +
+       "a bounding box, even if stretchy" do
+      Prawn::Document.new do
+        bounding_box([bounds.left, bounds.top - 20], :width => 400) do
+          table([[ (1..80).map{ |i| "Line #{i}" }.join("\n"), "Column 2" ]])
+        end
+      end.page_count.should == 1
+    end
+
+    it "should still break to the next page if in a stretchy bounding box " +
+       "but not at the top" do
+      Prawn::Document.new do
+        bounding_box([bounds.left, bounds.top - 20], :width => 400) do
+          text "Hello"
+          table([[ (1..80).map{ |i| "Line #{i}" }.join("\n"), "Column 2" ]])
+        end
+      end.page_count.should == 2
+    end
+
+    it "should only draw first-page header if the first body row fits" do
+      pdf = Prawn::Document.new
+
+      pdf.y = 60 # not enough room for a table row
+      pdf.table [["Header"], ["Body"]], :header => true
+
+      output = PDF::Inspector::Page.analyze(pdf.render)
+      # Ensure we only drew the header once, on the second page
+      output.pages[0][:strings].should be_empty
+      output.pages[1][:strings].should == ["Header", "Body"]
+    end
+
+    it "should draw background before borders, but only within pages" do
+      seq = sequence("drawing_order")
+
+      @pdf = Prawn::Document.new
+
+      # give enough room for only the first row
+      @pdf.y = @pdf.bounds.absolute_bottom + 30
+      t = @pdf.make_table([["A", "B"],
+                           ["C", "D"]],
+            :cell_style => {:background_color => 'ff0000'})
+
+      ca = t.cells[0, 0]
+      cb = t.cells[0, 1]
+      cc = t.cells[1, 0]
+      cd = t.cells[1, 1]
+
+      # All backgrounds should draw before any borders on page 1...
+      ca.expects(:draw_background).in_sequence(seq)
+      cb.expects(:draw_background).in_sequence(seq)
+      ca.expects(:draw_borders).in_sequence(seq)
+      cb.expects(:draw_borders).in_sequence(seq)
+      # ...and page 2
+      @pdf.expects(:start_new_page).in_sequence(seq)
+      cc.expects(:draw_background).in_sequence(seq)
+      cd.expects(:draw_background).in_sequence(seq)
+      cc.expects(:draw_borders).in_sequence(seq)
+      cd.expects(:draw_borders).in_sequence(seq)
+
+      t.draw
+    end
+
+    describe "before_rendering_page callback" do
+      before(:each) { @pdf = Prawn::Document.new }
+
+      it "is passed all cells to be rendered on that page" do
+        kicked = 0
+
+        @pdf.table([["foo"]] * 100) do |t|
+          t.before_rendering_page do |page|
+            page.row_count.should == ((kicked < 3) ? 30 : 10)
+            page.column_count.should == 1
+            page.row(0).first.content.should == "foo"
+            page.row(-1).first.content.should == "foo"
+            kicked += 1
+          end
+        end
+
+        kicked.should == 4
+      end
+
+      it "numbers cells relative to their position on page" do
+        @pdf.table([["foo"]] * 100) do |t|
+          t.before_rendering_page do |page|
+            page[0, 0].content.should == "foo"
+          end
+        end
+      end
+
+      it "changing cells in the callback affects their rendering" do
+        seq = sequence("render order")
+
+        t = @pdf.make_table([["foo"]] * 40) do |table|
+          table.before_rendering_page do |page|
+            page[0, 0].background_color = "ff0000"
+          end
+        end
+
+        t.cells[30, 0].stubs(:draw_background).checking do |xy|
+          t.cells[30, 0].background_color.should == 'ff0000'
+        end
+        t.cells[31, 0].stubs(:draw_background).checking do |xy|
+          t.cells[31, 0].background_color.should == nil
+        end
+
+        t.draw
+      end
+
+      it "passes headers on page 2+" do
+        @pdf.table([["header"]] + [["foo"]] * 100, :header => true) do |t|
+          t.before_rendering_page do |page|
+            page[0, 0].content.should == "header"
+          end
+        end
+      end
+
+      it "allows headers to be changed" do
+        seq = sequence("render order")
+        @pdf.expects(:draw_text!).with { |t, _| t == "hdr1"}.in_sequence(seq)
+        @pdf.expects(:draw_text!).with { |t, _| t == "foo"}.times(29).in_sequence(seq)
+        # Verify that the changed cell doesn't mutate subsequent pages
+        @pdf.expects(:draw_text!).with { |t, _| t == "header"}.in_sequence(seq)
+        @pdf.expects(:draw_text!).with { |t, _| t == "foo"}.times(11).in_sequence(seq)
+
+        set_first_page_headers = false
+        @pdf.table([["header"]] + [["foo"]] * 40, :header => true) do |t|
+          t.before_rendering_page do |page|
+            # only change first page header
+            page[0, 0].content = "hdr1" unless set_first_page_headers
+            set_first_page_headers = true
+          end
+        end
+      end
+    end
+  end
+
+  describe "#style" do
+    it "should send #style to its first argument, passing the style hash and" +
+        " block" do
+
+      stylable = stub()
+      stylable.expects(:style).with(:foo => :bar).once.yields
+
+      block = stub()
+      block.expects(:kick).once
+
+      Prawn::Document.new do
+        table([["x"]]) { style(stylable, :foo => :bar) { block.kick } }
+      end
+    end
+
+    it "should default to {} for the hash argument" do
+      stylable = stub()
+      stylable.expects(:style).with({}).once
+
+      Prawn::Document.new do
+        table([["x"]]) { style(stylable) }
+      end
+    end
+  end
+
+  describe "row_colors" do
+    it "should allow array syntax for :row_colors" do
+      data = [["foo"], ["bar"], ["baz"]]
+      pdf = Prawn::Document.new
+      t = pdf.table(data, :row_colors => ['cccccc', 'ffffff'])
+      t.cells.map{|x| x.background_color}.should == %w[cccccc ffffff cccccc]
+    end
+
+    it "should ignore headers" do
+      data = [["header"], ["foo"], ["bar"], ["baz"]]
+      pdf = Prawn::Document.new
+      t = pdf.table(data, :header => true,
+                    :row_colors => ['cccccc', 'ffffff']) do
+        row(0).background_color = '333333'
+      end
+
+      t.cells.map{|x| x.background_color}.should ==
+        %w[333333 cccccc ffffff cccccc]
+    end
+
+    it "stripes rows consistently from page to page, skipping header rows" do
+      data = [["header"]] + [["foo"]] * 70
+      pdf = Prawn::Document.new
+      t = pdf.make_table(data, :header => true,
+          :row_colors => ['cccccc', 'ffffff']) do
+        cells.padding = 0
+        cells.size = 9
+        row(0).size = 11
+      end
+
+      # page 1: header + 67 cells (odd number -- verifies that the next
+      # page disrupts the even/odd coloring, since both the last data cell
+      # on this page and the first one on the next are colored cccccc)
+      Prawn::Table::Cell.expects(:draw_cells).with do |cells|
+        cells.map { |c, (x, y)| c.background_color } ==
+          [nil] + (%w[cccccc ffffff] * 33) + %w[cccccc]
+      end
+      # page 2: header and 3 data cells
+      Prawn::Table::Cell.expects(:draw_cells).with do |cells|
+        cells.map { |c, (x, y)| c.background_color } ==
+          [nil] + %w[cccccc ffffff cccccc]
+      end
+      t.draw
+    end
+
+    it "should_not override an explicit background_color" do
+      data = [["foo"], ["bar"], ["baz"]]
+      pdf = Prawn::Document.new
+      table = pdf.table(data, :row_colors => ['cccccc', 'ffffff']) { |t|
+        t.cells[0, 0].background_color = 'dddddd'
+      }
+      table.cells.map{|x| x.background_color}.should == %w[dddddd ffffff cccccc]
+    end
+  end
+
+  describe "inking" do
+    before(:each) do
+      @pdf = Prawn::Document.new
+    end
+
+    it "should set the x-position of each cell based on widths" do
+      @table = @pdf.table([["foo", "bar", "baz"]])
+
+      x = 0
+      (0..2).each do |col|
+        cell = @table.cells[0, col]
+        cell.x.should == x
+        x += cell.width
+      end
+    end
+
+    it "should set the y-position of each cell based on heights" do
+      y = 0
+      @table = @pdf.make_table([["foo"], ["bar"], ["baz"]])
+
+      (0..2).each do |row|
+        cell = @table.cells[row, 0]
+        cell.y.should be_within(0.01).of(y)
+        y -= cell.height
+      end
+    end
+
+    it "should output content cell by cell, row by row" do
+      data = [["foo","bar"],["baz","bang"]]
+      @pdf = Prawn::Document.new
+      @pdf.table(data)
+      output = PDF::Inspector::Text.analyze(@pdf.render)
+      output.strings.should == data.flatten
+    end
+
+    it "should_not cause an error if rendering the very first row causes a " +
+      "page break" do
+      Prawn::Document.new do |pdf|
+        arr = Array(1..5).collect{|i| ["cell #{i}"] }
+
+        pdf.move_down( pdf.y - (pdf.bounds.absolute_bottom + 3) )
+
+        lambda {
+          pdf.table(arr)
+        }.should_not raise_error
+      end
+    end
+
+    it "should draw all backgrounds before any borders" do
+      # lest backgrounds overlap borders:
+      # https://github.com/sandal/prawn/pull/226
+
+      seq = sequence("drawing_order")
+
+      t = @pdf.make_table([["A", "B"]],
+            :cell_style => {:background_color => 'ff0000'})
+      ca = t.cells[0, 0]
+      cb = t.cells[0, 1]
+
+      # XXX Not a perfectly general test, because it would still be acceptable
+      # if we drew B then A
+      ca.expects(:draw_background).in_sequence(seq)
+      cb.expects(:draw_background).in_sequence(seq)
+      ca.expects(:draw_borders).in_sequence(seq)
+      cb.expects(:draw_borders).in_sequence(seq)
+
+      t.draw
+    end
+
+    it "should allow multiple inkings of the same table" do
+      pdf = Prawn::Document.new
+      t = Prawn::Table.new([["foo"]], pdf)
+
+      pdf.expects(:bounding_box).with{|(x, y), options| y.to_i == 495}.yields
+      pdf.expects(:bounding_box).with{|(x, y), options| y.to_i == 395}.yields
+      pdf.expects(:draw_text!).with{ |text, options| text == 'foo' }.twice
+
+      pdf.move_cursor_to(500)
+      t.draw
+
+      pdf.move_cursor_to(400)
+      t.draw
+    end
+
+    describe "in stretchy bounding boxes" do
+      it "should draw all cells on a row at the same y-position" do
+        pdf = Prawn::Document.new
+
+        text_y = pdf.y.to_i - 5 # text starts 5pt below current y pos (padding)
+
+        pdf.bounding_box([0, pdf.cursor], :width => pdf.bounds.width) do
+          pdf.expects(:draw_text!).checking { |text, options|
+            pdf.bounds.absolute_top.should == text_y
+          }.times(3)
+
+          pdf.table([%w[a b c]])
+        end
+      end
+    end
+  end
+
+  describe "headers" do
+    it "should add headers to output when specified" do
+      data = [["a", "b"], ["foo","bar"],["baz","bang"]]
+      @pdf = Prawn::Document.new
+      @pdf.table(data, :header => true)
+      output = PDF::Inspector::Text.analyze(@pdf.render)
+      output.strings.should == data.flatten
+    end
+
+    it "should repeat headers across pages" do
+      data = [["foo","bar"]] * 30
+      headers = ["baz","foobar"]
+      @pdf = Prawn::Document.new
+      @pdf.table([headers] + data, :header => true)
+      output = PDF::Inspector::Text.analyze(@pdf.render)
+      output.strings.should == headers + data.flatten[0..-3] + headers +
+        data.flatten[-2..-1]
+    end
+
+    it "draws headers at the correct position" do
+      data = [["header"]] + [["foo"]] * 40
+
+      Prawn::Table::Cell.expects(:draw_cells).times(2).checking do |cells|
+        cells.each do |cell, pt|
+          if cell.content == "header"
+            # Assert that header text is drawn at the same location on each page
+            if @header_location
+              pt.should == @header_location
+            else
+              @header_location = pt
+            end
+          end
+        end
+      end
+      @pdf = Prawn::Document.new
+      @pdf.table(data, :header => true)
+    end
+
+    it "should_not draw header twice when starting new page" do
+      @pdf = Prawn::Document.new
+      @pdf.y = 0
+      @pdf.table([["Header"], ["Body"]], :header => true)
+      output = PDF::Inspector::Text.analyze(@pdf.render)
+      output.strings.should == ["Header", "Body"]
+    end
+  end
+
+  describe "nested tables" do
+    before(:each) do
+      @pdf = Prawn::Document.new
+      @subtable = Prawn::Table.new([["foo"]], @pdf)
+      @table = @pdf.table([[@subtable, "bar"]])
+    end
+
+    it "can be created from an Array" do
+      cell = Prawn::Table::Cell.make(@pdf, [["foo"]])
+      cell.should be_a_kind_of(Prawn::Table::Cell::Subtable)
+      cell.subtable.should be_a_kind_of(Prawn::Table)
+    end
+
+    it "defaults its padding to zero" do
+      @table.cells[0, 0].padding.should == [0, 0, 0, 0]
+    end
+
+    it "has a subtable accessor" do
+      @table.cells[0, 0].subtable.should == @subtable
+    end
+
+    it "determines its dimensions from the subtable" do
+      @table.cells[0, 0].width.should == @subtable.width
+      @table.cells[0, 0].height.should == @subtable.height
+    end
+
+  end
+
+  describe "An invalid table" do
+
+    before(:each) do
+      @pdf = Prawn::Document.new
+      @bad_data = ["Single Nested Array"]
+    end
+
+    it "should raise_error error when invalid table data is given" do
+      lambda {
+        @pdf.table(@bad_data)
+      }.should raise_error(Prawn::Errors::InvalidTableData)
+    end
+
+    it "should raise_error an EmptyTableError with empty table data" do
+      lambda {
+        data = []
+        @pdf = Prawn::Document.new
+        @pdf.table(data)
+      }.should raise_error( Prawn::Errors::EmptyTable )
+    end
+
+    it "should raise_error an EmptyTableError with nil table data" do
+      lambda {
+        data = nil
+        @pdf = Prawn::Document.new
+        @pdf.table(data)
+      }.should raise_error( Prawn::Errors::EmptyTable )
+    end
+
+  end
+
+end
+
+describe "colspan / rowspan" do
+  before(:each) { create_pdf }
+
+  it "doesn't raise an error" do
+    lambda {
+      @pdf.table([[{:content => "foo", :colspan => 2, :rowspan => 2}]])
+    }.should_not raise_error
+  end
+
+  it "colspan is properly counted" do
+    t = @pdf.make_table([[{:content => "foo", :colspan => 2}]])
+    t.column_length.should == 2
+  end
+
+  it "rowspan is properly counted" do
+    t = @pdf.make_table([[{:content => "foo", :rowspan => 2}]])
+    t.row_length.should == 2
+  end
+
+  it "raises if colspan or rowspan are called after layout" do
+    lambda {
+      @pdf.table([["foo"]]) { cells[0, 0].colspan = 2 }
+    }.should raise_error(Prawn::Errors::InvalidTableSpan)
+
+    lambda {
+      @pdf.table([["foo"]]) { cells[0, 0].rowspan = 2 }
+    }.should raise_error(Prawn::Errors::InvalidTableSpan)
+  end
+
+  it "raises when spans overlap" do
+    lambda {
+      @pdf.table([["foo", {:content => "bar", :rowspan => 2}],
+                  [{:content => "baz", :colspan => 2}]])
+    }.should raise_error(Prawn::Errors::InvalidTableSpan)
+  end
+
+  it "table and cell width account for colspan" do
+    t = @pdf.table([["a", {:content => "b", :colspan => 2}]],
+                   :column_widths => [100, 100, 100])
+    spanned = t.cells[0, 1]
+    spanned.colspan.should == 2
+    t.width.should == 300
+    t.cells.min_width.should == 300
+    t.cells.max_width.should == 300
+    spanned.width.should == 200
+  end
+
+  it "table and cell height account for rowspan" do
+    t = @pdf.table([["a"], [{:content => "b", :rowspan => 2}]]) do
+      row(0..2).height = 100
+    end
+    spanned = t.cells[1, 0]
+    spanned.rowspan.should == 2
+    t.height.should == 300
+    spanned.height.should == 200
+  end
+
+  it "provides the full content_width as drawing space" do
+    w = @pdf.make_table([["foo"]]).cells[0, 0].content_width
+
+    t = @pdf.make_table([[{:content => "foo", :colspan => 2}]])
+    t.cells[0, 0].spanned_content_width.should == w
+  end
+
+  it "dummy cells are not drawn" do
+    # make a fake master cell for the dummy cell to slave to
+    t = @pdf.make_table([[{:content => "foo", :colspan => 2}]])
+
+    # drawing just a dummy cell should_not ink
+    @pdf.expects(:stroke_line).never
+    @pdf.expects(:draw_text!).never
+    Prawn::Table::Cell.draw_cells([t.cells[0, 1]])
+  end
+
+  it "dummy cells do not add any height or width" do
+    t1 = @pdf.table([["foo"]])
+
+    t2 = @pdf.table([[{:content => "foo", :colspan => 2}]])
+    t2.width.should == t1.width
+
+    t3 = @pdf.table([[{:content => "foo", :rowspan => 2}]])
+    t3.height.should == t1.height
+  end
+
+  it "dummy cells ignored by #style" do
+    t = @pdf.table([[{:content => "blah", :colspan => 2}]],
+                   :cell_style => { :size => 9 })
+    t.cells[0, 0].size.should == 9
+  end
+
+  context "inheriting master cell styles from dummy cell" do
+    # Relatively full coverage for all these attributes that should be
+    # inherited.
+    [["border_X_width", 20],
+     ["border_X_color", "123456"],
+     ["padding_X", 20]].each do |attribute, val|
+      attribute_right  = attribute.sub("X", "right")
+      attribute_left   = attribute.sub("X", "left")
+      attribute_bottom = attribute.sub("X", "bottom")
+      attribute_top    = attribute.sub("X", "top")
+
+      specify "#{attribute_right} of right column is inherited" do
+        t = @pdf.table([[{:content => "blah", :colspan => 2}]]) do |table|
+          table.column(1).send("#{attribute_right}=", val)
+        end
+
+        t.cells[0, 0].send(attribute_right).should == val
+      end
+
+      specify "#{attribute_bottom} of bottom row is inherited" do
+        t = @pdf.table([[{:content => "blah", :rowspan => 2}]]) do |table|
+          table.row(1).send("#{attribute_bottom}=", val)
+        end
+
+        t.cells[0, 0].send(attribute_bottom).should == val
+      end
+
+      specify "#{attribute_left} of right column is not inherited" do
+        t = @pdf.table([[{:content => "blah", :colspan => 2}]]) do |table|
+          table.column(1).send("#{attribute_left}=", val)
+        end
+
+        t.cells[0, 0].send(attribute_left).should_not == val
+      end
+
+      specify "#{attribute_right} of interior column is not inherited" do
+        t = @pdf.table([[{:content => "blah", :colspan => 3}]]) do |table|
+          table.column(1).send("#{attribute_right}=", val)
+        end
+
+        t.cells[0, 0].send(attribute_right).should_not == val
+      end
+
+      specify "#{attribute_bottom} of interior row is not inherited" do
+        t = @pdf.table([[{:content => "blah", :rowspan => 3}]]) do |table|
+          table.row(1).send("#{attribute_bottom}=", val)
+        end
+
+        t.cells[0, 0].send(attribute_bottom).should_not == val
+      end
+
+      specify "#{attribute_top} of bottom row is not inherited" do
+        t = @pdf.table([[{:content => "blah", :rowspan => 2}]]) do |table|
+          table.row(1).send("#{attribute_top}=", val)
+        end
+
+        t.cells[0, 0].send(attribute_top).should_not == val
+      end
+    end
+  end
+
+  it "splits natural width between cols in the group" do
+    t = @pdf.table([[{:content => "foo", :colspan => 2}]])
+    widths = t.column_widths
+    widths[0].should == widths[1]
+  end
+
+  it "splits natural width between cols when width is increased" do
+    t = @pdf.table([[{:content => "foo", :colspan => 2}]],
+                   :width => @pdf.bounds.width)
+    widths = t.column_widths
+    widths[0].should == widths[1]
+  end
+
+  it "splits min-width between cols in the group" do
+    # Since column_widths, when reducing column widths, reduces proportional to
+    # the remaining width after each column's min width, we must ensure that the
+    # min-width is split proportionally in order to ensure the width is still
+    # split evenly when the width is reduced. (See "splits natural width between
+    # cols when width is reduced".)
+    t = @pdf.table([[{:content => "foo", :colspan => 2}]],
+                   :width => 20)
+    t.column(0).min_width.should == t.column(1).min_width
+  end
+
+  it "splits natural width between cols when width is reduced" do
+    t = @pdf.table([[{:content => "foo", :colspan => 2}]],
+                   :width => 20)
+    widths = t.column_widths
+    widths[0].should == widths[1]
+  end
+
+  it "honors a large, explicitly set table width" do
+    t = @pdf.table([[{:content => "AAAAAAAAAA", :colspan => 3}],
+                    ["A", "B", "C"]],
+                   :width => 400)
+
+    t.column_widths.inject(0) { |sum, w| sum + w }.
+      should be_within(0.01).of(400)
+  end
+
+  it "honors a small, explicitly set table width" do
+    t = @pdf.table([[{:content => "Lorem ipsum dolor sit amet " * 20,
+                      :colspan => 3}],
+                    ["A", "B", "C"]],
+                   :width => 200)
+
+    t.column_widths.inject(0) { |sum, w| sum + w }.
+      should be_within(0.01).of(200)
+  end
+
+  it "splits natural_content_height between rows in the group" do
+    t = @pdf.table([[{:content => "foo", :rowspan => 2}]])
+    heights = t.row_heights
+    heights[0].should == heights[1]
+  end
+
+  it "skips column numbers that have been col-spanned" do
+    t = @pdf.table([["a", "b", {:content => "c", :colspan => 3}, "d"]])
+    t.cells[0, 0].content.should == "a"
+    t.cells[0, 1].content.should == "b"
+    t.cells[0, 2].content.should == "c"
+    t.cells[0, 3].should be_a_kind_of(Prawn::Table::Cell::SpanDummy)
+    t.cells[0, 4].should be_a_kind_of(Prawn::Table::Cell::SpanDummy)
+    t.cells[0, 5].content.should == "d"
+  end
+
+  it "skips row/col positions that have been row-spanned" do
+    t = @pdf.table([["a", {:content => "b", :colspan => 2, :rowspan => 2}, "c"],
+                    ["d",                                                  "e"],
+                    ["f",               "g",              "h",             "i"]])
+    t.cells[0, 0].content.should == "a"
+    t.cells[0, 1].content.should == "b"
+    t.cells[0, 2].should be_a_kind_of(Prawn::Table::Cell::SpanDummy)
+    t.cells[0, 3].content.should == "c"
+
+    t.cells[1, 0].content.should == "d"
+    t.cells[1, 1].should be_a_kind_of(Prawn::Table::Cell::SpanDummy)
+    t.cells[1, 2].should be_a_kind_of(Prawn::Table::Cell::SpanDummy)
+    t.cells[1, 3].content.should == "e"
+
+    t.cells[2, 0].content.should == "f"
+    t.cells[2, 1].content.should == "g"
+    t.cells[2, 2].content.should == "h"
+    t.cells[2, 3].content.should == "i"
+  end
+end
+