spreadsheet 0.6.0 → 0.6.1

data/History.txt

@@ -1,3 +1,11 @@
+=== 0.6.1 / 2008-10-17
+
+* 3 minor enhancements
+
+  * Adds Column formatting and Worksheet#format_column
+  * Reads and writes correct Fonts (Font-indices > 3 appear to be 1-based)
+  * Reads xf data
+
 === 0.6.0 / 2008-10-13
 
 * 1 major enhancement

data/README.txt

@@ -1,6 +1,13 @@
+Last Update: 13.10.2008, 19.45 - zdavatz
+
 = Spreadsheet
 
   http://spreadsheet.rubyforge.org
+  http://scm.ywesee.com/spreadsheet
+
+For a viewable directory of all recent changes, please see:
+
+  http://scm.ywesee.com/?p=spreadsheet;a=summary
 
 == Description
 
@@ -34,6 +41,16 @@ Hannes Wyss. Spreadsheet can read, write and modify Spreadsheet Documents.
 
 Have a look at the GUIDE[link://files/GUIDE_txt.html].
 
+== Installation
+
+Using RubyGems[http://www.rubygems.org]:
+
+* sudo gem install spreadsheet
+
+If you don't like RubyGems[http://www.rubygems.org], let me know which
+installation solution you prefer and I'll include it in the future.
+
+
 == Authors
 
 Original Code:
@@ -49,6 +66,6 @@ Copyright (c) 2008 by Hannes Wyss (hannes.wyss@gmail.com)
 
 == License
 
-This library is distributed under the GPL. 
+This library is distributed under the GPL.
 Please see the LICENSE[link://files/LICENSE_txt.html] file.
 

data/Rakefile

@@ -10,6 +10,7 @@ Hoe.new('spreadsheet', Spreadsheet::VERSION) do |p|
   # p.rubyforge_name = 'spreadsheetx' # if different than lowercase project name
    p.developer('Hannes Wyss', 'hannes.wyss@gmail.com')
    p.remote_rdoc_dir = ''
+   p.extra_deps << 'ruby-ole'
 end
 
 # vim: syntax=Ruby

data/lib/spreadsheet.rb

@@ -42,7 +42,7 @@ module Spreadsheet
 
   ##
   # The version of Spreadsheet you are using.
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 
   ##
   # Default client Encoding. Change this value if your application uses a

data/lib/spreadsheet/excel.rb

@@ -34,6 +34,16 @@ module Spreadsheet
     end
   end
   class Worksheet
+    unless instance_methods.include? "new_format_column"
+      alias :new_format_column :format_column
+      def format_column column, width=nil, format=nil
+        if width.is_a? Format
+          new_format_column column, width, format
+        else
+          new_format_column column, format, :width => width
+        end
+      end
+    end
     def write row, col, data=nil, format=nil
       if data.is_a? Array
         write_row row, col, data, format

data/lib/spreadsheet/excel/internals.rb

@@ -94,6 +94,7 @@ module Internals
   BINARY_FORMATS = {
     :blank      => 'v3',
     :boolerr    => 'v3C2',
+    :colinfo    => 'v5x2',
     :font       => 'v5C3x',
     :labelsst   => 'v3V',
     :number     => "v3#{EIGHT_BYTE_DOUBLE}",
@@ -107,7 +108,7 @@ module Internals
   # default in a US-English environment. All indexes from 0 to 163 are
   # reserved for built-in formats.
   BUILTIN_FORMATS = { # TODO: locale support
-     0 => 'General',
+     0 => 'GENERAL',
      1 => '0',
      2 => '0.00',
      3 => '#,##0',
@@ -196,34 +197,35 @@ module Internals
   }
   LEAP_ERROR = Date.new 1900, 2, 28
   OPCODES = {
-    :blank        => 0x0201,
-    :boolerr      => 0x0205,
-    :boundsheet   => 0x0085,
-    :codepage     => 0x0042,
-    :continue     => 0x003c,
-    :datemode     => 0x0022,
-    :dbcell       => 0x0a0b,
-    :dimensions   => 0x0200,
-    :eof          => 0x000a,
-    :extsst       => 0x00ff,
-    :font         => 0x0031,
-    :format       => 0x041e,
-    :formula      => 0x0006,
-    :index        => 0x020b,
-    :label        => 0x0204,
-    :labelsst     => 0x00fd,
-    :mulblank     => 0x00be,
-    :mulrk        => 0x00bd,
-    :number       => 0x0203,
-    :rk           => 0x027e,
-    :row          => 0x0208,
-    :rstring      => 0x00d6,
-    :sst          => 0x00fc,
-    :string       => 0x0207,
-    :style        => 0x0293,
-    :uncalced     => 0x005e,
-    :xf           => 0x00e0,
+    :blank        => 0x0201, #    BLANK ➜ 6.7
+    :boolerr      => 0x0205, #    BOOLERR ➜ 6.10
+    :boundsheet   => 0x0085, # ●● BOUNDSHEET ➜ 6.12
+    :codepage     => 0x0042, # ○  CODEPAGE ➜ 6.17
+    :colinfo      => 0x007d, # ○○ COLINFO ➜ 6.18
+    :continue     => 0x003c, # ○  CONTINUE ➜ 6.22
+    :datemode     => 0x0022, # ○  DATEMODE ➜ 6.25
+    :dbcell       => 0x0a0b, # ○  DBCELL
+    :dimensions   => 0x0200, # ●  DIMENSIONS ➜ 6.31
+    :eof          => 0x000a, # ●  EOF ➜ 6.36
+    :font         => 0x0031, # ●● FONT ➜ 6.43
+    :format       => 0x041e, # ○○ FORMAT (Number Format) ➜ 6.45
+    :formula      => 0x0006, #    FORMULA ➜ 6.46
+    :label        => 0x0204, #    LABEL ➜ 6.59 (BIFF2-BIFF7)
+    :labelsst     => 0x00fd, #    LABELSST ➜ 6.61 (BIFF8 only)
+    :mulblank     => 0x00be, #    MULBLANK ➜ 6.64 (BIFF5-BIFF8)
+    :mulrk        => 0x00bd, #    MULRK ➜ 6.65 (BIFF5-BIFF8)
+    :number       => 0x0203, #    NUMBER ➜ 6.68
+    :rk           => 0x027e, #    RK ➜ 6.82 (BIFF3-BIFF8)
+    :row          => 0x0208, # ●  ROW ➜ 6.83
+    :rstring      => 0x00d6, #    RSTRING ➜ 6.84 (BIFF5/BIFF7)
+    :sst          => 0x00fc, # ●  SST ➜ 6.96
+    :string       => 0x0207, #    STRING ➜ 6.98
+    :style        => 0x0293, # ●● STYLE ➜ 6.99
+    :xf           => 0x00e0, # ●● XF ➜ 6.115
     ########################## Unhandled Opcodes ################################
+    :extsst       => 0x00ff, # ●  EXTSST ➜ 6.40
+    :index        => 0x020b, # ○  INDEX ➜ 5.7 (Row Blocks), ➜ 6.55
+    :uncalced     => 0x005e, # ○  UNCALCED ➜ 6.104
     ########################## ○  Calculation Settings Block ➜ 5.3
     :calccount    => 0x000c, # ○  CALCCOUNT ➜ 6.14
     :calcmode     => 0x000d, # ○  CALCMODE ➜ 6.15
@@ -296,7 +298,6 @@ module Internals
     :defrowheight => 0x0225, # ○  DEFAULTROWHEIGHT ➜ 6.28
     :wsbool       => 0x0081, # ○  WSBOOL ➜ 6.113
     :defcolwidth  => 0x0055, # ○  DEFCOLWIDTH ➜ 6.29
-    :colinfo      => 0x007d, # ○○ COLINFO ➜ 6.18
     :sort         => 0x0090, # ○  SORT ➜ 6.95
   }
 =begin ## unknown opcodes
@@ -311,6 +312,31 @@ module Internals
     0x0022 => :double_accounting,
   }
   SEPYT_ENILREDNU = UNDERLINE_TYPES.invert
+  XF_H_ALIGN = {
+    :default       => 0,
+    :left          => 1,
+    :center        => 2,
+    :right         => 3,
+    :fill          => 4,
+    :justify       => 5,
+    :merge         => 6,
+    :distributed   => 7,
+  }
+  NGILA_H_FX = XF_H_ALIGN.invert
+  XF_TEXT_DIRECTION = {
+    :context       => 0,
+    :left_to_right => 1,
+    :right_to_left => 2,
+  }
+  NOITCERID_TXET_FX = XF_TEXT_DIRECTION.invert
+  XF_V_ALIGN = {
+    :top         => 0,
+    :middle      => 1,
+    :bottom      => 2,
+    :justify     => 3,
+    :distributed => 4,
+  }
+  NGILA_V_FX = XF_V_ALIGN.invert
   def binfmt key
     BINARY_FORMATS[key]
   end

data/lib/spreadsheet/excel/reader.rb

@@ -107,6 +107,7 @@ class Reader
     extend_reader biff
     extend_internals biff
     read_workbook
+    @workbook.default_format = @workbook.format 0
     @workbook
   end
   def read_blank worksheet, addr, work
@@ -181,6 +182,31 @@ class Reader
     codepage, _ = work.unpack 'v'
     @workbook.set_encoding encoding(codepage), pos, len
   end
+  def read_colinfo worksheet, work, pos, len
+    # Offset  Size  Contents
+    #      0     2  Index to first column in the range
+    #      2     2  Index to last column in the range
+    #      4     2  Width of the columns in 1/256 of the width of the zero
+    #               character, using default font (first FONT record in the
+    #               file)
+    #      6     2  Index to XF record (➜ 6.115) for default column formatting
+    #      8     2  Option flags:
+    #               Bits  Mask    Contents
+    #                  0  0x0001  1 = Columns are hidden
+    #               10-8  0x0700  Outline level of the columns (0 = no outline)
+    #                 12  0x1000  1 = Columns are collapsed
+    #     10     2  Not used
+    first, last, width, xf, opts = work.unpack binfmt(:colinfo)[0..-2]
+    first.upto last do |col|
+      column = Column.new col, @workbook.format(xf),
+                          :width         => width.to_f / 256,
+                          :hidden        => (opts & 0x0001) > 0,
+                          :collapsed     => (opts & 0x1000) > 0,
+                          :outline_level => (opts & 0x0700)
+      column.worksheet = worksheet
+      worksheet.columns[col] = column
+    end
+  end
   def read_dimensions worksheet, work, pos, len
     # Offset  Size  Contents
     #      0     4  Index to first used row
@@ -550,7 +576,7 @@ class Reader
         read_style work, pos, len
       when :format     # ○○ FORMAT (Number Format) ➜ 6.45
         read_format work, pos, len
-      when :font
+      when :font       # ●● FONT ➜ 6.43
         read_font work, pos, len
       end
       previous_op = op unless op == :continue
@@ -577,6 +603,8 @@ class Reader
       #when :index      # ○  INDEX ➜ 5.7 (Row Blocks), ➜ 6.55
         # TODO: if there are changes in rows, omit index when writing
         #read_index worksheet, work, pos, len
+      when :colinfo    # ○○ COLINFO ➜ 6.18
+        read_colinfo worksheet, work, pos, len
       when :dimensions # ●  DIMENSIONS ➜ 6.31
         read_dimensions worksheet, work, pos, len
       when :row        # ○○ Row Blocks ➜ 5.7
@@ -729,12 +757,42 @@ class Reader
     font_idx, numfmt, xf_type, xf_align, xf_rotation, xf_indent, xf_used_attr,
       xf_borders, xf_brdcolors, xf_pattern = work.unpack binfmt(:xf)
     fmt.number_format = @formats[numfmt]
-    fmt.font = @workbook.font font_idx
+    ## this appears to be undocumented: the first 4 fonts seem to be accessed
+    #  with a 0-based index, but all subsequent font indices are 1-based.
+    fmt.font = @workbook.font(font_idx > 3 ? font_idx - 1 : font_idx)
+    fmt.horizontal_align = NGILA_H_FX[xf_align & 0x07]
+    fmt.text_wrap = xf_align & 0x08 > 0
+    fmt.vertical_align = NGILA_V_FX[xf_align & 0x70]
+    fmt.rotation = if xf_rotation == 255
+                     :stacked
+                   elsif xf_rotation > 90
+                     90 - xf_rotation
+                   else
+                     xf_rotation
+                   end
+    fmt.indent_level = xf_indent & 0x0f
+    fmt.shrink = xf_indent & 0x10 > 0
+    fmt.text_direction = NOITCERID_TXET_FX[xf_indent & 0xc0]
+    fmt.left   = xf_borders & 0x0000000f > 0
+    fmt.right  = xf_borders & 0x000000f0 > 0
+    fmt.top    = xf_borders & 0x00000f00 > 0
+    fmt.bottom = xf_borders & 0x0000f000 > 0
+    fmt.left_color     = COLOR_CODES[xf_borders & 0x007f0000] || :border
+    fmt.right_color    = COLOR_CODES[xf_borders & 0x3f800000] || :border
+    fmt.cross_down     = xf_borders & 0x40000000 > 0
+    fmt.cross_up       = xf_borders & 0x80000000 > 0
+    fmt.top_color      = COLOR_CODES[xf_brdcolors & 0x0000007f] || :border
+    fmt.bottom_color   = COLOR_CODES[xf_brdcolors & 0x00003f80] || :border
+    fmt.diagonal_color = COLOR_CODES[xf_brdcolors & 0x001fc000] || :border
+    #fmt.diagonal_style = COLOR_CODES[xf_brdcolors & 0x01e00000]
+    fmt.pattern = xf_brdcolors & 0xfc000000
+    fmt.pattern_fg_color = COLOR_CODES[xf_pattern & 0x007f] || :border
+    fmt.pattern_bg_color = COLOR_CODES[xf_pattern & 0x3f80] || :pattern_bg
     @workbook.add_format fmt
   end
   def set_cell worksheet, row, column, xf, value=nil
     cells = @current_row_block[row] ||= Row.new(nil, row)
-    cells.formats[column] = @workbook.format(xf)
+    cells.formats[column] = @workbook.format(xf) unless xf == 0
     cells[column] = value
   end
   def set_row_address worksheet, work, pos, len
@@ -758,21 +816,27 @@ class Reader
     @current_row_block_offset ||= [pos]
     index, first_used, first_unused, flags,
       hasdefaults, offset = work.unpack binfmt(:row)
+    format = nil
     # TODO: read attributes from work[13,3], read flags
-    if hasdefaults > 0
-      # TODO: read row default XF
+    if hasdefaults > 0 && work.size > 13
+      xf, = work[-2..-1].unpack 'v'
+      format = @workbook.format(xf)
     end
-    worksheet.set_row_address index, :first_used   => first_used,
-                                     :first_unused => first_unused,
-                                     :index        => index,
-                                     :row_block    => @current_row_block_offset,
-                                     :offset       => @current_row_block_offset[0]
-                                     #:first_cell   => offset
+    worksheet.set_row_address index,
+                              :default_format => format,
+                              :first_used     => first_used,
+                              :first_unused   => first_unused,
+                              :index        => index,
+                              :row_block    => @current_row_block_offset,
+                              :offset       => @current_row_block_offset[0]
+                              #:first_cell   => offset
   end
   private
   def extend_internals version
     require 'spreadsheet/excel/internals/biff%i' % version
     extend Internals.const_get('Biff%i' % version)
+    ## spreadsheets may not include a codepage record.
+    @workbook.encoding = encoding 850 if version < 8
   rescue LoadError
   end
   def extend_reader version

data/lib/spreadsheet/excel/worksheet.rb

@@ -17,6 +17,10 @@ class Worksheet < Spreadsheet::Worksheet
     @offset, @ole, @reader = opts[:offset], opts[:ole], opts[:reader]
     @dimensions = nil
   end
+  def column idx
+    ensure_rows_read
+    super
+  end
   def date_base
     @workbook.date_base
   end
@@ -35,6 +39,7 @@ class Worksheet < Spreadsheet::Worksheet
     @rows.fetch idx do
       if addr = @row_addresses[idx]
         row = @reader.read_row self, addr
+        row.default_format = addr[:default_format]
         row.worksheet = self
         row
       else
@@ -73,10 +78,12 @@ class Worksheet < Spreadsheet::Worksheet
     @dimensions[1] = [ @rows.size, @row_addresses.size ].compact.max
     compact = @rows.compact
     first_rows = compact.collect do |row| index_of_first row end.compact.min
-    first_addrs = @row_addresses.collect do |addr| addr[:first_used] end.min
+    first_addrs = @row_addresses.compact.collect do |addr|
+      addr[:first_used] end.min
     @dimensions[2] = [ first_rows, first_addrs ].compact.min
     last_rows = compact.collect do |row| row.size end.max
-    last_addrs = @row_addresses.collect do |addr| addr[:first_unused] end.max
+    last_addrs = @row_addresses.compact.collect do |addr|
+      addr[:first_unused] end.max
     @dimensions[3] = [last_rows, last_addrs].compact.max
     @dimensions
   end

data/lib/spreadsheet/excel/writer/format.rb

@@ -21,28 +21,6 @@ class Format < DelegateClass(Format)
       color_code(@format.send(key) || default)
     end
   end
-  XF_H_ALIGN = {
-    :default       => 0,
-    :left          => 1,
-    :center        => 2,
-    :right         => 3,
-    :fill          => 4,
-    :justify       => 5,
-    :merge         => 6,
-    :distributed   => 7,
-  }
-  XF_TEXT_DIRECTION = {
-    :context       => 0,
-    :left_to_right => 1,
-    :right_to_left => 2,
-  }
-  XF_V_ALIGN = {
-    :top         => 0,
-    :middle      => 1,
-    :bottom      => 2,
-    :justify     => 3,
-    :distributed => 4,
-  }
   boolean :hidden, :locked, :merge_range, :shrink, :text_justlast, :text_wrap,
           :cross_down, :cross_up, :left, :right, :top, :bottom
   color :left_color,       :border
@@ -54,7 +32,7 @@ class Format < DelegateClass(Format)
   color :pattern_bg_color, :pattern_bg
   attr_accessor :xf_index
   attr_reader :format
-  def initialize writer, workbook, format, type=:style
+  def initialize writer, workbook, format=workbook.default_format, type=:format
     @type = type.to_s.downcase
     @format = format
     @writer = writer
@@ -219,7 +197,7 @@ class Format < DelegateClass(Format)
   end
   def xf_pattern
     ptrn  = pattern_fg_color
-    ptrn |= pattern_bg_color
+    ptrn |= pattern_bg_color << 7
     ptrn
   end
   def xf_rotation
@@ -235,7 +213,7 @@ class Format < DelegateClass(Format)
     rot
   end
   def xf_type_prot type
-    type = type.to_s.downcase == 'style' ? 0xfff4 : 0x0000
+    type = type.to_s.downcase == 'style' ? 0xfff5 : 0x0000
     type |= locked
     type |= hidden << 1
     type
@@ -243,6 +221,7 @@ class Format < DelegateClass(Format)
   def xf_used_attr
     atr_num = num_format & 1
     atr_fnt = font_index & 1
+    atr_fnt = 1 unless @format.font.color == :text
     atr_alc = 0
     if horizontal_align != 0 \
       || vertical_align != 2 \
@@ -252,9 +231,13 @@ class Format < DelegateClass(Format)
       atr_alc = 1
     end
     atr_bdr = [top, bottom, left, right, cross_up, cross_down].max
-    atr_pat = @format.font.color != :text \
-      || @format.bg_color != :pattern_bg \
-      || pattern != 0x00 ? 1 : 0
+    atr_pat = 0
+    if  @format.pattern_fg_color != :border \
+      || @format.pattern_bg_color != :pattern_bg \
+      || pattern != 0x00
+    then
+      atr_pat = 1
+    end
     atr_prot = hidden? || locked? ? 1 : 0
     attrs  = atr_num
     attrs |= atr_fnt << 1
@@ -262,7 +245,7 @@ class Format < DelegateClass(Format)
     attrs |= atr_bdr << 3
     attrs |= atr_pat << 4
     attrs |= atr_prot << 5
-    attrs
+    attrs << 2
   end
 end
     end

data/lib/spreadsheet/excel/writer/workbook.rb

@@ -48,16 +48,23 @@ class Workbook < Spreadsheet::Writer
     @number_formats.delete workbook
     @worksheets.delete workbook
   end
-  def collect_formats workbook
+  def collect_formats workbook, opts={}
     # The default cell format is always present in an Excel file, described by
     # the XF record with the fixed index 15 (0-based). By default, it uses the
     # worksheet/workbook default cell style, described by the very first XF
     # record (index 0).
     formats = []
+    unless opts[:existing_document]
+      15.times do
+        formats.push Format.new(self, workbook, workbook.default_format, :style)
+      end
+      formats.push Format.new(self, workbook)
+    end
     workbook.formats.each do |fmt|
-      format = Format.new self, workbook, fmt
-      format.xf_index = formats.size
-      formats.push format
+      formats.push Format.new(self, workbook, fmt)
+    end
+    formats.each_with_index do |fmt, idx|
+      fmt.xf_index = idx
     end
     @formats[workbook] = formats
   end
@@ -68,6 +75,7 @@ class Workbook < Spreadsheet::Writer
     end
     total = current.size
     current.uniq!
+    current.delete ''
     if (stored - current).empty?
       ## if all previously stored strings are still needed, we don't have to
       #  rewrite all cells because the sst-index of such string does not change.
@@ -78,7 +86,10 @@ class Workbook < Spreadsheet::Writer
     end
   end
   def font_index workbook, font_key
-    @fonts[workbook][font_key] || 0
+    idx = @fonts[workbook][font_key] || 0
+    ## this appears to be undocumented: the first 4 fonts seem to be accessed
+    #  with a 0-based index, but all subsequent font indices are 1-based.
+    idx > 3 ? idx.next : idx
   end
   def number_format_index workbook, format
     @number_formats[workbook][format] || 0
@@ -135,7 +146,7 @@ class Workbook < Spreadsheet::Writer
   # Copy unchanged data verbatim, adjust offsets and write new records for
   # changed data.
   def write_changes workbook, io
-    collect_formats workbook
+    collect_formats workbook, :existing_document => true
     reader = workbook.ole
     sheet_data = {}
     sst_status, sst_total, sst_strings = complete_sst_update? workbook
@@ -299,7 +310,7 @@ class Workbook < Spreadsheet::Writer
   end
   def write_fonts workbook, writer
     fonts = @fonts[workbook] = {}
-    workbook.formats.each do |format|
+    @formats[workbook].each do |format|
       if(font = format.font) && !fonts.include?(font.key)
         fonts.store font.key, fonts.size
         write_font workbook, writer, font
@@ -317,6 +328,8 @@ class Workbook < Spreadsheet::Writer
     BUILTIN_FORMATS.each do |idx, str|
       formats.store client(str, 'UTF8'), idx
     end
+    ## Ensure at least a 'GENERAL' format is written
+    formats.delete client('GENERAL', 'UTF8')
     idx = 0xa4
     workbook.formats.each do |fmt|
       str = fmt.number_format
@@ -342,6 +355,7 @@ class Workbook < Spreadsheet::Writer
     # ○  DSF ➜ 6.32
     write_dsf workbook, buffer1
     # ○  TABID
+    write_tabid workbook, buffer1
     # ○  FNGROUPCOUNT
     # ○  Workbook Protection Block ➜ 5.18
     write_protect workbook, buffer1
@@ -505,6 +519,9 @@ class Workbook < Spreadsheet::Writer
     ]
     write_op writer, 0x0293, data.pack('vC2')
   end
+  def write_tabid workbook, writer
+    write_op writer, 0x013d, [1].pack('v')
+  end
   def write_window1 workbook, writer
     data = [
       0x0000, # Horizontal position of the document window
@@ -555,20 +572,7 @@ class Workbook < Spreadsheet::Writer
     # the XF record with the fixed index 15 (0-based). By default, it uses the
     # worksheet/workbook default cell style, described by the very first XF
     # record (index 0).
-    formats = @formats[workbook].dup
-    default = formats.first
-    ## First 15 formats, or dummy/default styles if there are fewer formats
-    fmts1 = formats.slice!(0,15)
-    while fmts1.size < 15 do
-      fmt = Format.new self, workbook, workbook.default_format, writer
-      fmt.xf_index = fmts1.size
-      fmts1.push fmt
-    end
-    fmts1.each do |fmt| fmt.write_xf writer end
-    ## Default cell format
-    default.write_xf writer, :format
-    ## remaining formats
-    formats.each do |fmt| fmt.write_xf writer end
+    @formats[workbook].each do |fmt| fmt.write_xf writer end
   end
   def sst_index worksheet, str
     @sst[worksheet][str]

data/lib/spreadsheet/excel/writer/worksheet.rb

@@ -100,7 +100,7 @@ class Worksheet
   end
   def strings
     @worksheet.inject [] do |memo, row|
-      strings = row.select do |cell| cell.is_a? String end
+      strings = row.select do |cell| cell.is_a?(String) && !cell.empty? end
       memo.concat strings
     end
   end
@@ -171,8 +171,9 @@ class Worksheet
     # RSTRING ➜ 6.84 (BIFF5/BIFF7)
     multiples, first_idx = nil
     row.each_with_index do |cell, idx|
-      if multiples && (!multiples.last.is_a?(cell.class) \
-                       || (cell.is_a?(Numeric) && cell.abs < 0.1))
+      cell = nil if cell == ''
+      number = cell.is_a?(Float) && cell.to_s.length > 5
+      if multiples && (!multiples.last.is_a?(cell.class) || number)
         write_multiples row, first_idx, multiples
         multiples, first_idx = nil
       end
@@ -196,7 +197,7 @@ class Worksheet
         #  10^9. Not sure what is a good rule of thumb here, but it seems that
         #  Decimal Numbers with more than 4 significant digits are not represented
         #  with sufficient precision by RK
-        if cell.is_a?(Float) && cell.to_s.length > 5
+        if number
           write_number row, idx
         elsif multiples
           multiples.push cell
@@ -240,6 +241,43 @@ class Worksheet
     end
     @io.write reader.read(endpos - lastpos)
   end
+  def write_colinfo bunch
+    col = bunch.first
+    width = col.width.to_f * 256
+    xf_idx = @workbook.xf_index @worksheet.workbook, col.default_format
+    opts =  0
+    opts |= 0x0001 if col.hidden?
+    opts |= col.outline_level.to_i << 8
+    opts |= 0x1000 if col.collapsed?
+    data = [
+      col.idx,        # Index to first column in the range
+      bunch.last.idx, # Index to last column in the range
+      width.to_i,     # Width of the columns in 1/256 of the width of the zero
+                      # character, using default font (first FONT record in the
+                      # file)
+      xf_idx.to_i,    # Index to XF record (➜ 6.115) for default column formatting
+      opts,           # Option flags:
+                      # Bits  Mask    Contents
+                      #    0  0x0001  1 = Columns are hidden
+                      # 10-8  0x0700  Outline level of the columns
+                      #               (0 = no outline)
+                      #   12  0x1000  1 = Columns are collapsed
+    ]
+    write_op opcode(:colinfo), data.pack(binfmt(:colinfo))
+  end
+  def write_colinfos
+    cols = @worksheet.columns
+    bunch = []
+    cols.each_with_index do |column, idx|
+      if column
+        bunch << column
+        if cols[idx.next] != column
+          write_colinfo bunch
+          bunch.clear
+        end
+      end
+    end
+  end
   def write_defaultrowheight
     data = [
       0x00, # Option flags:
@@ -252,6 +290,20 @@ class Worksheet
     ]
     write_op 0x0225, data.pack('v2')
   end
+  def write_defcolwidth
+    # Offset  Size  Contents
+    #      0     2  Column width in characters, using the width of the zero
+    #               character from default font (first FONT record in the
+    #               file). Excel adds some extra space to the default width,
+    #               depending on the default font and default font size. The
+    #               algorithm how to exactly calculate the resulting column
+    #               width is not known.
+    #
+    #               Example: The default width of 8 set in this record results
+    #               in a column width of 8.43 using Arial font with a size of
+    #               10 points.
+    write_op 0x0055, [8].pack('v')
+  end
   def write_dimensions
     # Offset  Size  Contents
     #      0     4  Index to first used row
@@ -268,11 +320,12 @@ class Worksheet
   # Write a cell with a Formula. May write an additional String record depending
   # on the stored result of the Formula.
   def write_formula row, idx
+    xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx)
     cell = row[idx]
     data1 = [
       row.idx,      # Index to row
       idx,          # Index to column
-      0,            # Index to XF record (➜ 6.115)
+      xf_idx,       # Index to XF record (➜ 6.115)
     ].pack 'v3'
     data2 = nil
     case value = cell.value
@@ -345,7 +398,9 @@ class Worksheet
     # ○  Page Settings Block ➜ 5.4
     # ○  Worksheet Protection Block ➜ 5.18
     # ○  DEFCOLWIDTH ➜ 6.29
+    write_defcolwidth
     # ○○ COLINFO ➜ 6.18
+    write_colinfos
     # ○  SORT ➜ 6.95
     # ●  DIMENSIONS ➜ 6.31
     write_dimensions
@@ -400,9 +455,9 @@ class Worksheet
       idx, # Index to first column (fc)
     ]
     # List of nc=lc-fc+1 16-bit indexes to XF records (➜ 6.115)
-    multiples.each do |cell|
-      # TODO: XF indices
-      data.push 0, encode_rk(cell)
+    multiples.each_with_index do |cell, cell_idx|
+      xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx + cell_idx)
+      data.push xf_idx, encode_rk(cell)
       fmt << 'vV'
     end
     # Index to last column (lc)
@@ -477,9 +532,12 @@ class Worksheet
       0, # Not used
       has_defaults,
       0, # OOffice does not set this - ignore until someone complains
+      1,
+      15,
+      0,
     ]
     # OpenOffice apparently can't read Rows with a length other than 16 Bytes
-    fmt = binfmt(:row) + 'x3'
+    fmt = binfmt(:row) + 'C3'
 =begin
     if format = row.default_format
       fmt = fmt + 'xv'

data/lib/spreadsheet/font.rb

@@ -59,9 +59,12 @@ module Spreadsheet
                     :korean_hangul, :korean_johab, :chinese_simplified,
                     :chinese_traditional, :greek, :turkish, :vietnamese,
                     :hebrew, :arabic, :cyrillic, :thai, :iso_latin2, :oem_latin1
-    def initialize name
+    def initialize name, opts={}
       self.name = name
       @color = :text
+      opts.each do |key, val|
+        self.send "#{key}=", val
+      end
     end
     ##
     # Sets #weight to :bold if(_bool_), :normal otherwise.

data/lib/spreadsheet/format.rb

@@ -33,7 +33,7 @@ module Spreadsheet
     ##
     # Color attributes
     colors  :bottom_color, :top_color, :left_color, :right_color,
-            :bg_color, :pattern_fg_color, :pattern_bg_color,
+            :pattern_fg_color, :pattern_bg_color,
             :diagonal_color
     ##
     # Text direction
@@ -72,16 +72,15 @@ module Spreadsheet
     # Text rotation
     attr_reader :rotation
     def initialize opts={}
-      @font             = Font.new client("Arial", 'UTF8')
-      @number_format    = client 'General', 'UTF8'
+      @font             = Font.new client("Arial", 'UTF8'), :family => :swiss
+      @number_format    = client 'GENERAL', 'UTF8'
       @rotation         = 0
-      @bg_color         = :pattern_bg
       @pattern          = 0
-      @bottom_color     = :border
-      @top_color        = :border
-      @left_color       = :border
-      @right_color      = :border
-      @diagonal_color   = :border
+      @bottom_color     = :builtin_black
+      @top_color        = :builtin_black
+      @left_color       = :builtin_black
+      @right_color      = :builtin_black
+      @diagonal_color   = :builtin_black
       @pattern_fg_color = :border
       @pattern_bg_color = :pattern_bg
       # Temp code to prevent merged formats in non-merged cells.

data/lib/spreadsheet/row.rb

@@ -47,7 +47,7 @@ module Spreadsheet
     # Set the default Format used when writing a Cell if no explicit Format is
     # stored for the cell.
     def default_format= format
-      @worksheet.add_format format
+      @worksheet.add_format format if @worksheet
       @default_format = format
     end
     ##
@@ -60,10 +60,11 @@ module Spreadsheet
       index_of_first self
     end
     ##
-    # The Format for the Cell at _idx_ (0-based), or default_format
-    # if no Format is set.
+    # The Format for the Cell at _idx_ (0-based), or the first valid Format in
+    # Row#default_format, Column#default_format and Worksheet#default_format.
     def format idx
-      @formats[idx] || @default_format
+      @formats[idx] || @default_format \
+        || @worksheet.column(idx).default_format if @worksheet
     end
     ##
     # Set the Format for the Cell at _idx_ (0-based).

data/lib/spreadsheet/workbook.rb

@@ -27,13 +27,14 @@ module Spreadsheet
     # Add a Font to the Workbook. Used by the parser. You should not need to
     # use this Method.
     def add_font font
-      @fonts.push font
+      @fonts.push(font).uniq! if font
+      font
     end
     ##
     # Add a Format to the Workbook. If you use Row#set_format, you should not
     # need to use this Method.
     def add_format format
-      @formats.push(format).uniq!
+      @formats.push(format) if format && !@formats.include?(format)
       format
     end
     ##

data/lib/spreadsheet/worksheet.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'spreadsheet/column'
 require 'spreadsheet/encodings'
 require 'spreadsheet/row'
 
@@ -14,22 +15,27 @@ module Spreadsheet
   # #rows          :: The Rows in this Worksheet. It is not recommended to
   #                   Manipulate this Array directly. If you do, call
   #                   #updated_from with the smallest modified index.
+  # #columns       :: The Column formatting in this Worksheet. Column
+  #                   instances may appear at more than one position in #columns.
+  #                   If you modify a Column directly, your changes will be
+  #                   reflected in all those positions.
   class Worksheet
     include Encodings
-    attr_accessor :name, :workbook
-    attr_reader :rows
     include Enumerable
+    attr_accessor :name, :workbook
+    attr_reader :rows, :columns
     def initialize opts={}
       @dimensions = [0,0,0,0]
       @name = opts[:name] || 'Worksheet'
       @workbook = opts[:workbook]
       @rows = []
+      @columns = []
     end
     ##
     # Add a Format to the Workbook. If you use Row#set_format, you should not
     # need to use this Method.
     def add_format fmt
-      @workbook.add_format fmt
+      @workbook.add_format fmt if fmt
     end
     ##
     # Get the enriched value of the Cell at _row_, _column_.
@@ -38,6 +44,11 @@ module Spreadsheet
       row(row)[column]
     end
     ##
+    # Returns the Column at _idx_.
+    def column idx
+      @columns[idx] || Column.new(idx, default_format, :worksheet => self)
+    end
+    ##
     # The number of columns in this Worksheet which contain data.
     def column_count
       dimensions[3] - dimensions[2]
@@ -59,7 +70,7 @@ module Spreadsheet
     # Set the default Format of this Worksheet.
     def default_format= format
       @default_format = format
-      add_format format if format
+      add_format format
       format
     end
     ##
@@ -87,6 +98,31 @@ module Spreadsheet
       @workbook.encoding
     end
     ##
+    # Sets the default Format of the column at _idx_.
+    #
+    # _idx_ may be an Integer, or an Enumerable that iterates over a number of
+    # Integers.
+    #
+    # _format_ is a Format, or nil if you want to remove the Formatting at _idx_
+    #
+    # Returns an instance of Column if _idx_ is an Integer, an Array of Columns
+    # otherwise.
+    def format_column idx, format=nil, opts={}
+      opts[:worksheet] = self
+      res = case idx
+            when Integer
+              column = nil
+              if format
+                column = Column.new(idx, format, opts)
+              end
+              @columns[idx] = column
+            else
+              idx.collect do |col| format_column col, format, opts end
+            end
+      shorten @columns
+      res
+    end
+    ##
     # Insert a Row at _idx_ (0-based) containing _cells_
     def insert_row idx, cells=[]
       res = @rows.insert idx, Row.new(self, idx, cells)

data/test/font.rb

@@ -77,11 +77,11 @@ module Spreadsheet
       assert_equal true, @font.shadow
     end
     def test_size
-      assert_equal 10, @font.size  
+      assert_equal 10, @font.size
       @font.size = 12
-      assert_equal 12, @font.size  
+      assert_equal 12, @font.size
       @font.size = 11.2
-      assert_equal 11.2, @font.size  
+      assert_equal 11.2, @font.size
       assert_raises ArgumentError do @font.size = "123" end
     end
     def test_strikeout

data/test/integration.rb

@@ -37,7 +37,7 @@ module Spreadsheet
       book = Spreadsheet.open path
       assert_instance_of Excel::Workbook, book
       assert_equal 8, book.biff_version
-      assert_equal @@iconv.iconv('Microsoft Excel 97/2000/XP'), 
+      assert_equal @@iconv.iconv('Microsoft Excel 97/2000/XP'),
                    book.version_string
       enc = 'UTF-16LE'
       if defined? Encoding
@@ -532,13 +532,13 @@ module Spreadsheet
         end
       end
       assert_equal long, str4
-      sheet = book.worksheet 0 
+      sheet = book.worksheet 0
       sheet[0,0] = 4
       row = sheet.row 1
       row[0] = 3
       book.write path
       assert_nothing_raised do book = Spreadsheet.open path end
-      sheet = book.worksheet 0 
+      sheet = book.worksheet 0
       assert_equal 10, sheet.row_count
       assert_equal 11, sheet.column_count
       useds = [0,0,0,0,0,0,0,1,0,0]
@@ -635,7 +635,7 @@ module Spreadsheet
         end
       end
       assert_equal long, str4
-      sheet = book.worksheet 0 
+      sheet = book.worksheet 0
       sheet[0,0] = 4
       str5 = 'A completely different String'
       sheet[0,1] = str5
@@ -647,7 +647,7 @@ module Spreadsheet
       assert_equal str2, book.shared_string(1)
       assert_equal str3, book.shared_string(2)
       assert_equal str4, book.shared_string(3)
-      sheet = book.worksheet 0 
+      sheet = book.worksheet 0
       assert_equal 10, sheet.row_count
       assert_equal 11, sheet.column_count
       useds = [0,0,0,0,0,0,0,1,0,0]
@@ -719,6 +719,13 @@ module Spreadsheet
       str2 = 'Another Shared String'
       str3 = '1234567890 ' * 1000
       str4 = '9876543210 ' * 1000
+      fmt1 = Format.new :italic => true, :color => :blue
+      sheet1.format_column 1, fmt1, :width => 20
+      fmt2 = Format.new(:weight => :bold, :color => :yellow)
+      sheet1.format_column 2, fmt2
+      sheet1.format_column 3, Format.new(:weight => :bold, :color => :red)
+      sheet1.format_column 6..9, fmt1
+      sheet1.format_column [4,5,7], fmt2
       sheet1[0,0] = str1
       sheet1.row(0).push str1
       sheet1.row(1).concat [str2, str2]
@@ -797,10 +804,15 @@ module Spreadsheet
       assert_equal 2, book.worksheets.size
       sheet = book.worksheets.first
       assert_instance_of Spreadsheet::Excel::Worksheet, sheet
-      assert_equal "W\000o\000r\000k\000s\000h\000e\000e\000t\0001\000", 
+      assert_equal "W\000o\000r\000k\000s\000h\000e\000e\000t\0001\000",
                    sheet.name
       assert_not_nil sheet.offset
+      assert_not_nil col = sheet.column(1)
+      assert_equal true, col.default_format.font.italic?
+      assert_equal :blue, col.default_format.font.color
+      assert_equal 20, col.width
       row = sheet.row 0
+      assert_equal col.default_format, row.format(1)
       assert_equal str1, row[0]
       assert_equal str1, sheet[0,0]
       assert_equal str1, sheet.cell(0,0)
@@ -880,7 +892,7 @@ module Spreadsheet
       assert_equal 1.00005, sheet1[10,4]
       assert_instance_of Spreadsheet::Excel::Worksheet, sheet
       sheet = book.worksheets.last
-      assert_equal "m\000y\000 \000n\000a\000m\000e\000", 
+      assert_equal "m\000y\000 \000n\000a\000m\000e\000",
                    sheet.name
       assert_not_nil sheet.offset
     end
@@ -893,6 +905,8 @@ module Spreadsheet
       str2 = @@iconv.iconv 'Another Shared String'
       str3 = @@iconv.iconv('1234567890 ' * 1000)
       str4 = @@iconv.iconv('9876543210 ' * 1000)
+      fmt = Format.new :italic => true, :color => :blue
+      sheet1.format_column 1, fmt, :width => 20
       sheet1[0,0] = str1
       sheet1.row(0).push str1
       sheet1.row(1).concat [str2, str2]
@@ -948,7 +962,11 @@ module Spreadsheet
       assert_instance_of Spreadsheet::Excel::Worksheet, sheet
       assert_equal "Worksheet1", sheet.name
       assert_not_nil sheet.offset
+      assert_not_nil col = sheet.column(1)
+      assert_equal true, col.default_format.font.italic?
+      assert_equal :blue, col.default_format.font.color
       row = sheet.row 0
+      assert_equal col.default_format, row.format(1)
       assert_equal str1, row[0]
       assert_equal str1, sheet[0,0]
       assert_equal str1, sheet.cell(0,0)
@@ -1008,14 +1026,9 @@ module Spreadsheet
       assert_equal [1,2,3,4,5,6,7,8,9,0], sheet.cell(7,1..10)
       assert_instance_of Spreadsheet::Excel::Worksheet, sheet
       sheet = book.worksheets.last
-      assert_equal "my name", 
+      assert_equal "my name",
                    sheet.name
       assert_not_nil sheet.offset
     end
-    def test_read_bsv
-      book = Spreadsheet.open '/home/hwyss/cogito/oddb.org/data/xls/BSV_per_2008.10.01.xls'
-      sheet = book.worksheet 0
-      assert_equal Date.new(2000), sheet[1,6]
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spreadsheet
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Hannes Wyss
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-13 00:00:00 +02:00
+date: 2008-10-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-ole
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development