watir-classic 3.0.0

data/LICENSE

@@ -0,0 +1,34 @@
+---------------------------------------------------------------------------
+Copyright (c) 2004 - 2006, Paul Rogers
+Copyright (c) 2006 - 2007, Angrez Singh
+Copyright (c) 2004 - 2010, Bret Pettichord
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the names Paul Rogers, nor Bret Pettichord, nor Angrez Singh nor the names of any
+other contributors to this software may be used to endorse or promote
+products derived from this software without specific prior written
+permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+--------------------------------------------------------------------------
+(based on BSD Open Source License)

data/README.rdoc

@@ -0,0 +1,78 @@
+= Watir Classic
+
+Watir, pronounced water, is an open-source (BSD) family of Ruby libraries for automating web browsers. It supports your app no matter what technology it is developed in. They support Internet Explorer on Windows, Firefox and Chrome on Windows, Mac and Linux and Safari on Mac.
+
+Project Home:: http://watir.com
+Source Code:: http://github.com/bret/watir
+Support:: http://watir.com/support
+Gem:: https://rubygems.org/gems/watir
+Gem:: https://rubygems.org/gems/firewatir
+Gem:: https://rubygems.org/gems/commonwatir
+Gem:: https://rubygems.org/gems/safariwatir
+Gem:: https://rubygems.org/gems/watir-webdriver
+Gem:: https://rubygems.org/gems/celerity
+
+== Install
+
+You have to install Ruby and RubyGems first. To be able to drive Firefox you have to install Firefox add-on. Detailed installation instructions are at http://watir.com/installation
+
+=== Windows
+
+To install Internet Explorer and Firefox driver:
+
+  gem update --system
+  gem install watir-classic
+
+== Examples
+
+Some examples from http://watir.com/examples
+
+Loading Watir gem to drive Internet Explorer on Windows
+
+  require 'watir-classic'
+
+Starting a new browser & and going to our site
+
+  browser = Watir::Browser.new
+  browser.goto("http://bit.ly/watir-example")
+
+Setting a text field
+
+  browser.text_field(:name => "entry.0.single").set "Watir"
+
+Setting a multi-line text box
+
+  browser.text_field(:name => "entry.1.single").set "I come here from Australia. \n The weather is great here."
+
+Setting and clearing a radio button
+
+  browser.radio(:value => "Watir").set
+  browser.radio(:value => "Watir").clear
+
+Setting and clearing check boxes
+
+  browser.checkbox(:value => "Ruby").set
+  browser.checkbox(:value => "Python").set
+  browser.checkbox(:value => "Python").clear
+
+Clicking a button
+
+  browser.button(:name => "logon").click
+
+Clearing, getting and selecting selection list values
+
+  browser.select_list(:name => "entry.6.single").clear
+  puts browser.select_list(:name => "entry.6.single").options
+  browser.select_list(:name => "entry.6.single").select "Chrome"
+
+Clicking a button
+
+  browser.button(:name => "submit").click
+
+Checking for text in a page
+
+  puts browser.text.include?("Your response has been recorded.")
+
+Checking the title of a page
+
+  puts browser.title == "Thanks!"

data/VERSION

@@ -0,0 +1 @@
+3.0.0

data/bin/watir-console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+$watir_lib = File.join($root, 'watir-classic', 'lib')
+$libs = "-I #{$watir_lib}"
+exec "irb.bat #{$libs} -r rubygems -r irb/completion -r watir-classic/irb-history -r watir --simple-prompt --readline"

data/lib/watir-classic.rb

@@ -0,0 +1,14 @@
+#--
+#  The 'watir-classic' library loads the common watir-classic code, common to all watir-classic
+# implementations. The 'watir-classic/browser' library will autoload the actual
+# implementations.
+
+require 'watir-classic/version'
+require 'watir-classic/waiter' # this will be removed in some future version
+require 'watir-classic/wait'
+require 'watir-classic/wait_helper'
+require 'watir-classic/element_extensions'
+require 'watir-classic/util'
+require 'watir-classic/exceptions'
+require 'watir-classic/matches'
+require 'watir-classic/browser'

data/lib/watir-classic/assertions.rb

@@ -0,0 +1,44 @@
+require 'test/unit/assertions'
+
+module Watir
+  # Verification methods used by Watir::TestCase
+  module Assertions
+  include Test::Unit::Assertions
+    
+    # Log a failure if the boolean is true. The message is the failure
+    # message logged.
+    # Whether true or false, the assertion count is incremented.
+    def verify boolean, message = 'verify failed.'
+      add_assertion
+      add_failure message.to_s, caller unless boolean
+    end
+    
+    def verify_equal expected, actual, message=nil
+      full_message = build_message(message, <<EOT, expected, actual)
+<?> expected but was
+<?>.
+EOT
+      verify(expected == actual, full_message)
+    end
+    def verify_match pattern, string, message=nil
+      pattern = case(pattern)
+      when String
+        Regexp.new(Regexp.escape(pattern))
+      else
+        pattern
+      end
+      full_message = build_message(message, "<?> expected to be =~\n<?>.", string, pattern)
+      verify(string =~ pattern, full_message)
+    end
+    
+  end
+
+end
+module Test::Unit::Assertions
+    def assert_false(boolean, message=nil)
+        _wrap_assertion do
+            assert_block("assert should not be called with a block.") { !block_given? }
+            assert_block(build_message(message, "<?> is not false.", boolean)) { !boolean }
+        end
+    end
+end 

data/lib/watir-classic/browser.rb

@@ -0,0 +1,149 @@
+# watir-classic/browser
+require 'watir-classic/options'
+module Watir
+  
+=begin rdoc
+
+Watir is a family of open-source drivers for automating web browsers. You
+can use it to write tests that are easy to read and maintain. 
+
+Watir drives browsers the same way people do. It clicks links, fills in forms,
+presses buttons. Watir also checks results, such as whether expected text 
+appears on a page.
+
+The Watir family currently includes support for Internet Explorer (on Windows),
+Firefox (on Windows, Mac and Linux) and Safari (on Mac). 
+
+Project Homepage: http://wtr.rubyforge.org
+
+This Browser module provides a generic interface
+that tests can use to access any browser. The actual browser (and thus
+the actual Watir driver) is determined at runtime based on configuration
+settings.
+
+  require 'watir-classic'
+  browser = Watir::Browser.new
+  browser.goto 'http://google.com'
+  browser.text_field(:name, 'q').set 'pickaxe'  
+  browser.button(:name, 'btnG').click
+  if browser.text.include? 'Programming Ruby'
+    puts 'Text was found'
+  else
+    puts 'Text was not found'
+  end
+
+A comprehensive summary of the Watir API can be found here
+http://wiki.openqa.org/display/WTR/Methods+supported+by+Element
+
+There are two ways to configure the browser that will be used by your tests.
+
+One is to set the +watir_browser+ environment variable to +ie+ or +firefox+. 
+(How you do this depends on your platform.)
+
+The other is to create a file that looks like this.
+
+  browser: ie
+
+And then to add this line to your script, after the require statement and 
+before you invoke Browser.new.
+
+  Watir.options_file = 'path/to/the/file/you/just/created'
+
+=end rdoc
+  
+  module Browser
+    @@browser_classes = {}
+    @@sub_options = {}
+    @@default = nil
+    class << self
+
+      # Create a new instance of a browser driver, as determined by the
+      # configuration settings. (Don't be fooled: this is not actually 
+      # an instance of Browser class.)
+      def new
+        set_sub_options
+        klass.new
+      end
+      # Create a new instance as with #new and start the browser on the
+      # specified url.
+      def start url
+        set_sub_options
+        klass.start url
+      end
+      # Attach to an existing browser.
+      def attach(how, what)
+        set_sub_options
+        klass.attach(how, what)
+      end
+      def set_options options
+        return unless klass.respond_to?(:set_options)
+        klass.set_options options
+      end
+      def options
+        return {} unless klass.respond_to?(:options)
+        klass.options
+      end
+
+      def klass
+        key = Watir.options[:browser]
+        eval @@browser_classes[key] # this triggers the autoload
+      end
+      private :klass
+      # Add support for the browser option, using the specified class, 
+      # provided as a string. Optionally, additional options supported by
+      # the class can be specified as an array of symbols. Options specified
+      # by the user and included in this list will be passed (as a hash) to 
+      # the set_options class method (if defined) before creating an instance.
+      def support hash_args
+        option = hash_args[:name]
+        class_string = hash_args[:class]
+        additional_options = hash_args[:options]
+        library = hash_args[:library]
+        gem = hash_args[:gem] || library
+
+        @@browser_classes[option] = class_string        
+        @@sub_options[option] = additional_options
+
+        autoload class_string, library
+        activate_gem gem, option
+      end
+      
+      def default
+        @@default
+      end
+      # Specifies a default browser. Must be specified before options are parsed.
+      def default= option
+        @@default = option
+      end
+      # Returns the names of the browsers that are supported by this module.
+      # These are the options for 'watir_browser' (env var) or 'browser:' (yaml).
+      def browser_names
+        @@browser_classes.keys
+      end      
+      
+      private
+      def autoload class_string, library
+        mod, klass = class_string.split('::')
+        eval "module ::#{mod}; autoload :#{klass}, '#{library}'; end"
+      end
+      # Activate the gem (if installed). The default browser will be set
+      # to the first gem that activates.
+      def activate_gem gem_name, option
+        begin
+          gem gem_name 
+          @@default ||= option
+        rescue Gem::LoadError
+        end
+      end
+      def set_sub_options
+        sub_options = @@sub_options[Watir.options[:browser]]
+        return if sub_options.nil?
+        specified_options = Watir.options.reject {|k, v| !sub_options.include? k}
+        self.set_options specified_options
+      end
+    end
+  end
+
+end
+
+require 'watir-classic/browsers'

data/lib/watir-classic/browsers.rb

@@ -0,0 +1,7 @@
+#--
+# watir/browsers
+# Define browsers supported by Watir
+
+Watir::Browser.support :name => 'ie', :class => 'Watir::IE', 
+  :library => 'watir-classic/ie', :gem => 'watir-classic',
+  :options => [:speed, :visible, :zero_based_indexing]

data/lib/watir-classic/close_all.rb

@@ -0,0 +1,31 @@
+require 'watir-classic/ie'
+
+module Watir
+  class IE
+    # close all ie browser windows
+    def self.close_all
+      close_all_but nil
+    end
+    # find other ie browser windows and close them
+    def close_others
+      IE.close_all_but self
+    end
+    private
+    def self.close_all_but(except=nil)
+      Watir::IE.each do |ie|
+        ie.close_modal
+        ie.close unless except and except.hwnd == ie.hwnd
+      end
+      sleep 1.0 # replace with polling for window count to be zero?
+    end
+    public
+    # close modal dialog. unlike IE#modal_dialog.close, does not wait for dialog
+    # to appear and does not raise exception if no window is found.
+    # returns true if modal was found and close, otherwise false
+    def close_modal
+      while self.modal_dialog.exists? do
+        self.modal_dialog.close
+      end
+    end
+  end
+end

data/lib/watir-classic/container.rb

@@ -0,0 +1,110 @@
+module Watir
+  # This module contains the factory methods that are used to access most html objects
+  #
+  # For example, to access a button on a web page that has the following html
+  #  <input type=button name='b1' value='Click Me' onClick='javascript:doSomething()'>
+  #
+  # the following watir code could be used to click the button
+  #
+  #  browser.button(:name, 'b1').click
+  #
+  # or to find the name attribute
+  #
+  #  browser.button(:value, 'Click Me').name
+  #
+  # there are many methods available to the Button object
+  #--
+  # Is includable for classes that have @container, document and __ole_inner_elements
+  module Container
+    include Watir::Exception
+    
+    # Note: @container is the container of this object, i.e. the container
+    # of this container.
+    # In other words, for browser.table().this_thing().text_field().set,
+    # container of this_thing is the table.
+    
+    # This is used to change the typing speed when entering text on a page.
+    attr_accessor :typingspeed
+    attr_accessor :type_keys
+    # The color we want to use for the active object. This can be any valid web-friendly color.
+    attr_accessor :activeObjectHighLightColor
+    # The PageContainer object containing this element
+    attr_accessor :page_container
+    
+    def copy_test_config(container) # only used by form and frame
+      @typingspeed = container.typingspeed
+      @type_keys = container.type_keys
+      @activeObjectHighLightColor = container.activeObjectHighLightColor
+    end
+    private :copy_test_config
+    
+    # Write the specified string to the log.
+    def log(what)
+      @container.logger.debug(what) if @logger
+    end
+    
+    # Wait until Browser has finished loading the page.
+    #--
+    # called explicitly by most click and set methods
+    def wait(no_sleep=false)
+      @container.wait(no_sleep)
+    end
+    
+    def set_container container #:nodoc:
+      @container = container 
+      @page_container = container.page_container
+    end
+        
+    public
+
+    def modal_dialog
+      ModalDialog.new(self)
+    end
+
+    # Searching for Page Elements
+    # Not for external consumption
+    #
+    #++
+    def __ole_inner_elements
+      return document.body.all
+    end
+    
+    # This method shows the available objects on the current page.
+    # This is usually only used for debugging or writing new test scripts.
+    # This is a nice feature to help find out what HTML objects are on a page
+    # when developing a test case using Watir.
+    def show_all_objects
+      puts "-----------Objects in page -------------"
+      doc = document
+      s = ""
+      props = ["name", "id", "value", "alt", "src"]
+      doc.all.each do |n|
+        begin
+          s += n.invoke("type").to_s.ljust(16)
+        rescue
+          next
+        end
+        props.each do |prop|
+          begin
+            p = n.invoke(prop)
+            s += "  " + "#{prop}=#{p}".to_s.ljust(18)
+          rescue
+            # this object probably doesnt have this property
+          end
+        end
+        s += "\n"
+      end
+      puts s
+    end
+    
+    # Locator Methods
+    #
+    # Not for external use, but cannot set to private due to usages in Element
+    # classes.
+
+    def locator_for(locator_class, specifiers, klass)
+      locator_class.new self, specifiers, klass
+    end
+    
+  end # module
+end