rb-appscript 0.2.0 → 0.2.1

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

@@ -29,7 +29,7 @@
 
 <p>Both direct and keyword parameters are optional.</p>
 
-<p>Application commands are implemented by the application's top-level <code>application</code> object (represented by an <code>AS::Application</code> instance). For convenience, appscript also makes application commands available as methods on every reference. If a command is called upon a reference rather than an Application object, that reference will be taken as the application's direct parameter (with one or two caveats; see the Special Cases section below).</p>
+<p>Application commands are implemented by the application's top-level <code>application</code> object (represented by an <code>Appscript::Application</code> instance). For convenience, appscript also makes application commands available as methods on every reference. If a command is called upon a reference rather than an Application object, that reference will be taken as the application's direct parameter (with one or two caveats; see the Special Cases section below).</p>
 
 <p>The command's direct parameter can be any value; the application's dictionary will (usually) indicate the appropriate types. A command can have a maximum of one direct parameter; if more than one is given, an error will occur. Keyword parameters are specified as a <code>Hash</code> object whose keys are symbols representing the parameter names:</p>
 
@@ -83,25 +83,25 @@
 <h2>Examples</h2>
 
 <pre><code># tell application &quot;TextEdit&quot; to activate
-AS.app('TextEdit').activate
+app('TextEdit').activate
 
 # tell application &quot;TextEdit&quot; to open fileRefList
-AS.app('TextEdit').open(fileRefList)
+app('TextEdit').open(fileRefList)
 
 # tell application &quot;Finder&quot; to get version
-AS.app('Finder').version.get
+app('Finder').version.get
 
 # tell application &quot;Finder&quot; to set name of file &quot;foo.txt&quot; of home to &quot;bar.txt&quot;
-AS.app('Finder').home.files['foo.txt'].name.set('bar.txt')
+app('Finder').home.files['foo.txt'].name.set('bar.txt')
 
 # tell application &quot;TextEdit&quot; to count (text of first document) each paragraph
-AS.app('TextEdit').documents.first.text.count(:each =&gt; :paragraph)
+app('TextEdit').documents.first.text.count(:each =&gt; :paragraph)
 
 # tell application &quot;TextEdit&quot; to make new document at end of documents
-AS.app('TextEdit').documents.end.make(:new =&gt; :document)
+app('TextEdit').documents.end.make(:new =&gt; :document)
 
 # tell application &quot;Finder&quot; to get items of home as alias list
-AS.app('Finder').home.items.get(:result_type =&gt; :alias)</code></pre>
+app('Finder').home.items.get(:result_type =&gt; :alias)</code></pre>
 
 
 
@@ -155,13 +155,13 @@ AS.app('Finder').home.items.get(:result_type =&gt; :alias)</code></pre>
 
 <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>
 
-<pre><code>foo = AS.app('Finder').disks</code></pre>
+<pre><code>foo = app('Finder').disks</code></pre>
 
 <p>is <em>not</em> equivalent to:</p>
 
 <pre><code>set foo to disks of application &quot;Finder&quot;</code></pre>
 
-<p>even though the two may look similar. In the first case, the value assigned to variable <code>foo</code> is a reference, <code>AS.app('Finder').disks</code>. In the second, AppleScript evaluates the <code>disks of application &quot;Finder&quot;</code> reference by performing an implicit <code>get</code> command before assigning the result, a <em>list</em> containing one or more references (one to each disk currently mounted), to variable <code>foo</code>. To assign an unresolved reference to a variable in AppleScript, the reference must be preceded by the <code>a reference to</code> operator. For example:</p>
+<p>even though the two may look similar. In the first case, the value assigned to variable <code>foo</code> is a reference, <code>app('Finder').disks</code>. In the second, AppleScript evaluates the <code>disks of application &quot;Finder&quot;</code> reference by performing an implicit <code>get</code> command before assigning the result, a <em>list</em> containing one or more references (one to each disk currently mounted), to variable <code>foo</code>. To assign an unresolved reference to a variable in AppleScript, the reference must be preceded by the <code>a reference to</code> operator. For example:</p>
 
 <ul>
 <li><p>Getting a reference to all disks:</p>
@@ -170,9 +170,9 @@ AS.app('Finder').home.items.get(:result_type =&gt; :alias)</code></pre>
 return foo
 --&gt; a reference to every disk of application &quot;Finder&quot;</code></pre>
 
-<pre><code>foo = AS.app('Finder').disks
+<pre><code>foo = app('Finder').disks
 print foo
---&gt; AS.app('Finder').disks</code></pre></li>
+--&gt; app('Finder').disks</code></pre></li>
 
 
 <li><p>Getting a list of references to each disk:</p>
@@ -181,9 +181,9 @@ print foo
 return foo
 --&gt; {disk &quot;Mac HD&quot; of application &quot;Finder&quot;, disk &quot;ZIP-100&quot; of application &quot;Finder&quot;}</code></pre>
 
-<pre><code>foo = AS.app('Finder').disks.get
+<pre><code>foo = app('Finder').disks.get
 print foo
---&gt; [AS.app('Finder').disks['Mac HD'], AS.app('Finder').disks['ZIP-100']]</code></pre>
+--&gt; [app('Finder').disks['Mac HD'], app('Finder').disks['ZIP-100']]</code></pre>
 
 </li>
 </ul>

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

@@ -28,11 +28,11 @@
 
 <pre><code># tell application "Finder" to get name of every folder of home
 
-AS.app('Finder').get(AS.app.home.folders.name)</code></pre>
+app('Finder').get(app.home.folders.name)</code></pre>
 
 <p>Note that if the direct parameter is omitted from the argument list, the reference that the command is invoked on is used instead. For example, the above example would normally be written as:</p>
 
-<pre><code>AS.app('Finder').home.folders.name.get</code></pre>
+<pre><code>app('Finder').home.folders.name.get</code></pre>
 
 
 <h2><code>set</code></h2>
@@ -41,7 +41,7 @@ AS.app('Finder').get(AS.app.home.folders.name)</code></pre>
 
 <pre><code># tell application "TextEdit" to set text of document 1 to "Hello World"
 
-AS.app('TextEdit').documents[1].text.set('Hello World')</code></pre>
+app('TextEdit').documents[1].text.set('Hello World')</code></pre>
 
 
 <h2><code>count</code></h2>
@@ -50,13 +50,13 @@ AS.app('TextEdit').documents[1].text.set('Hello World')</code></pre>
 
 <pre><code># tell application "TextEdit" to count words of document 1
 
-AS.app('TextEdit').documents[1].words.count</code></pre>
+app('TextEdit').documents[1].words.count</code></pre>
 
 <p>Count the items in the current user's home folder:</p>
 
 <pre><code>#tell application "Finder" to count items of home
 
-AS.app('Finder').home.count(:each =&gt; :item)</code></pre>
+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>
 
@@ -68,7 +68,7 @@ AS.app('Finder').home.count(:each =&gt; :item)</code></pre>
 <pre><code># tell application "TextEdit" to make new document &not;
 #     with properties {text:"Hello World\n"}
 
-AS.app('TextEdit').make(
+app('TextEdit').make(
     :new =&gt; :document,
     :with_properties =&gt; {:text =&gt; "Hello World\n"})</code></pre>
 
@@ -78,14 +78,14 @@ AS.app('TextEdit').make(
 #     at end of text of document 1 &not;
 #     with properties {text:"Yesterday\nToday\nTomorrow\n"}
 
-AS.app('TextEdit').make(
+app('TextEdit').make(
     :new =&gt; :paragraph,
-    :at =&gt; AS.app.documents[1].text.end,
+    :at =&gt; app.documents[1].text.end,
     :with_data =&gt; "Yesterday\nToday\nTomorrow\n")</code></pre>
 
 <p>Note that the <code>make</code> command's <code>at</code> parameter can be omitted for convenience, in which case the reference that the command is invoked on is used instead:</p>
 
-<pre><code>AS.app('TextEdit').documents[1].text.end.make(
+<pre><code>app('TextEdit').documents[1].text.end.make(
     :new =&gt; :paragraph,
     :with_data =&gt; "Yesterday\nToday\nTomorrow\n")</code></pre>
 
@@ -97,8 +97,8 @@ AS.app('TextEdit').make(
 <pre><code># tell application "Finder" to &not;
 #     duplicate folder "Projects" of home to disk "Work" with replacing
 
-AS.app('Finder').home.folders['Projects'].duplicate(
-    :to =&gt; AS.app.disks['Backup'], :replacing =&gt; true)</code></pre>
+app('Finder').home.folders['Projects'].duplicate(
+    :to =&gt; app.disks['Backup'], :replacing =&gt; true)</code></pre>
 
 
 <h2><code>add</code></h2>
@@ -109,9 +109,9 @@ AS.app('Finder').home.folders['Projects'].duplicate(
 #     every person whose birth date is not missing value &not;
 #     to group "Birthdays"
 
-AS.app('Address Book').people[
-    AS.its.birth_date.ne(:missing_value)
-    ].add(:to =&gt; AS.app.groups['Birthdays'])</code></pre>
+app('Address Book').people[
+    its.birth_date.ne(:missing_value)
+    ].add(:to =&gt; app.groups['Birthdays'])</code></pre>
 
 
 

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

@@ -37,7 +37,8 @@
 <h2>The iterative OO-style approach</h2>
 
 <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
 
 desiredEmail = 'sam.brown@foo.com'
 
@@ -57,9 +58,10 @@ p foundNames</code></pre>
 
 <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>
 
+include Appscript
 
-desiredEmail = 'sam.brown@foo.com'
-        AS.its.emails.value.contains(desiredEmail)
+desiredEmail = 'sam.brown@foo.com'
+        its.emails.value.contains(desiredEmail)
         ].name.get</code></pre>
 
 <p>To explain:</p>
@@ -78,16 +80,17 @@ desiredEmail = 'sam.brown@foo.com'
 <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>
 
 <pre><code>require "appscript"
+include Appscript
 
 desiredDomain = 'foo.com'
 
 domainPattern = Regexp.new(Regexp.escape('@'+desiredDomain) + '$')
 
 # get a list of name strings
-names = AS.app('Address Book').people.name.get
+names = app('Address Book').people.name.get
 
 # a list of lists of email strings
-emailsOfEveryPerson = AS.app('Address Book').people.emails.value.get
+emailsOfEveryPerson = app('Address Book').people.emails.value.get
 
 result = []
 names.zip(emailsOfEveryPerson).each do |name, emails|

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

@@ -50,7 +50,7 @@
 
 <p>For example:</p>
 
-<pre><code>aem_ref = AS.app('TextEdit').documents[1].text.AS_aem_reference
+<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')
@@ -144,7 +144,7 @@ end</code></pre>
 <pre><code>require "appscript"
 require "ical_terms"
 
-ical = AS.app('iCal', ICalTerminology)
+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>
@@ -167,13 +167,12 @@ ical = AS.app('iCal', ICalTerminology)
 <p>Examples:</p>
 
 <pre><code>require "appscript"
-require "macfile"
 
 # Run
-AS.app('Foo', false).run(:wait_reply => false)
+Appscript.app('Foo', false).run(:wait_reply => false)
 
 # Open
-bar = AS.app('Bar', false)
+bar = Appscript.app('Bar', false)
 bar.launch
 bar.open([MacFile::Alias.path('/path/to/item 1'), ...], :wait_reply => false)</code></pre>
 

data/doc/mactypes-manual/index.html

@@ -37,21 +37,29 @@
 <pre><code>Alias -- a persistent reference to a filesystem object
     Constructors:
 
-        Alias.path(path) -- make Alias object from POSIX path
+        Alias.path(path) -- make Alias object from POSIX path string
+
+        Alias.url(url) -- make Alias object from a local file:// URL string
     
         Alias.desc(desc) -- make Alias object from an AE::AEDesc
                             of TypeAlias
 
     Methods:
+
+        ==
+
+        hash
+    
+        inspect
     
         path -- returns POSIX path string to the object's current location
 
+        url -- returns file:// URL string to the object's current location
+
         desc -- returns AE::AEDesc of TypeAlias
 
         to_s -- synonym for #path
     
-        inspect -- returns string representation of Alias object
-    
         to_alias -- returns self
     
         to_file_url -- returns a MacTypes::FileURL object</code></pre>
@@ -66,10 +74,13 @@ f = MacTypes::Alias.path('/Users/foo/some file')
 puts f.to_s
 # /Users/foo/some file
 
+puts f.url
+# file://localhost/Users/foo/some%20file
+
 puts f.inspect
 # MacTypes::Alias.path("/Users/foo/some file")
 
-AS.app('TextEdit').open(f)
+Appscript.app('TextEdit').open(f)
 # opens document in TextEdit</code></pre>
 
 
@@ -88,7 +99,9 @@ AS.app('TextEdit').open(f)
 <pre><code>FileURL -- identifies a fixed filesystem location
     Constructors:
 
-        FileURL.path(path) -- make FileURL object from POSIX path
+        FileURL.path(path) -- make FileURL object from POSIX path string
+
+        FileURL.url(url) -- make FileURL object from a local file:// URL string
     
         FileURL.desc(desc) -- make FileURL object from an AE::AEDesc
                               of TypeFSS, TypeFSRef or TypeFileURL
@@ -99,14 +112,16 @@ AS.app('TextEdit').open(f)
 
         hash
     
+        inspect
+    
         path -- returns POSIX path string
 
+        url -- returns file:// URL string
+
         desc -- returns AE::AEDesc of TypeFSRef, TypeFSS or TypeFileURL
 
         to_s -- synonym for #path
     
-        inspect -- returns string representation of FileURL object
-    
         to_alias -- returns a MacTypes::Alias object
     
         to_file_url -- returns a new MacTypes::FileURL object</code></pre>
@@ -121,10 +136,13 @@ f = MacTypes::FileURL.path('/Users/foo/new file')
 puts f.to_s
 # /Users/foo/new file
 
+puts f.url
+# file://localhost/Users/foo/some%20file
+
 puts f.inspect
 # MacTypes::FileURL.path("/Users/foo/new file")
 
-AS.app('TextEdit').documents[1].save(:in => f)
+Appscript.app('TextEdit').documents[1].save(:in => f)
 # saves front TextEdit document at the given location</code></pre>
 
 
@@ -140,7 +158,7 @@ file_url = MacTypes::FileURL.path('/Users/foo/new file')
 
 fs_spec = file_url.desc.coerce(KAE::TypeFSS)
 
-AS.app('older app').documents[1].save(:in => fs_spec)</code></pre>
+Appscript.app('older app').documents[1].save(:in => fs_spec)</code></pre>
 
 <p>When used in an application command, a <code>FileURL</code> object returned by appscript will always pack into the same <code>TypeFSRef</code>, <code>TypeFileURL</code> or <code>TypeFSS</code> AEDesc it was created from. A <code>FileURL</code> object returned by <code>FileURL.path</code>, <code>Alias#to_file_url</code> or <code>FileURL#to_file_url</code> will always pack into an AEDesc of <code>TypeFileURL</code>.</p>
 

data/doc/osax-manual/index.html

@@ -135,7 +135,7 @@ p sa.commands
 sa.beep
 
 p sa.path_to(:scripts_folder)
-# Result: MacFile::Alias.at("/Users/foo/Library/Scripts/")
+# Result: MacTypes::Alias.at("/Users/foo/Library/Scripts/")
 
 p sa.display_dialog("Ruby says hello!",
                     :buttons=>["Hi!", "Howdy!", "Duuuude!"],

data/rb-appscript.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |s|
 	s.name = "rb-appscript"
-	s.version = "0.2.0"
+	s.version = "0.2.1"
 	s.author = "HAS"
 	s.homepage = "http://rb-appscript.rubyforge.org/"
 	s.rubyforge_project="rb-appscript"

data/sample/AB_list_people_with_emails.rb

@@ -3,6 +3,7 @@
 # Lists the name and email(s) of every person in Address Book with one or more email addresses.
 
 require "appscript"
+include Appscript
 
-people_ref = AS.app('Address Book').people[AS.its.emails.ne([])]
+people_ref = app('Address Book').people[its.emails.ne([])]
 p people_ref.name.get.zip(people_ref.emails.value.get)

data/sample/Create_daily_iCal_todos.rb

@@ -26,8 +26,9 @@
 
 
 require "appscript"
+include Appscript
 
-ICal = AS.app("iCal")
+ICal = app("iCal")
 
 # The calendar in which recurring todo items should appear:
 ToDoCalendarName = "Personal"
@@ -38,8 +39,8 @@ def create_to_do(summary_text)
     midnight = Time.local(now.year(), now.month(), now.day())
     to_dos = ICal.calendars[ToDoCalendarName].todos
     # don't create an item if it already exists for today!
-    if to_dos[AS.its.due_date.ge(midnight).and(
-            AS.its.summary.eq(summary_text))].count < 1
+    if to_dos[its.due_date.ge(midnight).and(
+            its.summary.eq(summary_text))].count < 1
         to_dos.end.make(:new=>:todo, :with_properties=>{
                 :due_date=>midnight, :summary=>summary_text})
     end

data/sample/Hello_world.rb

@@ -3,7 +3,8 @@
 # Hello world in TextEdit.
 
 require "appscript"
+include Appscript
 
-te = AS.app('TextEdit')
+te = app('TextEdit')
 te.activate
 te.documents.end.make(:new => :document, :with_properties => {:text => "Hello World!\n"})

data/sample/List_iTunes_playlist_names.rb

@@ -3,5 +3,6 @@
 # List names of playlists in iTunes.
 
 require "appscript"
+include Appscript
 
-p AS.app('iTunes').sources[1].user_playlists.name.get
+p app('iTunes').sources[1].user_playlists.name.get

data/sample/Make_Mail_message.rb

@@ -3,6 +3,7 @@
 # Compose an outgoing message in Apple's Mail.app.
 
 require "appscript"
+include Appscript
 
 def make_message(addresses, subject, content, show_window=false)
 	# Make an outgoing message in Mail.
@@ -11,7 +12,7 @@ def make_message(addresses, subject, content, show_window=false)
 	# 	content : unicode -- the message content
 	# 	show_window : Boolean -- show message window in Mail
 	# Result : reference -- reference to the new outgoing message
-	mail = AS.app('Mail')
+	mail = app('Mail')
 	msg = mail.make(
 			:new => :outgoing_message, 
 			:with_properties => {:visible => show_window})

data/sample/Open_file_in_TextEdit.rb

@@ -3,7 +3,8 @@
 # Opens a file in TextEdit. (Demonstrates mactypes module usage.)
 
 require "appscript"
+include Appscript
 
-te = AS.app('TextEdit')
+te = app('TextEdit')
 te.activate
 te.open(MacTypes::Alias.path('/Users/USERNAME/ReadMe.txt'))