spreadsheet-excel 0.3.4 → 0.3.5

data/CHANGES

@@ -1,3 +1,14 @@
+== 0.3.5 - 18-Aug-2006
+* Instead of making OLEWriter inherit from IO, just have it delegate
+  the IO method calls to an IO object reference in an instance variable. That
+  way the developer can specify an IO or IO-like object to which OLEWriter will
+  write. This allows developers to use StringIO objects (or any IO-like object).
+  Thanks go to Daniel Amelang for the feature request, the patch, and most of
+  this description.
+* Implemented a Feature Request by Randal Santia: it is now possible to specify 
+  alignment and border as additional values in the configuration-hash passed to 
+  Format.new as if alignment= or border= were called.
+
 == 0.3.4 - 17-Feb-2006
 * Added a workaround for a bug in Ruby 1.8.3 and Ruby 1.8.4 where subclasses
   of IO are not guaranteed to call IO#close in block form.

data/CVS/Entries

@@ -1,10 +1,10 @@
 /.project/1.2/Tue Oct 11 14:08:38 2005//
-/CHANGES/1.14/Fri Feb 17 17:12:54 2006/-kb/
 /MANIFEST/1.10/Mon Dec  5 02:05:39 2005/-kb/
-/README/1.5/Tue Oct 11 17:06:12 2005/-kb/
 /install.rb/1.8/Mon Dec  5 02:13:14 2005/-ko/
-/spreadsheet-excel.gemspec/1.7/Fri Feb 17 03:44:27 2006/-kb/
 D/doc////
 D/examples////
 D/lib////
 D/test////
+/CHANGES/1.15/Fri Aug 18 13:42:05 2006/-kb/
+/README/1.6/Fri Aug 18 13:38:31 2006/-kb/
+/spreadsheet-excel.gemspec/1.8/Fri Aug 18 13:38:59 2006/-kb/

data/README

@@ -13,6 +13,9 @@
    ruby test/ts_all.rb (optional)
    ruby spreadsheet-excel.gemspec
    gem install spreadsheet-excel-x.y.z.gem # where 'x.y.z' is the version
+
+   or directly via RubyForge:
+   gem install spreadsheet-excel
    
 == Synopsis
    require "spreadsheet/excel"
@@ -67,3 +70,7 @@
    Daniel J. Berger
    djberg96 at gmail dot com
    IRC nickname: imperator/mok/rubyhacker1 (freenode)
+
+== Maintainer 
+   Hannes Wyss
+   hannes.wyss@gmail.com

data/lib/spreadsheet/CVS/Entries

@@ -1,7 +1,7 @@
 /biffwriter.rb/1.1/Tue Oct 11 17:09:08 2005//
 /excel.rb/1.4/Fri Feb 17 03:34:00 2006//
-/format.rb/1.1/Tue Oct 11 17:09:08 2005//
-/olewriter.rb/1.3/Mon Dec  5 02:03:48 2005//
-/workbook.rb/1.4/Sun Feb 12 16:42:10 2006//
 /worksheet.rb/1.2/Fri Feb 17 03:33:24 2006//
+/format.rb/1.2/Fri Aug 18 13:15:05 2006//
+/olewriter.rb/1.4/Fri Aug 18 13:20:26 2006//
+/workbook.rb/1.5/Fri Aug 18 13:20:13 2006//
 D

data/lib/spreadsheet/excel.rb

@@ -8,6 +8,6 @@ require "format"
 
 module Spreadsheet
    class Excel < Workbook
-      VERSION = "0.3.4"
+      VERSION = "0.3.5"
    end
-end
+end

data/lib/spreadsheet/format.rb

@@ -41,12 +41,16 @@ class Format
       defaults.update(:text_h_align   => 0, :num_format   => 0)
       defaults.update(:text_justlast  => 0, :text_wrap    => 0)
 
+      ## convenience methods
+      defaults.update(:border => 0, :align => 'left')
+
       ########################################################################
       # We must manually create accessors for these so that they can handle
       # both 0/1 and true/false.
       ########################################################################
       no_acc = [:bold,:italic,:underline,:strikeout,:text_wrap,:text_justlast]
       no_acc.push(:fg_color,:bg_color,:color,:font_outline,:font_shadow)
+      no_acc.push(:align,:border)
 
       args.each{|key,val|
          key = key.to_s.downcase.intern
@@ -304,19 +308,28 @@ class Format
       return if location.kind_of?(Fixnum)
       location.downcase!
 
-      @text_h_align = 1 if location == 'left'
-      @text_h_align = 2 if location == 'centre'
-      @text_h_align = 2 if location == 'center'
-      @text_h_align = 3 if location == 'right'
-      @text_h_align = 4 if location == 'fill'
-      @text_h_align = 5 if location == 'justify'
-      @text_h_align = 6 if location == 'merge'
-
-      @text_v_align = 0 if location == 'top'
-      @text_v_align = 1 if location == 'vcentre'
-      @text_v_align = 1 if location == 'vcenter'
-      @text_v_align = 2 if location == 'bottom'
-      @text_v_align = 3 if location == 'vjustify'
+      case location
+      when 'left'
+        @text_h_align = 1
+      when 'center', 'centre'
+        @text_h_align = 2
+      when 'right'
+        @text_h_align = 3
+      when 'fill'
+        @text_h_align = 4 
+      when 'justify'
+        @text_h_align = 5 
+      when 'merge'
+        @text_h_align = 6
+      when 'top'
+        @text_v_align = 0
+      when 'vcentre', 'vcenter'
+        @text_v_align = 1
+      when 'bottom'
+        @text_v_align = 2
+      when 'vjustify'
+        @text_v_align = 3
+      end
    end
 
    def align

data/lib/spreadsheet/olewriter.rb

@@ -5,7 +5,7 @@
 
 class MaxSizeError < StandardError; end
 
-class OLEWriter < IO
+class OLEWriter
 
    # Not meant for public consumption
    MaxSize    = 7087104
@@ -16,16 +16,14 @@ class OLEWriter < IO
    attr_reader :biff_size, :book_size, :big_blocks, :list_blocks
    attr_reader :root_start, :size_allowed
 
-   # Accept an IO object, a fileno, or a String
-   def initialize(arg, &block)
+   # Accept an IO or IO-like object or a filename (as a String)
+   def initialize(arg)
       if arg.kind_of?(String)
-         super(File.open(arg, "w+").fileno, "w+", &block)
-      elsif arg.respond_to?(:fileno)
-         super(arg.fileno, "w+", &block)
+        @io = File.open(arg, "w")
       else
-         super(arg, "w+", &block)
+        @io = arg
       end
-      binmode
+      @io.binmode
 
       @biff_only     = false
       @size_allowed  = true
@@ -37,6 +35,26 @@ class OLEWriter < IO
       @block_count   = 4
    end
 
+   # Imitate IO.open behavior
+   def self.open(arg)
+     if block_given?
+       ole = self.new(arg)
+       result = yield(ole)
+       ole.close
+       result
+     else
+       self.new(arg)
+     end
+   end
+
+   # Delegate 'write' and 'print' to the internal IO object.
+   def write(*args, &block)
+     @io.write(*args, &block)
+   end
+   def print(*args, &block)
+     @io.print(*args, &block)
+   end
+
    # Set the size of the data to be written to the OLE stream
    #
    # @big_blocks = (109 depot block x (128 -1 marker word)
@@ -71,7 +89,7 @@ class OLEWriter < IO
          write_property_storage
          write_big_block_depot
       end
-      super
+      @io.close
    end 
 
    # Write the OLE header block

data/lib/spreadsheet/olewriter.rb.orig

@@ -0,0 +1,196 @@
+# olewriter.rb
+#
+# This class should never be instantiated directly. The entire class, and all
+# its methods should be considered private.
+
+class MaxSizeError < StandardError; end
+
+class OLEWriter
+
+   # Not meant for public consumption
+   MaxSize    = 7087104
+   BlockSize  = 4096
+   BlockDiv   = 512
+   ListBlocks = 127
+
+   attr_reader :biff_size, :book_size, :big_blocks, :list_blocks
+   attr_reader :root_start, :size_allowed
+
+   # Accept an IO or IO-like object or a filename (as a String)
+   def initialize(arg)
+      if arg.kind_of?(String)
+        @io = File.open(arg, "w")
+      else
+        @io = arg
+      end
+      @io.binmode
+
+      @biff_only     = false
+      @size_allowed  = true
+      @biff_size     = 0
+      @book_size     = 0
+      @big_blocks    = 0
+      @list_blocks   = 0
+      @root_start    = 0
+      @block_count   = 4
+   end
+
+   # Imitate IO.open behavior
+   def self.open(arg)
+     if block_given?
+       ole = self.new(arg)
+       result = yield(ole)
+       ole.close
+       result
+     else
+       self.new(arg)
+     end
+   end
+
+   # Delegate 'write' and 'print' to the internal IO object.
+   def write(*args, &block)
+     @io.write(*args, &block)
+   end
+   def print(*args, &block)
+     @io.print(*args, &block)
+   end
+
+   # Set the size of the data to be written to the OLE stream
+   #
+   # @big_blocks = (109 depot block x (128 -1 marker word)
+   # - (1 x end words)) = 13842
+   #
+   # MaxSize = @big_blocks * 512 bytes = 7087104
+   def set_size(size = BlockSize)
+      raise MaxSizeError if size > MaxSize
+
+      @biff_size = size
+
+      if biff_size > BlockSize
+         @book_size = size
+      else
+         @book_size = BlockSize
+      end
+
+      @size_allowed = true
+   end
+
+   # Calculate various sizes needed for the OLE stream
+   def calculate_sizes
+      @big_blocks  = (@book_size.to_f/BlockDiv.to_f).ceil
+      @list_blocks = (@big_blocks / ListBlocks) + 1
+      @root_start  = @big_blocks
+   end
+
+   # Write root entry, big block list and close the filehandle.
+   def close
+      if @size_allowed == true
+         write_padding
+         write_property_storage
+         write_big_block_depot
+      end
+      @io.close
+   end 
+
+   # Write the OLE header block
+   def write_header
+      return if @biff_only == true
+      calculate_sizes
+      root_start = @root_start
+
+      write([0xD0CF11E0, 0xA1B11AE1].pack("NN"))
+      write([0x00, 0x00, 0x00, 0x00].pack("VVVV"))
+      write([0x3E, 0x03, -2, 0x09].pack("vvvv"))
+      write([0x06, 0x00, 0x00].pack("VVV"))
+      write([@list_blocks, root_start].pack("VV"))
+      write([0x00, 0x1000,-2].pack("VVV"))
+      write([0x00, -2 ,0x00].pack("VVV"))
+
+      unused = [-1].pack("V")
+
+      1.upto(@list_blocks){
+         root_start += 1
+         write([root_start].pack("V"))
+      }
+
+      @list_blocks.upto(108){
+         write(unused)
+      }
+   end
+
+   # Write a big block depot
+   def write_big_block_depot
+      total_blocks = @list_blocks * 128
+      used_blocks  = @big_blocks + @list_blocks + 2
+      
+      marker = [-3].pack("V")
+      eoc    = [-2].pack("V")
+      unused = [-1].pack("V")
+
+      num_blocks = @big_blocks - 1
+
+      1.upto(num_blocks){|n|
+         write([n].pack("V"))
+      }
+
+      write eoc
+      write eoc
+
+      1.upto(@list_blocks){ write(marker) }
+
+      used_blocks.upto(total_blocks){ write(unused) }
+      
+   end
+
+   # Write property storage
+   def write_property_storage
+      write_pps('Root Entry', 0x05,  1,   -2, 0x00)
+      write_pps('Book',       0x02, -1, 0x00, @book_size)
+      write_pps("",           0x00, -1, 0x00, 0x0000)
+      write_pps("",           0x00, -1, 0x00, 0x0000)
+   end
+
+   # Write property sheet in property storage
+   def write_pps(name, type, dir, start, size)
+      length = 0
+      ord_name = []
+      unless name.empty? 
+         name += "\0"
+         ord_name = name.unpack("c*")
+         length = name.length * 2
+      end
+
+      zero = [0].pack("C")
+      unknown = [0].pack("V")
+      
+      write(ord_name.pack("v*"))
+
+      for n in 1..64-length
+         write(zero)
+      end
+
+      write([length,type,-1,-1,dir].pack("vvVVV"))
+
+      for n in 1..5
+         write(unknown)
+      end
+      
+      for n in 1..4
+         write([0].pack("V"))
+      end
+
+      write([start,size].pack("VV"))
+      write(unknown)
+   end
+
+   # Pad the end of the file
+   def write_padding
+      min_size = 512
+      min_size = BlockSize if @biff_size < BlockSize
+
+      if @biff_size % min_size != 0
+         padding = min_size - (@biff_size % min_size)
+         write("\0" * padding)
+      end
+   end
+end

data/lib/spreadsheet/olewriter.rb.rej

@@ -0,0 +1,32 @@
+***************
+*** 83,97 ****
+     end
+  
+     # Write root entry, big block list and close the filehandle.
+     def close
+-       return if @io.closed?
+        if @size_allowed == true
+           write_padding
+           write_property_storage
+           write_big_block_depot
+        end
+-       @io.close
+     end 
+  
+     # Write the OLE header block
+     def write_header
+--- 65,78 ----
+     end
+  
+     # Write root entry, big block list and close the filehandle.
+     def close
+        if @size_allowed == true
+           write_padding
+           write_property_storage
+           write_big_block_depot
+        end
++       super
+     end 
+  
+     # Write the OLE header block
+     def write_header

data/lib/spreadsheet/workbook.rb

@@ -102,7 +102,6 @@ class Workbook < BIFFWriter
          @worksheets.each{ |sheet|
             ole.print(sheet.data)
          }
-         ole.close # Added because of bug introduced in Ruby 1.8.3   
       }
    end
 

data/lib/spreadsheet/worksheet.rb

@@ -6,6 +6,7 @@ class Worksheet < BIFFWriter
    ColMax = 256
    StrMax = 255
    Buffer = 4096
+   ContMax = 2080
 
    attr_reader :name, :xf_index
    attr_accessor :index, :colinfo, :selection, :offset
@@ -272,12 +273,9 @@ class Worksheet < BIFFWriter
 
    def write_string(row, col, str, format)
       record = 0x0204
-      length = 0x0008 + str.length
 
       xf_index = XF(row, col, format)
 
-      strlen = str.length
-
       raise MaxSizeError if row >= RowMax
       raise MaxSizeError if col >= ColMax
 
@@ -286,17 +284,20 @@ class Worksheet < BIFFWriter
       @dim_colmin = col if col < @dim_colmin
       @dim_colmax = col if col > @dim_colmax
 
-      # Truncate strings over 255 characters
-      if strlen > StrMax
-         str    = str[0..StrMax-1]
-         length = 0x0008 + StrMax
-         strlen = StrMax
-      end
-
+      strlen = str.size
+      pstr = str.slice!(0,StrMax)
+      length = 0x0008 + pstr.size
       header = [record, length].pack("vv")
       data   = [row, col, xf_index, strlen].pack("vvvv")
+      append(header, data, pstr)
+
+      record = 0x003C
+      until(str.empty?)
+        pstr = str.slice!(0,ContMax)
+        header = [record, pstr.size].pack("vv")
+        append(header, pstr)
+      end
 
-      append(header, data, str)
    end
 
    # Write a blank cell to the specified row and column (zero indexed).

data/test/CVS/Entries

@@ -1,9 +1,9 @@
 /tc_all.rb/1.1/Sun Nov 23 03:46:55 2003//
 /tc_biff.rb/1.3/Wed Oct 12 21:33:36 2005//
 /tc_excel.rb/1.7/Fri Feb 17 03:36:41 2006//
-/tc_format.rb/1.4/Wed Oct 12 21:34:22 2005//
 /tc_ole.rb/1.4/Wed Oct 12 21:33:05 2005//
-/tc_workbook.rb/1.2/Wed Oct 12 21:34:46 2005//
 /tc_worksheet.rb/1.3/Wed Oct 12 21:35:11 2005//
 /ts_all.rb/1.2/Wed Oct 12 21:35:30 2005//
 D/perl_output////
+/tc_format.rb/1.5/Fri Aug 18 13:15:13 2006//
+/tc_workbook.rb/1.3/Fri Aug 18 13:05:40 2006//

data/test/tc_excel.rb

@@ -21,6 +21,6 @@ require "ftools"
 
 class TC_Excel < Test::Unit::TestCase
    def test_version
-      assert_equal("0.3.4", Spreadsheet::Excel::VERSION)
+      assert_equal("0.3.5", Spreadsheet::Excel::VERSION)
    end
 end

data/test/tc_format.rb

@@ -120,6 +120,14 @@ class TC_Format < Test::Unit::TestCase
       assert_equal(true,@format.bold,"Bad bold value")
    end
 
+   def test_initialize
+     assert_nothing_raised {
+       Format.new(:bold => true, :size => 10, :color => 'black', 
+                  :fg_color => 43, :align => 'top', :text_wrap => true,
+                  :border => 1)
+     }
+   end
+
    def teardown
       begin
          @pfh.close

data/test/tc_workbook.rb

@@ -60,12 +60,27 @@ class TC_Workbook < Test::Unit::TestCase
    def test_add_format
       assert_nothing_raised{ @wb.add_format }
       assert_equal(2,@wb.formats.length,"Bad number of formats")
+      assert_nothing_raised{ 
+        @wb.add_format(:bold => true, :size => 10, :color => 'black',
+                       :fg_color => 43, :align => 'top', :text_wrap => true,
+                       :border => 1)
+      }
+      assert_equal(3,@wb.formats.length,"Bad number of formats")
+   end
+
+   def test_write_string_continued
+      ws = @wb.add_worksheet 
+      txt = ''
+      0.upto(256) { |num|
+        txt << "." << num.to_s
+      }
+      ws.write(0,0,txt)
    end
 
    def teardown
       @wb.close
       @wb = nil
-      File.delete("test.xls") if File.exists?("test.xls")
+      #File.delete("test.xls") if File.exists?("test.xls")
    end
 
 end

metadata

@@ -3,12 +3,12 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: spreadsheet-excel
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
-date: 2006-06-06 00:00:00 +02:00
+  version: 0.3.5
+date: 2006-08-23 00:00:00 +02:00
 summary: Creates Excel documents on any platform
 require_paths: 
 - lib
-email: djberg96@gmail.com
+email: hannes.wyss@gmail.com
 homepage: http://rubyspreadsheet.sf.net
 rubyforge_project: 
 description: Creates Excel documents on any platform
@@ -26,7 +26,7 @@ platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-- Daniel Berger
+- Hannes Wyss
 files: 
 - CVS/Root
 - CVS/Repository
@@ -50,24 +50,29 @@ files:
 - lib/CVS/Entries
 - lib/spreadsheet/CVS
 - lib/spreadsheet/biffwriter.rb
-- lib/spreadsheet/excel.rb
+- lib/spreadsheet/worksheet.rb
 - lib/spreadsheet/format.rb
-- lib/spreadsheet/olewriter.rb
+- lib/spreadsheet/olewriter.rb.orig
+- lib/spreadsheet/olewriter.rb.rej
 - lib/spreadsheet/workbook.rb
-- lib/spreadsheet/worksheet.rb
+- lib/spreadsheet/olewriter.rb
+- lib/spreadsheet/excel.rb
 - lib/spreadsheet/CVS/Root
 - lib/spreadsheet/CVS/Repository
 - lib/spreadsheet/CVS/Entries
 - test/CVS
 - test/tc_all.rb
 - test/tc_biff.rb
-- test/tc_excel.rb
-- test/tc_format.rb
 - test/tc_ole.rb
-- test/tc_workbook.rb
-- test/tc_worksheet.rb
 - test/ts_all.rb
 - test/perl_output
+- test/foo.ole
+- test/tc_format.rb
+- test/delete_this
+- test/test.xls
+- test/tc_workbook.rb
+- test/tc_worksheet.rb
+- test/tc_excel.rb
 - test/CVS/Root
 - test/CVS/Repository
 - test/CVS/Entries