More misc clean-ups.

git-svn-id: https://ruby-msg.googlecode.com/svn/trunk@121 c30d66de-b626-0410-988f-81f6512a6d81

Author: aquasync

Rakefile

@@ -45,22 +45,21 @@ Rake::RDocTask.new do |t|
 end
 
 spec = Gem::Specification.new do |s|
-	s.name = PKG_NAME
-	s.version = PKG_VERSION
-	s.summary = %q{Ruby Msg library.}
+	s.name        = PKG_NAME
+	s.version     = PKG_VERSION
+	s.summary     = %q{Ruby Msg library.}
 	s.description = %q{A library for reading Outlook msg files, and for converting them to RFC2822 emails.}
-	s.authors = ["Charles Lowe"]
-	s.email = %q{aquasync@gmail.com}
-	s.homepage = %q{http://code.google.com/p/ruby-msg}
+	s.authors     = ["Charles Lowe"]
+	s.email       = %q{aquasync@gmail.com}
+	s.homepage    = %q{http://code.google.com/p/ruby-msg}
 	s.rubyforge_project = %q{ruby-msg}
 
 	s.executables = ['msgtool']
-	s.files  = Dir.glob('data/*.yaml') + ['Rakefile', 'README', 'FIXES']
-	s.files += Dir.glob("lib/**/*.rb")
-	s.files += Dir.glob("test/test_*.rb")
-	s.files += Dir.glob("bin/*")
+	s.files       = FileList['data/*.yaml', 'Rakefile', 'README', 'FIXES']
+	s.files      += FileList['lib/**/*.rb', 'test/test_*.rb', 'bin/*']
 
-	s.has_rdoc = true
+	s.has_rdoc    = true
+	s.extra_rdoc_files = ['README']
 	s.rdoc_options += ['--main', 'README',
 					   '--title', "#{PKG_NAME} documentation",
 					   '--tab-width', '2']

TODO

@@ -1,5 +1,14 @@
 = Newer Msg
 
+* extend msgtool with support for the other kinds of msg files. things like, 
+  - dump properties to yaml / xml (with option on how the keys should be dumped).
+    should be fairly easy to implement. hash, with array of attach & recips.
+  - just write out the mime type
+  - convert to a certain output type, maybe supporting an override of some
+    sort.
+  - options regarding preferring rtf / html / txt output for things. like, eg
+    the output for note conversion, will be one of them i guess.
+
 * fix nameid handling for sub Properties objects. needs to inherit top-level @nameid.
 
 * better handling for "Untitled Attachments", or attachments with no filename at all.

lib/mapi.rb

@@ -2,30 +2,6 @@
 require 'mapi/property_set'
 
 module Mapi
-=begin
-	# IMessage essentially, but there's also stuff like IMAPIFolder etc. so, for this to form
-	# basis for PST Item, it'd need to be more general.
-	class Item #< Msg
-		# IAttach
-		class Attachment #< Msg::Attachment
-		end
-
-
-		class Recipient #< Recipient
-		end
-
-		# +props+ should be a PropertyStore object.
-		def initialize props
-			@properties = props
-			@mime = Mime.new props.transport_message_headers.to_s, true
-
-			# hack
-			@root = OpenStruct.new(:ole => OpenStruct.new(:dirents => [OpenStruct.new(:time => nil)]))
-			populate_headers
-		end
-	end
-=end
-
 	class ObjectWithProperties
 		attr_reader :properties
 		alias props properties
@@ -100,6 +76,9 @@ def inspect
 
 	# i refer to it as a message (as does mapi), although perhaps Item is better, as its a more general
 	# concept than a message
+	#
+	# IMessage essentially, but there's also stuff like IMAPIFolder etc. so, for this to form
+	# basis for PST Item, it'd need to be more general.
 	class Message < ObjectWithProperties
 		# these 2 collections should be provided by our subclasses
 		def attachments
@@ -110,43 +89,5 @@ def recipients
 			raise NotImplementedError
 		end
 	end
-	
-	# the #to_mime logic will be refactored out into mapi/to_mime.rb
-	#   will probably ditch custom Mime class, and go with TMail. to_mime.rb
-	#   will include that mapping, as well as vcard, etc etc. or, i'll have
-	#   mapi/to_mime/message.rb mapi/to_mime/vcard.rb mapi/to_mime/ical.rb
-	#   i will add minimal functionality to the base classes beyond that.
-	# the msg parsing will be consolidated into mapi/msg.rb
-	# the pst parsing will go into mapi/pst.rb
-	# rtf related code will be in rtf.rb and mapi/rtf.rb
 end
 
-#message = Mapi::Msg.open 'test-swetlana_novikova.msg'
-#message = Mapi::Msg.open ARGV.first #'test-swetlana_novikova.msg'
-#p message.props
-#p message.props.message_class
-#puts message.convert
-
-Mapi::Msg.open 'test_Blammo.msg' do |msg|
-	puts msg.to_mime.to_tree
-	puts msg.to_mime.to_s
-end if $0 == __FILE__
-
-__END__
-
-pst = Mapi::Pst.open 'test.pst'
-message2 = pst.find { |m| m.path =~ /^inbox\/test/i and m.subject == 'test' }
-
-# what about conversion. i'm thinking something like:
-# Mapi::PropertyStore#replace and/or #update
-# and similarly, Message#replace. so you can do something like:
-
-message3 = Mapi::Msg.open 'test2.msg', 'rb+' # creates empty msg file
-message3.update message2 # recursively copy all properties
-message3.close
-
-# can define Message#to_msg as a shortcut to this. similarly, in the unlikely
-# event that pst write support is ever implemented.
-
-# needs to be cheap to create a message, not like the current situation. ie, fully lazily loading.
-# on the other hand, the inspect strings will probably cause things to be loaded, but thats ok.

lib/mapi/msg.rb

@@ -87,12 +87,11 @@ class Msg < Message
 		#
 		# = TODO
 		#
-		# * Test cases.
 		# * While the key objects are sufficient, the value objects are just plain
 		#   ruby types. It currently isn't possible to write to the values, or to know
 		#   which encoding the value had.
-		# * Consider other MAPI property stores, such as tnef/pst. Similar model?
-		#   Generalise this one?
+		# * Update this doc.
+		# * Perhaps change from eager loading, to be load-on-demand.
 		#
 		class PropertyStore
 			include PropertySet::Constants
@@ -117,23 +116,19 @@ class PropertyStore
 			NAMEID_RX = /^__nameid_version1\.0$/
 			VALID_RX = /#{SUBSTG_RX}|#{PROPERTIES_RX}|#{NAMEID_RX}/
 
-			# access the underlying raw property hash
-			attr_reader :raw
 			attr_reader :nameid
 
 			def initialize
-				@raw = {}
-				@unused = []
 				@nameid = nil
-				# FIXME
-				@body_rtf = @body_html = @body = false
+				# not exactly a cache currently
+				@cache = {}
 			end
 
 			#--
 			# The parsing methods
 			#++
 
-			def self.load obj, ignore=nil
+			def self.load obj
 				prop = new
 				prop.load obj
 				prop
@@ -306,23 +301,21 @@ def add_property key, value, pos=nil
 					key = Key.new key
 				end
 				if pos
-					@raw[key] ||= []
-					Log.warn "duplicate property" unless Array === @raw[key]
+					@cache[key] ||= []
+					Log.warn "duplicate property" unless Array === @cache[key]
 					# ^ this is actually a trickier problem. the issue is more that they must all be of
 					# the same type.
-					@raw[key][pos] = value
+					@cache[key][pos] = value
 				else
 					# take the last.
-					Log.warn "duplicate property #{key.inspect}" if @raw[key]
-					@raw[key] = value
+					Log.warn "duplicate property #{key.inspect}" if @cache[key]
+					@cache[key] = value
 				end
 			end
 
-			def inspect
-				'#<Properties ' + to_h.map do |k, v|
-					v = v.inspect
-					"#{k}=#{v.length > 32 ? v[0..29] + '..."' : v}"
-				end.join(' ') + '>'
+			# delegate to cache
+			def method_missing name, *args, &block
+				@cache.send name, *args, &block
 			end
 		end
 
@@ -355,7 +348,7 @@ def self.open arg, mode=nil
 		def initialize root
 			@root = root
 			@close_parent = false
-			super PropertySet.new(PropertyStore.load(@root).raw)
+			super PropertySet.new(PropertyStore.load(@root))
 			Msg.warn_unknown @root
 		end
 
@@ -396,11 +389,10 @@ class Attachment < Mapi::Attachment
 
 			def initialize obj
 				@obj = obj
-				@properties = Properties.load @obj
 				@embedded_ole = nil
 				@embedded_msg = nil
 
-				super PropertySet.new(PropertyStore.load(@obj).raw)
+				super PropertySet.new(PropertyStore.load(@obj))
 				Msg.warn_unknown @obj
 
 				@obj.children.each do |child|
@@ -448,7 +440,7 @@ class Recipient < Mapi::Recipient
 
 			def initialize obj
 				@obj = obj
-				super PropertySet.new(PropertyStore.load(@obj).raw)
+				super PropertySet.new(PropertyStore.load(@obj))
 				Msg.warn_unknown @obj
 			end
 		end

lib/mapi/property_set.rb

@@ -222,8 +222,13 @@ def method_missing name, *args
 		def to_h
 			sym_to_key.inject({}) { |hash, (sym, key)| hash.update sym => raw[key] }
 		end
-		
-		# the other pseudo properties like body_html, body_rtf etc that are inferred will exist here.
+
+		def inspect
+			"#<#{self.class} " + to_h.sort_by { |k, v| k.to_s }.map do |k, v|
+				v = v.inspect
+				"#{k}=#{v.length > 32 ? v[0..29] + '..."' : v}"
+			end.join(' ') + '>'
+		end
 
 		# -----