ruby-ole 1.2.10.1 → 1.2.11

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2010 Charles Lowe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/ChangeLog

@@ -1,3 +1,16 @@
+== 1.2.11 / 2010-10-17
+
+- Add COPYING for packaging (issue #7)
+- Make tests pass using home_run (github #1)
+- Make tests pass using mathn.
+- Updates to suppress warnings on 1.9.2.
+- Split out gemspec into separate file and use for Rakefile.
+
+== 1.2.10.1 / 2010-03-19
+
+- Avoid use of DateTime#new! (issue #4)
+- Remove warning about unexpected root names (issue #5)
+
 == 1.2.10 / 2009-07-20
 
 - Mostly more performance enhancements, significantly faster for
@@ -74,3 +87,4 @@
 == 1.2.1 / 2007-08-20
 
 - Separate out from ruby-msg as new project.
+

data/README

@@ -102,7 +102,6 @@ See the documentation for each class for more details.
 * case insensitive open mode would be nice
 * fix property sets a bit more. see TODO in Ole::Storage::MetaData
 * ability to zero out padding and unused blocks
-* case insensitive mode for ole/file_system?
 * better tests for mbat support.
 * further doc cleanup
 * add in place testing for jruby and ruby1.9

data/Rakefile

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'rake/rdoctask'
 require 'rake/testtask'
 require 'rake/packagetask'
@@ -6,12 +7,7 @@ require 'rake/gempackagetask'
 require 'rbconfig'
 require 'fileutils'
 
-$:.unshift 'lib'
-
-require 'ole/storage'
-
-PKG_NAME = 'ruby-ole'
-PKG_VERSION = Ole::Storage::VERSION
+spec = eval File.read('ruby-ole.gemspec')
 
 task :default => [:test]
 
@@ -44,33 +40,6 @@ Rake::RDocTask.new do |t|
 	t.main	   = 'README'
 end
 
-spec = Gem::Specification.new do |s|
-	s.name = PKG_NAME
-	s.version = PKG_VERSION
-	s.summary = %q{Ruby OLE library.}
-	s.description = %q{A library for easy read/write access to OLE compound documents for Ruby.}
-	s.authors = ['Charles Lowe']
-	s.email = %q{aquasync@gmail.com}
-	s.homepage = %q{http://code.google.com/p/ruby-ole}
-	s.rubyforge_project = %q{ruby-ole}
-
-	s.executables = ['oletool']
-	s.files  = ['README', 'Rakefile', 'ChangeLog', 'data/propids.yaml']
-	s.files += FileList['lib/**/*.rb']
-	s.files += FileList['test/test_*.rb', 'test/*.doc']
-	s.files += FileList['test/oleWithDirs.ole', 'test/test_SummaryInformation']
-	s.files += FileList['bin/*']
-	s.test_files = FileList['test/test_*.rb']
-
-	s.has_rdoc = true
-	s.extra_rdoc_files = ['README', 'ChangeLog']
-	s.rdoc_options += [
-		'--main', 'README',
-		'--title', "#{PKG_NAME} documentation",
-		'--tab-width', '2'
-	]
-end
-
 Rake::GemPackageTask.new(spec) do |t|
 	t.gem_spec = spec
 	t.need_tar = false
@@ -82,7 +51,7 @@ desc 'Run various benchmarks'
 task :benchmark do
 	require 'benchmark'
 	require 'tempfile'
-	require 'ole/file_system'
+	require 'ole/storage'
 
 	# should probably add some read benchmarks too
 	def write_benchmark opts={}

data/lib/ole/base.rb

@@ -1,5 +1,8 @@
+# encoding: ASCII-8BIT
+
 
 require 'ole/support'
+require 'ole/storage/version'
 
 module Ole # :nodoc:
 	Log = Logger.new_with_callstack

data/lib/ole/file_system.rb

@@ -1,2 +1,7 @@
-# keeping this file around for now, but will delete later on...
-require 'ole/storage/file_system'
+warn <<-end
+Use of ole/file_system is deprecated. Use ole/storage (the file_system api
+is recommended and enabled by default).
+end
+
+require 'ole/storage'
+

data/lib/ole/ranges_io.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+
 # need IO::Mode
 require 'ole/support'
 
@@ -122,7 +124,7 @@ class RangesIO
 		# do a binary search throuh @offsets to find the active range.
 		a, c, b = 0, 0, @offsets.length
 		while a < b
-			c = (a + b) / 2
+			c = (a + b).div(2)
 			pivot = @offsets[c]
 			if pos == pivot
 				@active = c

data/lib/ole/storage/base.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+
 require 'tempfile'
 
 require 'ole/base'
@@ -21,8 +23,6 @@ module Ole # :nodoc:
 		class FormatError < StandardError # :nodoc:
 		end
 
-		VERSION = '1.2.10.1'
-
 		# options used at creation time
 		attr_reader :params
 		# The top of the ole tree structure

data/lib/ole/storage/file_system.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+
 #
 # = Introduction
 #
@@ -29,8 +31,6 @@
 #   the filesystem api.
 #
 
-require 'ole/storage'
-
 module Ole # :nodoc:
 	class Storage
 		def file
@@ -51,7 +51,7 @@ module Ole # :nodoc:
 				next if part.empty?
 				return nil if dirent.file?
 				return nil unless dirent = dirent/part
-			end			
+			end
 			dirent
 		end
 

data/lib/ole/storage/meta_data.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+
 require 'ole/types/property_set'
 
 module Ole

data/lib/ole/storage/version.rb

@@ -0,0 +1,8 @@
+# encoding: ASCII-8BIT
+
+module Ole # :nodoc:
+	class Storage
+		VERSION = '1.2.11'
+	end
+end
+

data/lib/ole/support.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+
 # 
 # A file with general support functions used by most files in the project.
 # 
@@ -25,13 +27,15 @@ end
 class File # :nodoc:
 	# for interface consistency with StringIO etc (rather than adding #stat
 	# to them). used by RangesIO.
-	def size
-		stat.size
+	unless File.instance_methods.include?(:size)
+		def size
+			stat.size
+		end
 	end
 end
 
 class Symbol # :nodoc:
-	unless :x.respond_to? :to_proc
+	unless Symbol.instance_methods.include?(:to_proc)
 		def to_proc
 			proc { |a| a.send self }
 		end

data/lib/ole/types/base.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+
 require 'iconv'
 require 'date'
 
@@ -16,7 +18,7 @@ module Ole # :nodoc:
 			def self.load str
 				new str
 			end
-			
+
 			def self.dump str
 				str.to_s
 			end
@@ -39,17 +41,17 @@ module Ole # :nodoc:
 		class Lpwstr < String
 			FROM_UTF16 = Iconv.new 'utf-8', 'utf-16le'
 			TO_UTF16   = Iconv.new 'utf-16le', 'utf-8'
-			
+
 			def self.load str
 				new FROM_UTF16.iconv(str).chomp(0.chr)
 			end
-			
+
 			def self.dump str
 				# need to append nulls?
 				data = TO_UTF16.iconv str
 				# not sure if this is the recommended way to do it, but I want to treat
 				# the resulting utf16 data as regular bytes, not characters.
-				data.force_encoding Encoding::US_ASCII if data.respond_to? :encoding
+				data.force_encoding Encoding::ASCII_8BIT if data.respond_to? :encoding
 				data
 			end
 		end
@@ -68,13 +70,12 @@ module Ole # :nodoc:
 				end
 				y   = year + 4800
 				m   = month - 3
-				jd  = day + (153 * m + 2) / 5 + 365 * y + y / 4 - y / 100 + y / 400 - 32045
+				jd  = day + (153 * m + 2).div(5) + 365 * y + y.div(4) - y.div(100) + y.div(400) - 32045
 				fr  = hour / 24.0 + min / 1440.0 + sec / 86400.0
-				# avoid new!, as it was actually new0 in older versions of ruby (<=1.8.4?)
-				# see issue #4. this is equivalent, but doesn't rely on the aliasing used
-				obj = allocate
-				obj.send :initialize, jd + fr - 0.5, 0, ITALY
-				obj
+				# new! was actually new0 in older versions of ruby (<=1.8.4?)
+				# see issue #4.
+				msg = respond_to?(:new!) ? :new! : :new0
+				send msg, jd + fr - 0.5, 0, ITALY
 			end
 
 			def self.from_time time
@@ -100,7 +101,10 @@ module Ole # :nodoc:
 				return nil if low == 0 and high == 0
 				# the + 0.00001 here stinks a bit...
 				seconds = (high * (1 << 32) + low) / 1e7 + 0.00001
-				EPOCH + seconds / 86400 rescue return
+				obj = EPOCH + seconds / 86400 rescue return
+				# work around home_run not preserving derived class
+				obj = new! obj.jd + obj.day_fraction - 0.5, 0, ITALY unless FileTime === obj
+				obj
 			end
 
 			# +time+ should be able to be either a Time, Date, or DateTime.
@@ -120,7 +124,7 @@ module Ole # :nodoc:
 				high, low = nanoseconds.divmod 1 << 32
 				[low, high].pack 'V2'
 			end
-			
+
 			def inspect
 				"#<#{self.class} #{to_s}>"
 			end
@@ -138,13 +142,13 @@ module Ole # :nodoc:
 			def self.load str
 				new str.to_s
 			end
-			
+
 			def self.dump guid
 				return 0.chr * SIZE unless guid
 				# allow use of plain strings in place of guids.
 				guid['-'] ? parse(guid) : guid
 			end
-			
+
 			def self.parse str
 				vals = str.scan(/[a-f\d]+/i).map(&:hex)
 				if vals.length == 5
@@ -160,7 +164,7 @@ module Ole # :nodoc:
 			def format
 				"%08x-%04x-%04x-%02x%02x-#{'%02x' * 6}" % unpack(PACK)
 			end
-			
+
 			def inspect
 				"#<#{self.class}:{#{format}}>"
 			end
@@ -249,12 +253,12 @@ module Ole # :nodoc:
 			module Constants
 				NAMES.each { |num, name| const_set name, num }
 			end
-			
+
 			def self.load type, str
 				type = NAMES[type] or raise ArgumentError, 'unknown ole type - 0x%04x' % type
 				(CLASS_MAP[type] || Data).load str
 			end
-			
+
 			def self.dump type, variant
 				type = NAMES[type] or raise ArgumentError, 'unknown ole type - 0x%04x' % type
 				(CLASS_MAP[type] || Data).dump variant
@@ -262,7 +266,7 @@ module Ole # :nodoc:
 		end
 
 		include Variant::Constants
-		
+
 		# deprecated aliases, kept mostly for the benefit of ruby-msg, until
 		# i release a new version.
 		def self.load_guid str

data/lib/ole/types/property_set.rb

@@ -1,4 +1,5 @@
-require 'ole/types'
+# encoding: ASCII-8BIT
+
 require 'yaml'
 
 module Ole
@@ -163,3 +164,4 @@ module Ole
 		end
 	end
 end
+

data/test/test_filesystem.rb

@@ -23,7 +23,7 @@
 TEST_DIR = File.dirname __FILE__
 $:.unshift "#{TEST_DIR}/../lib"
 
-require 'ole/storage/file_system'
+require 'ole/storage'
 require 'test/unit'
 
 module ExtraAssertions
@@ -873,7 +873,38 @@ class OleFsDirIteratorTest < Test::Unit::TestCase
 
 end
 
+class OleUnicodeTest < Test::Unit::TestCase
+	def setup
+		@io = StringIO.new ''
+	end
+	
+	def test_unicode
+		# in ruby-1.8, encoding is assumed to be UTF-8 (and converted with iconv).
+		# in ruby-1.9, UTF-8 should work also, but probably shouldn't be using fixed
+		# TO_UTF16 iconv for other encodings.
+		resume = "R\xc3\xa9sum\xc3\xa9"
+		resume.force_encoding Encoding::UTF_8 if resume.respond_to? :encoding
+		Ole::Storage.open @io do |ole|
+			ole.file.open(resume, 'w') { |f| f.write 'Skills: writing bad unit tests' }
+		end
+		Ole::Storage.open @io do |ole|
+			assert_equal ['.', '..', resume], ole.dir.entries('.')
+			# use internal api to verify utf16 encoding
+			assert_equal "R\x00\xE9\x00s\x00u\x00m\x00\xE9\x00", ole.root.children[0].name_utf16[0, 6 * 2]
+			# FIXME: there is a bug in ruby-1.9 (at least in p376), which makes encoded
+			# strings useless as hash keys. identical bytes, identical encodings, identical
+			# according to #==, but different hash.
+			temp = File.expand_path("/#{resume}").split('/').last
+			if resume == temp and resume.hash != temp.hash
+				warn 'skipping assertion due to broken String#hash'
+			else
+				assert_equal 'Skills', ole.file.read(resume).split(': ', 2).first
+			end
+		end
+	end
+end
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard
 # rubyzip is free software; you can redistribute it and/or
 # modify it under the terms of the ruby license.
+

data/test/test_mbat.rb

@@ -3,8 +3,7 @@
 $: << File.dirname(__FILE__) + '/../lib'
 
 require 'test/unit'
-require 'ole/storage/base'
-require 'ole/storage/file_system'
+require 'ole/storage'
 require 'tempfile'
 
 class TestWriteMbat < Test::Unit::TestCase

data/test/test_meta_data.rb

@@ -3,9 +3,7 @@
 $: << File.dirname(__FILE__) + '/../lib'
 
 require 'test/unit'
-require 'ole/storage/base'
-require 'ole/storage/meta_data'
-require 'ole/storage/file_system'
+require 'ole/storage'
 
 class TestMetaData < Test::Unit::TestCase
 	def test_meta_data

data/test/test_property_set.rb

@@ -3,7 +3,7 @@
 $: << File.dirname(__FILE__) + '/../lib'
 
 require 'test/unit'
-require 'ole/types/property_set'
+require 'ole/types'
 
 class TestPropertySet < Test::Unit::TestCase
 	include Ole::Types

data/test/test_types.rb

@@ -3,7 +3,7 @@
 $: << File.dirname(__FILE__) + '/../lib'
 
 require 'test/unit'
-require 'ole/types/base'
+require 'ole/types'
 
 class TestTypes < Test::Unit::TestCase
 	include Ole::Types

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-ole
 version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: false
   segments: 
   - 1
   - 2
-  - 10
-  - 1
-  version: 1.2.10.1
+  - 11
+  version: 1.2.11
 platform: ruby
 authors: 
 - Charles Lowe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-19 00:00:00 -04:00
+date: 2010-10-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -30,33 +30,31 @@ extra_rdoc_files:
 - ChangeLog
 files: 
 - README
+- COPYING
 - Rakefile
 - ChangeLog
 - data/propids.yaml
 - bin/oletool
-- lib/ole/types.rb
 - lib/ole/storage.rb
+- lib/ole/storage/file_system.rb
+- lib/ole/storage/base.rb
+- lib/ole/storage/meta_data.rb
+- lib/ole/storage/version.rb
+- lib/ole/types/property_set.rb
+- lib/ole/types/base.rb
+- lib/ole/types.rb
 - lib/ole/support.rb
+- lib/ole/file_system.rb
 - lib/ole/base.rb
 - lib/ole/ranges_io.rb
-- lib/ole/file_system.rb
-- lib/ole/types/property_set.rb
-- lib/ole/types/base.rb
-- lib/ole/storage/meta_data.rb
-- lib/ole/storage/base.rb
-- lib/ole/storage/file_system.rb
-- test/test_ranges_io.rb
+- test/test_property_set.rb
 - test/test_storage.rb
-- test/test_filesystem.rb
-- test/test_support.rb
 - test/test_mbat.rb
-- test/test_types.rb
 - test/test_meta_data.rb
-- test/test_property_set.rb
-- test/test_word_6.doc
-- test/test_word_97.doc
-- test/test_word_95.doc
-- test/test.doc
+- test/test_support.rb
+- test/test_types.rb
+- test/test_ranges_io.rb
+- test/test_filesystem.rb
 - test/oleWithDirs.ole
 - test/test_SummaryInformation
 has_rdoc: true
@@ -74,32 +72,36 @@ 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"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ruby-ole
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby OLE library.
 test_files: 
-- test/test_ranges_io.rb
+- test/test_property_set.rb
 - test/test_storage.rb
-- test/test_filesystem.rb
-- test/test_support.rb
 - test/test_mbat.rb
-- test/test_types.rb
 - test/test_meta_data.rb
-- test/test_property_set.rb
+- test/test_support.rb
+- test/test_types.rb
+- test/test_ranges_io.rb
+- test/test_filesystem.rb