spreadsheet 0.6.2.1 → 0.6.3

data/History.txt

@@ -1,3 +1,21 @@
+=== 0.6.3 / 2009-01-14
+
+* 1 Bugfix
+
+  * Fixes the issue reported by Corey Martella in
+    http://rubyforge.org/forum/message.php?msg_id=63651
+    as well as other issues engendered by the decision to always shorten
+    Rows to the last non-nil value.
+
+* 2 minor enhancements
+
+  * Added bin/xlsopcodes, a tool for examining Excel files
+
+  * Documents created by Spreadsheet can now be Printed in Excel and
+    Excel-Viewer.
+    This issue was reported by Spencer Turner in
+    http://rubyforge.org/tracker/index.php?func=detail&aid=23287&group_id=678&atid=2677
+
 === 0.6.2.1 / 2008-12-18
 
 * 1 Bugfix

data/Manifest.txt

@@ -4,6 +4,7 @@ LICENSE.txt
 Manifest.txt
 README.txt
 Rakefile
+bin/xlsopcodes
 lib/parseexcel.rb
 lib/parseexcel/parseexcel.rb
 lib/parseexcel/parser.rb
@@ -32,18 +33,23 @@ lib/spreadsheet/excel/writer/worksheet.rb
 lib/spreadsheet/font.rb
 lib/spreadsheet/format.rb
 lib/spreadsheet/formula.rb
+lib/spreadsheet/helpers.rb
 lib/spreadsheet/link.rb
 lib/spreadsheet/row.rb
 lib/spreadsheet/workbook.rb
 lib/spreadsheet/worksheet.rb
 lib/spreadsheet/writer.rb
 test/data/test_copy.xls
+test/data/test_datetime.xls
 test/data/test_empty.xls
 test/data/test_version_excel5.xls
 test/data/test_version_excel95.xls
 test/data/test_version_excel97.xls
 test/excel/row.rb
+test/excel/writer/worksheet.rb
 test/font.rb
 test/integration.rb
+test/row.rb
+test/suite.rb
 test/workbook.rb
 test/worksheet.rb

data/bin/xlsopcodes

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'spreadsheet'
+
+source, target = ARGV
+
+if source.nil?
+  puts "Usage: #{$0} <source> [<target>]"
+  exit -1
+end
+
+target = target ? File.open(target, 'w') : STDOUT
+
+reader = Spreadsheet::Excel::Reader.new :print_opcodes => target
+reader.setup source
+
+while tuple = reader.get_next_chunk
+end

data/lib/spreadsheet.rb

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

data/lib/spreadsheet/excel/internals.rb

@@ -98,8 +98,10 @@ module Internals
     :font       => 'v5C3x',
     :labelsst   => 'v3V',
     :number     => "v3#{EIGHT_BYTE_DOUBLE}",
+    :pagesetup  => "v8#{EIGHT_BYTE_DOUBLE}2v",
     :rk         => 'v3V',
     :row        => 'v4x4V',
+    :window2    => 'v4x2v2x4',
     :xf         => 'v3C4V2v',
   }
   # From BIFF5 on, the built-in number formats will be omitted. The built-in
@@ -278,6 +280,11 @@ module Internals
     :useselfs     => 0x0160, # ○  USESELFS (Natural Language Formulas) ➜ 6.105
     :dsf          => 0x0161, # ○  DSF (Double Stream File) ➜ 6.32
     :refreshall   => 0x01b7, # ○  REFRESHALL
+    ########################## ●  Worksheet View Settings Block ➜ 5.5
+    :window2      => 0x023e, # ●  WINDOW2 ➜ 5.110
+    :scl          => 0x00a0, # ○  SCL ➜ 5.92 (BIFF4-BIFF8 only)
+    :pane         => 0x0041, # ○  PANE ➜ 5.75
+    :selection    => 0x001d, # ○○ SELECTION ➜ 5.93
     ########################## ○  Page Settings Block ➜ 5.4
     :hpagebreaks  => 0x001b, # ○  HORIZONTALPAGEBREAKS ➜ 6.54
     :vpagebreaks  => 0x001a, # ○  VERTICALPAGEBREAKS ➜ 6.107
@@ -290,7 +297,7 @@ module Internals
     :topmargin    => 0x0028, # ○  TOPMARGIN ➜ 6.103
     :bottommargin => 0x0029, # ○  BOTTOMMARGIN ➜ 6.11
                              # ○  PLS (opcode unknown)
-    :setup        => 0x00a1, # ○  SETUP ➜ 6.89 (BIFF4-BIFF8 only)
+    :pagesetup    => 0x00a1, # ○  PAGESETUP ➜ 6.89 (BIFF4-BIFF8 only)
     :bitmap       => 0x00e9, # ○  BITMAP ➜ 6.6 (Background-Bitmap, BIFF8 only)
     ##########################
     :printheaders => 0x002a, # ○  PRINTHEADERS ➜ 6.76
@@ -340,6 +347,8 @@ module Internals
   }
   NGILA_V_FX = XF_V_ALIGN.invert
   OPCODE_SIZE = 4
+  ROW_HEIGHT = 12.1
+  SST_CHUNKSIZE = 20
   def binfmt key
     BINARY_FORMATS[key]
   end

data/lib/spreadsheet/excel/reader.rb

@@ -74,6 +74,23 @@ class Reader
       name
     end
   end
+  def get_next_chunk
+    pos = @pos
+    if pos < @data.size
+      op, len = @data[@pos,OPCODE_SIZE].unpack('v2')
+      @pos += OPCODE_SIZE
+      if len
+        work = @data[@pos,len]
+        @pos += len
+        code = SEDOCPO.fetch(op, op)
+        if io = @opts[:print_opcodes]
+          io.puts sprintf("0x%04x/%-16s %5i: %s",
+                          op, code.inspect, len, work.inspect)
+        end
+        [ pos, code, len + OPCODE_SIZE, work]
+      end
+    end
+  end
   def in_row_block? op, previous
     if op == :row
       previous == op
@@ -98,17 +115,7 @@ class Reader
   # The entry-point for reading Excel-documents. Reads the Biff-Version and
   # loads additional reader-methods before proceeding with parsing the document.
   def read io
-    @ole = Ole::Storage.open io
-    @workbook = Workbook.new io, {}
-    @book = @ole.file.open("Book") rescue @ole.file.open("Workbook")
-    @data = @book.read
-    read_bof
-    @workbook.ole = @book
-    @workbook.bof = @bof
-    @workbook.version = @version
-    biff = @workbook.biff_version
-    extend_reader biff
-    extend_internals biff
+    setup io
     read_workbook
     @workbook.default_format = @workbook.format 0
     @workbook.changes.clear
@@ -1047,6 +1054,19 @@ class Reader
     # TODO: Row spacing
     worksheet.set_row_address index, attrs
   end
+  def setup io
+    @ole = Ole::Storage.open io
+    @workbook = Workbook.new io, {}
+    @book = @ole.file.open("Book") rescue @ole.file.open("Workbook")
+    @data = @book.read
+    read_bof
+    @workbook.ole = @book
+    @workbook.bof = @bof
+    @workbook.version = @version
+    biff = @workbook.biff_version
+    extend_reader biff
+    extend_internals biff
+  end
   private
   def extend_internals version
     require 'spreadsheet/excel/internals/biff%i' % version
@@ -1060,19 +1080,6 @@ class Reader
     extend Reader.const_get('Biff%i' % version)
   rescue LoadError
   end
-  def get_next_chunk
-    pos = @pos
-    op, len = @data[@pos,OPCODE_SIZE].unpack('v2')
-    @pos += OPCODE_SIZE
-    if len
-      work = @data[@pos,len]
-      @pos += len
-      code = SEDOCPO.fetch(op, op)
-      #puts "0x%04x/%-16s (0x%08x) %5i: %s" % [op, code.inspect, pos, len, work[0,16].inspect]
-      #puts "0x%04x/%-16s %5i: %s" % [op, code.inspect, len, work[0,32].inspect]
-      [ pos, code, len + OPCODE_SIZE, work]
-    end
-  end
 end
   end
 end

data/lib/spreadsheet/excel/worksheet.rb

@@ -36,11 +36,11 @@ class Worksheet < Spreadsheet::Worksheet
     return if @row_addresses
     @dimensions = nil
     @row_addresses = []
-    @reader.read_worksheet self, @offset
+    @reader.read_worksheet self, @offset if @reader
   end
   def row idx
-    ensure_rows_read
     @rows[idx] or begin
+      ensure_rows_read
       if addr = @row_addresses[idx]
         row = @reader.read_row self, addr
         [:default_format, :height, :outline_level, :hidden, ].each do |key|
@@ -53,7 +53,7 @@ class Worksheet < Spreadsheet::Worksheet
       end
     end
   end
-  def row_updated idx, row, args={}
+  def row_updated idx, row
     res = super
     @workbook.changes.store self, true
     @workbook.changes.store :boundsheets, true
@@ -83,11 +83,11 @@ class Worksheet < Spreadsheet::Worksheet
                        index_of_first(@row_addresses) ].compact.min || 0
     @dimensions[1] = [ @rows.size, @row_addresses.size ].compact.max || 0
     compact = @rows.compact
-    first_rows = compact.collect do |row| index_of_first row end.compact.min
+    first_rows = compact.collect do |row| row.first_used end.compact.min
     first_addrs = @row_addresses.compact.collect do |addr|
       addr[:first_used] end.min
     @dimensions[2] = [ first_rows, first_addrs ].compact.min || 0
-    last_rows = compact.collect do |row| row.size end.max
+    last_rows = compact.collect do |row| row.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 || 0

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

@@ -32,8 +32,8 @@ class Format < DelegateClass Spreadsheet::Format
   color :pattern_bg_color, :pattern_bg
   attr_accessor :xf_index
   attr_reader :format
-  def initialize writer, workbook, format=workbook.default_format, type=:format
-    @type = type.to_s.downcase
+  def initialize writer, workbook, format=workbook.default_format, opts={}
+    @opts = { :type => :format }.merge opts
     @format = format
     @writer = writer
     @workbook = workbook
@@ -62,7 +62,7 @@ class Format < DelegateClass Spreadsheet::Format
     writer.write [op,data.size].pack("v2")
     writer.write data
   end
-  def write_xf writer, type=@type
+  def write_xf writer, type=@opts[:type]
     xf_type = xf_type_prot type
     data = [
       font_index,   # Index to FONT record (➜ 6.43)

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

@@ -56,7 +56,8 @@ class Workbook < Spreadsheet::Writer
     formats = []
     unless opts[:existing_document]
       15.times do
-        formats.push Format.new(self, workbook, workbook.default_format, :style)
+        formats.push Format.new(self, workbook, workbook.default_format,
+                                :type => :style)
       end
       formats.push Format.new(self, workbook)
     end
@@ -258,7 +259,7 @@ class Workbook < Spreadsheet::Writer
     write_op writer, 0x000a
   end
   def write_extsst workbook, offsets, writer
-    header = [8].pack('v')
+    header = [SST_CHUNKSIZE].pack('v')
     data = offsets.collect do |pair| pair.push(0).pack('Vv2') end
     write_op writer, 0x00ff, header, data
   end
@@ -374,7 +375,9 @@ class Workbook < Spreadsheet::Writer
     buffer1 = StringIO.new ''
     # ●  BOF Type = workbook globals (➜ 6.8)
     write_bof workbook, buffer1, :globals
-    # ○  File Protection Block ➜ 5.19
+    # ○  File Protection Block ➜ 4.19
+    # ○  WRITEACCESS User name (BIFF3-BIFF8, ➜ 5.112)
+    # ○  FILESHARING File sharing options (BIFF3-BIFF8, ➜ 5.44)
     # ○  CODEPAGE ➜ 6.17
     write_encoding workbook, buffer1
     # ○  DSF ➜ 6.32
@@ -382,42 +385,46 @@ class Workbook < Spreadsheet::Writer
     # ○  TABID
     write_tabid workbook, buffer1
     # ○  FNGROUPCOUNT
-    # ○  Workbook Protection Block ➜ 5.18
+    # ○  Workbook Protection Block ➜ 4.18
+    # ○  WINDOWPROTECT Window settings: 1 = protected (➜ 5.111)
+    # ○  PROTECT Cell contents: 1 = protected (➜ 5.82)
     write_protect workbook, buffer1
+    # ○  OBJECTPROTECT Embedded objects: 1 = protected (➜ 5.72)
+    # ○  PASSWORD Hash value of the password; 0 = No password (➜ 5.76)
     write_password workbook, buffer1
-    # ●  WINDOW1 ➜ 6.108
+    # ○  BACKUP ➜ 5.5
+    # ○  HIDEOBJ ➜ 5.56
+    # ●  WINDOW1 ➜ 5.109
     write_window1 workbook, buffer1
-    # ○  BACKUP ➜ 6.5
-    # ○  HIDEOBJ ➜ 6.52
-    # ○  DATEMODE ➜ 6.25
+    # ○  DATEMODE ➜ 5.28
     write_datemode workbook, buffer1
-    # ○  PRECISION ➜ 6.74
+    # ○  PRECISION ➜ 5.79
     write_precision workbook, buffer1
     # ○  REFRESHALL
     write_refreshall workbook, buffer1
-    # ○  BOOKBOOL ➜ 6.9
+    # ○  BOOKBOOL ➜ 5.9
     write_bookbool workbook, buffer1
-    # ●● FONT ➜ 6.43
+    # ●● FONT ➜ 5.45
     write_fonts workbook, buffer1
-    # ○○ FORMAT ➜ 6.45
+    # ○○ FORMAT ➜ 5.49
     write_formats workbook, buffer1
-    # ●● XF ➜ 6.115
+    # ●● XF ➜ 5.115
     write_xfs workbook, buffer1
-    # ●● STYLE ➜ 6.99
+    # ●● STYLE ➜ 5.103
     write_styles workbook, buffer1
-    # ○  PALETTE ➜ 6.70
-    # ○  USESELFS ➜ 6.105
+    # ○  PALETTE ➜ 5.74
+    # ○  USESELFS ➜ 5.106
     buffer1.rewind
-    # ●● BOUNDSHEET ➜ 6.12
+    # ●● BOUNDSHEET ➜ 5.95
     buffer2 = StringIO.new ''
-    # ○  COUNTRY ➜ 6.23
-    # ○  Link Table ➜ 5.10.3
+    # ○  COUNTRY ➜ 5.22
+    # ○  Link Table ➜ 4.10.3
     # ○○ NAME ➜ 6.66
-    # ○  Shared String Table ➜ 5.11
-    # ●  SST ➜ 6.96
-    # ●  EXTSST ➜ 6.40
+    # ○  Shared String Table ➜ 4.11
+    # ●  SST ➜ 5.100
+    # ●  EXTSST ➜ 5.42
     write_sst workbook, buffer2, buffer1.size
-    # ●  EOF ➜ 6.36
+    # ●  EOF ➜ 5.37
     write_eof workbook, buffer2
     buffer2.rewind
     # worksheet data can only be assembled after write_sst
@@ -482,7 +489,9 @@ class Workbook < Spreadsheet::Writer
     strings.each_with_index do |string, idx|
       sst.store string, idx
       op_offset = data.size + 4
-      offsets.push [offset + writer.pos + op_offset, op_offset] if idx % 8 == 0
+      if idx % SST_CHUNKSIZE == 0
+        offsets.push [offset + writer.pos + op_offset, op_offset]
+      end
       header, packed, next_wide = _unicode_string string, 2
       # the first few bytes (header + first character) must not be split
       must_fit = header.size + wide + 1
@@ -546,9 +555,9 @@ class Workbook < Spreadsheet::Writer
               # 0x07 = Currency [0] (BIFF4-BIFF8)
               # 0x08 = Hyperlink (BIFF8)
               # 0x09 = Followed Hyperlink (BIFF8)
-      0xFF,   # Level for RowLevel or ColLevel style (zero-based, lv),
-              # 0xFF otherwise
-      0x00,   # The RowLevel and ColLevel styles specify the formatting of
+      0xff,   # Level for RowLevel or ColLevel style (zero-based, lv),
+              # 0xff otherwise
+              # The RowLevel and ColLevel styles specify the formatting of
               # subtotal cells in a specific outline level. The level is
               # specified by the last field in the STYLE record. Valid values
               # are 0…6 for the outline levels 1…7.

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

@@ -158,7 +158,7 @@ class Worksheet
     write_op 0x000c, [count].pack('v')
   end
   def write_cell type, row, idx, *args
-    xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx)
+    xf_idx = @workbook.xf_index @worksheet.workbook, row.formats[idx]
     data = [
       row.idx, # Index to row
       idx,     # Index to column
@@ -178,6 +178,7 @@ class Worksheet
     # RK ➜ 6.82 (BIFF3-BIFF8)
     # RSTRING ➜ 6.84 (BIFF5/BIFF7)
     multiples, first_idx = nil
+    row = row.formatted
     row.each_with_index do |cell, idx|
       cell = nil if cell == ''
       ## it appears that there are limitations to RK precision, both for
@@ -357,7 +358,7 @@ 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)
+    xf_idx = @workbook.xf_index @worksheet.workbook, row.formats[idx]
     cell = row[idx]
     data1 = [
       row.idx,      # Index to row
@@ -415,47 +416,52 @@ class Worksheet
   ##
   # Write a new Worksheet.
   def write_from_scratch
-    # ●  BOF Type = worksheet (➜ 6.8)
+    # ●  BOF Type = worksheet (➜ 5.8)
     write_bof
-    # ○  UNCALCED ➜ 6.104
-    # ○  INDEX ➜ 5.7 (Row Blocks), ➜ 6.55
-    # ○  Calculation Settings Block ➜ 5.3
+    # ○  UNCALCED ➜ 5.105
+    # ○  INDEX ➜ 4.7 (Row Blocks), ➜ 5.59
+    # ○  Calculation Settings Block ➜ 4.3
     write_calccount
     write_refmode
     write_iteration
     write_saverecalc
-    # ○  PRINTHEADERS ➜ 6.76
-    # ○  PRINTGRIDLINES ➜ 6.75
-    # ○  GRIDSET ➜ 6.48
-    # ○  GUTS ➜ 6.49
-    # ○  DEFAULTROWHEIGHT ➜ 6.28
+    # ○  PRINTHEADERS ➜ 5.81
+    # ○  PRINTGRIDLINES ➜ 5.80
+    # ○  GRIDSET ➜ 5.52
+    # ○  GUTS ➜ 5.53
+    # ○  DEFAULTROWHEIGHT ➜ 5.31
     write_defaultrowheight
-    # ○  WSBOOL ➜ 6.113
+    # ○  WSBOOL ➜ 5.113
     write_wsbool
-    # ○  Page Settings Block ➜ 5.4
-    # ○  Worksheet Protection Block ➜ 5.18
-    # ○  DEFCOLWIDTH ➜ 6.29
+    # ○  Page Settings Block ➜ 4.4
+    # ○  Worksheet Protection Block ➜ 4.18
+    # ○  DEFCOLWIDTH ➜ 5.32
     write_defcolwidth
-    # ○○ COLINFO ➜ 6.18
+    # ○○ COLINFO ➜ 5.18
     write_colinfos
-    # ○  SORT ➜ 6.95
-    # ●  DIMENSIONS ➜ 6.31
+    # ○  SORT ➜ 5.99
+    # ●  DIMENSIONS ➜ 5.35
     write_dimensions
-    # ○○ Row Blocks ➜ 5.7
+    # ○○ Row Blocks ➜ 4.7
     write_rows
-    # ●  Worksheet View Settings Block ➜ 5.5
-    # ○  STANDARDWIDTH ➜ 6.97
-    # ○○ MERGEDCELLS ➜ 6.63
-    # ○  LABELRANGES ➜ 6.60
-    # ○  PHONETIC ➜ 6.73
-    # ○  Conditional Formatting Table ➜ 5.12
-    # ○  Hyperlink Table ➜ 5.13
+    # ●  Worksheet View Settings Block ➜ 4.5
+    # ●  WINDOW2 ➜ 5.110
+    write_window2
+    # ○  SCL ➜ 5.92 (BIFF4-BIFF8 only)
+    # ○  PANE ➜ 5.75
+    # ○○ SELECTION ➜ 5.93
+    # ○  STANDARDWIDTH ➜ 5.101
+    # ○○ MERGEDCELLS ➜ 5.67
+    # ○  LABELRANGES ➜ 5.64
+    # ○  PHONETIC ➜ 5.77
+    # ○  Conditional Formatting Table ➜ 4.12
+    # ○  Hyperlink Table ➜ 4.13
     write_hyperlink_table
-    # ○  Data Validity Table ➜ 5.14
-    # ○  SHEETLAYOUT ➜ 6.91 (BIFF8X only)
-    # ○  SHEETPROTECTION Additional protection, ➜ 6.92 (BIFF8X only)
-    # ○  RANGEPROTECTION Additional protection, ➜ 6.79 (BIFF8X only)
-    # ●  EOF ➜ 6.36
+    # ○  Data Validity Table ➜ 4.14
+    # ○  SHEETLAYOUT ➜ 5.96 (BIFF8X only)
+    # ○  SHEETPROTECTION Additional protection, ➜ 5.98 (BIFF8X only)
+    # ○  RANGEPROTECTION Additional protection, ➜ 5.84 (BIFF8X only)
+    # ●  EOF ➜ 5.36
     write_eof
   end
   def write_hlink row, col, link
@@ -556,11 +562,11 @@ class Worksheet
     ]
     # List of nc=lc-fc+1 16-bit indexes to XF records (➜ 6.115)
     multiples.each_with_index do |blank, cell_idx|
-      xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx + cell_idx)
+      xf_idx = @workbook.xf_index @worksheet.workbook, row.formats[idx + cell_idx]
       data.push xf_idx
     end
     # Index to last column (lc)
-    data.push idx + multiples.size
+    data.push idx + multiples.size - 1
     write_op opcode(:mulblank), data.pack('v*')
   end
   ##
@@ -673,23 +679,28 @@ class Worksheet
     #                                       formatted with a medium or thick
     #                                       line style. Thin line styles are
     #                                       not taken into account.
-    height = row.height || 12 # FIXME: where is the default font height?
+    height = row.height || ROW_HEIGHT
     opts = row.outline_level & 0x00000007
     opts |= 0x00000010 if row.collapsed?
     opts |= 0x00000020 if row.hidden?
-    opts |= 0x00000040 if height != 12 # FIXME: where is the default font height?
+    opts |= 0x00000040 if height != ROW_HEIGHT
     if fmt = row.default_format
       xf_idx = @workbook.xf_index @worksheet.workbook, fmt
       opts |= 0x00000080
       opts |= xf_idx << 16
     end
     opts |= 0x00000100
+    height = if height == ROW_HEIGHT
+               height * TWIPS
+             else
+               ( height * TWIPS ) | 0x8000
+             end
     # TODO: Row spacing
     data = [
       row.idx,
       row.first_used,
       row.first_unused,
-      height * TWIPS,
+      height,
       opts,
     ].pack binfmt(:row)
     write_op opcode(:row), data
@@ -714,6 +725,54 @@ class Worksheet
     # 0 = Do not recalculate; 1 = Recalculate before saving the document
     write_op 0x005f, [1].pack('v')
   end
+  def write_window2
+    # This record contains additional settings for the document window
+    # (BIFF2-BIFF4) or for the window of a specific worksheet (BIFF5-BIFF8).
+    # It is part of the Sheet View Settings Block (➜ 4.5).
+    # Offset  Size  Contents
+    #      0     2  Option flags:
+    #               Bits  Mask    Contents
+    #                  0  0x0001  0 = Show formula results
+    #                             1 = Show formulas
+    #                  1  0x0002  0 = Do not show grid lines
+    #                             1 = Show grid lines
+    #                  2  0x0004  0 = Do not show sheet headers
+    #                             1 = Show sheet headers
+    #                  3  0x0008  0 = Panes are not frozen
+    #                             1 = Panes are frozen (freeze)
+    #                  4  0x0010  0 = Show zero values as empty cells
+    #                             1 = Show zero values
+    #                  5  0x0020  0 = Manual grid line colour
+    #                             1 = Automatic grid line colour
+    #                  6  0x0040  0 = Columns from left to right
+    #                             1 = Columns from right to left
+    #                  7  0x0080  0 = Do not show outline symbols
+    #                             1 = Show outline symbols
+    #                  8  0x0100  0 = Keep splits if pane freeze is removed
+    #                             1 = Remove splits if pane freeze is removed
+    #                  9  0x0200  0 = Sheet not selected
+    #                             1 = Sheet selected (BIFF5-BIFF8)
+    #                 10  0x0400  0 = Sheet not active
+    #                             1 = Sheet active (BIFF5-BIFF8)
+    #                 11  0x0800  0 = Show in normal view
+    #                             1 = Show in page break preview (BIFF8)
+    #      2     2  Index to first visible row
+    #      4     2  Index to first visible column
+    #      6     2  Colour index of grid line colour (➜ 5.74).
+    #               Note that in BIFF2-BIFF5 an RGB colour is written instead.
+    #      8     2  Not used
+    #     10     2  Cached magnification factor in page break preview (in percent)
+    #               0 = Default (60%)
+    #     12     2  Cached magnification factor in normal view (in percent)
+    #               0 = Default (100%)
+    #     14     4  Not used
+    flags = 310
+    if @worksheet.active
+      flags |= 0x0200
+    end
+    data = [ flags, 0, 0, 0, 0, 0 ].pack binfmt(:window2)
+    write_op opcode(:window2), data
+  end
   def write_wsbool
     bits = [
          #   Bit  Mask    Contents

data/lib/spreadsheet/helpers.rb

@@ -0,0 +1,11 @@
+class Array
+  def rcompact
+    dup.rcompact!
+  end
+  def rcompact!
+    while !empty? && last.nil?
+      pop
+    end
+    self
+  end
+end

data/lib/spreadsheet/row.rb

@@ -1,3 +1,5 @@
+require 'spreadsheet/helpers'
+
 module Spreadsheet
   ##
   # The Row class. Encapsulates Cell data and formatting.
@@ -23,10 +25,7 @@ module Spreadsheet
             alias_method :"unupdated_#{key}=", :"#{key}="
             define_method "#{key}=" do |value|
               send "unupdated_#{key}=", value
-              if @worksheet
-                @formatted = true
-                @worksheet.row_updated @idx, self, :formatted => true
-              end
+              @worksheet.row_updated @idx, self if @worksheet
               value
             end
           end
@@ -36,9 +35,7 @@ module Spreadsheet
         keys.each do |key|
           define_method key do |*args|
             res = super
-            if @worksheet
-              @worksheet.row_updated @idx, self, :formatted => @formatted
-            end
+            @worksheet.row_updated @idx, self if @worksheet
             res
           end
         end
@@ -55,31 +52,22 @@ module Spreadsheet
     def initialize worksheet, idx, cells=[]
       @worksheet = worksheet
       @idx = idx
-      while !cells.empty? && !cells.last
-        cells.pop
-      end
       super cells
-      @first_used ||= index_of_first self
-      @first_unused ||= size
       @formats = []
-      @height = 12
+      @height = 12.1
     end
     ##
     # 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 if @worksheet
-      @worksheet.row_updated @idx, self, :formatted => true if @worksheet
+      @worksheet.row_updated @idx, self if @worksheet
       @default_format = format
     end
     ##
-    # #first_unused (really last used + 1) - the 0-based index of the first of
-    # all remaining contiguous blank Cells.
-    alias :first_unused :size
-    ##
     # #first_used the 0-based index of the first non-blank Cell.
     def first_used
-      index_of_first self
+      [ index_of_first(self), index_of_first(@formats) ].compact.min
     end
     ##
     # The Format for the Cell at _idx_ (0-based), or the first valid Format in
@@ -89,22 +77,48 @@ module Spreadsheet
         || @worksheet.column(idx).default_format if @worksheet
     end
     ##
-    # Set the Format for the Cell at _idx_ (0-based).
-    def set_format idx, fmt
-      @formats[idx] = fmt
-      @worksheet.add_format fmt
-      @worksheet.row_updated @idx, self, :formatted => true if @worksheet
-      fmt
+    # Returns a copy of self with nil-values appended for empty cells that have
+    # an associated Format.
+    # This is primarily a helper-function for the writer classes.
+    def formatted
+      copy = dup
+      @formats.rcompact!
+      if copy.length < @formats.size
+        copy.concat Array.new(@formats.size - copy.length)
+      end
+      copy
+    end
+    ##
+    # Same as Row#size, but takes into account formatted empty cells
+    def formatted_size
+      @formats.rcompact!
+      sz = size
+      fs = @formats.size
+      fs > sz ? fs : sz
     end
+    ##
+    # #first_unused (really last used + 1) - the 0-based index of the first of
+    # all remaining contiguous blank Cells.
+    alias :first_unused :formatted_size
     def inspect
       variables = instance_variables.collect do |name|
         "%s=%s" % [name, instance_variable_get(name)]
       end.join(' ')
       sprintf "#<%s:0x%014x %s %s>", self.class, object_id, variables, super
     end
+    ##
+    # Set the Format for the Cell at _idx_ (0-based).
+    def set_format idx, fmt
+      @formats[idx] = fmt
+      @worksheet.add_format fmt
+      @worksheet.row_updated @idx, self if @worksheet
+      fmt
+    end
     private
     def index_of_first ary # :nodoc:
-      ary.index(ary.find do |elm| elm end)
+      if first = ary.find do |elm| !elm.nil? end
+        ary.index first
+      end
     end
   end
 end

data/lib/spreadsheet/workbook.rb

@@ -13,7 +13,7 @@ module Spreadsheet
   class Workbook
     include Spreadsheet::Encodings
     attr_reader :io, :worksheets, :formats, :fonts
-    attr_accessor :encoding, :version, :default_format
+    attr_accessor :active_worksheet, :encoding, :default_format, :version
     def initialize io = nil, opts={:default_format => Format.new}
       @worksheets = []
       @io = io

data/lib/spreadsheet/worksheet.rb

@@ -19,12 +19,19 @@ module Spreadsheet
   #                   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.
+  # #active        :: When a user chooses to print a Workbook, Excel will include
+  #                   all active Worksheets. Defaults to true. If you want to
+  #                   exclude a Worksheet from the default print-list, set this
+  #                   to false. Warning: Excel will display a cryptic Error
+  #                   Message if a user tries to print a Workbook that has no
+  #                   active Worksheets.
   class Worksheet
     include Spreadsheet::Encodings
     include Enumerable
-    attr_accessor :name, :workbook
+    attr_accessor :active, :name, :workbook
     attr_reader :rows, :columns
     def initialize opts={}
+      @active = true
       @dimensions = [0,0,0,0]
       @name = opts[:name] || 'Worksheet'
       @workbook = opts[:workbook]
@@ -173,11 +180,8 @@ module Spreadsheet
     ##
     # Tell Worksheet that the Row at _idx_ has been updated and the #dimensions
     # need to be recalculated. You should not need to call this directly.
-    def row_updated idx, row, opts={}
+    def row_updated idx, row
       @dimensions = nil
-      unless opts[:formatted]
-        row = shorten(row)
-      end
       @rows[idx] = row
       format_dates row
       row
@@ -188,7 +192,7 @@ module Spreadsheet
       res = if row = @rows[idx]
               row[0, cells.size] = cells
               row
-            elsif cells = shorten(cells)
+            else
               Row.new self, idx, cells
             end
       row_updated idx, res
@@ -251,8 +255,9 @@ module Spreadsheet
       @dimensions[0] = index_of_first(@rows) || 0
       @dimensions[1] = @rows.size
       compact = @rows.compact
-      @dimensions[2] = compact.collect do |row| index_of_first row end.compact.min || 0
-      @dimensions[3] = compact.collect do |row| row.size end.max || 0
+      @dimensions[2] = compact.collect do |row| row.first_used end.compact.min || 0
+      @dimensions[3] = compact.collect do |row| row.first_unused end.max || 0
+      puts caller if @dimensions.nil?
       @dimensions
     end
     def shorten ary # :nodoc:

data/test/excel/row.rb

@@ -19,8 +19,8 @@ class TestRow < Test::Unit::TestCase
     assert_equal Date.new(1975,8,21), row.date(1)
   end
   def test_datetime
-    row = Row.new @worksheet, 0, [nil, 27627.6789]
-    d1 = DateTime.new(1975,8,21) + 0.6789
+    row = Row.new @worksheet, 0, [nil, 27627.765]
+    d1 = DateTime.new(1975,8,21) + 0.765
     d2 = row.datetime 1
     assert_equal d1, d2
   end

data/test/excel/writer/worksheet.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# Excel::Writer::TestWorksheet -- Spreadheet -- 21.11.2007 -- hwyss@ywesee.com
+
+require 'test/unit'
+require 'spreadsheet/excel/writer/worksheet'
+
+module Spreadsheet
+  module Excel
+    module Writer
+class TestWorksheet < Test::Unit::TestCase
+  def test_need_number
+    sheet = Worksheet.new nil, nil
+    assert_equal false, sheet.need_number?(10)
+    assert_equal false, sheet.need_number?(114.55)
+    assert_equal false, sheet.need_number?(0.1)
+    assert_equal false, sheet.need_number?(0.01)
+    assert_equal true, sheet.need_number?(0.001)
+  end
+end
+    end
+  end
+end

data/test/integration.rb

@@ -63,7 +63,7 @@ module Spreadsheet
         enc = Encoding.find enc
       end
       assert_equal enc, book.encoding
-      assert_equal 24, book.formats.size
+      assert_equal 25, book.formats.size
       assert_equal 5, book.fonts.size
       str1 = book.shared_string 0
       assert_equal @@iconv.iconv('Shared String'), str1
@@ -92,10 +92,10 @@ module Spreadsheet
       end
       assert_equal long, str4
       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]
-      unuseds = [2,2,1,1,1,2,1,11,1,2]
+      assert_equal 11, sheet.row_count
+      assert_equal 12, sheet.column_count
+      useds = [0,0,0,0,0,0,0,1,0,0,11]
+      unuseds = [2,2,1,1,1,2,1,11,1,2,12]
       sheet.each do |row|
         assert_equal useds.shift, row.first_used
         assert_equal unuseds.shift, row.first_unused
@@ -154,6 +154,7 @@ module Spreadsheet
       assert_equal 0.0001, row[0]
       row = sheet.row 9
       assert_equal 0.00009, row[0]
+      assert_equal :green, sheet.row(10).format(11).pattern_fg_color
     end
     def test_version_excel97__ooffice
       path = File.join @data, 'test_version_excel97.xls'
@@ -166,7 +167,7 @@ module Spreadsheet
         enc = Encoding.find enc
       end
       assert_equal enc, book.encoding
-      assert_equal 24, book.formats.size
+      assert_equal 25, book.formats.size
       assert_equal 5, book.fonts.size
       str1 = book.shared_string 0
       assert_equal 'Shared String', str1
@@ -195,10 +196,10 @@ module Spreadsheet
       end
       assert_equal long, str4
       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]
-      unuseds = [2,2,1,1,1,2,1,11,1,2]
+      assert_equal 11, sheet.row_count
+      assert_equal 12, sheet.column_count
+      useds = [0,0,0,0,0,0,0,1,0,0,11]
+      unuseds = [2,2,1,1,1,2,1,11,1,2,12]
       sheet.each do |row|
         assert_equal useds.shift, row.first_used
         assert_equal unuseds.shift, row.first_unused
@@ -577,10 +578,10 @@ module Spreadsheet
       book.write path
       assert_nothing_raised do book = Spreadsheet.open path end
       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]
-      unuseds = [2,2,1,1,1,2,1,11,1,2]
+      assert_equal 11, sheet.row_count
+      assert_equal 12, sheet.column_count
+      useds = [0,0,0,0,0,0,0,1,0,0,11]
+      unuseds = [2,2,1,1,1,2,1,11,1,2,12]
       sheet.each do |row|
         assert_equal useds.shift, row.first_used
         assert_equal unuseds.shift, row.first_unused
@@ -686,10 +687,10 @@ module Spreadsheet
       assert_equal str3, book.shared_string(2)
       assert_equal str4, book.shared_string(3)
       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]
-      unuseds = [2,2,1,1,1,2,1,11,1,2]
+      assert_equal 11, sheet.row_count
+      assert_equal 12, sheet.column_count
+      useds = [0,0,0,0,0,0,0,1,0,0,11]
+      unuseds = [2,2,1,1,1,2,1,11,1,2,12]
       sheet.each do |row|
         assert_equal useds.shift, row.first_used
         assert_equal unuseds.shift, row.first_unused

data/test/row.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# TestRow -- Spreadsheet -- 08.01.2009 -- hwyss@ywesee.com
+
+$: << File.expand_path('../../lib', File.dirname(__FILE__))
+
+require 'test/unit'
+require 'spreadsheet'
+
+module Spreadsheet
+  class TestRow < Test::Unit::TestCase
+    def setup
+      @workbook = Excel::Workbook.new
+      @worksheet = Excel::Worksheet.new
+      @workbook.add_worksheet @worksheet
+    end
+    def test_formatted
+      row = Row.new @worksheet, 0, [nil, 1]
+      assert_equal 2, row.formatted.size
+      row.set_format 3, Format.new
+      assert_equal 4, row.formatted.size
+    end
+    def test_concat
+      row = Row.new @worksheet, 0, [nil, 1, nil]
+      assert_equal [nil, 1, nil], row
+      row.concat [2, nil]
+      assert_equal [nil, 1, nil, 2, nil], row
+      row.concat [3]
+      assert_equal [nil, 1, nil, 2, nil, 3], row
+      row.concat [nil, 4]
+      assert_equal [nil, 1, nil, 2, nil, 3, nil, 4], row
+    end
+  end
+end

data/test/suite.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# suite.rb -- oddb -- 08.01.2009 -- hwyss@ywesee.com
+
+require 'find'
+
+here = File.dirname(__FILE__)
+
+$: << here
+
+Find.find(here) do |file|
+	if /(?<!suite)\.rb$/o.match(file)
+    require file
+	end
+end

data/test/worksheet.rb

@@ -28,10 +28,10 @@ module Spreadsheet
       assert_equal 2, @sheet.row_count
       @sheet[1,0] = nil
       assert_equal 2, @sheet.column_count
-      assert_equal 1, @sheet.row_count
+      assert_equal 2, @sheet.row_count
       @sheet[0,1] = nil
-      assert_equal 1, @sheet.column_count
-      assert_equal 1, @sheet.row_count
+      assert_equal 2, @sheet.column_count
+      assert_equal 2, @sheet.row_count
     end
     def test_column_count
       assert_equal 0, @sheet.column_count
@@ -44,7 +44,7 @@ module Spreadsheet
       @sheet.replace_row 5, nil, 'something', 4, 7, nil
       assert_equal 4, @sheet.column_count
       @sheet.replace_row 3
-      assert_equal 3, @sheet.column_count
+      assert_equal 4, @sheet.column_count
     end
     def test_row_count
       assert_equal 0, @sheet.row_count
@@ -57,7 +57,15 @@ module Spreadsheet
       @sheet.replace_row 5, nil, 'something', 4, 7, nil
       assert_equal 6, @sheet.row_count
       @sheet.replace_row 3
+      assert_equal 6, @sheet.row_count
+      @sheet.delete_row 3
+      assert_equal 5, @sheet.row_count
+      @sheet.delete_row 3
+      assert_equal 4, @sheet.row_count
+      @sheet.delete_row 2
       assert_equal 4, @sheet.row_count
+      @sheet.delete_row 2
+      assert_equal 3, @sheet.row_count
     end
     def test_modify_column
       assert_equal 10, @sheet.column(0).width

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spreadsheet
 version: !ruby/object:Gem::Version 
-  version: 0.6.2.1
+  version: 0.6.3
 platform: ruby
 authors: 
 - Hannes Wyss
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-19 00:00:00 +01:00
+date: 2009-01-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,8 +35,8 @@ dependencies:
 description: The Spreadsheet Library is designed to read and write Spreadsheet Documents. As of version 0.6.0, only Microsoft Excel compatible spreadsheets are supported. Spreadsheet is a combination/complete rewrite of the Spreadsheet::Excel Library by Daniel J. Berger and the ParseExcel Library by Hannes Wyss. Spreadsheet can read, write and modify Spreadsheet Documents.
 email: 
 - hannes.wyss@gmail.com
-executables: []
-
+executables: 
+- xlsopcodes
 extensions: []
 
 extra_rdoc_files: 
@@ -52,6 +52,7 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- bin/xlsopcodes
 - lib/parseexcel.rb
 - lib/parseexcel/parseexcel.rb
 - lib/parseexcel/parser.rb
@@ -80,19 +81,24 @@ files:
 - lib/spreadsheet/font.rb
 - lib/spreadsheet/format.rb
 - lib/spreadsheet/formula.rb
+- lib/spreadsheet/helpers.rb
 - lib/spreadsheet/link.rb
 - lib/spreadsheet/row.rb
 - lib/spreadsheet/workbook.rb
 - lib/spreadsheet/worksheet.rb
 - lib/spreadsheet/writer.rb
 - test/data/test_copy.xls
+- test/data/test_datetime.xls
 - test/data/test_empty.xls
 - test/data/test_version_excel5.xls
 - test/data/test_version_excel95.xls
 - test/data/test_version_excel97.xls
 - test/excel/row.rb
+- test/excel/writer/worksheet.rb
 - test/font.rb
 - test/integration.rb
+- test/row.rb
+- test/suite.rb
 - test/workbook.rb
 - test/worksheet.rb
 has_rdoc: true