rb-appscript 0.2.0

data/sample/Open_file_in_TextEdit.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Opens a file in TextEdit. (Demonstrates mactypes module usage.)
+
+require "appscript"
+
+te = AS.app('TextEdit')
+te.activate
+te.open(MacTypes::Alias.path('/Users/USERNAME/ReadMe.txt'))

data/sample/Organize_Mail_messages.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# Set up a Mail mailbox folder for organising incoming emails from a 
+# particular sender.
+#
+# Based on an AppleScript by Michelle Steiner.
+#
+# To use: in Mail, select an incoming email message from the desired sender
+# (e.g. a mailing list), then run this script. The script will first make a
+# new mailbox folder for storing messages from this sender if one doesn't
+# already exist. It will then create a new Mail rule that automatically moves
+# incoming messages from this sender directly into this mailbox.
+
+require "appscript"
+
+mail = AS.app('Mail')
+
+# get the current selection in Mail and make sure it's an email message
+selection = mail.selection.get
+
+if  selection == [] or selection[0].class_.get != :message
+	puts "Please select a message and try again."
+	exit
+end
+
+# get a reference to the first selected message
+msg = selection[0]
+
+recipient = msg.to_recipients[1]
+address = recipient.address.get
+
+# determine the new mailbox's name based on the sender's name/address
+if recipient.name.exists
+	folder_name = recipient.name.get
+else
+	folder_name = /^[^@]*/.match(address)[0]
+end
+
+# make a new mailbox if one doesn't already exist
+if not mail.mailboxes[folder_name].exists
+	mail.mailboxes.end.make(:new=>:mailbox, :with_properties=>{
+			:name=>folder_name})
+end
+
+# make a new mail rule to move list messages to the mailbox
+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],
+			:stop_evaluating_rules=>true})
+	new_rule.make(:new=>:rule_condition, :with_properties=>{
+			:expression=>address,
+			:rule_type=>:to_header,
+			:qualifier=>:does_contain_value})
+	new_rule.enabled.set(true)
+end

data/sample/Print_folder_tree.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# Prints the sub-folder hierarchy of a given folder as a list of folder names indented according to depth.
+
+require "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'])

data/sample/Select_all_HTML_files.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Selects all .htm/.html files in the top Finder window.
+
+require "appscript"
+
+w = AS.app('Finder').Finder_windows[1].target.get
+w.files[AS.its.name_extension.is_in(['htm', 'html'])].select

data/sample/Set_iChat_status.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# Set iChat's status message to the name of the currently selected
+# iTunes track.
+#
+# Based on an AppleScript example from:
+# <http://developer.apple.com/cocoa/applescriptforapps.html>
+
+require "appscript"
+
+begin
+	track_name = AS.app("iTunes").current_track.name.get
+rescue AS::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)

data/sample/Simple_Finder_GUI_Scripting.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require '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')
+
+AS.app('Finder').activate
+se.keystroke('n', :using=>[:command_down, :option_down])
+se.keystroke('ruby')

data/sample/Stagger_Finder_windows.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+# Rearranges Finder windows diagonally across screen with title bars one above
+# another. (Could easily be adapted to work with any scriptable application
+# that uses standard window class terminology.)
+
+require "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
+
+# Move windows while preserving their original sizes
+window_list.reverse.each do |window|
+    x1, y1, x2, y2 = window.bounds.get
+    window.bounds.set([x, y, x2 - x1 + x, y2 - y1 + y])
+    x += offset
+    y += offset
+end

data/sample/TextEdit_demo.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+
+# Demonstrates various references and commands in action.
+
+require "appscript"
+
+textedit = AS.app('TextEdit') # get an application object for TextEdit
+
+
+# tell application "TextEdit" to activate
+textedit.activate
+
+
+# tell application "TextEdit" to make new document at end of documents
+textedit.documents.end.make(:new => :document)
+
+
+# tell application "TextEdit" to set text of document 1 to "Hello World\n"
+textedit.documents[1].text.set('Hello World\n')
+
+
+# tell application "TextEdit" to get a reference to every window
+p textedit.windows
+
+
+# tell application "TextEdit" to get a reference to document 1
+p textedit.documents
+
+
+# tell application "TextEdit" to get every document
+p textedit.documents.get
+
+
+# tell application "TextEdit" to get a reference to document 1
+p textedit.documents[1]
+
+
+# tell application "TextEdit" to get document 1
+p textedit.documents[1].get
+
+
+# tell application "TextEdit" to get window id 3210
+# p textedit.windows.ID(3210).get
+
+
+# tell application "TextEdit" to get a reference to text of document 1
+p textedit.documents[1].text
+
+
+# tell application "TextEdit" to get text of document 1
+p textedit.documents[1].text.get
+
+
+# tell application "TextEdit" to make new document at end of documents
+textedit.documents.end.make(:new => :document)
+
+
+# tell application "TextEdit" to set text of document 1 to "Happy Happy Joy Joy\n"
+textedit.documents[1].text.set("Happy Happy Joy Joy\n")
+
+
+# tell application "TextEdit" to get text of every document
+p textedit.documents.text.get
+
+
+# tell application "TextEdit" to count each word of text of document 1
+p textedit.documents[1].text.count(:each => :word)
+
+
+# tell application "TextEdit" to get words 3 thru -1 of document 1
+p textedit.documents[1].words[3, -1].get
+
+
+# tell application "TextEdit" to set size of character 1 of every word 
+#         of document 1 to 24
+textedit.documents[1].words.characters[1].size.set(24)
+
+
+# tell application "TextEdit" to set color of any word of document 1 to {65535, 0, 0}
+textedit.documents[1].words.any.color.set([65535, 0, 0])
+
+
+# tell application "TextEdit" to make new paragraph at 
+#         (after last paragraph of text of document 1) with data "Silly Rabbit\n"
+textedit.documents[1].text.paragraphs.last.after.make(
+        :new => :paragraph, :with_data => "Silly Rabbit\n")
+
+
+# tell application "TextEdit" to get paragraph after paragraph 1 of document 1
+p textedit.documents[1].paragraphs[1].next(:paragraph).get
+
+
+# tell application "TextEdit" to make new document at end of documents 
+#         with properties {text:"foo\nbar\n\n\nbaz\n\nfub\n"}
+textedit.documents.end.make(:new => :document, 
+        :with_properties => {:text => "foo\nbar\n\n\nbaz\n\nfub\n"})
+
+
+# tell application "TextEdit" to get every paragraph of text of document 1
+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
+
+
+# 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
+
+
+
+# The following examples don't work in TextEdit but will work in, 
+# for example, Tex-Edit Plus:
+#
+#  # 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
+#
+#
+#  # 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

data/sample/iTunes_top40_to_html.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+# This script renders the track and album names of the  top 40 most played
+# iTunes tracks to an HTML file, then opens it in Safari.
+#
+# Requires the Amrita templating engine: http://amrita.sourceforge.jp
+
+require 'appscript'
+require 'osax'
+require "amrita/template"
+include Amrita
+
+# Amrita HTML template
+tmpl = TemplateText.new <<END
+<html>
+<head>
+<title> iTunes Top 40 Tracks</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<style type="text/css" media="all">
+	body {padding:0; margin:0;}
+	table {color:black; background-color:#448; width:100%; padding:2px;}
+	th, td {padding:2px; border-width:0;}
+	th {color:#fff; background-color:#114;}
+	td {color:black; background-color:#bbd;}
+</style>
+</head>
+<body>
+<table border="1">
+	<thead>
+	<tr><th>#</th><th>Track</th><th>Album</th></tr>
+	</thead>
+	<tbody>
+	<tr id="table_row"><td id="table_column"></td></tr>
+	</tbody>
+</table>
+</body>
+</html>
+END
+
+# Choose the file to write
+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
+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]
+
+# Assemble input data for Amrita
+data = {
+	:table_row=>top40.collect { |row_data| {:table_column=>row_data} }
+}
+
+# Render HTML file
+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.activate
+safari.open(out_file)
+
+