castanaut 1.1.1 → 1.1.2

data/{Copyright.txt → COPYRIGHT.md}

@@ -1,4 +1,4 @@
-== Castanaut
+### Castanaut
 
 Copyright (C) 2008 Inventive Labs.
 
@@ -8,7 +8,7 @@ and/or modify it under the terms of the Do What The Fuck You Want
 To Public License, Version 2, as published by Sam Hocevar. See
 http://sam.zoy.org/wtfpl/COPYING for more details.
 
-=== DomQuery
+### DomQuery
 
 The DomQuery implementation is included from the Ext JS distribution, which
 uses the MIT license requiring the following copyright and permission 

data/{History.txt → HISTORY.md}

@@ -1,18 +1,23 @@
-== 1.1.1 / 2011-08-13
+### 1.1.2 / 2012-01-10
+
+* Safari 5 support, including adding tabs [DouweM]
+* Updated gem build practices [joseph]
+
+### 1.1.1 / 2011-08-13
 
 * Now supports Mac OS X 10.7 (Lion).
 
-== 1.1.0 / 2010-02-26
+### 1.1.0 / 2010-02-26
 
 * Replaced the gem/rubyforge packaging cruft with a gemspec and rake task.
 * IRB support (see README). [metavida / joseph]
-* Added click_menu_item function. [topfunky]
+* Added `click_menu_item` function. [topfunky]
 * Added basic TextMate plugin. Name is textmate to comply with Castanaut
     expectations. [topfunky]
-* Added wait_for_element method [metavida]
+* Added `wait_for_element` method [metavida]
 * Added perform method for organization. [topfunky]
 * Keystroke method using special keys if necessary. [jlsync / topfunky]
 
-=== 1.0.0 / 2008-02-21
+### 1.0.0 / 2008-02-21
 
 * Initial release.

data/{README.txt → README.md}

@@ -1,34 +1,34 @@
-= Castanaut: Automate your screencasts.
+# Castanaut: Automate your screencasts.
 
-    Author: Joseph Pearson
-    http://gadgets.inventivelabs.com.au/castanaut
+Author: Joseph Pearson  
+http://gadgets.inventivelabs.com.au/castanaut
 
-== DESCRIPTION:
+## DESCRIPTION
 
 Castanaut lets you write executable scripts for your screencasts. With a
 simple dictionary of stage directions, you can create complex interactions
 with a variety of applications. Currently, and for the foreseeable future,
 Castanaut supports Mac OS X 10.5 only.
 
-== SYNOPSIS:
+## SYNOPSIS
 
-=== Writing screenplays
+### Writing screenplays
 
 You write your screenplays as Ruby files. Castanaut has been designed to
 read fairly naturally to the non-technical, within Ruby's constraints.
 
 Here's a simple screenplay:
 
-  launch "Safari", at(10, 10, 800, 600)
-  type "http://www.inventivelabs.com.au"
-  hit Enter
-  pause 2
-  move to(100, 100)
-  move to(200, 100)
-  move to(200, 200)
-  move to(100, 200)
-  move to(100, 100)
-  say "I drew a square!"
+    launch "Safari", at(10, 10, 800, 600)
+    type "http://www.inventivelabs.com.au"
+    hit Enter
+    pause 2
+    move to(100, 100)
+    move to(200, 100)
+    move to(200, 200)
+    move to(100, 200)
+    move to(100, 100)
+    say "I drew a square!"
 
 With any luck we don't need to explain to you what this screenplay
 does. The only thing that might need some explanation is "say" -- this has a
@@ -40,11 +40,11 @@ a large audience. Most people find it a little offputting.
 You are free to contravene our recommendation though. You
 can tweak the robot in the Mac OS X Speech Preferences pane.
 
-=== Running your screenplay
+### Running your screenplay
 
 Simply give the screenplay to the castanaut command, like this:
 
-  castanaut test.screenplay
+    castanaut test.screenplay
 
 This assumes you have a screenplay file called "test.screenplay" in the
 directory where you are running the command.
@@ -53,19 +53,19 @@ Of course, it isn't always convenient to drop to the terminal to run your
 screenplay. So there's also a method of executing your screenplays directly.
 You need to add this line (the "shebang" line) at the top of your screenplay:
 
-#!/usr/bin/env castanaut
+    #!/usr/bin/env castanaut
 
 Then you need to set the screenplay to be executable by running this command
 on it:
 
-  chmod a+x test.screenplay
+    chmod a+x test.screenplay
 
 Again, substitute "test.screenplay" for your screenplay's filename.
 
 At this point, you should be able to double-click the screenplay, or invoke
 it with Quicksilver, or run it any other way that floats your boat.
 
-=== Stopping the screenplay
+### Stopping the screenplay
 
 If you want to abruptly terminate execution before the end of the screenplay,
 you just need to run the 'castanaut' command again -- with or without any
@@ -78,9 +78,9 @@ assigned to Shift-F1, that calls castanaut. You'll need the full path to
 the command for this, which is usually /usr/bin/castanaut, but you can check
 it with the following command:
 
-  which "castanaut"
+    which "castanaut"
 
-=== Running interactively with IRB
+### Running interactively with IRB
 
 You can now run Castanaut interactively from IRB — to test commands, try stuff
 out, etc:
@@ -94,7 +94,7 @@ Note that this technique creates an IRB subsession, so you'll have to exit out
 of that before exiting out of IRB. There's heaps you can do with subsessions -
 read up about them online.
 
-=== What stage directions can I make?
+### What stage directions can I make?
 
 Out of the box, Castanaut performs mouse actions, keyboard actions,
 robot speech and application launches.
@@ -102,7 +102,7 @@ robot speech and application launches.
 For a complete overview of the built-in stage directions, see the
 Castanaut::Movie class.
 
-=== Using plugins
+### Using plugins
 
 Of course, just using the built-in stage directions is a little bit awkward
 and verbose. Plugins allow you to extend the available dictionary with
@@ -118,26 +118,26 @@ Castanaut comes with several plugins, including
 
 To use a plugin, simply declare it:
 
-  plugin "safari"
+    plugin "safari"
 
-  launch "Safari", at(32, 32, 800, 600)
-  url "http://www.google.com"
-  pause 4
-  move to_element('input[name="q"]')
-  click
-  type "Castanaut"
-  move to_element('input[type="submit"]')
-  click
-  pause 4
-  say "Oh. I was hoping for more results."
+    launch "Safari", at(32, 32, 800, 600)
+    url "http://www.google.com"
+    pause 4
+    move to_element('input[name="q"]')
+    click
+    type "Castanaut"
+    move to_element('input[type="submit"]')
+    click
+    pause 4
+    say "Oh. I was hoping for more results."
 
 
 In the example above, we use the two methods provided by the Safari module:
-url, which causes Safari to navigate to the given url, and to_element, which
+url, which causes Safari to navigate to the given url, and `to_element`, which
 returns the co-ordinates of a page element (using CSS selectors) relative to
 the screen.
 
-=== Creating your own plugins
+### Creating your own plugins
 
 Advanced users can create their own plugins. Put them in a directory
 called "plugins" below the directory containing the screenplays that use
@@ -146,26 +146,27 @@ the plugin.
 Take a look at the plugins that Castanaut comes with for examples on creating
 your own.
 
-== REQUIREMENTS:
+## REQUIREMENTS
 
-* Mac OS X 10.5
+* Mac OS X 10.5 or higher
 
 or
 
 * Mac OS X 10.4
-* The Extras Suite application <http://www.kanzu.com/main.html#extrasuites>
+* [The Extras Suite application](http://www.kanzu.com/main.html#extrasuites)
 
-== INSTALL:
+## INSTALL
 
 Run the following command to install Castanaut
 
-  sudo gem install castanaut
+    gem install castanaut
 
-If you're using Mac OS X 10.4 (Tiger) you will also need to download and install the XTool scripting additions.
+If you're using Mac OS X 10.4 (Tiger) you will also need to download and
+install the XTool scripting additions.
 
 Once installed, you should run the following command for two reasons:
 
-  castanaut
+    castanaut
 
 Reason 1 is to confirm that it is installed correctly. Reason 2 is to set up
 the permissions on the utility that controls your mouse and keyboard during
@@ -173,12 +174,12 @@ Castanaut movies. You may be asked for a password here.
 
 If you just see a "ScreenplayNotFound" exception here, everything's good.
 
-== LICENSE:
+## LICENSE
 
-Copyright (C) 2008 Inventive Labs.
+Copyright (C) 2008-2011 Inventive Labs.
 
-Released under the WTFPL: http://sam.zoy.org/wtfpl.
+Released under the [WTFPL](http://sam.zoy.org/wtfpl).
 
 Portions released under the MIT License.
 
-See Copyright.txt for full licensing details.
+See COPYRIGHT.md for full licensing details.

data/lib/castanaut.rb

@@ -10,7 +10,7 @@ unless defined? Castanaut
   module Castanaut
 
     # :stopdoc:
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
     LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
     PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
 

data/lib/plugins/safari.rb

@@ -2,7 +2,7 @@ module Castanaut
 
   module Plugin
     # This module provides actions for controlling Safari. It's tested against
-    # Safari 3 on Mac OS X 10.5.2.
+    # Safari 5.1.2 on Mac OS X 10.7.2.
     module Safari
 
       # An applescript fragment by the Movie launch method to determine
@@ -19,11 +19,26 @@ module Castanaut
 
       # Open a URL in the front Safari tab.
       def url(str)
-        execute_applescript(%Q`
-        tell application "safari"
-        do JavaScript "location.href = '#{str}'" in front document
-        end tell
-        `)
+        execute_javascript("location.href = '#{str}'");
+      end
+      
+      # Create a new tab in the front Safari window.
+      def new_tab(str = nil)
+        if str.nil?
+          execute_applescript %Q`
+            tell front window of application "Safari"
+                set the current tab to (make new tab)
+            end tell
+          `
+        else
+          execute_applescript %Q`
+            tell front window of application "Safari"
+                set newTab to make new tab
+                set the URL of newTab to "#{str}"
+                set the current tab to newTab
+            end tell
+          `
+        end
       end
 
       # Sleep until the specified element appears on-screen. Use this if you
@@ -105,21 +120,14 @@ module Castanaut
 
       private
 
-        # Note: the script should set the Castanaut.result variable.
         def execute_javascript(scpt)
           execute_applescript %Q`
             tell application "Safari"
-              do JavaScript "
-                document.oldTitle = document.title;
-                #{escape_dq(scpt)}
-                if (typeof Castanaut.result != 'undefined') {
-                  document.title = Castanaut.result;
-                }
-              " in front document
-              set the_result to ((name of window 1) as string)
-              do JavaScript "
-                document.title = document.oldTitle;
-              " in front document
+              set the_result to (do JavaScript "
+                (function() {
+                  #{escape_dq(scpt)}
+                })();
+              " in front document)
               return the_result
             end tell
           `
@@ -132,7 +140,7 @@ module Castanaut
           coords = execute_javascript(%Q`
             #{gebys}
             #{cjs}
-            Castanaut.result = Castanaut.Coords.forElement(
+            return Castanaut.Coords.forElement(
               '#{selector}',
               #{index}
             );
@@ -168,4 +176,4 @@ module Castanaut
     end
   end
 
-end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: castanaut
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Joseph Pearson
@@ -14,16 +15,17 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-13 00:00:00 +10:00
-default_executable: 
+date: 2012-01-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -36,13 +38,13 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- Copyright.txt
-- History.txt
-- README.txt
+- COPYRIGHT.md
+- HISTORY.md
+- README.md
 files: 
-- Copyright.txt
-- History.txt
-- README.txt
+- COPYRIGHT.md
+- HISTORY.md
+- README.md
 - bin/castanaut
 - cbin/osxautomation
 - lib/castanaut/exceptions.rb
@@ -66,7 +68,6 @@ files:
 - test/helper.rb
 - test/main_test.rb
 - test/movie_test.rb
-has_rdoc: true
 homepage: http://gadgets.inventivelabs.com.au/castanaut
 licenses: []
 
@@ -75,27 +76,31 @@ rdoc_options:
 - --title
 - Castanaut
 - --main
-- README.txt
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.6
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Castanaut - automate your screencasts