rb-appscript 0.2.1 → 0.3.0

data/src/lib/_aem/connect.rb

@@ -2,8 +2,6 @@
 # Copyright (C) 2006 HAS. 
 # Released under MIT License.
 
-# TO DO: this module refers directly to Send::Event instead of going via the AEM::Application::Event hook, which might cause problems when used in an OSA component or other situation where client needs to customise all event creation and/or dispatch.
-
 module Connect
 	# Creates Apple event descriptor records of typeProcessSerialNumber, typeKernelProcessID and typeApplicationURL, used to specify the target application in Send::Event constructor.
 	

data/src/lib/_aem/findapp.rb

@@ -58,7 +58,7 @@ module FindApp
 			name += '.app'
 		end
 		if not FileTest.exist?(name)
-			raise RuntimeError, name
+			raise ApplicationNotFoundError.new(nil, nil, name), "Application #{name.inspect} not found."
 		end
 		return name
 	end

data/src/lib/_aem/mactypes.rb

@@ -13,7 +13,7 @@ module MacTypes
 	class FileBase
 	
 		URLPrefix = 'file://localhost'
-		URLPatt = Regexp.new('file://(?:.*?)(/.*)', Regexp::IGNORECASE)
+		URLPatt = Regexp.new('file://.*?(/.*)', Regexp::IGNORECASE)
 	
 		def FileBase._path_to_url(path)
 			return URLPrefix + path.gsub(/[^a-zA-Z0-9_.-\/]/) { |c| "%%%02x" % c[0] }
@@ -44,10 +44,7 @@ module MacTypes
 		end
 		
 		def ==(val)
-			return (self.equal?(val) or (
-					self.class == val.class and 
-					self.desc.type == val.desc.type and
-					self.desc.data == self.desc.data))
+			return (self.equal?(val) or (self.class == val.class and self.url == val.url))
 		end
 		
 		alias_method :eql?, :==
@@ -207,10 +204,6 @@ module MacTypes
 		# The AEM defines a standard set of unit types; some applications may define additional types for their own use. This wrapper stores the raw unit type and value data; aem/appscript Codecs objects will convert this to/from an AEDesc, or raise an error if the unit type is unrecognised.
 	
 		attr_reader :value, :type
-	
-		def Units.method_missing(name, value)
-			return new(value, name)
-		end
 		
 		def initialize(value, type)
 			@value = value

data/src/lib/_aem/send.rb

@@ -159,7 +159,7 @@ module Send
 		end
 		
 		def _send_apple_event(flags, timeout)
-			#�Hook method; may be overridden to customise how events are sent.
+			# Hook method; may be overridden to customise how events are sent.
 			return @AEM_event.send(flags, timeout)
 		end
 		
@@ -193,7 +193,7 @@ module Send
 				if reply_event.type != KAE::TypeNull
 					event_result = {}
 					reply_event.length.times do |i|
-						key, value = reply_event.get(i + 1, KAE::TypeWildCard)
+						key, value = reply_event.get_item(i + 1, KAE::TypeWildCard)
 						event_result[key] = value
 					end
 					if event_result.has_key?(KAE::KeyErrorNumber) # The application raised an error.

data/src/lib/_appscript/defaultterminology.rb

@@ -201,8 +201,8 @@ module DefaultTerminology
 	# ReferenceByName table is used to convert appscript-style references and commands to their aem equivalents
 	
 	ReferenceByCode = {
-		'pcls' => 'class_',
-		'ID  ' => 'id_',
+		'ppcls' => 'class_',
+		'pID  ' => 'id_',
 	}
 	
 	ReferenceByName = {

data/src/lib/_appscript/referencerenderer.rb

@@ -24,6 +24,8 @@ class ReferenceRenderer
 		end
 	end
 	
+	##
+	
 	def property(code)
 		name = @_app_data.reference_by_code.fetch('p'+code) { @_app_data.reference_by_code.fetch('e'+code) }
 		@result += ".#{name}"
@@ -71,15 +73,16 @@ class ReferenceRenderer
 		return self
 	end
 	
+	##
+	
 	def app
-		if @_app_data.path
-			@result = "app(#{@_app_data.path.inspect})"
-		elsif @_app_data.pid
-			@result = "app.by_pid(#{@_app_data.pid.inspect})"
-		elsif @_app_data.url
-			@result = "app.by_url(#{@_app_data.url.inspect})"
+		case @_app_data.constructor
+			when :current
+				@result = "app.current"
+			when :by_path
+				@result = "app(#{@_app_data.identifier.inspect})"
 		else
-			@result = "app.current"
+			@result = "app.#{@_app_data.constructor}(#{@_app_data.identifier.inspect})"
 		end
 		return self
 	end
@@ -94,12 +97,114 @@ class ReferenceRenderer
 		return self
 	end
 	
-	def method_missing(name, *args)
-		if args.length > 0
-			@result += ".#{name.to_s}(#{(args.map { |arg| arg.inspect }).join(', ')})"
-		else
-			@result += ".#{name.to_s}"
-		end
+	##
+	
+	def start
+		@result += ".start"
+		return self
+	end
+	
+	def end
+		@result += ".end"
+		return self
+	end
+	
+	def before
+		@result += ".before"
+		return self
+	end
+	
+	def after
+		@result += ".after"
+		return self
+	end
+	
+	##
+	
+	def first
+		@result += ".first"
+		return self
+	end
+	
+	def middle
+		@result += ".middle"
+		return self
+	end
+	
+	def last
+		@result += ".last"
+		return self
+	end
+	
+	def any
+		@result += ".any"
+		return self
+	end
+	
+	##
+	
+	def gt(val)
+		@result += ".gt(#{_format(val)})"
+		return self
+	end
+	
+	def ge(val)
+		@result += ".ge(#{_format(val)})"
+		return self
+	end
+	
+	def eq(val)
+		@result += ".eq(#{_format(val)})"
+		return self
+	end
+	
+	def ne(val)
+		@result += ".ne(#{_format(val)})"
+		return self
+	end
+	
+	def lt(val)
+		@result += ".lt(#{_format(val)})"
+		return self
+	end
+	
+	def le(val)
+		@result += ".le(#{_format(val)})"
+		return self
+	end
+	
+	def starts_with(val)
+		@result += ".starts_with(#{_format(val)})"
+		return self
+	end
+	
+	def ends_with(val)
+		@result += ".ends_with(#{_format(val)})"
+		return self
+	end
+	
+	def contains(val)
+		@result += ".contains(#{_format(val)})"
+		return self
+	end
+	
+	def is_in(val)
+		@result += ".is_in(#{_format(val)})"
+		return self
+	end
+	
+	def and(*operands)
+		@result += ".and(#{(operands.map { |val| _format(val) }).join(', ')})"
+		return self
+	end
+	
+	def or(*operands)
+		@result += ".or(#{(operands.map { |val| _format(val) }).join(', ')})"
+		return self
+	end
+	
+	def not
+		@result += ".not"
 		return self
 	end
 	
@@ -122,7 +227,7 @@ class ReferenceRenderer
 			aem_reference.AEM_resolve(f)
 			return f.result
 		rescue
-			return aem_reference.inspect
+			return "#{new(app_data).app.result}.AS_new_reference(#{aem_reference.inspect})"
 		end
 	end
 

data/src/lib/_appscript/reservedkeywords.rb

@@ -12,6 +12,7 @@ ReservedKeywords = [
 	"AS_aem_reference=",
 	"AS_app_data",
 	"AS_app_data=",
+	"AS_new_reference",
 	"AS_resolve",
 	"ID",
 	"[]",
@@ -25,7 +26,9 @@ ReservedKeywords = [
 	"after",
 	"and",
 	"any",
+	"app",
 	"before",
+	"by_aem_app",
 	"by_creator",
 	"by_id",
 	"by_name",
@@ -34,6 +37,7 @@ ReservedKeywords = [
 	"class",
 	"clone",
 	"commands",
+	"con",
 	"contains",
 	"current",
 	"display",
@@ -67,6 +71,7 @@ ReservedKeywords = [
 	"is_a?",
 	"is_in",
 	"is_not_in",
+	"its",
 	"keywords",
 	"kind_of?",
 	"last",

data/src/lib/_appscript/safeobject.rb

@@ -0,0 +1,190 @@
+#!/usr/local/bin/ruby
+# A modified, updated version of basicobject (http://facets.rubyforge.org/), used to provide
+# Appscript::Reference and Appscript#GenericReference with stable superclasses.
+
+# Unfortunately, Ruby makes it ludicrously easy for users to accidentally add new methods
+# to the Object class. And if these methods' names are the same as application keywords, 
+# Ruby will invoke them instead of Reference#method_missing, resulting in incorrect behaviour.
+#
+# e.g. The following code demonstrates the problem in an unpatched copy of appscript 0.2.1.
+# Including modules in the main script for convenience is a not-uncommon practice; unfortunately,
+# because main's class is Object, this causes the additional methods to appear on every other
+# object in the system as well (very bad).
+#
+#######
+# require 'appscript'
+#
+# module X
+#	def name
+#		puts 'X.name was called'
+#		return 999
+#	end
+# end
+# include X
+#
+# Appscript.app('textedit').name.get
+########
+#
+# Result:
+#
+# # X.name was called
+# # /tmp/tmpscript:13: undefined method `get' for 999:Fixnum (NoMethodError)
+
+# The AS_SafeObject class undefines any methods not on the EXCLUDE safe list; traps are
+# then applied to Module#method_added and Module#included to detect any subsequent
+# method additions and immediately remove those from AS_SafeObject as well.
+
+# Having to insert traps into other users' runtimes isn't exactly an ideal solution, but 
+# unless/until Ruby comes up with a safe, sane system for including modules in main that
+# doesn't pollute every other namespace as well, it may be the only practical solution. The
+# only other alternative would be a major redesign+rewrite of the appscript module to use 
+# metaclasses (c.f. js-appscript) instead of method_missing, but this is not really desireable
+# as it'd be much more complicated to implement, slower to initialise, and less elegant to
+# use (since GenericReferences would have to be dropped).
+
+######################################################################
+# ORIGINAL COPYRIGHT
+######################################################################
+
+# = basicobject.rb
+#
+# == Copyright (c) 2005 Thomas Sawyer, Jim Weirich
+#
+#   Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   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.
+
+######################################################################
+# PUBLIC
+######################################################################
+
+require '_appscript/reservedkeywords'
+
+class AS_SafeObject
+
+	EXCLUDE = ReservedKeywords + [
+		"Array",
+		"Float",
+		"Integer",
+		"String",
+		"`",
+		"abort",
+		"at_exit",
+		"autoload",
+		"autoload?",
+		"binding",
+		"block_given?",
+		"callcc",
+		"caller",
+		"catch",
+		"chomp",
+		"chomp!",
+		"chop",
+		"chop!",
+		"eval",
+		"exec",
+		"exit",
+		"exit!",
+		"fail",
+		"fork",
+		"format",
+		"getc",
+		"gets",
+		"global_variables",
+		"gsub",
+		"gsub!",
+		"initialize",
+		"initialize_copy",
+		"iterator?",
+		"lambda",
+		"load",
+		"local_variables",
+		"loop",
+		"open",
+		"p",
+		"print",
+		"printf",
+		"proc",
+		"putc",
+		"puts",
+		"raise",
+		"rand",
+		"readline",
+		"readlines",
+		"remove_instance_variable",
+		"require",
+		"scan",
+		"select",
+		"set_trace_func",
+		"singleton_method_added",
+		"singleton_method_removed",
+		"singleton_method_undefined",
+		"sleep",
+		"split",
+		"sprintf",
+		"srand",
+		"sub",
+		"sub!",
+		"syscall",
+		"system",
+		"test",
+		"throw",
+		"trace_var",
+		"trap",
+		"untrace_var",
+		"warn"
+	] + [
+		/^__/, /^instance_/, /^object_/, /\?$/, /^\W$/,
+	]
+
+	def self.hide(name)
+		case name
+			when *EXCLUDE
+		else
+			undef_method(name) rescue nil
+		end
+	end
+
+	public_instance_methods(true).each { |m| hide(m) }
+	#private_instance_methods(true).each { |m| hide(m) }
+	protected_instance_methods(true).each { |m| hide(m) }
+
+end
+
+
+
+######################################################################
+# PRIVATE
+######################################################################
+# Since Ruby is very dynamic, methods added to the ancestors of
+# AS_SafeObject after AS_SafeObject is defined will show up in the
+# list of available AS_SafeObject methods. We handle this by defining
+# hooks in Module that will hide any defined.
+
+class Module
+	madded = method(:method_added)
+	define_method(:method_added) do |name|
+		# puts "ADDED    %-32s %s" % [name, self]
+		result = madded.call(name)
+		if self == Object
+			AS_SafeObject.hide(name)
+		end
+		return result
+	end
+	mincluded = method(:included)
+	define_method(:included) do |mod|
+		result = mincluded.call(mod)
+		# puts "INCLUDED %-32s %s" % [mod, self]
+		if mod == Object
+			public_instance_methods(true).each { |name| AS_SafeObject.hide(name) }
+			#private_instance_methods(true).each { |name| AS_SafeObject.hide(name) }
+			protected_instance_methods(true).each { |name| AS_SafeObject.hide(name) }
+		end
+		return result
+	end
+end