commonwatir 1.6.5 → 1.6.6.rc1

data/lib/watir/browsers.rb

@@ -1,12 +1,13 @@
-# watir/browsers
-# Define browsers supported by Watir
-
-Watir::Browser.support :name => 'ie', :class => 'Watir::IE', 
-  :library => 'watir/ie', :gem => 'watir', 
-  :options => [:speed, :visible]
-
-Watir::Browser.support :name => 'firefox', :class => 'FireWatir::Firefox',
-  :library => 'firewatir'
-
-Watir::Browser.support :name => 'safari', :class => 'Watir::Safari',
-  :library => 'safariwatir'
+#--
+# watir/browsers
+# Define browsers supported by Watir
+
+Watir::Browser.support :name => 'ie', :class => 'Watir::IE', 
+  :library => 'watir/ie', :gem => 'watir', 
+  :options => [:speed, :visible]
+
+Watir::Browser.support :name => 'firefox', :class => 'FireWatir::Firefox',
+  :library => 'firewatir'
+
+Watir::Browser.support :name => 'safari', :class => 'Watir::Safari',
+  :library => 'safariwatir'

data/lib/watir/exceptions.rb

@@ -1,48 +1,48 @@
-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
-
-    # Return an error message for when unable to locate the element
-    def self.message_for_unable_to_locate(how, what)
-      result = "using #{how.inspect}"
-      result << ", #{what.inspect}" if what
-      "Unable to locate element, #{result}"
-    end    
-  end
+module Watir
+  module Exception
+
+    # Root class for all Watir Exceptions
+    class WatirException < RuntimeError  
+			def initialize(message="")
+				super(message)
+			end
+    end
+    
+    # This exception is raised if an attempt is made to access an object that doesn't exist
+    class UnknownObjectException < WatirException; end
+    # This exception is raised if an attempt is made to access an object that is in a disabled state
+    class ObjectDisabledException   < WatirException; end
+    # This exception is raised if an attempt is made to access a frame that cannot be found
+    class UnknownFrameException< WatirException; end
+    # This exception is raised if an attempt is made to access a form that cannot be found
+    class UnknownFormException< WatirException; end
+    # This exception is raised if an attempt is made to access an object that is in a read only state
+    class ObjectReadOnlyException  < WatirException; end
+    # This exception is raised 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 raised if the window cannot be found
+    class NoMatchingWindowFoundException < WatirException; end
+    # This exception is raised if an attemp is made to acces the status bar of the browser when it doesnt exist
+    class NoStatusBarException < WatirException; end
+    # This exception is raised 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
+
+    # Return an error message for when unable to locate the element
+    def self.message_for_unable_to_locate(how, what)
+      result = "using #{how.inspect}"
+      result << ", #{what.inspect}" if what
+      "Unable to locate element, #{result}"
+    end    
+  end
 end

data/lib/watir/matches.rb

@@ -1,17 +1,17 @@
-class String
-  def matches(x)
-    return self == x
-  end
-end
-
-class Regexp
-  def matches(x)
-    return self.match(x)
-  end
-end
-
-class Integer
-  def matches(x)
-    return self == x
-  end
-end
+class String
+  def matches(x)
+    return self == x
+  end
+end
+
+class Regexp
+  def matches(x)
+    return self.match(x)
+  end
+end
+
+class Integer
+  def matches(x)
+    return self == x
+  end
+end

data/lib/watir/options.rb

@@ -1,52 +1,53 @@
-# watir/options
-require 'rubygems'
-
-require 'user-choices'
-
-module Watir
-  @@options_file = nil
-  @@options = nil
-  class << self
-    # Specify the location of a yaml file containing Watir options. Must be
-    # specified before the options are parsed.
-    def options_file= file
-      @@options_file = file
-    end
-    def options_file
-      @@options_file
-    end
-    def options= x
-      @@options = x
-    end
-    # Return the Watir options, as a hash. If they haven't been parsed yet,
-    # they will be now.
-    def options
-      @@options ||= Watir::Options.new.execute
-    end
-  end
-
-  class Options < UserChoices::Command
-    include UserChoices
-    def add_sources builder
-      builder.add_source EnvironmentSource, :with_prefix, 'watir_'
-      if Watir.options_file
-        builder.add_source YamlConfigFileSource, :from_complete_path, 
-          Watir.options_file
-      end
-    end
-    def add_choices builder
-      builder.add_choice :browser, 
-      :type => Watir::Browser.browser_names, 
-      :default => Watir::Browser.default
-      builder.add_choice :speed, 
-      :type => ['slow', 'fast', 'zippy'], 
-      :default => 'fast'
-      builder.add_choice :visible,
-      :type => :boolean
-    end
-    def execute 
-      @user_choices[:speed] = @user_choices[:speed].to_sym
-      @user_choices
-    end 
-  end
-end
+#--
+# watir/options
+require 'rubygems'
+
+require 'user-choices'
+
+module Watir
+  @@options_file = nil
+  @@options = nil
+  class << self
+    # Specify the location of a yaml file containing Watir options. Must be
+    # specified before the options are parsed.
+    def options_file= file
+      @@options_file = file
+    end
+    def options_file
+      @@options_file
+    end
+    def options= x
+      @@options = x
+    end
+    # Return the Watir options, as a hash. If they haven't been parsed yet,
+    # they will be now.
+    def options
+      @@options ||= Watir::Options.new.execute
+    end
+  end
+
+  class Options < UserChoices::Command
+    include UserChoices
+    def add_sources builder
+      builder.add_source EnvironmentSource, :with_prefix, 'watir_'
+      if Watir.options_file
+        builder.add_source YamlConfigFileSource, :from_complete_path, 
+          Watir.options_file
+      end
+    end
+    def add_choices builder
+      builder.add_choice :browser, 
+      :type => Watir::Browser.browser_names, 
+      :default => Watir::Browser.default
+      builder.add_choice :speed, 
+      :type => ['slow', 'fast', 'zippy'], 
+      :default => 'fast'
+      builder.add_choice :visible,
+      :type => :boolean
+    end
+    def execute 
+      @user_choices[:speed] = @user_choices[:speed].to_sym
+      @user_choices
+    end 
+  end
+end

data/lib/watir/testcase.rb

@@ -1,58 +1,97 @@
-require 'test/unit'
-require 'watir/assertions'
-
-module Watir
-
-  class TestCase < Test::Unit::TestCase
-    include Watir::Assertions
-    @@order = :sequentially
-    def initialize name
-      throw :invalid_test if name == :default_test && self.class == Watir::TestCase
-      super
-    end        
-    class << self
-      attr_accessor :test_methods, :order
-      def test_methods
-        @test_methods ||= []
-      end
-      def order
-        @order || @@order
-      end
-      def default_order= order
-        @@order = order
-      end
-      def sorted_test_methods
-        case order
-        when :alphabetically then          test_methods.sort
-        when :sequentially then            test_methods
-        when :reversed_sequentially then   test_methods.reverse
-        when :reversed_alphabetically then test_methods.sort.reverse
-        else raise ArgumentError, "Execute option not supported: #{@order}"
-        end
-      end
-      def suite
-        suite = Test::Unit::TestSuite.new(name)
-        sorted_test_methods.each do |test|
-          catch :invalid_test do
-            suite << new(test)
-          end
-        end
-        if (suite.empty?)
-          catch :invalid_test do
-            suite << new(:default_test)
-          end
-        end
-        return suite
-      end
-      def method_added id
-        name = id.id2name
-        test_methods << name if name =~ /^test./
-      end
-      def execute order
-        @order = order
-      end
-    end
-    public :add_assertion
-  end    
-
-end  
+require 'test/unit'
+require 'watir/assertions'
+
+module Watir
+
+  # This is a 'test/unit' testcase customized to exeucte test methods sequentially by default
+  # and extra assertions
+  #
+  # Example Usage
+  #
+  #   require 'watir/testcase'
+  #
+  #   class MyTestCase < Watir::TestCase
+  #
+  #     # some helpers
+  #     @@browser = nil
+  #     def browser
+  #       @browser ||= Watir::IE.start(:url, 'http://watir.com/")
+  #     end
+  #
+  #     # TESTS
+  #     def test_text
+  #       browser.goto "http://watir.com/"
+  #       verify_match "Web Application Testing in Ruby", browser.text
+  #     end
+  #
+  #     def test_title
+  #       verify browser.title == 'Watir'
+  #     end
+  #
+  #     def test_link
+  #       verify_match 'watir.com', browser.link(:text, 'Home').href
+  #     end
+  #
+  #     def test_navigate_to_examples
+  #       browser.div(:id, 'nav').link(:text, 'Examples').click
+  #     end
+  #
+  #     def test_url
+  #       verify_equal browser.url, 'http://watir.com/examples/'
+  #     end
+  #
+  #   end
+  #
+  class TestCase < Test::Unit::TestCase
+    include Watir::Assertions
+    @@order = :sequentially
+    def initialize name
+      throw :invalid_test if name == :default_test && self.class == Watir::TestCase
+      super
+    end        
+    class << self
+      attr_accessor :test_methods, :order
+      def test_methods
+        @test_methods ||= []
+      end
+      def order
+        @order || @@order
+      end
+      def default_order= order
+        @@order = order
+      end
+      def sorted_test_methods
+        case order
+        when :alphabetically then          test_methods.sort
+        when :sequentially then            test_methods
+        when :reversed_sequentially then   test_methods.reverse
+        when :reversed_alphabetically then test_methods.sort.reverse
+        else raise ArgumentError, "Execute option not supported: #{@order}"
+        end
+      end
+      def suite
+        suite = Test::Unit::TestSuite.new(name)
+        sorted_test_methods.each do |test|
+          catch :invalid_test do
+            suite << new(test)
+          end
+        end
+        if (suite.empty?)
+          catch :invalid_test do
+            suite << new(:default_test)
+          end
+        end
+        return suite
+      end
+      def method_added id
+        name = id.id2name
+        test_methods << name if name =~ /^test./
+      end
+      def execute order
+        @order = order
+      end
+    end
+    public :add_assertion
+  end    
+
+end  

data/lib/watir/waiter.rb

@@ -1,92 +1,92 @@
-require 'watir/exceptions'
-
-module Watir
-  
-  def wait_until(*args)
-    Waiter.wait_until(*args) {yield}
-  end  
-
-class TimeKeeper
-  attr_reader :sleep_time
-  def initialize 
-    @sleep_time = 0.0
-  end
-  def sleep seconds
-    @sleep_time += Kernel.sleep seconds    
-  end
-  def now
-    Time.now
-  end
-end
-
-class Waiter
-  # This is an interface to a TimeKeeper which proxies
-  # calls to "sleep" and "Time.now".
-  # Useful for unit testing Waiter.
-  attr_accessor :timer
-
-  # How long to wait between each iteration through the wait_until
-  # loop. In seconds.
-  attr_accessor :polling_interval
-
-  # Timeout for wait_until.
-  attr_accessor :timeout
-  
-  @@default_polling_interval = 0.5
-  @@default_timeout = 60.0
-
-  def initialize(timeout=@@default_timeout,
-                 polling_interval=@@default_polling_interval)
-    @timeout = timeout
-    @polling_interval = polling_interval
-    @timer = TimeKeeper.new
-  end
-
-  # Execute the provided block until either (1) it returns true, or
-  # (2) the timeout (in seconds) has been reached. If the timeout is reached,
-  # a TimeOutException will be raised. The block will always
-  # execute at least once.  
-  # 
-  # waiter = Waiter.new(5)
-  # waiter.wait_until {puts 'hello'}
-  # 
-  # This code will print out "hello" for five seconds, and then raise a 
-  # Watir::TimeOutException.
-  def wait_until # block
-    start_time = now
-    until yield do
-      if (duration = now - start_time) > @timeout
-        raise Watir::Exception::TimeOutException.new(duration, @timeout),
-          "Timed out after #{duration} seconds."
-      end
-      sleep @polling_interval
-    end
-  end  
-
-  # Execute the provided block until either (1) it returns true, or
-  # (2) the timeout (in seconds) has been reached. If the timeout is reached,
-  # a TimeOutException will be raised. The block will always
-  # execute at least once.  
-  # 
-  # Waiter.wait_until(5) {puts 'hello'}
-  # 
-  # This code will print out "hello" for five seconds, and then raise a 
-  # Watir::TimeOutException.  
-
-  # IDEA: wait_until: remove defaults from Waiter.wait_until
-  def self.wait_until(timeout=@@default_timeout,
-                      polling_interval=@@default_polling_interval)
-    waiter = new(timeout, polling_interval)
-    waiter.wait_until { yield }
-  end
-     
-  private
-  def sleep seconds
-    @timer.sleep seconds
-  end
-  def now
-    @timer.now
-  end
-end  
-    
+require 'watir/exceptions'
+
+module Watir
+  
+  def wait_until(*args)
+    Waiter.wait_until(*args) {yield}
+  end  
+
+class TimeKeeper
+  attr_reader :sleep_time
+  def initialize 
+    @sleep_time = 0.0
+  end
+  def sleep seconds
+    @sleep_time += Kernel.sleep seconds    
+  end
+  def now
+    Time.now
+  end
+end
+
+class Waiter
+  # This is an interface to a TimeKeeper which proxies
+  # calls to "sleep" and "Time.now".
+  # Useful for unit testing Waiter.
+  attr_accessor :timer
+
+  # How long to wait between each iteration through the wait_until
+  # loop. In seconds.
+  attr_accessor :polling_interval
+
+  # Timeout for wait_until.
+  attr_accessor :timeout
+  
+  @@default_polling_interval = 0.5
+  @@default_timeout = 60.0
+
+  def initialize(timeout=@@default_timeout,
+                 polling_interval=@@default_polling_interval)
+    @timeout = timeout
+    @polling_interval = polling_interval
+    @timer = TimeKeeper.new
+  end
+
+  # Execute the provided block until either (1) it returns true, or
+  # (2) the timeout (in seconds) has been reached. If the timeout is reached,
+  # a TimeOutException will be raised. The block will always
+  # execute at least once.  
+  # 
+  # waiter = Waiter.new(5)
+  # waiter.wait_until {puts 'hello'}
+  # 
+  # This code will print out "hello" for five seconds, and then raise a 
+  # Watir::TimeOutException.
+  def wait_until # block
+    start_time = now
+    until yield do
+      if (duration = now - start_time) > @timeout
+        raise Watir::Exception::TimeOutException.new(duration, @timeout),
+          "Timed out after #{duration} seconds."
+      end
+      sleep @polling_interval
+    end
+  end  
+
+  # Execute the provided block until either (1) it returns true, or
+  # (2) the timeout (in seconds) has been reached. If the timeout is reached,
+  # a TimeOutException will be raised. The block will always
+  # execute at least once.  
+  # 
+  # Waiter.wait_until(5) {puts 'hello'}
+  # 
+  # This code will print out "hello" for five seconds, and then raise a 
+  # Watir::TimeOutException.  
+
+  # IDEA: wait_until: remove defaults from Waiter.wait_until
+  def self.wait_until(timeout=@@default_timeout,
+                      polling_interval=@@default_polling_interval)
+    waiter = new(timeout, polling_interval)
+    waiter.wait_until { yield }
+  end
+     
+  private
+  def sleep seconds
+    @timer.sleep seconds
+  end
+  def now
+    @timer.now
+  end
+end  
+    
 end # module