rexcel 0.1.0

data/benchmark/rexcel_benchmark.rb

@@ -0,0 +1,70 @@
+require 'benchmark'
+$:.unshift("../lib")
+require 'rexcel'
+Excel::LOGGER.level = Log4r::OFF #no messages
+
+def delete_testfiles()
+  %w{test.xml test.xls test.xlsx}.each{|fn|
+    File.delete(fn) if File.exist?(fn)
+  }
+end #delete_testfiles
+delete_testfiles
+
+def test(rownumber)
+  puts "======Test with #{rownumber} rows"
+  wb = Excel::Workbook.new()
+  rownumber.times{
+  wb << [1,2,3,4,5,6,7]
+  wb << [:a, :b, :c, :d, :e, :f]
+  }
+
+  Benchmark.bm do |x|
+    x.report('xml     ') {  wb.save('test.xml') }    
+    x.report('xml2xls ') {  wb.save('test.xls', 'test.xml')}
+    x.report('xml2xlsx') {  wb.save('test.xlsx', 'test.xml')}
+    
+    delete_testfiles
+    x.report('xls     ') {  wb.save('test.xls') }
+    delete_testfiles
+    x.report('xlsx    ') {  wb.save('test.xlsx') }
+    delete_testfiles
+  end
+end
+
+test(  10)
+test( 500)
+test(1000)
+test(5000)
+
+
+__END__
+My Testresult:
+
+======Test with 10 rows
+      user     system      total        real
+xml       0.031000   0.078000   0.109000 (  0.124771)
+xml2xls   0.000000   0.015000   0.015000 (  2.760563)
+xml2xlsx  0.000000   0.016000   0.016000 (  0.452296)
+xls       0.016000   0.000000   0.016000 (  0.701838)
+xlsx      0.031000   0.015000   0.046000 (  0.717435)
+======Test with 500 rows
+      user     system      total        real
+xml       0.875000   0.016000   0.891000 (  0.951380)
+xml2xls   0.000000   0.016000   0.016000 (  0.483488)
+xml2xlsx  0.000000   0.000000   0.000000 (  0.452296)
+xls       1.000000   0.265000   1.265000 (  6.316542)
+xlsx      1.062000   0.375000   1.437000 (  6.456910)
+======Test with 1000 rows
+      user     system      total        real
+xml       1.813000   0.015000   1.828000 (  1.840375)
+xml2xls   0.000000   0.000000   0.000000 (  0.530278)
+xml2xlsx  0.000000   0.000000   0.000000 (  0.561470)
+xls       2.015000   0.766000   2.781000 ( 13.366115)
+xlsx      2.688000   0.906000   3.594000 ( 14.676212)
+======Test with 5000 rows
+      user     system      total        real
+xml       9.594000   0.062000   9.656000 (  9.841328)
+xml2xls   0.000000   0.000000   0.000000 (  1.575237)
+xml2xlsx  0.000000   0.000000   0.000000 (  1.138537)
+xls      24.234000   4.500000  28.734000 (145.873129)
+xlsx     31.938000   4.453000  36.391000 (161.625493)

data/examples/example.rb

@@ -0,0 +1,29 @@
+$:.unshift('../lib') if $0 == __FILE__
+require 'rexcel'
+Excel::LOGGER.level = Log4r::DEBUG
+
+wb = Excel::Workbook.new('data')
+
+wb << [1,2,3,4,5,6,7]
+wb << [:a, :b, :c, :d, :e, :f]
+
+
+wb << ws = Excel::Worksheet.new('Formats')
+ws << row = Excel::Row.new
+row << cell = Excel::Cell.new(1)
+
+wb << style = Excel::Style.new('bold', :bold=> true, :backgroundcolor => 15)
+row << cell = Excel::Cell.new('Bold', :style => style)
+#~ puts wb.build_excel_xml('ss')
+
+wb << style = Excel::Style.new('boldit', :bold=> true, :bold => true, :italic => true)
+row << cell = Excel::Cell.new('Bold and italic', :style => style)
+
+wb << style = Excel::Style.new('gray', :color => 18, :backgroundcolor => 27)
+row << cell = Excel::Cell.new('grau text', :style => style)
+
+    
+wb.save('test.xml')
+wb.save('test_xml.xls', 'test.xml')
+wb.save('test.xls')
+wb.save('test.xlsx')

data/examples/example_color.rb

@@ -0,0 +1,43 @@
+$:.unshift('../lib') if $0 == __FILE__
+require 'rexcel'
+
+wb = Excel::Workbook.new()
+wb << ws = Excel::Worksheet.new('Colors')
+
+# For each color in color index
+1.upto(56) do |i|
+  wb << style       = Excel::Style.new("color%02i" % i, :color => i)
+  wb << styleback = Excel::Style.new("backgroundcolor%02i" % i, :backgroundcolor => i)
+
+  ws  << row = Excel::Row.new
+  row << cell = Excel::Cell.new("Font color %02i" % i, :style => style)
+  row << cell = Excel::Cell.new("Background %02i" % i, :style => styleback)
+end
+
+#
+#Color matrix
+#
+wb << ws = Excel::Worksheet.new('Color matrix')
+ws  << firstrow = Excel::Row.new
+firstrow << cell = Excel::Cell.new
+1.upto(56) do |i2|
+  firstrow << Excel::Cell.new("Background %02i" % i2)
+end
+
+1.upto(56) do |i1|
+  ws  << row = Excel::Row.new
+  row << Excel::Cell.new("Font color %02i" % i1)
+  1.upto(56) do |i2|
+    wb << style       = Excel::Style.new("color%02i-%02i" % [i1, i2], :color => i1, :backgroundcolor => i2)
+    row << Excel::Cell.new("Color %02i/%02i" % [i1, i2], :style => style, :string => true)
+  end
+end
+
+
+wb.save('colors.xml')
+wb.save('colors_xml.xlsx', 'colors.xml')
+wb.save('colors.xls')
+wb.save('colors.xlsx')
+
+Excel::Excel.instance.close
+

data/examples/example_format.rb

@@ -0,0 +1,23 @@
+$:.unshift('../lib') if $0 == __FILE__
+require 'rexcel'
+Excel::LOGGER.level = Log4r::DEBUG
+
+wb << ws = Excel::Worksheet.new('Formats')
+ws << row = Excel::Row.new
+row << cell = Excel::Cell.new(1)
+
+wb << style = Excel::Style.new('bold', :bold=> true, :backgroundcolor => 15)
+row << cell = Excel::Cell.new('Bold', :style => style)
+#~ puts wb.build_excel_xml('ss')
+
+wb << style = Excel::Style.new('boldit', :bold=> true, :bold => true, :italic => true)
+row << cell = Excel::Cell.new('Bold and italic', :style => style)
+
+wb << style = Excel::Style.new('gray', :color => 18, :backgroundcolor => 27)
+row << cell = Excel::Cell.new('grau text', :style => style)
+
+    
+wb.save('test_format.xml')
+wb.save('test_xml.xls', 'test_format.xml')
+wb.save('test_format.xls')
+wb.save('test_format.xlsx')

data/lib/rexcel.rb

@@ -0,0 +1,166 @@
+#encoding: utf-8
+=begin rdoc
+: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.
+
+
+=end
+require 'win32ole'
+require 'log4r'
+require 'singleton'
+
+=begin rdoc
+Frame for Excel-tools.
+=end
+module Excel
+  VERSION = '0.1.0'
+
+  LOGGER = Log4r::Logger.new( name )#, Log4r::DEBUG, :trunc => true )
+  LOGGER.outputters << Log4r::StdoutOutputter.new('std', :level => Log4r::WARN )
+
+=begin rdoc
+Singleton for Excel.
+
+Will be closed at END.
+=end
+  class Excel
+    include Singleton
+    def initialize()
+      reconnect()
+    end
+=begin rdoc
+Create OLE-object.
+=end
+    def reconnect()
+      return @xl if @xl
+      # Create an instance of the Excel application object
+      @xl = WIN32OLE.new('Excel.Application')
+      # Make Excel visible  1=visible 0=not visible
+      @xl.Visible = 0
+      #~ xl.Interactive = false  #visible, but no input allowed
+      #~ xl.ScreenUpdating = false  #make it faster
+      @xl.DisplayAlerts = false  #No alerts like "don't overwrite
+      
+    end
+    #OLE-object
+    attr_reader :xl
+=begin rdoc
+Make sure Excel is closed.
+
+Called at END to be sure it's really closed.
+
+See http://forum.ruby-portal.de/viewtopic.php?f=22&t=11667
+
+When closed once: Don't create it again. There may be errors.
+=end
+    def close()
+      return unless @xl
+      @xl.Quit  #Leider Kein effekt.
+      WIN32OLE.ole_free(@xl) 
+      @xl = nil
+    end    
+  end #class Excel
+=begin rdoc
+Exceptionclass for empty Workbook, Worksheet, Row
+=end
+  class EmptyError < Exception; end
+end #module Excel
+
+=begin
+makes problems in unit test
+=end
+#~ at_exit { 
+  #~ Excel::Excel.instance.close
+#~ }
+
+
+require 'rexcel/workbook'
+require 'rexcel/worksheet'
+require 'rexcel/row'
+require 'rexcel/cell'
+require 'rexcel/style'
+
+=begin
+Open:
+* Height (only Row)
+* Width (Column)
+
+Styles??
+class Style
+  def initialize(name)
+  
+  end
+  #Bold
+  attr_accessor :bold
+  #Italic
+  attr_accessor :italic
+  #Color
+  attr_accessor :color
+  #Background Color
+  attr_accessor :backgroundcolor
+end
+
+Columns
+(actual only sequence.
+missing:
+* title
+* width
+=end

data/lib/rexcel/cell.rb

@@ -0,0 +1,130 @@
+module Excel
+=begin rdoc
+Cell of a Worksheet.
+
+A cell is part of a Row.
+
+Cells define
+* Type .
+  The type is defined by the type of the content.
+  * String
+  * Number
+  * DateTime (not supported/tested yet)
+* Style (Reference to Excel::Style instance)
+=end
+class Cell
+  TYPES = [
+    nil,  #
+    :string,
+  ]
+  
+=begin rdoc
+Define a cell and add the content.
+
+Options:
+* :string [true/false]
+* :log: Replacement for the default Logger.
+* :style see Excel::Style
+=end
+  def initialize( content = nil, options = {})
+    @log = options[:log] || LOGGER
+    options.each{|key,value|
+      case key
+        when :log
+        when :string
+           @type = 'String' if value
+        when :style
+          @style = value
+          raise ArgumentError, "Style is no Excel::Style" unless @style.is_a?(Style)
+        else
+          @log.warn("Excel::Cell: undefined option #{options}")
+      end
+    }
+    @content = content      
+    @type = get_excel_type() unless @type
+  end
+  #Content of the cell
+  attr_reader :content
+  #Target type for Excel
+  attr_reader :type
+  #Style
+  attr_reader :style
+
+=begin rdoc
+Supported Excel types:
+* Number
+* String
+* DateTime 
+  Example: 2010-02-01T00:00:00.000
+=end
+  def get_excel_type()
+    case content
+      #~ when Rational #-> Formula?
+      when Numeric #Fixnum, Bignum, Float
+        @type = 'Number'
+      when Time #Date
+        @type = 'DateTime'
+        @log.warn("Cell type DateTime not tested")
+      else
+        @type = 'String'
+    end
+  end #def get_excel_type()
+  protected :get_excel_type
+    
+=begin rdoc
+Build the xml a work sheet row,
+
+ns must be a method-object to implement the namespace definitions.
+=end
+  def to_xml(xmlbuilder, ns, row = nil)
+        #~ ns.call(:StyleID)=>"1"
+    
+    cell_options = {}
+    if @style
+      cell_options[ns.call('StyleID')] = @style.style_id 
+    #~ elsif row and row.style
+      #~ cell_options[ns.call('StyleID')] = row.style.style_id 
+    end
+    xmlbuilder[ns.call].Cell(cell_options){
+      #~ options[ns.call('Type')] = @type
+      xmlbuilder[ns.call].Data(@content, ns.call('Type') => @type )
+    }
+  end #to_xml
+
+=begin rdoc
+Fill an Excel field.
+Receives a OLE-cell and optional a row.
+
+* value is added
+* format is set (depending on cell and row format).
+
+=end
+  def to_xls(cell, row = nil)
+    case @type
+      when 'String'  #Suppress automatic conversion from Excel
+        cell.NumberFormat = "@" #as String
+        cell.Value = @content.to_s
+      when 'Number'
+        cell.Value = @content
+      when 'DateTime'
+        @log.warn("Cell type DateTime not tested")
+        cell.Value = @content
+      when nil #no conversion
+        cell.Value = @content
+      else
+        raise ArgumentError, "#{self.class}##{__method__}: Undefined Excel type #{@type}"
+      end
+    #Style must be defined in Workbook
+    #As long I don't know how to do it, I will use Style#to_xls_direct
+    if @style
+      #~ cell.Style = @style.style_id #
+      @style.to_xls_direct(cell)
+    elsif row and row.style
+      row.style.to_xls_direct(cell)
+    end
+    cell
+  end #to_xls
+
+
+end #class Cell
+end #module Excel