rexcel 0.1.0

data/lib/rexcel/row.rb

@@ -0,0 +1,73 @@
+module Excel
+=begin rdoc
+A Row in the spreadsheet.
+=end
+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
+=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
+=begin rdoc
+Build the xml a work sheet row,
+
+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?
+    
+    #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
+  
+end #class Row
+end #module Excel

data/lib/rexcel/style.rb

@@ -0,0 +1,224 @@
+module Excel
+=begin rdoc
+Style definition for Excel.
+The styles can be assigned to the Cell and Row.
+
+You can define:
+* Font characteristic: bold/italic
+* Color and background color (Based on ColorIndex)
+
+You can (yet) not define:
+* Font type
+
+=end
+class Style
+  #
+  #Some colors.
+  #
+  #Colors are adminstrated by a ColorIndex.
+  #This Hash is a reconversion.
+  #
+  #See also http://www.mvps.org/dmcritchie/excel/colors.htm
+  ColorIndex = {
+    1=> '#000000',
+    2=> '#FFFFFF',
+    3=> '#FF0000',
+    4=> '#00FF00',
+    5=> '#0000FF',
+    6=> '#FFFF00',
+    7=> '#FF00FF',
+    8=> '#00FFFF',
+    9=> '#800000',
+    10=> '#008000',
+    11=> '#000080',
+    12=> '#808000',
+    13=> '#800080',
+    14=> '#008080',
+    15=> '#C0C0C0', #gray
+    16=> '#808080',
+    17=> '#9999FF',
+    18=> '#993366',
+    19=> '#FFFFCC',
+    20=> '#CCFFFF',
+    21=> '#660066',
+    22=> '#FF8080',
+    23=> '#0066CC',
+    24=> '#CCCCFF',
+    25=> '#000080',
+    26=> '#FF00FF',
+    27=> '#FFFF00',
+    28=> '#00FFFF',
+    29=> '#800080',
+    30=> '#800000',
+    31=> '#008080',
+    32=> '#0000FF',
+    33=> '#00CCFF',
+    34=> '#CCFFFF',
+    35=> '#CCFFCC',
+    36=> '#FFFF99',
+    37=> '#99CCFF',
+    38=> '#FF99CC',
+    39=> '#CC99FF',
+    40=> '#FFCC99',
+    41=> '#3366FF',
+    42=> '#33CCCC',
+    43=> '#99CC00',
+    44=> '#FFCC00',
+    45=> '#FF9900',
+    46=> '#FF6600',
+    47=> '#666699',
+    48=> '#969696',
+    49=> '#003366',
+    50=> '#339966',
+    51=> '#003300',
+    52=> '#333300',
+    53=> '#993300',
+    54=> '#993366',
+    55=> '#333399',
+    56=> '#333333',
+}
+=begin rdoc
+Create a new style.
+
+Options:
+* bold
+* italic
+* color (not supported yet)
+* backgroundcolor (not supported yet)
+
+Not implemented (yet)
+* Fontsize
+* Font
+=end
+  def initialize(name, options = {})
+    @name = name
+    @log = options[:log] || LOGGER    
+    @log.debug( "Create Style #{name}")
+    
+    options.each{|key,value|
+      case key
+        when :log
+        when :bold
+          self.bold = value
+          @log.debug( "Style #{name}: Set #{key}")
+        when :italic
+          self.italic = value
+          @log.debug( "Style #{name}: Set #{key}")          
+        when :color, :colour
+          if ColorIndex[value]
+            self.color = value
+            @log.debug( "Style #{name}: Set color #{key}")
+          else
+            @log.error( "Style #{name}: Usage of undefined color #{value}")
+          end
+        when :backgroundcolor, :backgroundcolour
+          if ColorIndex[value]
+            self.backgroundcolor = value
+            @log.debug( "Style #{name}: Set backgroundcolor #{key}")
+          else
+            @log.error( "Style #{name}: Usage of undefined color #{value}")
+          end
+        else
+          @log.warn("Excel::Style: undefined option #{option}")
+      end
+    }
+      
+    @style_id = nil #Set by Workbook
+  end
+  #Name of the Sytle. for usage inside ruby
+  attr_reader :name
+  
+=begin rdoc
+Define Style ID. For usage in XML/XLS.
+
+(Set by Workbook#<<)
+=end 
+  def style_id=(id)
+    raise ArgumentError, "Second id for style #{@name}" if @style_id
+    @log.debug( "Set Style-id #{id} for #{name}")
+    
+    @style_id = id
+  end
+  #Style ID. For usage in XML/XLS.
+  attr_reader :style_id
+
+  #Bold
+  attr_accessor :bold
+  #Italic
+  attr_accessor :italic
+  #Color. Must be defined in ColorIndex
+  attr_accessor :color
+  #Background Color. Must be defined in ColorIndex
+  attr_accessor :backgroundcolor
+=begin rdoc
+Build the xml a work sheet style definition,
+
+ns must be a method-object to implement the namespace definitions.
+=end
+  def to_xml(xmlbuilder, ns)
+    xmlbuilder[ns.call].Style( ns.call(:ID) => @style_id ){
+      fontoption = {}
+      fontoption[ns.call(:Bold)]  = "1"  if bold
+      fontoption[ns.call(:Italic)] = "1"  if italic
+      if color  #Set font color
+        if ColorIndex[color]
+          fontoption[ns.call(:Color)] = ColorIndex[color] 
+        else
+          @log.error("Color #{color.inspect} not defined in ColorIndex")
+        end
+      end      
+      xmlbuilder[ns.call].Font(fontoption) unless fontoption.empty?
+
+      if backgroundcolor
+        if ColorIndex[backgroundcolor]
+          xmlbuilder[ns.call].Interior(
+            ns.call(:Color) => ColorIndex[backgroundcolor],
+            ns.call(:Pattern) => "Solid"
+          )
+        else
+          @log.error("ColorIndex #{backgroundcolor.inspect} not defined")
+        end
+      end
+    }
+  end #to_xml
+=begin rdoc
+Define Excel style.
+
+Receives a OLE-work book
+
+How to do it??
+
+Unless this function is working, use #to_xls_direct
+=end      
+  def to_xls(wb)
+    #~ @log.fatal("#{self.class}##{__method__} not supported.") unless @@xls_warning_made
+    @@xls_warning_made = true  #only once
+    @log.info("Cells include format options directly")
+  end #to_xls
+  @@xls_warning_made = false  
+=begin rdoc
+Attach style information directly to the OLE-Object (row/cell)
+
+Receives a OLE-object
+
+This method is only a interim solution until I found the way to 
+use styles with ole. (#to_xls).
+=end      
+  def to_xls_direct(cell)
+
+      #if the cell has bold=false, the row-setting is overwritten
+      if bold 
+        cell.Font.Bold = true
+      end
+      if italic
+        cell.Font.Italic = true
+      end
+      if color
+        cell.Font.ColorIndex  = color
+      end 
+      if backgroundcolor
+        cell.Interior.ColorIndex = backgroundcolor
+      end
+  end #to_xls
+end #class Stylwe
+end #module Excel

data/lib/rexcel/workbook.rb

@@ -0,0 +1,229 @@
+=begin rdoc
+Workbook definitions.
+=end
+require 'nokogiri'
+
+module Excel
+=begin rdoc
+This Workbook will become an Excel-File.
+
+Workbooks contains one or more Worksheet.
+=end
+class Workbook
+=begin rdoc
+Create a workbook.
+
+Container for 
+* Style #styles
+* Worksheets
+=end
+    def initialize( logger = nil)
+      
+      @log = logger || LOGGER
+      raise ArgumentError, "Workbook: No logger" unless @log.is_a?(Log4r::Logger)
+      @log.info("Create Workbook")
+  
+      @styles = {}
+      @worksheets = []
+      @active_worksheet = nil
+      #~ @header = []
+      #~ @content = []
+    end
+    #Worksheets
+    attr_reader :worksheets
+    #Predefined styles.
+    attr_reader :styles
+    #Active worksheet
+    attr_reader :active_worksheet
+=begin rdoc
+Add content to the workbook.
+* Excel#Worksheet
+* Array: Added to the actual worksheet.
+* Hash: Added to the actual worksheet.
+* Row: Added the actual worksheet.
+
+If no actual worksheet is available, a new worksheet i created.
+=end
+  def << (insertion)
+    case insertion
+      when Style  #Excel::Style      
+        if @styles[insertion.name]
+          @log.warn("Duplicate insertion #{@name} for Style")
+        else
+          @styles[insertion.name] = insertion
+          insertion.style_id = @styles.size
+        end
+      when Worksheet  
+        @worksheets << insertion
+        @active_worksheet = insertion
+      when Array, Hash, Row
+        self << Worksheet.new("Sheet#{@worksheets.size}", :log => @log) unless @active_worksheet
+        @active_worksheet << insertion
+      else
+        raise ArgumentError, "#{Workbook}: Wrong insertion type #{insertion.inspect}"
+    end
+    self
+  end
+
+=begin rdoc
+Build the workbook via OLE.
+
+If a xml-source is available, it is used to build the Excel Workbook.
+
+If no xml-source is available, the internal data are taken to 
+build the xls.
+This may take some time...
+
+For big files, it is recommended to use the way via xml.
+
+=end
+  def prepare_xls(xml_source = 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
+    @worksheets.each{|worksheet|
+      if first
+        worksheet.to_xls(wb.ActiveSheet)
+        first = false
+      else
+        @log.error("#{__method__}: Wrong worksheet sequence")
+        worksheet.to_xls(wb.Worksheets.Add)
+      end
+    }
+    wb
+  end
+
+=begin rdoc
+Save the workbook.
+
+Filename must end with 
+* xls
+* xlsx
+* xlm (Microsoft Office Word 2003 XML Format)
+
+The optional XML-file is used to create the workbook.
+
+The way Ruby Workbook -> xml -> xls[x] is faster then the 
+direct xls[x] generation.
+=end
+  def save(path, xml_file = nil)
+    
+    @log.info("Save #{path}")
+    expath = File.expand_path(path) #Excel needs absolute path
+    expath.gsub!(/\//, '\\')# Save the workbook. / must be \
+    begin
+      #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)
+          @log.info("Save #{path}")
+          wb.SaveAs(expath, 51)
+          wb.Close
+        when /xls$/
+          wb = prepare_xls(xml_file)
+          @log.info("Save #{path}")
+          wb.SaveAs(expath, -4143 ) #excel97_2003_format
+          wb.Close
+        when /xml$/
+=begin rdoc
+Save "Microsoft Office Word 2003 XML Format". 
+
+Special rules:
+* The last CR must be deleted. Else Excel doesn't accept the xml
+* There must be a name space.
+The namespace must be used before its definition (Tag Workbook)
+=end        
+          ns = 'ss' #namespace
+          File.open(path, 'w'){|f| 
+              f << build_excel_xml(ns)
+          }          
+        else
+          @log.fatal("Wrong filename, no xls/xlsx (#{path})")
+          raise ArgumentError, "Wrong filename, no xls/xlsx (#{path})"
+      end
+    rescue WIN32OLERuntimeError => err
+      @log.error("Error #{path} (Opened in Excel?) #{err}")
+    end
+    # Close the workbook
+    
+  end #save_workbook
+
+
+=begin rdoc
+Build the XML for Excel ("Microsoft Office Word 2003 XML Format")
+
+Requires a namespace for the xml.
+
+Special rules:
+* The last CR must be deleted. Else Excel doesn't accept the xml
+* There must be a name space.
+The namespace must be used before its definition (Tag Workbook)
+
+Example:
+* http://blogs.msdn.com/b/brian_jones/archive/2005/06/27/433152.aspx
+
+XSD:
+* http://www.microsoft.com/downloads/en/details.aspx?familyid=fe118952-3547-420a-a412-00a2662442d9&displaylang=en
+
+Descriptions and examples:
+ http://en.wikipedia.org/wiki/Microsoft_Office_XML_formats
+=end
+  def build_excel_xml(namespace)
+    
+    #Define method ns
+    self.class.class_eval(%{
+      def ns(attr=nil)
+        attr ?  "%s:%s" % ['#{namespace}', attr] : '#{namespace}'
+      end
+    })
+    
+    @log.debug("Prepare XML")
+    builder = Nokogiri::XML::Builder.new() { |xmlbuilder|
+      #~ xmlbuilder.Workbook( 'xmlns'=>"urn:schemas-microsoft-com:office:spreadsheet"){
+      xmlbuilder.Workbook( "xmlns:#{namespace}"  =>"urn:schemas-microsoft-com:office:spreadsheet"){
+        #Add Styles
+        xmlbuilder[ns].Styles{
+          @styles.each{|name,style|
+            style.to_xml(xmlbuilder, method(:ns))
+          }
+        } unless @styles.empty?
+        #Add worksheets
+        @worksheets.each{|worksheet|
+          worksheet.to_xml(xmlbuilder, method(:ns))
+        }
+      } #Workbook
+    } #@builder
+    
+    builder.to_xml(
+                #~ :encoding => 'utf-8',
+                :indent => 4,
+                :save_with => Nokogiri::XML::Node::SaveOptions::FORMAT
+              ).strip.gsub(/<(\/?)Workbook/, '<\1%s:Workbook' % namespace )
+              
+  end #build_excel_xml
+
+end #class Workbook
+end #module Excel