RubyGems - rb-appscript - Versions diffs - 0.5.1 → 0.5.2 - Mend

rb-appscript 0.5.1 → 0.5.2

Files changed (61) hide show

data/CHANGES +30 -0
data/LICENSE +1 -1
data/README +7 -3
data/TODO +7 -1
data/doc/aem-manual/01_introduction.html +23 -9
data/doc/aem-manual/02_apioverview.html +25 -11
data/doc/aem-manual/03_packingandunpackingdata.html +22 -17
data/doc/aem-manual/04_references.html +49 -36
data/doc/aem-manual/05_targettingapplications.html +25 -14
data/doc/aem-manual/06_buildingandsendingevents.html +47 -21
data/doc/aem-manual/07_findapp.html +22 -11
data/doc/aem-manual/08_examples.html +21 -10
data/doc/aem-manual/index.html +28 -12
data/doc/appscript-manual/01_introduction.html +40 -27
data/doc/appscript-manual/02_aboutappscripting.html +28 -15
data/doc/appscript-manual/03_quicktutorial.html +29 -16
data/doc/appscript-manual/04_gettinghelp.html +31 -16
data/doc/appscript-manual/05_keywordconversion.html +23 -10
data/doc/appscript-manual/06_classesandenums.html +32 -19
data/doc/appscript-manual/07_applicationobjects.html +31 -18
data/doc/appscript-manual/08_realvsgenericreferences.html +23 -11
data/doc/appscript-manual/09_referenceforms.html +33 -20
data/doc/appscript-manual/10_referenceexamples.html +30 -17
data/doc/appscript-manual/11_applicationcommands.html +25 -13
data/doc/appscript-manual/12_commandexamples.html +26 -15
data/doc/appscript-manual/13_performanceissues.html +46 -20
data/doc/appscript-manual/14_notes.html +29 -19
data/doc/appscript-manual/index.html +27 -11
data/doc/full.css +95 -9
data/doc/index.html +27 -10
data/doc/mactypes-manual/01_introduction.html +56 -0
data/doc/mactypes-manual/02_aliasclass.html +134 -0
data/doc/mactypes-manual/03_fileurlclass.html +136 -0
data/doc/mactypes-manual/04_unitsclass.html +102 -0
data/doc/mactypes-manual/index.html +26 -227
data/doc/osax-manual/01_introduction.html +69 -0
data/doc/osax-manual/02_interface.html +149 -0
data/doc/osax-manual/03_examples.html +75 -0
data/doc/osax-manual/04_notes.html +80 -0
data/doc/osax-manual/index.html +26 -195
data/doc/rb-appscript-logo.png +0 -0
data/rb-appscript.gemspec +2 -2
data/sample/TextEdit_demo.rb +1 -1
data/src/lib/_aem/aemreference.rb +1 -1
data/src/lib/_aem/codecs.rb +42 -8
data/src/lib/_aem/connect.rb +3 -1
data/src/lib/_aem/findapp.rb +1 -1
data/src/lib/_aem/mactypes.rb +1 -1
data/src/lib/_aem/send.rb +162 -142
data/src/lib/_aem/typewrappers.rb +2 -2
data/src/lib/_appscript/defaultterminology.rb +76 -46
data/src/lib/_appscript/referencerenderer.rb +1 -1
data/src/lib/_appscript/reservedkeywords.rb +2 -2
data/src/lib/_appscript/safeobject.rb +1 -1
data/src/lib/_appscript/terminology.rb +30 -19
data/src/lib/aem.rb +1 -6
data/src/lib/appscript.rb +65 -20
data/src/lib/osax.rb +21 -18
data/src/rbae.c +1 -1
data/test/test_appscriptcommands.rb +1 -1
metadata +12 -3

data/doc/appscript-manual/11_applicationcommands.html CHANGED

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<title>appscript | 11. Application Commands</title>
+<title>rb-appscript manual | 11. Application Commands</title>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 <style type="text/css" media="all"><!--@import url(../full.css);--></style>
@@ -10,18 +10,28 @@
 </head>
 <body>
-<h1>11. Application Commands</h1>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
 <!-- top navigation -->
 <div class="navbar">
-	<a href="10_referenceexamples.html">Previous</a> | <a href="index.html">Up</a> | <a href="12_commandexamples.html">Next</a>
+<a href="10_referenceexamples.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="12_commandexamples.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
 </div>
 <!-- content -->
 <div id="content">
-<h2>Command syntax</h2>
+<h2>11. Application Commands</h2>
+<h3>Command syntax</h3>
 <p>Appscript commands have the following syntax:</p>
@@ -80,7 +90,7 @@
 <p>See the Special cases section below for additional rules.</p>
-<h2>Examples</h2>
+<h3>Examples</h3>
 <pre><code># tell application &quot;TextEdit&quot; to activate
 app('TextEdit').activate
@@ -105,7 +115,7 @@ app('Finder').home.items.get(:result_type =&gt; :alias)</code></pre>
-<h2>Special cases</h2>
+<h3>Special cases</h3>
 <p>The following special-case behaviours are implemented for convenience:</p>
@@ -156,7 +166,7 @@ app('Finder').home.items.get(:result_type =&gt; :alias)</code></pre>
 </ol>
-<h2>Note to AppleScript users</h2>
+<h3>Note to AppleScript users</h3>
 <p>Unlike AppleScript, which implicitly sends a <code>get</code> command to any unresolved application object references at the end of evaluating an expression, appscript only resolves a reference when it receives an appropriate command. For example:</p>
@@ -195,12 +205,14 @@ print d
 </div>
 <!-- bottom navigation -->
-<div class="navbar">
-	<a href="10_referenceexamples.html">Previous</a> | <a href="index.html">Up</a> | <a href="12_commandexamples.html">Next</a>
+<div class="footer">
+<a href="10_referenceexamples.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="12_commandexamples.html">Next</a>
+<span>&copy; 2006-2008 HAS</span>
 </div>
-<!--footer-->
-<p class="footer">&copy; 2006-2008 HAS</p>
 </body>
 </html>

data/doc/appscript-manual/12_commandexamples.html CHANGED

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<title>appscript | 12. Command Examples</title>
+<title>rb-appscript manual | 12. Command Examples</title>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 <style type="text/css" media="all"><!--@import url(../full.css);--></style>
@@ -10,19 +10,28 @@
 </head>
 <body>
-<h1>12. Command Examples</h1>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
 <!-- top navigation -->
 <div class="navbar">
-	<a href="11_applicationcommands.html">Previous</a> | <a href="index.html">Up</a> | <a href="13_performanceissues.html">Next</a>
+<a href="11_applicationcommands.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="13_performanceissues.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
 </div>
 <!-- content -->
 <div id="content">
+<h2>12. Command Examples</h2>
-<h2><code>get</code></h2>
+<h3><code>get</code></h3>
 <p>Get the name of every folder in the user's home folder:</p>
@@ -35,7 +44,7 @@ app('Finder').get(app.home.folders.name)</code></pre>
 <pre><code>app('Finder').home.folders.name.get</code></pre>
-<h2><code>set</code></h2>
+<h3><code>set</code></h3>
 <p>Set the content of a TextEdit document:</p>
@@ -44,7 +53,7 @@ app('Finder').get(app.home.folders.name)</code></pre>
 app('TextEdit').documents[1].text.set('Hello World')</code></pre>
-<h2><code>count</code></h2>
+<h3><code>count</code></h3>
 <p>Count the words in a TextEdit document:</p>
@@ -61,7 +70,7 @@ app('Finder').home.count(:each =&gt; :item)</code></pre>
 <p>(Note that the <code>each</code> parameter is required in Finder's <code>count</code> command.)</p>
-<h2><code>make</code></h2>
+<h3><code>make</code></h3>
 <p>Create a new TextEdit document:</p>
@@ -90,7 +99,7 @@ app('TextEdit').make(
     :with_data =&gt; "Yesterday\nToday\nTomorrow\n")</code></pre>
-<h2><code>duplicate</code></h2>
+<h3><code>duplicate</code></h3>
 <p>Duplicate a folder to a disk, replacing an existing item if one exists:</p>
@@ -101,7 +110,7 @@ app('Finder').home.folders['Projects'].duplicate(
     :to =&gt; app.disks['Backup'], :replacing =&gt; true)</code></pre>
-<h2><code>add</code></h2>
+<h3><code>add</code></h3>
 <p>Add every person with a known birthday to a group named "Birthdays":</p>
@@ -118,12 +127,14 @@ app('Address Book').people[
 </div>
 <!-- bottom navigation -->
-<div class="navbar">
-	<a href="11_applicationcommands.html">Previous</a> | <a href="index.html">Up</a> | <a href="13_performanceissues.html">Next</a>
+<div class="footer">
+<a href="11_applicationcommands.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="13_performanceissues.html">Next</a>
+<span>&copy; 2006-2008 HAS</span>
 </div>
-<!--footer-->
-<p class="footer">&copy; 2006-2008 HAS</p>
 </body>
 </html>

data/doc/appscript-manual/13_performanceissues.html CHANGED

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<title>appscript | 13. Performance Issues</title>
+<title>rb-appscript manual | 13. Performance Issues</title>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 <style type="text/css" media="all"><!--@import url(../full.css);--></style>
@@ -10,17 +10,28 @@
 </head>
 <body>
-<h1>13. Performance Issues</h1>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
 <!-- top navigation -->
 <div class="navbar">
-	<a href="12_commandexamples.html">Previous</a> | <a href="index.html">Up</a> | <a href="14_notes.html">Next</a>
+<a href="12_commandexamples.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="14_notes.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
 </div>
 <!-- content -->
 <div id="content">
-<h2>About performance</h2>
+<h2>13. Performance Issues</h2>
+<h3>About performance</h3>
 <p>Application scripting is subject to a number of potential performance bottlenecks:</p>
@@ -34,33 +45,46 @@
 <p>Fortunately, it's often possible to minimise performance overheads by using fewer commands to do more work. Let's consider a typical example: obtaining the name of every person in <code>Address Book.app</code> who has a particular email address. There are several possible solutions to this, each with very different performance characteristics:</p>
-<h2>The iterative OO-style approach</h2>
+<h3>The iterative OO-style approach</h3>
 <p>While iterating over application objects and manipulating each in turn is a common technique, it's also the slowest by far:</p>
-include Appscript
+<pre><code>require "appscript"
+include Appscript
 desiredEmail = 'sam.brown@foo.com'
-foundNames = []
    person.emails.get.each do |email|
        if email.value.get == desiredEmail
            foundNames.push(person.name.get)
+foundNames = []
+app('Address Book').people.get.each do |person|
+    person.emails.get.each do |email|
+        if email.value.get == desiredEmail
+            foundNames.push(person.name.get)
         end
     end
 end
-p foundNames</code></pre>
+p foundNames</code></pre>
 <p>The above script sends one Apple event to get a list of references to all people, then one Apple event for each person to get a list of references to their emails, then one Apple event for each of those emails. Thus the time taken increases directly in proportion to the number of people in Address Book. If there's hundreds of people to search, that's hundreds of Apple events to be built, sent and individually resolved, and performance suffers as a result.</p>
 <p>The solution, where possible, is to use fewer, more sophisticated commands to do the same job.</p>
-<h2>The smart query-oriented approach</h2>
+<h3>The smart query-oriented approach</h3>
 <p>While there are some situations where iterating over and manipulating each application object individually is the only option (for example, when setting a property in each object to a different value), in this case there is plenty of room for improvement. Depending on how well an application implements its AEOM support, it's possible to construct queries that identify more than one application object at a time, allowing a single command to manipulate multiple objects in a single operation.</p>
 <p>In this case, the entire search can be performed using a single complex query sent to Address Book via a single Apple event:</p>
+<pre><code>require "appscript"
 include Appscript
-desiredEmail = 'sam.brown@foo.com'
+desiredEmail = 'sam.brown@foo.com'
+p app('Address Book').people[
         its.emails.value.contains(desiredEmail)
         ].name.get</code></pre>
@@ -75,7 +99,7 @@ desiredEmail = 'sam.brown@foo.com'
 </ul>
-<h2>The hybrid solution</h2>
+<h3>The hybrid solution</h3>
 <p>While AEOM queries can be surprisingly powerful, there are still many problems too complex for the application to evaluate entirely by itself. For example, let's say that you want to obtain the name of every person who has an email addresses that uses a particular domain name. Unfortunately, this test is too complex to express as a single AEOM query; however, it can still be solved reasonably efficiently by obtaining all the data from the application up-front and processing it locally. For this we need: 1. the name of every person in the Address Book, and 2. each person's email addresses. Fortunately, each of these can be expressed in a single query, allowing all this data to be retrieved using just two <code>get</code> commands.</p>
@@ -107,12 +131,14 @@ p result</code></pre>
 </div>
 <!-- bottom navigation -->
-<div class="navbar">
-	<a href="12_commandexamples.html">Previous</a> | <a href="index.html">Up</a> | <a href="14_notes.html">Next</a>
+<div class="footer">
+<a href="12_commandexamples.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="14_notes.html">Next</a>
+<span>&copy; 2006-2008 HAS</span>
 </div>
-<!--footer-->
-<p class="footer">&copy; 2006-2008 HAS</p>
 </body>
 </html>

data/doc/appscript-manual/14_notes.html CHANGED

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<title>appscript | 14. Notes</title>
+<title>rb-appscript manual | 14. 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>
@@ -10,18 +10,27 @@
 </head>
 <body>
-<h1>14. Notes</h1>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
 <!-- top navigation -->
 <div class="navbar">
-	<a href="13_performanceissues.html">Previous</a> | <a href="index.html">Up</a>
+<a href="13_performanceissues.html">Previous</a> &bull;
+<a href="index.html">Up</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
 </div>
 <!-- content -->
 <div id="content">
-<h2>Rubygems issues</h2>
+<h2>14. Notes</h2>
+<h3>Rubygems issues</h3>
 <p>If using the appscript gem, don't forget to <code>require 'rubygems'</code> <em>before</em> requiring appscript, otherwise the appscript gem won't load. For example:</p>
@@ -33,44 +42,44 @@ require 'appscript'
 ...</code></pre>
-<h2>Security issues</h2>
+<h3>Security issues</h3>
 <p>If including user names and/or passwords in remote application URLs, please note that appscript retains these URLs in both the <code>Terminology</code> module's internal cache and in the Application and Reference objects subsequently created from those URLs. Security here is the user's responsibility, as it's their code that creates and retains these objects.</p>
-<h2>GUI Scripting</h2>
+<h3>GUI Scripting</h3>
 <p>Non-scriptable applications may in some cases be controlled from Ruby by using System Events to manipulate their graphical user interface. Note that the &quot;Enable access for assistive devices&quot; checkbox must be selected in the Universal Access system preferences pane for GUI Scripting to work.</p>
-<h2>AEDescs</h2>
+<h3>AEDescs</h3>
 <p>Some applications (e.g. QuarkXpress) may return values which appscript cannot convert to equivalent Ruby types. These values are usually of types which are defined, used and understood only by that particular application, and will be represented in Ruby as raw <code>AE::AEDesc</code> objects (e.g. <code>#&lt;AE::AEDesc:0x33fc40&gt;</code>). While there's not much you can do with raw <code>AEDesc</code> objects within Ruby (it's best just to treat them as opaque types), subsequent commands can pass them back to the application for further use and/or conversion just like any other value.</p>
-<h2>Dealing with problem applications</h2>
+<h3>Dealing with problem applications</h3>
 <p>Appscript provides a number of mechanisms for dealing with problematic applications. See the <a href="http://rb-appscript.rubyforge.org">appscript website</a> for more information.</p>
-<h2>Credits</h2>
+<h3>Credits</h3>
 <p>Many thanks to Bill Birkett, Jordan Breeding, Fujimoto Hisakuni, Jordan K Hubbard, Alexander Kellett, Chris Nebel, Matt Neuburg, Laurent Sansonetti, Michelle Steiner, Kevin Van Vechten, and all the appscript users who've provided comments, criticisms and encouragement along the way.</p>
-<h2>Donations</h2>
+<h3>Donations</h3>
 <p>You can <a href="http://sourceforge.net/donate/index.php?group_id=175009">donate to the appscript project</a> via SourceForge.net. Special thanks to all those appscript users who have already contributed.</p>
-<h2>Website</h2>
+<h3>Website</h3>
 <p><a href="http://rb-appscript.rubyforge.org">http://rb-appscript.rubyforge.org</a></p>
-<h2>Copyright</h2>
+<h3>Copyright</h3>
-<p>(C) 2006 HAS -- hhas -at- users - sourceforge - net</p>
+<p>(C) 2006-2008 HAS -- hhas -at- users - sourceforge - net</p>
 <p>Appscript is released under the MIT License.</p>
@@ -78,12 +87,13 @@ require 'appscript'
 </div>
 <!-- bottom navigation -->
-<div class="navbar">
-	<a href="13_performanceissues.html">Previous</a> | <a href="index.html">Up</a>
+<div class="footer">
+<a href="13_performanceissues.html">Previous</a> &bull;
+<a href="index.html">Up</a>
+<span>&copy; 2006-2008 HAS</span>
 </div>
-<!--footer-->
-<p class="footer">&copy; 2006-2008 HAS</p>
 </body>
 </html>

data/doc/appscript-manual/index.html CHANGED

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-<title>appscript | Contents</title>
+<title>rb-appscript manual | Contents</title>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 <style type="text/css" media="all"><!--@import url(../full.css);--></style>
@@ -10,16 +10,28 @@
 </head>
 <body>
-<h1>Contents</h1>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
 <!-- top navigation -->
 <div class="navbar">
-	<a href="../index.html">Up</a> | <a href="01_introduction.html">Next</a>
+<a href="../index.html">Previous</a> &bull;
+<a href="../index.html">Up</a> &bull;
+<a href="01_introduction.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
 </div>
 <!-- content -->
-<div id="content"><ol>
+<div id="content">
+<h2>Contents</h2>
+<ol>
 	<li><a href="01_introduction.html">Introduction</a></li>
 	<li><a href="02_aboutappscripting.html">About Application Scripting</a></li>
 	<li><a href="03_quicktutorial.html">Quick Tutorial</a></li>
@@ -34,15 +46,19 @@
 	<li><a href="12_commandexamples.html">Command Examples</a></li>
 	<li><a href="13_performanceissues.html">Performance Issues</a></li>
 	<li><a href="14_notes.html">Notes</a></li>
-</ol></div>
+</ol>
+</div>
 <!-- bottom navigation -->
-<div class="navbar">
-	<a href="../index.html">Up</a> | <a href="01_introduction.html">Next</a>
+<div class="footer">
+<a href="../index.html">Previous</a> &bull;
+<a href="../index.html">Up</a> &bull;
+<a href="01_introduction.html">Next</a>
+<span>&copy; 2006-2008 HAS</span>
 </div>
-<!--footer-->
-<p class="footer">&copy; 2006-2008 HAS</p>
 </body>
 </html>