rexcel 0.1.1 → 0.1.2

data/examples/example.rb

@@ -1,16 +1,37 @@
 #encoding: cp1252
+=begin rdoc
+Create an excel file.
+
+Creates
+* test.xml
+* test_xml.xls
+* test.xls
+* test.xlsx
+=end
 $:.unshift('../lib') if $0 == __FILE__
 require 'rexcel'
 Excel::LOGGER.level = Log4r::DEBUG
 
 wb = Excel::Workbook.new()
 
-wb << [1,2,3,4,5,6,7]
-wb << [:a, :b, :c, :d, :e, :f]
-wb << ['�', '�', '�', '�', '�', '�', '�']
-wb << ['�', '�', '�', '�', '�', '�', '�'].map{|x| x.encode('utf-8')}
-
-
+#Sheet one with numbers, letters and umlauts.
+wb << ['Integer', 1,2,3,4,5,6,7]
+wb << ['Float', 1.1,2.2,3.3,4.4,5.5,6.6,7.7]
+wb << %w{Letters a b c d e f}
+begin
+wb << [:Symbols, :a, :b, :c, :d, :e, :f]
+rescue
+  puts "Warning: Adding symbols have problems"
+  puts "Please report the problem with the following informations:"
+  puts "ruby #{RUBY_VERSION}"
+  puts "#{Excel::Excel.instance.xl.Name} #{Excel::Excel.instance.xl.version}"
+  puts Excel::Excel.instance.xl.OperatingSystem
+  puts "Thanks"
+end
+wb << ['Umlauts', '�', '�', '�', '�', '�', '�', '�']
+wb << ['Umlauts/UTF8', '�', '�', '�', '�', '�', '�', '�'].map{|x| x.encode('utf-8')}
+
+#Sheet 2: Some text formatting.
 wb << ws = Excel::Worksheet.new('Formats')
 ws << row = Excel::Row.new
 row << cell = Excel::Cell.new(1)
@@ -27,6 +48,7 @@ row << cell = Excel::Cell.new('grau text', :style => style)
 
     
 wb.save('test.xml')
+#Create xls based on xml.
 wb.save('test_xml.xls', 'test.xml')
 wb.save('test.xls')
 wb.save('test.xlsx')

data/examples/example_format.rb

@@ -2,6 +2,7 @@ $:.unshift('../lib') if $0 == __FILE__
 require 'rexcel'
 Excel::LOGGER.level = Log4r::DEBUG
 
+wb = Excel::Workbook.new()
 wb << ws = Excel::Worksheet.new('Formats')
 ws << row = Excel::Row.new
 row << cell = Excel::Cell.new(1)

data/examples/example_sequel.rb

@@ -0,0 +1,52 @@
+#encoding: cp1252
+=begin rdoc
+Create a sqlite-DB and copy the data from table to Excel.
+
+This test needs a SQLITE-Installation
+=end
+$:.unshift('../lib') if $0 == __FILE__
+require 'rexcel'
+Excel::LOGGER.level = Log4r::DEBUG
+
+require 'sequel'
+
+begin
+DB = Sequel.sqlite()
+rescue Sequel::AdapterNotFound
+  puts "No sqlite found - test not possible"
+  exit
+end
+#
+#Fill DB with data
+#
+DB.create_table :testtable do 
+  column :column_1, :integer
+  column :column_2, :integer
+  column :column_3, :integer
+end
+1.upto(100){|i|
+  DB[:testtable].insert( i, i * 2, i ** 2 )
+}
+
+
+#
+#Create Excel from DB
+#
+WB = Excel::Workbook.new()
+WB << WS = Excel::Worksheet.new('Formats')
+WB << style = Excel::Style.new(:column, :color => 14)
+
+DB[:testtable].columns.each{|col| 
+  WS << Excel::Column.new(col, :style =>  style) 
+}
+x = WS.add_title_row
+p x
+DB[:testtable].all{| dataset|
+  WS << dataset
+}
+
+    
+WB.save('test_sequel.xml')
+WB.save('test_sequel_xml.xls', 'test_sequel.xml')
+#~ WB.save('test_sequel.xls')
+#~ WB.save('test_sequel.xlsx')

data/lib/rexcel.rb

@@ -3,65 +3,10 @@
 :title:Create Excel-documents with ruby
 Build Excel documents via win32ole.
 
-==Example 1 (Simple Spreadsheet):
-  require 'excel'
-  
-  wb = Excel::Workbook.new()
-
-  wb << [1,2,3,4,5,6,7]
-  wb << [:a, :b, :c, :d, :e, :f]
-
-  #Save as excel spreadsheets
-  wb.save('test.xls') #excel97_2003_format
-  wb.save('test.xlsx')  #Excel 2007
-  
-  wb.save('test.xml') #Microsoft Office Word 2003 XML Format
-  wb.save('test.xls', 'test.xml')#Build xls from xlm
-
-==Example 2 (Access to Worksheets, Rows and Cells):
-  require 'excel'
-  
-  wb = Excel::Workbook.new()
-
-  wb << ws = Excel::Worksheet.new('My Spreadsheet')
-  ws << row = Excel::Row.new()
-  row << Excel::Cell.new(1)
-  row << Excel::Cell.new(2)
-  row << Excel::Cell.new(4)
-
-  #Save as excel spreadsheets
-  wb.save('test.xls') #excel97_2003_format
-  wb.save('test.xlsx')  #Excel 2007
-  
-  wb.save('test.xml') #Microsoft Office Word 2003 XML Format
-  wb.save('test.xls', 'test.xml')#Build xls from xlm
-
-==Example 3 (With Format options):
-  require 'excel'
-  
-  wb = Excel::Workbook.new()
-  wb << style = Excel::Style.new('fett', :bold => true)
-
-  wb << ws = Excel::Worksheet.new('My Spreadsheet')
-  ws << row = Excel::Row.new()
-  row << Excel::Cell.new(1)
-  row << Excel::Cell.new(2)
-  row << Excel::Cell.new(999, :style => style)
-
-  #Save as excel spreadsheets
-  wb.save('test.xls') #excel97_2003_format
-  wb.save('test.xlsx')  #Excel 2007
-  
-  wb.save('test.xml') #Microsoft Office Word 2003 XML Format
-  wb.save('test.xls', 'test.xml')#Build xls from xlm
-
-
-'Big' spreadsheets needs a long time to be build.
-(20000 lines need 2 hours)
-
-When you build the xml, and then the xls from xlm, the wor is done in seconds.
-
 
+This gem was tested with
+* Windows XP + MS Excel 2007 (Version 12)
+* Windows 7  + MS Excel 2007 (Version 12)
 =end
 require 'win32ole'
 require 'log4r'
@@ -71,7 +16,7 @@ require 'singleton'
 Frame for Excel-tools.
 =end
 module Excel
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 
   LOGGER = Log4r::Logger.new( name )#, Log4r::DEBUG, :trunc => true )
   LOGGER.outputters << Log4r::StdoutOutputter.new('std', :level => Log4r::WARN )
@@ -125,11 +70,16 @@ Exceptionclass for empty Workbook, Worksheet, Row
 end #module Excel
 
 =begin
-makes problems in unit test
+Close excel instance 
+
+The double at_exit is needed.
+Else you get problems in unit test
 =end
-#~ at_exit { 
-  #~ Excel::Excel.instance.close
-#~ }
+at_exit { 
+  at_exit { 
+    Excel::Excel.instance.close
+  }
+}
 
 
 require 'rexcel/workbook'

data/lib/rexcel/cell.rb

@@ -32,7 +32,10 @@ Options:
       case key
         when :log
         when :string
-           @type = 'String' if value
+          if value
+           @type = 'String' 
+            content = content.to_s
+          end
         when :style
           @style = value
           raise ArgumentError, "Style is no Excel::Style" unless @style.is_a?(Style)
@@ -128,6 +131,36 @@ Receives a OLE-cell and optional a row.
     cell
   end #to_xls
 
+=begin rdoc
+Fill an CSV-Field.
+
+The output is set depending on cell content.
+The csv-value is optimized to be used by Excel.
+
+Examples for conversion:
+* 1.1 -> ='1.1'  (1.1 would become 1st January)
+
+=end
+  def to_csv()
+    cellcontent = @content
+    case @type
+      when 'String'  #Suppress automatic conversion from Excel
+        cellcontent = "\"#{@content}\"" if @content =~ /^\A[\s\d]/
+      when 'Number'
+        #~ cellcontent = "%.2f" % cellcontent if cellcontent.is_a?(Float)
+        #http://www.creativyst.com/Doc/Articles/CSV/CSV01.htm#CSVAndExcel            
+        cellcontent = "=\"#{cellcontent}\"" if cellcontent.is_a?(Float)
+      when 'DateTime'
+        @log.warn("Cell type DateTime not tested")
+        #avoid interpretation in excel, e.g. dates. does not work with numbers.
+        cellcontent = " #{cellcontent}"
+      when nil #no conversion
+        cellcontent = @content
+      else
+        raise ArgumentError, "#{self.class}##{__method__}: Undefined CSV type #{@type}"
+      end
+    cellcontent
+  end #to_csv
 
 end #class Cell
 end #module Excel

data/lib/rexcel/row.rb

@@ -2,50 +2,50 @@ module Excel
 =begin rdoc
 A Row in the spreadsheet.
 =end
-class Row
+  class Row
 =begin rdoc
 Define a new row.
 =end
-  def initialize( options = {})
-    @log = options[:log] || LOGGER
-    @columns = []
-    options.each{|key,value|
-      case key
-        when :log
-        when :style
-          @style = value
-          raise ArgumentError, "Style is no Excel::Style" unless @style.is_a?(Style)
-        else
-          @log.warn("Excel::Row: undefined option #{option}")
-      end
-    }
-  end
-  #Array with columns of this row
-  attr_reader :columns
-  #Style for the row. Is inherited to cells.
-  attr_reader :style
+    def initialize( options = {})
+      @log = options[:log] || LOGGER
+      @columns = []
+      options.each{|key,value|
+        case key
+          when :log
+          when :style
+            @style = value
+            raise ArgumentError, "Style is no Excel::Style" unless @style.is_a?(Style)
+          else
+            @log.warn("Excel::Row: undefined option #{option}")
+        end
+      }
+    end
+    #Array with columns of this row
+    attr_reader :columns
+    #Style for the row. Is inherited to cells.
+    attr_reader :style
 =begin rdoc
 Add content to the Row.
 =end
-  def << (insertion)
-    case insertion
-      when Cell
-        @columns << insertion
-      when Array
-        insertion.each{|value|
-          @columns << Cell.new(value)
-        }
-      when Hash
-        @log.error("Excel::Row: Hashs not supported")
-        raise ArgumentError, "Excel::Row#<<: Hashs not supported"
-        #fixme: if connectuion to worksheet, use columns.
-      when Row, Worksheet, Workbook
-        raise ArgumentError, "Excel::Row#<<: #{insertion.class} not supported"
-      else
-        @columns << Cell.new(insertion)
-      end
-      self  #for usage like " << (Excel::Row.new()  << 'a')"
-  end
+    def << (insertion)
+      case insertion
+        when Cell
+          @columns << insertion
+        when Array
+          insertion.each{|value|
+            @columns << Cell.new(value)
+          }
+        when Hash
+          @log.error("Excel::Row: Hashs not supported")
+          raise ArgumentError, "Excel::Row#<<: Hashs not supported"
+          #fixme: if connectuion to worksheet, use columns.
+        when Row, Worksheet, Workbook
+          raise ArgumentError, "Excel::Row#<<: #{insertion.class} not supported"
+        else
+          @columns << Cell.new(insertion)
+        end
+        self  #for usage like " << (Excel::Row.new()  << 'a')"
+    end
 =begin rdoc
 Build the xml a work sheet row,
 
@@ -53,23 +53,45 @@ ns must be a method-object to implement the namespace definitions.
 
 Format options (bold, italic, colors) are forwarded to cells.
 =end
-  def to_xml(xmlbuilder, ns)
-    raise EmptyError, "Row without content" if @columns.empty?
+    def to_xml(xmlbuilder, ns)
+      raise EmptyError, "Row without content" if @columns.empty?
+      
+      #Build options
+      row_options = {}
+      if @style
+        row_options[ns.call('StyleID')] = @style.style_id 
+      end
+      
+      xmlbuilder[ns.call].Row( row_options ){
+        @columns.each{|column|
+            column.to_xml(xmlbuilder, ns, self)      
+        }
+      }
+    end #to_xml
+=begin rdoc
+Build the row for csv.
+
+Details on options see Rexcel::Worksheet#to_csv
+=end
+    def to_csv(options = {})
+      
+      @log.debug("Prepare csv-row")
+      #Set options defaults
+      options[:sep] ||= ";"
+      
+      csv_row = []
+      self.columns.each_with_index{|col, colnum|
+        @log.debug("Prepare cell #{colnum} for csv-output") if @log.debug?
+        csv_row << col.to_csv()
+        raise ArgumentError, "Cell separator <#{options[:sep]}> is part of the data #{csv_row.last.inspect}" if csv_row.last.to_s.include?(options[:sep])
+        
+      }#columns in row
+
+      csv_row.join(options[:sep])
+    end #build_excel_csv
     
-    #Build options
-    row_options = {}
-    if @style
-      row_options[ns.call('StyleID')] = @style.style_id 
+    def inspect
+      "#<Excel::Row:#{object_id} #{columns.size} Columns>"
     end
-    
-    xmlbuilder[ns.call].Row( row_options ){
-      @columns.each{|column|
-          column.to_xml(xmlbuilder, ns, self)      
-      }
-    }
-  end #to_xml
-  def inspect
-    "#<Excel::Row:#{object_id} #{columns.size} Columns>"
-  end
-end #class Row
+  end #class Row
 end #module Excel

data/lib/rexcel/workbook.rb

@@ -68,69 +68,144 @@ If no actual worksheet is available, a new worksheet i created.
 =begin rdoc
 Build the workbook via OLE.
 
-If a xml-source is available, it is used to build the Excel Workbook.
+The excel may be build in two ways.
 
+* from internal data (previous with Workbook#<< added data)
+* from a xml file
+
+==Internal data
 If no xml-source is available, the internal data are taken to 
 build the xls.
+
 This may take some time...
 
+==Source-reference
+If a reference to a source is available, 
+this reference is used to build the Excel Workbook.
+
+This source reference may be
+* xml
+* csv
+
+You may first save the data as xml and then 
+use the xml to build a xls(x).
+
 For big files, it is recommended to use the way via xml.
 
 =end
-  def prepare_xls(xml_source = nil)
+  def prepare_xls(source_reference = nil)
 
     wb = nil
-    if xml_source
-      if File.exist?(xml_source)
-        @log.info("Use existing #{xml_source}")
-        wb = Excel.instance.xl.Workbooks.OpenXML(File.expand_path(xml_source))
-      else
-        @log.fatal("#{__method__} #{xml_source} missing")
-        raise ArgumentError, 'Source data missing'
-      end
-      return wb
-    end
-    
-    @log.info("Create xls-Workbook")
-    wb = Excel.instance.xl.Workbooks.Add #Includes 3 worksheets
-    #Delete unused sheets.
-    wb.ActiveSheet.delete
-    wb.ActiveSheet.delete
-
-    @log.info("Add styles to document") unless @styles.empty?
-    @styles.each{|name, style|
-      @log.debug("Add style #{name} to document")
-      style.to_xls(wb)
-    }
-
-    first = true
-    #wb.Worksheets.Add appends new worksheets at begin -> reverse for creation to get right sequence.
-    @worksheets.reverse.each{|worksheet|
-      if first
-        worksheet.to_xls(wb.ActiveSheet)
-        first = false
-      else
-        worksheet.to_xls(wb.Worksheets.Add)
-      end
-    }
+    case source_reference
+      when /xml$/
+        if File.exist?(source_reference)
+          @log.info("Use existing #{source_reference}")
+          wb = Excel.instance.xl.Workbooks.OpenXML(File.expand_path(source_reference))
+        else
+          @log.fatal("#{__method__} #{source_reference} missing")
+          raise ArgumentError, 'Source data missing'
+        end
+      when /csv$/
+        if File.exist?(source_reference)
+          @log.info("Use existing #{source_reference}")
+          wb = Excel.instance.xl.Workbooks.Open(File.expand_path(source_reference))
+        else
+          @log.fatal("#{__method__} #{source_reference} missing")
+          raise ArgumentError, 'Source data missing'
+        end
+        
+      when nil
+        @log.info("Create xls-Workbook")
+        wb = Excel.instance.xl.Workbooks.Add #Includes 3 worksheets
+        #Delete unused sheets.
+        wb.ActiveSheet.delete
+        wb.ActiveSheet.delete
+
+        @log.info("Add styles to document") unless @styles.empty?
+        @styles.each{|name, style|
+          @log.debug("Add style #{name} to document")
+          style.to_xls(wb)
+        }
+
+        first = true
+        #wb.Worksheets.Add appends new worksheets at begin -> reverse for creation to get right sequence.
+        @worksheets.reverse.each{|worksheet|
+          if first
+            worksheet.to_xls(wb.ActiveSheet)
+            first = false
+          else
+            worksheet.to_xls(wb.Worksheets.Add)
+          end
+        }
+    end #case source_reference
     wb
   end
 
 =begin rdoc
 Save the workbook.
 
-Filename must end with 
-* xls
-* xlsx
-* xlm (Microsoft Office Word 2003 XML Format)
+The filename must end with 
+* .xls
+* .xlsx
+* .xlm (Microsoft Office Word 2003 XML Format)
+* .csv
+
+Examples:
+  WB = Excel::Workbook.new()
+  # fill WB
+  WB.save('testfile.xls')
+  WB.save('testfile.xlsx')
+  WB.save('testfile.xml')
 
-The optional XML-file is used to create the workbook.
+
+==Save with reference to xml file
+You may create the Excel file based on a xml file.
 
 The way Ruby Workbook -> xml -> xls[x] is faster then the 
 direct xls[x] generation.
+
+Example:
+  WB = Excel::Workbook.new()
+  # fill WB
+  WB.save('testfile.xml')
+  WB.save('testfile_xml.xls', 'testfile.xml')
+
+==Save with reference to csv file
+You may create the Excel file based on a csv file.
+
+* This method is only possible for workbooks with only one worksheets.
+* Attention! You may get problems with field conversion.
+* Therefor the way Ruby Workbook -> xml -> xls[x] is recommended.
+
+Example:
+
+  WB = Excel::Workbook.new()
+  # fill WB
+  WB.save('testfile.csv')
+  WB.save('testfile_xml.xls', 'testfile.csv')
+
+==Save with implicit reference files
+Instead the explicit usage of xml/csv-file, the save command
+can do it implicit
+
+Example: 
+  WB = Excel::Workbook.new()
+  # fill WB
+  WB.save('testfile_xml.xls', :via_xml)
+  WB.save('testfile_xml.xls', :via_csv)
+
 =end
-  def save(path, xml_file = nil)
+  def save(path, source_reference = nil)
     
+    case source_reference
+      when :via_xml
+        source_reference = path.sub(/\.[^\.]+/, '.xml')
+        save(source_reference)
+      when :via_csv
+        source_reference = path.sub(/\.[^\.]+/, '.csv')
+        save(source_reference)
+    end
+      
     @log.info("Save #{path}")
     expath = File.expand_path(path) #Excel needs absolute path
     expath.gsub!(/\//, '\\')# Save the workbook. / must be \
@@ -138,12 +213,12 @@ direct xls[x] generation.
       #different formats, see http://msdn.microsoft.com/en-us/library/microsoft.office.interop.excel.xlfileformat.aspx
       case path
         when /xlsx$/
-          wb = prepare_xls(xml_file)
+          wb = prepare_xls(source_reference)
           @log.info("Save #{path}")
           wb.SaveAs(expath, 51)
           wb.Close
         when /xls$/
-          wb = prepare_xls(xml_file)
+          wb = prepare_xls(source_reference)
           @log.info("Save #{path}")
           wb.SaveAs(expath, -4143 ) #excel97_2003_format
           wb.Close
@@ -160,6 +235,10 @@ The namespace must be used before its definition (Tag Workbook)
           File.open(path, 'w'){|f| 
               f << build_excel_xml(ns)
           }          
+        when /csv$/
+          File.open(path, 'w'){|f| 
+              f << build_excel_csv()
+          }                  
         else
           @log.fatal("Wrong filename, no xls/xlsx (#{path})")
           raise ArgumentError, "Wrong filename, no xls/xlsx (#{path})"
@@ -224,6 +303,25 @@ Descriptions and examples:
               ).strip.gsub(/<(\/?)Workbook/, '<\1%s:Workbook' % namespace )
               
   end #build_excel_xml
+=begin rdoc
+Build the csv for Excel.
+
+Details on options see Rexcel::Worksheet#to_csv and Rexcel::Cell#to_csv.
+=end
+  def build_excel_csv(options = {})
+    
+    csv = []
+    count = 0 #counter for filled worksheets
+    @log.debug("Prepare csv")
+    @worksheets.each{|worksheet|
+        next if worksheet.rows.empty?
+        csv << worksheet.to_csv(options)
+        count += 1
+      } #Worksheets
+    
+    raise ArgumentError, "csv not possible for multiple worksheets" if count > 1
+    csv.join()
+  end #build_excel_csv
 
 end #class Workbook
 end #module Excel