spreadsheet 0.6.4.1 → 0.6.5.0

data/GUIDE.txt

@@ -168,6 +168,64 @@ a particular Cell, Spreadsheet will leave it untouched:
   row[6] = Time.new 2008, 10, 12
   # -> the Format of cell 6 is left unchanged.
 
+== Outline (Grouping) and Hiding
+Spreadsheet supports outline (grouping) and hiding functions from version 
+0.6.5. In order to hide rows or columns, you can use 'hidden' property. 
+As for outline, 'outline_level' property is also available. You can use 
+both 'hidden' and 'outline_level' at the same time.
+
+You can create a new file with outline and hiding rows and columns as
+follows:
+
+  require 'spreadsheet'
+  
+  # create a new book and sheet
+  book = Spreadsheet::Workbook.new
+  sheet = book.create_worksheet
+  5.times {|j| 5.times {|i| sheet[j,i] = (i+1)*10**j}}
+  
+  # column
+  sheet.column(2).hidden = true
+  sheet.column(3).hidden = true
+  sheet.column(2).outline_level = 1
+  sheet.column(3).outline_level = 1
+  
+  # row
+  sheet.row(2).hidden = true
+  sheet.row(3).hidden = true
+  sheet.row(2).outline_level = 1
+  sheet.row(3).outline_level = 1
+  
+  # save file
+  book.write 'out.xls'
+
+Also you can read an existing file and change the hidden and outline
+properties. Here is the example below:
+
+  require 'spreadsheet'
+  
+  # read an existing file
+  file = ARGV[0]
+  book = Spreadsheet.open(file, 'rb')
+  sheet= book.worksheet(0)
+  
+  # column
+  sheet.column(2).hidden = true
+  sheet.column(3).hidden = true
+  sheet.column(2).outline_level = 1
+  sheet.column(3).outline_level = 1
+  
+  # row
+  sheet.row(2).hidden = true
+  sheet.row(3).hidden = true
+  sheet.row(2).outline_level = 1
+  sheet.row(3).outline_level = 1
+  
+  # save file
+  book.write "out.xls"
+
+Notes
+  * The outline_level should be under 8, which is due to the Excel data format.
 
 == More about Encodings
 Spreadsheet assumes it's running on Ruby 1.8 with Iconv-support. It is your

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.6.5 / 07.12.2010
+
+* 2 Enhancements courtesy to ISS AG.
+
+  * Outlining (Grouping) of lines and columns is now possible. The outlining 
+    maximum is 8. This means you can do 8 subgroups in a group.
+
+  * Hiding and Unhiding of lines and columns is now possible. 
+
+  * Both of above two points is now possible by creating a new Excel File from 
+    scratch or editing an existing XLS and adding groups or hiding lines to it.
+
 === 0.6.4.1 / 2009-09-17
 
 * 3 Bugfixes

data/README.txt

@@ -1,14 +1,13 @@
-Last Update: 17.09.2009, 16.32 - hwyss
+Last Update: 08.12.2010 - Zeno Davatz
 
 
 = 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
+http://scm.ywesee.com/?p=spreadsheet/.git;a=summary
 
 For Non-GPLv3 commercial licencing, please see:
 
@@ -26,6 +25,7 @@ Hannes Wyss. Spreadsheet can read, write and modify Spreadsheet Documents.
 
 == What's new?
 
+* Supported outline (grouping) functions
 * Significantly improved memory-efficiency when reading large Excel Files
 * Limited Spreadsheet modification support
 * Improved handling of String Encodings
@@ -45,7 +45,6 @@ Hannes Wyss. Spreadsheet can read, write and modify Spreadsheet Documents.
 == Dependencies
 
 * ruby 1.8
-* Iconv
 * ruby-ole[http://code.google.com/p/ruby-ole/]
 
 
@@ -63,6 +62,13 @@ Using RubyGems[http://www.rubygems.org]:
 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.
 
+If you can use 'rake' and 'hoe' library is also installed, you can 
+build a gem package as follows:
+
+* rake gem 
+
+The gem package is built in pkg directory.
+
 
 == Authors
 
@@ -75,7 +81,7 @@ ParseExcel:
 Copyright (c) 2003 by Hannes Wyss (hannes.wyss@gmail.com)
 
 New Code:
-Copyright (c) 2008 by Hannes Wyss (hannes.wyss@gmail.com)
+Copyright (c) 2010 ywesee GmbH (mhatakeyama@ywesee.com, zdavatz@ywesee.com)
 
 
 == License

data/Rakefile

@@ -1,5 +1,7 @@
 # -*- ruby -*-
 
+$: << File.expand_path("./lib", File.dirname(__FILE__))
+
 require 'rubygems'
 require 'hoe'
 require './lib/spreadsheet.rb'
@@ -8,7 +10,7 @@ ENV['RDOCOPT'] = '-c utf8'
 
 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.developer('Masaomi Hatakeyama, Zeno R.R. Davatz','mhatakeyama@ywesee.com, zdavatz@ywesee.com')
    p.remote_rdoc_dir = ''
    p.extra_deps << 'ruby-ole'
 end

data/lib/spreadsheet.rb

@@ -1,6 +1,6 @@
 ### Spreadsheet - A Library for reading and writing Spreadsheet Documents.
 #
-#   Copyright (C) 2008  Hannes Wyss
+#   Copyright (C) 2008-2010 ywesee GmbH
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -17,9 +17,9 @@
 #
 #   Contact Information:
 #
-#     E-Mail: hannes.wyss@gmail.com
+#     E-Mail: mhatakeyama@ywesee.com, zdavatz@ywesee.com
 #     P-Mail: ywesee GmbH
-#             Hannes Wyss
+#             Zeno R.R. Davatz
 #             Winterthurerstrasse 52
 #             8006 Zürich
 ###           Switzerland
@@ -42,7 +42,7 @@ module Spreadsheet
 
   ##
   # The version of Spreadsheet you are using.
-  VERSION = '0.6.4.1'
+  VERSION = '0.6.5.0'
 
   ##
   # Default client Encoding. Change this value if your application uses a

data/lib/spreadsheet/excel/reader.rb

@@ -216,7 +216,7 @@ class Reader
                           :width         => width.to_f / 256,
                           :hidden        => (opts & 0x0001) > 0,
                           :collapsed     => (opts & 0x1000) > 0,
-                          :outline_level => (opts & 0x0700)
+                          :outline_level => (opts & 0x0700) / 256
       column.worksheet = worksheet
       worksheet.columns[col] = column
     end
@@ -830,6 +830,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 :guts       #    GUTS      5.53
+        read_guts worksheet, work, pos, len
       when :colinfo    # ○○ COLINFO ➜ 6.18
         read_colinfo worksheet, work, pos, len
       when :dimensions # ●  DIMENSIONS ➜ 6.31
@@ -849,6 +851,18 @@ class Reader
       previous = op
     end
   end
+  def read_guts worksheet, work, pos, len
+    # Offset Size Contents
+    #      0    2 Width of the area to display row outlines (left of the sheet), in pixel
+    #      2    2 Height of the area to display column outlines (above the sheet), in pixel
+    #      4    2 Number of visible row outline levels (used row levels + 1; or 0, if not used)
+    #      6    2 Number of visible column outline levels (used column levels + 1; or 0, if not used)
+    width, height, row_level, col_level = work.unpack 'v4'
+    worksheet.guts[:width] = width
+    worksheet.guts[:height] = height
+    worksheet.guts[:row_level] = row_level
+    worksheet.guts[:col_level] = col_level
+  end
   def read_style work, pos, len
     # User-Defined Cell Styles:
     # Offset  Size  Contents

data/lib/spreadsheet/excel/workbook.rb

@@ -1,7 +1,7 @@
 require 'spreadsheet/workbook'
 require 'spreadsheet/excel/offset'
 require 'spreadsheet/excel/writer'
-require 'ole/file_system'
+require 'ole/storage'
 
 module Spreadsheet
   module Excel

data/lib/spreadsheet/excel/worksheet.rb

@@ -11,13 +11,14 @@ module Spreadsheet
 class Worksheet < Spreadsheet::Worksheet
   include Spreadsheet::Excel::Offset
   offset :dimensions
-  attr_reader :offset, :ole, :links
+  attr_reader :offset, :ole, :links, :guts
   def initialize opts = {}
     @row_addresses = nil
     super
     @offset, @ole, @reader = opts[:offset], opts[:ole], opts[:reader]
     @dimensions = nil
     @links = {}
+    @guts = {}
   end
   def add_link row, column, link
     @links.store [row, column], link

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

@@ -3,7 +3,7 @@ require 'spreadsheet/writer'
 require 'spreadsheet/excel/writer/biff8'
 require 'spreadsheet/excel/writer/format'
 require 'spreadsheet/excel/writer/worksheet'
-require 'ole/file_system'
+require 'ole/storage'
 
 module Spreadsheet
   module Excel

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

@@ -240,6 +240,15 @@ class Worksheet
     write_multiples row, first_idx, multiples if multiples
   end
   def write_changes reader, endpos, sst_status
+
+    ## FIXME this is not smart solution to update outline_level.
+    #        without this process, outlines in row disappear in MS Excel.       
+    @worksheet.row_count.times do |i|
+      if @worksheet.row(i).outline_level > 0
+        @worksheet.row(i).outline_level = @worksheet.row(i).outline_level
+      end
+    end
+
     reader.seek @worksheet.offset
     blocks = row_blocks
     lastpos = reader.pos
@@ -296,6 +305,13 @@ and minimal code that generates this warning. Thanks!
       lastpos = pos + len
       reader.seek lastpos
     end
+
+    # Necessary for outline (grouping) and hiding functions 
+    # but these below are not necessary to run
+    # if [Row|Column]#hidden? = false and [Row|Column]#outline_level == 0
+    write_colinfos
+    write_guts
+
     @io.write reader.read(endpos - lastpos)
   end
   def write_colinfo bunch
@@ -448,6 +464,7 @@ and minimal code that generates this warning. Thanks!
     # ○  PRINTGRIDLINES ➜ 5.80
     # ○  GRIDSET ➜ 5.52
     # ○  GUTS ➜ 5.53
+    write_guts
     # ○  DEFAULTROWHEIGHT ➜ 5.31
     write_defaultrowheight
     # ○  WSBOOL ➜ 5.113
@@ -483,6 +500,28 @@ and minimal code that generates this warning. Thanks!
     # ●  EOF ➜ 5.36
     write_eof
   end
+  ##
+  # Write record that contains information about the layout of outline symbols.
+  def write_guts
+    # find the maximum outline_level in rows and columns
+    row_outline_level = 0
+    col_outline_level = 0
+    if(row = @worksheet.rows.select{|x| x!=nil}.max{|a,b| a.outline_level <=> b.outline_level})
+      row_outline_level = row.outline_level
+    end
+    if(col = @worksheet.columns.select{|x| x!=nil}.max{|a,b| a.outline_level <=> b.outline_level})
+      col_outline_level = col.outline_level
+    end
+    # set data
+    data = [
+      0,  # Width of the area to display row outlines (left of the sheet), in pixel
+      0,  # Height of the area to display column outlines (above the sheet), in pixel
+      row_outline_level+1, # Number of visible row outline levels (used row levels+1; or 0,if not used)
+      col_outline_level+1  # Number of visible column outline levels (used column levels+1; or 0,if not used)
+    ]
+    # write record
+    write_op opcode(:guts), data.pack('v4')
+  end
   def write_hlink row, col, link
     # FIXME: only Hyperlinks are supported at present.
     cell_range = [
@@ -793,6 +832,8 @@ and minimal code that generates this warning. Thanks!
     if @worksheet.selected
       flags |= 0x0200
     end
+    flags |= 0x0080 # Show outline symbols, 
+                    # but if [Row|Column]#outline_level = 0 the symbols are not shown.
     data = [ flags, 0, 0, 0, 0, 0 ].pack binfmt(:window2)
     write_op opcode(:window2), data
   end

data/lib/spreadsheet/font.rb

@@ -59,7 +59,8 @@ module Spreadsheet
     enum :encoding, :default, :iso_latin1, :symbol, :apple_roman, :shift_jis,
                     :korean_hangul, :korean_johab, :chinese_simplified,
                     :chinese_traditional, :greek, :turkish, :vietnamese,
-                    :hebrew, :arabic, :cyrillic, :thai, :iso_latin2, :oem_latin1
+                    :hebrew, :arabic, :baltic, :cyrillic, :thai, :iso_latin2,
+                    :oem_latin1
     def initialize name, opts={}
       self.name = name
       @color = :text

data/lib/spreadsheet/link.rb

@@ -30,7 +30,7 @@ module Spreadsheet
     def href
       href = (@url || @dos).to_s.dup
       if @fragment
-        href << client('#') << @fragment
+        href << client('#', 'UTF-8') << @fragment
       end
       href
     end

data/test/integration.rb

@@ -829,7 +829,7 @@ module Spreadsheet
       sheet1[5,0] = 0.75
       sheet1.row(5).set_format 0, fmt
       link = Link.new 'http://scm.ywesee.com/?p=spreadsheet;a=summary',
-                      'The Spreadsheet GitWeb'
+                      'The Spreadsheet GitWeb', 'top'
       sheet1[5,1] = link
       sheet1[6,0] = 1
       fmt = Format.new :color => 'green'
@@ -962,6 +962,7 @@ module Spreadsheet
       url = @@iconv.iconv 'http://scm.ywesee.com/?p=spreadsheet;a=summary'
       assert_equal @@iconv.iconv('The Spreadsheet GitWeb'), link
       assert_equal url, link.url
+      assert_equal @@iconv.iconv('top'), link.fragment
       row = sheet.row 6
       assert_equal :green, row.format(0).font.color
       assert_equal 1, row[0]
@@ -1270,5 +1271,11 @@ module Spreadsheet
       target = File.join @var, 'test_changes.xls'
       assert_nothing_raised do book.write target end
     end
+    def test_read_baltic
+      path = File.join @data, 'test_baltic.xls'
+      assert_nothing_raised do
+        Spreadsheet.open path
+      end
+    end
   end
 end

metadata

@@ -1,37 +1,54 @@
 --- !ruby/object:Gem::Specification 
 name: spreadsheet
 version: !ruby/object:Gem::Version 
-  version: 0.6.4.1
+  hash: 107
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 5
+  - 0
+  version: 0.6.5.0
 platform: ruby
 authors: 
-- Hannes Wyss
+- Masaomi Hatakeyama, Zeno R.R. Davatz
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 +02:00
+date: 2010-12-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-ole
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id002
 description: |-
   The Spreadsheet Library is designed to read and write Spreadsheet Documents.
   As of version 0.6.0, only Microsoft Excel compatible spreadsheets are
@@ -39,7 +56,7 @@ description: |-
   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
+- mhatakeyama@ywesee.com, zdavatz@ywesee.com
 executables: 
 - xlsopcodes
 extensions: []
@@ -121,21 +138,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: spreadsheet
-rubygems_version: 1.3.4
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: The Spreadsheet Library is designed to read and write Spreadsheet Documents