rubyosa 0.3.0.1 → 0.4.0

data/AUTHORS

@@ -3,9 +3,12 @@ Laurent Sansonetti <lsansonetti@apple.com>
 
 Contributors:
 Aaron Patterson <aaron.patterson@gmail.com>
+Carlos Villela <carlos.villela@gmail.com>
 James MacAulay <jmacaulay@gmail.com>
+Justin Palmer <encytemedia@gmail.com>
 Michael Pruett <michael@68k.org>
 Michail Pishchagin <mblsha@gmail.com>
+Mike Naberezny <mike@maintainable.com>
 Sebastian Delmont <sd@notso.net>
 Stefan Saasen <s@juretta.com>
 Terry Donoghue <donoghue@apple.com>

data/bin/rdoc-osa

@@ -28,146 +28,205 @@
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-require 'rbosa'
 require 'tmpdir'
 require 'rbconfig'
+require 'rbosa'
 
 def usage
-    STDERR.puts <<-EOS
-Usage: #{$0} [--name | --path | --bundle_id | --signature] <criterion> [rdoc-options...]
+  STDERR.puts <<-EOS
+Usage: #{$0} [--addition] [--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
+    # Generate HTML documentation for the StandardAdditions scriptable addition:
+    #{$0} --addition --name StandardAdditions
 See rdoc --help for additional options.
 EOS
-    exit 1
+  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
+  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 
-
-key = case ARGV.first
-    when '--name'
-        :name
-    when '--path'
-        :path
-    when '--bundle_id'
-        :bundle_id
-    when '--signature'
-        :signature
-    else
-        usage
+addition = key = criterion = nil
+while arg = ARGV.shift
+  case arg
+  when '--addition'
+    addition = true
+  when '--name', '--path', '--bundle_id', '--signature'
+    if key
+      $stderr.puts "You cannot use --name, --path, --bundle_id or --signature more than once."
+      exit 1
+    end
+    key = arg[2..-1].intern
+    criterion = ARGV.shift
+    usage if criterion.nil?
+  else
+    if key and criterion
+      ARGV.unshift(arg)
+      break
+    end
+    usage
+  end
 end
 
 DOC_NOT_AVAILABLE = 'Documentation not available.'
 
-app = OSA.app(key => ARGV[1])
+app = app_name = nil
+
+if addition
+  app_name = criterion if key == :name
+  mod = Module.new
+  OSA.const_set('TheApplication', mod)
+  klass = Class.new(OSA::Element)
+  mod.const_set('Application', klass) 
+  klass.class_eval do
+    include OSA::EventDispatcher
+    METHODS_DESCRIPTION = []
+    DESCRIPTION = 'The application class.'
+  end
+  app = klass.new.merge(key => criterion)
+else
+  app = OSA.app(key => criterion)
+  app_name = if app.respond_to?(:name)
+    app.name
+  else
+    if key != :name
+      STDERR.puts "Can't guess the application name, because the application doesn't have a #name method. Please use `--name' instead."
+      exit 1
+    else
+      criterion
+    end
+  end
+end
+
 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, args_def_opt = '', '', ''
-            if method.args and !method.args.empty?
-                args_doc_ary, args_def_ary, args_def_opt_ary = [], [], []
-                method.args.each do |x| 
-                    arg = x.name
-                    desc = x.description
-                    desc = DOC_NOT_AVAILABLE if desc.empty?
-                    args_doc_ary << "  # #{arg}::\n  #    #{desc}" + (x.optional? ? ' Optional. Can be passed as a Hash key/value.' : '')
-                    if x.optional?
-                        args_def_ary << x.name + '=nil'
-                        args_def_opt_ary << ':' + x.name + ' => nil'
-                    else
-                        args_def_ary << x.name
-                        args_def_opt_ary << x.name
-                    end
-                end
-                args_doc = args_doc_ary.join("\n")
-                args_def = '(' + args_def_ary.join(', ') + ')'
-                args_def_opt = '(' + args_def_opt_ary.join(', ') + ')'
-            end
-            if method.result
-                args_doc << "\n" unless args_doc.empty?
-                desc = method.result.description
-                desc = DOC_NOT_AVAILABLE if desc.empty?
-                args_doc << "  # Returns::\n  #    #{desc}\n"
-            end
-            <<EOS
+  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, args_def_opt = '', '', ''
+      if method.args and !method.args.empty?
+        args_doc_ary, args_def_ary, args_def_opt_ary = [], [], []
+        method.args.each do |x| 
+          arg = x.name
+          desc = x.description
+          desc = DOC_NOT_AVAILABLE if desc.empty?
+          args_doc_ary << "  # #{arg}::\n  #  #{desc}" + (x.optional? ? ' Optional. Can be passed as a Hash key/value.' : '')
+          if x.optional?
+            args_def_ary << x.name + '=nil'
+            args_def_opt_ary << ':' + x.name + ' => nil'
+          else
+            args_def_ary << x.name
+            args_def_opt_ary << x.name
+          end
+        end
+        args_doc = args_doc_ary.join("\n")
+        args_def = '(' + args_def_ary.join(', ') + ')'
+        args_def_opt = '(' + args_def_opt_ary.join(', ') + ')'
+      end
+      if method.result
+        args_doc << "\n" unless args_doc.empty?
+        desc = method.result.description
+        desc = DOC_NOT_AVAILABLE if desc.empty?
+        args_doc << "  # Returns::\n  #  #{desc}\n"
+      end
+      <<EOS
   # call-seq:
-  #    #{method.name + args_def}
-  #    #{args_def_opt != args_def ? method.name + args_def_opt : ''}
+  #  #{method.name + args_def}
+  #  #{args_def_opt != args_def ? method.name + args_def_opt : ''}
   #
   # #{method.description}
 #{args_doc}
   def #{method.name}#{args_def}; end
 EOS
-        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
+  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
+    end
+    <<EOS
 module #{mod.name}::#{const_name}
 #{enums_desc}
 end
 
 EOS
-    end
+  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.
+header = if addition
+  <<EOS
+# This documentation describes the RubyOSA API for the #{criterion} scriptable addition. It has been automatically generated.
+#
+# In order to use this API you have to merge the scriptable addition into an application object. For instance:
+#
+#   OSA.app('iTunes').merge(#{app_name ? "'#{app_name}'" : ":#{key} => '#{criterion}'"})
+#
+# The module OSA::TheApplication is fake, everything inside will be defined in the module of the application you are controlling (for iTunes, in OSA::ITunes).
+EOS
+else
+  <<EOS
+# 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}')
+#   OSA.app('#{app_name}')
+EOS
+end
+
+header << <<EOS
 #
 # For more information about RubyOSA, please visit the project homepage: http://rubyosa.rubyforge.org.
 module OSA; end
-# The #{app.name} module.
+# The #{app_name} module.
 module #{mod.name}; end
 EOS
 
+fake_ruby_src = header << fake_ruby_src
+
 rdoc_flags = ''
-template = File.join(Config.datadir('rubyosa'), 'rdoc_html.rb')
+datadir = if Config.respond_to?(:datadir)
+  Config.datadir('rubyosa')
+else
+  File.join(Config::CONFIG['datadir'], 'rubyosa')
+end
+template = File.join(datadir, 'rdoc_html.rb')
 if File.exists?(template)
-    rdoc_flags << " --template '#{template}' "
+  rdoc_flags << " --template '#{template}' "
 end
-rdoc_flags << " --title '#{app.name} RubyOSA API' "
+rdoc_flags << " --title '#{app_name} RubyOSA API' "
 rdoc_flags << ' --main OSA '
-rdoc_flags << ARGV[2..-1].join(' ')
+rdoc_flags << ARGV.join(' ')
 
-path = unique_tmp_path(app.name, '.rb')
+path = unique_tmp_path(app_name, '.rb')
 File.open(path, 'w') { |io| io.puts fake_ruby_src }
 line = "rdoc #{rdoc_flags} \"#{path}\""
 unless system(line)
-    STDERR.puts "Error when executing `#{line}' : #{$?}"
-    exit 1
+  STDERR.puts "Error when executing `#{line}' : #{$?}"
+  exit 1
 end
 File.unlink(path)

data/sample/Photoshop/new_doc.rb

@@ -0,0 +1,13 @@
+# Creates a new Photoshop document with a given title and size.
+
+begin require 'rubygems'; rescue LoadError; end
+require 'rbosa'
+
+app = OSA.app('Adobe Photoshop CS2')
+app.settings.ruler_units = OSA::AdobePhotoshopCS2::E440::PIXEL_UNITS
+
+app.make(OSA::AdobePhotoshopCS2::Document, nil, :with_properties => {
+	:name => 'Ruby Rocks',
+  :width => 500,
+  :height => 500
+})

data/sample/Photoshop/new_doc_with_text.rb

@@ -0,0 +1,34 @@
+# Creates a new Photoshop document with a given title and size, and adds a text
+# layer on it.
+
+begin require 'rubygems'; rescue LoadError; end
+require 'rbosa'
+
+app = OSA.app('Adobe Photoshop CS2')
+app.settings.ruler_units = OSA::AdobePhotoshopCS2::E440::PIXEL_UNITS
+app.instance_eval do
+  def create_document(options = {})
+    make(OSA::AdobePhotoshopCS2::Document, nil, :with_properties => {
+       :name => 'Ruby Rocks',
+       :width => 500,
+       :height => 500
+     }.merge(options))
+  end
+
+  def add_layer(name, kind)
+    kinds = %w(NORMAL GRADIENTFILL PATTERNFILL TEXT SOLIDFILL)
+    do_javascript %(  
+      var doc = app.activeDocument;
+      var layer = doc.artLayers.add();
+      layer.name = "#{name || ''}";
+      layer.kind = LayerKind.#{kinds.detect {|k| k.downcase == kind} || 'NORMAL'};
+      )
+    current_document.art_layers[0]
+  end
+end
+
+app.create_document(:name => 'Schweet')
+layer = app.add_layer('A text layer', 'text')
+texto  = layer.text_object
+texto.size = 40
+texto.contents = "This is some text"

data/sample/iTunes/name_that_tune.rb

@@ -0,0 +1,97 @@
+# Plays a track of your iTunes library at random and asks you to guess the name of the track.
+
+begin require 'rubygems'; rescue LoadError; end
+require 'rbosa'
+
+OSA.app('iTunes') # initialize the constants
+
+class OSA::ITunes::Application
+  
+  def library_source
+    sources.find {|s| s.kind == OSA::ITunes::ESRC::LIBRARY }
+  end
+  
+  def library
+    library_source.playlists.find {|p| p.name == 'Library' }
+  end
+  
+  def party_shuffle
+    library_source.playlists.find {|p| p.special_kind == OSA::ITunes::ESPK::PARTY_SHUFFLE }
+  end
+
+end
+
+class OSA::ITunes::Playlist
+  
+  def random_track
+    tracks[rand * tracks.size]
+  end
+  
+end
+
+class OSA::ITunes::Track
+
+  def to_s
+    "#{artist} - #{name}"
+  end
+
+end
+
+
+class NameThatTune
+  attr_accessor :score
+  
+  def initialize
+    @itunes = OSA.app('iTunes')
+  end
+
+  def finish
+    puts "Thanks for playing! Score: #{score}"
+    exit
+  end
+
+  def start
+    @score = 0
+    while true
+      @itunes.party_shuffle.play
+      @itunes.next_track
+  
+      options = generate_options
+      options.each_with_index { |track, i| puts "#{i+1} - #{track}" }
+
+      selected = gets.to_i
+  
+      finish if selected == 0
+  
+      if correct?(options, selected)
+        points = calculate_points_for_correct_choice
+        puts "Correct! #{points} points"
+        self.score += points
+      else
+        puts "Sorry! That was #{@itunes.current_track}"
+      end
+    end
+  end
+  
+  private
+  
+  def correct?(options, selected)
+    options[selected-1] == @itunes.current_track
+  end
+  
+  def calculate_points_for_correct_choice
+    points = (@itunes.player_position > 10 ? 1 : 10 - @itunes.player_position) * 1000
+    points += (@itunes.current_track.played_count > 10 ? 1 : 10 - @itunes.current_track.played_count) * 100
+    points.to_i
+  end
+  
+  def generate_options(count = 5)
+    options = []
+    options << @itunes.current_track
+    (count - 1).times {|i| options << @itunes.library.random_track }
+    options = options.sort_by { rand }
+  end
+  
+end
+
+NameThatTune.new.start

data/sample/iTunes/tag_genre_lastfm.rb

@@ -4,17 +4,29 @@ begin require 'rubygems'; rescue LoadError; end
 require 'rbosa'
 require 'net/http'
 require 'cgi'
-require 'rexml/document'
+require 'rexml/document' 
 include REXML
 
 itunes = OSA.app('iTunes')
+
 selection = itunes.selection.get
 if selection.empty?
   $stderr.puts "Please select some tracks."
   exit 1
 end
+
+first = selection.first.artist 
+feed = "http://ws.audioscrobbler.com/1.0/artist/#{CGI::escape(first)}/toptags.xml"
+doc = Document.new(Net::HTTP.get(URI(feed))) 
+
 selection.each do |track|
-  feed = "http://ws.audioscrobbler.com/1.0/artist/#{CGI::escape(track.artist)}/toptags.xml"
-  doc = Document.new(Net::HTTP.get(URI(feed)))
-  track.genre = doc.root[1][1].text
+  if doc.root.attributes['artist'] == track.artist
+    genre = doc.root[1][1].text.capitalize
+  else
+    puts 'Querying Last.fm again...' 
+    feed = "http://ws.audioscrobbler.com/1.0/artist/#{CGI::escape(track.artist)}/toptags.xml"
+    doc = Document.new(Net::HTTP.get(URI(feed)))
+    genre = doc.root[1][1].text.capitalize
+  end
+  track.genre = genre
 end