ruport-util 0.12.0 → 0.13.0

data/Rakefile

@@ -33,7 +33,7 @@ end
 
 spec = Gem::Specification.new do |spec|
   spec.name = "ruport-util"
-  spec.version = "0.12.0"
+  spec.version = "0.13.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A set of tools and helper libs for Ruby Reports"
   spec.files =  Dir.glob("{example,lib,test,bin}/**/**/*") +
@@ -48,7 +48,7 @@ spec = Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w{INSTALL}
   spec.rdoc_options << '--title' << 'ruport-util Documentation' <<
                        '--main' << 'INSTALL' << '-q'
-  spec.add_dependency('ruport', ">=1.2.3")
+  spec.add_dependency('ruport', ">=1.4.0")
   spec.add_dependency('mailfactory',">=1.2.3")
   spec.add_dependency('rubyzip','>=0.9.1')
   spec.author = "Gregory Brown"

data/example/invoice_report.rb

@@ -1,10 +1,11 @@
+require "rubygems"
 require "ruport"
 require "ruport/util"
 
 class SampleReport < Ruport::Report
   include Invoice
 
-  def generate
+  def renderable_data(format)
     render_invoice do |i|
       i.data = Table("Item Number","Description","Price") { |t|
         t << %w[101 Erlang\ The\ Movie $1000.00]
@@ -25,4 +26,4 @@ class SampleReport < Ruport::Report
 end
 
 a = SampleReport.new
-File.open("invoice.pdf","wb") { |f| f << a.generate }
+a.save_as("invoice.pdf")

data/lib/ruport/util.rb

@@ -1,6 +1,6 @@
 module Ruport
   module Util
-    VERSION = "0.12.0"
+    VERSION = "0.13.0"
 
     file = __FILE__
     file = File.readlink(file) if File.symlink?(file)
@@ -21,3 +21,5 @@ require "ruport/util/pdf/form"
 require "ruport/util/ods" 
 require "ruport/util/query"
 require "ruport/util/xls"
+require "ruport/util/ods_table"
+require "ruport/util/xls_table"

data/lib/ruport/util/invoice.rb

@@ -22,7 +22,7 @@ module Ruport
         end
 
         def build_customer_header
-          move_cursor -5
+          move_cursor(-5)
           rounded_text_box(options.customer_info) { |o| 
               o.radius    = 3
               o.width     = options.header_width || 200
@@ -99,7 +99,7 @@ module Ruport
 
               horizontal_line left_boundary + 20, right_boundary - 25
 
-              move_cursor -10 
+              move_cursor(-10)
 
               add_text(options.comments,:justification => :center, 
                                         :left => 0, :right => 0 )

data/lib/ruport/util/ods_table.rb

@@ -0,0 +1,136 @@
+require 'ruport'
+
+# === Overview
+#
+# This class extends the core class Ruport::Data::Table and adds support for loading Openoffice
+# spreadsheet files using roo. The idea is to get data from speadsheets that may contain
+# already calculated values entered by non-programmers.
+#
+# Once your data is in a Table object, it can be manipulated
+# to suit your needs, then used to build a report.
+#
+# Copyright (C) 2007, Wes Hays
+# All Rights Reserved.
+#
+class Ruport::Data::Table
+
+  # === Overview
+  #
+  # This module provides facilities for creating tables from Openoffice spreadsheet file (ods).
+  #
+  module FromODS
+    # Loads a ods file directly into a Table using the roo library.
+    #
+    # Example:
+    #   
+    #   # Load data from Openoffice ods file with defaults
+    #   table = Table.load_ods('myspreadsheet.ods')
+    #
+    #   # do not assume the data has column names - default is false.
+    #   table = Table.load_ods('myspreadsheet.ods',{:has_column_names => false})
+    #
+    #   # Select sheet - default is the first sheet.
+    #   table = Table.load_ods('myspreadsheet.ods', {:select_sheet => 1})
+    #
+    #   # Start row - default is the first row. Use this to override where
+    #                 the first row should start.
+    #   table = Table.load_ods('myspreadsheet.ods', {:start_row => 1})
+    #
+    def load_ods(ods_file, options={})
+      get_table_from_ods_file(ods_file, options)
+    end
+
+    # Creates a Table from an Openoffice object (from roo library). 
+    #
+    # Example:
+    #   
+    #   # parse openoffice object with defaults. 
+    #   table = Table.parse_ods(openoffice_object)
+    #
+    #   # do not assume the data has column names.
+    #   table = Table.parse_ods(openoffice_object,{:has_column_names => false})
+    #
+    #   # Select sheet - default is the first sheet.
+    #   table = Table.parse_ods(openoffice_object, {:select_sheet => 1})
+    #
+    #   # Start row - default is the first row. Use this to override where
+    #                 the first row should start.
+    #   table = Table.parse_ods('myspreadsheet.ods', {:start_row => 1})    
+    #
+    def parse_ods(ods_object, options={})
+      get_table_from_ods(ods_object, options)
+    end      
+
+    private
+
+    def get_table_from_ods_file(ods_file, options) #:nodoc:
+      require 'roo'
+      oo = Openoffice.new(ods_file)
+      get_table_from_ods(oo, options)
+    end
+
+    def get_table_from_ods(oo, options) #:nodoc:
+      options = {:has_column_names => true, 
+                 :select_sheet => oo.sheets.first,
+                 :start_row => 0}.merge(options)        
+      oo.default_sheet = options[:select_sheet]
+      
+      options[:start_row] = options[:start_row].to_i + 1 unless options[:start_row].nil?      
+      start_row = options[:start_row]
+
+      raise 'start_row must be greater than or equal to zero' if options[:start_row].to_i < 0
+      
+      last_row_index_zero = oo.last_row - 1
+      raise "start_row must be less than or equal to #{last_row_index_zero}" if !oo.last_row.nil? and 
+                                                                                (options[:start_row].to_i > oo.last_row)
+                                                                                
+      table = self.new(options) do |feeder|            
+        
+        if options[:has_column_names] == true
+          feeder.data.column_names = oo.row(start_row) 
+          start_row = start_row + 1
+        end
+        
+        unless oo.last_row.nil?
+          start_row.upto(oo.last_row) do |row|
+            tempArr = []
+            1.upto(oo.last_column) do |col|
+              tempArr << oo.cell(row,col)
+            end
+            feeder << tempArr
+          end 
+        end
+        
+      end
+
+      return table     
+    end
+
+  end
+
+  extend FromODS
+
+end
+    
+
+module Kernel
+  
+  alias :RuportTableMethod :Table
+  
+  # Updates the Ruport interface for creating Data::Tables with
+  # the ability to pass in a ODS file or Roo Openoffice object.
+  #
+  #   t = Table("myspreadsheet.ods")
+  #   t = Table("myspreadsheet.ods", :has_column_names => true)
+  def Table(*args,&block)
+    table=
+    case(args[0])
+    when /\.ods/
+      Ruport::Data::Table.load_ods(*args)
+    else
+      RuportTableMethod(*args,&block)
+    end             
+    
+    return table
+  end
+end  

data/lib/ruport/util/query.rb

@@ -66,13 +66,24 @@ module Ruport
     #   # explicitly use a file, even if it doesn't end in .sql
     #   Ruport::Query.new(:file => "foo")
     #
+    #   # query with parameter substitution
+    #   Ruport::Query.new("select * from fo where bar=?", :params => [1234])
+    #   Ruport::Query.new(:file => "foo", :params => [1234])
+    #
+    #   # query with parameter substitution (ActiveRecord style)
+    #   Ruport::Query.new(["select * from fo where bar=?", 1234])
+    #
     def initialize(sql, options={})   
       if sql.kind_of?(Hash)  
         options = { :source => :default }.merge(sql)   
         sql = options[:file] || options[:string]
       else 
+        if sql.kind_of?(Array)
+          options[:params] = sql[1..-1]
+          sql = sql.first
+        end
         options = { :source => :default, :string => sql }.merge(options)
-        options[:file] = sql if sql =~ /.sql$/    
+        options[:file] = sql if sql =~ /\.sql$/    
       end                                                 
       origin = options[:file] ? :file : :string      
       

data/lib/ruport/util/xls_table.rb

@@ -0,0 +1,136 @@
+require 'ruport'
+
+# === Overview
+#
+# This class extends the core class Ruport::Data::Table and adds support for loading Excel
+# spreadsheet files using roo. The idea is to get data from speadsheets that may contain
+# already calculated values entered by non-programmers.
+#
+# Once your data is in a Table object, it can be manipulated
+# to suit your needs, then used to build a report.
+#
+# Copyright (C) 2008, Wes Hays
+# All Rights Reserved.
+#
+class Ruport::Data::Table
+
+  # === Overview
+  #
+  # This module provides facilities for creating tables from Excel spreadsheet file (xls).
+  #
+  module FromXLS
+    # Loads a xls file directly into a Table using the roo library.
+    #
+    # Example:
+    #   
+    #   # Load data from an Excel xls file with defaults
+    #   table = Table.load_xls('myspreadsheet.xls')
+    #
+    #   # do not assume the data has column names - default is false.
+    #   table = Table.load_xls('myspreadsheet.xls',{:has_column_names => false})
+    #
+    #   # Select sheet - default is the first sheet.
+    #   table = Table.load_xls('myspreadsheet.xls', {:select_sheet => 1})
+    #
+    #   # Start row - default is the first row. Use this to override where
+    #                 the first row should start.
+    #   table = Table.load_xls('myspreadsheet.xls', {:start_row => 1})
+    #
+    def load_xls(xls_file, options={})
+      get_table_from_xls_file(xls_file, options)
+    end
+
+    # Creates a Table from an Excel object (from roo library). 
+    #
+    # Example:
+    #   
+    #   # parse excel object with defaults. 
+    #   table = Table.parse_xls(excel_object)
+    #
+    #   # do not assume the data has column names.
+    #   table = Table.parse_xls(excel_object,{:has_column_names => false})
+    #
+    #   # Select sheet - default is the first sheet.
+    #   table = Table.parse_xls(excel_object, {:select_sheet => 1})
+    #
+    #   # Start row - default is the first row. Use this to override where
+    #                 the first row should start.
+    #   table = Table.parse_xls('myspreadsheet.xls', {:start_row => 1})    
+    #
+    def parse_xls(xls_object, options={})
+      get_table_from_xls(xls_object, options)
+    end      
+
+    private
+
+    def get_table_from_xls_file(xls_file, options) #:nodoc:
+      require 'roo'
+      oo = Excel.new(xls_file)
+      get_table_from_xls(oo, options)
+    end
+
+    def get_table_from_xls(oo, options) #:nodoc:
+      options = {:has_column_names => true, 
+                 :select_sheet => oo.sheets.first,
+                 :start_row => 0}.merge(options)        
+      oo.default_sheet = options[:select_sheet]
+      
+      options[:start_row] = options[:start_row].to_i + 1 unless options[:start_row].nil?      
+      start_row = options[:start_row]
+
+      raise 'start_row must be greater than or equal to zero' if options[:start_row].to_i < 0
+      
+      last_row_index_zero = oo.last_row - 1
+      raise "start_row must be less than or equal to #{last_row_index_zero}" if !oo.last_row.nil? and 
+                                                                                (options[:start_row].to_i > oo.last_row)
+                                                                                
+      table = self.new(options) do |feeder|            
+        
+        if options[:has_column_names] == true
+          feeder.data.column_names = oo.row(start_row) 
+          start_row = start_row + 1
+        end
+        
+        unless oo.last_row.nil?
+          start_row.upto(oo.last_row) do |row|
+            tempArr = []
+            1.upto(oo.last_column) do |col|
+              tempArr << oo.cell(row,col)
+            end
+            feeder << tempArr
+          end 
+        end
+        
+      end
+
+      return table     
+    end
+
+  end
+
+  extend FromXLS
+
+end
+    
+
+module Kernel
+  
+  alias :RuportTableMethod2 :Table
+  
+  # Updates the Ruport interface for creating Data::Tables with
+  # the ability to pass in a XLS file or Roo Excel object.
+  #
+  #   t = Table("myspreadsheet.xls")
+  #   t = Table("myspreadsheet.xls", :has_column_names => true)
+  def Table(*args,&block)
+    table=
+    case(args[0])
+    when /\.xls/
+      Ruport::Data::Table.load_xls(*args)
+    else
+      RuportTableMethod2(*args,&block)
+    end             
+    
+    return table
+  end
+end  

data/test/test_ods_table.rb

@@ -0,0 +1,219 @@
+# Copyright (C) 2007, Wes Hays
+# All Rights Reserved.
+
+require 'test/helper'
+testcase_requires 'roo'
+
+describe 'Ruport::Data::TableFromODS' do
+  before(:each) do
+    @ods_file = 'test/samples/people.ods'
+    @csv_file = 'test/samples/data.csv'
+    
+    @ods_file_column_names = %w(Name Age DOB)
+    @rows = [ ['Andy',    27.0, Date.parse('01/20/1980')], 
+              ['Bob',     26.0, Date.parse('02/11/1981')],
+              ['Charlie', 20.0, Date.parse('03/14/1987')],
+              ['David',   73.0, Date.parse('04/26/1997')] ]
+              
+    @ods_file_column_names2 = %w(Name Age Pet_Type)
+    @rows2 = [ ['Tigger', 3.0,  'Cat'], 
+               ['Chai',   4.0,  'Dog'],
+               ['Rusky',  6.0,  'Dog'],
+               ['Sam',    13.0, 'Dog'] ]            
+  end
+
+  # ==== File check ====
+  # Raise error if file is not found
+  it "should raise if ods file is not found" do
+    lambda do
+      Ruport::Data::Table.load_ods('people.ods')
+    end.should raise_error
+  end
+  
+  # Raise error if file is not found
+  it "shouldn't raise if ods file exists" do
+    lambda do
+      Ruport::Data::Table.load_ods(@ods_file)
+    end.should_not raise_error
+  end  
+  
+  
+  # ==== Constructor check ====
+  it "shouldn't be nil if a ods file is passed" do
+    table = Table(@ods_file)
+    table.should_not be_nil
+  end  
+  
+  it "shouldn't be nil if a Openoffice object is passed" do
+    oo = Openoffice.new(@ods_file)
+    oo.default_sheet = oo.sheets.first
+    table = Table(oo) # This will be passed to the base Ruport::Data::Table class.
+    table.should_not be_nil
+  end
+  
+  it "shouldn't be nil if a Ruport::Data::Table parameter is passed" do
+    table = Table(@csv_file) # Pass cs file
+    table.should_not be_nil
+  end  
+  
+  
+  # ==== Constructor check with options params ====
+  it "shouldn't be nil if a ods file is passed with options params" do
+    table = Table(@ods_file, {:has_column_names => false})
+    table.should_not be_nil
+  end  
+  
+  it "shouldn't be nil if a Openoffice object is passed with options params using parse_ods method" do
+    oo = Openoffice.new(@ods_file)
+    oo.default_sheet = oo.sheets.first
+    table = Ruport::Data::Table.parse_ods(oo, {:has_column_names => false})
+    table.should_not be_nil
+  end
+  
+  it "shouldn't be nil if a Ruport::Data::Table parameter is passed with options params" do
+    table = Table(@csv_file, {:has_column_names => false}) # Pass cs file
+    table.should_not be_nil
+  end  
+  
+  it "should raise if start_row is less than zero" do
+    lambda do
+      Table(@ods_file, {:start_row => -2})
+    end.should raise_error
+  end
+  
+  it "should raise if start_row is greater than the number of rows (starting at 0) in the spreadsheet" do
+    lambda do
+      Table(@ods_file, {:start_row => 20})
+    end.should raise_error
+  end  
+    
+  
+  # ==== Table load check ====
+  
+  # Output:
+  # +-----------------------------+
+  # | Name    | Age  | DOB        |
+  # | Andy    | 27.0 | 1980-01-20 |
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+
+  it "table should be valid without column names loaded from ods file starting at the row 1 (index 0) - column names will be data" do
+    # Load data from ods file but do not load column headers.
+    table = Table(@ods_file, {:has_column_names => false, :start_row => 0})
+    table.should_not be_nil
+    table.column_names.should == []
+    
+    # Add headers to the first position
+    @rows.insert(0, @ods_file_column_names)    
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == [0, 1, 2] }  
+  end
+  
+  # Output:
+  # +-----------------------------+
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+
+  it "table should be valid without column names loaded from ods file starting at row 3 (index 2)" do
+    # Load data from ods file but do not load column headers.
+    # Will start at Row 3 (index 2): ['Bob', 26.0, Date.parse('02/11/1981')]
+    table = Table(@ods_file, {:has_column_names => false, :start_row => 2})
+    table.should_not be_nil
+    table.column_names.should == []
+    
+    # The header row has not been included yet so don't worry about that one
+    # just delete the first row in @rows.
+    @rows.delete_at(0) # delete ['Andy', 27.0, Date.parse('01/20/1980')]
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == [0, 1, 2] }  
+  end  
+  
+  # Output:
+  # +-----------------------------+
+  # | Name    | Age  | DOB        |
+  # | Andy    | 27.0 | 1980-01-20 |
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+  
+  it "table should be valid without column names loaded from ods file" do
+    # Load data from ods file but do not load column headers.
+    table = Table(@ods_file, {:has_column_names => false})
+    table.should_not be_nil
+    table.column_names.should == [] 
+    
+    # Add headers to the first position
+    @rows.insert(0, @ods_file_column_names)
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == [0, 1, 2] }  
+  end
+  
+  # Output:
+  # +-----------------------------+
+  # |  Name   | Age  |    DOB     |
+  # +-----------------------------+
+  # | Andy    | 27.0 | 1980-01-20 |
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+
+  it "table should be valid with column names loaded from ods file" do
+    # Load data from ods file but do not load column headers.
+    table = Table(@ods_file)
+    table.should_not be_nil
+    table.column_names.should == @ods_file_column_names
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == @ods_file_column_names }  
+  end  
+  
+  # Output:
+  # +--------------------------+
+  # |  Name  | Age  | Pet_Type |
+  # +--------------------------+
+  # | Tigger |  3.0 | Cat      |
+  # | Chai   |  4.0 | Dog      |
+  # | Rusky  |  6.0 | Dog      |
+  # | Sam    | 13.0 | Dog      |
+  # +--------------------------+ 
+  it "table should be valid with column names loaded from ods file using Sheet2" do
+    # Load data from ods file but do not load column headers.
+    table = Table(@ods_file, {:select_sheet => 'Sheet2'})
+    table.should_not be_nil
+    table.column_names.should == @ods_file_column_names2
+    
+    table.each { |r| r.to_a.should == @rows2.shift
+                     r.attributes.should == @ods_file_column_names2 }  
+  end  
+  
+  # Output:
+  # +--------------------------+
+  # |  Name  | Age  | Pet_Type |
+  # +--------------------------+
+  # | Tigger |  3.0 | Cat      |
+  # | Chai   |  4.0 | Dog      |
+  # | Rusky  |  6.0 | Dog      |
+  # | Sam    | 13.0 | Dog      |
+  # +--------------------------+
+  it "should be valid if an Openoffice object is passed using parse_ods method" do
+    oo = Openoffice.new(@ods_file)
+    oo.default_sheet = oo.sheets.first
+    table = Ruport::Data::Table.parse_ods(oo)
+    table.should_not be_nil
+    
+    table.column_names.should == @ods_file_column_names
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == @ods_file_column_names }    
+  end   
+  
+end
+
+    
+    
+  

data/test/test_query.rb

@@ -29,6 +29,7 @@ describe "A Query" do
       :plain      => Ruport::Query.new(@sql[0]),
       :sourced    => Ruport::Query.new(@sql[0], :source        => :alternative),
       :paramed    => Ruport::Query.new(@sql[0], :params        => [ 42 ]),
+      :paramed_ar => Ruport::Query.new([@sql[0], 69, 777]),
       :raw        => Ruport::Query.new(@sql[0], :row_type      => :raw),
       :resultless => Ruport::Query.new(@sql[1]),
       :multi      => Ruport::Query.new(@sql[2]),
@@ -52,13 +53,20 @@ describe "A Query" do
         query.execute.should == nil
       end
    
-      it "should allow excute to accept parameters" do
+      it "should allow execute to accept parameters" do
         query = @query[:paramed]
         setup_mock_dbi(1, :params => [ 42 ])
 
         query.execute.should == nil   
       end  
    
+      it "should allow execute to accept parameters (ActiveRecord style)" do
+        query = @query[:paramed_ar]
+        setup_mock_dbi(1, :params => [ 69, 777 ])
+
+        query.execute.should == nil   
+      end  
+   
       it "should return nil for empty results" do
         query = @query[:resultless]
         setup_mock_dbi(1, :resultless => true, :sql => @sql[1])

data/test/test_xls_table.rb

@@ -0,0 +1,236 @@
+# Copyright (C) 2008, Wes Hays
+# All Rights Reserved.
+
+require 'test/helper'
+testcase_requires 'roo'
+
+describe 'Ruport::Data::TableFromXLS' do
+  before(:each) do
+    @xls_file = 'test/samples/people.xls'
+    @csv_file = 'test/samples/data.csv'
+    
+    @xls_file_column_names = %w(Name Age DOB)
+    # This test will pass once Spreadsheet and Roo support
+    # formulas in an excel file.
+    # @rows = [ ['Andy',    27.0, Date.parse('01/20/1980')], 
+    #           ['Bob',     26.0, Date.parse('02/11/1981')],
+    #           ['Charlie', 20.0, Date.parse('03/14/1987')],
+    #           ['David',   73.0, Date.parse('04/26/1997')] ]
+    
+    # Delete this once Roo supports formulas in an excel file.
+    @rows = [ ['Andy',    27.0, Date.parse('01/20/1980')], 
+              ['Bob',     26.0, Date.parse('02/11/1981')],
+              ['Charlie', 20.0, Date.parse('03/14/1987')],
+              ['David',   nil, Date.parse('04/26/1997')] ]    
+       
+       
+    @xls_file_column_names2 = %w(Name Age Pet_Type)
+    # This test will pass once Spreadsheet and Roo support
+    # formulas in an excel file.    
+    # @rows2 = [ ['Tigger', 3.0,  'Cat'], 
+    #            ['Chai',   4.0,  'Dog'],
+    #            ['Rusky',  6.0,  'Dog'],
+    #            ['Sam',    13.0, 'Dog'] ]
+
+    # Delete this once Roo supports formulas in an excel file.
+    @xls_file_column_names2 = %w(Name Age Pet_Type)
+    @rows2 = [ ['Tigger', 3.0,  'Cat'], 
+               ['Chai',   4.0,  'Dog'],
+               ['Rusky',  6.0,  'Dog'],
+               ['Sam',    nil, 'Dog'] ]            
+  end
+
+  # ==== File check ====
+  # Raise error if file is not found
+  it "should raise if xls file is not found" do
+    lambda do
+      Ruport::Data::Table.load_xls('people.xls')
+    end.should raise_error
+  end
+  
+  # Raise error if file is not found
+  it "shouldn't raise if xls file exists" do
+    lambda do
+      Ruport::Data::Table.load_xls(@xls_file)
+    end.should_not raise_error
+  end  
+  
+  
+  # ==== Constructor check ====
+  it "shouldn't be nil if a xls file is passed" do
+    table = Table(@xls_file)
+    table.should_not be_nil
+  end  
+  
+  it "shouldn't be nil if a Excel object is passed" do
+    oo = Excel.new(@xls_file)
+    oo.default_sheet = oo.sheets.first
+    table = Table(oo) # This will be passed to the base Ruport::Data::Table class.
+    table.should_not be_nil
+  end
+  
+  it "shouldn't be nil if a Ruport::Data::Table parameter is passed" do
+    table = Table(@csv_file) # Pass cs file
+    table.should_not be_nil
+  end  
+  
+  
+  # ==== Constructor check with options params ====
+  it "shouldn't be nil if a xls file is passed with options params" do
+    table = Table(@xls_file, {:has_column_names => false})
+    table.should_not be_nil
+  end  
+  
+  it "shouldn't be nil if a Excel object is passed with options params using parse_xls method" do
+    oo = Excel.new(@xls_file)
+    oo.default_sheet = oo.sheets.first
+    table = Ruport::Data::Table.parse_xls(oo, {:has_column_names => false})
+    table.should_not be_nil
+  end
+  
+  it "shouldn't be nil if a Ruport::Data::Table parameter is passed with options params" do
+    table = Table(@csv_file, {:has_column_names => false}) # Pass cs file
+    table.should_not be_nil
+  end  
+  
+  it "should raise if start_row is less than zero" do
+    lambda do
+      Table(@xls_file, {:start_row => -2})
+    end.should raise_error
+  end
+  
+  it "should raise if start_row is greater than the number of rows (starting at 0) in the spreadsheet" do
+    lambda do
+      Table(@xls_file, {:start_row => 20})
+    end.should raise_error
+  end  
+    
+  
+  # ==== Table load check ====
+  
+  # Output:
+  # +-----------------------------+
+  # | Name    | Age  | DOB        |
+  # | Andy    | 27.0 | 1980-01-20 |
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+
+  it "table should be valid without column names loaded from xls file starting at the row 1 (index 0) - column names will be data" do
+    # Load data from xls file but do not load column headers.
+    table = Table(@xls_file, {:has_column_names => false, :start_row => 0})
+    table.should_not be_nil
+    table.column_names.should == []
+    
+    # Add headers to the first position
+    @rows.insert(0, @xls_file_column_names)    
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == [0, 1, 2] }  
+  end
+  
+  # Output:
+  # +-----------------------------+
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+
+  it "table should be valid without column names loaded from xls file starting at row 3 (index 2)" do
+    # Load data from xls file but do not load column headers.
+    # Will start at Row 3 (index 2): ['Bob', 26.0, Date.parse('02/11/1981')]
+    table = Table(@xls_file, {:has_column_names => false, :start_row => 2})
+    table.should_not be_nil
+    table.column_names.should == []
+    
+    # The header row has not been included yet so don't worry about that one
+    # just delete the first row in @rows.
+    @rows.delete_at(0) # delete ['Andy', 27.0, Date.parse('01/20/1980')]
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == [0, 1, 2] }  
+  end  
+  
+  # Output:
+  # +-----------------------------+
+  # | Name    | Age  | DOB        |
+  # | Andy    | 27.0 | 1980-01-20 |
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+  
+  it "table should be valid without column names loaded from xls file" do
+    # Load data from xls file but do not load column headers.
+    table = Table(@xls_file, {:has_column_names => false})
+    table.should_not be_nil
+    table.column_names.should == [] 
+    
+    # Add headers to the first position
+    @rows.insert(0, @xls_file_column_names)
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == [0, 1, 2] }  
+  end
+  
+  # Output:
+  # +-----------------------------+
+  # |  Name   | Age  |    DOB     |
+  # +-----------------------------+
+  # | Andy    | 27.0 | 1980-01-20 |
+  # | Bob     | 26.0 | 1981-02-11 |
+  # | Charlie | 20.0 | 1987-03-14 |
+  # | David   | 73.0 | 1997-04-26 |
+  # +-----------------------------+
+  it "table should be valid with column names loaded from xls file" do
+    # Load data from xls file but do not load column headers.
+    table = Table(@xls_file)
+    table.should_not be_nil
+    table.column_names.should == @xls_file_column_names
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == @xls_file_column_names }  
+  end  
+  
+  # Output:
+  # +--------------------------+
+  # |  Name  | Age  | Pet_Type |
+  # +--------------------------+
+  # | Tigger |  3.0 | Cat      |
+  # | Chai   |  4.0 | Dog      |
+  # | Rusky  |  6.0 | Dog      |
+  # | Sam    | 13.0 | Dog      |
+  # +--------------------------+ 
+  it "table should be valid with column names loaded from xls file using Sheet2" do
+    # Load data from xls file but do not load column headers.
+    table = Table(@xls_file, {:select_sheet => 'Sheet2'})
+    table.should_not be_nil
+    table.column_names.should == @xls_file_column_names2
+    
+    table.each { |r| r.to_a.should == @rows2.shift
+                     r.attributes.should == @xls_file_column_names2 }  
+  end  
+  
+  # Output:
+  # +--------------------------+
+  # |  Name  | Age  | Pet_Type |
+  # +--------------------------+
+  # | Tigger |  3.0 | Cat      |
+  # | Chai   |  4.0 | Dog      |
+  # | Rusky  |  6.0 | Dog      |
+  # | Sam    | 13.0 | Dog      |
+  # +--------------------------+
+  it "should be valid if an Excel object is passed using parse_xls method" do
+    oo = Excel.new(@xls_file)
+    oo.default_sheet = oo.sheets.first
+    table = Ruport::Data::Table.parse_xls(oo)
+    table.should_not be_nil
+    
+    table.column_names.should == @xls_file_column_names
+    
+    table.each { |r| r.to_a.should == @rows.shift
+                     r.attributes.should == @xls_file_column_names }    
+  end   
+  
+end
+
+    
+    

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: ruport-util
 version: !ruby/object:Gem::Version 
-  version: 0.12.0
-date: 2007-12-25 00:00:00 -05:00
+  version: 0.13.0
+date: 2008-02-08 00:00:00 -05:00
 summary: A set of tools and helper libs for Ruby Reports
 require_paths: 
 - lib
@@ -30,71 +30,79 @@ authors:
 - Gregory Brown
 files: 
 - example/data
-- example/data/amline_settings.xml
-- example/data/blank.xlsx
-- example/data/amline_graph.xml
-- example/data/blank.ods
-- example/invoice_report.rb
 - example/draw_graph.rb
 - example/form.rb
+- example/graph_report.rb
 - example/gruff_report.rb
-- example/ods.rb
-- example/managed_report.rb
+- example/invoice_report.rb
 - example/mailer.rb
-- example/graph_report.rb
+- example/managed_report.rb
+- example/ods.rb
+- example/data/amline_graph.xml
+- example/data/amline_settings.xml
+- example/data/blank.ods
+- example/data/blank.xlsx
+- lib/open_flash_chart.rb
 - lib/ruport
 - lib/ruport/util
-- lib/ruport/util/graph
-- lib/ruport/util/graph/scruffy.rb
-- lib/ruport/util/graph/amline.rb
-- lib/ruport/util/graph/o_f_c.rb
-- lib/ruport/util/graph/gruff.rb
-- lib/ruport/util/pdf
-- lib/ruport/util/pdf/form.rb
-- lib/ruport/util/generator.rb
+- lib/ruport/util.rb
 - lib/ruport/util/bench.rb
+- lib/ruport/util/generator.rb
+- lib/ruport/util/graph
 - lib/ruport/util/graph.rb
+- lib/ruport/util/invoice.rb
+- lib/ruport/util/mailer.rb
 - lib/ruport/util/ods.rb
+- lib/ruport/util/ods_table.rb
+- lib/ruport/util/pdf
 - lib/ruport/util/query.rb
+- lib/ruport/util/report.rb
 - lib/ruport/util/report_manager.rb
 - lib/ruport/util/xls.rb
-- lib/ruport/util/mailer.rb
-- lib/ruport/util/report.rb
-- lib/ruport/util/invoice.rb
-- lib/ruport/util.rb
-- lib/open_flash_chart.rb
+- lib/ruport/util/xls_table.rb
+- lib/ruport/util/graph/amline.rb
+- lib/ruport/util/graph/gruff.rb
+- lib/ruport/util/graph/o_f_c.rb
+- lib/ruport/util/graph/scruffy.rb
+- lib/ruport/util/pdf/form.rb
 - test/helper
-- test/helper/layout.rb
-- test/helper/wrap.rb
+- test/helper.rb
 - test/samples
-- test/samples/data.csv
-- test/samples/foo.rtxt
-- test/test_report_manager.rb
+- test/test_format_ods.rb
 - test/test_format_xls.rb
-- test/helper.rb
-- test/test_query.rb
-- test/test_hpricot_traverser.rb
-- test/test_graph_renderer.rb
 - test/test_graph_ofc.rb
+- test/test_graph_renderer.rb
+- test/test_hpricot_traverser.rb
+- test/test_invoice.rb
 - test/test_mailer.rb
+- test/test_ods_table.rb
+- test/test_query.rb
 - test/test_report.rb
-- test/test_invoice.rb
-- test/test_format_ods.rb
+- test/test_report_manager.rb
+- test/test_xls_table.rb
+- test/helper/layout.rb
+- test/helper/wrap.rb
+- test/samples/data.csv
+- test/samples/foo.rtxt
+- test/samples/people.ods
+- test/samples/people.xls
 - bin/csv2ods
 - bin/rope
 - Rakefile
 - INSTALL
 test_files: 
-- test/test_report_manager.rb
+- test/test_format_ods.rb
 - test/test_format_xls.rb
-- test/test_query.rb
-- test/test_hpricot_traverser.rb
-- test/test_graph_renderer.rb
 - test/test_graph_ofc.rb
+- test/test_graph_renderer.rb
+- test/test_hpricot_traverser.rb
+- test/test_invoice.rb
 - test/test_mailer.rb
+- test/test_ods_table.rb
+- test/test_query.rb
 - test/test_report.rb
-- test/test_invoice.rb
-- test/test_format_ods.rb
+- test/test_report_manager.rb
+- test/test_xls_table.rb
 rdoc_options: 
 - --title
 - ruport-util Documentation
@@ -118,7 +126,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.3
+        version: 1.4.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: mailfactory