prawn 1.0.0.rc2 → 1.0.0

data/lib/prawn/table/cell.rb

@@ -10,6 +10,8 @@ require 'date'
 module Prawn
   class Document
 
+    # @group Experimental API
+
     # Instantiates and draws a cell on the document.
     #
     #   cell(:content => "Hello world!", :at => [12, 34])
@@ -122,7 +124,7 @@ module Prawn
       # HTML RGB-format ("ccffff") border colors: [top, right, bottom, left].
       #
       attr_reader :border_colors
-      
+
       # Line style
       #
       attr_reader :border_lines
@@ -151,7 +153,7 @@ module Prawn
       # this span group. They know their own width / height, but do not draw
       # anything.
       #
-      attr_reader :dummy_cells # :nodoc:
+      attr_reader :dummy_cells 
 
       # Instantiates a Cell based on the given options. The particular class of
       # cell returned depends on the :content argument. See the Prawn::Table
@@ -163,7 +165,7 @@ module Prawn
           content.kind_of?(Date)
 
         if content.is_a?(Hash)
-          if img = content[:image]
+          if content[:image]
             return Cell::Image.new(pdf, at, content)
           end
           options.update(content)
@@ -232,7 +234,9 @@ module Prawn
       #   cell.border_width = 2
       #
       def style(options={}, &block)
-        options.each { |k, v| send("#{k}=", v) }
+        options.each do |k, v|
+          send("#{k}=", v) if respond_to?("#{k}=")
+        end
 
         # The block form supports running a single block for multiple cells, as
         # in Cells#style.
@@ -245,7 +249,7 @@ module Prawn
       def width_ignoring_span
         # We can't ||= here because the FP error accumulates on the round-trip
         # from #content_width.
-        @width || (content_width + padding_left + padding_right)
+        defined?(@width) && @width || (content_width + padding_left + padding_right)
       end
 
       # Returns the cell's width in points, inclusive of padding. If the cell is
@@ -275,7 +279,7 @@ module Prawn
       # Returns the width of the bare content in the cell, excluding padding.
       #
       def content_width
-        if @width # manually set
+        if defined?(@width) && @width # manually set
           return @width - padding_left - padding_right
         end
 
@@ -302,7 +306,7 @@ module Prawn
       def height_ignoring_span
         # We can't ||= here because the FP error accumulates on the round-trip
         # from #content_height.
-        @height || (content_height + padding_top + padding_bottom)
+        defined?(@height) && @height || (content_height + padding_top + padding_bottom)
       end
 
       # Returns the cell's height in points, inclusive of padding. If the cell
@@ -325,7 +329,7 @@ module Prawn
       # Returns the height of the bare content in the cell, excluding padding.
       #
       def content_height
-        if @height # manually set
+        if defined?(@height) && @height # manually set
           return @height - padding_top - padding_bottom
         end
 
@@ -359,7 +363,7 @@ module Prawn
       #   pdf.table([["foo", "bar"]]) { cells[0, 1].colspan = 2 }
       #
       def colspan=(span)
-        if @initializer_run
+        if defined?(@initializer_run) && @initializer_run
           raise Prawn::Errors::InvalidTableSpan,
             "colspan must be provided in the table's structure, never in the " +
             "initialization block. See Prawn's documentation for details."
@@ -380,7 +384,7 @@ module Prawn
       #   pdf.table([["foo", "bar"], ["baz"]]) { cells[0, 1].rowspan = 2 }
       #
       def rowspan=(span)
-        if @initializer_run
+        if defined?(@initializer_run) && @initializer_run
           raise Prawn::Errors::InvalidTableSpan,
             "rowspan must be provided in the table's structure, never in the " +
             "initialization block. See Prawn's documentation for details."
@@ -543,14 +547,6 @@ module Prawn
         @border_colors[0] = val
       end
 
-      def border_top_color
-        @border_colors[0]
-      end
-
-      def border_top_color=(val)
-        @border_colors[0] = val
-      end
-
       def border_right_color
         @border_colors[1]
       end
@@ -640,7 +636,7 @@ module Prawn
         @min_width ||= padding_left + padding_right
         @max_width ||= @pdf.bounds.width
       end
-      
+
       # Sets border line style on this cell. The argument can be one of:
       #
       # Possible values are: :solid, :dashed, :dotted
@@ -704,7 +700,7 @@ module Prawn
       # Draws the cell's background color.
       #
       def draw_background(pt)
-        if @background_color
+        if defined?(@background_color) && @background_color
           @pdf.mask(:fill_color) do
             @pdf.fill_color @background_color
             @pdf.fill_rectangle pt, width, height
@@ -755,7 +751,7 @@ module Prawn
               raise ArgumentError, "border_line must be :solid, :dotted or" +
                 " :dashed"
             end
-            
+
             @pdf.line_width   = border_width
             @pdf.stroke_color = border_color
             @pdf.stroke_line(from, to)

data/lib/prawn/table/cell/image.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # image.rb: Table image cells.
 #
@@ -9,8 +9,7 @@ module Prawn
   class Table
     class Cell
 
-      # A Cell that contains another table.
-      #
+      # @private
       class Image < Cell
 
         def initialize(pdf, point, options={})

data/lib/prawn/table/cell/in_table.rb

@@ -1,21 +1,27 @@
 # encoding: utf-8
 
 # Accessors for using a Cell inside a Table.
+#
+# Contributed by Brad Ediger.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
 
 module Prawn
-  class Table    
+  class Table
+
     class Cell
 
       # This module extends Cell objects when they are used in a table (as
       # opposed to standalone). Its properties apply to cells-in-tables but not
       # cells themselves.
       #
+      # @private
       module InTable
 
         # Row number (0-based).
         #
         attr_accessor :row
-        
+
         # Column number (0-based).
         #
         attr_accessor :column

data/lib/prawn/table/cell/span_dummy.rb

@@ -12,6 +12,7 @@ module Prawn
       # A Cell object used to represent all but the topmost cell in a span
       # group.
       #
+      # @private
       class SpanDummy < Cell
         def initialize(pdf, master_cell)
           super(pdf, [0, pdf.cursor])
@@ -69,6 +70,10 @@ module Prawn
           @master_cell.border_bottom_width = val if bottommost?
         end
 
+        def background_color
+          @master_cell.background_color
+        end
+
         private
 
         # Are we on the right border of the span?

data/lib/prawn/table/cell/subtable.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # subtable.rb: Yo dawg.
 #
@@ -11,6 +11,7 @@ module Prawn
 
       # A Cell that contains another table.
       #
+      # @private
       class Subtable < Cell
 
         attr_reader :subtable
@@ -47,7 +48,7 @@ module Prawn
           @subtable.cells.max_width
         end
 
-        # Proxied to subtable. 
+        # Proxied to subtable.
         #
         def natural_content_height
           @subtable.cells.height

data/lib/prawn/table/cell/text.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # text.rb: Text table cells.
 #
@@ -12,6 +12,7 @@ module Prawn
       # A Cell that contains text. Has some limited options to set font family,
       # size, and style.
       #
+      # @private
       class Text < Cell
 
         TextOptions = [:inline_format, :kerning, :size, :align, :valign,
@@ -64,7 +65,7 @@ module Prawn
         # Draws the text content into its bounding box.
         #
         def draw_content
-          with_font do 
+          with_font do
             @pdf.move_down((@pdf.font.line_gap + @pdf.font.descender)/2)
             with_text_color do
               text_box(:width => spanned_content_width + FPTolerance,
@@ -78,7 +79,7 @@ module Prawn
           # Sets a reasonable minimum width. If the cell has any content, make
           # sure we have enough width to be at least one character wide. This is
           # a bit of a hack, but it should work well enough.
-          unless @min_width
+          unless defined?(@min_width) && @min_width
             min_content_width = [natural_content_width, styled_width_of_single_character].min
             @min_width = padding_left + padding_right + min_content_width
             super
@@ -91,15 +92,16 @@ module Prawn
           @pdf.save_font do
             options = {}
             options[:style] = @text_options[:style] if @text_options[:style]
+            options[:style] ||= @pdf.font.options[:style] if @pdf.font.options[:style]
 
-            @pdf.font(@font || @pdf.font.name, options)
+            @pdf.font(defined?(@font) && @font || @pdf.font.family, options)
 
             yield
           end
         end
 
         def with_text_color
-          if @text_color
+          if defined?(@text_color) && @text_color
             begin
               old_color = @pdf.fill_color || '000000'
               @pdf.fill_color(@text_color)
@@ -111,16 +113,18 @@ module Prawn
             yield
           end
         end
-        
+
         def text_box(extra_options={})
-          if @text_options[:inline_format]
+          if p = @text_options[:inline_format]
+            p = [] unless p.is_a?(Array)
             options = @text_options.dup
             options.delete(:inline_format)
             options.merge!(extra_options)
             options[:document] = @pdf
 
-            array = ::Prawn::Text::Formatted::Parser.to_array(@content)
-            ::Prawn::Text::Formatted::Box.new(array, options)
+            array = @pdf.text_formatter.format(@content, *p)
+            ::Prawn::Text::Formatted::Box.new(array,
+              options.merge(extra_options).merge(:document => @pdf))
           else
             ::Prawn::Text::Box.new(@content, @text_options.merge(extra_options).
                merge(:document => @pdf))
@@ -142,9 +146,7 @@ module Prawn
         #   use whichever character is widest under the current font)
         #
         def styled_width_of_single_character
-          key   = (@text_options[:style] == :bold) ? :bold_char_width : :plain_char_width
-          cache = Thread.current[key] ||= {}
-          cache[@pdf.font] ||= styled_width_of("M")
+          styled_width_of("M")
         end
       end
     end

data/lib/prawn/table/cells.rb

@@ -8,7 +8,6 @@
 
 module Prawn
   class Table
-
     # Selects the given rows (0-based) for styling. Returns a Cells object --
     # see the documentation on Cells for things you can do with cells.
     #
@@ -38,6 +37,8 @@ module Prawn
     #
     class Cells < Array
 
+      # @group Experimental API
+
       # Limits selection to the given row or rows. +row_spec+ can be anything
       # that responds to the === operator selecting a set of 0-based row
       # numbers; most commonly a number or a range.
@@ -46,7 +47,7 @@ module Prawn
       #   table.rows(3..4) # selects rows four and five
       #
       def rows(row_spec)
-        index_cells unless @indexed
+        index_cells unless defined?(@indexed) && @indexed
         row_spec = transform_spec(row_spec, @first_row, @row_count)
         Cells.new(@rows[row_spec] ||= select { |c|
                     row_spec.respond_to?(:include?) ?
@@ -57,7 +58,7 @@ module Prawn
       # Returns the number of rows in the list.
       #
       def row_count
-        index_cells unless @indexed
+        index_cells unless defined?(@indexed) && @indexed
         @row_count
       end
 
@@ -69,10 +70,10 @@ module Prawn
       #   table.columns(3..4) # selects columns four and five
       #
       def columns(col_spec)
-        index_cells unless @indexed
+        index_cells unless defined?(@indexed) && @indexed
         col_spec = transform_spec(col_spec, @first_column, @column_count)
         Cells.new(@columns[col_spec] ||= select { |c|
-                    col_spec.respond_to?(:include?) ? 
+                    col_spec.respond_to?(:include?) ?
                       col_spec.include?(c.column) : col_spec === c.column })
       end
       alias_method :column, :columns
@@ -80,7 +81,7 @@ module Prawn
       # Returns the number of columns in the list.
       #
       def column_count
-        index_cells unless @indexed
+        index_cells unless defined?(@indexed) && @indexed
         @column_count
       end
 
@@ -95,12 +96,12 @@ module Prawn
 
       # Retrieves a cell based on its 0-based row and column. Returns an
       # individual Cell, not a Cells collection.
-      # 
+      #
       #   table.cells[0, 0].content # => "First cell content"
       #
       def [](row, col)
         return nil if empty?
-        index_cells unless @indexed
+        index_cells unless defined?(@indexed) && @indexed
         row_array, col_array = @rows[@first_row + row] || [], @columns[@first_column + col] || []
         if row_array.length < col_array.length
           row_array.find { |c| c.column == @first_column + col }
@@ -116,7 +117,7 @@ module Prawn
         cell.row = row
         cell.column = col
 
-        if @indexed
+        if defined?(@indexed) && @indexed
           (@rows[row]    ||= []) << cell
           (@columns[col] ||= []) << cell
           @first_row    = row if !@first_row    || row < @first_row
@@ -154,7 +155,6 @@ module Prawn
       def width
         widths = {}
         each do |cell|
-          index = cell.column
           per_cell_width = cell.width_ignoring_span.to_f / cell.colspan
           cell.colspan.times do |n|
             widths[cell.column+n] = [widths[cell.column+n], per_cell_width].
@@ -173,7 +173,7 @@ module Prawn
       # Returns maximum width that can contain cells in the set.
       #
       def max_width
-        aggregate_cell_values(:column, :max_width_ignoring_span, :min)
+        aggregate_cell_values(:column, :max_width_ignoring_span, :max)
       end
 
       # Returns the total height of all rows in the selected set.
@@ -195,13 +195,13 @@ module Prawn
       end
 
       protected
-      
+
       # Defers indexing until rows() or columns() is actually called on the
       # Cells object. Without this, we would needlessly index the leaf nodes of
       # the object graph, the ones that are only there to be iterated over.
       #
       # Make sure to call this before using @rows or @columns.
-      # 
+      #
       def index_cells
         @rows = {}
         @columns = {}
@@ -229,9 +229,53 @@ module Prawn
       #
       def aggregate_cell_values(row_or_column, meth, aggregate)
         values = {}
+
+        #calculate values for all cells that do not span accross multiple cells
+        #this ensures that we don't have a problem if the first line includes
+        #a cell that spans across multiple cells
+        each do |cell|
+          #don't take spanned cells
+          if cell.colspan == 1 and cell.class != Prawn::Table::Cell::SpanDummy
+            index = cell.send(row_or_column)
+            values[index] = [values[index], cell.send(meth)].compact.send(aggregate)
+          end
+        end
+
+        #if there are only colspanned or rowspanned cells in a table
+        spanned_width_needs_fixing = true
+
         each do |cell|
           index = cell.send(row_or_column)
-          values[index] = [values[index], cell.send(meth)].compact.send(aggregate)
+          if cell.colspan > 1
+            #calculate current (old) return value before we do anything
+            old_sum = 0
+            cell.colspan.times { |i|
+              old_sum += values[index+i] unless values[index+i].nil?
+            }
+
+            #calculate future return value
+            new_sum = cell.send(meth) * cell.colspan
+
+            #due to float rounding errors we need to ignore a small difference in the new 
+            #and the old sum the same had to be done in
+            #the column_width_calculator#natural_width
+            spanned_width_needs_fixing = ((new_sum - old_sum) > Prawn::FLOAT_PRECISION)
+
+            if spanned_width_needs_fixing
+              #not entirely sure why we need this line, but with it the tests pass
+              values[index] = [values[index], cell.send(meth)].compact.send(aggregate)
+              #overwrite the old values with the new ones, but only if all entries existed
+              entries_exist = true
+              cell.colspan.times { |i| entries_exist = false if values[index+i].nil? }
+              cell.colspan.times { |i|
+                values[index+i] = cell.send(meth) if entries_exist
+              }
+            end
+          else
+            if spanned_width_needs_fixing && cell.class == Prawn::Table::Cell::SpanDummy
+              values[index] = [values[index], cell.send(meth)].compact.send(aggregate)
+            end
+          end
         end
         values.values.inject(0, &:+)
       end