prawn-layout 0.1.0

data/lib/prawn/table/cell.rb

@@ -0,0 +1,263 @@
+# encoding: utf-8   
+
+# cell.rb : Table support functions
+#
+# Copyright June 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+
+  class Document
+    # Builds and renders a Table::Cell.  A cell is essentially a
+    # special-purpose bounding box designed for flowing text within a bordered
+    # area.  For available options, see Table::Cell#new.
+    #
+    #    Prawn::Document.generate("cell.pdf") do
+    #       cell [100,500], 
+    #         :width => 200,
+    #         :text  => "The rain in Spain falls mainly on the plains"
+    #    end
+    #
+    def cell(point, options={})
+      Prawn::Table::Cell.new(
+        options.merge(:document => self, :point => point)).draw
+    end
+  end
+
+  class Table
+    # A cell is a special-purpose bounding box designed to flow text within a
+    # bordered area. This is used by Prawn's Document::Table implementation but
+    # can also be used standalone for drawing text boxes via Document#cell
+    #
+    class Cell
+
+      # Creates a new cell object.  Generally used indirectly via Document#cell
+      #
+      # Of the available options listed below, <tt>:point</tt>, <tt>:width</tt>,
+      # and <tt>:text</tt> must be provided. If you are not using the
+      # Document#cell shortcut, the <tt>:document</tt> must also be provided.
+      #
+      # <tt>:point</tt>:: Absolute [x,y] coordinate of the top-left corner of the cell.
+      # <tt>:document</tt>:: The Prawn::Document object to render on. 
+      # <tt>:text</tt>:: The text to be flowed within the cell
+      # <tt>:text_color</tt>:: The color of the text to be displayed
+      # <tt>:width</tt>:: The width in PDF points of the cell.
+      # <tt>:height</tt>:: The height in PDF points of the cell.
+      # <tt>:horizontal_padding</tt>:: The horizontal padding in PDF points
+      # <tt>:vertical_padding</tt>:: The vertical padding in PDF points
+      # <tt>:padding</tt>:: Overrides both horizontal and vertical padding
+      # <tt>:align</tt>:: One of <tt>:left</tt>, <tt>:right</tt>, <tt>:center</tt>
+      # <tt>:borders</tt>:: An array of sides which should have a border. Any of <tt>:top</tt>, <tt>:left</tt>, <tt>:right</tt>, <tt>:bottom</tt>
+      # <tt>:border_width</tt>:: The border line width. Defaults to 1.
+      # <tt>:border_style</tt>:: One of <tt>:all</tt>, <tt>:no_top</tt>, <tt>:no_bottom</tt>, <tt>:sides</tt>, <tt>:none</tt>, <tt>:bottom_only</tt>. Defaults to :all.
+      # <tt>:border_color</tt>:: The color of the cell border.
+      # <tt>:font_size</tt>:: The font size for the cell text.
+      #
+      def initialize(options={})
+        @point        = options[:point]
+        @document     = options[:document]
+        @text         = options[:text].to_s
+        @text_color   = options[:text_color]
+        @width        = options[:width]
+        @height       = options[:height]
+        @borders      = options[:borders]
+        @border_width = options[:border_width] || 1
+        @border_style = options[:border_style] || :all               
+        @border_color = options[:border_color]
+        @background_color = options[:background_color] 
+        @align            = options[:align] || :left
+        @font_size        = options[:font_size]
+
+        @horizontal_padding = options[:horizontal_padding] || 0
+        @vertical_padding   = options[:vertical_padding]   || 0
+
+        if options[:padding]
+          @horizontal_padding = @vertical_padding = options[:padding]
+        end
+      end
+
+      attr_accessor :point, :border_style, :border_width, :background_color,
+                    :document, :horizontal_padding, :vertical_padding, :align,
+                    :borders, :text_color, :border_color
+                    
+      attr_writer   :height, :width #:nodoc:   
+           
+      # Returns the cell's text as a string.
+      #
+      def to_s
+        @text
+      end
+
+      # The width of the text area excluding the horizonal padding
+      #
+      def text_area_width
+        width - 2*@horizontal_padding
+      end
+
+      # The width of the cell in PDF points
+      #
+      def width
+        @width || (@document.font.width_of(@text, :size => @font_size)) + 2*@horizontal_padding
+      end
+
+      # The height of the cell in PDF points
+      #
+      def height  
+        @height || text_area_height + 2*@vertical_padding
+      end
+
+      # The height of the text area excluding the vertical padding
+      #
+      def text_area_height
+        @document.height_of(@text, text_area_width)
+      end
+
+      # Draws the cell onto the PDF document
+      # 
+      def draw
+        rel_point = @point                
+        
+        if @background_color    
+          @document.mask(:fill_color) do
+            @document.fill_color @background_color  
+            h  = borders.include?(:bottom) ? 
+              height - border_width : height + border_width / 2.0
+            @document.fill_rectangle [rel_point[0] + border_width / 2.0, 
+                                      rel_point[1] - border_width / 2.0 ], 
+                width - border_width, h  
+          end
+        end
+
+        if @border_width > 0
+          @document.mask(:line_width) do
+            @document.line_width = @border_width
+
+            @document.mask(:stroke_color) do
+              @document.stroke_color @border_color if @border_color
+
+              if borders.include?(:left)
+                @document.stroke_line [rel_point[0], rel_point[1] + (@border_width / 2.0)], 
+                  [rel_point[0], rel_point[1] - height - @border_width / 2.0 ]
+              end
+
+              if borders.include?(:right)
+                @document.stroke_line( 
+                  [rel_point[0] + width, rel_point[1] + (@border_width / 2.0)],
+                  [rel_point[0] + width, rel_point[1] - height - @border_width / 2.0] )
+              end
+
+              if borders.include?(:top)
+                @document.stroke_line(
+                  [ rel_point[0] + @border_width / 2.0, rel_point[1] ], 
+                  [ rel_point[0] - @border_width / 2.0 + width, rel_point[1] ])
+              end
+
+              if borders.include?(:bottom)
+                @document.stroke_line [rel_point[0], rel_point[1] - height ],
+                                    [rel_point[0] + width, rel_point[1] - height]
+              end
+            end
+
+          end
+          
+          borders
+
+        end
+
+        @document.bounding_box( [@point[0] + @horizontal_padding, 
+                                 @point[1] - @vertical_padding], 
+                                :width   => text_area_width,
+                                :height  => height - @vertical_padding) do
+          @document.move_down((@document.font.line_gap - @document.font.descender)/2)
+
+          options = {:align => @align, :final_gap => false}
+
+          options[:size] = @font_size if @font_size
+
+          @document.mask(:fill_color) do
+            @document.fill_color @text_color if @text_color                        
+            @document.text @text, options
+          end
+        end
+      end
+
+      private
+
+      def borders
+        @borders ||= case @border_style
+        when :all
+          [:top,:left,:right,:bottom]
+        when :sides
+          [:left,:right]
+        when :no_top
+          [:left,:right,:bottom]
+        when :no_bottom
+          [:left,:right,:top]
+        when :bottom_only
+          [:bottom]
+        when :none
+          []
+        end
+      end
+
+    end
+
+    class CellBlock #:nodoc:
+
+      # Not sure if this class is something I want to expose in the public API.
+
+      def initialize(document)
+        @document = document
+        @cells    = []
+        @width    = 0
+        @height   = 0
+      end
+
+      attr_reader :width, :height, :cells
+      attr_accessor :background_color, :text_color, :border_color
+
+      def <<(cell)
+        @cells << cell
+        @height = cell.height if cell.height > @height 
+        @width += cell.width
+        self
+      end
+
+      def draw
+        y = @document.y
+        x = @document.bounds.absolute_left
+
+        @cells.each do |e|
+          e.point  = [x - @document.bounds.absolute_left, 
+                      y - @document.bounds.absolute_bottom]
+          e.height = @height
+          e.background_color ||= @background_color
+          e.text_color ||= @text_color
+          e.border_color ||= @border_color
+          e.draw
+          x += e.width
+        end
+        
+        @document.y = y - @height
+      end
+
+      def border_width
+        @cells[0].border_width
+      end
+
+      def border_style=(s)
+        @cells.each { |e| e.border_style = s }
+      end    
+      
+      def align=(align) 
+        @cells.each { |e| e.align = align } 
+      end           
+      
+      def border_style
+        @cells[0].border_style
+      end
+
+    end
+  end
+ 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
+
+require "rubygems"
+require "test/spec"                                                
+require "mocha"
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib') 
+
+require "prawn"
+require "prawn/layout"
+$LOAD_PATH << File.join(Prawn::BASEDIR, 'vendor','pdf-inspector','lib')
+
+Prawn.debug = true
+
+gem 'pdf-reader', ">=0.7.3"
+require "pdf/reader"          
+require "pdf/inspector"
+
+def create_pdf(klass=Prawn::Document)
+  @pdf = klass.new(:left_margin   => 0,
+                   :right_margin  => 0,
+                   :top_margin    => 0,
+                   :bottom_margin => 0)
+end    

data/spec/table_spec.rb

@@ -0,0 +1,261 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+
+describe "A table's width" do
+  it "should equal sum(column_widths)" do
+    pdf = Prawn::Document.new
+    table = Prawn::Table.new( [%w[ a b c ], %w[d e f]], pdf,
+       :column_widths => { 0 => 50, 1 => 100, 2 => 150 })
+
+    table.width.should == 300
+  end
+
+  it "should calculate unspecified column widths as "+
+     "(max(string_width).ceil + 2*horizontal_padding)" do
+    pdf = Prawn::Document.new
+    hpad, fs = 3, 12
+    columns = 2
+    table = Prawn::Table.new( [%w[ foo b ], %w[d foobar]], pdf,
+      :horizontal_padding => hpad, :font_size => fs)
+
+    col0_width = pdf.font.width_of("foo", :size => fs)
+    col1_width = pdf.font.width_of("foobar", :size => fs)
+
+    table.width.should == col0_width.ceil + col1_width.ceil + 2*columns*hpad
+  end
+
+  it "should allow mixing autocalculated and preset"+
+     "column widths within a single table" do
+
+    pdf = Prawn::Document.new
+    hpad, fs = 10, 6
+    stretchy_columns = 2
+    
+    col0_width = 50
+    col1_width = pdf.font.width_of("foo", :size => fs)
+    col2_width = pdf.font.width_of("foobar", :size => fs)
+    col3_width = 150
+
+    table = Prawn::Table.new( [%w[snake foo b apple], 
+                                         %w[kitten d foobar banana]], pdf,
+      :horizontal_padding => hpad, :font_size => fs, 
+      :column_widths => { 0 => col0_width, 3 => col3_width } )
+
+        table.width.should == col1_width.ceil + col2_width.ceil + 
+                              2*stretchy_columns*hpad + 
+                              col0_width.ceil + col3_width.ceil
+
+  end
+
+  it "should not exceed the maximum width of the margin_box" do
+      
+    pdf = Prawn::Document.new
+    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
+      
+    pdf = Prawn::Document.new
+    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_widths => { 1 => 100 })
+
+    table.width.should == expected_width
+
+  end
+
+  it "should be the width of the :width parameter" do
+      
+    pdf = Prawn::Document.new
+    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
+      
+    pdf = Prawn::Document.new
+    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
+      
+    pdf = Prawn::Document.new
+    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, :column_widths => { 1 => 100 }, :width => expected_width)
+
+    table.width.should == expected_width
+
+  end
+      
+end   
+
+describe "A table's height" do 
+  
+  before :each do                                           
+    data = [["foo"],["bar"],["baaaz"]]
+    pdf = Prawn::Document.new
+    @num_rows = data.length
+       
+    @vpad  = 4
+    origin = pdf.y
+    pdf.table data, :vertical_padding => @vpad
+
+    @table_height = origin - pdf.y
+
+    @font_height = pdf.font.height
+  end   
+  
+  it "should have a height of n rows" do  
+    @table_height.should.be.close(
+      @num_rows*@font_height + 2*@vpad*@num_rows, 0.001 )
+  end
+  
+end
+
+describe "A table's content" do
+
+  it "should not cause an error if rendering the very first row causes a page break" do
+    Prawn::Document.new( :page_layout => :portrait ) do
+      arr = Array(1..5).collect{|i| ["cell #{i}"] }
+
+      move_down( y - (bounds.absolute_bottom + 3) )
+
+      lambda {
+        table( arr,
+            :font_size          => 9, 
+            :horizontal_padding => 3,
+            :vertical_padding   => 3,
+            :border_width       => 0.05,
+            :border_style       => :none,
+            :row_colors         => %w{ffffff eeeeee},
+            :column_widths      => {0 =>110},
+            :position           => :left,
+            :headers            => ["exploding header"],
+            :align              => :left,
+            :align_headers      => :center)
+      }.should.not.raise
+    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 add headers to output when specified" do
+    data = [["foo","bar"],["baz","bang"]]
+    headers = %w[a b]
+    @pdf = Prawn::Document.new
+    @pdf.table(data, :headers => headers)
+    output = PDF::Inspector::Text.analyze(@pdf.render)   
+    output.strings.should == headers + data.flatten
+  end
+
+  it "should repeat headers across pages" do
+    data = [["foo","bar"]]*30
+    headers = ["baz","foobar"]
+    @pdf = Prawn::Document.new
+    @pdf.table(data, :headers => headers)
+    output = PDF::Inspector::Text.analyze(@pdf.render)   
+    output.strings.should == headers + data.flatten[0..-3] + headers +
+      data.flatten[-2..-1]
+  end
+
+  it "should allow empty fields" do
+    lambda {
+      data = [["foo","bar"],["baz",""]]
+      @pdf = Prawn::Document.new
+      @pdf.table(data)
+    }.should.not.raise
+  end   
+  
+  it "should paginate for large tables" do
+    # 30 rows fit on the table with default setting, 31 exceed.
+    data = [["foo"]] * 31
+    pdf = Prawn::Document.new
+
+    pdf.table data
+    pdf.page_count.should == 2
+
+    pdf.table data
+    pdf.page_count.should == 3
+  end
+  
+  it "should accurately count columns from data" do
+    # First data row may contain colspan which would hide true column count
+    data = [["Name:",{:text => "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 "An invalid table" do
+  
+  before(:each) do
+    @pdf = Prawn::Document.new
+    @bad_data = ["Single Nested Array"]
+  end
+  
+  it "should raise error when invalid table data is given" do
+    assert_raises(Prawn::Errors::InvalidTableData) do
+      @pdf.table(@bad_data)
+    end
+  end
+
+  it "should raise an EmptyTableError with empty table data" do
+    lambda {
+      data = []
+      @pdf = Prawn::Document.new
+      @pdf.table(data)
+    }.should.raise( Prawn::Errors::EmptyTable )
+  end   
+
+  it "should raise an EmptyTableError with nil table data" do
+    lambda {
+      data = nil
+      @pdf = Prawn::Document.new
+      @pdf.table(data)
+    }.should.raise( Prawn::Errors::EmptyTable )
+  end   
+
+end