prawn-table-continued 1.0.0.rc1

data/LICENSE

@@ -0,0 +1,56 @@
+Prawn is copyrighted free software produced by Gregory Brown along with 
+community contributions.  See git log for authorship information.
+
+Licensing terms follow:
+
+You can redistribute Prawn and/or modify it under either the terms of the GPLv2
+or GPLv3 (see GPLv2 and GPLv3 files), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+    modifications to Usenet or an equivalent medium, or by allowing
+    the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+    with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+    together with instructions (in the manual page or equivalent)
+    on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+    the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial). 
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

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

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+# image.rb: Table image cells.
+#
+# Copyright September 2010, Brad Ediger. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class Table
+    class Cell
+
+      # @private
+      class Image < Cell
+
+        def initialize(pdf, point, options={})
+          @image_options = {}
+          super
+
+          @pdf_object, @image_info = @pdf.build_image_object(@file)
+          @natural_width, @natural_height = @image_info.calc_image_dimensions(
+            @image_options)
+        end
+
+        def image=(file)
+          @file = file
+        end
+
+        def scale=(s)
+          @image_options[:scale] = s
+        end
+
+        def fit=(f)
+          @image_options[:fit] = f
+        end
+
+        def image_height=(h)
+          @image_options[:height] = h
+        end
+
+        def image_width=(w)
+          @image_options[:width] = w
+        end
+
+        def position=(p)
+          @image_options[:position] = p
+        end
+
+        def vposition=(vp)
+          @image_options[:vposition] = vp
+        end
+
+        def natural_content_width
+          @natural_width
+        end
+
+        def natural_content_height
+          @natural_height
+        end
+
+        # Draw the image on the page.
+        #
+        def draw_content
+          @pdf.embed_image(@pdf_object, @image_info, @image_options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 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
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+# span_dummy.rb: Placeholder for non-master spanned cells.
+#
+# Copyright December 2011, Brad Ediger. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class Table
+    class Cell
+
+      # 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])
+          @master_cell = master_cell
+          @padding = [0, 0, 0, 0]
+        end
+
+        # By default, a span dummy will never increase the height demand.
+        #
+        def natural_content_height
+          0
+        end
+
+        # By default, a span dummy will never increase the width demand.
+        #
+        def natural_content_width
+          0
+        end
+
+        def avg_spanned_min_width
+          @master_cell.avg_spanned_min_width
+        end
+
+        # Dummy cells have nothing to draw.
+        #
+        def draw_borders(pt)
+        end
+
+        # Dummy cells have nothing to draw.
+        #
+        def draw_bounded_content(pt)
+        end
+
+        def padding_right=(val)
+          @master_cell.padding_right = val if rightmost?
+        end
+
+        def padding_bottom=(val)
+          @master_cell.padding_bottom = val if bottommost?
+        end
+
+        def border_right_color=(val)
+          @master_cell.border_right_color = val if rightmost?
+        end
+
+        def border_bottom_color=(val)
+          @master_cell.border_bottom_color = val if bottommost?
+        end
+
+        def border_right_width=(val)
+          @master_cell.border_right_width = val if rightmost?
+        end
+
+        def border_bottom_width=(val)
+          @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?
+        #
+        def rightmost?
+          @column == @master_cell.column + @master_cell.colspan - 1
+        end
+
+        # Are we on the bottom border of the span?
+        #
+        def bottommost?
+          @row == @master_cell.row + @master_cell.rowspan - 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+# subtable.rb: Yo dawg.
+#
+# Copyright January 2010, Brad Ediger. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class Table
+    class Cell
+
+      # A Cell that contains another table.
+      #
+      # @private
+      class Subtable < Cell
+
+        attr_reader :subtable
+
+        def initialize(pdf, point, options={})
+          options[:padding] ||= [0, 0, 0, 0]
+
+          super
+
+          @subtable = options[:content]
+        end
+
+        # Sets the text color of the entire subtable.
+        #
+        def text_color=(color)
+          @subtable.cells.text_color = color
+        end
+
+        # Proxied to subtable.
+        #
+        def natural_content_width
+          @subtable.cells.width
+        end
+
+        # Proxied to subtable.
+        #
+        def min_width
+          @subtable.cells.min_width
+        end
+
+        # Proxied to subtable.
+        #
+        def max_width
+          @subtable.cells.max_width
+        end
+
+        # Proxied to subtable.
+        #
+        def natural_content_height
+          @subtable.cells.height
+        end
+
+        # Draws the subtable.
+        #
+        def draw_content
+          @subtable.draw
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# encoding: utf-8
+
+# text.rb: Text table cells.
+#
+# Copyright December 2009, Gregory Brown and Brad Ediger. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class Table
+    class Cell
+
+      # 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,
+          :rotate, :rotate_around, :leading, :single_line, :skip_encoding,
+          :overflow, :min_font_size]
+
+        TextOptions.each do |option|
+          define_method("#{option}=") { |v| @text_options[option] = v }
+          define_method(option) { @text_options[option] }
+        end
+
+        attr_writer :font, :text_color
+
+        def initialize(pdf, point, options={})
+          @text_options = {}
+          super
+        end
+
+        # Returns the font that will be used to draw this cell.
+        #
+        def font
+          with_font { @pdf.font }
+        end
+
+        # Sets the style of the font in use. Equivalent to the Text::Box
+        # +style+ option, but we already have a style method.
+        #
+        def font_style=(style)
+          @text_options[:style] = style
+        end
+
+        # Returns the width of this text with no wrapping. This will be far off
+        # from the final width if the text is long.
+        #
+        def natural_content_width
+          @natural_content_width ||= [styled_width_of(@content), @pdf.bounds.width].min
+        end
+
+        # Returns the natural height of this block of text, wrapped to the
+        # preset width.
+        #
+        def natural_content_height
+          with_font do
+            b = text_box(:width => spanned_content_width + FPTolerance)
+            b.render(:dry_run => true)
+            b.height + b.line_gap
+          end
+        end
+
+        # Draws the text content into its bounding box.
+        #
+        def draw_content
+          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,
+                       :height => spanned_content_height + FPTolerance,
+                       :at => [0, @pdf.cursor]).render
+            end
+          end
+        end
+
+        def set_width_constraints
+          # 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 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
+          end
+        end
+
+        protected
+
+        def with_font
+          @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(defined?(@font) && @font || @pdf.font.family, options)
+
+            yield
+          end
+        end
+
+        def with_text_color
+          if defined?(@text_color) && @text_color
+            begin
+              old_color = @pdf.fill_color || '000000'
+              @pdf.fill_color(@text_color)
+              yield
+            ensure
+              @pdf.fill_color(old_color)
+            end
+          else
+            yield
+          end
+        end
+
+        def text_box(extra_options={})
+          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 = @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))
+          end
+        end
+
+        # Returns the width of +text+ under the given text options.
+        #
+        def styled_width_of(text)
+          options = @text_options.reject { |k| k == :style }
+          with_font { @pdf.width_of(text, options) }
+        end
+
+        private
+
+        # Returns the greatest possible width of any single character
+        #   under the given text options.
+        # (We use this to determine the minimum width of a table cell)
+        # (Although we currently determine this by measuring "M", it should really
+        #   use whichever character is widest under the current font)
+        #
+        def styled_width_of_single_character
+          styled_width_of("M")
+        end
+      end
+    end
+  end
+end