parseexcel 0.5.1

data/lib/parseexcel/workbook.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+#
+#	Spreadsheet::ParseExcel -- Extract Data from an Excel File
+#	Copyright (C) 2003 ywesee -- intellectual capital connected
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#	ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Z�rich, Switzerland
+#	hwyss@ywesee.com
+#
+# Workbook -- Spreadsheet::ParseExcel -- 10.06.2003 -- hwyss@ywesee.com 
+
+require 'parseexcel/worksheet'
+
+module Spreadsheet
+	module ParseExcel
+		class Annotation < String
+			attr_accessor :author
+		end
+		class Workbook
+			attr_accessor :biffversion, :version, :flg_1904
+			attr_writer :format
+			def initialize
+				@worksheets = []
+				@pkg_strs = []
+				@annotations = []
+				@formats = []
+			end
+			def add_annotation(pkg_str)
+				@annotations.push(pkg_str)
+			end
+			def add_text_format(idx, fmt_str)
+				@format.add_text_format(idx, fmt_str)
+			end
+			def add_cell_format(format)
+				@formats.push(format)
+			end
+			def add_pkg_str(pkg_str)
+				@pkg_strs.push(pkg_str)
+			end
+			def annotation(idx)
+				@annotations.at(idx)
+			end
+			def format(idx=nil)
+				(idx.nil?) ? @format : @formats.at(idx)
+			end
+			def pkg_str(idx)
+				@pkg_strs.at(idx)
+			end
+			def sheet_count
+				@worksheets.size
+			end
+			def worksheet(idx)
+				@worksheets[idx] ||= Worksheet.new
+			end
+		end
+	end
+end

data/lib/parseexcel/worksheet.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+#
+#	Spreadsheet::ParseExcel -- Extract Data from an Excel File
+#	Copyright (C) 2003 ywesee -- intellectual capital connected
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#	ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Z�rich, Switzerland
+#	hwyss@ywesee.com
+#
+# Worksheet -- Spreadsheet::ParseExcel -- 10.06.2003 -- hwyss@ywesee.com 
+
+require 'parseexcel/olestorage'
+require 'iconv'
+
+module Spreadsheet
+	module ParseExcel
+		class Worksheet
+			include Enumerable
+			attr_accessor :default_row_height, :resolution, :v_resolution, :paper,
+				:scale, :page_start, :fit_width, :fit_height, :header_margin,
+				:footer_margin, :copies, :left_to_right, :no_pls, :no_color, :draft,
+				:notes, :no_orient, :use_page, :landscape, :sheet_version, :sheet_type,
+				:header, :footer, :page_fit
+			class Cell
+				attr_accessor :value, :kind, :numeric, :code, :book, :format_no,
+					:format, :rich, :encoding, :annotation
+				def initialize(params={:value=>'',:kind=>:blank,:numeric=>false})
+					@encoding = 'UTF-16LE'
+					params.each { |key, val|
+						mthd = key.to_s + '='
+						if(self.respond_to?(mthd))
+							self.send(mthd, val)
+						end
+					}
+				end
+				def date
+					datetime.date
+				end
+				def datetime
+					date = @value.to_i
+					time = @value.to_f - date
+					#1. Calc Days
+					year = 1900
+					if (@book.flg_1904)
+						year = 1904
+						date += 1 #Start from Jan 1st
+					end
+					ydays = year_days(year)
+					while (date > ydays)
+						date -= ydays
+						year += 1
+						ydays = year_days(year)
+					end
+					month = 1
+					1.upto(12) { |month|
+						mdays = month_days(month, year)
+						break if(date <= mdays)
+						date -= mdays
+					}
+					#2. Calc Time
+					day = date
+					time += (0.0005 / 86400.0)
+					time *= 24.0
+					hour = time.to_i
+					time -= hour
+					time *= 60.0
+					min = time.to_i
+					time -= min
+					time *= 60.0
+					sec = time.to_i
+					time -= sec
+					time *= 1000.0
+					msec = time.to_i
+					OLE::DateTime.new(year,month,day,hour,min,sec,msec)
+				end
+				def to_i
+					@value.to_i
+				end
+				def to_f
+					@value.to_f
+				end
+				def to_s(target_encoding=nil)
+					if(target_encoding)
+						Iconv.new(target_encoding, @encoding).iconv(@value.to_s)
+					else
+						@value.to_s
+					end
+				end
+				def type 
+					@format.cell_type(self) if @format
+				end
+				private
+				def month_days(month, year)
+					if(year == 1900 && month == 2)
+						29
+					else
+						OLE::DateTime::month_days(month, year)
+					end
+				end
+				def year_days(year)
+					(year == 1900) ? 366 : OLE::DateTime::year_days(year)
+				end
+			end
+			class PkgString
+				attr_reader :text, :unicode, :rich, :ext
+				def initialize(text, unicode, rich, ext)
+					@text, @unicode, @rich, @ext = text, unicode, rich, ext
+				end
+			end
+			def initialize
+				@cells = []
+				@row_heights = []
+			end
+			def add_cell(row, col, cell)
+				(@cells[row] ||= [])[col] ||= cell
+				self.set_dimensions(row, col)
+				@cells[row][col]
+			end
+			def cell(row, col)
+				(@cells[row] ||= [])[col] ||= Cell.new
+			end
+			def each(skip=0, &block)
+				@cells[skip..-1].each(&block)
+			end
+			def row(row)
+				@cells[row] ||= []
+			end
+			def set_dimensions(row, scol, ecol=scol)
+				@min_row = [row, @min_row || row].min
+				@max_row = [row, @max_row || row].max
+				@min_col = [scol, @min_col || scol].min
+				@max_col = [ecol, @max_col || ecol].max
+			end
+			def set_row_height(row, height)
+				@row_heights[row] = height
+			end
+		end
+	end
+end

data/test/suite.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# TestSuite -- spreadsheet -- 02.06.2003 -- hwyss@ywesee.com 
+
+$: << File.expand_path(File.dirname(__FILE__))
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+
+Dir.foreach(File.dirname(__FILE__)) { |file|
+	require file if /^test_.*\.rb$/o.match(file)
+}

data/test/test_format.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+#
+#	Spreadsheet::ParseExcel -- Extract Data from an Excel File
+#	Copyright (C) 2003 ywesee -- intellectual capital connected
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#	ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Z�rich, Switzerland
+#	hwyss@ywesee.com
+#
+# TestFormat -- Spreadsheet::ParseExcel -- 10.06.2003 -- hwyss@ywesee.com 
+
+$: << File.expand_path("../lib", File.dirname(__FILE__))
+
+require 'test/unit'
+require 'parseexcel/format'
+
+module Spreadsheet
+	module ParseExcel
+		class Format
+			attr_writer :index
+		end
+	end
+end
+class StubFormatCell
+	attr_accessor :numeric	
+end
+
+class TestFormat < Test::Unit::TestCase
+	def setup
+		@format = Spreadsheet::ParseExcel::Format.new
+	end
+	def test_cell_type
+		cell = StubFormatCell.new
+		assert_equal(:text, @format.cell_type(cell))
+		cell.numeric = true
+		assert_equal(:numeric, @format.cell_type(cell))
+		@format.fmt_idx = 0x12
+		assert_equal(:date, @format.cell_type(cell))
+		@format.fmt_idx = 0
+		assert_equal(:numeric, @format.cell_type(cell))
+		@format.add_text_format(0x46, 'General')
+		@format.fmt_idx = 0x46
+		assert_equal(:numeric, @format.cell_type(cell))
+	end
+	def test_text_format
+		assert_equal('foo', @format.text_format('foo'))
+		assert_equal('foo', @format.text_format('foo', :_native_))
+		assert_equal('foo', @format.text_format("\x00f\x00o\x00o", :ucs2))
+	end
+end

data/test/test_olestorage.rb

@@ -0,0 +1,175 @@
+#!/usr/bin/env ruby
+#
+#	Spreadsheet::ParseExcel -- Extract Data from an Excel File
+#	Copyright (C) 2003 ywesee -- intellectual capital connected
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#	ywesee - intellectual capital connected, Winterthurerstrasse 52, CH-8006 Z�rich, Switzerland
+#	hwyss@ywesee.com
+#
+# TestOLEReader -- Spreadsheet::ParseExcel -- 05.06.2003 -- hwyss@ywesee.com 
+
+$: << File.expand_path("../lib", File.dirname(__FILE__))
+
+require 'test/unit'
+require 'parseexcel/olestorage'
+
+module OLE
+class Storage < File
+	public :get_header 
+	class Header 
+		attr_writer :bbd_info
+	end
+end
+end
+
+class TestOLEStorageClass < Test::Unit::TestCase
+	def test_is_normal_block
+		assert(OLE::Storage.is_normal_block?(0))
+		assert(OLE::Storage.is_normal_block?(0xFF))
+		assert(!OLE::Storage.is_normal_block?(0xFFFFFFFC))
+	end
+	def test_invalid_header
+		filename = File.expand_path('data/nil.xls', File.dirname(__FILE__))
+		file = File.open(filename)
+		assert_raises(OLE::UnknownFormatError) {
+			h = OLE::Storage::Header.new(file)
+		}
+		file.close
+	end
+	def test_asc2ucs
+		expected = "W\000o\000r\000k\000b\000o\000o\000k\000"
+		assert_equal(expected, OLE.asc2ucs('Workbook'))
+		expected = "R\000o\000o\000t\000 \000E\000n\000t\000r\000y\000"
+		assert_equal(expected, OLE.asc2ucs('Root Entry'))
+	end
+end
+class TestOLEDateTime < Test::Unit::TestCase
+	def test_year_days
+		assert_equal(perl_year_days(2000), OLE::DateTime.year_days(2000))
+		assert_equal(perl_year_days(1999), OLE::DateTime.year_days(1999))
+		assert_equal(perl_year_days(1900), OLE::DateTime.year_days(1900))
+		assert_equal(perl_year_days(1980), OLE::DateTime.year_days(1980))
+		assert_equal(366, OLE::DateTime.year_days(2000))
+		assert_equal(365, OLE::DateTime.year_days(1999))
+		assert_equal(365, OLE::DateTime.year_days(1900))
+		assert_equal(366, OLE::DateTime.year_days(1980))
+	end
+	def test_month_days
+		assert_equal(31, OLE::DateTime.month_days(8,1975))
+		assert_equal(30, OLE::DateTime.month_days(6,2003))
+		assert_equal(29, OLE::DateTime.month_days(2,2000))
+		assert_equal(29, OLE::DateTime.month_days(2,1980))
+		assert_equal(28, OLE::DateTime.month_days(2,1900))
+	end
+	def test_parse
+		# how?
+	end
+	def test_date
+		datetime = OLE::DateTime.new(2002,4,19)
+		assert_equal(Date.new(2002, 4, 19), datetime.date)
+	end
+
+	# helper methods
+	def perl_year_days(year)
+		perl_leap_year?(year) ? 366 : 365
+	end
+	def perl_leap_year?(iYear)
+		(((iYear % 4)==0) && ((iYear % 100).nonzero? || (iYear % 400)==0))
+	end
+end
+class TestOLEStorage < Test::Unit::TestCase
+	def setup
+		@datadir = File.expand_path('data', File.dirname(__FILE__))
+		@filename = File.expand_path('foo.xls', @datadir)
+		@ole = OLE::Storage.new(@filename)
+	end
+	def test_get_header
+		header = @ole.get_header
+		assert_equal(1, header.bdb_count) 
+		assert_equal(512, header.big_block_size) 
+		assert_equal(0, header.extra_bbd_count) 
+		assert_equal(4294967294, header.extra_bbd_start) 
+		assert_equal(11, header.root_start)
+		assert_equal(1, header.sbd_count) 
+		assert_equal(2, header.sbd_start) 
+		assert_equal(64, header.small_block_size) 
+	end
+	def test_search_pps
+		expected = [
+			@ole.header.get_nth_pps(0),
+			@ole.header.get_nth_pps(1),
+		]
+		result = @ole.search_pps([
+			OLE.asc2ucs('Root Entry'), 
+			OLE.asc2ucs('Workbook'),
+		])
+		assert_equal(expected, result)
+		lowercase = [
+			OLE.asc2ucs('root entry'), 
+			OLE.asc2ucs('workbook'),
+		]
+		assert_equal([], @ole.search_pps(lowercase))
+		result = @ole.search_pps(lowercase, true)
+		assert_equal(expected, result)
+	end
+end
+class TestOLEStorageHeader < Test::Unit::TestCase
+	def setup
+		@filename = File.expand_path('data/foo.xls', File.dirname(__FILE__))
+		@file = OLE::Storage.new(@filename)
+		@header = @file.get_header
+	end
+	def test_get_next_block_no
+		@header.bbd_info = {
+			1	=>	2,
+			3	=>	5,
+		}
+		assert_equal(2, @header.get_next_block_no(1))
+		assert_equal(3, @header.get_next_block_no(2))
+		assert_equal(5, @header.get_next_block_no(3))
+	end
+	def test_get_nth_block_no
+		@header.bbd_info = {
+			1	=>	2,
+			3	=>	5,
+		}
+		assert_equal(2, @header.get_nth_block_no(1,1))
+		assert_equal(3, @header.get_nth_block_no(1,2))
+		assert_equal(5, @header.get_nth_block_no(1,3))
+		assert_equal(3, @header.get_nth_block_no(2,1))
+		assert_equal(5, @header.get_nth_block_no(2,2))
+		assert_equal(5, @header.get_nth_block_no(3,1))
+	end
+	def test_get_nth_pps
+		root = @header.get_nth_pps(0)
+		assert_instance_of(OLE::Storage::PPS::Root, root)
+		file = @header.get_nth_pps(1)
+		assert_instance_of(OLE::Storage::PPS::File, file)
+		assert_equal(1, root.dir_pps)
+		min_1, = [-1].pack('V').unpack('V')
+		assert_equal(min_1, root.next_pps)
+		assert_equal(min_1, root.prev_pps)
+		assert_equal(3904, root.data.size)
+		assert_equal(3335, file.data.size)
+	end
+	def test_sb_start
+		assert_equal(3, @header.sb_start)
+	end
+	def test_sb_size
+		assert_equal(3904, @header.sb_size)
+	end
+end