rubyosa 0.1.0

data/AUTHORS

@@ -0,0 +1,9 @@
+Maintainer:
+Laurent Sansonetti <lsansonett@apple.com>
+
+Contributors:
+Aaron Patterson <aaron.patterson@gmail.com>
+James MacAulay <jmacaulay@gmail.com>
+Michael Pruett <michael@68k.org>
+Sebastian Delmont <sd@notso.net>
+Vincent Isambart <vincent.isambart@gmail.com>

data/COPYRIGHT

@@ -0,0 +1,25 @@
+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.

data/README

@@ -0,0 +1,39 @@
+== Introduction ==
+
+RubyOSA is a bridge that connects Ruby to the Apple Event Manager 
+infrastructure.
+ 
+It automatically populates the API (classes, methods, constants) according 
+to the target application's scriptable definition.
+
+RubyOSA is an alternative to RubyAEOSA, and meant to replace it.
+
+RubyOSA is licensied under a BSD license, see the COPYRIGHT file for more 
+information.
+
+More information on the project home page: http://rubyosa.rubyforge.org.
+
+== Requirements ==
+
+Mac OS X 10.4.X or greater
+ruby 1.8.X or greater
+libxml-ruby 0.3.8 or greater
+
+== Get started ==
+
+$ ruby extconf.rb
+$ make
+$ sudo make install
+
+== Support ==
+
+Sample code is available in the `sample' sub-directory.
+
+The rdoc-osa tool can be used to generate API reference documentation
+for the given application. See its --help flag for more information
+about how to use it.
+
+Feel free to send feedback to lsansonetti@apple.com.
+
+When reporting a bug, please set the AEDebugSends and AEDebugReceives 
+environment variables to 1 and attach the logs. 

data/bin/rdoc-osa

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+# RDoc frontend for RubyOSA. Generate API referene documentation for the 
+# given application, based on the descriptions in the sdef(5).
+#
+# 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 'rbosa'
+require 'tmpdir'
+
+def usage
+    STDERR.puts <<-EOS
+Usage: #{$0} [--name | --path | --bundle_id | --signature] <criterion> [rdoc-options...]
+Examples:
+    # Generate HTML documentation for iTunes:
+    #{$0} --name iTunes
+    # Generate RI documentation for iTunes:
+    #{$0} --name iTunes --ri
+See rdoc --help for additional options.
+EOS
+    exit 1
+end
+
+def unique_tmp_path(base, extension='', dir=Dir.tmpdir)
+   i = 0
+   loop do
+       p = File.join(dir, "#{base}-#{i}-#{Process.pid}" + extension)
+       return p unless File.exists?(p)
+       i += 1
+   end
+end
+
+usage unless ARGV.length >= 2 
+
+msg = case ARGV.first
+    when '--name'
+        :app_with_name
+    when '--path'
+        :app_with_path
+    when '--bundle_id'
+        :app_with_bundle_id
+    when '--signature'
+        :app_with_signature
+    else
+        usage
+end
+
+app = OSA.send(msg, ARGV[1])
+mod = OSA.const_get(app.class.name.scan(/^OSA::(.+)::Application$/).to_s)
+fake_ruby_src = mod.constants.map do |const_name|
+    obj = mod.const_get(const_name)
+    case obj
+    when Class
+        # Class.
+        methods_desc = obj.const_get('METHODS_DESCRIPTION').map do |method|
+            args_doc, args_def = '', ''
+            if method.args and !method.args.empty?
+                args_doc = method.args.map do |x| 
+                    arg = x.name.dup
+                    optional = arg.sub!(/=.+$/, '') != nil
+                    "  # #{arg}::\n  #    #{x.description}" + (optional ? ' Optional.' : '')
+                end.join("\n")
+                args_def = '(' + method.args.map { |x| x.name }.join(', ') + ')'
+            end
+            if method.result
+                args_doc << "\n" unless args_doc.empty?
+                args_doc << "  # Returns::\n  #    #{method.result.description}\n"
+            end
+            <<EOS
+  # #{method.description}
+#{args_doc}
+  def #{method.name}#{args_def}; end
+EOS
+        end
+        <<EOS
+# #{(obj.const_get('DESCRIPTION') || 'n/a')}
+class #{obj.name} < #{obj.superclass}
+#{methods_desc.join.rstrip}
+end
+
+EOS
+    when Module
+        # Enumeration group.
+        next unless obj.const_defined?(:DESCRIPTION)
+        enums_desc = obj.const_get(:DESCRIPTION).map do |item|
+            <<EOS
+  # #{item.description}
+  #{item.name} = '#{obj.const_get(item.name).code}'
+EOS
+        end
+        <<EOS
+module #{mod.name}::#{const_name}
+#{enums_desc}
+end
+
+EOS
+    end
+end.
+join
+
+fake_ruby_src = <<EOS + fake_ruby_src
+# This documentation describes the RubyOSA API for the #{app.name} application. It has been automatically generated.
+#
+# The main class is #{mod.name}::Application, of which an instance is created likewise:
+#
+#   OSA.app('#{app.name}')
+#
+# For more information about RubyOSA, please visit the project homepage: http://rubyosa.rubyforge.org.
+module OSA; end
+# The #{app.name} module.
+module #{mod.name}; end
+EOS
+
+path = unique_tmp_path(app.name, '.rb')
+File.open(path, 'w') { |io| io.puts fake_ruby_src }
+line = "rdoc #{ARGV[2..-1].join(' ')} \"#{path}\""
+unless system(line)
+    STDERR.puts "Error when executing `#{line}' : #{$?}"
+    exit 1
+end
+File.unlink(path)

data/extconf.rb

@@ -0,0 +1,53 @@
+# 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'
+
+$CFLAGS << ' -Wall '
+$LDFLAGS = '-framework Carbon -framework ApplicationServices'
+
+exit 1 unless have_func('OSACopyScriptingDefinition')
+exit 1 unless have_func('LSFindApplicationForInfo')
+
+# Avoid `ID' and `T_DATA' symbol collisions between Ruby and Carbon.
+# (adapted code from RubyAEOSA - FUJIMOTO Hisakuni  <hisa@fobj.com>)
+ruby_h = "#{Config::CONFIG['archdir']}/ruby.h"
+intern_h = "#{Config::CONFIG['archdir']}/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(/\bintern.h\b/, "#{new_filename_prefix}intern.h")
+            dstfile.puts line
+        end
+    end
+end
+
+create_makefile('osa', 'src')

data/sample/Finder_show_desktop.rb

@@ -0,0 +1,7 @@
+require 'rbosa'
+
+ary = OSA.app('Finder').desktop.entire_contents.get
+ary.each do |x|
+    next unless x.is_a?(OSA::Finder::Item)
+    puts "#{x.class.name.sub(/^.+::/, '').sub(/_/, ' ').ljust(25)} #{x.name}"
+end

data/sample/QT_playall.rb

@@ -0,0 +1,29 @@
+# Opens given movies and in QuickTime and starts playing them indefinitely in fullscreen mode.
+
+require 'rbosa'
+
+if ARGV.empty?
+    STDERR.puts "Usage: #{$0} <movies-files>"
+    exit 1
+end
+
+app = OSA.app('QuickTime Player')
+ARGV.each { |p| app.open(p) }
+l = app.movies.to_a
+exit if l.length == 0
+last = nil
+loop do
+    l2 = []
+    l.length.times { l2 << l.slice!(rand(l.length)) }
+    l2[0], l2[1] = l2[1], l2[0] if l2[0] == last and l2.length > 1 # not to have the same file playing twice consecutively
+    l2.each do |m|
+        m.rewind # to be sure that we start at the beginning of the movie
+        m.present
+        sleep 0.1 while m.playing?
+        m.stop # to be sure we are not in presentation mode anymore
+        # if we do not end with a stop, and the movie has been stopped by the user,
+        # the next present will not play the movie because an other movie is still in presentation mode
+        last = m
+    end
+    l = l2
+end

data/sample/iChat_uptime.rb

@@ -0,0 +1,11 @@
+# Periodically set your iChat status to the output of uptime(1). 
+
+require 'rbosa'
+
+app = OSA.app('iChat')
+previous_status_message = app.status_message
+trap('INT') { app.status_message = previous_status_message; exit 0 }
+while true 
+    app.status_message = `uptime`.strip 
+    sleep 5
+end

data/sample/iTunes_control.rb

@@ -0,0 +1,64 @@
+# Simple iTunes controller.
+
+require 'rbosa'
+require 'curses'
+include Curses
+
+app = OSA.app('iTunes')
+
+if app.current_track.nil?
+    # We don't support write access now, so...
+    puts "Please select a track in iTunes and retry again."
+    exit 1
+end
+
+init_screen
+
+addstr <<EOS
+Keys available:
+  SPACE     toggle play/pause
+  p         go to previous song
+  n         go to next song
+  f         toggle fast forward
+  r         toggle rewind
+  m         toggle mute
+  q         exit the program
+
+On track:
+EOS
+
+begin
+    noecho
+    while true
+        setpos(9, 2)
+        addstr "#{app.player_state.to_s.capitalize} : #{app.current_track.name}".ljust(cols - 3)
+        refresh
+        x = getch
+        case x.chr
+        when ' '
+            app.playpause
+        when 'p'
+            app.previous_track
+        when 'n'
+            app.next_track
+        when 'f'
+            if app.player_state == OSA::ITunes::EPLS::FAST_FORWARDING
+                app.resume
+            else
+                app.fast_forward
+            end
+        when 'r'
+            if app.player_state == OSA::ITunes::EPLS::REWINDING
+                app.resume
+            else
+                app.rewind
+            end
+        when 'm'
+            app.mute = !app.mute?
+        when 'q' 
+            break
+        end 
+    end
+ensure
+    echo
+end

data/sample/iTunes_fade_volume.rb

@@ -0,0 +1,22 @@
+# Start playing, then fade the volume from 0 to the original setting.
+
+require 'rbosa'
+
+app = OSA.app('iTunes')
+
+original_volume = app.sound_volume
+
+if original_volume == 0 or app.current_track.nil?
+    puts "Please select a track and/or set a higher volume."
+    exit 1
+end
+
+app.sound_volume = 0
+app.play
+
+0.step(original_volume, original_volume / 8.0) do |volume|
+    app.sound_volume = volume
+    sleep(0.1)
+end
+
+app.sound_volume = original_volume

data/sample/iTunes_inspect.rb

@@ -0,0 +1,14 @@
+# Quick inspection of iTunes' sources, playlists and tracks.
+
+require 'rbosa'
+
+app = OSA.app('iTunes')
+app.sources.each do |source|
+    puts source.name
+    source.playlists.each do |playlist|
+        puts " -> #{playlist.name}"
+        playlist.tracks.each do |track|
+            puts "     -> #{track.name}" if track.enabled?
+        end
+    end
+end

data/sample/sdef.rb

@@ -0,0 +1,36 @@
+# Print the given application's sdef(5).
+
+require 'rbosa'
+require 'rexml/document'
+
+def usage
+    STDERR.puts <<-EOS
+Usage: #{$0} [--name | --path | --bundle_id | --signature] ...
+Examples:
+    #{$0} --name iTunes
+    #{$0} --path /Applications/iTunes.app 
+    #{$0} --bundle_id com.apple.iTunes 
+    #{$0} --signature hook
+EOS
+    exit 1
+end
+
+usage unless ARGV.length == 2 
+
+msg = case ARGV.first
+    when '--name'
+        :app_with_name
+    when '--path'
+        :app_with_path
+    when '--bundle_id'
+        :app_with_bundle_id
+    when '--signature'
+        :app_with_signature
+    else
+        usage
+end
+
+app = OSA.send(msg, ARGV.last)
+doc = REXML::Document.new(app.sdef)
+doc.write(STDOUT, 0)
+puts ""