ufooar 0.1.1.140

data/openoffice/document.rb

@@ -0,0 +1,167 @@
+# Filename: document.rb
+#
+# Author::              Nathan Lane (mailto:nathamberlane@gmail.com)
+# Copyright::   Copyright (c) 2007 Nathan Lane
+# License::             GNU Lesser General Public License (http://www.gnu.org/licenses/lgpl.html)
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# Documentation for this library may be found at http://code.google.com/p/ufooar/
+
+# This module contains the Document class, which is a factory class for other classes used
+# to automate OpenOffice.org.
+# Author:: Nathan Lane
+# Last Updated: 11/09/2007
+
+module OpenOffice
+
+	class Document
+
+		# creates and opens a new document of the specified type
+		def self.create_document(doc_type, hidden = false)
+			case doc_type
+				when :calc
+					factory_uri = "private:factory/scalc"
+				when :writer
+					factory_uri = "private:factory/swriter"
+				when :impress
+					factory_uri = "private:factory/simpress"
+				when :draw
+					factory_uri = "private:factory/sdraw"
+				when :base, :math
+					msg = "#{doc_type.to_s} cannot be created."
+					raise(ArgumentError, msg)
+				else
+					msg = "#{doc_type.to_s} is not a type of Open Office document."
+					raise(ArgumentError, msg)
+			end
+			
+			file_args = hidden ? UNO.create_property_values("Hidden", true) : []
+			load_document(factory_uri, file_args)
+		end
+
+		# opens a document
+		# require fully qualified file name, excluding uri portion
+		def self.open_document(file_name, hidden = false)
+			msg = "Document #{file_name} does not exists."
+			file_exist = File.exist?(file_name)
+			raise(ArgumentError, msg) unless File.exist?(file_name)
+
+			# build the uri
+			extension = File.basename(file_name).split('.')[-1]
+			factory_uri = 'file:///' + file_name
+
+			# determine the required propety values require for the document
+			case extension
+				when "odw", "doc", "ods", "txt"
+					names_values = hidden ? ["Hidden", true] : []
+				when "xls"
+					names_values = ["FilterName", "MS Excel 97"]
+					names_values += ["Hidden", true] if hidden
+				when "csv"
+					col_descr = csv_col_descr()  # 1/10/2/10 .. /255/10/256/10
+					names_values = ["FilterName",
+					   "Text - txt - csv (StarCalc)",
+					   "FilterOptions",
+					   "44, 34, SYSTEM, 1, #{col_descr}"]
+					names_values += ["Hidden", true] if hidden
+				when "htm", "html"
+					names_values = ["FilterName", "HTML (StarWriter)", "Overwrite", TRUE]
+					names_values += ["Hidden", true] if hidden
+				else
+					msg = "Cannot open #{file_name} document currently."
+					raise(ArgumentError, msg)
+			end
+			
+			file_args = names_values.size > 0 ? UNO.create_property_values(names_values) : []
+			load_document(factory_uri, file_args)
+		end
+
+		# This method returns a WIN32OLE object to the document object requested.
+		# Author:: Nathan Lane
+		# Last Updated: 11/09/2007
+		def self.create_document_instance(document_type, file_uri = nil, file_args = [])
+			case document_type
+				when :calc
+					if file_uri.nil?
+						factory_uri = "private:factory/scalc"
+					elsif file_uri =~ /^(file:\/\/\/)[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(ods|xls|csv|html|htm){1}$/
+						factory_uri = file_uri
+					elsif file_uri =~ /^[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(ods|xls|csv|html|htm){1}$/
+						factory_uri = "file:///" + file_uri
+					else
+						msg = "Malformed URI only support for xls, ods, and csv files is currently available"
+						raise(ArgumentError, msg)
+				end # End: if file_uri.nil?
+				
+				when :writer
+					if file_uri.nil?
+						factory_uri = "private:factory/swriter"
+					elsif file_uri =~ /^(file:\/\/\/)[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(odw|doc|txt){1}$/
+						factory_uri = file_uri
+					elsif file_uri =~ /^[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(odw|doc|txt){1}$/
+						factory_uri = "file:///" + file_uri
+					elsif file_uri =~ /^(https:\/\/)[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(htm|html){1}$/
+						factory_uri = file_uri
+					elsif file_uri =~ /^[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(htm|html){1}$/
+						factory_uri = "http://" + file_uri
+					else
+						raise "Malformed URI, only support for doc, odw, htm, and html files is currently available"
+					end # End: if file_uri.nil?
+			else
+				puts "document_type must be either :calc or :writer"
+			end # End: case document_type
+
+			if !factory_uri["csv"].nil?
+				# Need to create two Property objects and insert them into the file_args array
+				col_descr = csv_col_descr()
+				names_values = ["FilterName",
+				   "Text - txt - csv (StarCalc)",
+				   "FilterOptions",
+				   "44, 34, SYSTEM, 1, #{col_descr}"]
+				  # "44, 34, SYSTEM, 1, 1/10/2/10/3/10/4/10/5/10/6/10/7/10/8/10/9/10"]
+				file_args = UNO.create_property_values( names_values )
+			end # End: if !factory_uri["csv"].nil?
+
+			if !factory_uri["htm"].nil? || !factory_uri["html"].nil?
+				# Need to create two Property objects and insert them into the file_args array
+				names_values = ["FilterName", "HTML (StarWriter)", "Overwrite", TRUE]
+				file_args = UNO.create_property_values( names_values )
+			end # End: if !factory_uri["htm"].nil?
+
+			Document.load_document(factory_uri, file_args)
+		end # End: def self.create_document_instance document_type, file_uri = nil, args = []
+
+		# This method loads a document based on its URI and args array.
+		# Author:: Nathan Lane
+		# Last Updated: 11/09/2007
+		def self.load_document factory_uri, file_args
+			# puts [factory_uri, file_args].inspect
+			UNO.get_desktop_instance.loadComponentFromURL(factory_uri, "_blank", 0, file_args)
+		end # End: def load_document uri = nil, args = []
+		
+	end # End: class Document
+
+	# ###############################################################
+	# support methods
+	# ###############################################################
+	# generates columns descriptor for the csv FilterOption
+	def csv_col_descr
+		cols = ""
+		(1..256).each { |i| cols += i.to_s + '/' + 10.to_s + '/' }
+		cols.chop!
+	end
+
+end # End: module OpenOffice

data/openoffice/writer.rb

@@ -0,0 +1,137 @@
+# Filename: writer.rb
+#
+# Author::		Nathan Lane (mailto:nathamberlane@gmail.com)
+# Copyright::	Copyright (c) 2007 Nathan Lane
+# License::		GNU Lesser General Public License (http://www.gnu.org/licenses/lgpl.html)
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# Documentation for this library may be found at http://code.google.com/p/ufooar/
+
+# This module contains the Writer class, which wraps around Writer documents.
+# Author:: Nathan Lane
+# Last Updated: 11/13/2007
+
+require 'openoffice/document'
+
+module OpenOffice
+	
+	# This class contains methods used to manipulate Writer documents.
+	# Author:: Nathan Lane
+	# Last Updated: 11/13/2007
+	
+	class Writer
+		
+		attr_reader :document, :file_uri, :file_args
+		
+		# This constructor takes two arguments, file_path, which is a String and args, which is an
+		# Array.  Args is not required to create a new document, but you must specify a file path
+		# as a URI in the form file:///driveletter:/path/to/file.ods.
+		# Author:: Nathan Lane
+		# Last Updated: 11/13/2007
+		
+		def initialize file_path = nil, file_args = []
+			@document, @file_uri, @file_args = Document.create_document_instance :writer, file_path, file_args
+		end # End: def initialize file_path = nil, file_args = []
+		
+		# This method saves the current document according to the URI you provide as the file path.  The
+		# URI must be in the format file:///driveletter:/path/to/file.odw
+		# Author:: Nathan Lane
+		# Last Updated: 11/13/2007
+		
+		def save file_path = nil, args = []
+			if file_path =~ /^(file:\/\/\/)[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(odw|doc){1}$/
+				file_uri = file_path
+				file_args = args
+				@document.storeAsURL file_uri, file_args
+			elsif file_path.nil? and !@file_uri.nil?
+				if @file_uri =~ /^[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(odw|doc){1}$/
+					full_file_uri = "file:///" + @file_uri
+				else
+					full_file_uri = @file_uri
+				end # End: if @file_uri =~ /^[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(odw|doc){1}$/
+				
+				file_args = args
+				@document.storeAsURL full_file_uri, file_args
+			else
+				raise "Malformed URI: only support for xls and ods files is currently available or file path not supplied"
+			end # End: if filepath =~ /^(file:\/\/\/)[a-zA-Z]{1}[:]{1}[\/a-zA-Z\d\s._-]+(odw|doc){1}$/
+		end # End: def save file_path
+		
+		# This method saves the current document in a different form according to what you provide as
+		# the format.
+		# Author:: Nathan Lane
+		# Last Updated: 11/13/2007
+		
+		def save_as file_type = :odw, file_path = nil, args = []
+			case file_type
+				when :ods
+					args = args
+					
+					# Fix the URI
+					if file_path.nil?
+						file_suffix = "odw"
+						
+						if @file_uri["doc"]
+							len = @file_uri.length - 1
+							@file_uri = @file_uri[0..(len - 3)] + file_suffix
+						end
+					else
+						file_suffix = "doc"
+						
+						if file_path["odw"]
+							len = @file_uri.length - 1
+							file_path = file_path[0..(len - 3)] + file_suffix
+						end
+					end # End: if file_path.nil?
+				when :word97
+					excel_filter = UNO.create_property_value "FilterName", "MS Word 97"
+					args = args + [ excel_filter ]
+					
+					# Fix the URI
+					if file_path.nil?
+						file_suffix = "doc"
+						
+						if @file_uri["odw"]
+							len = @file_uri.length - 1
+							@file_uri = @file_uri[0..(len - 3)] + file_suffix
+						end
+					else
+						file_suffix = "doc"
+						
+						if file_path["odw"]
+							len = @file_uri.length - 1
+							file_path = file_path[0..(len - 3)] + file_suffix
+						end
+					end # End: if file_path.nil?
+				else
+					raise "Unsupported file type only :odw and :word97 are supported"
+			end # End: case file_type
+			
+			save file_path, args
+		end # End: def save_as file_path, args = [], file_type = :ods
+		
+		# This method closes the current document.
+		# Author:: Nathan Lane
+		# Last Updated: 11/13/2007
+		
+		def close
+			@document.close(0)
+			@document
+		end # End: def close
+		
+	end # End: class Writer
+	
+end # End: module OpenOffice

data/ufooar.rb

@@ -0,0 +1,45 @@
+# Filename: ufooar.rb
+#
+# Author::		Nathan Lane (mailto:nathamberlane@gmail.com)
+# Copyright::	Copyright (c) 2007 Nathan Lane
+# License::		GNU Lesser General Public License (http://www.gnu.org/licenses/lgpl.html)
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# Documentation for this library may be found at http://code.google.com/p/ufooar/
+
+# This module contains the UFOOAR classes used to automate OpenOffice.org
+# via its UNO component.
+# Author:: Nathan Lane
+# Last Updated: 11/09/2007
+
+require 'win32ole'
+require 'uno/uno'
+require 'openoffice/calc'
+require 'openoffice/writer'
+
+module OpenOffice
+end # End: module OpenOffice
+
+module UFOOAR
+    # The revision number (according to Subversion)
+    REVISION_STRING = '$Revision: 140 $'
+    REVISION_STRING.scan(/Revision: (\d*)/)
+    REVISION = $1 or 'unknown'
+    
+    # The Release number
+    VERSION_SHORT = '0.1.1'
+    VERSION = VERSION_SHORT + '.' + REVISION
+end # End: module UFOOAR

data/unittests/all_ufooar_tests.rb

@@ -0,0 +1,25 @@
+# Author::		Nathan Lane (mailto:nathamberlane@gmail.com)
+# Copyright::	Copyright (c) 2007 Nathan Lane
+# License::		GNU Lesser General Public License (http://www.gnu.org/licenses/lgpl.html)
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+# This unit test set tests all of the ufooar classes
+# Author:: Nathan Lane
+# Last Update: 11/08/2007
+
+require 'spreadsheet_tests'
+require 'uno_tests'

data/unittests/spreadsheet_tests.rb

@@ -0,0 +1,56 @@
+# Author::		Nathan Lane (mailto:nathamberlane@gmail.com)
+# Copyright::	Copyright (c) 2007 Nathan Lane
+# License::		GNU Lesser General Public License (http://www.gnu.org/licenses/lgpl.html)
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+# This unit test set tests the Spreadsheet class
+# Author:: Nathan Lane
+# Last Update: 11/08/2007
+
+require 'test/unit'
+require 'ufooar'
+
+include OpenOffice
+
+class TestSpreadsheet < Test::Unit::TestCase
+	
+	def test_spreadheet_hidden
+		test_object = Spreadsheet.HIDDEN
+		assert_equal test_object.class, WIN32OLE
+		assert_equal test_object.Name, "Hidden"
+		assert_equal test_object.Value, true
+	end # End: def test_spreadheet_hidden
+	
+	def test_open_new_spreadsheet
+		test_object = Spreadsheet.new
+		assert_equal test_object.class, Spreadsheet
+		assert_equal test_object.spreadsheet.class, WIN32OLE
+		
+		test_object.close
+		assert test_object.spreadsheet.nil?
+	end # End: def test_open_new_spreadsheet
+	
+	def test_open_ods_spreadsheet
+		test_object = Spreadsheet.new ("file:///" + Dir.getwd + "/unittestresources/test.ods")
+		assert_equal test_object.class, Spreadsheet
+		assert_equals test_object.spreadsheet.class, WIN32OLE
+		
+		test_object.close
+		assert test_object.spreadsheet.nil?		
+	end # End: def test_open_ods_spreadsheet
+	
+end # End: class TestSpreadsheet < Test::Unit::TestCase

data/unittests/unittestresources/test.csv

@@ -0,0 +1,5 @@
+Name, Country, Age, Hobby
+"George", "England", 24, "Guitar"
+"Henry", "France", 28, "Ruling"
+"Jack", "Italy", 19, "Stealing"
+"Kevin", "United States", 21, "Hacking"

data/unittests/uno_tests.rb

@@ -0,0 +1,54 @@
+# Author::		Nathan Lane (mailto:nathamberlane@gmail.com)
+# Copyright::	Copyright (c) 2007 Nathan Lane
+# License::		GNU Lesser General Public License (http://www.gnu.org/licenses/lgpl.html)
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+# This unit test set tests the UNO class
+# Author:: Nathan Lane
+# Last Update: 11/08/2007
+
+require 'test/unit'
+require 'ufooar'
+
+include OpenOffice
+
+class TestUNO < Test::Unit::TestCase
+	
+	def test_get_service_manager
+		assert_equal UNO.get_service_manager.class, WIN32OLE
+	end # End: def test_get_service_manager
+	
+	def test_get_core_reflection_instance
+		assert_equal UNO.get_core_reflection_instance.class, WIN32OLE
+	end # End: def test_get_core_reflection_instance
+	
+	def test_get_desktop_instance
+		assert_equal UNO.get_desktop_instance.class, WIN32OLE
+	end # End: def test_get_desktop_instance
+	
+	def test_property_value
+		assert_equal UNO.property_value.class, WIN32OLE
+	end # End: def test_property_value
+	
+	def test_create_property_value
+		test_object = UNO.create_property_value "Hidden", true
+		assert_equal test_object.class, WIN32OLE
+		assert_equal test_object.Name, "Hidden"
+		assert_equal test_object.Value, true
+	end # End: def test_create_property_value
+	
+end # End: class TestUNO < Test::Unit::TestCase