rb-appscript 0.2.1 → 0.3.0

data/src/lib/osax.rb

@@ -20,7 +20,7 @@ module OSAX
 	OSAXCache = {}
 	OSAXNames = []
 	
-	se = Appscript.app('System Events')
+	se = Appscript.app.by_id('com.apple.systemevents')
 	[se.system_domain, se.local_domain, se.user_domain].each do |domain|
 		osaxen = domain.scripting_additions_folder.files[
 				Appscript.its.file_type.eq('osax').or(Appscript.its.name_extension.eq('osax'))]
@@ -37,33 +37,25 @@ module OSAX
 	
 	class OSAXData < Appscript::AppData
 	
-		def initialize(name, pid, url, terms)
-			super(AEM::Application, name, pid, url, terms)
+		def initialize(constructor, identifier, terms)
+			super(AEM::Application, constructor, identifier, terms)
 		end
 	
-		def _connect
-			if @path
-				@target = @_aem_application_class.by_path(@path)
-			elsif @pid
-				@target = @_aem_application_class.by_pid(@pid)
-			elsif @url
-				@target = @_aem_application_class.by_url(@url)
-			else
-				@target = @_aem_application_class.current
-			end
+		def connect
+			super
 			begin
-				@target.event('ascrgdut').send(300) # make sure target application has loaded event handlers for all installed OSAXen
+				@target.event('ascrgdut').send(60 * 60) # make sure target application has loaded event handlers for all installed OSAXen
 			rescue AEM::CommandError => e
 				if e.number != -1708 # ignore 'event not handled' error
 					raise
 				end
 			end
-			@type_by_code, @type_by_name, @reference_by_code, @reference_by_name = @_terms
-			extend(Appscript::AppDataAccessors)
 		end
 	
 	end
 	
+	@_standard_additions = nil
+	
 	
 	######################################################################
 	# PUBLIC
@@ -74,16 +66,55 @@ module OSAX
 		return OSAXNames
 	end
 	
-	def OSAX.osax(name, app_name=nil)
-		# convenience method; provides shortcut for creating a new ScriptingAddition instance;
-		# a target application's name or full path may optionally be given as well
-		addition = ScriptingAddition.new(name)
-		if app_name
-			addition = addition.by_name(app_name)
+	def OSAX.osax(name=nil, app_name=nil)
+		# Convenience method for creating a new ScriptingAddition instance.
+		#	name : String | nil -- scripting addition's name; nil = 'StandardAdditions'
+		#	app_name : String | nil -- target application's name/path, or nil for current application
+		#	Result : ScriptingAddition
+		#
+		# If both arguments are nil, a ScriptingAddition object for StandardAdditions is created
+		# and returned. This object is cached for efficiency and returned in subsequent calls;
+		# thus clients can conveniently write (e.g):
+		#
+		#	osax.some_command
+		#	osax.another_command
+		#
+		# instead of:
+		#
+		#	sa = osax
+		#	sa.some_command
+		#	sa.another_command
+		#
+		# without the additional overhead of creating a new ScriptingAddition object each time.
+		#
+		if name == nil and app_name == nil
+			if @_standard_additions == nil
+				@_standard_additions = ScriptingAddition.new('StandardAdditions')
+			end
+			addition = @_standard_additions
+		else
+			if name == nil
+				name = 'StandardAdditions'
+			end
+			addition = ScriptingAddition.new(name)
+			if app_name
+				addition = addition.by_name(app_name)
+			end
 		end
 		return addition
 	end
 	
+	# allow methods to be included via 'include OSAX'
+	
+	def scripting_additions
+		return OSAX.scripting_additions
+	end
+	
+	def osax(*args)
+		return OSAX.osax(*args)
+	end
+	
+	#######
 	
 	class ScriptingAddition < Appscript::Reference
 		# Represents a single scripting addition.
@@ -107,7 +138,7 @@ module OSAX
 					@_terms = OSAXCache[osax_name][1] = \
 							Terminology.tables_for_aetes(DefaultCodecs.unpack(desc))
 				end
-				osax_data = OSAXData.new(nil, nil, nil, @_terms)
+				osax_data = OSAXData.new(:current, nil, @_terms)
 			end
 			super(osax_data, AEM.app)
 		end
@@ -140,33 +171,38 @@ module OSAX
 		def by_name(name)
 			# name : string -- name or full path to application
 			return ScriptingAddition.new(@_osax_name, 
-					OSAXData.new(FindApp.by_name(name), nil, nil, @_terms))
+					OSAXData.new(:by_path, FindApp.by_name(name), @_terms))
 		end
 		
 		def by_id(id)
 			# id : string -- bundle id of application
 			return ScriptingAddition.new(@_osax_name, 
-					OSAXData.new(FindApp.by_id(id), nil, nil, @_terms))
+					OSAXData.new(:by_path, FindApp.by_id(id), @_terms))
 		end
 		
 		def by_creator(creator)
 			# creator : string -- four-character creator code of application
 			return ScriptingAddition.new(@_osax_name, 
-					OSAXData.new(FindApp.by_creator(creator), nil, nil, @_terms))
+					OSAXData.new(:by_path, FindApp.by_creator(creator), @_terms))
 		end
 		
 		def by_pid(pid)
 			# pid : integer -- Unix process id
-			return ScriptingAddition.new(@_osax_name, OSAXData.new(nil, pid, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(:by_pid, pid, @_terms))
 		end
 		
 		def by_url(url)
 			# url : string -- eppc URL of application
-			return ScriptingAddition.new(@_osax_name, OSAXData.new(nil, nil, url, @_terms))
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(:by_url, url, @_terms))
+		end
+		
+		def by_aem_app(aem_app)
+			# aem_app : AEM::Application -- an AEM::Application instance
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(:by_aem_app, aem_app, @_terms))
 		end
 		
 		def current
-			return ScriptingAddition.new(@_osax_name, OSAXData.new(nil, nil, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(:current, nil, @_terms))
 		end
 	end
 	

data/src/rbae.c

@@ -233,6 +233,7 @@ rbAE_AEDesc_isRecord(VALUE self)
 	return AECheckIsRecord(&(AEDESC_OF(self))) ? Qtrue : Qfalse;
 }
 
+
 static VALUE
 rbAE_AEDesc_coerce(VALUE self, VALUE type)
 {
@@ -244,6 +245,7 @@ rbAE_AEDesc_coerce(VALUE self, VALUE type)
 	return rbAE_wrapAEDesc(&desc);
 }
 
+
 static VALUE
 rbAE_AEDesc_length(VALUE self)
 {
@@ -256,6 +258,8 @@ rbAE_AEDesc_length(VALUE self)
 }
 
 
+/*******/
+
 static VALUE
 rbAE_AEDesc_putItem(VALUE self, VALUE index, VALUE desc)
 {
@@ -295,8 +299,10 @@ rbAE_AEDesc_putAttr(VALUE self, VALUE key, VALUE desc)
 }
 
 
+/*******/
+
 static VALUE
-rbAE_AEDesc_get(VALUE self, VALUE index, VALUE type)
+rbAE_AEDesc_getItem(VALUE self, VALUE index, VALUE type)
 {
 	OSErr err = noErr;
 	AEKeyword key;
@@ -315,6 +321,38 @@ rbAE_AEDesc_get(VALUE self, VALUE index, VALUE type)
 }
 
 
+static VALUE
+rbAE_AEDesc_getParam(VALUE self, VALUE key, VALUE type)
+{
+	OSErr err = noErr;
+	AEDesc desc;
+	
+	err = AEGetParamDesc(&(AEDESC_OF(self)),
+					   rbStringToDescType(key),
+					   rbStringToDescType(type),
+					   &desc);
+	if (err != noErr) rbAE_raiseMacOSError("Can't get parameter from AEDesc.", err);
+	return rbAE_wrapAEDesc(&desc);
+}
+
+
+static VALUE
+rbAE_AEDesc_getAttr(VALUE self, VALUE key, VALUE type)
+{
+	OSErr err = noErr;
+	AEDesc desc;
+	
+	err = AEGetAttributeDesc(&(AEDESC_OF(self)),
+					   rbStringToDescType(key),
+					   rbStringToDescType(type),
+					   &desc);
+	if (err != noErr) rbAE_raiseMacOSError("Can't get attribute from AEDesc.", err);
+	return rbAE_wrapAEDesc(&desc);
+}
+
+
+/*******/
+
 static VALUE
 rbAE_AEDesc_send(VALUE self, VALUE sendMode, VALUE timeout)
 {
@@ -706,7 +744,9 @@ Init_ae (void)
 	rb_define_method(cAEDesc, "put_item", rbAE_AEDesc_putItem, 2);
 	rb_define_method(cAEDesc, "put_param", rbAE_AEDesc_putParam, 2);
 	rb_define_method(cAEDesc, "put_attr", rbAE_AEDesc_putAttr, 2);
-	rb_define_method(cAEDesc, "get", rbAE_AEDesc_get, 2);
+	rb_define_method(cAEDesc, "get_item", rbAE_AEDesc_getItem, 2);
+	rb_define_method(cAEDesc, "get_param", rbAE_AEDesc_getParam, 2);
+	rb_define_method(cAEDesc, "get_attr", rbAE_AEDesc_getAttr, 2);
 	rb_define_method(cAEDesc, "send", rbAE_AEDesc_send, 2);
 	
 	// AE::MacOSError

data/test/test_aemreference.rb

@@ -103,9 +103,9 @@ class TC_AEMReferences < Test::Unit::TestCase
 		assert_not_equal(AEMReference::App.elements('ctxt').property('ctxt'), AEMReference::App.property('ctxt').property('ctxt'))
 		assert_not_equal(AEMReference::App.elements('ctxt').property('ctxt'), 333)
 		assert_not_equal(333, AEMReference::App.property('ctxt').property('ctxt'))
-		# by-range and by-filter references do basic type checking to ensure a reference is given
-		assert_raises(TypeError) { AEMReference::App.elements('docu').by_range(1, 2) }
-		assert_raises(TypeError) { AEMReference::App.elements('docu').by_filter(1) }
+#		# by-range and by-filter references do basic type checking to ensure a reference is given
+#		assert_raises(TypeError) { AEMReference::App.elements('docu').by_range(1, 2) }
+#		assert_raises(TypeError) { AEMReference::App.elements('docu').by_filter(1) }
 		
 	end
 end

data/test/test_appscriptcommands.rb

@@ -0,0 +1,135 @@
+#!/usr/local/bin/ruby
+
+require 'test/unit'
+require 'appscript'
+
+class AS_SafeObject
+	def self.hide(name)
+	end
+end
+
+class TC_AppscriptNewApp < Test::Unit::TestCase
+
+	def test_by_name
+		[
+				'/Applications/TextEdit.app',
+				'Finder.app',
+				'System Events'
+		].each do |name|
+			a = Appscript.app(name)
+			assert_not_nil(a)
+			assert_instance_of(Appscript::Application, a)
+			assert_instance_of(Appscript::Reference, a.name)
+		end
+		assert_equal('app("/Applications/TextEdit.app")', Appscript.app('TextEdit').to_s)
+		assert_equal('app("/Applications/TextEdit.app")', Appscript.app.by_name('TextEdit').to_s)
+		
+		assert_raises(Appscript::ApplicationNotFoundError) { Appscript.app('/non-existent/app') }
+		assert_raises(Appscript::ApplicationNotFoundError) { Appscript.app('non-existent.app') }
+	end
+	
+	def test_by_id
+		[
+				'com.apple.textedit',
+				'com.apple.finder',
+		].each do |name|
+			a = Appscript.app.by_id(name)
+			assert_not_nil(a)
+			assert_instance_of(Appscript::Application, a)
+			assert_instance_of(Appscript::Reference, a.name)
+		end
+		assert_equal('app("/Applications/TextEdit.app")', Appscript.app.by_id('com.apple.textedit').to_s)
+		
+		assert_raises(Appscript::ApplicationNotFoundError) { Appscript.app.by_id('non.existent.app') }
+	end
+
+	def test_by_creator
+		a = Appscript.app.by_creator('ttxt')
+		assert_instance_of(Appscript::Reference, a.name)
+		assert_equal('app("/Applications/TextEdit.app")', a.to_s)
+		assert_raises(Appscript::ApplicationNotFoundError) { Appscript.app.by_id('!@$o') }
+	end
+	
+	def test_by_pid
+		pid = `top -l1 | grep Finder | awk '{ print $1 }'`.to_i
+		a = Appscript.app.by_pid(pid)
+		assert_instance_of(Appscript::Reference, a.name)
+		assert_equal("app.by_pid(#{pid})", a.to_s)
+		assert_equal('Finder', a.name.get)
+	end
+	
+	def test_by_aem_app
+		a = Appscript.app.by_aem_app(AEM::Application.by_path('/Applications/TextEdit.app'))
+		assert_instance_of(Appscript::Reference, a.name)
+		assert_equal('app.by_aem_app(AEM::Application.by_path("/Applications/TextEdit.app"))', a.to_s)
+	end
+end
+
+
+class TC_AppscriptCommands < Test::Unit::TestCase
+
+	def setup
+		@te = Appscript.app('TextEdit')
+		@f = Appscript.app('Finder')
+	end
+	
+	def test_commands_1
+		assert_equal('TextEdit', @te.name.get)
+		d = @te.make(:new=>:document, :with_properties=>{:text=>'test test_commands'})
+		assert_instance_of(Appscript::Reference, d)
+		d.text.end.make(:new=>:word, :with_data=>' test2')
+		assert_equal('test test_commands test2', d.text.get)
+		assert_instance_of(String, 
+				d.text.get(:ignore=>[:diacriticals, :punctuation, :whitespace, :expansion], :timeout=>10))
+		assert_nil(d.get(:wait_reply=>false))
+		
+		d.text.set("\302\251 M. Lef\303\250vre")
+		assert_equal("\302\251 M. Lef\303\250vre", d.text.get)
+		
+		d.close(:saving=>:no)
+	end
+	
+	def test_commands_2
+		d = @te.make(:new=>:document, :at=>@te.documents.end)
+		
+		@te.set(d.text, :to=> 'test1')
+		assert_equal('test1', d.text.get)
+		
+		@te.set(d.text, :to=> 'test2')
+		@te.make(:new=>:word, :at=>Appscript.app.documents[1].paragraphs.end, :with_data=>' test3')
+		assert_equal('test2 test3', d.text.get)
+		
+		d.close(:saving=>:no)
+		
+		assert_raises(Appscript::CommandError) { @te.documents[10000].get }
+		
+		assert_instance_of(Fixnum, @te.documents.count)
+		assert_equal(@te.documents.count, @te.count(:each=>:document))
+	end
+	
+	def test_commands_3
+		assert_equal('Finder', @f.name.get)
+		val = @f.home.folders['Desktop'].get(:result_type=>:alias)
+		assert_instance_of(MacTypes::Alias, val)
+		assert_equal(val, @f.desktop.get(:result_type=>:alias))
+		assert_instance_of(Array, @f.disks.get)
+		
+		r = @f.home.get
+		f = r.get(:result_type=>:file_ref)
+		assert_equal(r, @f.items[f].get)
+		
+		assert_equal(@f.home.items.get, @f.home.items.get)
+		assert_not_equal(@f.disks['non-existent'], @f.disks[1].get)
+	end
+	
+	def test_command_error
+		begin
+			@f.items[10000].get
+		rescue Appscript::CommandError => e
+			assert_equal(-1728, e.to_i)
+			assert_equal("CommandError\n\t\tOSERROR: -1728\n\t\tMESSAGE: Can't get reference.\n\t\tCOMMAND: app(\"/System/Library/CoreServices/Finder.app\").items[10000].get()\n", e.to_s)
+			assert_instance_of(AEM::CommandError, e.real_error)
+		end
+	end
+end
+

data/test/test_appscriptreference.rb

@@ -3,7 +3,6 @@
 require 'test/unit'
 require "appscript"
 
-
 class TC_AppscriptReferences < Test::Unit::TestCase
 
 	def setup
@@ -13,6 +12,16 @@ class TC_AppscriptReferences < Test::Unit::TestCase
 
 	def test_reference_forms
 		[
+			
+			[@te.documents[
+					Appscript.con.documents[3],
+					Appscript.con.documents['foo']], 
+					@s+'.documents[' +
+					'con.documents[3], ' +
+					'con.documents["foo"]]', nil],
+					
+					
+					
 			[@te.text, @s+'.text', nil],
 			
 			[@te.documents, @s+'.documents', nil],
@@ -36,13 +45,6 @@ class TC_AppscriptReferences < Test::Unit::TestCase
 			
 			[Appscript.con.documents[3], 'con.documents[3]', nil],
 			
-			[@te.documents[
-					Appscript.con.documents[3],
-					Appscript.con.documents['foo']], 
-					@s+'.documents[' +
-					'con.documents[3], ' +
-					'con.documents["foo"]]', nil],
-			
 			
 			[Appscript.its.name.eq('foo').and(Appscript.its.words.eq([])), 
 					'its.name.eq("foo").and(its.words.eq([]))', nil],

data/test/test_mactypes.rb

@@ -46,6 +46,9 @@ class TC_MacTypes < Test::Unit::TestCase
 		`rm #{@path2}`
 		assert_raises(MacTypes::FileNotFoundError) { f.to_s } # File not found.
 		assert_raises(MacTypes::FileNotFoundError) { f.to_file_url } # File not found.
+		
+		assert_equal(MacTypes::Alias.path("/Library/Scripts/"), MacTypes::Alias.path("/Library/Scripts/"))
+		assert_not_equal(MacTypes::Alias.path("/Library/Scripts/"), MacTypes::Alias.path("/Applications/"))
 	end
 
 
@@ -62,6 +65,9 @@ class TC_MacTypes < Test::Unit::TestCase
 
 		# check a not-found error is raised if getting Alias for a filesystem object that doesn't exist
 		assert_raises(MacTypes::FileNotFoundError) { g.to_alias } # File "/non/existent path" not found.
-
+		
+		assert_equal(MacTypes::FileURL.path("/Library/Scripts/"), MacTypes::FileURL.path("/Library/Scripts/"))
+		assert_not_equal(MacTypes::FileURL.path("/Library/Scripts/"), MacTypes::FileURL.path("/Applications/"))
+		assert_not_equal(MacTypes::FileURL.path("/Library/Scripts/"), MacTypes::Alias.path("/Library/Scripts/"))
 	end
 end