safariwatir 0.1.1 → 0.1.2

data/safariwatir.rb

@@ -5,33 +5,67 @@ require 'safariwatir/core_ext'
 module Watir
   include Watir::Exception
 
-  module Clickable
-    def click
-      @scripter.highlight(self) do
-        click_element
-      end
-    end    
+  module PageContainer
+    def html
+      @scripter.document_html
+    end
+    
+    def text
+      @scripter.document_text
+    end
   end
 
-  module Elements
+  module Container
+    attr_reader :scripter
+    private :scripter
+
+    module Clickable
+      def click
+        @scripter.highlight(self) do
+          click_element
+        end
+      end    
+    end
+
     class AlertWindow
-      def initialize(scripter)
-        @scripter = scripter
-      end
+      def_init :scripter
       
       def click
         @scripter.click_alert_ok
       end
     end
 
+    class Frame
+      include Container
+      include PageContainer
+      
+      attr_reader :name
+      
+      def initialize(scripter, name)
+        @name = name
+        @scripter = scripter.for_frame(self)
+      end
+    end
+
     class HtmlElement
       def_init :scripter, :how, :what
       attr_reader :how, :what
 
-      # Hooks for subclasses
-      def tag; end
-      def speak; end
+      # overridden in derivitives
+      def tag
+        raise RuntimeError, "tag not provided for #{name}"
+      end
 
+      # overridden in derivitives
+      def speak
+        @scripter.speak("#{name}'s don't know how to speak.")
+      end
+
+      def exists?
+        @scripter.element_exists?(self)
+      end
+      alias :exist? :exists?
+      
       def name
         self.class.name.split("::").last
       end
@@ -79,12 +113,15 @@ module Watir
         @scripter.speak_value_of(self)
       end
 
-      # Hooks for subclasses
+      def tag; "INPUT"; end
+
+      # Hook for derivitives
       def by_value; end
     end
     
     class ContentElement < HtmlElement
       include Clickable
+      include Container
 
       def text
         @scripter.get_text_for(self)
@@ -107,9 +144,12 @@ module Watir
     end
 
     class Div < ContentElement
+      def tag; "DIV"; end
     end
 
     class Label < ContentElement
+      def tag; "LABEL"; end
+      
       protected
       
       def operate_by_text(&block)
@@ -117,12 +157,14 @@ module Watir
       end
     end
 
-    class Link < InputElement
+    class Link < ContentElement
       def click
         @scripter.highlight(self) do
           click_link
         end
       end
+
+      def tag; "A"; end
     end
 
     class Radio < Checkbox
@@ -130,23 +172,110 @@ module Watir
 
     class SelectList < InputElement
       def select(label)
-        @scripter.highlight(self) do
-          select_option(:text, label)
-        end
+        option(:text, label).select
       end
-
+      
       def select_value(value)
-        @scripter.highlight(self) do
-          select_option(:value, value)
-        end
+        option(:value, value).select
+      end
+      
+      def option(how, what)
+        Option.new(@scripter, self, how, what)
       end
       
       def speak
         @scripter.speak_options_for(self)
       end
+      
+      def tag; "SELECT"; end
+    end
+
+    class Option < InputElement
+      def_init :scripter, :select_list, :how, :what
+      
+      def select
+        @scripter.highlight(self) do
+          select_option
+        end
+      end
+      
+      def operate(&block)
+        @select_list.operate(&block)
+      end
+
+      def exists?
+        @scripter.option_exists?(self)
+      end
+      alias :exist? :exists?
+      
+      def tag; "OPTION"; end
     end
 
     class Span < ContentElement
+      def tag; "SPAN"; end
+    end
+
+    class Table
+      def_init :scripter, :how, :what
+      attr_reader :how, :what
+      
+      def each
+        # TODO
+      end
+      
+      def [](index)
+        TableRow.new(@scripter, :index, index, self)
+      end
+      
+      def row_count
+        # TODO
+      end
+      
+      def column_count
+        # TODO
+      end
+    end
+    
+    class TableRow
+      def initialize(scripter, how, what, table = nil)
+        @scripter = scripter
+        @how = how
+        @what = what
+        @table = table
+      end
+
+      attr_reader :table, :how, :what
+            
+      def each
+        # TODO
+      end
+      
+      def [](index)
+        TableCell.new(@scripter, :index, index, self)
+      end
+
+      def column_count
+        # TODO
+      end
+    end
+    
+    class TableCell < ContentElement
+      def initialize(scripter, how, what, row = nil)
+        @scripter = scripter.for_table(self)
+        @how = how
+        @what = what
+        @row = row
+      end
+      
+      attr_reader :how, :what, :row
+
+      def operate_by_index(&block)
+        @scripter.operate_by_table_cell_index(self, &block)
+      end
+
+      def operate(&block)
+        @scripter.operate_by_table_cell(self, &block)
+      end
     end
 
     class TextField < InputElement
@@ -171,43 +300,18 @@ module Watir
 
     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
+    # Elements
     
-    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 cell(how, what)
+      TableCell.new(scripter, how, what)
+    end
+
     def checkbox(how, what, value = nil)
       Checkbox.new(scripter, how, what, value)
     end
@@ -220,6 +324,10 @@ module Watir
       Form.new(scripter, how, what)
     end
 
+    def frame(name)
+      Frame.new(scripter, name)
+    end
+    
     def image(how, what)
       Button.new(scripter, how, what)
     end
@@ -240,6 +348,10 @@ module Watir
       Radio.new(scripter, how, what, value)
     end
 
+    def row(how, what)
+      TableRow.new(scripter, how, what)
+    end
+
     def select_list(how, what)
       SelectList.new(scripter, how, what)
     end
@@ -247,21 +359,56 @@ module Watir
     def span(how, what)
       Span.new(scripter, how, what)
     end
+
+    def table(how, what)
+      Table.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
+      when Regexp:
+        text =~ what
+      when String:
+        text.index(what)
+      else
+        raise MissingWayOfFindingObjectException
+      end
+    end
+  end
+
+  class Safari
+    include Container
+    include PageContainer
+
+    def self.start(url = nil)
+      safari = new
+      safari.goto(url) if url
+      safari
+    end
+    
+    def initialize
+      @scripter = AppleScripter.new
+      @scripter.ensure_window_ready
+    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
   end # class Safari
 end

data/safariwatir/scripter.rb

@@ -1,38 +1,97 @@
+require File.dirname(__FILE__) + '/core_ext'
+require File.dirname(__FILE__) + '/../watir/exceptions'
+
 module Watir
-  NOT_FOUND = "__safari_watir_unfound__"
+  ELEMENT_NOT_FOUND = "__safari_watir_element_unfound__"
+  FRAME_NOT_FOUND = "__safari_watir_frame_unfound__"
   NO_RESPONSE = "__safari_watir_no_response__"
+  TABLE_CELL_NOT_FOUND = "__safari_watir_cell_unfound__"
 
-  module JavaScripter
-    def js_operation(locator, operation)
-      js_wrapper(%|
+  class JavaScripter    
+    def operate(locator, operation)
+      wrap(%|
 #{locator}
 if (element) {
   #{operation}
 } else {
-  return '#{NOT_FOUND}';
+  return '#{ELEMENT_NOT_FOUND}';
 }|)
     end
     
-    def js_wrapper(script)
+    def wrap(script)
+      script.gsub! "DOCUMENT", "document"
       %|set response to do JavaScript "#{script}" in document 1|
     end
+
+    def find_cell(cell)
+      return %|getElementById('#{cell.what}')| if cell.how == :id
+      raise RuntimeError, "Unable to use #{cell.how} to find TableCell" unless cell.row
+
+      finder = 
+      case cell.row.how
+      when :id:
+        %|getElementById('#{cell.row.what}')|
+      when :index:
+        case cell.row.table.how
+        when :id
+          %|getElementById('#{cell.row.table.what}').rows[#{cell.row.what-1}]|
+        when :index:
+          %|getElementsByTagName('TABLE')[#{cell.row.table.what-1}].rows[#{cell.row.what-1}]|
+        else
+          raise MissingWayOfFindingObjectException, "Table element does not support #{cell.row.table.how}"
+        end
+      else
+        raise MissingWayOfFindingObjectException, "TableRow element does not support #{cell.row.how}"
+      end
+      
+      finder + %|.cells[#{cell.what-1}]|
+    end
+  end
+
+  class FrameJavaScripter < JavaScripter
+    def initialize(frame)
+      @page_container = "parent.#{frame.name}"
+    end
+
+    def wrap(script)
+      # add in frame name when referencing parent or document
+      script.gsub! "parent", "parent.#{@page_container}"
+      script.gsub! "document", "#{@page_container}.document"
+      super(script)
+    end
+  end
+
+  class TableJavaScripter < JavaScripter
+    def_init :cell
+    
+    def wrap(script)
+      script.gsub! "document", "document." + find_cell(@cell)
+      super(script)
+    end
   end
   
   class AppleScripter
-    include JavaScripter
     include Watir::Exception
     
+    attr_reader :js
+    private :js
+    
     TIMEOUT = 10
   
-    def initialize
-      ensure_window_ready
+    def initialize(scripter = JavaScripter.new)
+      @js = scripter
     end
-          
-    def close
-      execute(%|close document 1|)
+              
+    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
 
-    def quit
+    def close
       execute(%|quit|)
     end
   
@@ -40,24 +99,25 @@ if (element) {
       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)
+    def operate_by_table_cell(element = @element)      
+      js.wrap(%|
+var element = document;
+if (element == undefined) {
+  return '#{TABLE_CELL_NOT_FOUND}';
+}
+#{yield}|)
     end
-
+        
     def get_value_for(element = @element)
       execute(element.operate { %|return element.value;| }, element)
     end
       
     def document_text
-      execute(js_wrapper(%|document.getElementsByTagName('BODY').item(0).innerText;|))
+      execute(js.wrap(%|document.getElementsByTagName('BODY').item(0).innerText;|))
     end
       
     def highlight(element, &block)
@@ -74,29 +134,38 @@ element.style.backgroundColor = 'yellow';|
       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)
+    def element_exists?(element = @element, &block)
+      block ||= Proc.new {}
+      execute(element.operate(&block), element)
+      return true
+      rescue UnknownObjectException
+      return false
     end
 
-    def select_option(option_how, option_what, element = @element)
+    def select_option(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;
-  }
-}|
+        handle_option(element, %|element.options[i].selected = true;|)
       end, element)
     end
     
+    def option_exists?(element = @element)
+      element_exists?(element) { handle_option(element) }
+    end
+    
+    def handle_option(select_list, selection = nil)
+%|var option_found = false;
+for (var i = 0; i < element.options.length; i++) {
+  if (element.options[i].#{select_list.how} == '#{select_list.what}') {
+    #{selection}
+    option_found = true;
+  }
+}
+if (!option_found) {
+  return '#{ELEMENT_NOT_FOUND}';
+}|      
+    end
+    private :handle_option
+    
     def clear_text_input(element = @element)
       execute(element.operate { %|element.value = '';| }, element)
     end
@@ -110,29 +179,69 @@ element.setSelectionRange(element.value.length, element.value.length);|
 
     # TODO need a better approach for "waiting"
     def click_element(element = @element)
-      execute_and_wait(element.operate { %|element.click();| })
+      execute_and_wait(element.operate { %|
+if (element.click) {
+  element.click();
+} else {
+  var event = document.createEvent('MouseEvents');
+  event.initEvent('click', true, true);
+  element.dispatchEvent(event);
+
+  if (element.onclick) {
+    var event = document.createEvent('HTMLEvents');
+    event.initEvent('click', true, true);
+    element.onclick(event);
+  }
+}| })
     end
   
     def click_link(element = @element)      
-      click = find_link(element) + %|
-var click = document.createEvent('HTMLEvents');
+      click = %/
+function baseTarget() {
+  var bases = document.getElementsByTagName('BASE');
+  if (bases.length > 0) {
+    return bases[0].target;
+  } else {
+    return;
+  }
+}
+function undefinedTarget(target) {
+  return target == undefined || target == '';
+}
+function topTarget(target) {
+  return undefinedTarget(target) || target == '_top';
+}
+function nextLocation(element) {
+  var target = element.target;
+  if (undefinedTarget(target) && baseTarget()) {
+    top[baseTarget()].location = element.href;
+  } else if (topTarget(target)) {
+    top.location = element.href;
+  } else {
+    top[target].location = element.href;    
+  }
+}
+var click = DOCUMENT.createEvent('HTMLEvents');
 click.initEvent('click', true, true);
 if (element.onclick) {
  	if (false != element.onclick(click)) {
-		return element.href;
+		nextLocation(element);
 	}
 } else {
-	return element.href;
-}|
-      execute_and_wait(%|set target to do JavaScript "#{click}" in document 1
-set URL in document 1 to target|)
+	nextLocation(element);
+}/
+      execute_and_wait(js.operate(find_link(element), click))
     end
 
     def operate_on_link(element)
-      js_operation(find_link(element), yield)
+      js.operate(find_link(element), yield)
     end
 
     def find_link(element)
+      case element.how
+      when :index:
+%|var element = document.getElementsByTagName('A')[#{element.what-1}];|
+      else
 %|var element = undefined;
 for (var i = 0; i < document.links.length; i++) {
   if (document.links[i].#{handle_match(element)}) {
@@ -140,6 +249,7 @@ for (var i = 0; i < document.links.length; i++) {
     break;
   }
 }|
+      end
     end
     private :find_link
 
@@ -147,15 +257,17 @@ for (var i = 0; i < document.links.length; i++) {
       how = {:text => "text", :url => "href"}[element.how]
       case element.what
         when Regexp:
-          %|#{how}.match(/#{element.what.source}/)|          
+          %|#{how}.match(/#{element.what.source}/#{element.what.casefold? ? "i":nil})|          
         when String:
           %|#{how} == '#{element.what}'|
+        else
+          raise RuntimeError, "Unable to locate #{element.name} with #{element.how}"
       end
     end
     private :handle_match
   
     def operate_by_input_value(element)
-      js_operation(%|
+      js.operate(%|
 var elements = document.getElementsByTagName('INPUT');
 var element = undefined;
 for (var i = 0; i < elements.length; i++) {
@@ -169,7 +281,7 @@ for (var i = 0; i < elements.length; i++) {
     end
 
     def operate_by_name(element)
-      js_operation(%|
+      js.operate(%|
 var elements = document.getElementsByName('#{element.what}');
 var element = undefined;
 for (var i = 0; i < elements.length; i++) {
@@ -192,15 +304,15 @@ for (var i = 0; i < elements.length; i++) {
     private :handle_form_element_name_match
 
     def operate_by_id(element)
-      js_operation("var element = document.getElementById('#{element.what}');", yield)
+      js.operate("var element = document.getElementById('#{element.what}');", yield)
     end
 
     def operate_by_index(element)
-      js_operation(%|var element = document.getElementsByTagName('#{element.tag}')[#{element.what}];|, yield)
+      js.operate(%|var element = document.getElementsByTagName('#{element.tag}')[#{element.what-1}];|, yield)
     end
 
     def operate_on_label(element)
-      js_operation(%|var elements = document.getElementsByTagName('LABEL');
+      js.operate(%|var elements = document.getElementsByTagName('LABEL');
 var element = undefined;
 for (var i = 0; i < elements.length; i++) {
   if (elements[i].innerText == '#{element.what}') {
@@ -223,10 +335,51 @@ tell window 1
 end tell|)
     end 
 
+    def for_table(element)
+      AppleScripter.new(TableJavaScripter.new(element))
+    end
+
+    def for_frame(element)
+      # verify the frame exists
+      execute(js.wrap(%|
+if (parent.#{element.name} == undefined) {
+  return '#{FRAME_NOT_FOUND}';
+}|), element)
+      AppleScripter.new(FrameJavaScripter.new(element))
+    end
+
+    def speak_value_of(element = @element)
+      speak(get_value_for(element))
+    end
+
+    def speak_text_of(element = @element)
+      speak(element.text)
+    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 speak(string)
+`osascript <<SCRIPT
+say "#{string.quote_safe}"
+SCRIPT`
+      nil
+    end 
+
+
     private
 
     def execute!(script)
-# puts script
 `osascript <<SCRIPT
 tell application "Safari"
   set response to "#{NO_RESPONSE}"
@@ -239,10 +392,14 @@ SCRIPT`.chomp
     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
+        when ELEMENT_NOT_FOUND:
+          raise UnknownObjectException, "Unable to locate #{element.name} element with #{element.how} of #{element.what}" 
+        when TABLE_CELL_NOT_FOUND:
+          raise UnknownCellException, "Unable to locate a table cell with #{element.how} of #{element.what}"
+        when FRAME_NOT_FOUND:
+          raise UnknownFrameException, "Unable to locate a frame with name #{element.name}" 
         else
           response
       end
@@ -263,33 +420,18 @@ SCRIPT`
       nil
     end
 
-    def execute_and_wait(script, element = nil)
+    def execute_and_wait(script, element = nil)      
       execute(%|
 #{script}
 delay 2
 repeat with i from 1 to #{TIMEOUT}
-  if (do JavaScript "document.readyState" in document 1) is "complete" then
+  #{js.wrap("document.readyState")}
+  if (response) is "complete" then
     exit repeat
   else
     delay 1
   end if
 end repeat|, element)
     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
-    
-    def speak(string)
-`osascript <<SCRIPT
-say "#{string.quote_safe}"
-SCRIPT`
-      nil
-    end
   end # class AppleScripter
 end

data/safariwatir_script.rb

@@ -3,12 +3,12 @@ require 'safariwatir'
 
 # TODO 
 # 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
+# Be more attached to the Safari window. Currently, 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: UL/OL
-# Use dynamic properties for Javascript optimization?
+# Unsupported Elements: Test that P/Div/Span/TD handle link, button, etc., Javascript confirm [OK/CANCEL], Javascript prompt, Javascript popup windows
+# Use dynamic properties for Javascript optimization? Or use global lookup table?
 # 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 test generator, fixtures and AR in-test, Browser Factory
@@ -24,10 +24,12 @@ 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(:text, "Programming Ruby, 2nd Ed.").click
   link(:url, "http://www.pragmaticprogrammer.com/titles/ruby/code/index.html").click
   link(:text, "Catalog").click
-  link(:text, "All Books").click
+  # site was down
+  # link(:text, "All Books").click
+  goto("http://pragmaticprogrammer.com/bookshelf/") # workaround
   link(:text, /Agile Retrospectives/).click
   puts "FAILURE prag" unless contains_text("Dave Hoover")  
 end
@@ -46,7 +48,7 @@ def safari.amazon
   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)")
+  puts "FAILURE amazon" unless contains_text("Master of Orion")
 end
 
 def safari.google_advanced
@@ -65,7 +67,7 @@ def safari.reddit
   goto("http://reddit.com/")
   text_field(:name, "user").set("foo")
   password(:name, "passwd").set("bar")
-  form(:index, 1).submit
+  form(:index, 2).submit
   puts "FAILURE reddit" unless contains_text("foo") and contains_text("logout")  
 end
 
@@ -92,6 +94,34 @@ def safari.redsquirrel
   end
 end
 
+def safari.weinberg
+  goto("http://www.geraldmweinberg.com/")
+  puts "FAILURE weinberg menu" unless frame("menu").contains_text("Jerry Weinberg's Site")
+  frame("menu").link(:text, "Books").click
+  frame("menu").link(:text, /psychology/i).click
+  puts "FAILURE weinberg content" unless frame("content").contains_text("Silver Anniversary")  
+end
+
+def safari.tables
+  goto("http://basecamphq.com/")
+  puts "FAILURE basecamp content" unless table(:index, 1)[1][2].text =~ /What is Basecamp\?/
+  
+  goto("http://www.jimthatcher.com/webcourse9.htm")
+  puts "FAILURE thatcher" unless cell(:id, "c5").text == "subtotals"
+  
+  goto("http://amazon.com/")
+  if contains_text("If you're not")
+    link(:text, "click here").click
+  end
+    
+  puts "FAILURE amazon tr" unless row(:id, "twotabtop")[2].text =~ /Your\s+Amazon\.com/
+  row(:id, "twotabtop")[2].link(:index, 1).click
+  puts "FAILURE amazon link" unless contains_text("personalized recommendations")
+    
+  goto("http://www.dreamweaverresources.com/tutorials/tableborder.htm")
+  puts "FAILURE dreamweaver" unless table(:id, "titletable")[1][1].text =~ /CSS/
+end
+
 safari.google_to_prag
 safari.ala
 safari.amazon
@@ -99,5 +129,7 @@ safari.google_advanced
 safari.reddit
 safari.colbert
 safari.redsquirrel
+safari.weinberg
+safari.tables
 
 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.1
-date: 2006-07-23 00:00:00 -05:00
+  version: 0.1.2
+date: 2006-10-12 00:00:00 -05:00
 summary: Automated testing tool for web applications.
 require_paths: 
 - .