caius-safariwatir 0.3.4

data/README.rdoc

@@ -0,0 +1,46 @@
+= SafariWatir
+
+* http://safariwatir.rubyforge.org
+* http://rubyforge.org/mailman/listinfo/safariwatir-general
+* http://twitter.com/SafariWatir
+
+== DESCRIPTION:
+
+We are putting Watir on Safari.
+The original Watir (Web Application Testing in Ruby) project supports only IE on Windows.
+This project aims at adding Watir support for Safari on the Mac.
+
+== Requirements
+
+Mac OS X running Safari. Some features require you to turn on "Enable access for assistive devices" in System Preferences > Universal Access.
+
+
+== SYNOPSIS:
+
+  require 'rubygems'
+  require 'safariwatir'
+
+  browser = Watir::Safari.new
+  browser.goto("http://google.com")
+  browser.text_field(:name, "q").set("obtiva")
+  browser.button(:name, "btnI").click
+  puts "FAILURE" unless browser.contains_text("software")
+
+== INSTALL:
+
+  [sudo] gem install safariwatir
+
+ or
+
+  git clone git://github.com/redsquirrel/safariwatir.git
+  cd safariwatir
+  rake install
+
+== RUNNING SAFARIWATIR AGAINST WATIR'S CORE TESTS
+
+  # First, install the SafariWatir gem (see above)
+  svn checkout https://svn.openqa.org/svn/watir/trunk
+  cd trunk/watir
+  cp unittests/options.yml.example unittests/options.yml
+  # Edit unittests/options.yml and set browser: safari
+  ruby unittests/core_tests.rb

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('safariwatir', '0.3.4') do | config |
+  config.summary = %q{Automated testing tool for web applications.}
+  config.description = %q{WATIR stands for "Web Application Testing in Ruby".  See WATIR project for more information.  This is a Safari-version of the original IE-only WATIR.}
+  config.url = 'http://safariwatir.rubyforge.org/'
+  config.author = 'Dave Hoover'
+  config.email = 'dave@obtiva.com'
+  config.ignore_pattern = ['tmp/*', 'script/*']
+  config.development_dependencies = ["rb-appscript"]
+end

data/lib/safariwatir.rb

@@ -0,0 +1,541 @@
+require 'watir/exceptions'
+require 'safariwatir/scripter'
+require 'safariwatir/core_ext'
+
+module Watir
+  include Watir::Exception
+
+  module PageContainer
+    def html
+      @scripter.document_html
+    end
+    
+    def text
+      @scripter.document_text
+    end
+
+    def title
+      @scripter.document_title
+    end
+  end
+
+  module Container
+    attr_reader :scripter
+    private :scripter
+
+    DEFAULT_TYPING_LAG = 0.08
+
+    def set_fast_speed
+      @scripter.typing_lag = 0
+    end
+    
+    def set_slow_speed
+      @scripter.typing_lag = DEFAULT_TYPING_LAG
+    end
+    
+    def speed=(how_fast)
+      case how_fast
+      when :fast : set_fast_speed
+      when :slow : set_slow_speed
+      else
+        raise ArgumentError, "Invalid speed: #{how_fast}"
+      end
+    end
+
+    module Clickable
+      def click
+        @scripter.highlight(self) do
+          click_element
+        end
+      end    
+    end
+
+    class AlertWindow
+      def_init :scripter
+      
+      def click
+        @scripter.click_alert
+      end
+    end
+
+    class SecurityWarningWindow
+      def initialize(scripter, url)
+        @scripter = scripter
+        @url = url
+      end
+      
+      def continue
+        handle_click("Continue")
+      end
+      
+      def cancel
+        handle_click("Cancel")
+      end
+      
+    private
+      def handle_click(button)
+        if @url
+          @scripter.navigate_to(@url) do
+            @scripter.click_security_warning(button)
+          end
+        else
+          @scripter.click_security_warning(button)
+        end
+      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
+
+      # 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
+
+      def operate(&block)
+        scripter_suffix = OPERATIONS[how]
+        if scripter_suffix.kind_of? Hash
+          scripter_suffix = scripter_suffix[name]
+        end
+        if scripter_suffix.nil?
+          raise "SafariWatir does not currently support finding by #{how}"
+        end
+        @scripter.send("operate_#{scripter_suffix}", self, &block)        
+      end
+
+      OPERATIONS = {
+        :id => "by_id",
+        :index => "by_index",
+        :class => "by_class",
+        :name => "by_name",
+        :text => { "Link" => "on_link", "Label" => "by_text" },
+        :url => "on_link",
+        :value => "by_input_value",
+        :caption => "by_input_value",
+        :src => "by_src",
+      }
+    end
+
+    class Form < HtmlElement
+      def_init :scripter, :how, :what
+
+      def submit
+        @scripter.submit_form(self)
+      end
+      
+      def tag; "FORM"; end
+    end
+    
+    class InputElement < HtmlElement
+      include Clickable
+      
+      def speak
+        @scripter.speak_value_of(self)
+      end
+
+      def tag; "INPUT"; end
+
+      # Hook for derivitives
+      def by_value; end
+    end
+    
+    class ContentElement < HtmlElement
+      include Clickable
+      include Container
+
+      def html
+        @scripter.get_html_for(self)
+      end
+
+      def text
+        @scripter.get_text_for(self)
+      end
+
+      def speak
+        @scripter.speak_text_of(self)
+      end      
+    end
+    
+    class Image < HtmlElement
+      include Clickable
+      
+      def tag; "IMG"; end
+    end
+    
+    class Button < InputElement
+    end
+        
+    class Checkbox < InputElement
+      def_init :scripter, :how, :what, :value
+      
+      def by_value
+        @value
+      end
+
+      # Contributed by Kyle Campos
+      def checked?
+        @scripter.checkbox_is_checked?(self)
+      end
+      
+      def set(check_it = true)
+        return if check_it && checked?
+        return if !check_it && !checked?
+        click
+      end
+    end
+
+    class Div < ContentElement
+      def tag; "DIV"; end
+    end
+
+    class Label < ContentElement
+      def tag; "LABEL"; end
+    end
+
+    class Link < ContentElement
+      def click
+        @scripter.highlight(self) do
+          click_link
+        end
+      end
+
+      def tag; "A"; end
+    end
+
+    class Radio < Checkbox
+    end
+
+    class SelectList < InputElement
+      def select(label)
+        option(:text, label).select
+      end
+      
+      def select_value(value)
+        option(:value, value).select
+      end
+      
+      def option(how, what)
+        Option.new(@scripter, self, how, what)
+      end
+      
+      def selected_values
+        values = []
+        index = 1
+        loop do
+          option = option(:index, index)
+          break unless option.exists?
+          values << option if option.selected?
+          index += 1
+        end
+        values.map {|o| o.text } #TODO?
+      end
+
+      def selected_value
+        selected_values.first
+      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 selected?
+        @scripter.option_selected?(self)
+      end
+      
+      def text
+        @scripter.get_text_for(self)
+      end
+
+      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
+
+      def tag; "TABLE"; 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
+
+      def tag; "TR"; end
+    end
+    
+    class TableCell < ContentElement
+      def initialize(scripter, how, what, row = nil)
+        @scripter = scripter.for_table(self)
+        set_slow_speed # TODO: Need to inherit this somehow
+
+        @how = how
+        @what = what
+        @row = row
+      end
+      
+      attr_reader :how, :what, :row
+
+      def operate(&block)
+        @scripter.operate_by_table_cell(self, &block)
+      end
+
+      def tag; "TD"; end
+    end
+
+    class TextField < InputElement
+      def set(value)
+        value = value.to_s
+        @scripter.focus(self)
+        @scripter.highlight(self) do
+          clear_text_input
+          value.length.times do |i|
+            append_text_input(value[i, 1])
+          end
+        end
+        @scripter.blur(self)
+      end
+      
+      def getContents
+        @scripter.get_value_for(self)
+      end
+      
+      def verify_contains(expected)
+        actual = getContents
+        case expected
+        when Regexp
+          actual.match(expected) != nil
+        else
+          expected == actual
+        end
+      end
+    end
+
+    class Password < TextField
+    end
+
+
+    # Elements
+    
+    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
+
+    def div(how, what)
+      Div.new(scripter, how, what)
+    end
+
+    def form(how, what)
+      Form.new(scripter, how, what)
+    end
+
+    def frame(name)
+      Frame.new(scripter, name)
+    end
+    
+    def image(how, what)
+      Image.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 row(how, what)
+      TableRow.new(scripter, how, what)
+    end
+
+    def select_list(how, what)
+      SelectList.new(scripter, how, what)
+    end
+    
+    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)
+      case what
+      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(JavaScripter.new)
+      @scripter.ensure_window_ready
+      set_slow_speed
+    end
+    
+    # URL of page
+    def url
+        scripter.url
+    end
+        
+    def close
+      scripter.close
+    end
+    
+    def quit
+      scripter.quit
+    end
+    
+    def alert
+      AlertWindow.new(scripter)
+    end
+
+    def security_warning
+      SecurityWarningWindow.new(scripter)
+    end
+
+    def security_warning_at(url)
+      SecurityWarningWindow.new(scripter, url)
+    end
+    
+    def goto(url)
+      scripter.navigate_to(url)
+    end
+    
+    # Reloads the page
+    def reload
+      scripter.reload
+    end
+  end # class Safari
+
+  
+  class WebKit < Safari
+    def initialize
+      @scripter = AppleScripter.new(JavaScripter.new,:appname => "WebKit")
+      @scripter.ensure_window_ready
+      set_slow_speed
+    end
+  end # class WebKit
+    
+end