thousand_island 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 389fb55f938dbc9612ecbdab028eb4c6f7a1ba6b
-  data.tar.gz: ef8e4cb13f7628a49c8f61af335686b6bf9596e6
+  metadata.gz: 7c954cf1458e611ac4249a9b3a39d8136db0cf14
+  data.tar.gz: 02b295ba89ca8e95219343ef9414ef648752c4d7
 SHA512:
-  metadata.gz: a720ae6858b1a2716f90b110aa5686023302add7de08f1e0929ca1e0da7b98877ac1c8d58dd6d10c7e0ea07530da3a3c5798fd9359dc64d9863e9bd2a9ba17a5
-  data.tar.gz: 12528531c5d4239969608d7ca0e0d6480494d84234293515a3ac587e16996b780ae2cd28fed86d85098209f48e58f1c3d8eed77ad275db5ab3939e0184f25355
+  metadata.gz: 8e616580434d106f2629097376c9b97eb602d07e0cd47bd22ca4e081834d48241d025ac9c75569f6aad7d9e109343c6634a95bdcb0ce65656f34669e19234ce9
+  data.tar.gz: 5a010d76d9bdd237127e6efd91937b218021b41dd358f0aba9b5d2a8aa3c98f4276b50fc56a63187c5dadbc6758ae694f57e29136c9fe9ed8dfd8ed41f62bb12

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-- 2.1.2
+- 2.1.4
 - 2.0.0
 - 1.9.3
 script: bundle exec rspec spec

data/README.md

@@ -1,7 +1,7 @@
 # Thousand Island
-### Dressing for Prawn
+**Dressing for Prawn**
 
-[![GitHub version](https://badge.fury.io/gh/colinweight%2Fthousand_island.svg)](http://badge.fury.io/gh/colinweight%2Fthousand_island) [![Code Climate](https://codeclimate.com/github/colinweight/thousand_island/badges/gpa.svg)](https://codeclimate.com/github/colinweight/thousand_island) [![Test Coverage](https://codeclimate.com/github/colinweight/thousand_island/badges/coverage.svg)](https://codeclimate.com/github/colinweight/thousand_island) [![Build Status](https://travis-ci.org/colinweight/thousand_island.svg?branch=master)](https://travis-ci.org/colinweight/thousand_island) [![Inline docs](http://inch-ci.org/github/colinweight/thousand_island.png?branch=master)](http://inch-ci.org/github/colinweight/thousand_island)
+[![Gem Version](https://badge.fury.io/rb/thousand_island.svg)](http://badge.fury.io/rb/thousand_island) [![Code Climate](https://codeclimate.com/github/colinweight/thousand_island/badges/gpa.svg)](https://codeclimate.com/github/colinweight/thousand_island) [![Test Coverage](https://codeclimate.com/github/colinweight/thousand_island/badges/coverage.svg)](https://codeclimate.com/github/colinweight/thousand_island) [![Build Status](https://travis-ci.org/colinweight/thousand_island.svg?branch=master)](https://travis-ci.org/colinweight/thousand_island) [![Inline docs](http://inch-ci.org/github/colinweight/thousand_island.png?branch=master)](http://inch-ci.org/github/colinweight/thousand_island)
 
 
 [Prawn](https://github.com/prawnpdf/prawn) is awesome. It has some amazing functionality, and you can get anything that's in your head onto a PDF document with some Ruby code. For me though, as wonderful as that is, I normally only need a repeating header and footer, and then some text and maybe a table in between them. This is where **Thousand Island** comes in. A few simple commands should get you set up with a template that you can use application wide, and then all you need to worry about is getting the right content into the document.
@@ -229,7 +229,7 @@ def show
 If your controller for getting the data for a PDF is that simple, then you're pretty lucky. Normally we're going to want a PDF file to render a few things at once, so you might build a service object that formats the data, and use as follows:
 
 ```ruby
-def show
+  def show
     respond_to do |format|
       format.html do
         @thing_for_html_view = Thing.find(params[:id])
@@ -255,6 +255,87 @@ These are only suggestions, as you can probably tell there is nothing tying you
 ```
 However, that kind of logic seems beyond the scope of the Builder, and should proabably be in the consumer of your Builder class, rather than the builder itself.
 
+## Tables
+
+Quite often a pdf will need to render tabular data. It makes sense if there is a common table styling for all PDFs in your application (although it's not compulsory!). Thousand Island has a Table class, and a TableStyle class.
+
+> Note: **Thousand Island** has been designed to handle the most common scenarios, and therefore cannot cover every possibility and still keep it simple. If there's anything you can't do with a ThousandIsland::Table, you may need to use Prawn's standard table rendering. There's nothing stopping your Builder rendering a table without using any of the Table implementation in **Thousand Island**. Check out the [Prawn Table Manual](http://prawnpdf.org/prawn-table-manual.pdf) for the full capabilities.
+
+### Creating a Table
+There are three main components of a table, header body and footer
+#### Header
+Header rows are optional. By doing nothing, your table will have no header row/s. To have a header in your table, you have several options:
+```ruby
+  # Straightforward single row, no builder logic required
+  header_rows = [['Column One', 'Column Two', 'Column Three']]
+    
+  # Build gradually (You can use Prawn native syntax for span and formatting)
+  header_rows << [{content: 'First Two Columns', colspan: 2}, 'Third']
+  header_rows << ['Column One', 'Column Two', 'Column Three']
+    
+```
+
+By default **Thousand Island** takes all the rows in the <code>header_rows</code> and formats them as a repeating header. If you don't want a header, don't put anything in <code>header_rows</code>. If you don't want the header to repeat across pages, then set:
+```ruby
+  header_repeat: false
+```
+in either the <code>settings</code> method (which returns a hash specific to this Table class) or by setting it in you TableSettings custom class.
+
+#### Body
+Similar to <code>header_rows</code>, <code>body_rows</code> can be set in one go or build gradually. Given the nature of the content of a table, it is more likely you'll have a method in that iterates through a collection of objects and builds the table according to the requirements.
+The way you build the Array of nested Array for the body is up to you. Three suggestions:
+
+- **Simple Data**: Simply set the <code>body_rows</code> as an Array of Arrays anywhere that's convenient
+- **Slightly Complex**: Iterate over a collection craeting and Array of "cellable" objects for Prawn, and add to <code>body_rows</code> as you go (<code>body_rows << newly_built_row</code>). You can do this in your Builder and pass it to the Table, or pass objects from your Builder to your Table so that the Table can deal with it.
+- **Complex Real Life**: Create a ServiceObject that knows everything it needs to know about how to build the rows. In some situations, a table row might need to represent multiple objects and the logic may be complex. Keeping the row building away from your Builder or Table classess keeps things simple.
+
+#### Footer
+Works in the same way as the header, except you use <code>footer_rows</code>. The only difference is that the footer does not repeat.
+
+#### Table Options
+A PrawnTable is very configurable. The goal of the Table component of **Thousand Island** is to make the configuration reusable throughout your application. There is a TableSettings class (see below) that you can subclass and use as a configuration object, but you can also override those settings for a specific table by setting a compatible Hash in your Table class like so:
+```ruby
+  def settings
+    {
+      header_repeat: false
+    }
+  end
+```
+
+### Table Settings
+You can use the defaults, or create your own <code>TableSettings</code> class as below:
+```ruby
+  class MyTableSettings
+    def table_options
+      {...}
+    end
+  end
+```
+All the settings in the <code>table_options</code> Hash will be merged with the defaults and made available to any Table that uses your custom TableSettings class.
+
+To get one of your Table subclasses to use your custom TableSettings subclass, do the following:
+```ruby
+  class MyTable < ThousandIsland::Table
+    uses_settings MyTableSettings
+    
+    ...
+    
+  end
+```
+
+### Using Tables in your Builder
+Anywhere in your Builder, you can do:
+```ruby
+  table = table_with MyTable
+```
+This initialises the Table class and gets it ready to build the body rows. You can then use it where appropriate to render the table in your PDF document:
+```ruby
+  table.draw
+  
+  # To override any of the settins either in the table or the TableSettings being used, just pass them as a Hash to the draw method:
+  table.draw(header_repeat: false)
+```
+
 ## Default Styles
 Out of the box, ThousandIsland gives you some generic styles with default values. Override any of the values in your custom Stylesheet, or your Template. Create your own entirely new style in either of those places too, and get the magic method for free.
 
@@ -262,94 +343,117 @@ The default styles are:
 ##### body
 ```ruby
 {
-  :size => 10, # Inherited from default_style
-  :style => :normal, # Inherited from default_style
-  :align => :left, # Inherited from default_style
-  :leading => 1, # Inherited from default_style
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 10, # Inherited from default_style
+  style: :normal, # Inherited from default_style
+  align: :left, # Inherited from default_style
+  leading: 1, # Inherited from default_style
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### h1
 ```ruby
 {
-  :size => 18, # Calcuated as 1.8 * default_style[:size]
-  :style => :bold,
-  :align => :left, # Inherited from default_style
-  :leading => 8,
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 18, # Calcuated as 1.8 * default_style[:size]
+  style: :bold,
+  align: :left, # Inherited from default_style
+  leading: 8,
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### h2
 ```ruby
 {
-  :size => 15, # Calcuated as 1.5 * default_style[:size]
-  :style => :bold,
-  :align => :left, # Inherited from default_style
-  :leading => 4,
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 15, # Calcuated as 1.5 * default_style[:size]
+  style: :bold,
+  align: :left, # Inherited from default_style
+  leading: 4,
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### h3
 ```ruby
 {
-  :size => 14, # Calcuated as 1.4 * default_style[:size]
-  :style => :bold,
-  :align => :left, # Inherited from default_style
-  :leading => 4,
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 14, # Calcuated as 1.4 * default_style[:size]
+  style: :bold,
+  align: :left, # Inherited from default_style
+  leading: 4,
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### h4
 ```ruby
 {
-  :size => 11, # Calcuated as 1.1 * default_style[:size]
-  :style => :bold_italic,
-  :align => :left, # Inherited from default_style
-  :leading => 4,
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 11, # Calcuated as 1.1 * default_style[:size]
+  style: :bold_italic,
+  align: :left, # Inherited from default_style
+  leading: 4,
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### h5
 ```ruby
 {
-  :size => 10, # Calcuated as 1 * default_style[:size]
-  :style => :normal, # Inherited from default_style
-  :align => :left, # Inherited from default_style
-  :leading => 4,
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 10, # Calcuated as 1 * default_style[:size]
+  style: :normal, # Inherited from default_style
+  align: :left, # Inherited from default_style
+  leading: 4,
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### h6
 ```ruby
 {
-  :size => 8.5, # Calcuated as 0.85 * default_style[:size]
-  :style => :italic,
-  :align => :left, # Inherited from default_style
-  :leading => 4,
-  :inline_format => true, # Inherited from default_style
-  :color => "000000" # Inherited from default_style
+  size: 8.5, # Calcuated as 0.85 * default_style[:size]
+  style: :italic,
+  align: :left, # Inherited from default_style
+  leading: 4,
+  inline_format: true, # Inherited from default_style
+  color: "000000" # Inherited from default_style
 }
 ```
 ##### footer
 ```ruby
 {
-  :size => 0.8, # Calcuated as 0.8 * default_style[:size]
-  :style => :normal,
-  :align => :left, # Inherited from default_style
-  :leading => 1, # Inherited from default_style
-  :inline_format => true, # Inherited from default_style
-  :color => "666666"
+  size: 0.8, # Calcuated as 0.8 * default_style[:size]
+  style: :normal,
+  align: :left, # Inherited from default_style
+  leading: 1, # Inherited from default_style
+  inline_format: true, # Inherited from default_style
+  color: "666666"
 }
 ```
+## Default Table Settings
+Override any of these settings (or the nested settings) using the following techniques (in order of precedence):
 
+- Builder: <code>table.draw(_your_hash_)</code>
+- Table class: <code>settings</code> method that returns a hash
+- TableSettings class: <code>table_settings</code> method that returns a hash
+
+### The full list of defaults
+```ruby
+{
+  position: :center,
+  width: pdf.bounds.width,   # Equates to full page width
+  cell_style: {
+    borders: [:top, :bottom],
+    border_width: 0.5,
+    inline_format: true,
+    size: 10
+  },
+  header_repeat: true,
+  header_format: {
+    align: :center,
+    font_style: :bold
+  }
+}
+```
 ## To come...
-- Easy (and repeatable) Table formatting
 - Easy list rendering and styling (including nested lists)
 - More flexibility in the Footer layout
 - (Possibly) Command line functions to create common subclass files 

data/lib/thousand_island.rb

@@ -1,19 +1,22 @@
-require "thousand_island/version"
+require 'thousand_island/version'
 
-require "prawn"
+require 'prawn'
+require 'prawn/table'
 
-require "thousand_island/style_sheet"
-require "thousand_island/template"
-require "thousand_island/builder"
+require 'thousand_island/style_sheet'
+require 'thousand_island/template'
+require 'thousand_island/builder'
+require 'thousand_island/table'
+require 'thousand_island/table_settings'
 
-require "thousand_island/components"
-require "thousand_island/components/base"
-require "thousand_island/components/header"
-require "thousand_island/components/footer"
-require "thousand_island/components/body"
+require 'thousand_island/components'
+require 'thousand_island/components/base'
+require 'thousand_island/components/header'
+require 'thousand_island/components/footer'
+require 'thousand_island/components/body'
 
-require "thousand_island/utilities/utilities"
-require "thousand_island/utilities/style_hash"
+require 'thousand_island/utilities/utilities'
+require 'thousand_island/utilities/style_hash'
 
 module ThousandIsland
   Error = Class.new(StandardError)

data/lib/thousand_island/builder.rb

@@ -107,6 +107,10 @@ module ThousandIsland
       {}
     end
 
+    def table_with(klass)
+      klass.new(pdf)
+    end
+
   private
 
     def draw_header

data/lib/thousand_island/components/footer.rb

@@ -36,9 +36,7 @@ module ThousandIsland
       def col2
         start = col1_width
         pdf.bounding_box([start, box_height], width: col2_width, height: box_height) do
-          options[:style].each do |k,v|
-            pdf.send(k, v) if pdf.respond_to?(k)
-          end if options[:style]
+          inject_style
           yield if block_given?
         end
       end
@@ -62,6 +60,10 @@ module ThousandIsland
         options[:repeated]
       end
 
+      def inject_style
+        options[:style].each { |k,v| pdf.send(k, v) if pdf.respond_to?(k) } if options[:style]
+      end
+
       def self.defaults
         {
           height: 33,

data/lib/thousand_island/table.rb

@@ -0,0 +1,119 @@
+module ThousandIsland
+  # The Table class can be used to set the definition of your table, such as
+  # format and headings. You then inject the data from your Builder so that
+  # it can be rendered.
+  # You can declare a TableSettings class that you wish to use, otherwise
+  # the default will be used. To set a Table Setting class, add the following
+  # in your class body:
+  #
+  #   uses_style MyTableSettings
+  #
+  class Table
+
+    attr_reader :pdf
+    attr_accessor :table_options
+
+    class << self
+      attr_writer :table_settings_klass
+
+      def table_settings_klass
+        @table_settings_klass ||= TableSettings
+      end
+
+      def uses_settings(klass)
+        self.table_settings_klass = klass
+      end
+    end
+
+    def initialize(pdf)
+      @pdf = pdf
+      @table_options = {}
+    end
+
+    def settings
+      {}
+    end
+
+    def draw(options={})
+
+      @table_options = merged_options(options)
+
+      table_options[:header] = prawn_header_setting
+
+      pdf.table(table_data, options_for_prawn) do |t|
+        t.row(0..num_header_rows - 1).font_style = table_options[:header_format][:font_style] unless header_rows.empty?
+        t.row(0..num_header_rows - 1).align = table_options[:header_format][:align] unless header_rows.empty?
+        t.row(-1..(0 - num_footer_rows)).font_style = :bold unless footer_rows.empty?
+        yield(t) if block_given?
+      end
+    end
+
+    def body_rows=(row_array)
+      raise ArgumentError.new('table_rows must be an array') unless row_array.is_a?(Array)
+      @body_rows = row_array
+    end
+
+    def body_rows
+      @body_rows ||= []
+    end
+
+    def header_rows=(row_array)
+      raise ArgumentError.new('header_cells must be an array') unless row_array.is_a?(Array)
+      @header_rows = row_array
+    end
+
+    def header_rows
+      @header_rows ||= []
+    end
+
+    def footer_rows=(row_array)
+      raise ArgumentError.new('footer_rows must be an array') unless row_array.is_a?(Array)
+      @footer_rows = row_array
+    end
+
+    def footer_rows
+      @footer_rows ||= []
+    end
+
+
+    private
+
+    def table_data
+      data = body_rows
+      header_rows.reverse_each{ |row| data.unshift(row) }
+      footer_rows.each{ |row| data << row }
+      data
+    end
+
+    def num_footer_rows
+      footer_rows.size
+    end
+
+    def num_header_rows
+      header_rows.size
+    end
+
+
+    def prawn_header_setting
+      return false if header_rows.empty? || table_options[:header_repeat] == false
+      header_rows.size
+    end
+
+    def options_for_prawn
+      table_options.select{ |k| [:cell_style, :header, :column_widths, :position, :width, :row_colors, ].include?(k)}
+    end
+
+    def merged_options(options={})
+      deep_merger.merge_options(options, settings, table_settings.settings)
+    end
+
+    def table_settings
+      @table_settings||= self.class.table_settings_klass.new(pdf, settings)
+    end
+
+    def deep_merger
+      @deep_merger ||= Utilities::DeepMerge::TableOptions
+    end
+
+  end
+end

data/lib/thousand_island/table_settings.rb

@@ -0,0 +1,58 @@
+module ThousandIsland
+  # The TableSettings class is where you set up styling rules that can be used by your Table class. You may create a class that inherits from TableSettings, and then use it in any of your tables. You can sub-class your TableStyles so you may define a master style for your app, but then have derived styles for special situations.
+  #
+  class TableSettings
+
+    attr_reader :pdf, :overrides
+
+    def initialize(pdf, overrides={})
+      @pdf = pdf
+      @overrides = overrides
+    end
+
+    #@TODO override this one!!! Do the docs...
+    def table_settings
+      {}
+    end
+
+    def settings
+      default_options.merge(table_settings.merge(overrides))
+    end
+
+    def default_options
+      {
+          width: pdf.bounds.width,
+          cell_style: cell_styles,
+          position: :center,
+          header_format: header_format,
+          header_repeat: true,
+          footer_format: footer_format
+      }
+    end
+
+    def cell_styles
+      {
+          borders: [:top, :bottom],
+          border_width: 0.5,
+          inline_format: true,
+          size: 10
+      }
+    end
+
+    def header_format
+      {
+          align: :center,
+          font_style: :bold
+      }
+
+    end
+
+    def footer_format
+      {
+          font_style: :bold
+      }
+    end
+
+
+  end
+end

data/lib/thousand_island/template.rb

@@ -181,13 +181,13 @@ module ThousandIsland
     end
 
     def header_space
-      return (pdf_options[:header][:height] + pdf_options[:header][:bottom_padding]) if pdf_options[:header][:render]
-      0
+      return 0 unless pdf_options[:header][:render]
+      pdf_options[:header][:height] + pdf_options[:header][:bottom_padding]
     end
 
     def footer_space
-      return (pdf_options[:footer][:height] + pdf_options[:footer][:top_padding]) if pdf_options[:footer][:render]
-      0
+      return 0 unless pdf_options[:footer][:render]
+      pdf_options[:footer][:height] + pdf_options[:footer][:top_padding]
     end
 
 
@@ -237,7 +237,7 @@ module ThousandIsland
 
 
     def deep_merger
-      @deep_merger ||= Utilities::DeepMerge
+      @deep_merger ||= Utilities::DeepMerge::TemplateOptions
     end
 
     # Called by method missing when a style is supplied with text, ie: h1 'Header'

data/lib/thousand_island/utilities/utilities.rb

@@ -3,53 +3,85 @@ module ThousandIsland
 
     module DeepMerge
 
-      #Take a number of hashes and merge them into one, respecting
-      # the structure and nesting according to the pdf options hash.
-      # Hashes work in order of precedence, the first in the array
-      # overrides, the second, etc.
-      #
-      # @param hashes [*Hash] A number of hashes to merge, in the order of precedence
-      #
-      # @return [Hash] the merged values
-      def self.merge_options(*hashes)
-        hashes.reverse!
+      def merge_for_key_and_nested_keys(key, keys, *hashes)
+        temp = {}
         merged = {}
-        footer = merge_footer(*hashes)
-        header = merge_header(*hashes)
-        body = merge_body(*hashes)
         hashes.each do |h|
-          merged.merge!(h)
+          keys.each do |k|
+            temp[k] = {} unless temp.has_key? k
+            temp[k].merge!(h[key][k]) if h[key] && h[key][k]
+          end
+          merged.merge!(h[key]) if h[key]
         end
-        merged[:footer] = footer
-        merged[:header] = header
-        merged[:body] = body
-        merged
+        merged.merge(temp)
       end
 
-      def self.merge_footer(*hashes)
-        keys = [:numbering_options, :style]
-        merge_for_key_and_nested_keys(:footer, keys, *hashes)
-      end
+      module TemplateOptions
+        extend ::ThousandIsland::Utilities::DeepMerge
 
-      def self.merge_header(*hashes)
-        merge_for_key_and_nested_keys(:header, [], *hashes)
-      end
+        # Take a number of hashes used for Template Options and merge them
+        # into one, respecting the structure and nesting according to
+        # the pdf options hash. Hashes work in order of precedence, the
+        # first in the array overrides, the second, etc.
+        #
+        # @param hashes [*Hash] A number of hashes to merge, in the order of precedence
+        #
+        # @return [Hash] the merged values
+        def self.merge_options(*hashes)
+          hashes.reverse!
+          merged = {}
+          footer = merge_footer(*hashes)
+          header = merge_header(*hashes)
+          body = merge_body(*hashes)
+          hashes.each do |h|
+            merged.merge!(h)
+          end
+          merged[:footer] = footer
+          merged[:header] = header
+          merged[:body] = body
+          merged
+        end
+
+        def self.merge_footer(*hashes)
+          keys = [:numbering_options, :style]
+          merge_for_key_and_nested_keys(:footer, keys, *hashes)
+        end
 
-      def self.merge_body(*hashes)
-        merge_for_key_and_nested_keys(:body, [], *hashes)
+        def self.merge_header(*hashes)
+          merge_for_key_and_nested_keys(:header, [], *hashes)
+        end
+
+        def self.merge_body(*hashes)
+          merge_for_key_and_nested_keys(:body, [], *hashes)
+        end
       end
 
-      def self.merge_for_key_and_nested_keys(key, keys, *hashes)
-        temp = {}
-        merged = {}
-        hashes.each do |h|
-          keys.each do |k|
-            temp[k] = {} unless temp.has_key? k
-            temp[k].merge!(h[key][k]) if h[key] && h[key][k]
+      module TableOptions
+        extend ::ThousandIsland::Utilities::DeepMerge
+
+        #Take a number of hashes used for Table Options and merge them
+        # into one, respecting the structure and nesting according to
+        # the pdf options hash. Hashes work in order of precedence, the
+        # first in the array overrides, the second, etc.
+        #
+        # @param hashes [*Hash] A number of hashes to merge, in the order of precedence
+        #
+        # @return [Hash] the merged values
+        def self.merge_options(*hashes)
+          hashes.reverse!
+          merged = {}
+          footer_format = merge_for_key_and_nested_keys(:footer_format, [], *hashes)
+          header_format = merge_for_key_and_nested_keys(:header_format, [], *hashes)
+          cell_style = merge_for_key_and_nested_keys(:cell_style, [], *hashes)
+          hashes.each do |h|
+            merged.merge!(h)
           end
-          merged.merge!(h[key]) if h[key]
+          merged[:footer_format] = footer_format
+          merged[:header_format] = header_format
+          merged[:cell_style] = cell_style
+          merged
         end
-        merged.merge(temp)
+
       end
 
     end

data/lib/thousand_island/version.rb

@@ -1,3 +1,3 @@
 module ThousandIsland
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
+require 'pdf/inspector'
 require 'thousand_island'
 
 RSpec.configure do |config|

data/spec/thousand_island/builder_spec.rb

@@ -29,14 +29,10 @@ module ThousandIsland
 
         before :each do
           allow(builder).to receive(:template) { template }
-          # klass.send(:define_method, :header_content, ->{})
-          # klass.send(:define_method, :body_content, ->{})
-          # klass.send(:define_method, :footer_content, ->{})
         end
         context 'exists' do
 
           it 'header_content' do
-            # allow(builder).to receive(:header_content)
             expect(builder).to receive(:header_content)
             builder.send(:draw_header)
           end
@@ -101,6 +97,12 @@ module ThousandIsland
           end
         end
       end
+
+      it 'table_with instantiates the class' do
+        dummy_table = double
+        expect(dummy_table).to receive(:new).with(subject.pdf)
+        subject.table_with dummy_table
+      end
     end
   end
 end

data/spec/thousand_island/table_spec.rb

@@ -0,0 +1,107 @@
+module ThousandIsland
+  describe Table do
+    let(:pdf) { Prawn::Document.new({:page_size => "A4", :page_layout => :portrait}) }
+
+    subject { described_class.new(pdf) }
+
+    context 'when TableStyle is not set' do
+      it 'sets default style' do
+        expect(described_class.table_settings_klass).to eq(TableSettings)
+      end
+    end
+
+    context 'when TableStyle is set' do
+      it 'is used' do
+        klass = described_class.dup
+        Dummy = Class.new
+        klass.uses_settings(Dummy)
+        expect(klass.table_settings_klass).to eq(Dummy)
+      end
+    end
+
+    describe '#header_rows' do
+      it 'defaults to an empty array' do
+        expect(subject.header_rows).to eq([])
+      end
+
+      it 'forces array' do
+        expect{ subject.header_rows = 'not an array' }.to raise_error(ArgumentError)
+      end
+
+      it 'can be set with an array' do
+        expect{ subject.header_rows = %w'it is an array' }.to_not raise_error
+      end
+    end
+
+    describe '#body_rows' do
+      it 'defaults to an empty array' do
+        expect(subject.body_rows).to eq([])
+      end
+
+      it 'forces array' do
+        expect{ subject.body_rows = 'not an array' }.to raise_error(ArgumentError)
+      end
+
+      it 'can be set with an array' do
+        expect{ subject.body_rows = %w'it is an array' }.to_not raise_error
+      end
+    end
+
+    describe '#footer_rows' do
+      it 'defaults to an empty array' do
+        expect(subject.footer_rows).to eq([])
+      end
+
+      it 'forces array' do
+        expect{ subject.footer_rows = 'not an array' }.to raise_error(ArgumentError)
+      end
+
+      it 'can be set with an array' do
+        expect{ subject.footer_rows = %w'it is an array' }.to_not raise_error
+      end
+    end
+
+    describe 'header' do
+      describe 'repeats' do
+        let(:body_rows) { [] }
+        let(:header_rows) { [[' ', { content: "Prefix", colspan: 2 } ], ['The Number', 'As', 'Bs'] ] }
+
+        before do
+          (1..50).each{ |n| body_rows.push( ["#{n}", "A#{n}", "B#{n}"] ) }
+          subject.body_rows = body_rows
+        end
+
+        it 'all rows' do
+          subject.header_rows = header_rows
+          draw_the_table
+          output = PDF::Inspector::Page.analyze(subject.pdf.render)
+          expect(output.pages[0][:strings][0..4]).to eq(output.pages[1][:strings][0..4])
+        end
+
+        it 'unless specified not to' do
+          subject.header_rows = header_rows
+          draw_the_table({header_repeat: false})
+          output = PDF::Inspector::Page.analyze(subject.pdf.render)
+          expect(output.pages[0][:strings][0..4]).to_not eq(output.pages[1][:strings][0..4])
+        end
+      end
+    end
+
+    private
+
+    def draw_the_table(opts={})
+      subject.pdf.bounding_box( [0, std_doc_height], height: std_doc_height, width: std_doc_width ) do
+        subject.draw(opts)
+      end
+    end
+
+    def std_doc_height
+      840
+    end
+
+    def std_doc_width
+      595
+    end
+
+  end
+end

data/spec/thousand_island/template_spec.rb

@@ -8,7 +8,7 @@ module ThousandIsland
         options = { op_one: 1, op_two: 2 }
         defaults = subject.send(:defaults)
         component_defaults = subject.send(:component_defaults)
-        deep_merger = ThousandIsland::Utilities::DeepMerge
+        deep_merger = ThousandIsland::Utilities::DeepMerge::TemplateOptions
         expect(deep_merger).to receive(:merge_options).with(options, [], defaults, component_defaults)
         subject.send(:setup_document_options, options)
       end
@@ -16,7 +16,6 @@ module ThousandIsland
       it 'method missing' do
         expect{ subject.made_up_method }.to raise_error(NoMethodError)
       end
-
     end
 
     context 'Style Sheet' do

data/spec/thousand_island/utilities/utilities_spec.rb

@@ -1,60 +1,44 @@
 module ThousandIsland
   module Utilities
+    module DeepMerge
 
-    describe DeepMerge do
+      describe TemplateOptions do
 
-      let(:default) {{
-        header:{
-          height: 33,
-          repeated: true,
-        },
-        footer: {
-          height: 33,
-          repeated: true,
-          numbering_options: {
-            align: :right,
-            start_count_at: 1,
-          },
-          number_pages: true,
-          numbering_string: '<page>',
-          style: {
-            font_size: 23
+
+        let(:default) {{
+          header:{
+            height: 33,
+            repeated: true,
           },
-        },
-      }}
-      let(:options) {{
-        header: {
+          footer: {
             height: 33,
-            repeated: false,
-        },
-        footer: {
-          height: 40,
-          repeated: true,
-          numbering_options: {
-            align: :right,
-            start_count_at: 2,
+            repeated: true,
+            numbering_options: {
+              align: :right,
+              start_count_at: 1,
+            },
+            number_pages: true,
+            numbering_string: '<page>',
+            style: {
+              font_size: 23
+            },
           },
-        },
-      }}
-      let(:over) {{
-        header: {
-          height: 50,
-          repeated: true,
-        },
-        footer: {
-          height: 50,
-          repeated: false,
-          numbering_options: {
-            align: :left,
+        }}
+        let(:options) {{
+          header: {
+              height: 33,
+              repeated: false,
           },
-          style: {
-            font_size: 5
+          footer: {
+            height: 40,
+            repeated: true,
+            numbering_options: {
+              align: :right,
+              start_count_at: 2,
+            },
           },
-        },
-      }}
-
-      it 'deep merges the hashes intelligently' do
-        expected = {
+        }}
+        let(:over) {{
           header: {
             height: 50,
             repeated: true,
@@ -64,18 +48,96 @@ module ThousandIsland
             repeated: false,
             numbering_options: {
               align: :left,
-              start_count_at: 2,
             },
-            number_pages: true,
-            numbering_string: '<page>',
             style: {
               font_size: 5
             },
           },
-          body: {},
-        }
-        final = described_class.merge_options(over, options, default)
-        expect(final).to eq(expected)
+        }}
+
+        it 'deep merges the hashes intelligently' do
+          expected = {
+            header: {
+              height: 50,
+              repeated: true,
+            },
+            footer: {
+              height: 50,
+              repeated: false,
+              numbering_options: {
+                align: :left,
+                start_count_at: 2,
+              },
+              number_pages: true,
+              numbering_string: '<page>',
+              style: {
+                font_size: 5
+              },
+            },
+            body: {},
+          }
+          final = described_class.merge_options(over, options, default)
+          expect(final).to eq(expected)
+        end
+      end
+
+      describe TableOptions do
+
+        let(:default) {{
+          header_repeat: true,
+          width: 600,
+          cell_style: {
+            borders: [:top, :bottom],
+            border_width: 0.5,
+            inline_format: true,
+            size: 10
+          },
+          position: :center,
+          header_format: {
+            align: :center,
+            font_style: :bold
+          },
+          footer_format: {
+              font_style: :bold
+          }
+        }}
+        let(:options) {{
+          header_format: {
+            align: :left,
+          },
+          header_repeat: false
+        }}
+        let(:over) {{
+          header_format: {
+            align: :right,
+          },
+          cell_style: {
+            size: 12
+          },
+        }}
+
+        it 'deep merges the hashes intelligently' do
+          expected = {
+            header_repeat: false,
+            width: 600,
+            cell_style: {
+              borders: [:top, :bottom],
+              border_width: 0.5,
+              inline_format: true,
+              size: 12
+            },
+            position: :center,
+            header_format: {
+              align: :right,
+              font_style: :bold
+            },
+            footer_format: {
+              font_style: :bold
+            }
+          }
+          final = described_class.merge_options(over, options, default)
+          expect(final).to eq(expected)
+        end
       end
     end
   end

data/thousand_island.gemspec

@@ -4,27 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'thousand_island/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "thousand_island"
+  spec.name          = 'thousand_island'
   spec.version       = ThousandIsland::VERSION
-  spec.authors       = ["Colin Weight"]
-  spec.email         = ["colin@colinweight.com.au"]
+  spec.authors       = ['Colin Weight']
+  spec.email         = ['colin@colinweight.com.au']
   spec.description   = %q{Dressing for Prawn}
   spec.summary       = %q{A library that helps with common layout elements in PDFs.}
-  spec.homepage      = "https://github.com/colinweight/thousand_island"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/colinweight/thousand_island'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'prawn', '~> 1.2.1'
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_dependency 'prawn', '~> 1.3.0'
+  spec.add_dependency 'prawn-table', '~> 0.2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "guard", "~> 2.6.1"
-  spec.add_development_dependency "guard-rspec", "~> 4.3.1"
-  spec.add_development_dependency "yard", "~> 0.8.7"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard', '~> 2.6.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3.1'
+  spec.add_development_dependency 'pdf-inspector', '~> 1.2.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thousand_island
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Colin Weight
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +173,8 @@ files:
 - lib/thousand_island/components/footer.rb
 - lib/thousand_island/components/header.rb
 - lib/thousand_island/style_sheet.rb
+- lib/thousand_island/table.rb
+- lib/thousand_island/table_settings.rb
 - lib/thousand_island/template.rb
 - lib/thousand_island/utilities/style_hash.rb
 - lib/thousand_island/utilities/utilities.rb
@@ -156,6 +186,7 @@ files:
 - spec/thousand_island/components/footer_spec.rb
 - spec/thousand_island/components/header_spec.rb
 - spec/thousand_island/style_sheet_spec.rb
+- spec/thousand_island/table_spec.rb
 - spec/thousand_island/template_spec.rb
 - spec/thousand_island/utilities/style_hash_spec.rb
 - spec/thousand_island/utilities/utilities_spec.rb
@@ -173,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -193,6 +224,7 @@ test_files:
 - spec/thousand_island/components/footer_spec.rb
 - spec/thousand_island/components/header_spec.rb
 - spec/thousand_island/style_sheet_spec.rb
+- spec/thousand_island/table_spec.rb
 - spec/thousand_island/template_spec.rb
 - spec/thousand_island/utilities/style_hash_spec.rb
 - spec/thousand_island/utilities/utilities_spec.rb