castanaut 1.0.0 → 1.1.0

data/lib/plugins/ishowuhd.rb

@@ -0,0 +1,98 @@
+# modifications for iShowU HD
+# 2009-04-23
+#
+module Castanaut; module Plugin
+  
+  # This module provides primitive support for iShowU, a screencast capturing
+  # tool for Mac OS X from Shiny White Box.
+  #
+  # iShowU is widely considered a good, simple application for its purpose,
+  # but you're by no means required to use it for Castanaut. Simply write
+  # your own module for Snapz Pro, or ScreenFlow, or whatever you like.
+  #
+  # Shiny White Box is promising much better Applescript support in an 
+  # imminent version, which could tidy up this module quite a bit.
+  #
+  # More info: http://www.shinywhitebox.com/home/home.html
+  module Ishowuhd
+
+    # Set the screencast to capture a particular region of the screen.
+    # Generate appropriately-formatted co-ordinates using Castanaut::Movie#to.
+    def ishowu_set_region(*options)
+      ishowu_applescriptify
+
+      options = combine_options(*options)
+
+      ishowu_menu_item("Edit", "Edit Capture Area", false)
+      sleep(0.2)
+      automatically "mousewarp 0 0"
+      drag to(0, 0)
+
+      automatically "mousewarp #{options[:to][:left]} #{options[:to][:top]}"
+
+      drag to(
+        options[:to][:left] + options[:to][:width],
+        options[:to][:top] + options[:to][:height]
+      )
+
+
+      sleep(0.2)
+      hit Enter
+      ishowu_hide
+    end
+
+    # Tell iShowU to start recording. Will automatically stop recording when
+    # the movie is ended, unless you set :auto_stop => false in options.
+    def ishowu_start_recording(options = {})
+      # ishowu_hide # iShowU preference
+      ishowu_menu_item("Edit", "Record")
+      sleep(3)
+      unless options[:auto_stop] == false
+        at_end_of_movie { ishowu_stop_recording }
+      end
+    end
+
+    # Tell iShowU to stop recording.
+    def ishowu_stop_recording
+      ishowu_menu_item("Edit", "Stop")
+    end
+
+    # Execute an iShowU menu option.
+    def ishowu_menu_item(menu, item, quiet = true)
+      ascript = %Q`
+        tell application "iShowU HD"
+          activate
+          tell application "System Events"
+            click menu item "#{item}" of menu "#{menu}" of menu bar item "#{menu}" of menu bar 1 of process "iShowU HD"
+          #{'set visible of process "iShowU HD" to false' if quiet}
+          end tell
+        end
+      `
+      execute_applescript(ascript)
+    end
+
+    # Hide the iShowU window. This is a bit random, and suggestions are 
+    # welcomed.
+    def ishowu_hide
+      ishowu_menu_item("iShowU HD", "Hide iShowU HD")
+    end
+
+    private
+    # iShowU is not Applescript-enabled out of the box. This fix, arguably
+    # a hack, lets us do some limited work with it in Applescript.
+    def ishowu_applescriptify
+      execute_applescript(%Q`
+        try
+        tell application "Finder"
+          set the a_app to (application file id "com.tcdc.Digitizer") as alias
+        end tell
+        set the plist_filepath to the quoted form of ¬
+        ((POSIX path of the a_app) & "Contents/Info")
+        do shell script "defaults write " & the plist_filepath & space ¬
+        & "NSAppleScriptEnabled -bool YES"
+        end try
+      `)
+    end
+  end
+end; end
+

data/lib/plugins/keystack.rb

@@ -0,0 +1,111 @@
+module Castanaut; module Plugin
+
+# keystack castanaut plugin
+# by trevor wennblom <trevor@corevx.com>
+# 2009-04-23
+#
+# used in gnu screen demo
+#   http://ninecoldwinters.com/ferro/gnuscreenscreencast
+#
+# castanaut can be found here:
+# http://gadgets.inventivelabs.com.au/castanaut
+#
+# support multiple modifier keys to achieve the likes of Command-Tab
+#
+# modifiers allowed are :control, :command, :option, and :shift
+# these can be passed as an array
+#
+# this does not account for input customization, so if you use dvorak your
+# results will be interesting.
+#
+# license compatible with castanaut
+# released under the terms of the WTFPL
+# http://sam.zoy.org/wtfpl
+#
+  module Keystack
+
+  # keycode press
+  # keycode is a number mapped to a specific key on your keyboard, '0' and greater
+    def keycode(k)
+      k = k.to_i # if a number as type String was passed
+      ascript = %Q`tell application "System Events" to key code #{k}`
+      execute_applescript(ascript)
+    end
+  
+  # keystroke such as 'a' or 'my sentence'
+    def keystroke(k)
+      ascript = %Q`tell application "System Events" to keystroke "#{k}"`
+      execute_applescript(ascript)
+    end
+
+  # keystroke literal such as 'return' or 'tab'
+  # example
+  #   keystroke_literal('tab')
+    def keystroke_literal(k, *modifiers)
+      ascript = %Q`tell application "System Events" to keystroke #{k}`
+      execute_applescript(ascript)
+    end
+    
+  # keycode press with one or more modifier keys
+  # keycode is a number mapped to a specific key on your keyboard, '0' and greater
+    def keycode_using(k, *modifiers)
+      k = k.to_i # if a number as type String was passed
+      m = modifiers_to_array(modifiers)
+      ascript = %Q`tell application "System Events" to key code #{k} using #{m}`
+      execute_applescript(ascript)
+    end
+          
+  # keystroke with one or more modifier keys
+  # example
+  #   keystroke('z', :command)
+  #   keystroke('z', :command, :shift)
+  #   keystroke('z', [:command, :shift])
+    def keystroke_using(k, *modifiers)
+      m = modifiers_to_array(modifiers)
+      ascript = %Q`tell application "System Events" to keystroke "#{k}" using #{m}`
+      execute_applescript(ascript)
+    end
+    
+  # keystroke literal such as 'return' or 'tab' with one or more modifier keys
+  # example
+  #   keystroke_literal_using('tab', :command) # Command-Tab switch windows
+    def keystroke_literal_using(k, *modifiers)
+      m = modifiers_to_array(modifiers)
+      ascript = %Q`tell application "System Events" to keystroke #{k} using #{m}`
+      execute_applescript(ascript)
+    end
+
+  protected
+
+    def modifiers_to_array(modifiers)
+      ary = []
+      raise "must be passed Array - received #{modifiers.inspect}'" unless modifiers.kind_of? Array
+      modifiers.flatten! # accept keystroke('z', [:command, :shift])
+      raise "must be passed Array with at least one element - received #{modifiers.inspect}'" if modifiers.empty?
+      modifiers.map! do |m|
+      # these are listed in the System Events dictionary
+      # Applications/AppleScript/Script Editor -> File -> Open Dictionary -> System Events
+        case m
+        when :control
+          'control down'
+        when :command
+          'command down'
+        when :option
+          'option down'
+        when :shift
+          'shift down'
+        else
+          raise "unrecognized '#{m.inspect}'"
+        end
+      end
+
+      if modifiers.size > 1
+        '{' + modifiers.join(', ') + '}'
+      else
+        modifiers.to_s
+      end
+    end
+
+  end # module Keystack
+  
+end; end

data/lib/plugins/mousepose.rb

@@ -7,7 +7,7 @@ module Castanaut; module Plugin
   # It doesn't do any configuration of Mousepose on the fly. Configure 
   # Mousepose settings before running your screenplay.
   #
-  # Tested against Mousepose 2. More info: http://www.boinx.com/mousepose
+  # Tested against Mousepose 3. More info: http://www.boinx.com/mousepose
   module Mousepose
 
     # Put a halo around the mouse. If a block is given to this method,

data/lib/plugins/safari.rb

@@ -5,27 +5,73 @@ module Castanaut
     # Safari 3 on Mac OS X 10.5.2.
     module Safari
 
+      # An applescript fragment by the Movie launch method to determine
+      # whether a Safari browser window is open or not.
+      def ensure_window_for_safari
+        "if (count(windows)) < 1 then make new document"
+      end
+
+      # An applescript fragment by the Movie launch method to position
+      # the window.
+      def positioning_for_safari
+        nil
+      end
+
       # 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
+        tell application "safari"
+        do JavaScript "location.href = '#{str}'" in front document
+        end tell
         `)
       end
 
+      # Sleep until the specified element appears on-screen. Use this if you
+      # want to wait until the a page or AJAX request has finished loading
+      # before proceding to the next command.
+      #
+      # Options include:
+      # * :timeout - maximum number of seconds to wait for the element to
+      #     appear. Defaults to 10.
+      # * :index - an integer (*n*) that gets the *n*th element matching the
+      #     selector. Defaults to the first element.
+      #     appear. Defaults to 10.
+      # * :index - an integer (*n*) that gets the *n*th element matching the
+      #     selector. Defaults to the first element.
+      #
+      def wait_for_element(selector, options = {})
+        timeout = Time.now.to_i + (options[:timeout] || 10).to_i
+        while true
+          begin
+            coords = element_coordinates(selector, options)
+            return coords unless coords.nil?
+          rescue Castanaut::Exceptions::ElementNotFound > e
+            raise e if Time.now.to_i > timeout
+          end
+          sleep 0.3
+        end
+      end
+
       # Get the co-ordinates of an element in the front Safari tab. Use this
       # with Castanaut::Movie#cursor to send the mouse cursor to the element.
       #
       # Options include:
-      # * :index - an integer (*n*) that gets the *n*th element matching the 
+      # * :index - an integer (*n*) that gets the *n*th element matching the
       #   selector. Defaults to the first element.
-      # * :area - whereabouts in the element do you want the coordinates. 
-      #   Valid values are: left, center, right, and top, middle, bottom. 
+      # * :area - whereabouts in the element do you want the coordinates.
+      #   Valid values are: left, center, right, and top, middle, bottom.
       #   Defaults to ["center", "middle"].
       #   If single axis is given (eg "left"), the other axis uses its default.
+      # * :timeout - maximum seconds to wait for the element to appear.
+      #   Useful if you're waiting for a page load or AJAX call to complete
+      #   Defaults to 0.
+      #
       def to_element(selector, options = {})
         pos = options.delete(:area)
+        if options[:timeout]
+          wait_for_element(selector, options)
+          options.delete(:timeout)
+        end
         coords = element_coordinates(selector, options)
 
         x_axis, y_axis = [:center, :middle]
@@ -34,30 +80,31 @@ module Castanaut
           x_axis = p.to_sym if %w[left center right].include?(p)
           y_axis = p.to_sym if %w[top middle bottom].include?(p)
         end
-        
+
         edge_offset = options[:edge_offset] || 3
         case x_axis
-          when :left
-            x = coords[0] + edge_offset
-          when :center
-            x = (coords[0] + coords[2] * 0.5).to_i 
-          when :right
-            x = (coords[0] + coords[2]) - edge_offset
+        when :left
+          x = coords[0] + edge_offset
+        when :center
+          x = (coords[0] + coords[2] * 0.5).to_i
+        when :right
+          x = (coords[0] + coords[2]) - edge_offset
         end
 
         case y_axis
-          when :top
-            y = coords[1] + edge_offset
-          when :middle
-            y = (coords[1] + coords[3] * 0.5).to_i
-          when :bottom
-            y = (coords[1] + coords[3]) - edge_offset
+        when :top
+          y = coords[1] + edge_offset
+        when :middle
+          y = (coords[1] + coords[3] * 0.5).to_i
+        when :bottom
+          y = (coords[1] + coords[3]) - edge_offset
         end
 
         result = { :to => { :left => x, :top => y } }
       end
 
       private
+
         # Note: the script should set the Castanaut.result variable.
         def execute_javascript(scpt)
           execute_applescript %Q`
@@ -105,7 +152,7 @@ module Castanaut
         end
 
     end
-  end 
+  end
 
   module Exceptions
     # When getting an element's coordinates, this is raised if no element on

data/lib/plugins/snapz_pro.rb

@@ -0,0 +1,55 @@
+module Castanaut
+  
+  module Plugin
+
+    # This module provides primitive support for Snapz Pro, a screencast capturing
+    # tool for Mac OS X from Abrosia Software.
+    #
+    # Unfortunately Snapz Pro has virtually no AppleScript support so for this plugin
+    # to work correctly you must do the following.
+    #
+    # 1. Invoke Snapz Pro.
+    # 2. Position the initial window so that it is flush with the left side of the screen & the top of the window is flush with the bottom of the menu-bar. The window's close button will be below & slightly to the left of the Apple menu.
+    # 3. Click the "Movie..." button & set everything up just the way you want it.
+    # 4. Close all Snapz Pro windows & run your castanaut script as usual :-)
+    #
+    # Once your script has finished you'll have to tell Snapz how & where to save
+    # the captured movie manually.
+    #
+    # More info: http://www.ambrosiasw.com/utilities/snapzprox
+    module SnapzPro
+
+      # Tell Snapz to start recording. Will automatically stop recording when
+      # the movie is ended, unless you set :auto_stop => false in options.
+      def snapz_start_recording(options = {})
+        snapz_invoke
+
+        # Click the "Movie..." button
+        move to(332, 130)
+        click
+
+        # Start recording
+        hit Castanaut::Enter
+
+        unless options[:auto_stop] == false
+          at_end_of_movie { snapz_stop_recording }
+        end
+      end
+
+      # Tell Snapz to stop recording (by invoking it again).
+      def snapz_stop_recording
+        snapz_invoke
+      end
+
+      private
+      # Invoke Snapz Pro. Bascially the same thing as hitting the keyboard shortcut.
+      def snapz_invoke
+        execute_applescript(%Q`
+          tell application "Snapz Pro X"
+          	invoke
+          end tell
+        `)
+      end
+    end
+  end
+end

data/lib/plugins/terminal.rb

@@ -0,0 +1,55 @@
+module Castanaut
+
+  module Plugin
+    # This module provides actions for controlling Terminal.app
+    # Terminal 2.0.1 on Mac OS X 10.5.6
+    module Terminal
+
+      # Applescript fragment for new windows.
+      def ensure_window_for_terminal
+        do_script
+      end
+
+      def do_script(args = '')
+        "do script \"#{args}\""
+      end
+
+      def launch_terminal
+        launch "Terminal"
+        execute_applescript ensure_window_for_terminal
+      end
+
+      def run_in_terminal(cmd)
+        execute_applescript "
+          tell application \"Terminal\"
+            #{do_script(cmd)} in window 1
+          end tell"
+      end
+
+      def focus_on_terminal
+        execute_applescript "
+          tell application \"Terminal\"
+            activate
+          end tell"
+      end
+
+      def cli(cmd, opts = {})
+        type(cmd, opts)
+        hit Enter
+      end
+
+      def type_pre(string)
+        type string.gsub(/\n/, '
+      end
+
+      def vim_insert(string)
+        type_pre 'i' + string + ''
+      end
+
+    end
+  end
+
+  module Exceptions
+  end
+
+end

data/lib/plugins/textmate.rb

@@ -0,0 +1,65 @@
+module Castanaut; module Plugin
+
+  ##
+  # Contributed by Geoffrey Grosenbach
+  # http://peepcode.com
+
+  # Modified by Brian Hogan
+  # http://www.napcs.com/
+
+  module Textmate
+
+    ##
+    # Types text into TextMate all at once.
+    #
+    # The as_snippet option is documented but doesn't seem to do anything.
+
+    def tm_insert_text(text, as_snippet=false)
+      escaped_text = text.gsub(/"/, '\"')
+      snippet_directive = (as_snippet ? "with as snippet" : "")
+
+      execute_applescript(%Q`
+        tell application "TextMate"
+          insert "#{escaped_text}" #{snippet_directive}
+        end
+      `)
+    end
+
+    ##
+    # Open a file, optionally at a specific line and column.
+    def tm_open_file(file_path, line=0, column=0)
+      full_url = "txmt://open?url=file://#{file_path}&line=#{line}&column=#{column}"
+      execute_applescript(%Q`
+        tell application "TextMate"
+          get url "#{full_url}"
+        end
+      `)
+    end
+
+    # Position the cursor at the given coordinates.
+    def tm_move_to(line=0, column=0)
+      full_url = "txmt://open?line=#{line}&column=#{column}"
+
+      execute_applescript(%Q`
+        tell application "TextMate"
+          get url "#{full_url}"
+        end
+      `)
+    end
+
+    # Create a new file on the filesystem and open it in textmate.
+    def tm_new_file(file)
+      execute_applescript(%Q`
+          do shell script "touch #{file}"
+          tell application "TextMate"
+            activate
+          end
+      `)
+
+      tm_open_file(file)
+    end
+
+
+  end
+
+end; end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'lib/castanaut'
+
+
+def fixture_path(path)
+  File.join(File.dirname(__FILE__), 'fixtures', path)
+end
+
+
+def fixture(path)
+  IO.read(fixture_path(path))
+end

data/test/main_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/helper'
+
+class MainTest < Test::Unit::TestCase
+
+  def test_instantiate_movie_with_screenplay
+    assert(
+      Castanaut::Main.run(
+        [fixture_path('1.screenplay')]
+      ).kind_of?(Castanaut::Movie)
+    )
+  end
+
+end

data/test/movie_test.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/helper'
+
+class MovieTest < Test::Unit::TestCase
+
+  def test_truth
+    assert(true)
+  end
+
+
+  def test_instantiate_movie
+    assert(Castanaut::Movie.spawn.kind_of?(Castanaut::Movie))
+  end
+
+
+  def test_absolute_mouse_movement
+    mov = Castanaut::Movie.spawn
+
+    mov.move(mov.to(100, 100))
+    mloc = mov.cursor_location
+    assert((99..101).to_a.include?(mloc[:x]))
+    assert((99..101).to_a.include?(mloc[:y]))
+  end
+
+
+  def test_relative_mouse_movement
+    mov = Castanaut::Movie.spawn
+
+    mloc = mov.cursor_location
+    mov.move(mov.by(100, 100))
+
+    new_mloc = mov.cursor_location
+    assert_equal(new_mloc[:x], mloc[:x] + 100)
+    assert_equal(new_mloc[:y], mloc[:y] + 100)
+  end
+
+
+  def test_plugin_extensibility
+    mov = Castanaut::Movie.spawn
+    assert(!mov.respond_to?(:to_element))
+    mov.plugin('safari')
+    assert(mov.respond_to?(:to_element))
+  end
+
+
+  def test_perform_and_skip
+    mov = Castanaut::Movie.spawn
+
+    x = 1
+    mov.perform("Something") {
+      x = 3
+      mov.skip
+      x = 4
+    }
+    assert_equal(3, x)
+  end
+
+
+  def test_credits
+    mov = Castanaut::Movie.spawn
+    x = 1
+    mov.at_end_of_movie { x = 3 }
+    assert_equal(1, x)
+    mov.send(:roll_credits)
+    assert_equal(3, x)
+  end
+
+end