rb-scpt 1.0.0

data/extconf.rb

@@ -0,0 +1,65 @@
+# appscript install script
+# Based on RubyOSA extconf.rb
+# Original copyright below:
+#
+# Copyright (c) 2006, Apple Computer, Inc. All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1.  Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer. 
+# 2.  Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution. 
+# 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
+#     its contributors may be used to endorse or promote products derived
+#     from this software without specific prior written permission. 
+# 
+# THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'mkmf'
+require 'rbconfig'
+
+$CFLAGS << ' -Wall'
+$LDFLAGS << ' -framework Carbon -framework ApplicationServices'
+
+# Avoid `ID' and `T_DATA' symbol collisions between Ruby and Carbon.
+# (adapted code from RubyAEOSA - FUJIMOTO Hisakuni  <hisa -at- fobj - com>)
+
+maj, min = RUBY_VERSION.split('.')
+is_ruby_18 = (maj <= '1' and min.to_i < 9)
+if is_ruby_18
+	header_path = RbConfig::CONFIG['archdir']
+else
+	header_path = File.join(RbConfig::CONFIG['rubyhdrdir'], 'ruby')
+end
+ruby_h = File.join(header_path, 'ruby.h')
+intern_h = File.join(header_path, 'intern.h')
+new_filename_prefix = 'osx_'
+
+[ ruby_h, intern_h ].each do |src_path|
+    dst_fname = File.join('./src', new_filename_prefix + File.basename(src_path))
+    $stderr.puts "create #{File.expand_path(dst_fname)} ..."
+    File.open(dst_fname, 'w') do |dstfile|
+        IO.foreach(src_path) do |line|
+            line = line.gsub(/\bID\b/, 'RB_ID')
+            line = line.gsub(/\bT_DATA\b/, 'RB_T_DATA')
+            line = line.gsub(/\b(?:ruby\/)?intern.h\b/, "#{new_filename_prefix}intern.h")
+            line = line.gsub('#include "defines.h"', '#include "ruby/defines.h"') if not is_ruby_18
+            dstfile.puts line
+        end
+    end
+end
+
+create_makefile('ae', 'src')

data/rb-scpt.gemspec

@@ -0,0 +1,14 @@
+require "rubygems"
+
+Gem::Specification.new do |s|
+	s.name = "rb-scpt"
+	s.version = "1.0.0"
+	s.homepage = "https://github.com/BrendanThompson/rb-scpt"
+	s.summary="This is a fork of the original rb-appscript. Ruby AppleScript (rb-scpt) is a high-level, user-friendly Apple event bridge that allows you to control scriptable Mac OS X applications using ordinary Ruby scripts."
+	s.files = Dir["**/*"].delete_if { |name| ["MakeFile", "ae.bundle", "mkmf.log", "rbae.o", "SendThreadSafe.o", "src/osx_ruby.h", "src/osx_intern.h"].include?(name) }
+	s.extensions = "extconf.rb"
+	s.test_files = Dir["test/test_*.rb"]
+    s.authors = ["hhas","Brendan Thompson"]
+    s.email = 'brendan@btsystems.com.au'
+	s.required_ruby_version = ">= 1.8"
+end

data/sample/AB_export_vcard.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+# Exports all Address Book entries as vcards to current working folder.
+#
+# Files are named as 'NAME.vcard' (note: existing files will be overwritten).
+# If the name is missing, 'unknown' is used instead. If two or more people
+# share the same name, files will be named 'NAME.vcard', 'NAME 1.vcard',
+# 'NAME 2.vcard', etc.
+
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require 'appscript'
+include Appscript
+
+people = app('Address Book').people
+
+found_names = []
+people.name.get.zip(people.vcard.get).each do |name, vcard|
+	name = 'unknown' if name == ''
+	name = name.gsub('/', ':')
+	filename = "#{name}.vcard"
+	i = 1
+	while found_names.include?(filename.downcase)
+		filename = "#{name} #{i}.vcard"
+		i += 1
+	end
+	found_names.push(filename.downcase)
+	File.open(filename, 'w') { |f| f.puts vcard }
+end

data/sample/AB_list_people_with_emails.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# Lists the name and email(s) of every person in Address Book with
+# one or more email addresses.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+people_ref = app('Address Book').people[its.emails.ne([])]
+p people_ref.name.get.zip(people_ref.emails.value.get)

data/sample/Add_iCal_event.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+# Add an event to Home calendar that runs from 7am to 9 am tomorrow
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require 'appscript'
+include Appscript
+
+calendar_name = 'Home'
+t = Time.now + 60 * 60 * 24
+start = Time.local(t.year, t.month, t.day, 7)
+end_ = start + 60 * 60 * 2
+summary = 'First pants, then shoes.'
+
+app('iCal').calendars[calendar_name].events.end.make(
+        :new => :event, :with_properties => {
+                :start_date => start, 
+                :end_date => end_, 
+                :summary => summary})

data/sample/Create_daily_iCal_todos.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+# Creates daily recurring todo items in iCal.
+#
+# Ported from 'Create daily todos.scpt' by Alexander Kellett 
+# <http://web.mac.com/lypanov>
+#
+# While iCal makes it easy to create recurring events, it lacks a similar
+# feature for To Do items. This script can be used to create a daily checklist
+# of things to do.
+#
+# To begin, create a new calendar with the name "Shadow". Then, add a number
+# of recurring events to this calendar. All Daily To Dos events must be 
+# recurring events as only recurring events are converted to To Dos. Start and
+# end dates are ignored.
+#
+# Now, create a calendar called "Personal". When the script is run, all the
+# To Do items will be added to this calendar. Finally, set up a cron job to
+# run this script first thing every morning.
+#
+# See also:
+# <http://web.mac.com/lypanov/iWeb/Web/Diary/1EDF1B30-C4AF-4A99-BC4D-
+#  4A8AF14BFC96.html>
+# <http://web.mac.com/lypanov/iWeb/Web/Diary/9950DF91-726E-42B2-A639-
+#  1967D1DE7545.html>
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+ICal = app("iCal")
+
+# The calendar in which recurring todo items should appear:
+ToDoCalendarName = "Personal"
+    
+def create_to_do(summary_text)
+    # Adds To Dos to calendar "Personal"
+    now = Time.new
+    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[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
+end
+
+def get_label(recurrence, label)
+    match = Regexp.new("(?:^|;)#{label}=(.*?)(?:$|;)").match(recurrence)
+    return match ? match[1] : nil
+end
+
+weekday_code = ["SU", "MO", "TU", "WE", "TH", "FR", "SA"][Time.new.wday]
+events = ICal.calendars["Shadow"].events
+
+events.recurrence.get.zip(events.summary.get).each do |recurrence, summary|
+    recurs_on_this_weekday = false
+    frequency = get_label(recurrence, "FREQ")
+    case frequency
+        when "WEEKLY"
+            days = get_label(recurrence, "BYDAY")
+            if days and days.split(",").include?(weekday_code)
+                recurs_on_this_weekday = true
+            end
+        when "DAILY"
+            recurs_on_this_weekday = true
+    end
+    if recurs_on_this_weekday
+        puts summary
+        create_to_do(summary)
+    end
+end

data/sample/Export_Address_Book_phone_numbers.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+# Exports phone numbers from Address Book.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "osax"
+include Appscript, OSAX
+
+# create Application object for Address Book
+AB = app("Address Book")
+
+# prompt user for name of Address Book group to export from
+DefaultChoice = ["<All>"]
+
+groups = DefaultChoice + AB.groups.name.get
+choice = osax.choose_from_list(groups, :default_items => DefaultChoice)
+if choice == false # user cancelled
+	exit
+elsif choice == DefaultChoice
+	ref = AB
+else
+	ref = AB.groups[choice[0]]
+end
+
+# build a reference identifying those people with one or more phone numbers
+p = ref.people[its.phones.ne([])]
+
+# get first and last names for those people, replacing any :missing_value
+# entries with empty strings
+last_names = p.last_name.get.collect { |val| val.is_a?(String) ? val : "" }
+first_names = p.first_name.get.collect { |val| val.is_a?(String) ? val : "" }
+
+# get lists of phone numbers and locations for those people
+locations = p.phones.label.get
+numbers = p.phones.value.get
+
+# build an array containing each person's details:
+# [[last name, first name, locations, numbers], ...]
+people = last_names.zip(first_names, locations, numbers)
+
+# sort array by last and first name
+people.sort! do |a, b|
+	a[0,2].collect { |s| s.downcase } <=> b[0,2].collect { |s| s.downcase }
+end
+
+# print table
+puts " #{'_' * 70} "
+people.each do |last_name, first_name, locations, numbers|
+	name = [last_name, first_name].delete_if { |s| s == "" }.join(', ')
+	puts "|#{' ' * 70}|"
+	# print each phone number in turn
+	numbers.zip(locations).each do |number, location|
+		puts "| #{name.ljust(32)} #{number.ljust(20)} (#{(location + ')').ljust(13)} |"
+		name = ""
+	end
+	puts "|#{'_' * 70}|"
+end

data/sample/Hello_world.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+# 1. "Hello world" in TextEdit:
+
+require "appscript"
+include Appscript
+
+te = app('TextEdit')
+te.activate
+te.documents.end.make(:new => :document, :with_properties => {:text => "Hello World!\n"})
+
+
+# 2. "Hello world" using StandardAdditions:
+
+require "osax"
+include OSAX
+
+osax.display_dialog("Hello World")

data/sample/List_iTunes_playlist_names.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# List names of playlists in iTunes.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+p app('iTunes').sources[1].user_playlists.name.get

data/sample/Make_Mail_message.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+# Compose an outgoing message in Apple's Mail.app.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+def make_message(addresses, subject, content, show_window=false)
+	# Make an outgoing message in Mail.
+	# 	addresses : list of unicode -- a list of email addresses
+	# 	subject : unicode -- the message subject
+	# 	content : unicode -- the message content
+	# 	show_window : Boolean -- show message window in Mail
+	# Result : reference -- reference to the new outgoing message
+	mail = app('Mail')
+	msg = mail.make(
+			:new => :outgoing_message, 
+			:with_properties => {:visible => show_window})
+	addresses.each do |an_address|
+		msg.to_recipients.end.make(
+				:new => :recipient, 
+				:with_properties => {:address => an_address})
+	end
+	msg.subject.set(subject)
+	msg.content.set(content)
+	return msg
+end
+
+# test
+p make_message(['joe@foo.com', 'jane@bar.net'], 'Hello World', 'Some body text.', true)

data/sample/Open_file_in_TextEdit.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# Opens a file in TextEdit. (Demonstrates mactypes module usage.)
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+te = app('TextEdit')
+te.activate
+te.open(MacTypes::Alias.path('/Users/USERNAME/ReadMe.txt'))

data/sample/Organize_Mail_messages.rb

@@ -0,0 +1,61 @@
+#!/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.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+mail = 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=>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,16 @@
+#!/usr/bin/env ruby
+
+# Prints the sub-folder hierarchy of a given folder as a list of folder names indented according to depth.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+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(app('Finder').home.folders['Documents'])