spreadsheet 0.9.1 → 0.9.2

data/History.md

@@ -1,3 +1,18 @@
+### 0.9.2 / 11.11.2013
+
+commit e70dc0dbbc966ce312b45b0d44d0c3b1dc10aad6
+Author: Malcolm Blyth <trashbat@co.ck>
+Date:   Mon Nov 11 15:53:58 2013 +0000
+
+*Corrected compressed string formatting - *U (UTF-8) should have been *S (16-bit string)
+*Completed addition of notes hash to worksheet
+*Bumped revision
+*Updated reader and note
+Note class no longer extends string for simplicity and debug of class (pp now works a bit more easily)
+Reader has had loads of changes (still WIP) to allow objects of class
+Note and NoteObject to be created and combined in the postread_worksheet function
+*Adding noteObject to deal with the Object (and ultimately text comment field) created by excel's madness
+
 ### 0.9.1 / 24.10.2013
 
 * Author: Matti Lehtonen <matti.lehtonen@puujaa.com>

data/README.md

@@ -1,3 +1,6 @@
+Forked to continue comment extraction based on andrewinkelmann's fork
+
+
 Last Update: 31.05.2013 - Zeno R.R. Davatz
 
 # Spreadsheet

data/bin/xlsopcodes

@@ -1,16 +1,18 @@
 #!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'xlsopcodes' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'spreadsheet'
 
-require 'rubygems'
-require 'bundler/setup'
+source, target = ARGV
 
-load Gem.bin_path('spreadsheet', 'xlsopcodes')
+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 File.open(source)
+
+while tuple = reader.get_next_chunk
+end

data/lib/spreadsheet.rb

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

data/lib/spreadsheet/excel/internals.rb

@@ -380,6 +380,10 @@ module Internals
     :wsbool       => 0x0081, # ○  WSBOOL ➜ 6.113
     :defcolwidth  => 0x0055, # ○  DEFCOLWIDTH ➜ 6.29
     :sort         => 0x0090, # ○  SORT ➜ 6.95
+    :note         => 0x001c,                                                                                                      
+    :obj          => 0x005d,                                                                                                      
+    :drawing      => 0x00EC,                                                                                                      
+    :txo          => 0x01B6,
   }
 =begin ## unknown opcodes
 0x00bf, 0x00c0, 0x00c1, 0x00e1, 0x00e2, 0x00eb, 0x01af, 0x01bc

data/lib/spreadsheet/excel/reader.rb

@@ -2,6 +2,8 @@ require 'spreadsheet/encodings'
 require 'spreadsheet/font'
 require 'spreadsheet/formula'
 require 'spreadsheet/link'
+require 'spreadsheet/note'
+require 'spreadsheet/noteObject'
 require 'spreadsheet/excel/error'
 require 'spreadsheet/excel/internals'
 require 'spreadsheet/excel/sst_entry'
@@ -113,6 +115,17 @@ class Reader
     end
   end
   def postread_worksheet worksheet
+     #We now have a lot of Note and NoteObjects, but they're not linked
+     #So link the noteObject(text) to the note (with author, position)
+     #TODO
+     @noteList.each do |i|
+        matching_obj = @noteObjList.select {|j| j.objID == i.objID}
+        if matching_obj.length > 1
+           puts "ERROR - more than one matching object ID!"
+        end
+        i.text = matching_obj.first.text
+        worksheet.add_note i.row, i.col, i.text
+     end
   end
   ##
   # The entry-point for reading Excel-documents. Reads the Biff-Version and
@@ -830,6 +843,8 @@ class Reader
   def read_worksheet worksheet, offset
     @pos = offset
     @detected_rows = {}
+    @noteObjList = []
+    @noteList = []
     previous = nil
     while tuple = get_next_chunk
       pos, op, len, work = tuple
@@ -867,6 +882,42 @@ class Reader
         read_merged_cells worksheet, work, pos, len
       when :protect, :password
         read_sheet_protection worksheet, op, work
+      when :note # a note references an :obj
+        read_note worksheet, work, pos, len
+      when :obj # it contains the author in the NTS structure
+        _ft, _cb, _ot, _objID = work.unpack('v4')
+        if _ot == 0x19
+          #puts "\nDEBUG: found Note Obj record"
+          @noteObject         = NoteObject.new
+          @noteObject.objID   = _objID
+        end
+        #p work
+      when :drawing # this can be followed by txo in case of a note
+        if previous == :obj
+          #puts "\nDEBUG: found MsDrawing record"
+          #p work
+        end
+      when :txo # this contains the length of the note text
+        if previous == :drawing
+          #puts "\nDEBUG: found TxO record"
+          #p work
+        end
+      when :continue # this contains the actual note text
+        if previous == :txo
+          #puts "\nDEBUG: found Continue record"
+          continueFmt = work.unpack('C')
+          if (continueFmt.first == 0)
+             #puts "Picking compressed charset"
+             #Skip to offset due to 'v5C' used above
+             _text = work.unpack('@1C*')
+             @noteObject.text = _text.pack('C*')
+          elsif (continueFmt.first == 1)
+             #puts "Picking uncompressed charset"
+             _text = work.unpack('@1S*')
+             @noteObject.text = _text.pack('U*')
+          end
+          @noteObjList << @noteObject
+        end
       when :pagesetup
         read_pagesetup(worksheet, work, pos, len)
       when :leftmargin
@@ -882,7 +933,8 @@ class Reader
           set_missing_row_address worksheet, work, pos, len
         end
       end
-      previous = op
+      previous = op 
+      #previous = op unless op == :continue
     end
   end
 
@@ -1087,6 +1139,27 @@ class Reader
     fmt.pattern_bg_color = COLOR_CODES[(xf_pattern & 0x3f80) >> 7] || :pattern_bg
     @workbook.add_format fmt
   end
+  def read_note worksheet, work, pos, len
+    #puts "\nDEBUG: found a note record in read_worksheet\n"
+    row, col, _, _objID, _objAuthLen, _objAuthLenFmt = work.unpack('v5C')
+    if (_objAuthLenFmt == 0)
+       #puts "Picking compressed charset"
+       #Skip to offset due to 'v5C' used above
+       _objAuth = work.unpack('@11C*')
+    elsif (_objAuthLenFmt == 1)
+       #puts "Picking uncompressed charset"
+       _objAuth = work.unpack('@11S*')
+    end
+    _objAuth = _objAuth.pack('C*')
+    @note = Note.new
+    @note.length = len
+    @note.row    = row
+    @note.col    = col
+    @note.author = _objAuth
+    @note.objID  = _objID
+    #Pop it on the list to be sorted in postread_worksheet
+    @noteList << @note
+  end
   def read_sheet_protection worksheet, op, data
     case op
     when :protect

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

@@ -28,6 +28,18 @@ module Biff8
     end
     size + 1
   end
+  # When a String is too long for one Opcode, it is continued in a Continue
+  # Opcode. Excel may reconsider compressing the remainder of the string.
+  # This method appends the available remainder (decompressed if necessary) to
+  # the incomplete string.
+  def unpack_string work
+    opts, _ = work.unpack 'C'
+    wide = opts & 1
+    string = work[1, -1]
+    if wide == 0
+      string = wide string
+    end
+  end
   ##
   # When a String is too long for one Opcode, it is continued in a Continue
   # Opcode. Excel may reconsider compressing the remainder of the string.
@@ -125,8 +137,8 @@ module Biff8
   # the available data (unchanged).
   def read_string_body work, offset, available, wide
     data = work[offset, available]
-    string = wide ? data : wide(data)
-    [string, data]
+    widened_data = wide ? data : wide(data)
+    [widened_data, data]
   end
   ##
   # Read the header of a string. Returns the following information in an Array:

data/lib/spreadsheet/excel/worksheet.rb

@@ -11,7 +11,7 @@ module Spreadsheet
 class Worksheet < Spreadsheet::Worksheet
   include Spreadsheet::Excel::Offset
   offset :dimensions
-  attr_reader :offset, :ole, :links, :guts
+  attr_reader :offset, :ole, :links, :guts, :notes
   def initialize opts = {}
     @row_addresses = nil
     super
@@ -19,10 +19,14 @@ class Worksheet < Spreadsheet::Worksheet
     @dimensions = nil
     @links = {}
     @guts = {}
+    @notes = {}
   end
   def add_link row, column, link
     @links.store [row, column], link
   end
+  def add_note row, column, note
+    @notes.store [row, column], note
+  end
   def column idx
     ensure_rows_read
     super

data/spreadsheet.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
    s.name        = "spreadsheet"
-   s.version     = "0.8.9"
+   s.version     = "0.9.2"
    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/integration.rb

@@ -1280,6 +1280,13 @@ module Spreadsheet
       temp_file.unlink
     end
 
+    def test_andre
+      path = File.join @data, 'test_comment.xls'
+      book = Spreadsheet.open path
+      assert_instance_of Excel::Workbook, book
+      sheet = book.worksheet 0
+      sheet.ensure_rows_read
+    end
     def test_read_pagesetup
       path = File.join @data, 'test_pagesetup.xls'
       book = Spreadsheet.open path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-ole