jyurek-prawn-layout 0.8.4

data/examples/table/fancy_table.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+#
+# Demonstrates various table and cell features.  
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+   
+headers, body = nil, nil  
+
+dir = File.expand_path(File.dirname(__FILE__))
+     
+ruby_18 do        
+  require "fastercsv" 
+  headers, *body = FasterCSV.read("#{dir}/addressbook.csv")   
+end
+
+ruby_19 do            
+  require "csv"
+  headers, *body = CSV.read("#{dir}/addressbook.csv", 
+                      :encoding => "utf-8")
+end
+                                                                                  
+Prawn::Document.generate("fancy_table.pdf", :page_layout => :landscape) do
+  
+  #font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+
+  mask(:y) { table body, :headers      => headers, 
+                         :align        => :center,
+                         :border_style => :grid     }
+
+  table [["This is",   "A Test"    ],
+         [  Prawn::Table::Cell.new( :text => "Of tables",
+                                       :background_color => "ffccff" ),
+          "Drawn Side"], ["By side",   "and stuff" ]], 
+    :position         => 600, 
+    :headers          => ["Col A", "Col B"],
+    :border_width     => 1,
+    :vertical_padding => 5,
+    :horizontal_padding => 3,
+    :font_size        => 10,
+    :row_colors       => :pdf_writer,
+    :column_widths => { 1 => 50 }
+
+  move_down 150
+
+  table [%w[1 2 3],%w[4 5 6],%w[7 8 9]], 
+    :position => :center,
+    :border_width   => 0,
+    :font_size => 40
+
+  cell [500,300],
+    :text => "This free flowing textbox shows how you can use Prawn's "+
+      "cells outside of a table with ease.  Think of a 'cell' as " +
+      "simply a limited purpose bounding box that is meant for laying " +
+      "out blocks of text and optionally placing a border around it",
+    :width => 225, :padding => 10, :border_width => 2
+
+  font_size 24
+
+  cell [50,75], 
+    :text => "This document demonstrates a number of Prawn's table features",
+    :border_style => :no_top, # :all, :no_bottom, :sides
+    :horizontal_padding => 5
+end

data/examples/table/table.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#
+# Generates a couple simple tables, including some UTF-8 text cells.
+# Although this does not show all of the options available to table, the most
+# common are used here.  See fancy_table.rb for a more comprehensive example.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+ 
+Prawn::Document.generate("table.pdf") do 
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  table [["ὕαλον ϕαγεῖν",    "baaar",    "1" ],
+         ["This is","a sample",          "2" ],
+         ["Table",  "dont\ncha\nknow?",  "3" ],
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4123231" ],     
+         [ "It",    "Rules",             "22.5" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules\nwith an iron fist", "x" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ],     
+         [ "It",    "Rules",             "4" ]],     
+
+    :font_size  => 24, 
+    :horizontal_padding => 10,
+    :vertical_padding   => 3,
+    :border_width       => 2,
+    :position           => :center,
+    :headers            => ["Column A","Column B","#"],
+    :align              => {1 => :center},
+    :align_headers      => :center
+                            
+  text "This should appear in the original font size, just below the table"     
+  move_down 10
+  
+  table [[ "Wide", "columns", "streeetch"], 
+         ["are","mighty fine", "streeeeeeeech"]],
+    :column_widths => { 0 => 200, 1 => 200 }, :position => 5
+
+end

data/examples/table/table_alignment.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+#
+# Demonstrates the many controls over alignment and positioning in Prawn
+# tables.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "table_header_align.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'],
+	  ['01/12/2008', 'Jane Doe', '3.2', { :text => '75.5', :align => :center }, '241.60'] ] * 20,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :column_widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid,
+  :align => { 0 => :right, 1 => :left, 2 => :right, 3 => :right, 4 => :right },
+  :align_headers => { 0 => :center, 2 => :left, 3 => :left, 4 => :right }
+end

data/examples/table/table_border_color.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+# Demonstrates how to set the table border color with the :border_color
+# attribute.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "table_border_color.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+          ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 20,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :column_widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid,
+  :border_color => "ff0000"
+end

data/examples/table/table_colspan.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# Demonstrates the use of the :col_span option when using Document#table
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "table_colspan.pdf" do
+  data = [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+           ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 5
+  
+  data << [{:text => 'Total', :colspan => 2, :align => :center}, '37.0', '1002.5', '3833']
+  
+  table data,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :column_widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid
+end

data/examples/table/table_header_color.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# Demonstrates explicitly setting the :header_color rather than inferring
+# it from :row_colors in Document#table
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "table_header_color.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+          ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 20,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :column_widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :grid,
+  :header_color => 'f07878',
+  :header_text_color  => "990000",
+  :row_colors => ["FFCCFF","CCFFCC"]
+end

data/examples/table/table_header_underline.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+#
+# Demonstrates the :underline_header border style for Document#table.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "table_header_underline.pdf" do
+  table [ ['01/01/2008', 'John Doe', '4.2', '125.00', '525.00'], 
+          ['01/12/2008', 'Jane Doe', '3.2', '75.50', '241.60'] ] * 5,
+  :position => :center,
+  :headers => ['Date', 'Employee', 'Hours', 'Rate', 'Total'],
+  :column_widths => { 0 => 75, 1 => 100, 2 => 50, 3 => 50, 4 => 50},
+  :border_style => :underline_header
+end

data/examples/table/table_widths.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+#
+# Generates a couple simple tables, including some UTF-8 text cells.
+# Although this does not show all of the options available to table, the most
+# common are used here.  See fancy_table.rb for a more comprehensive example.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("table_widths.pdf") do 
+
+  data = [
+    %w(one two three four),
+    %w(five six seven eight),
+    %w(nine ten eleven twelve),
+    %w(thirteen fourteen fifteen sixteen),
+    %w(seventeen eighteen nineteen twenty)
+  ]
+  headers = ["Column A","Column B","Column C", "Column D"]
+
+  text "A table with a specified width of the document width (within margins)"
+  move_down 10
+
+  table data,    
+    :position   => :center,
+    :headers    => headers,
+    :width      => margin_box.width
+
+
+  move_down 20
+  text "A table with a specified width of the document width (within margins) and two fixed width columns"
+  move_down 10
+
+  table data,    
+    :position      => :center,
+    :headers       => headers,
+    :width         => margin_box.width,
+    :column_widths => {0 => 70, 1 => 70}
+
+
+  move_down 20
+  text "A table with a specified width of 300"
+  move_down 10
+
+  table data,    
+    :position   => :center,
+    :headers    => headers,
+    :width      => 300
+
+
+  move_down 20
+  text "A table with too much data is automatically limited to the document width"
+  move_down 10
+
+  data << ['some text', 'A long piece of text that will make this cell too wide for the page', 'some more text', 'And more text']
+
+  table data,    
+    :position   => :center,
+    :headers    => headers
+
+end

data/lib/prawn/layout.rb

@@ -0,0 +1,21 @@
+require "prawn/table"
+require "prawn/layout/page"
+require 'prawn/layout/grid'
+
+module Prawn
+  
+ module Errors
+   
+   # This error is raised when table data is malformed
+   #
+   InvalidTableData = Class.new(StandardError)
+
+   # This error is raised when an empty or nil table is rendered
+   #
+   EmptyTable = Class.new(StandardError)
+ end
+
+ module Layout
+
+ end
+end

data/lib/prawn/layout/grid.rb

@@ -0,0 +1,260 @@
+module Prawn
+  class Document
+    
+    # Defines the grid system for a particular document.  Takes the number of 
+    # rows and columns and the width to use for the gutter as the 
+    # keys :rows, :columns, :gutter, :row_gutter, :column_gutter
+    #
+    def define_grid(options = {})
+      @grid = Grid.new(self, options)
+    end
+  
+    # A method that can either be used to access a particular grid on the page 
+    # or work with the grid system directly.
+    #
+    #   @pdf.grid                 # Get the Grid directly
+    #   @pdf.grid([0,1])          # Get the box at [0,1]
+    #   @pdf.grid([0,1], [1,2])   # Get a multi-box spanning from [0,1] to [1,2]
+    #
+    def grid(*args)
+      @boxes ||= {}
+      @boxes[args] ||= if args.empty?
+        @grid
+      else
+        g1, g2 = args
+        if(g1.class == Array && g2.class == Array && 
+          g1.length == 2 && g2.length == 2)
+          multi_box(single_box(*g1), single_box(*g2))
+        else
+          single_box(g1, g2)
+        end
+      end
+    end
+  
+    # A Grid represents the entire grid system of a Page and calculates 
+    # the column width and row height of the base box.
+    class Grid
+      attr_reader :pdf, :columns, :rows, :gutter, :row_gutter, :column_gutter
+      # :nodoc
+      def initialize(pdf, options = {})
+        valid_options = [:columns, :rows, :gutter, :row_gutter, :column_gutter]
+        Prawn.verify_options valid_options, options
+      
+        @pdf = pdf
+        @columns = options[:columns]
+        @rows = options[:rows]
+        set_gutter(options)
+      end
+
+      # Calculates the base width of boxes.
+      def column_width
+        @column_width ||= subdivide(pdf.bounds.width, columns, column_gutter)
+      end
+    
+      # Calculates the base height of boxes.
+      def row_height
+       @row_height ||= subdivide(pdf.bounds.height, rows, row_gutter)
+      end
+
+      # Diagnostic tool to show all of the grids.  Defaults to gray.
+      def show_all(color = "CCCCCC")
+        self.rows.times do |i|
+          self.columns.times do |j|
+            pdf.grid(i,j).show(color)
+          end
+        end
+      end
+
+      private
+      
+      def subdivide(total, num, gutter)
+        (total.to_f - (gutter * (num - 1).to_f)) / num.to_f
+      end
+      
+      def set_gutter(options)
+        if options.has_key?(:gutter)
+          @gutter = options[:gutter].to_f
+          @row_gutter, @column_gutter = @gutter, @gutter
+        else
+          @row_gutter    = options[:row_gutter].to_f
+          @column_gutter = options[:column_gutter].to_f
+          @gutter = 0
+        end
+      end
+    end
+  
+    # A Box is a class that represents a bounded area of a page.  
+    # A Grid object has methods that allow easy access to the coordinates of 
+    # its corners, which can be plugged into most existing prawnmethods.
+    #
+    class Box
+      attr_reader :pdf
+    
+      def initialize(pdf, i, j)
+        @pdf = pdf
+        @i = i
+        @j = j
+      end
+    
+      # Mostly diagnostic method that outputs the name of a box as 
+      # col_num, row_num
+      #
+      def name
+        "#{@i.to_s},#{@j.to_s}"
+      end
+      
+      # :nodoc
+      def total_height
+        pdf.bounds.height.to_f
+      end
+      
+      # Width of a box
+      def width
+        grid.column_width.to_f
+      end
+    
+      # Height of a box
+      def height
+        grid.row_height.to_f
+      end
+      
+      # Width of the gutter
+      def gutter
+        grid.gutter.to_f
+      end
+      
+      # x-coordinate of left side
+      def left
+        @left ||= (width + grid.column_gutter) * @j.to_f
+      end
+    
+      # x-coordinate of right side 
+      def right
+        @right ||= left + width
+      end
+    
+      # y-coordinate of the top
+      def top
+        @top ||= total_height - ((height + grid.row_gutter) * @i.to_f)
+      end
+    
+      # y-coordinate of the bottom
+      def bottom
+        @bottom ||= top - height
+      end
+    
+      # x,y coordinates of top left corner
+      def top_left
+        [left, top]
+      end
+    
+      # x,y coordinates of top right corner    
+      def top_right
+        [right, top]
+      end
+    
+      # x,y coordinates of bottom left corner
+      def bottom_left
+        [left, bottom]
+      end
+    
+      # x,y coordinates of bottom right corner
+      def bottom_right
+        [right, bottom]
+      end
+    
+      # Creates a standard bounding box based on the grid box.
+      def bounding_box(&blk)
+        pdf.bounding_box(top_left, :width => width, :height => height, &blk)
+      end
+    
+      # Diagnostic method
+      def show(grid_color = "CCCCCC")
+        self.bounding_box do
+          original_stroke_color = pdf.stroke_color
+
+          pdf.stroke_color = grid_color
+          pdf.text self.name
+          pdf.stroke_bounds
+          
+          pdf.stroke_color = original_stroke_color
+        end
+      end
+    
+      private
+      def grid
+        pdf.grid
+      end
+    end
+  
+    # A MultiBox is specified by 2 Boxes and spans the areas between.
+    class MultiBox < Box
+      def initialize(pdf, b1, b2)
+        @pdf = pdf
+        @bs = [b1, b2]
+      end
+    
+      def name
+        @bs.map {|b| b.name}.join(":")
+      end
+    
+      def total_height
+        @bs[0].total_height
+      end
+
+      def width
+        right_box.right - left_box.left
+      end
+    
+      def height
+        top_box.top - bottom_box.bottom
+      end
+    
+      def gutter
+        @bs[0].gutter
+      end
+    
+      def left
+        left_box.left
+      end
+    
+      def right
+        right_box.right
+      end
+    
+      def top
+        top_box.top
+      end
+    
+      def bottom
+        bottom_box.bottom
+      end
+    
+      private
+      def left_box
+        @left_box ||= @bs.min {|a,b| a.left <=> b.left}
+      end
+    
+      def right_box
+        @right_box ||= @bs.max {|a,b| a.right <=> b.right}
+      end
+    
+      def top_box
+        @top_box ||= @bs.max {|a,b| a.top <=> b.top}
+      end
+    
+      def bottom_box
+        @bottom_box ||= @bs.min {|a,b| a.bottom <=> b.bottom}
+      end
+    end
+  
+    private
+    def single_box(i, j)
+      Box.new(self, i, j)
+    end
+  
+    def multi_box(b1, b2)
+      MultiBox.new(self, b1, b2)
+    end
+  end
+end