safariwatir 0.1.0

data/safariwatir.rb

@@ -0,0 +1,213 @@
+require 'safariwatir/scripter'
+require 'safariwatir/core_ext'
+require 'watir/exceptions'
+
+module Watir
+  include Watir::Exception
+
+  module Elements
+    class AlertWindow
+      def initialize(scripter)
+        @scripter = scripter
+      end
+      
+      def click
+        @scripter.click_alert_ok
+      end
+    end
+
+    class HtmlElement
+      def_init :scripter, :how, :what
+      attr_reader :how, :what
+
+      # Hooks for subclasses
+      def tag; end
+
+      def operate(&block)
+        send("operate_by_" + how.to_s, &block)
+      end
+
+      protected
+      
+      def operate_by_id(&block)
+        @scripter.operate_by_id(self, &block)        
+      end
+      def operate_by_index(&block)
+        @scripter.operate_by_index(self, &block)        
+      end
+      def operate_by_name(&block)
+        @scripter.operate_on_form_element(self, &block)        
+      end
+      def operate_by_text(&block)
+        @scripter.operate_on_link(self, &block)        
+      end
+      def operate_by_url(&block)
+        @scripter.operate_on_link(self, &block)        
+      end
+    end
+
+    class Form < HtmlElement
+      def_init :scripter, :how, :what
+
+      def submit
+        @scripter.submit_form(self)
+      end
+      
+      def tag; "FORM"; end
+    end
+    
+    class ClickableElement < HtmlElement      
+      def click
+        @scripter.highlight(self) do
+          click_element
+        end
+      end
+
+      # Hooks for subclasses
+      def by_value; end
+    end
+    
+    class Button < ClickableElement
+    end
+    
+    class Checkbox < ClickableElement
+      alias :set :click
+    end
+
+    class Label < ClickableElement
+      protected
+      
+      def operate_by_text(&block)
+        @scripter.operate_on_label(self, &block)
+      end
+    end
+
+    class Link < ClickableElement
+      def click
+        @scripter.highlight(self) do
+          click_link
+        end
+      end
+    end
+
+    class Radio < ClickableElement
+      def_init :scripter, :how, :what, :value
+      def by_value
+        @value
+      end
+      alias :set :click
+    end
+
+    class SelectList < ClickableElement
+      def select(label)
+        @scripter.highlight(self) do
+          select_option("text", label)
+        end
+      end
+
+      def select_value(value)
+        @scripter.highlight(self) do
+          select_option("value", value)
+        end
+      end
+    end
+
+    class TextField < ClickableElement
+      def set(value)
+        @scripter.highlight(self) do
+          clear_text_input
+          value.length.times do |i|
+            append_text_input(value[i, 1])
+          end
+        end
+      end
+    end
+
+    class Password < TextField
+    end
+  end
+  
+  class Safari
+    include Elements
+
+    attr_reader :scripter
+
+    def self.start(url = nil)
+      safari = new
+      safari.goto(url) if url
+      safari
+    end
+    
+    def initialize
+      @scripter = AppleScripter.new
+    end
+    
+    def close
+      scripter.close
+    end
+    
+    def quit
+      scripter.quit
+    end
+
+    def alert
+      AlertWindow.new(scripter)
+    end
+    
+    def goto(url)
+      scripter.navigate_to(url)
+    end
+
+    def button(how, what)
+      Button.new(scripter, how, what)
+    end
+
+    def checkbox(how, what)
+      Checkbox.new(scripter, how, what)
+    end
+
+    def form(how, what)
+      Form.new(scripter, how, what)
+    end
+
+    def image(how, what)
+      Button.new(scripter, how, what)
+    end
+
+    def label(how, what)
+      Label.new(scripter, how, what)
+    end
+    
+    def link(how, what)
+      Link.new(scripter, how, what)
+    end
+
+    def password(how, what)
+      Password.new(scripter, how, what)
+    end
+
+    def radio(how, what, value = nil)
+      Radio.new(scripter, how, what, value)
+    end
+
+    def select_list(how, what)
+      SelectList.new(scripter, how, what)
+    end
+    
+    def text_field(how, what)
+      TextField.new(scripter, how, what)
+    end
+    
+    def contains_text(what)
+      text = scripter.document_text
+      case what
+        when Regexp:
+          text =~ what
+        when String:
+          text.index(what)
+        else
+          raise MissingWayOfFindingObjectException
+        end
+    end
+  end # class Safari
+end

data/safariwatir/core_ext.rb

@@ -0,0 +1,13 @@
+# Why shouldn't this be in core Ruby?
+class Class
+  def def_init(*attrs)
+    constructor = %|def initialize(|
+    constructor << attrs.map{|a| a.to_s }.join(",")
+    constructor << ")\n"
+    attrs.each do |attribute|
+      constructor << "@#{attribute} = #{attribute}\n"
+    end
+    constructor << "end"
+    class_eval(constructor)
+  end
+end

data/safariwatir/scripter.rb

@@ -0,0 +1,215 @@
+module Watir
+  class AppleScripter
+
+    @@timeout = 10
+  
+    def initialize
+      ensure_window_ready
+    end
+          
+    def close
+      execute(%|close document 1|)
+    end
+
+    def quit
+      execute(%|quit|)
+    end
+  
+    def navigate_to(url)
+      execute_and_wait(%|set URL in document 1 to "#{url}"|)
+    end
+      
+    def document_text
+      execute(%|do Javascript "document.getElementsByTagName('BODY').item(0).innerText;" in document 1|)
+    end
+      
+    def highlight(element, &block)
+      execute(element.operate do
+%|element.focus();        
+element.originalColor = element.style.backgroundColor;
+element.style.backgroundColor = 'yellow';|
+      end)      
+
+      @element = element
+      instance_eval(&block)
+      @element = nil
+
+      execute(element.operate { %|element.style.backgroundColor = element.originalColor;| })
+    end
+
+    def select_option(option_how, option_what, element = @element)
+      execute(element.operate do
+%|for (var i = 0; i < element.options.length; i++) {
+  if (element.options[i].#{option_how} == '#{option_what}') {
+    element.options[i].selected = true;
+  }
+}|
+      end)
+    end
+  
+    def clear_text_input(element = @element)
+      execute(element.operate { %|element.value = '';| })
+    end
+      
+    def append_text_input(value, element = @element)
+      execute(element.operate do 
+%|element.value += '#{value}';
+element.setSelectionRange(element.value.length, element.value.length);| 
+      end)
+    end
+
+    # TODO need a better approach for "waiting"
+    def click_element(element = @element)
+      execute_and_wait(element.operate { %|element.click();| })
+    end
+  
+    def click_link(element = @element)      
+      click = find_link(element) do
+%|var click = document.createEvent('HTMLEvents');
+click.initEvent('click', true, true);
+if (element.onclick) {
+ 	if (false != element.onclick(click)) {
+		return element.href;
+	}
+} else {
+	return element.href;
+}|
+      end
+      execute_and_wait(%|set target to do JavaScript "#{click}" in document 1
+set URL in document 1 to target|)
+    end
+
+    def operate_on_link(element, &block)
+      %|do JavaScript "#{find_link(element, &block)}" in document 1|  
+    end
+
+    def find_link(element)
+%|for (var i = 0; i < document.links.length; i++) {
+  if (document.links[i].#{handle_match(element)}) {
+    var element = document.links[i];
+    #{yield}
+    break;
+  }
+}|      
+    end
+    private :find_link
+
+    def handle_match(element)
+      how = {:text => "text", :url => "href"}[element.how]
+      case element.what
+        when Regexp:
+          %|#{how}.match(/#{element.what.source}/)|          
+        when String:
+          %|#{how} == '#{element.what}'|
+      end
+    end
+    private :handle_match
+  
+    def operate_on_form_element(element)
+%|do JavaScript "
+var elements = document.getElementsByName('#{element.what}');
+var element;
+for (var i = 0; i < elements.length; i++) {
+  if (elements[i].tagName != 'META') {
+    #{handle_form_element_name_match(element)}
+  }
+}
+#{yield}
+" in document 1|
+    end
+    
+    def handle_form_element_name_match(element)
+      element_capture = %|element = elements[i];break;|
+      if element.by_value
+%|if (elements[i].value == '#{element.by_value}') {
+  #{element_capture}
+}|        
+      else
+        element_capture
+      end
+    end
+    private :handle_form_element_name_match
+
+    def operate_by_id(element)
+%|do JavaScript "
+var element = document.getElementById('#{element.what}');
+#{yield}" in document 1|  
+    end
+
+    def operate_by_index(element)
+%|do JavaScript "
+var elements = document.getElementsByTagName('#{element.tag}');
+var element = elements[#{element.what}];
+#{yield}" in document 1|  
+    end
+
+    def operate_on_label(element)
+%|do JavaScript "
+var elements = document.getElementsByTagName('LABEL');
+var element;
+for (var i = 0; i < elements.length; i++) {
+  if (elements[i].textContent == '#{element.what}') {
+    element = elements[i];
+    #{yield}
+    break;
+  }
+}
+" in document 1|      
+    end
+
+    def submit_form(element)
+      execute_and_wait(element.operate { %|element.submit();| })
+    end
+
+    def click_link_ok
+      execute_system_events(%|
+tell window 1
+	if button named "OK" exists then
+		click button named "OK"
+	end if
+end tell|)
+    end 
+
+    private
+
+    def execute(script)      
+     # puts script
+`osascript <<SCRIPT
+tell application "Safari"
+	#{script}
+end tell
+SCRIPT`
+    end
+
+    # Must have "Enable access for assistive devices" checked in System Preferences > Universal Access
+    def execute_system_events(script)      
+`osascript <<SCRIPT
+tell application "System Events" to tell process "Safari"  
+	#{script}
+end tell
+SCRIPT`
+    end
+
+    def execute_and_wait(script)
+      execute(%|
+#{script}
+delay 2
+repeat with i from 1 to #{@@timeout}
+  if (do JavaScript "document.readyState" in document 1) is "complete" then
+    exit repeat
+  else
+    delay 1
+  end if
+end repeat|)
+    end
+  
+    def ensure_window_ready
+      execute(%|
+activate
+set document_list to every document
+if length of document_list is 0 then
+	make new document
+end if|)      
+    end
+  end # class AppleScripter
+end

data/safariwatir_script.rb

@@ -0,0 +1,76 @@
+require 'safari'
+
+# TODO 
+# Need to give feedback when browser dies or when elements are not found
+# Be more attached to the Safari window, if a different window is selected, the AppleScript executes against it
+# Verify onclick is working for buttons and links
+
+# Unsupported Elements: Textarea, Div, UL/OL, Span
+# Use dynamic properties for Javascript optimization?
+# Will I need to push more functionality into AppleScript to speed things up?
+# Angrez is looking into the Ruby/AppleScript binding
+# Watir Rails Plugin needed
+
+# SAFARI ISSUES
+# Labels are not clickable
+# No known way to programatically click a <button> 
+# Links with href="javascript:foo()"
+
+safari = Watir::Safari.new
+
+def safari.google_to_prag
+  goto("http://google.com")
+  text_field(:name, "q").set("pickaxe")
+  button(:name, "btnG").click
+  link(:text, "The Pragmatic Programmers, LLC: Programming Ruby").click
+  link(:url, "http://www.pragmaticprogrammer.com/titles/ruby/code/index.html").click
+  link(:text, "Catalog").click
+  link(:text, "All Books").click
+  link(:text, /Agile Retrospectives/).click
+  puts "FAILURE prag" unless contains_text("Dave Hoover")  
+end
+
+def safari.ala
+  goto("http://alistapart.com/")
+  text_field(:id, "search").set("grail")
+  checkbox(:id, "incdisc").set
+  button(:id, "submit").click
+  puts "FAILURE ala" unless contains_text('Search Results for “grail”')
+end
+
+def safari.amazon
+  goto("http://amazon.com")
+  select_list(:name, "url").select("Toys")
+  select_list(:name, "url").select_value("index=software")
+  text_field(:name, "keywords").set("Orion")
+  image(:name, "Go").click
+  puts "FAILURE amazon" unless contains_text("Master of Orion (Original Release) (PC)")
+end
+
+def safari.google_advanced
+  goto("http://www.google.com/advanced_search")
+  radio(:name, "safe", "active").set
+  radio(:name, "safe", "images").set
+  # Safari doesn't support label clicking ... perhaps I should raise an Exception
+  label(:text, "No filtering").click
+  radio(:id, "ss").set
+  text_field(:name, "as_q").set("obtiva")
+  button(:name, "btnG").click
+  puts "FAILURE google" unless contains_text("RailsConf Facebook")
+end
+
+def safari.reddit
+  goto("http://reddit.com/")
+  text_field(:name, "user").set("foo")
+  password(:name, "passwd").set("bar")
+  form(:index, 1).submit
+  puts "FAILURE reddit" unless contains_text("foo") and contains_text("logout")  
+end
+
+safari.google_to_prag
+safari.ala
+safari.amazon
+safari.google_advanced
+safari.reddit
+
+safari.close

data/watir/exceptions.rb

@@ -0,0 +1,42 @@
+module Watir
+  module Exception
+
+    # Root class for all Watir Exceptions
+    class WatirException < RuntimeError  
+        def initialize(message="")
+            super(message)
+        end
+    end
+    
+    # This exception is thrown if an attempt is made to access an object that doesn't exist
+    class UnknownObjectException < WatirException; end
+    # This exception is thrown if an attempt is made to access an object that is in a disabled state
+    class ObjectDisabledException   < WatirException; end
+    # This exception is thrown if an attempt is made to access a frame that cannot be found 
+    class UnknownFrameException< WatirException; end
+    # This exception is thrown if an attempt is made to access a form that cannot be found 
+    class UnknownFormException< WatirException; end
+    # This exception is thrown if an attempt is made to access an object that is in a read only state
+    class ObjectReadOnlyException  < WatirException; end
+    # This exception is thrown if an attempt is made to access an object when the specified value cannot be found
+    class NoValueFoundException < WatirException; end
+    # This exception gets raised if part of finding an object is missing
+    class MissingWayOfFindingObjectException < WatirException; end
+    # this exception is raised if an attempt is made to  access a table cell that doesnt exist
+    class UnknownCellException < WatirException; end
+    # This exception is thrown if the window cannot be found
+    class NoMatchingWindowFoundException < WatirException; end
+    # This exception is thrown if an attemp is made to acces the status bar of the browser when it doesnt exist
+    class NoStatusBarException < WatirException; end
+    # This exception is thrown if an http error, such as a 404, 500 etc is encountered while navigating
+    class NavigationException < WatirException; end
+    # This exception is raised if a timeout is exceeded
+    class TimeOutException < WatirException
+      def initialize(duration, timeout)
+        @duration, @timeout = duration, timeout
+      end 
+      attr_reader :duration, :timeout
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: safariwatir
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-07-21 00:00:00 -05:00
+summary: Automated testing tool for web applications.
+require_paths: 
+- .
+email: dave.hoover@gmail.com
+homepage: http://safariwatir.rubyforge.org/
+rubyforge_project: safariwatir
+description: WATIR stands for "Web Application Testing in Ruby".  See WATIR project for more information.  This is simply a Safari-version of the original IE-only WATIR.
+autorequire: safariwatir
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Dave Hoover
+files: 
+- safariwatir.rb
+- safariwatir_script.rb
+- safariwatir/core_ext.rb
+- safariwatir/scripter.rb
+- watir/exceptions.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: 
+- Mac OS X running Safari
+- Some features require you to turn on "Enable access for assistive devices" in System Preferences > Universal Access
+dependencies: []
+