safariwatir 0.1.0 → 0.1.1

data/safariwatir.rb

@@ -1,10 +1,18 @@
+require 'watir/exceptions'
 require 'safariwatir/scripter'
 require 'safariwatir/core_ext'
-require 'watir/exceptions'
 
 module Watir
   include Watir::Exception
 
+  module Clickable
+    def click
+      @scripter.highlight(self) do
+        click_element
+      end
+    end    
+  end
+
   module Elements
     class AlertWindow
       def initialize(scripter)
@@ -22,6 +30,11 @@ module Watir
 
       # Hooks for subclasses
       def tag; end
+      def speak; end
+
+      def name
+        self.class.name.split("::").last
+      end
 
       def operate(&block)
         send("operate_by_" + how.to_s, &block)
@@ -36,7 +49,7 @@ module Watir
         @scripter.operate_by_index(self, &block)        
       end
       def operate_by_name(&block)
-        @scripter.operate_on_form_element(self, &block)        
+        @scripter.operate_by_name(self, &block)        
       end
       def operate_by_text(&block)
         @scripter.operate_on_link(self, &block)        
@@ -44,6 +57,9 @@ module Watir
       def operate_by_url(&block)
         @scripter.operate_on_link(self, &block)        
       end
+      def operate_by_value(&block)
+        @scripter.operate_by_input_value(self, &block)
+      end
     end
 
     class Form < HtmlElement
@@ -56,25 +72,44 @@ module Watir
       def tag; "FORM"; end
     end
     
-    class ClickableElement < HtmlElement      
-      def click
-        @scripter.highlight(self) do
-          click_element
-        end
+    class InputElement < HtmlElement
+      include Clickable
+      
+      def speak
+        @scripter.speak_value_of(self)
       end
 
       # Hooks for subclasses
       def by_value; end
     end
     
-    class Button < ClickableElement
+    class ContentElement < HtmlElement
+      include Clickable
+
+      def text
+        @scripter.get_text_for(self)
+      end
+
+      def speak
+        @scripter.speak_text_of(self)
+      end      
+    end
+    
+    class Button < InputElement
     end
     
-    class Checkbox < ClickableElement
+    class Checkbox < InputElement
+      def_init :scripter, :how, :what, :value
+      def by_value
+        @value
+      end
       alias :set :click
     end
 
-    class Label < ClickableElement
+    class Div < ContentElement
+    end
+
+    class Label < ContentElement
       protected
       
       def operate_by_text(&block)
@@ -82,7 +117,7 @@ module Watir
       end
     end
 
-    class Link < ClickableElement
+    class Link < InputElement
       def click
         @scripter.highlight(self) do
           click_link
@@ -90,29 +125,31 @@ module Watir
       end
     end
 
-    class Radio < ClickableElement
-      def_init :scripter, :how, :what, :value
-      def by_value
-        @value
-      end
-      alias :set :click
+    class Radio < Checkbox
     end
 
-    class SelectList < ClickableElement
+    class SelectList < InputElement
       def select(label)
         @scripter.highlight(self) do
-          select_option("text", label)
+          select_option(:text, label)
         end
       end
 
       def select_value(value)
         @scripter.highlight(self) do
-          select_option("value", value)
+          select_option(:value, value)
         end
       end
+      
+      def speak
+        @scripter.speak_options_for(self)
+      end
     end
 
-    class TextField < ClickableElement
+    class Span < ContentElement
+    end
+
+    class TextField < InputElement
       def set(value)
         @scripter.highlight(self) do
           clear_text_input
@@ -121,6 +158,15 @@ module Watir
           end
         end
       end
+      
+      def getContents
+        @scripter.get_value_for(self)
+      end
+      
+      def verify_contains(expected)
+        actual = getContents
+        expected == actual
+      end
     end
 
     class Password < TextField
@@ -162,8 +208,12 @@ module Watir
       Button.new(scripter, how, what)
     end
 
-    def checkbox(how, what)
-      Checkbox.new(scripter, how, what)
+    def checkbox(how, what, value = nil)
+      Checkbox.new(scripter, how, what, value)
+    end
+
+    def div(how, what)
+      Div.new(scripter, how, what)
     end
 
     def form(how, what)
@@ -194,6 +244,10 @@ module Watir
       SelectList.new(scripter, how, what)
     end
     
+    def span(how, what)
+      Span.new(scripter, how, what)
+    end
+    
     def text_field(how, what)
       TextField.new(scripter, how, what)
     end

data/safariwatir/core_ext.rb

@@ -10,4 +10,10 @@ class Class
     constructor << "end"
     class_eval(constructor)
   end
+end
+
+class String
+  def quote_safe
+    gsub(/"/, '\"')
+  end
 end

data/safariwatir/scripter.rb

@@ -1,7 +1,28 @@
 module Watir
-  class AppleScripter
+  NOT_FOUND = "__safari_watir_unfound__"
+  NO_RESPONSE = "__safari_watir_no_response__"
 
-    @@timeout = 10
+  module JavaScripter
+    def js_operation(locator, operation)
+      js_wrapper(%|
+#{locator}
+if (element) {
+  #{operation}
+} else {
+  return '#{NOT_FOUND}';
+}|)
+    end
+    
+    def js_wrapper(script)
+      %|set response to do JavaScript "#{script}" in document 1|
+    end
+  end
+  
+  class AppleScripter
+    include JavaScripter
+    include Watir::Exception
+    
+    TIMEOUT = 10
   
     def initialize
       ensure_window_ready
@@ -18,9 +39,25 @@ module Watir
     def navigate_to(url)
       execute_and_wait(%|set URL in document 1 to "#{url}"|)
     end
+
+    def speak_value_of(element = @element)
+      speak(get_value_for(element))
+    end
+
+    def get_text_for(element = @element)
+      execute(element.operate { %|return element.innerText| }, element)
+    end
+
+    def speak_text_of(element = @element)
+      speak(element.text)
+    end
+
+    def get_value_for(element = @element)
+      execute(element.operate { %|return element.value;| }, element)
+    end
       
     def document_text
-      execute(%|do Javascript "document.getElementsByTagName('BODY').item(0).innerText;" in document 1|)
+      execute(js_wrapper(%|document.getElementsByTagName('BODY').item(0).innerText;|))
     end
       
     def highlight(element, &block)
@@ -28,13 +65,26 @@ module Watir
 %|element.focus();        
 element.originalColor = element.style.backgroundColor;
 element.style.backgroundColor = 'yellow';|
-      end)      
+      end, element)      
 
       @element = element
       instance_eval(&block)
       @element = nil
 
-      execute(element.operate { %|element.style.backgroundColor = element.originalColor;| })
+      execute_and_ignore(element.operate { %|element.style.backgroundColor = element.originalColor;| })
+    end
+
+    def speak_options_for(element = @element)
+      values = execute(element.operate do
+%|var values = '';
+for (var i = 0; i < element.options.length; i++) {
+  if (element.options[i].selected == true) {
+    values += ' ' + element.options[i].text;
+  }
+}
+return values|
+      end, element)
+      speak(values)
     end
 
     def select_option(option_how, option_what, element = @element)
@@ -44,18 +94,18 @@ element.style.backgroundColor = 'yellow';|
     element.options[i].selected = true;
   }
 }|
-      end)
+      end, element)
     end
-  
+    
     def clear_text_input(element = @element)
-      execute(element.operate { %|element.value = '';| })
+      execute(element.operate { %|element.value = '';| }, element)
     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, element)
     end
 
     # TODO need a better approach for "waiting"
@@ -64,8 +114,8 @@ element.setSelectionRange(element.value.length, element.value.length);|
     end
   
     def click_link(element = @element)      
-      click = find_link(element) do
-%|var click = document.createEvent('HTMLEvents');
+      click = find_link(element) + %|
+var click = document.createEvent('HTMLEvents');
 click.initEvent('click', true, true);
 if (element.onclick) {
  	if (false != element.onclick(click)) {
@@ -74,23 +124,22 @@ if (element.onclick) {
 } 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|  
+    def operate_on_link(element)
+      js_operation(find_link(element), yield)
     end
 
     def find_link(element)
-%|for (var i = 0; i < document.links.length; i++) {
+%|var element = undefined;
+for (var i = 0; i < document.links.length; i++) {
   if (document.links[i].#{handle_match(element)}) {
-    var element = document.links[i];
-    #{yield}
+    element = document.links[i];
     break;
   }
-}|      
+}|
     end
     private :find_link
 
@@ -105,17 +154,29 @@ set URL in document 1 to target|)
     end
     private :handle_match
   
-    def operate_on_form_element(element)
-%|do JavaScript "
+    def operate_by_input_value(element)
+      js_operation(%|
+var elements = document.getElementsByTagName('INPUT');
+var element = undefined;
+for (var i = 0; i < elements.length; i++) {
+  if (elements[i].tagName != 'META') {
+    if (elements[i].value == '#{element.what}') {
+      element = elements[i];
+      break;
+    }
+  }
+}|, yield)
+    end
+
+    def operate_by_name(element)
+      js_operation(%|
 var elements = document.getElementsByName('#{element.what}');
-var element;
+var element = undefined;
 for (var i = 0; i < elements.length; i++) {
   if (elements[i].tagName != 'META') {
     #{handle_form_element_name_match(element)}
   }
-}
-#{yield}
-" in document 1|
+}|, yield)
     end
     
     def handle_form_element_name_match(element)
@@ -131,37 +192,29 @@ for (var i = 0; i < elements.length; i++) {
     private :handle_form_element_name_match
 
     def operate_by_id(element)
-%|do JavaScript "
-var element = document.getElementById('#{element.what}');
-#{yield}" in document 1|  
+      js_operation("var element = document.getElementById('#{element.what}');", yield)
     end
 
     def operate_by_index(element)
-%|do JavaScript "
-var elements = document.getElementsByTagName('#{element.tag}');
-var element = elements[#{element.what}];
-#{yield}" in document 1|  
+      js_operation(%|var element = document.getElementsByTagName('#{element.tag}')[#{element.what}];|, yield)
     end
 
     def operate_on_label(element)
-%|do JavaScript "
-var elements = document.getElementsByTagName('LABEL');
-var element;
+      js_operation(%|var elements = document.getElementsByTagName('LABEL');
+var element = undefined;
 for (var i = 0; i < elements.length; i++) {
-  if (elements[i].textContent == '#{element.what}') {
+  if (elements[i].innerText == '#{element.what}') {
     element = elements[i];
-    #{yield}
     break;
   }
-}
-" in document 1|      
+}|, yield)
     end
 
     def submit_form(element)
       execute_and_wait(element.operate { %|element.submit();| })
     end
 
-    def click_link_ok
+    def click_alert_ok
       execute_system_events(%|
 tell window 1
 	if button named "OK" exists then
@@ -172,13 +225,32 @@ end tell|)
 
     private
 
-    def execute(script)      
-     # puts script
+    def execute!(script)
+# puts script
 `osascript <<SCRIPT
 tell application "Safari"
+  set response to "#{NO_RESPONSE}"
 	#{script}
+	response
 end tell
-SCRIPT`
+SCRIPT`.chomp
+    end    
+    
+    def execute(script, element = nil)
+      response = execute! script
+      case response
+        when NOT_FOUND:
+          raise UnknownObjectException, "Unable to locate #{element.name} element with #{element.how} of #{element.what}." 
+        when NO_RESPONSE:
+          nil
+        else
+          response
+      end
+    end
+    
+    def execute_and_ignore(script)
+      execute! script
+      nil
     end
 
     # Must have "Enable access for assistive devices" checked in System Preferences > Universal Access
@@ -188,19 +260,20 @@ tell application "System Events" to tell process "Safari"
 	#{script}
 end tell
 SCRIPT`
+      nil
     end
 
-    def execute_and_wait(script)
+    def execute_and_wait(script, element = nil)
       execute(%|
 #{script}
 delay 2
-repeat with i from 1 to #{@@timeout}
+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 repeat|, element)
     end
   
     def ensure_window_ready
@@ -211,5 +284,12 @@ if length of document_list is 0 then
 	make new document
 end if|)      
     end
+    
+    def speak(string)
+`osascript <<SCRIPT
+say "#{string.quote_safe}"
+SCRIPT`
+      nil
+    end
   end # class AppleScripter
 end

data/safariwatir_script.rb

@@ -1,15 +1,17 @@
-require 'safari'
+require 'rubygems'
+require 'safariwatir'
 
 # TODO 
-# Need to give feedback when browser dies or when elements are not found
+# Need to give feedback when browser dies
 # 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
+# TextFields should not respond to button method, etc.
 
-# Unsupported Elements: Textarea, Div, UL/OL, Span
+# Unsupported Elements: UL/OL
 # 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
+# Watir Rails Plugin needed -> Watir test generator, fixtures and AR in-test, Browser Factory
 
 # SAFARI ISSUES
 # Labels are not clickable
@@ -67,10 +69,35 @@ def safari.reddit
   puts "FAILURE reddit" unless contains_text("foo") and contains_text("logout")  
 end
 
+def safari.colbert
+  goto("http://www.colbertnation.com/cn/contact.php")
+  text_field(:name, "formmessage").set("Beware the Bear")
+  button(:value, "Send Email").click
+  puts "FAILURE colbert" unless text_field(:name, "formmessage").verify_contains("Enter message")  
+end
+
+def safari.redsquirrel
+  goto("http://redsquirrel.com/")
+  begin
+    text_field(:id, "not_there").set("imaginary")
+    puts "FAILURE squirrel text no e"
+  rescue Watir::UnknownObjectException => e
+    puts "FAILURE squirrel text bad e" unless e.message =~ /not_there/
+  end
+  begin
+    link(:text, "no_where").click
+    puts "FAILURE squirrel link no e"
+  rescue Watir::UnknownObjectException => e
+    puts "FAILURE squirrel link bad e" unless e.message =~ /no_where/
+  end
+end
+
 safari.google_to_prag
 safari.ala
 safari.amazon
 safari.google_advanced
 safari.reddit
+safari.colbert
+safari.redsquirrel
 
 safari.close

metadata

@@ -3,8 +3,8 @@ 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
+  version: 0.1.1
+date: 2006-07-23 00:00:00 -05:00
 summary: Automated testing tool for web applications.
 require_paths: 
 - .