rb-appscript 0.2.0 → 0.2.1

data/sample/Organize_Mail_messages.rb

@@ -12,8 +12,9 @@
 # incoming messages from this sender directly into this mailbox.
 
 require "appscript"
+include Appscript
 
-mail = AS.app('Mail')
+mail = app('Mail')
 
 # get the current selection in Mail and make sure it's an email message
 selection = mail.selection.get
@@ -47,7 +48,7 @@ if not mail.rules[folder_name].exists
 	new_rule = mail.rules[1].after.make(:new=>:rule, :with_properties=>{
 			:name=>folder_name, 
 			:should_move_message=>true,
-			:move_message=>AS.app.mailboxes[folder_name],
+			:move_message=>app.mailboxes[folder_name],
 			:stop_evaluating_rules=>true})
 	new_rule.make(:new=>:rule_condition, :with_properties=>{
 			:expression=>address,

data/sample/Print_folder_tree.rb

@@ -3,10 +3,11 @@
 # Prints the sub-folder hierarchy of a given folder as a list of folder names indented according to depth.
 
 require "appscript"
+include Appscript
 
 def print_folder_tree(folder, indent='')
     puts indent + folder.name.get
     folder.folders.get.each { |folder| print_folder_tree(folder, indent + "\t") }
 end
 
-print_folder_tree(AS.app('Finder').home.folders['Documents'])
+print_folder_tree(app('Finder').home.folders['Documents'])

data/sample/Select_all_HTML_files.rb

@@ -3,6 +3,7 @@
 # Selects all .htm/.html files in the top Finder window.
 
 require "appscript"
+include Appscript
 
-w = AS.app('Finder').Finder_windows[1].target.get
-w.files[AS.its.name_extension.is_in(['htm', 'html'])].select
+w = app('Finder').Finder_windows[1].target.get
+w.files[its.name_extension.is_in(['htm', 'html'])].select

data/sample/Set_iChat_status.rb

@@ -7,14 +7,15 @@
 # <http://developer.apple.com/cocoa/applescriptforapps.html>
 
 require "appscript"
+include Appscript
 
 begin
-	track_name = AS.app("iTunes").current_track.name.get
-rescue AS::CommandError => e
+	track_name = app("iTunes").current_track.name.get
+rescue CommandError => e
 	if e.to_i == -1728 # Can't get reference.
 		track_name = 'No track selected.'
 	else
 		raise
 	end
 end
-AS.app("iChat").status_message.set(track_name)
+app("iChat").status_message.set(track_name)

data/sample/Simple_Finder_GUI_Scripting.rb

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
 
 require 'appscript'
+include Appscript
 
 # Opens a new Finder smart folder that searches for 'ruby', via GUI Scripting
 
 # (Note: to use GUI Scripting, 'Enable access for assistive devices' option must
 # be enabled in the Universal Access panel of System Preferences.)
 
-se = AS.app('System Events')
+se = app('System Events')
 
-AS.app('Finder').activate
+app('Finder').activate
 se.keystroke('n', :using=>[:command_down, :option_down])
 se.keystroke('ruby')

data/sample/Stagger_Finder_windows.rb

@@ -5,12 +5,13 @@
 # that uses standard window class terminology.)
 
 require "appscript"
+include Appscript
 
 x, y = 0, 44
 offset  = 22
 
 # Get list of window references, ignoring any minimised windows
-window_list = AS.app('Finder').windows[AS.its.collapsed.not].get
+window_list = app('Finder').windows[its.collapsed.not].get
 
 # Move windows while preserving their original sizes
 window_list.reverse.each do |window|

data/sample/TextEdit_demo.rb

@@ -3,8 +3,9 @@
 # Demonstrates various references and commands in action.
 
 require "appscript"
+include Appscript
 
-textedit = AS.app('TextEdit') # get an application object for TextEdit
+textedit = app('TextEdit') # get an application object for TextEdit
 
 
 # tell application "TextEdit" to activate
@@ -102,12 +103,12 @@ p textedit.documents[1].text.paragraphs.get
 
 # tell application "TextEdit" to get every paragraph of document 1 
 #         where it is not "\n" -- get non-empty paragraphs
-p textedit.documents[1].paragraphs[AS.its.ne("\n")].get
+p textedit.documents[1].paragraphs[its.ne("\n")].get
 
 
 # tell application "TextEdit" to get text of every document 
 #         whose text begins with "H"
-p textedit.documents[AS.its.text.starts_with('H')].text.get
+p textedit.documents[its.text.starts_with('H')].text.get
 
 
 
@@ -117,10 +118,10 @@ p textedit.documents[AS.its.text.starts_with('H')].text.get
 #  # tell application "Tex-Edit Plus" to get words (character 5) 
 #  #         thru (paragraph 9) of document 1
 #  p app('Tex-Edit Plus').documents[1] \
-#           .words[AS.con.characters[5], AS.con.paragraphs[9]].get
+#           .words[con.characters[5], con.paragraphs[9]].get
 #
 #
 #  # tell application "Tex-Edit Plus" to get every word of text 
 #  #         of document 1 whose color is {0, 0, 0}
 #  p app('Tex-Edit Plus').documents[1].text.paragraphs \
-#          [AS.its.color.equals((0, 0, 0))].get
+#          [its.color.equals((0, 0, 0))].get

data/sample/iTunes_top40_to_html.rb

@@ -6,6 +6,7 @@
 # Requires the Amrita templating engine: http://amrita.sourceforge.jp
 
 require 'appscript'
+include Appscript
 require 'osax'
 require "amrita/template"
 include Amrita
@@ -42,7 +43,7 @@ sa = OSAX.osax('StandardAdditions')
 out_file = sa.choose_file_name(:default_name=>'My iTunes Top 40.html')
 
 # Get the played count, name and album for every track in iTunes
-tracks = AS.app('iTunes').library_playlists[1].tracks
+tracks = app('iTunes').library_playlists[1].tracks
 info = tracks.played_count.get.zip(tracks.name.get, tracks.album.get)
 # Extract the top 40 most played entries
 top40 = info.sort.reverse[0, 40]
@@ -57,7 +58,7 @@ tmpl.prettyprint = true
 File.open(out_file.to_s, 'w') { |f| tmpl.expand(f, data) }
 
 # Open file in Safari for viewing
-safari = AS.app('Safari')
+safari = app('Safari')
 safari.activate
 safari.open(out_file)
 

data/src/lib/_aem/mactypes.rb

@@ -13,16 +13,18 @@ module MacTypes
 	class FileBase
 	
 		URLPrefix = 'file://localhost'
+		URLPatt = Regexp.new('file://(?:.*?)(/.*)', Regexp::IGNORECASE)
 	
 		def FileBase._path_to_url(path)
 			return URLPrefix + path.gsub(/[^a-zA-Z0-9_.-\/]/) { |c| "%%%02x" % c[0] }
 		end
 	
 		def FileBase._url_to_path(url)
-			if url[0, URLPrefix.length] != URLPrefix
+			match = url.match(URLPatt)
+			if not match
 				raise ArgumentError, "Not a file:// URL."
 			end
-			return url[URLPrefix.length, url.length].gsub(/%../) { |s| "%c" % s[1,2].hex }
+			return match[1].gsub(/%../) { |s| "%c" % s[1,2].hex }
 		end
 		
 		def FileBase._coerce(desc, type, path=nil)
@@ -78,6 +80,11 @@ module MacTypes
 					KAE::TypeAlias, path))
 		end
 		
+		def Alias.url(url)
+			# Make Alias object from file URL. Note: only the path portion of the URL is used; the domain will always be localhost.
+			return Alias.path(_url_to_path(url))
+		end
+		
 		def Alias.desc(desc)
 			# Make Alias object from CarbonX.AE.AEDesc of typeAlias. Note: descriptor type is not checked; clients are responsible for passing the correct type as other types will cause unexpected problems/errors.
 			return new(desc)
@@ -90,6 +97,11 @@ module MacTypes
 			return @desc
 		end
 		
+		def url
+			# Get as URL string.
+			return desc.coerce(KAE::TypeFileURL).data
+		end
+		
 		def path
 			# Get as POSIX path.
 			return FileBase._url_to_path(FileBase._coerce(@desc, KAE::TypeFileURL).data)
@@ -131,6 +143,11 @@ module MacTypes
 			return new(path, nil)
 		end
 		
+		def FileURL.url(url)
+			# Make FileURL object from file URL. Note: only the path portion of the URL is used; the domain will always be localhost.
+			return FileURL.path(_url_to_path(url))
+		end
+		
 		def FileURL.desc(desc)
 			# Make FileURL object from AEDesc of typeFSS, typeFSRef, typeFileURL. Note: descriptor type is not checked; clients are responsible for passing the correct type as other types will cause unexpected problems/errors.
 			return new(nil, desc)
@@ -146,6 +163,11 @@ module MacTypes
 			return @desc
 		end
 		
+		def url
+			# Get as URL string.
+			return desc.coerce(KAE::TypeFileURL).data
+		end
+		
 		def path
 			# Get as POSIX path.
 			if not @path

data/src/lib/_appscript/referencerenderer.rb

@@ -13,7 +13,7 @@ class ReferenceRenderer
 	
 	def initialize(app_data)
 		@_app_data = app_data
-		@result = "AS"
+		@result = ""
 	end
 	
 	def _format(val)
@@ -73,24 +73,24 @@ class ReferenceRenderer
 	
 	def app
 		if @_app_data.path
-			@result += ".app(#{@_app_data.path.inspect})"
+			@result = "app(#{@_app_data.path.inspect})"
 		elsif @_app_data.pid
-			@result += ".app.by_pid(#{@_app_data.pid.inspect})"
+			@result = "app.by_pid(#{@_app_data.pid.inspect})"
 		elsif @_app_data.url
-			@result += ".app.by_url(#{@_app_data.url.inspect})"
+			@result = "app.by_url(#{@_app_data.url.inspect})"
 		else
-			@result += ".app.current"
+			@result = "app.current"
 		end
 		return self
 	end
 	
 	def con
-		@result += ".con"
+		@result = "con"
 		return self
 	end
 	
 	def its
-		@result += ".its"
+		@result = "its"
 		return self
 	end
 	

data/src/lib/appscript.rb

@@ -4,7 +4,7 @@
 
 require "_aem/mactypes"
 
-module AS
+module Appscript
 	# The following methods and classes are of interest to end users:
 	# app, con, its, CommandError, ApplicationNotFoundError
 	# Other classes are only of interest to implementors who need to hook in their own code.
@@ -182,7 +182,7 @@ module AS
 		end
 				
 		def unpack_contains_comp_descriptor(op1, op2)
-			if op1.is_a?(AS::Reference) and op1.AS_aem_reference.AEM_root == AEMReference::Its
+			if op1.is_a?(Appscript::Reference) and op1.AS_aem_reference.AEM_root == AEMReference::Its
 				return op1.contains(op2)
 			else
 				return super
@@ -219,7 +219,7 @@ module AS
 		end
 	
 		def to_s
-			s= 'AS.' + @_call[0]
+			s= @_call[0]
 			@_call[1, @_call.length].each do |name, args|					if name == :[]
 					if args.length == 1
 						s += "[#{args[0]}]"
@@ -272,7 +272,7 @@ module AS
 			if selector == nil
 				selector = value_if_none
 			end
-			if selector.is_a?(AS::GenericReference)
+			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
@@ -400,7 +400,7 @@ module AS
 					end
 				end
 #			rescue => e
-#				raise AS::CommandError.new(self, name, args, e)
+#				raise Appscript::CommandError.new(self, name, args, e)
 #			end
 			# build and send the Apple event, returning its result, if any
 			begin
@@ -541,7 +541,7 @@ module AS
 						self._resolve_range_boundary(end_range_selector, -1))
 			elsif selector.is_a?(String)
 				 new_ref = @AS_aem_reference.by_name(selector)
-			elsif selector.is_a?(AS::GenericReference)
+			elsif selector.is_a?(Appscript::GenericReference)
 				new_ref = @AS_aem_reference.by_filter(
 						selector.AS_resolve(@AS_app_data).AS_aem_reference)
 			else
@@ -771,9 +771,9 @@ module AS
 	
 	#######
 	
-	AS_App = AS::GenericApplication.new(Application)
-	AS_Con = AS::GenericReference.new(['con'])
-	AS_Its = AS::GenericReference.new(['its'])
+	AS_App = Appscript::GenericApplication.new(Application)
+	AS_Con = Appscript::GenericReference.new(['con'])
+	AS_Its = Appscript::GenericReference.new(['its'])
 	
 	
 	######################################################################
@@ -781,7 +781,7 @@ module AS
 	######################################################################
 	# public (note: Application & GenericApplication classes may also be accessed if subclassing Application class is required)
 	
-	def AS.app(*args)
+	def Appscript.app(*args)
 		if args == []
 			return AS_App
 		else
@@ -789,11 +789,29 @@ module AS
 		end
 	end
 
-	def AS.con
+	def Appscript.con
 		return AS_Con
 	end
 	
-	def AS.its
+	def Appscript.its
+		return AS_Its
+	end
+	
+	# also define app, con, its as instance methods so that clients can 'include Appscript'
+	
+	def app(*args)
+		if args == []
+			return AS_App
+		else
+			return AS_App.by_name(*args)
+		end
+	end
+
+	def con
+		return AS_Con
+	end
+	
+	def its
 		return AS_Its
 	end
 	
@@ -828,3 +846,5 @@ module AS
 	
 	ApplicationNotFoundError = FindApp::ApplicationNotFoundError
 end
+
+AS = Appscript # backwards compatibility # TO DO: remove in 0.3.0

data/src/lib/osax.rb

@@ -20,22 +20,22 @@ module OSAX
 	OSAXCache = {}
 	OSAXNames = []
 	
-	se = AS.app('System Events')
+	se = Appscript.app('System Events')
 	[se.system_domain, se.local_domain, se.user_domain].each do |domain|
 		osaxen = domain.scripting_additions_folder.files[
-				AS.its.file_type.eq('osax').or(AS.its.name_extension.eq('osax'))]
+				Appscript.its.file_type.eq('osax').or(Appscript.its.name_extension.eq('osax'))]
 		osaxen.name.get.zip(osaxen.POSIX_path.get).each do |name, path|
 			name = name.sub(/(?i)\.osax$/, '') # remove name extension, if any
 			OSAXNames.push(name)
 			OSAXCache[name.downcase] = [path, nil]
 		end
 	end
-	OSAXNames.sort.uniq
+	OSAXNames.sort!.uniq!
 	
 	#######
 	# modified AppData class
 	
-	class OSAXData < AS::AppData
+	class OSAXData < Appscript::AppData
 	
 		def initialize(name, pid, url, terms)
 			super(AEM::Application, name, pid, url, terms)
@@ -59,7 +59,7 @@ module OSAX
 				end
 			end
 			@type_by_code, @type_by_name, @reference_by_code, @reference_by_name = @_terms
-			extend(AS::AppDataAccessors)
+			extend(Appscript::AppDataAccessors)
 		end
 	
 	end
@@ -85,19 +85,18 @@ module OSAX
 	end
 	
 	
-	class ScriptingAddition < AS::Reference
+	class ScriptingAddition < Appscript::Reference
 		# Represents a single scripting addition.
 		
-		def initialize(name)
+		def initialize(name, osax_data=nil)
 			# name: string -- a scripting addition's name, e.g. "StandardAdditions";
 			#	basically its filename minus the '.osax' suffix
 			#
 			# Note that name is case-insensitive and an '.osax' suffix is ignored if given.
 			@_osax_name = name
-			if name.is_a?(OSAXData)
-				osax_data = name
-			else
-				path, terms = OSAXCache[name.downcase.sub(/(?i)\.osax$/, '')]
+			if not osax_data
+				osax_name = name.downcase.sub(/(?i)\.osax$/, '')
+				path, terms = OSAXCache[osax_name]
 				if not path
 					raise ArgumentError, "Scripting addition not found: #{name.inspect}"
 				end
@@ -105,7 +104,7 @@ module OSAX
 					@_terms = terms
 				else
 					desc = AE.get_app_terminology(path).coerce(KAE::TypeAEList)
-					@_terms = OSAXCache[name.downcase][1] = \
+					@_terms = OSAXCache[osax_name][1] = \
 							Terminology.tables_for_aetes(DefaultCodecs.unpack(desc))
 				end
 				osax_data = OSAXData.new(nil, nil, nil, @_terms)
@@ -124,7 +123,7 @@ module OSAX
 		def method_missing(name, *args)
 			begin
 				super
-			rescue AS::CommandError => e
+			rescue Appscript::CommandError => e
 				if e.to_i == -1713 # 'No user interaction allowed' error (e.g. user tried to send a 'display dialog' command to a non-GUI ruby process), so convert the target process to a full GUI process and try again
 					AE.transform_process_to_foreground_application
 					activate
@@ -140,31 +139,34 @@ module OSAX
 		
 		def by_name(name)
 			# name : string -- name or full path to application
-			return ScriptingAddition.new(OSAXData.new(FindApp.by_name(name), nil, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, 
+					OSAXData.new(FindApp.by_name(name), nil, nil, @_terms))
 		end
 		
 		def by_id(id)
 			# id : string -- bundle id of application
-			return ScriptingAddition.new(OSAXData.new(FindApp.by_id(id), nil, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, 
+					OSAXData.new(FindApp.by_id(id), nil, nil, @_terms))
 		end
 		
 		def by_creator(creator)
 			# creator : string -- four-character creator code of application
-			return ScriptingAddition.new(OSAXData.new(FindApp.by_creator(creator), nil, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, 
+					OSAXData.new(FindApp.by_creator(creator), nil, nil, @_terms))
 		end
 		
 		def by_pid(pid)
 			# pid : integer -- Unix process id
-			return ScriptingAddition.new(OSAXData.new(nil, pid, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(nil, pid, nil, @_terms))
 		end
 		
 		def by_url(url)
 			# url : string -- eppc URL of application
-			return ScriptingAddition.new(OSAXData.new(nil, nil, url, @_terms))
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(nil, nil, url, @_terms))
 		end
 		
 		def current
-			return ScriptingAddition.new(OSAXData.new(nil, nil, nil, @_terms))
+			return ScriptingAddition.new(@_osax_name, OSAXData.new(nil, nil, nil, @_terms))
 		end
 	end