spreadsheet 0.6.5.9 → 0.6.7

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.6.7 / 18.01.2012
+
+* http://dev.ywesee.com/wiki.php/Gem/Spreadsheet points point 2.
+* Tests by Michal
+* Patches by Timon
+
+=== 0.6.6 / 18.01.2012
+
+* http://dev.ywesee.com/wiki.php/Gem/Spreadsheet points 8 and 9. 
+* Fixes byjsaak@napalm.hu
+* Patches by Vitaly Klimov
+
 === 0.6.5.9 / 7.9.2011
 
 * Fixed a frozen string bug thanks to dblock (Daniel Doubrovkine),

data/Manifest.txt

@@ -47,10 +47,12 @@ test/data/test_datetime.xls
 test/data/test_empty.xls
 test/data/test_formula.xls
 test/data/test_long_sst_record.xls
+test/data/test_merged_cells.xls
 test/data/test_missing_row.xls
 test/data/test_version_excel5.xls
 test/data/test_version_excel95.xls
 test/data/test_version_excel97.xls
+test/data/test_version_excel97_2010.xls
 test/excel/row.rb
 test/excel/writer/workbook.rb
 test/excel/writer/worksheet.rb

data/README.txt

@@ -1,4 +1,4 @@
-Last Update: 20.07.2011 - Zeno R.R. Davatz
+Last Update: 08.12.2011 - Zeno R.R. Davatz
 
 = Spreadsheet
 
@@ -33,6 +33,11 @@ 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.
 
+== Notes from Users
+
+Alfred: a@boxbot.org: I think it should be noted in the README file that the library doesn't
+recognize cell formats in Excel created documents, which results in
+Floats returned for any number.
 
 == What's new?
 
@@ -52,6 +57,10 @@ Hannes Wyss. Spreadsheet can read, write and modify Spreadsheet Documents.
 1.0.0:: Ruby 1.9 Support;
         Remove backward compatibility code
 
+Note: Spreadsheet supports Ruby 1.8.6, 1.8.7, 1.9.2, 1.9.3
+
+You will get a deprecated warning about iconv when using spreadsheet with Ruby
+1.9.3. So replacing iconv is on the Roadmap as well ;).
 
 == Dependencies
 

data/lib/spreadsheet.rb

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

data/lib/spreadsheet/datatypes.rb

@@ -18,7 +18,63 @@ class << self
              :chart_border, :tooltip_bg, :tooltip_text, :aqua,
              :black, :blue, :cyan, :brown, :fuchsia, :gray, :grey, :green,
              :lime, :magenta, :navy, :orange, :purple, :red, :silver, :white,
-             :yellow ]
+             :yellow,
+             :xls_color_0,
+             :xls_color_1,
+             :xls_color_2,
+             :xls_color_3,
+             :xls_color_4,
+             :xls_color_5,
+             :xls_color_6,
+             :xls_color_7,
+             :xls_color_8,
+             :xls_color_9,
+             :xls_color_10,
+             :xls_color_11,
+             :xls_color_12,
+             :xls_color_13,
+             :xls_color_14,
+             :xls_color_15,
+             :xls_color_16,
+             :xls_color_17,
+             :xls_color_18,
+             :xls_color_19,
+             :xls_color_20,
+             :xls_color_21,
+             :xls_color_22,
+             :xls_color_23,
+             :xls_color_24,
+             :xls_color_25,
+             :xls_color_26,
+             :xls_color_27,
+             :xls_color_28,
+             :xls_color_29,
+             :xls_color_30,
+             :xls_color_31,
+             :xls_color_32,
+             :xls_color_33,
+             :xls_color_34,
+             :xls_color_35,
+             :xls_color_36,
+             :xls_color_37,
+             :xls_color_38,
+             :xls_color_39,
+             :xls_color_40,
+             :xls_color_41,
+             :xls_color_42,
+             :xls_color_43,
+             :xls_color_44,
+             :xls_color_45,
+             :xls_color_46,
+             :xls_color_47,
+             :xls_color_48,
+             :xls_color_49,
+             :xls_color_50,
+             :xls_color_51,
+             :xls_color_52,
+             :xls_color_53,
+             :xls_color_54,
+             :xls_color_55 ]
   ##
   # Define instance methods to read and write boolean attributes.
   def boolean *args

data/lib/spreadsheet/excel/internals.rb

@@ -54,6 +54,8 @@ module Internals
     32769 => "WINDOWS-1252", #(Latin I) (BIFF2-BIFF3)
   }
   SEGAPEDOC = CODEPAGES.invert
+  # color_codes according to http://support.softartisans.com/kbview_1205.aspx
+  # synonyms are in comments when reverse lookup
   COLOR_CODES = {
     0x0000 => :builtin_black,
     0x0001 => :builtin_white,
@@ -63,21 +65,63 @@ module Internals
     0x0005 => :builtin_yellow,
     0x0006 => :builtin_magenta,
     0x0007 => :builtin_cyan,
-    0x0008 => :black,
-    0x0009 => :white,
-    0x000a => :red,
-    0x000b => :lime,
-    0x000c => :blue,
-    0x000d => :yellow,
-    0x000e => :magenta,
-    0x000f => :cyan,
-    0x0010 => :brown,
-    0x0011 => :green,
-    0x0012 => :navy,
-    0x0016 => :silver,
-    0x0017 => :gray,
-    0x0034 => :orange,
-    0x0024 => :purple,
+    0x0008 => :black,                 #xls_color_0
+    0x0009 => :white,                 #xls_color_1
+    0x000a => :red,                   #xls_color_2
+    0x000b => :lime,                  #xls_color_3
+    0x000c => :blue,                  #xls_color_4
+    0x000d => :yellow,                #xls_color_5
+    0x000e => :magenta,               #xls_color_6, fuchsia
+    0x000f => :cyan,                  #xls_color_7, aqua
+    0x0010 => :brown,                 #xls_color_8
+    0x0011 => :green,                 #xls_color_9
+    0x0012 => :navy,                  #xls_color_10
+    0x0013 => :xls_color_11,
+    0x0014 => :xls_color_12,
+    0x0015 => :xls_color_13,
+    0x0016 => :silver,                #xls_color_14
+    0x0017 => :gray,                  #xls_color_15, grey
+    0x0018 => :xls_color_16,
+    0x0019 => :xls_color_17,
+    0x001a => :xls_color_18,
+    0x001b => :xls_color_19,
+    0x001c => :xls_color_20,
+    0x001d => :xls_color_21,
+    0x001e => :xls_color_22,
+    0x001f => :xls_color_23,
+    0x0020 => :xls_color_24,
+    0x0021 => :xls_color_25,
+    0x0022 => :xls_color_26,
+    0x0023 => :xls_color_27,
+    0x0024 => :purple,                #xls_color_28
+    0x0025 => :xls_color_29,
+    0x0026 => :xls_color_30,
+    0x0027 => :xls_color_31,
+    0x0028 => :xls_color_32,
+    0x0029 => :xls_color_33,
+    0x002a => :xls_color_34,
+    0x002b => :xls_color_35,
+    0x002c => :xls_color_36,
+    0x002d => :xls_color_37,
+    0x002e => :xls_color_38,
+    0x002f => :xls_color_39,
+    0x0030 => :xls_color_40,
+    0x0031 => :xls_color_41,
+    0x0032 => :xls_color_42,
+    0x0033 => :xls_color_43,
+    0x0034 => :orange,                #xls_color_44
+    0x0035 => :xls_color_45,
+    0x0036 => :xls_color_46,
+    0x0037 => :xls_color_47,
+    0x0038 => :xls_color_48,
+    0x0039 => :xls_color_49,
+    0x003a => :xls_color_50,
+    0x003b => :xls_color_51,
+    0x003c => :xls_color_52,
+    0x003d => :xls_color_53,
+    0x003e => :xls_color_54,
+    0x003f => :xls_color_55,
+
     0x0040 => :border,
     0x0041 => :pattern_bg,
     0x0043 => :dialog_bg,
@@ -86,11 +130,30 @@ module Internals
     0x004f => :chart_border,
     0x0050 => :tooltip_bg,
     0x0051 => :tooltip_text,
-    0x7fff => :text,
+    0x7fff => :text
   }
-  SEDOC_ROLOC = COLOR_CODES.invert.update( :aqua    => 0x000f,
-                                           :fuchsia => 0x000e,
-                                           :grey    => 0x0017 )
+
+  SEDOC_ROLOC = COLOR_CODES.invert.update(
+    :xls_color_0  => 0x0008,
+    :xls_color_1  => 0x0009,
+    :xls_color_2  => 0x000a,
+    :xls_color_3  => 0x000b,
+    :xls_color_4  => 0x000c,
+    :xls_color_5  => 0x000d,
+    :xls_color_6  => 0x000e,
+    :fuchsia      => 0x000e,
+    :xls_color_7  => 0x000f,
+    :aqua         => 0x000f,
+    :xls_color_8  => 0x0010,
+    :xls_color_9  => 0x0011,
+    :xls_color_10 => 0x0012,
+    :xls_color_14 => 0x0016,
+    :xls_color_15 => 0x0017,
+    :grey         => 0x0017,
+    :xls_color_28 => 0x0024,
+    :xls_color_44 => 0x0034
+  )
+
   BINARY_FORMATS = {
     :blank      => 'v3',
     :boolerr    => 'v3C2',
@@ -216,6 +279,7 @@ module Internals
     :hlink        => 0x01b8, #    HLINK ➜ 6.52 (BIFF8 only)
     :label        => 0x0204, #    LABEL ➜ 6.59 (BIFF2-BIFF7)
     :labelsst     => 0x00fd, #    LABELSST ➜ 6.61 (BIFF8 only)
+    :mergedcells  => 0x00e5, # ○○ MERGEDCELLS	➜ 5.67 (BIFF8 only)
     :mulblank     => 0x00be, #    MULBLANK ➜ 6.64 (BIFF5-BIFF8)
     :mulrk        => 0x00bd, #    MULRK ➜ 6.65 (BIFF5-BIFF8)
     :number       => 0x0203, #    NUMBER ➜ 6.68

data/lib/spreadsheet/excel/reader.rb

@@ -761,6 +761,27 @@ class Reader
     flags, _ = work.unpack 'v'
     worksheet.selected = flags & 0x0200 > 0
   end
+
+  def read_merged_cells worksheet, work, pos, len
+    # This record contains the addresses of merged cell ranges in the current sheet.
+    # Record MERGEDCELLS, BIFF8:
+    # Offset  Size  Contents
+    # 0	      var.	Cell range address list with merged ranges (➜ 2.5.15)
+    # If the record size exceeds the limit, it is not continued with a CONTINUE record,
+    # but another self-contained MERGEDCELLS record is started. The limit of 8224 bytes
+    # per record results in a maximum number of 1027 merged ranges.
+
+    worksheet.merged_cells.push *read_range_address_list(work, len)
+    #
+    # A cell range address list consists of a field with the number of ranges and the list
+    # of the range addresses.
+    # Cell range address list, BIFF2-BIFF8:
+    # Offset  Size          Contents
+    # 0       2             Number of following cell range addresses (nm)
+    # 2	      6∙nm or 8∙nm  List of nm cell range addresses (➜ 2.5.14)
+    #
+  end
+
   def read_workbook
     worksheet = nil
     previous_op = nil
@@ -843,6 +864,8 @@ class Reader
         read_hlink worksheet, work, pos, len
       when :window2
         read_window2 worksheet, work, pos, len
+      when :mergedcells # ○○ MERGEDCELLS	➜ 5.67
+        read_merged_cells worksheet, work, pos, len
       else
         if ROW_BLOCK_OPS.include?(op)
           set_missing_row_address worksheet, work, pos, len

data/lib/spreadsheet/excel/reader/biff5.rb

@@ -16,6 +16,26 @@ module Biff5
     length, = work.unpack fmt
     work[count_length, length]
   end
+
+  def read_range_address_list work, len
+    # Cell range address, BIFF2-BIFF5:
+    # Offset  Size  Contents
+    # 0       2     Index to first row
+    # 2       2     Index to last row
+    # 4       1     Index to first column
+    # 5       1     Index to last column
+    #
+    offset = 0, results = []
+    return results if len < 2
+    count = work[0..1].unpack('v').first
+    offset = 2
+    count.times do |i|
+      results << work[offset...offset+6].unpack('v2c2')
+      offset += 6
+    end
+    results
+  end
+
 end
     end
   end

data/lib/spreadsheet/excel/reader/biff8.rb

@@ -161,6 +161,27 @@ module Biff8
     owing     = chars - have_chrs
     [chars, flagsize, wide, phonetic, richtext, avbl, owing, skip]
   end
+
+  def read_range_address_list work, len
+    # Cell range address, BIFF8:
+    # Offset  Size  Contents
+    # 0       2     Index to first row
+    # 2       2     Index to last row
+    # 4       2     Index to first column
+    # 6       2     Index to last column
+    # ! In several cases, BIFF8 still writes the BIFF2-BIFF5 format of a cell range address
+    # (using 8-bit values for the column indexes). This will be mentioned at the respective place.
+    #
+    offset = 0, results = []
+    return results if len < 2
+    count = work[0..1].unpack('v').first
+    offset = 2
+    count.times do |i|
+      results << work[offset...offset+8].unpack('v4')
+      offset += 8
+    end
+    results
+  end
   ##
   # Insert null-characters into a compressed UTF-16 string
   def wide string

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

@@ -488,6 +488,7 @@ and minimal code that generates this warning. Thanks!
     # ○○ SELECTION ➜ 5.93
     # ○  STANDARDWIDTH ➜ 5.101
     # ○○ MERGEDCELLS ➜ 5.67
+    write_merged_cells
     # ○  LABELRANGES ➜ 5.64
     # ○  PHONETIC ➜ 5.77
     # ○  Conditional Formatting Table ➜ 4.12
@@ -837,6 +838,20 @@ and minimal code that generates this warning. Thanks!
     data = [ flags, 0, 0, 0, 0, 0 ].pack binfmt(:window2)
     write_op opcode(:window2), data
   end
+
+  def write_merged_cells
+    return unless @worksheet.merged_cells.any?
+    # FIXME standards say the record is limited by 1027 records at once
+    # And no CONTINUE is supported
+
+    merge_cells = @worksheet.merged_cells.dup
+    while (window = merge_cells.slice!(0...1027)).any?
+      count = window.size
+      data = ([count] + window.flatten).pack('v2v*')
+      write_op opcode(:mergedcells), data
+    end
+  end
+
   def write_wsbool
     bits = [
          #   Bit  Mask    Contents

data/lib/spreadsheet/worksheet.rb

@@ -27,7 +27,7 @@ module Spreadsheet
     include Spreadsheet::Encodings
     include Enumerable
     attr_accessor :name, :selected, :workbook
-    attr_reader :rows, :columns
+    attr_reader :rows, :columns, :merged_cells
     def initialize opts={}
       @default_format = nil
       @selected = opts[:selected]
@@ -37,6 +37,7 @@ module Spreadsheet
       @rows = []
       @columns = []
       @links = {}
+      @merged_cells = []
     end
     def active # :nodoc:
       warn "Worksheet#active is deprecated. Please use Worksheet#selected instead."
@@ -251,6 +252,12 @@ module Spreadsheet
     def []= row, column, value
       row(row)[column] = value
     end
+    ##
+    # Merges multiple cells into one.
+    def merge_cells start_row, start_col, end_row, end_col
+      # FIXME enlarge or dup check
+      @merged_cells.push [start_row, end_row, start_col, end_col]
+    end
     private
     def index_of_first ary # :nodoc:
       return unless ary

data/spreadsheet.gemspec

@@ -3,7 +3,7 @@ require "rake"
 
 spec = Gem::Specification.new do |s|
    s.name        = "spreadsheet"
-   s.version     = "0.6.5.7"
+   s.version     = "0.6.7"
    s.summary     = "The Spreadsheet Library is designed to read and write Spreadsheet Documents"
    s.description = "As of version 0.6.0, only Microsoft Excel compatible spreadsheets are supported"
    s.author      = "Masaomi Hatakeyama, Zeno R.R. Davatz"

data/test/excel/writer/worksheet.rb

@@ -18,6 +18,22 @@ class TestWorksheet < Test::Unit::TestCase
     assert_equal true, sheet.need_number?(0.001)
     assert_equal true, sheet.need_number?(10000000.0)
   end
+  def test_write_merged_cells
+    # top/bottom/left/right cell of test range 1/2
+    r1t, r1b, r1l, r1r = 0, 0, 0, 1
+    r2t, r2b, r2l, r2r = 1, 2, 0, 0
+    book = Spreadsheet::Workbook.new
+    sheet = book.create_worksheet
+    sheet.merge_cells(r1t, r1l, r1b, r1r)
+    sheet.merge_cells(r2t, r2l, r2b, r2r)
+    assert_equal [[r1t, r1b, r1l, r1r], [r2t, r2b, r2l, r2r]], sheet.merged_cells
+    io = StringIO.new
+    book.write(io)
+    book2 = Spreadsheet.open(io)
+    sheet2 = book2.worksheet(0)
+    sheet2[0,0] # trigger read_worksheet
+    assert_equal [[r1t, r1b, r1l, r1r], [r2t, r2b, r2l, r2r]], sheet2.merged_cells
+  end
 end
     end
   end

data/test/integration.rb

@@ -67,6 +67,29 @@ module Spreadsheet
       assert_equal 0, sheet.column_count
       assert_nothing_raised do sheet.inspect end
     end
+    def test_version_excel97__excel2010__utf16
+      Spreadsheet.client_encoding = 'UTF-16LE'
+      assert_equal 'UTF-16LE', Spreadsheet.client_encoding
+      path = File.join @data, 'test_version_excel97_2010.xls'
+      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'),
+                   book.version_string
+      enc = 'UTF-16LE'
+      if defined? Encoding
+        enc = Encoding.find enc
+      end
+      assert_equal enc, book.encoding
+      sheet = book.worksheet 0
+      row = sheet.row 9
+      assert_equal 0.00009, row[0]
+      link = row[1]
+      assert_instance_of Link, link
+      assert_equal @@iconv.iconv('Link-Text'), link
+      assert_equal @@iconv.iconv('http://scm.ywesee.com/spreadsheet'), link.url
+      assert_equal @@iconv.iconv('http://scm.ywesee.com/spreadsheet'), link.href
+    end
     def test_version_excel97__ooffice__utf16
       Spreadsheet.client_encoding = 'UTF-16LE'
       assert_equal 'UTF-16LE', Spreadsheet.client_encoding
@@ -1307,5 +1330,13 @@ module Spreadsheet
         book.write path
       end
     end
+    def test_read_merged_cells
+      path = File.join(@data, 'test_merged_cells.xls')
+      book = Spreadsheet.open(path)
+      assert_equal 8, book.biff_version
+      sheet = book.worksheet(0)
+      sheet[0,0] # trigger read_worksheet
+      assert_equal [[2, 4, 1, 1], [3, 3, 2, 3]], sheet.merged_cells
+    end
   end
 end

data/test/suite.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# suite.rb -- spreadsheet -- 26.07.2011 -- zdavatz@ywesee.com
+# suite.rb -- spreadsheet -- 22.12.2011 -- jsaak@napalm.hu
 
 require 'find'
 
@@ -8,10 +8,8 @@ here = File.dirname(__FILE__)
 $: << here
 
 Find.find(here) do |file|
-	if /(?<!suite)\.rb$/o.match(file)
-    #from Roel van der Hoorn vanderhoorn@gmail.com
-    #should work for Ruby 1.8 and 1.9, without Oniguruma
-#  if /(?:^|\/)(?!suite)[^\/]+\.rb$/o
-    require file
-	end
+  next if File.basename(file) == 'suite.rb'
+  if file =~ /\.rb$/o
+    require file[here.size+1..-1]
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: spreadsheet
 version: !ruby/object:Gem::Version 
-  hash: 121
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 6
-  - 5
-  - 9
-  version: 0.6.5.9
+  - 7
+  version: 0.6.7
 platform: ruby
 authors: 
 - Masaomi Hatakeyama, Zeno R.R. Davatz
@@ -16,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-07 00:00:00 +02:00
-default_executable: 
+date: 2012-01-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-ole
@@ -35,21 +33,35 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rdoc
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 41
+        hash: 19
         segments: 
-        - 2
-        - 9
-        - 1
-        version: 2.9.1
+        - 3
+        - 10
+        version: "3.10"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id003
 description: |-
   The Spreadsheet Library is designed to read and write Spreadsheet Documents.
   As of version 0.6.0, only Microsoft Excel compatible spreadsheets are
@@ -118,10 +130,12 @@ files:
 - test/data/test_empty.xls
 - test/data/test_formula.xls
 - test/data/test_long_sst_record.xls
+- test/data/test_merged_cells.xls
 - test/data/test_missing_row.xls
 - test/data/test_version_excel5.xls
 - test/data/test_version_excel95.xls
 - test/data/test_version_excel97.xls
+- test/data/test_version_excel97_2010.xls
 - test/excel/row.rb
 - test/excel/writer/workbook.rb
 - test/excel/writer/worksheet.rb
@@ -132,7 +146,6 @@ files:
 - test/workbook.rb
 - test/worksheet.rb
 - .gemtest
-has_rdoc: true
 homepage: http://spreadsheet.rubyforge.org
 licenses: []
 
@@ -163,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: spreadsheet
-rubygems_version: 1.4.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: The Spreadsheet Library is designed to read and write Spreadsheet Documents