rb-appscript 0.2.1 → 0.3.0

data/test/test_osax.rb

@@ -0,0 +1,57 @@
+#!/usr/local/bin/ruby
+
+require 'test/unit'
+require 'osax'
+
+class AS_SafeObject
+	def self.hide(name)
+	end
+end
+
+class TC_OSAX < Test::Unit::TestCase
+	
+	def test_1
+		sa = OSAX.osax('Standardadditions')
+		
+		assert_equal(65, sa.ASCII_number('A'))
+		
+		assert_equal(MacTypes::Alias.path("/Applications/"), sa.path_to(:applications_folder))
+		
+		assert_equal(MacTypes::Alias.path("/Library/Scripts/"), 
+				sa.path_to(:scripts_folder, :from=>:local_domain))
+		
+		assert_raises(RuntimeError) { sa.non_existent_command }
+	end
+	
+	def test_2
+		sa = OSAX.osax('Standardadditions').by_name('Finder')
+		assert_equal(65, sa.ASCII_number('A'))
+		assert_equal(MacTypes::Alias.path("/System/Library/CoreServices/Finder.app/"), sa.path_to(nil))
+	end
+	
+	def test_3
+		sa = OSAX.osax('Standardadditions').by_creator('MACS')
+		assert_equal(65, sa.ASCII_number('A'))
+		assert_equal(MacTypes::Alias.path("/System/Library/CoreServices/Finder.app/"), sa.path_to(nil))
+	end
+	
+	def test_4
+		sa = OSAX.osax('Standardadditions').by_id('com.apple.finder')
+		assert_equal(65, sa.ASCII_number('A'))
+		assert_equal(MacTypes::Alias.path("/System/Library/CoreServices/Finder.app/"), sa.path_to(nil))
+	end
+	
+	def test_5
+		sa = OSAX.osax('Standardadditions').by_pid(`top -l1 | grep Finder | awk '{ print $1 }'`.to_i)
+		assert_equal(MacTypes::Alias.path("/System/Library/CoreServices/Finder.app/"), sa.path_to(nil))
+		assert_equal(65, sa.ASCII_number('A'))
+	end
+
+	def test_6
+		sa = OSAX.osax('Standardadditions').by_aem_app(AEM::Application.by_path("/System/Library/CoreServices/Finder.app/"))
+		assert_equal(65, sa.ASCII_number('A'))
+		assert_equal(MacTypes::Alias.path("/System/Library/CoreServices/Finder.app/"), sa.path_to(nil))
+	end
+
+
+end

data/test/testall.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 
-for f in `ls | grep test_`;
+for f in `ls | grep '^test_'`;
 do
+	echo $f
 	/usr/local/bin/ruby $f
 	echo
 	echo

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rb-appscript
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2006-11-30 00:00:00 +00:00
+  version: 0.3.0
+date: 2007-01-18 00:00:00 +00:00
 summary: Ruby appscript (rb-appscript) is a high-level, user-friendly Apple event bridge that allows you to control scriptable Mac OS X applications using ordinary Ruby scripts.
 require_paths: 
 - lib
@@ -33,8 +33,6 @@ files:
 - doc
 - extconf.rb
 - LICENSE
-- misc
-- rb-appscript-0.2.0.gem
 - rb-appscript.gemspec
 - README
 - sample
@@ -54,7 +52,6 @@ files:
 - doc/aem-manual/06_buildingandsendingevents.html
 - doc/aem-manual/07_findapp.html
 - doc/aem-manual/08_examples.html
-- doc/aem-manual/09_notes.html
 - doc/aem-manual/aemreferenceinheritance.gif
 - doc/aem-manual/full.css
 - doc/aem-manual/index.html
@@ -71,8 +68,7 @@ files:
 - doc/appscript-manual/11_applicationcommands.html
 - doc/appscript-manual/12_commandexamples.html
 - doc/appscript-manual/13_performanceissues.html
-- doc/appscript-manual/14_problemapps.html
-- doc/appscript-manual/15_notes.html
+- doc/appscript-manual/14_notes.html
 - doc/appscript-manual/application_architecture.gif
 - doc/appscript-manual/application_architecture2.gif
 - doc/appscript-manual/finder_to_textedit_event.gif
@@ -82,10 +78,10 @@ files:
 - doc/appscript-manual/ruby_to_itunes_event.gif
 - doc/mactypes-manual/index.html
 - doc/osax-manual/index.html
-- misc/adobeunittypes.rb
-- misc/dump.rb
 - sample/AB_list_people_with_emails.rb
+- sample/Add_iCal_event.rb
 - sample/Create_daily_iCal_todos.rb
+- sample/Export_Address_Book_phone_numbers.rb
 - sample/Hello_world.rb
 - sample/iTunes_top40_to_html.rb
 - sample/List_iTunes_playlist_names.rb
@@ -116,20 +112,25 @@ files:
 - src/lib/_appscript/defaultterminology.rb
 - src/lib/_appscript/referencerenderer.rb
 - src/lib/_appscript/reservedkeywords.rb
+- src/lib/_appscript/safeobject.rb
 - src/lib/_appscript/terminology.rb
 - test/README
 - test/test_aemreference.rb
+- test/test_appscriptcommands.rb
 - test/test_appscriptreference.rb
 - test/test_codecs.rb
 - test/test_findapp.rb
 - test/test_mactypes.rb
+- test/test_osax.rb
 - test/testall.sh
 test_files: 
 - test/test_aemreference.rb
+- test/test_appscriptcommands.rb
 - test/test_appscriptreference.rb
 - test/test_codecs.rb
 - test/test_findapp.rb
 - test/test_mactypes.rb
+- test/test_osax.rb
 rdoc_options: []
 
 extra_rdoc_files: []

data/doc/aem-manual/09_notes.html

@@ -1,41 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-
-<title>aem | 9. Notes</title>
-
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-<style type="text/css" media="all"><!--@import url(full.css);--></style>
-
-</head>
-<body>
-
-<h1>9. Notes</h1>
-
-<!-- top navigation -->
-<div class="navbar">
-	<a href="08_examples.html">Previous</a> | <a href="index.html">Up</a>
-</div>
-
-<!-- content -->
-<div id="content">
-
-
-<h2>Copyright</h2>
-
-<p>(C) 2006 HAS -- hhas -at- users - sourceforge - net (<a href="http://rb-appscript.rubyforge.org">http://rb-appscript.rubyforge.org</a>)</p>
-
-<p>Released under the MIT License.</p>
-
-
-</div>
-
-<!-- bottom navigation -->
-<div class="navbar">
-	<a href="08_examples.html">Previous</a> | <a href="index.html">Up</a>
-</div>
-
-<!--footer-->
-<p class="footer">&copy; 2006 HAS</p>
-</body>
-</html>

data/doc/appscript-manual/14_problemapps.html

@@ -1,192 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-
-<title>appscript | 14. Dealing With Problem Applications</title>
-
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-<style type="text/css" media="all"><!--@import url(full.css);--></style>
-
-</head>
-<body>
-
-<h1>14. Dealing With Problem Applications</h1>
-
-<!-- top navigation -->
-<div class="navbar">
-	<a href="13_performanceissues.html">Previous</a> | <a href="index.html">Up</a> | <a href="15_notes.html">Next</a>
-	
-</div>
-
-<!-- content -->
-<div id="content">
-
-<p>Appscript provides a number of mechanisms for dealing with problematic applications. The following topics are currently covered:</p>
-
-<ul>
-<li><a href="#defective_terminology">Dealing with defective terminology</a></li>
-<li><a href="#non_stay_open_applications">Scripting non-stay-open applications</a></li>
-</ul>
-
-
-<!-- TO DO:
-- patching AS_app_data codecs
-- adding application-specific unit types
-- FSRef/FileURL/FSSpec, string/unicode/international text compatibility issues with older apps 
--->
-
-
-<h2><a name="defective_terminology"></a>Dealing with defective terminology</h2>
-
-
-<p>There are two ways to work around missing or incorrect terminology: use <code>aem</code> or use the <code>dump</code> tool.</p>
-
-<h3>Use aem</h3>
-
-
-<p>If faulty terminology prevents you from correctly constructing an appscript reference or command, one solution is to use the lower-level aem module, which uses raw codes instead of human-readable names. (You can use the <a href="http://sourceforge.net/project/showfiles.php?group_id=175009">ASDictionary</a> application to obtain a plain text listing of raw codes from an application's terminology resource.)</p>
-
-<p>Note that you can obtain an aem reference from an existing appscript reference by calling its <code>AS_aem_reference</code> method. You can also pass an aem reference as a parameter to an appscript command. (You cannot use an appscript reference in an aem event, however; you have to extract its aem reference and use that.)</p>
-
-<p>For example:</p>
-
-<pre><code>aem_ref = app('TextEdit').documents[1].text.AS_aem_reference
-
-# aem_ref contains an aem reference:
-#     app.elements('docu').by_index(1).elements('ctxt')
-
-app('TextEdit').get(aem_ref)</code></pre>
-
-
-<p class="hilitebox">Note that the rb-aem documentation is not yet available; for now, refer to the py-aem documentation (rb-aem's API is virtually identical to py-aem's) and rb-aem source code for more information.</p>
-
-
-
-<h3>Use dump</h3>
-
-<p>Another way to deal with buggy or imcomplete application terminology is to export it as a Ruby module and correct it by hand. Appscript can then use the terminology data from this module instead of the broken terminology from the application itself.</p>
-
-<p>Exporting an application's terminology is done using the <code>dump.rb</code> script located in the <code>misc</code> folder. This script is designed to be run from the command line, and takes three arguments: the name or path of the application whose terminology you wish to export, followed by the new module's Ruby name and file path. For example:</p>
-
-<pre><code>ruby dump.rb iCal.app ICalTerminology ~/ical_terms.rb</code></pre>
-
-<p>The dump tool will generate a new Ruby module similar to the following:</p>
-
-<pre><code>module ICalTerminology
-	Version = 1.1
-	Path = "/Applications/iCal.app"
-
-	Classes = [
-		["application", "capp"],
-		["attachment", "atts"],
-		["attendee", "wrea"],
-		...
-	]
-
-	Enumerators = [
-		["accepted", "E6ap"],
-		["ask", "ask "],
-		...
-	]
-
-	Properties = [
-		["allday_event", "wrad"],
-		["bounds", "pbnd"],
-		...
-	]
-
-	Elements = [
-		["applications", "capp"],
-		["attachment", "atts"],
-		...
-	]
-
-	Commands = [
-		["GetURL", "GURLGURL", [
-		]],
-		["close", "coreclos", [
-			["saving", "savo"],
-			["saving_in", "kfil"],
-		]],
-		...
-	]
-end</code></pre>
-
-<p>Every terminology module contains the following constants:</p>
-
-<dl>
-<dt>Version</dt>
-<dd>Indicates the terminology module's format. This is currently 1.1.</dd>
-
-<dt>Path</dt>
-<dd>The application from which this terminology was obtained.</dd>
-
-<dt>Classes</dt>
-<dd>A list of class names and their corresponding four-character codes as name-code pairs, e.g. <code>["document", "docu"]</code>.</dd>
-
-<dt>Enumerators</dt>
-<dd>A list of enumerator names and their corresponding four-character codes as name-code pairs, e.g. <code>["yes", "yes "]</code>.</dd>
-
-<dt>Properties</dt>
-<dd>A list of property names and their corresponding four-character codes as name-code pairs, e.g. <code>["name", "pnam"]</code>.</dd>
-
-<dt>Elements</dt>
-<dd>A list of element names and their corresponding four-character codes as name-code pairs, e.g. <code>["documents", "docu"]</code>. Note that this list should be identical to the <code>Classes</code> list, except that each element name should be the plural form of the corresponding class name.</dd>
-
-<dt>Commands</dt>
-<dd>A list of command names and their corresponding eight-character codes, followed by a list of keyword argument names and their corresponding four-character codes as name-code pairs, e.g. <code>["make", "corecrel", [["new", "kocl"],...]]</code>.</dd>
-</dl>
-
-<p>You can edit any of the five terminology lists as needed, e.g. to add missing class and element definitions, to correct faulty four-character codes, etc. (Make sure any changes are correctly formatted as appscript doesn't perform any special error checking when reading data from this module.) Once the changes are complete, place the module file somewhere on Ruby's module search path (e.g. in <code>/usr/lib/ruby/site_ruby/1.8</code>) so it can be imported into scripts when needed.</p>
-
-<p>To use a terminology module, first import it as normal. Then, when creating a new application object for the problem application, pass this module to the constructor call as its second argument (or first argument if it's the <code>current</code> constructor). For example:</p>
-
-<pre><code>require "appscript"
-require "ical_terms"
-
-ical = Appscript.app('iCal', ICalTerminology)
-...</code></pre>
-
-<p>Finally, remember to file a bug report with the application's developer so that they can fix the problem in a future release!</p>
-
-
-
-
-<h2><a name="non_stay_open_applications">Scripting non-stay-open applications</h2>
-
-<p>When scripting AppleScript applets and other applications that take only a single <code>run</code> or <code>open</code> event, scripts must take some additional steps to avoid problems:<p>
-
-<ol>
-<li>When creating an application object, the <code>:terms</code> argument must be <code>false</code>. This will prevent appscript from repeatedly starting the application in an (unsuccessful) attempt to retrieve its terminology.</li>
-
-<li>When sending an <code>open</code> event, the application must first be started using the <code>launch</code> command to avoid it receiving the usual <code>run</code> event upon start-up.</li>
-
-<li>Since non-stay-open applications don't reply to commands, the <code>run</code>/<code>open</code> command's <code>:wait_reply</code> argument must be <code>false</code> to prevent appscript waiting for a non-existent response.</li>
-</ol>
-
-<p>Examples:</p>
-
-<pre><code>require "appscript"
-
-# Run
-Appscript.app('Foo', false).run(:wait_reply => false)
-
-# Open
-bar = Appscript.app('Bar', false)
-bar.launch
-bar.open([MacFile::Alias.path('/path/to/item 1'), ...], :wait_reply => false)</code></pre>
-
-
-
-</div>
-
-<!-- bottom navigation -->
-<div class="navbar">
-	<a href="13_performanceissues.html">Previous</a> | <a href="index.html">Up</a> | <a href="15_notes.html">Next</a>
-	
-</div>
-
-<!--footer-->
-<p class="footer">&copy; 2006 HAS</p>
-</body>
-</html>

data/misc/adobeunittypes.rb

@@ -1,14 +0,0 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
-
-AdobeUnitTypes = [
-	[:millimeters, "\x81MM\x8c"],
-	[:points, "\x81PS\x8c"],
-	[:picas, "\x81SP\x8c"],
-	[:traditional_points, "\x81PT\x8c"],
-	[:traditional_picas, "\x81PC\x8c"],
-	[:ciceros, "\x81CR\x8c"],
-	[:percent, "\x81PN\x8c"],
-	[:pixels, "\x81PX\x8c"],
-]

data/misc/dump.rb

@@ -1,72 +0,0 @@
-#!/usr/local/bin/ruby
-# Copyright (C) 2006 HAS. 
-# Released under MIT License.
-
-require "ae"
-require "aem"
-require "findapp"
-require "_appscript/terminology"
-
-if ARGV.length != 3
-	puts "dump.rb
-
-Outputs an application's terminology as a Ruby module file, suitable for use by AS::Application.
-
-Usage:
-
-	ruby  dump.rb  application-name-or-path  module-name  module-path
-
-Example:
-
-	ruby  dump.rb  Address\ Book  AddressBook  ~/addressbook_terms.rb"
-	
-	exit
-end
-
-app_path = FindApp.by_name(ARGV[0])
-module_name = ARGV[1]
-out_path = ARGV[2]
-
-if not /^[A-Z][A-Za-z0-9_]*$/ === module_name
-	raise RuntimeError, "Invalid module name."
-end
-
-File.open(out_path, "w") do |f|
-	# Get aete(s)
-	begin
-		aetes = AEM::Codecs.new.unpack(AE.get_app_terminology(app_path).coerce(KAE::TypeAEList))
-	rescue AE::MacOSError => e
-		if  e.to_i == -192 # aete resource not found
-			raise RuntimeError, "No terminology found."
-		else
-			raise
-		end
-	end
-	
-	# Parse aete(s) into intermediate tables, suitable for use by Terminology#tables_for_module
-	tables = TerminologyParser.build_tables_for_aetes(aetes)
-	
-	# Write module code
-	f.puts "module #{module_name}"
-	f.puts "\tVersion = 1.1"
-	f.puts "\tPath = #{app_path.inspect}"
-	f.puts
-	(["Classes", "Enumerators", "Properties", "Elements"].zip(tables[0,4])).each do |name, table|
-		f.puts "\t#{name} = ["
-		table.sort.each do |item|
-			f.puts "\t\t#{item.inspect},"
-		end
-		f.puts "\t]"
-		f.puts
-	end
-	f.puts "\tCommands = ["
-	tables[4].sort.each do |name, code, params|
-		f.puts "\t\t[#{name.inspect}, #{code.inspect}, ["
-			params.each do |item|
-				f.puts "\t\t\t#{item.inspect},"
-			end
-		f.puts "\t\t]],"
-	end
-	f.puts "\t]"
-	f.puts "end"
-end