spreadsheet 0.6.3 → 0.6.3.1

data/History.txt

@@ -1,3 +1,33 @@
+=== 0.6.3.1 / 2009-02-13
+
+* 3 Bugfixes
+
+  * Only selects the First Worksheet by default
+    This deals with an issue reported by Biörn Andersson in
+    http://rubyforge.org/tracker/?func=detail&atid=2677&aid=23736&group_id=678
+    where data-edits in OpenOffice were propagated through all selected
+    sheets.
+
+  * Honors Row, Column, Worksheet and Workbook-formats
+    and thus fixes a Bug introduced in
+    http://scm.ywesee.com/?p=spreadsheet;a=commit;h=52755ad76fdda151564b689107ca2fbb80af3b78
+    and reported in
+    http://rubyforge.org/tracker/index.php?func=detail&aid=23875&group_id=678&atid=2678
+    and by Joachim Schneider in
+    http://rubyforge.org/forum/forum.php?thread_id=31056&forum_id=2920
+
+  * Fixes a bug reported by Alexander Skwar in
+    http://rubyforge.org/forum/forum.php?thread_id=31403&forum_id=2920
+    where the user-defined formatting of Dates and Times was overwritten with
+    a default format, and other issues connected with writing Dates and Times
+    into Spreadsheets.
+
+* 1 minor enhancements
+
+  * Spreadsheet shold now be completely warning-free,
+    as requested by Eric Peterson in
+    http://rubyforge.org/forum/forum.php?thread_id=31346&forum_id=2920
+
 === 0.6.3 / 2009-01-14
 
 * 1 Bugfix

data/lib/spreadsheet.rb

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

data/lib/spreadsheet/column.rb

@@ -39,6 +39,7 @@ module Spreadsheet
     enum :outline_level, 0, Integer
     updater :collapsed, :hidden, :outline_level, :width
     def initialize idx, format, opts={}
+      @worksheet = nil
       @idx = idx
       opts[:width] ||= 10
       opts.each do |key, value|

data/lib/spreadsheet/datatypes.rb

@@ -21,10 +21,11 @@ class << self
   def boolean *args
     args.each do |key|
       define_method key do
-        !!instance_variable_get("@#{key}")
+        name = "@#{key}"
+        !!(instance_variable_get(name) if instance_variables.include?(name))
       end
       define_method "#{key}?" do
-        !!instance_variable_get("@#{key}")
+        send key
       end
       define_method "#{key}=" do |arg|
         arg = false if arg == 0
@@ -73,7 +74,9 @@ class << self
       aliases.store value, value
     end
     define_method key do
-      instance_variable_get("@#{key}") || values.first
+      name = "@#{key}"
+      value = instance_variable_get(name) if instance_variables.include? name
+      value || values.first
     end
     define_method "#{key}=" do |arg|
       if arg

data/lib/spreadsheet/excel/reader.rb

@@ -26,7 +26,9 @@ class Reader
       [1].pack('l') != "\001\000\000\000"
     }
     @opts = opts
+    @boundsheets = nil
     @current_row_block = {}
+    @current_row_block_offset = nil
     @formats = {}
     BUILTIN_FORMATS.each do |key, fmt| @formats.store key, client(fmt, 'UTF-8') end
   end
@@ -183,7 +185,7 @@ class Reader
     else
       @boundsheets = [1, pos, len]
     end
-    @workbook.set_boundsheets *@boundsheets
+    @workbook.set_boundsheets(*@boundsheets)
     @workbook.add_worksheet Worksheet.new(:name     => name,
                                           :ole      => @book,
                                           :offset   => offset,
@@ -710,6 +712,50 @@ class Reader
     value = client read_string(work[6..-1], 2), @workbook.encoding
     set_cell worksheet, row, column, xf, value
   end
+  def read_window2 worksheet, work, pos, len
+    # 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, _ = work.unpack 'v'
+    worksheet.selected = flags & 0x0200 > 0
+  end
   def read_workbook
     worksheet = nil
     previous_op = nil
@@ -718,14 +764,6 @@ class Reader
       case op
       when @bof, :bof  # ●  BOF Type = worksheet (➜ 6.8)
         return
-        worksheet = @workbook.worksheets.find do |worksheet|
-          worksheet.offset == pos
-        end
-        if worksheet
-          read_worksheet worksheet
-        else
-          warn "Unexpected BOF (0x%04x) at position 0x%04x" % [@bof, pos]
-        end
       when :eof        # ●  EOF ➜ 6.36
         postread_workbook
         return
@@ -795,6 +833,8 @@ class Reader
         set_row_address worksheet, work, pos, len
       when :hlink
         read_hlink worksheet, work, pos, len
+      when :window2
+        read_window2 worksheet, work, pos, len
       end
       previous = op
     end

data/lib/spreadsheet/excel/sst_entry.rb

@@ -9,6 +9,7 @@ class SstEntry
   attr_accessor :chars, :phonetic, :richtext, :flags, :available,
                 :continued_chars, :wide
   def initialize opts = {}
+    @content = nil
     @offset = opts[:offset]
     @ole    = opts[:ole]
     @reader = opts[:reader]

data/lib/spreadsheet/excel/worksheet.rb

@@ -13,6 +13,7 @@ class Worksheet < Spreadsheet::Worksheet
   offset :dimensions
   attr_reader :offset, :ole, :links
   def initialize opts = {}
+    @row_addresses = nil
     super
     @offset, @ole, @reader = opts[:offset], opts[:ole], opts[:reader]
     @dimensions = nil

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

@@ -95,6 +95,17 @@ class Workbook < Spreadsheet::Writer
   def number_format_index workbook, format
     @number_formats[workbook][format] || 0
   end
+  def sanitize_worksheets sheets
+    found_selected = false
+    sheets.each do |sheet|
+      found_selected ||= sheet.selected
+      sheet.format_dates!
+    end
+    unless found_selected
+      sheets.first.selected = true
+    end
+    sheets
+  end
   def worksheets workbook
     @worksheets[workbook] ||= workbook.worksheets.collect do |worksheet|
       Excel::Writer::Worksheet.new self, worksheet
@@ -147,6 +158,7 @@ class Workbook < Spreadsheet::Writer
   # Copy unchanged data verbatim, adjust offsets and write new records for
   # changed data.
   def write_changes workbook, io
+    sanitize_worksheets workbook.worksheets
     collect_formats workbook, :existing_document => true
     reader = workbook.ole
     sheet_data = {}
@@ -370,6 +382,7 @@ class Workbook < Spreadsheet::Writer
   ##
   # Write a new Excel file.
   def write_from_scratch workbook, io
+    sanitize_worksheets workbook.worksheets
     collect_formats workbook
     sheets = worksheets workbook
     buffer1 = StringIO.new ''
@@ -568,6 +581,8 @@ class Workbook < Spreadsheet::Writer
     write_op writer, 0x013d, [1].pack('v')
   end
   def write_window1 workbook, writer
+    selected = workbook.worksheets.find do |sheet| sheet.selected end
+    actidx = workbook.worksheets.index selected
     data = [
       0x0000, # Horizontal position of the document window
               # (in twips = 1/20 of a point)
@@ -587,7 +602,7 @@ class Workbook < Spreadsheet::Writer
               #              1 = Vertical scroll bar visible
               #   5  0x0020  0 = Worksheet tab bar hidden
               #              1 = Worksheet tab bar visible
-      0x0000, # Index to active (displayed) worksheet
+      actidx, # Index to active (displayed) worksheet
       0x0000, # Index of first visible tab in the worksheet tab bar
       0x0001, # Number of selected worksheets
               # (highlighted in the worksheet tab bar)

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.formats[idx]
+    xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx)
     data = [
       row.idx, # Index to row
       idx,     # Index to column
@@ -222,8 +222,8 @@ class Worksheet
         end
       when Formula
         write_formula row, idx
-      when Date
-        write_rk row, idx
+      when Date, Time
+        write_number row, idx
       end
     end
     write_multiples row, first_idx, multiples if multiples
@@ -358,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.formats[idx]
+    xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx)
     cell = row[idx]
     data1 = [
       row.idx,      # Index to row
@@ -562,7 +562,7 @@ 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.formats[idx + cell_idx]
+      xf_idx = @workbook.xf_index @worksheet.workbook, row.format(idx + cell_idx)
       data.push xf_idx
     end
     # Index to last column (lc)
@@ -607,7 +607,12 @@ class Worksheet
     # 2 2 Index to column
     # 4 2 Index to XF record (➜ 6.115)
     # 6 8 IEEE 754 floating-point value (64-bit double precision)
-    write_cell :number, row, idx, row[idx]
+    value = row[idx]
+    case value
+    when Date, Time
+      value = encode_date(value)
+    end
+    write_cell :number, row, idx, value
   end
   def write_op op, *args
     data = args.join
@@ -625,12 +630,7 @@ class Worksheet
   ##
   # Write a cell with a Numeric or Date value.
   def write_rk row, idx
-    value = row[idx]
-    case value
-    when Date, DateTime
-      value = encode_date(value)
-    end
-    write_cell :rk, row, idx, encode_rk(value)
+    write_cell :rk, row, idx, encode_rk(row[idx])
   end
   def write_row row
     # Offset  Size  Contents
@@ -766,8 +766,10 @@ class Worksheet
     #     12     2  Cached magnification factor in normal view (in percent)
     #               0 = Default (100%)
     #     14     4  Not used
-    flags = 310
-    if @worksheet.active
+    flags = 0x0536  # Show grid lines, sheet headers, zero values. Automatic
+                    # grid line colour, Remove slits if pane freeze is removed,
+                    # Sheet is active.
+    if @worksheet.selected
       flags |= 0x0200
     end
     data = [ flags, 0, 0, 0, 0, 0 ].pack binfmt(:window2)

data/lib/spreadsheet/format.rb

@@ -158,6 +158,11 @@ module Spreadsheet
       !!/[YMD]/.match(@number_format.to_s)
     end
     ##
+    # Is the cell formatted as a Date or Time?
+    def date_or_time?
+      !!/[hmsYMD]/.match(@number_format.to_s)
+    end
+    ##
     # Is the cell formatted as a DateTime?
     def datetime?
       !!/([YMD].*[HS])|([HS].*[YMD])/.match(@number_format.to_s)

data/lib/spreadsheet/link.rb

@@ -18,9 +18,10 @@ module Spreadsheet
   #                  but if you do, here is where you can find it.
   class Link < String
     attr_accessor :target_frame, :url, :dos, :fragment
-    def initialize url='', description=url
+    def initialize url='', description=url, fragment=nil
       super description
       @url = url
+      @fragment = fragment
     end
     ##
     # The Url with the fragment appended if present.

data/lib/spreadsheet/row.rb

@@ -50,6 +50,7 @@ module Spreadsheet
             :sort!, :uniq!, :unshift
     format_updater :collapsed, :height, :hidden, :outline_level
     def initialize worksheet, idx, cells=[]
+      @default_format = nil
       @worksheet = worksheet
       @idx = idx
       super cells

data/lib/spreadsheet/workbook.rb

@@ -72,7 +72,6 @@ module Spreadsheet
       end
     end
     def inspect
-      "#<#{self.class}:#{object_id} "
       variables = (instance_variables - uninspect_variables).collect do |name|
         "%s=%s" % [name, instance_variable_get(name)]
       end.join(' ')

data/lib/spreadsheet/worksheet.rb

@@ -19,19 +19,18 @@ 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.
+  # #selected      :: When a user chooses to print a Workbook, Excel will include
+  #                   all selected Worksheets. If no Worksheet is selected at
+  #                   Workbook#write, then the first Worksheet is selected by
+  #                   default.
   class Worksheet
     include Spreadsheet::Encodings
     include Enumerable
-    attr_accessor :active, :name, :workbook
+    attr_accessor :name, :selected, :workbook
     attr_reader :rows, :columns
     def initialize opts={}
-      @active = true
+      @default_format = nil
+      @selected = opts[:selected]
       @dimensions = [0,0,0,0]
       @name = opts[:name] || 'Worksheet'
       @workbook = opts[:workbook]
@@ -39,6 +38,14 @@ module Spreadsheet
       @columns = []
       @links = {}
     end
+    def active # :nodoc:
+      warn "Worksheet#active is deprecated. Please use Worksheet#selected instead."
+      selected
+    end
+    def active= selected # :nodoc:
+      warn "Worksheet#active= is deprecated. Please use Worksheet#selected= instead."
+      self.selected = selected
+    end
     ##
     # Add a Format to the Workbook. If you use Row#set_format, you should not
     # need to use this Method.
@@ -134,6 +141,33 @@ module Spreadsheet
       res
     end
     ##
+    # Formats all Date, DateTime and Time cells with _format_ or the default
+    # formats:
+    # - 'DD.MM.YYYY' for Date
+    # - 'DD.MM.YYYY hh:mm:ss' for DateTime and Time
+    def format_dates! format=nil
+      each do |row|
+        row.each_with_index do |value, idx|
+          unless row.formats[idx] || row.format(idx).date_or_time?
+            numfmt = case value
+                     when DateTime, Time
+                       format || client('DD.MM.YYYY hh:mm:ss', 'UTF-8')
+                     when Date
+                       format || client('DD.MM.YYYY', 'UTF-8')
+                     end
+            case numfmt
+            when Format
+              row.set_format idx, numfmt
+            when String
+              fmt = row.format(idx).dup
+              fmt.number_format = numfmt
+              row.set_format idx, fmt
+            end
+          end
+        end
+      end
+    end
+    ##
     # Insert a Row at _idx_ (0-based) containing _cells_
     def insert_row idx, cells=[]
       res = @rows.insert idx, Row.new(self, idx, cells)
@@ -141,7 +175,6 @@ module Spreadsheet
       res
     end
     def inspect
-      "#<#{self.class}:#{object_id} "
       names = instance_variables
       names.delete '@rows'
       variables = names.collect do |name|
@@ -183,8 +216,6 @@ module Spreadsheet
     def row_updated idx, row
       @dimensions = nil
       @rows[idx] = row
-      format_dates row
-      row
     end
     ##
     # Updates the Row at _idx_ with the following arguments.
@@ -221,30 +252,6 @@ module Spreadsheet
       row(row)[column] = value
     end
     private
-    def format_dates row # :nodoc:
-      ## If no format is set in a cell which contains a Date or Time, we will
-      #  add a format. At the moment, the number formats correspond to builtin
-      #  Excel number-formats. We may need to add a level of abstraction if
-      #  additional writers are added to the library.
-      return unless row
-      row.each_with_index do |value, idx|
-        unless row.formats[idx]
-          format = nil
-          case value
-          when Date
-            format = @workbook.formats.find do |fmt| fmt.date? end
-            format ||= Format.new :number_format => client('M/D/YY', 'UTF-8')
-          when DateTime, Time
-            format = @workbook.formats.find do |fmt| fmt.datetime? end
-            format ||= Format.new :number_format => client('M/D/YY h:mm', 'UTF-8')
-          end
-          if format
-            row.formats[idx] = format
-            @workbook.add_format format
-          end
-        end
-      end
-    end
     def index_of_first ary # :nodoc:
       return unless ary
       ary.index(ary.find do |elm| elm end)

data/test/integration.rb

@@ -580,7 +580,7 @@ module Spreadsheet
       sheet = book.worksheet 0
       assert_equal 11, sheet.row_count
       assert_equal 12, sheet.column_count
-      useds = [0,0,0,0,0,0,0,1,0,0,11]
+      useds = [0,0,0,0,0,0,0,0,0,0,0]
       unuseds = [2,2,1,1,1,2,1,11,1,2,12]
       sheet.each do |row|
         assert_equal useds.shift, row.first_used
@@ -689,7 +689,7 @@ module Spreadsheet
       sheet = book.worksheet 0
       assert_equal 11, sheet.row_count
       assert_equal 12, sheet.column_count
-      useds = [0,0,0,0,0,0,0,1,0,0,11]
+      useds = [0,0,0,0,0,0,0,0,0,0,0]
       unuseds = [2,2,1,1,1,2,1,11,1,2,12]
       sheet.each do |row|
         assert_equal useds.shift, row.first_used
@@ -804,7 +804,7 @@ module Spreadsheet
       sheet1.row(6).set_format 0, fmt
       sheet1[6,1] = Date.new 2008, 10, 10
       sheet1[6,2] = Date.new 2008, 10, 12
-      fmt = Format.new :number_format => 'DD.MM.YYYY'
+      fmt = Format.new :number_format => 'D.M.YY'
       sheet1.row(6).set_format 1, fmt
       sheet1.update_row 7, nil, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0
       sheet1[8,0] = 0.0005
@@ -930,12 +930,12 @@ module Spreadsheet
       assert_equal 1, row[0]
       assert_equal 1, sheet[6,0]
       assert_equal 1, sheet.cell(6,0)
-      assert_equal @@iconv.iconv('DD.MM.YYYY'), row.format(1).number_format
+      assert_equal @@iconv.iconv('D.M.YY'), row.format(1).number_format
       date = Date.new 2008, 10, 10
       assert_equal date, row[1]
       assert_equal date, sheet[6,1]
       assert_equal date, sheet.cell(6,1)
-      assert_equal @@iconv.iconv('M/D/YY'), row.format(2).number_format
+      assert_equal @@iconv.iconv('DD.MM.YYYY'), row.format(2).number_format
       date = Date.new 2008, 10, 12
       assert_equal date, row[2]
       assert_equal date, sheet[6,2]
@@ -1092,7 +1092,7 @@ module Spreadsheet
       assert_equal date, row[1]
       assert_equal date, sheet[6,1]
       assert_equal date, sheet.cell(6,1)
-      assert_equal 'M/D/YY', row.format(2).number_format
+      assert_equal 'DD.MM.YYYY', row.format(2).number_format
       date = Date.new 2008, 10, 12
       assert_equal date, row[2]
       assert_equal date, sheet[6,2]
@@ -1145,13 +1145,13 @@ module Spreadsheet
         book = Spreadsheet.open path
       end
       assert_equal bignum, book.worksheet(0)[0,0]
-      assert_equal -bignum, book.worksheet(0)[1,0]
+      assert_equal(-bignum, book.worksheet(0)[1,0])
       assert_equal smallnum, book.worksheet(0)[0,1]
-      assert_equal -smallnum, book.worksheet(0)[1,1]
+      assert_equal(-smallnum, book.worksheet(0)[1,1])
       assert_equal bignum - 0.1, book.worksheet(0)[0,2]
-      assert_equal -bignum - 0.1, book.worksheet(0)[1,2]
+      assert_equal(-bignum - 0.1, book.worksheet(0)[1,2])
       assert_equal smallnum - 0.1, book.worksheet(0)[0,3]
-      assert_equal -smallnum - 0.1, book.worksheet(0)[1,3]
+      assert_equal(-smallnum - 0.1, book.worksheet(0)[1,3])
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spreadsheet
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
+  version: 0.6.3.1
 platform: ruby
 authors: 
 - Hannes Wyss
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-14 00:00:00 +01:00
+date: 2009-02-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 1.8.3
     version: 
 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: 
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: spreadsheet
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: The Spreadsheet Library is designed to read and write Spreadsheet Documents