rb-appscript 0.5.0 → 0.5.1

data/src/lib/_aem/send.rb

@@ -1,6 +1,10 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# send -- Event class represents a packed AppleEvent that's ready to send via AESendMessage
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 module Send
 

data/src/lib/_aem/typewrappers.rb

@@ -1,6 +1,10 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# typewrappers -- Ruby classes representing type, enumerator, property and keyword AEDescs
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 module TypeWrappers
 	

data/src/lib/_appscript/defaultterminology.rb

@@ -1,6 +1,10 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# defaultterminology -- lookup tables for default type, enumerator and command definitions
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 module DefaultTerminology
 	# Defines built-in terminology available for any application. When constructing the terminology tables for a particular application, the Terminology module will duplicate these tables and then add application-specific terms to create the finished lookup tables.

data/src/lib/_appscript/referencerenderer.rb

@@ -1,6 +1,10 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# referencerenderer -- obtain an appscript-style string representation of an aem reference
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 require "_aem/aemreference"
 

data/src/lib/_appscript/reservedkeywords.rb

@@ -1,6 +1,11 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# reservedkeywords -- names of methods already used by Ruby's Object class
+#    and appscript's Reference class
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 # This list is mirrored in ch.6 of the appscript manual and in py-appscript's osaterminology.makeidentifier module
 

data/src/lib/_appscript/safeobject.rb

@@ -1,4 +1,14 @@
-#!/usr/local/bin/ruby
+#
+# rb-appscript
+#
+# safeobject -- ensure Appscript::Reference#method_missing works reliably
+#
+# New code Copyright (C) 2006-2008 HAS
+# Original code Copyright (C) 2005 Thomas Sawyer, Jim Weirich; see below for original copyright
+#
+
+# Notes:
+
 # A modified, updated version of basicobject (http://facets.rubyforge.org/), used to provide
 # Appscript::Reference and Appscript#GenericReference with stable superclasses.
 
@@ -143,7 +153,7 @@ class AS_SafeObject
 	]
 
 	def self.hide(name)
-		case name
+		case name.to_s # Ruby1.9 returns method names as symbols, not strings as in 1.8
 			when *EXCLUDE
 		else
 			undef_method(name) rescue nil

data/src/lib/_appscript/terminology.rb

@@ -1,6 +1,10 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# terminology -- retrieve and convert an application's terminology into lookup tables
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 ######################################################################
 # TERMINOLOGY PARSER
@@ -51,9 +55,21 @@ module TerminologyParser
 			return @_str[@_ptr - 4, 4] # big-endian
 		end
 		
+		# Ruby 1.9 has changed the way that a character ordinal is obtained
+		maj, min, rev = RUBY_VERSION.split('.')
+		if (maj == '1' and min.to_i < 9) # is Ruby 1.8
+			def _length
+				return @_str[@_ptr]
+			end
+		else
+			def _length
+				return @_str[@_ptr].ord
+			end
+		end
+		
 		def _name
 			# Read a MacRoman-encoded Pascal keyword string.
-			count = @_str[@_ptr]
+			count = _length
 			@_ptr += 1 + count
 			s = @_str[@_ptr - count, count]
 			if not @@_name_cache.has_key?(s)
@@ -89,17 +105,17 @@ module TerminologyParser
 		
 		def parse_command
 			name = _name
-			@_ptr += 1 + @_str[@_ptr] # description string
+			@_ptr += 1 + _length # description string
 			@_ptr += @_ptr & 1 # align
 			code = _word + _word # event class + event id
 			# skip result
 			@_ptr += 4 # datatype word
-			@_ptr += 1 + @_str[@_ptr] # description string
+			@_ptr += 1 + _length # description string
 			@_ptr += @_ptr & 1 # align
 			@_ptr += 2 # flags integer
 			# skip direct parameter
 			@_ptr += 4 # datatype word
-			@_ptr += 1 + @_str[@_ptr] # description string
+			@_ptr += 1 + _length # description string
 			@_ptr += @_ptr & 1 # align
 			@_ptr += 2 # flags integer
 			#
@@ -117,7 +133,7 @@ module TerminologyParser
 				@_ptr += @_ptr & 1 # align
 				parameter_code = _word
 				@_ptr += 4 # datatype word
-				@_ptr += 1 + @_str[@_ptr] # description string
+				@_ptr += 1 + _length # description string
 				@_ptr += @_ptr & 1 # align
 				@_ptr += 2 # flags integer
 				current_command_args.push([parameter_name, parameter_code])
@@ -128,7 +144,7 @@ module TerminologyParser
 			name = _name
 			@_ptr += @_ptr & 1 # align
 			code = _word
-			@_ptr += 1 + @_str[@_ptr] # description string
+			@_ptr += 1 + _length # description string
 			@_ptr += @_ptr & 1 # align
 			is_plural = false
 			_integer.times do # properties
@@ -136,7 +152,7 @@ module TerminologyParser
 				@_ptr += @_ptr & 1 # align
 				propcode = _word
 				@_ptr += 4 # datatype word
-				@_ptr += 1 + @_str[@_ptr] # description string
+				@_ptr += 1 + _length # description string
 				@_ptr += @_ptr & 1 # align
 				flags = _integer
 				if propcode != 'c@#^' # not a superclass definition (see kAEInheritedProperties)
@@ -170,10 +186,10 @@ module TerminologyParser
 		end
 		
 		def parse_comparison # comparison info isn't used
-			@_ptr += 1 + @_str[@_ptr] # name string
+			@_ptr += 1 + _length # name string
 			@_ptr += @_ptr & 1 # align
 			@_ptr += 4 # code word
-			@_ptr += 1 + @_str[@_ptr] # description string
+			@_ptr += 1 + _length # description string
 			@_ptr += @_ptr & 1 # align
 		end
 		
@@ -183,7 +199,7 @@ module TerminologyParser
 				name = _name
 				@_ptr += @_ptr & 1 # align
 				code = _word
-				@_ptr += 1 + @_str[@_ptr] # description string
+				@_ptr += 1 + _length # description string
 				@_ptr += @_ptr & 1 # align
 				if not @_found_enumerators.has_key?(name + code)
 					@enumerators.push([name, code])
@@ -193,8 +209,8 @@ module TerminologyParser
 		end
 		
 		def parse_suite
-			@_ptr += 1 + @_str[@_ptr] # name string
-			@_ptr += 1 + @_str[@_ptr] # description string
+			@_ptr += 1 + _length # name string
+			@_ptr += 1 + _length # description string
 			@_ptr += @_ptr & 1 # align
 			@_ptr += 4 # code word
 			@_ptr += 4 # level, version integers

data/src/lib/aem.rb

@@ -1,6 +1,11 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# aem -- a mid-level object-oriented API for creating and sending Apple events
+#    using raw AE codes; may be used directly or via high-level appscript wrapper
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 require "ae"
 require "kae"

data/src/lib/appscript.rb

@@ -1,6 +1,11 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
+#
+# rb-appscript
+#
+# appscript -- syntactically sugared wrapper around the mid-level aem API;
+#    provides a high-level, easy-to-use API for creating and sending Apple events
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 require "_aem/mactypes"
 
@@ -187,15 +192,15 @@ module Appscript
 				# if hash contains a 'class' property containing a class name, coerce the AEDesc to that class
 				new_val = Hash[val]
 				if new_val.has_key?(:class_)
-					value = new_val.delete(:class_)
+					val2 = new_val.delete(:class_)
 				else
-					value = new_val.delete(ClassType)
+					val2 = new_val.delete(ClassType)
 				end
-				if value.is_a?(Symbol) # get the corresponding AEType (assuming there is one)
-					value = @type_by_name.fetch(value, value)
+				if val2.is_a?(Symbol) # get the corresponding AEType (assuming there is one)
+					val2 = @type_by_name.fetch(val2, val2)
 				end
-				if value.is_a?(AEM::AEType) # coerce the record to the desired type
-					record = record.coerce(value.code)
+				if val2.is_a?(AEM::AEType) # coerce the record to the desired type
+					record = record.coerce(val2.code)
 					val = new_val
 				end # else value wasn't a class name, so it'll be packed as a normal record property instead
 			end	
@@ -241,8 +246,8 @@ module Appscript
 				key, value = desc.get_item(i + 1, KAE::TypeWildCard)
 				if key == KAE::KeyASUserRecordFields
 					lst = unpack_aelist(value)
-					(lst.length / 2).times do |i|
-						dct[lst[i * 2]] = lst[i * 2 + 1]
+					(lst.length / 2).times do |j|
+						dct[lst[j * 2]] = lst[j * 2 + 1]
 					end
 				else
 					dct[@type_by_code.fetch(key) { AEM::AEType.new(key) }] = unpack(value)
@@ -259,7 +264,7 @@ module Appscript
 			return Reference.new(self, @reference_codecs.unpack(desc))
 		end
 				
-		def unpack_contains_comp_descriptor(op1, op2) # TO DO: is this needed?
+		def unpack_contains_comp_descriptor(op1, op2)
 			if op1.is_a?(Appscript::Reference) and op1.AS_aem_reference.AEM_root == AEMReference::Its
 				return op1.contains(op2)
 			else
@@ -300,6 +305,7 @@ module Appscript
 		protected :_call
 		
 		def initialize(call)
+			super()
 			@_call = call
 		end
 		
@@ -363,22 +369,18 @@ module Appscript
 		attr_writer :AS_aem_reference, :AS_app_data
 	
 		def initialize(app_data, aem_reference)
+			super()
 			@AS_app_data = app_data
 			@AS_aem_reference = aem_reference
 		end
 		
-		def _resolve_range_boundary(selector, value_if_none)
-			if selector == nil
-				selector = value_if_none
-			end
+		def _resolve_range_boundary(selector)
 			if selector.is_a?(Appscript::GenericReference)
 				return selector.AS_resolve(@AS_app_data).AS_aem_reference
 			elsif selector.is_a?(Reference)
 				return selector.AS_aem_reference
-			elsif selector.is_a?(String)
-				return AEM.con.elements(@AS_aem_reference.AEM_want).by_name(selector)
 			else
-				return AEM.con.elements(@AS_aem_reference.AEM_want).by_index(selector)
+				return selector
 			end
 		end
 		
@@ -505,28 +507,41 @@ module Appscript
 			begin
 				return @AS_app_data.target.event(code, params, atts, 
 						KAE::KAutoGenerateReturnID, @AS_app_data).send(timeout, send_flags)
-			rescue => e
-				if e.is_a?(AEM::CommandError)
-					if [-600, -609].include?(e.number) and @AS_app_data.constructor == :by_path
-						if not AEM::Application.process_exists_for_path?(@AS_app_data.identifier)
-							if code == 'ascrnoop'
-								AEM::Application.launch(@AS_app_data.identifier)
-							elsif code != 'aevtoapp'
-								raise CommandError.new(self, name, args, e)
-							end
-						end
-						@AS_app_data.target.reconnect
-						begin
-							return @AS_app_data.target.event(code, params, atts, 
-									KAE::KAutoGenerateReturnID, @AS_app_data).send(timeout, send_flags)
-						rescue
+			rescue AEM::CommandError => e
+				if e.number == -1708 and code == 'ascrnoop'
+					return # 'launch' events always return 'not handled' errors; just ignore these
+				elsif [-600, -609].include?(e.number) and @AS_app_data.constructor == :by_path 
+					#
+					# Event was sent to a local app for which we no longer have a valid address
+					# (i.e. the application has quit since this AEM::Application object was made).
+					#
+					# - If application is running under a new process id, we just update the 
+					#   AEM::Application object and resend the event.
+					#
+					# - If application isn't running, then we see if the event being sent is one of 
+					#   those allowed to relaunch the application (i.e. 'run' or 'launch'). If it is, the
+					#   application is relaunched, the process id updated and the event resent;
+					#   if not, the error is rethrown.
+					#
+					if not AEM::Application.process_exists_for_path?(@AS_app_data.identifier)
+						if code == 'ascrnoop'
+							AEM::Application.launch(@AS_app_data.identifier)
+						elsif code != 'aevtoapp'
+							raise CommandError.new(self, name, args, e)
 						end
-					elsif e.number == -1708 and code == 'ascrnoop'
-						return
+					end
+					# update AEMApplication object's AEAddressDesc
+					@AS_app_data.target.reconnect
+					# re-send command
+					begin
+						return @AS_app_data.target.event(code, params, atts, 
+								KAE::KAutoGenerateReturnID, @AS_app_data).send(timeout, send_flags)
+					rescue AEM::CommandError => e
+						raise CommandError.new(self, name, args, e)
 					end
 				end
-				raise CommandError.new(self, name, args, e)
 			end
+			raise CommandError.new(self, name, args, e)
 		end
 		
 		
@@ -627,7 +642,7 @@ module Appscript
 					return _send_command(args, name, code[0], code[1])
 			else 
 				# see if it's a method that has been added to Object class [presumably] at runtime, but excluded
-				# by AE_SafeObject to avoid potential conflicts with property/element/command names
+				# by AS_SafeObject to avoid potential conflicts with property/element/command names
 				begin
 					# Notes:
 					# rb-appscript has to prevent arbitrary methods that are added to Ruby's base Object class
@@ -665,19 +680,28 @@ module Appscript
 		end
 		
 		def [](selector, end_range_selector=nil)
+			raise TypeError, "Bad selector: nil not allowed." if selector == nil
 			if end_range_selector != nil
 				new_ref = @AS_aem_reference.by_range(
-						self._resolve_range_boundary(selector, 1),
-						self._resolve_range_boundary(end_range_selector, -1))
+						self._resolve_range_boundary(selector),
+						self._resolve_range_boundary(end_range_selector))
 			else
 				case selector
 					when String
 						 new_ref = @AS_aem_reference.by_name(selector)
-					when Appscript::GenericReference
-						new_ref = @AS_aem_reference.by_filter(
-								selector.AS_resolve(@AS_app_data).AS_aem_reference)
-					when Appscript::Reference, AEMReference::Test
-						new_ref = @AS_aem_reference.by_filter(selector)
+					when Appscript::GenericReference, Appscript::Reference, AEMReference::Test
+						case selector
+							when Appscript::GenericReference
+								test_clause = selector.AS_resolve(@AS_app_data).AS_aem_reference
+							when Appscript::Reference
+								test_clause = selector.AS_aem_reference
+						else
+							test_clause = selector	
+						end
+						if not test_clause.is_a?(AEMReference::Test)
+							raise TypeError, "Not an its-based test: #{selector}"
+						end
+						new_ref = @AS_aem_reference.by_filter(test_clause)
 				else
 					new_ref = @AS_aem_reference.by_index(selector)
 				end
@@ -881,7 +905,11 @@ module Appscript
 				AEM::Application.launch(@AS_app_data.identifier)
 				@AS_app_data.target.reconnect
 			else
-				@AS_app_data.target.event('ascrnoop').send # will send launch event to app if already running; else will error
+				begin
+					@AS_app_data.target.event('ascrnoop').send # will send launch event to app if already running; else will error
+				rescue AEM::CommandError => e
+					raise if e.to_i != -1708
+				end
 			end
 		end
 	end

data/src/lib/osax.rb

@@ -1,13 +1,14 @@
-#!/usr/local/bin/ruby
+#
+# rb-appscript
+#
+# osax -- invoke scripting addition (OSAX) commands from Ruby
+#
+# Copyright (C) 2006-2008 HAS. Released under MIT License.
+#
 
 require "appscript"
 
 module OSAX
-
-	# Allows scripting additions (a.k.a. OSAXen) to be called from Ruby.
-	#
-	# Note: currently 32-bit only; attempting to create a new ScriptingAddition instance
-	# in a 64-bit process will result in a NotImplementedError.
 	
 	######################################################################
 	# PRIVATE