watir-webdriver 0.1.8 → 0.1.9

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 Jari Bakken
+Copyright (c) 2009-2011 Jari Bakken
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -52,4 +52,4 @@ Specs specific to watir-webdriver are found in spec/*_spec.rb, with watirspec in
 
 == Copyright
 
-Copyright (c) 2009-2010 Jari Bakken. See LICENSE for details.
+Copyright (c) 2009-2011 Jari Bakken. See LICENSE for details.

data/lib/watir-webdriver.rb

@@ -1,18 +1,19 @@
 # encoding: utf-8
-require "selenium-webdriver"
-require "json"
+require 'selenium-webdriver'
+require 'json'
 
-require "watir-webdriver/version"
-require "watir-webdriver/exception"
-require "watir-webdriver/xpath_support"
-require "watir-webdriver/window_switching"
-require "watir-webdriver/container"
-require "watir-webdriver/locators/element_locator"
-require "watir-webdriver/locators/button_locator"
-require "watir-webdriver/locators/text_field_locator"
-require "watir-webdriver/locators/child_row_locator"
-require "watir-webdriver/locators/child_cell_locator"
-require "watir-webdriver/browser"
+require 'watir-webdriver/version'
+require 'watir-webdriver/wait'
+require 'watir-webdriver/exception'
+require 'watir-webdriver/xpath_support'
+require 'watir-webdriver/window_switching'
+require 'watir-webdriver/container'
+require 'watir-webdriver/locators/element_locator'
+require 'watir-webdriver/locators/button_locator'
+require 'watir-webdriver/locators/text_field_locator'
+require 'watir-webdriver/locators/child_row_locator'
+require 'watir-webdriver/locators/child_cell_locator'
+require 'watir-webdriver/browser'
 
 module Watir
   include Selenium
@@ -29,40 +30,33 @@ module Watir
 
 end
 
-require "watir-webdriver/attribute_helper"
-require "watir-webdriver/row_container"
-require "watir-webdriver/cell_container"
-require "watir-webdriver/element_collection"
-require "watir-webdriver/elements/element"
-require "watir-webdriver/elements/generated"
-require "watir-webdriver/elements/frame"
-require "watir-webdriver/elements/input"
-require "watir-webdriver/elements/button"
-require "watir-webdriver/elements/checkbox"
-require "watir-webdriver/elements/file_field"
-require "watir-webdriver/elements/image"
-require "watir-webdriver/elements/link"
-require "watir-webdriver/elements/font"
-require "watir-webdriver/elements/radio"
-require "watir-webdriver/elements/text_field"
-require "watir-webdriver/elements/hidden"
-require "watir-webdriver/elements/select"
-require "watir-webdriver/elements/form"
-require "watir-webdriver/elements/option"
-require "watir-webdriver/elements/table"
-require "watir-webdriver/elements/table_row"
-require "watir-webdriver/elements/table_cell"
-require "watir-webdriver/elements/table_section"
+require 'watir-webdriver/attribute_helper'
+require 'watir-webdriver/row_container'
+require 'watir-webdriver/cell_container'
+require 'watir-webdriver/element_collection'
+require 'watir-webdriver/elements/element'
+require 'watir-webdriver/elements/generated'
+require 'watir-webdriver/elements/frame'
+require 'watir-webdriver/elements/input'
+require 'watir-webdriver/elements/button'
+require 'watir-webdriver/elements/checkbox'
+require 'watir-webdriver/elements/file_field'
+require 'watir-webdriver/elements/image'
+require 'watir-webdriver/elements/link'
+require 'watir-webdriver/elements/font'
+require 'watir-webdriver/elements/radio'
+require 'watir-webdriver/elements/text_field'
+require 'watir-webdriver/elements/hidden'
+require 'watir-webdriver/elements/select'
+require 'watir-webdriver/elements/form'
+require 'watir-webdriver/elements/option'
+require 'watir-webdriver/elements/table'
+require 'watir-webdriver/elements/table_row'
+require 'watir-webdriver/elements/table_cell'
+require 'watir-webdriver/elements/table_section'
 
 Watir.tag_to_class.freeze
 
-module Watir
-  module Container
-
-  end # Container
-end # Watir
-
-
 # undefine deprecated methods to use them for Element attributes
 class Object
   undef_method :id if method_defined? "id"

data/lib/watir-webdriver/browser.rb

@@ -115,6 +115,10 @@ module Watir
       wrap_elements_in(returned)
     end
 
+    def send_keys(*args)
+      @driver.switch_to.active_element.send_keys(*args)
+    end
+
     def add_checker(checker = nil, &block)
       if block_given?
         @error_checkers << block

data/lib/watir-webdriver/elements/element.rb

@@ -7,10 +7,12 @@ module Watir
   #
 
   class Element
+    extend AttributeHelper
+
     include Exception
     include Container
     include Selenium
-    extend AttributeHelper
+    include EventuallyPresent
 
     def initialize(parent, selector)
       @parent   = parent
@@ -157,11 +159,25 @@ module Watir
     end
     alias_method :wd, :element # ensures duck typing with Browser
 
+    #
+    # Returns true if this element is visible on the page
+    #
+
     def visible?
       assert_exists
       @element.displayed?
     end
 
+    #
+    # Returns true if the element exists and is visible on the page
+    #
+    # @see Watir::Wait
+    #
+
+    def present?
+      exists? && visible?
+    end
+
     def style(property = nil)
       if property
         assert_exists

data/lib/watir-webdriver/elements/frame.rb

@@ -69,18 +69,23 @@ module Watir
       @element = element
       @driver = driver
     end
-    
+
     def ==(other)
       @element == other.element
     end
     alias_method :eql?, :==
-    
+
+    def send_keys(*args)
+      switch!
+      @driver.switch_to.active_element.send_keys(*args)
+    end
+
     protected
-    
+
     def element
       @element
     end
-    
+
     private
 
     def method_missing(meth, *args, &blk)

data/lib/watir-webdriver/extensions/wait.rb

@@ -1,141 +1 @@
-# encoding: utf-8
-module Watir
-
-  #
-  # Module provided by optional require:
-  #
-  #   require "watir-webdriver/extensions/wait"
-  #
-
-  module Wait
-    module_function
-
-    class TimeoutError < StandardError
-    end
-
-    #
-    # Wait until the block evaluates to true or times out.
-    #
-
-    def until(timeout = 30, &block)
-      end_time = ::Time.now + timeout
-
-      until ::Time.now > end_time
-        result = yield(self)
-        return result if result
-        sleep 0.5
-      end
-
-      raise TimeoutError, "timed out after #{timeout} seconds"
-    end
-
-    #
-    # Wait while the block evaluates to true or times out.
-    #
-
-    def while(timeout = 30, &block)
-      end_time = ::Time.now + timeout
-
-      until ::Time.now > end_time
-        return unless yield(self)
-        sleep 0.5
-      end
-
-      raise TimeoutError, "timed out after #{timeout} seconds"
-    end
-
-  end # Wait
-
-  #
-  # Wraps an Element so that any subsequent method calls are
-  # put on hold until the element is present (exists and is visible) on the page.
-  #
-
-  class WhenPresentDecorator
-    def initialize(element, timeout)
-      @element = element
-      @timeout = timeout
-    end
-
-    def method_missing(m, *args, &block)
-      unless @element.respond_to?(m)
-        raise NoMethodError, "undefined method `#{m}' for #{@element.inspect}:#{@element.class}"
-      end
-
-      Watir::Wait.until(@timeout) { @element.present? }
-
-      @element.__send__(m, *args, &block)
-    end
-  end # WhenPresentDecorator
-
-  class Element
-
-    #
-    # Returns true if the element exists and is visible on the page
-    #
-    # This method is provided by an optional require.
-    # @see Watir::Wait
-    #
-
-    def present?
-      exists? && visible?
-    end
-
-    #
-    # Waits until the element is present.
-    #
-    # This method is provided by an optional require.
-    # @see Watir::Wait
-    #
-    # Example:
-    #   browser.button(:id, 'foo').when_present.click
-    #   browser.div(:id, 'bar').when_present { |div| ... }
-    #   browser.p(:id, 'baz').when_present(60).text
-    #
-    # @param [Integer] timeout seconds to wait before timing out
-    #
-
-    def when_present(timeout = 30)
-      if block_given?
-        Watir::Wait.until(timeout) { self.present? }
-        yield self
-      else
-        WhenPresentDecorator.new(self, timeout)
-      end
-    end
-
-    #
-    # Waits until the element is present.
-    #
-    # This method is provided by an optional require.
-    #
-    # @param [Integer] timeout seconds to wait before timing out
-    #
-    # @see Watir::Wait
-    # @see Watir::Element#present?
-    #
-
-    def wait_until_present(timeout = 30)
-      Watir::Wait.until(timeout) { self.present? }
-    end
-
-    #
-    # Waits while the element is present.
-    #
-    # This method is provided by an optional require.
-    #
-    # @param [Integer] timeout seconds to wait before timing out
-    #
-    # @see Watir::Wait
-    # @see Watir::Element#present?
-    #
-
-    def wait_while_present(timeout = 30)
-      Watir::Wait.while(timeout) { self.present? }
-    rescue Selenium::WebDriver::Error::ObsoleteElementError
-      # it's not present
-    end
-  end # Element
-
-
-end # Watir
+warn "wait helpers are now loaded by default, please remove require of 'watir-webdriver/extensions/wait'"

data/lib/watir-webdriver/version.rb

@@ -1,3 +1,3 @@
 module Watir
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/watir-webdriver/wait.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+module Watir
+
+  module Wait
+
+    class TimeoutError < StandardError
+    end
+
+    class << self
+      #
+      # Wait until the block evaluates to true or times out.
+      #
+
+      def until(timeout = 30, message = nil, &block)
+        end_time = ::Time.now + timeout
+
+        until ::Time.now > end_time
+          result = yield(self)
+          return result if result
+          sleep 0.5
+        end
+
+        raise TimeoutError, message_for(timeout, message)
+      end
+
+      #
+      # Wait while the block evaluates to true or times out.
+      #
+
+      def while(timeout = 30, message = nil, &block)
+        end_time = ::Time.now + timeout
+
+        until ::Time.now > end_time
+          return unless yield(self)
+          sleep 0.5
+        end
+
+        raise TimeoutError, message_for(timeout, message)
+      end
+
+      private
+
+      def message_for(timeout, message)
+        err = "timed out after #{timeout} seconds"
+        err << ", #{message}" if message
+
+        err
+      end
+    end # class << self
+  end # Wait
+
+  #
+  # Wraps an Element so that any subsequent method calls are
+  # put on hold until the element is present (exists and is visible) on the page.
+  #
+
+  class WhenPresentDecorator
+    def initialize(element, timeout, message = nil)
+      @element = element
+      @timeout = timeout
+      @message = message
+    end
+
+    def method_missing(m, *args, &block)
+      unless @element.respond_to?(m)
+        raise NoMethodError, "undefined method `#{m}' for #{@element.inspect}:#{@element.class}"
+      end
+
+      Watir::Wait.until(@timeout, @message) { @element.present? }
+
+      @element.__send__(m, *args, &block)
+    end
+  end # WhenPresentDecorator
+
+  #
+  # Convenience methods for things that eventually become present.
+  #
+  # Includers should implement a public #present? and a (possibly private) #selector_string method.
+  #
+
+  module EventuallyPresent
+    #
+    # Waits until the element is present.
+    #
+    # @see Watir::Wait
+    #
+    # Example:
+    #   browser.button(:id, 'foo').when_present.click
+    #   browser.div(:id, 'bar').when_present { |div| ... }
+    #   browser.p(:id, 'baz').when_present(60).text
+    #
+    # @param [Integer] timeout seconds to wait before timing out
+    #
+
+    def when_present(timeout = 30)
+      message = "waiting for #{selector_string} to become present"
+
+      if block_given?
+        Watir::Wait.until(timeout, message) { present? }
+        yield self
+      else
+        WhenPresentDecorator.new(self, timeout, message)
+      end
+    end
+
+    #
+    # Waits until the element is present.
+    #
+    # @param [Integer] timeout seconds to wait before timing out
+    #
+    # @see Watir::Wait
+    # @see Watir::Element#present?
+    #
+
+    def wait_until_present(timeout = 30)
+      message = "waiting for #{selector_string} to become present"
+      Watir::Wait.until(timeout, message) { present? }
+    end
+
+    #
+    # Waits while the element is present.
+    #
+    # @param [Integer] timeout seconds to wait before timing out
+    #
+    # @see Watir::Wait
+    # @see Watir::Element#present?
+    #
+
+    def wait_while_present(timeout = 30)
+      message = "waiting for #{selector_string} to disappear"
+      Watir::Wait.while(timeout, message) { present? }
+    rescue Selenium::WebDriver::Error::ObsoleteElementError
+      # it's not present
+    end
+
+  end # EventuallyPresent
+end # Watir

data/lib/watir-webdriver/window_switching.rb

@@ -5,7 +5,7 @@ module Watir
     end
 
     def windows(*args)
-      all = @driver.window_handles.map { |id| Window.new(@driver, id) }
+      all = @driver.window_handles.map { |handle| Window.new(@driver, :handle => handle) }
 
       if args.empty?
         all
@@ -15,13 +15,11 @@ module Watir
     end
 
     def window(*args, &blk)
-      win = filter_windows(args, windows, :find)
+      win = Window.new @driver, extract_selector(args)
 
-      if win && block_given?
-        win.use(&blk)
-      end
+      win.use(&blk) if block_given?
 
-      win or raise NoMatchingWindowFoundException, args.inspect
+      win
     end
 
     private
@@ -29,10 +27,6 @@ module Watir
     def filter_windows(args, all, method)
       sel = extract_selector(args)
 
-      if sel.empty?
-        all.find { |w| w.current? }
-      end
-
       unless sel.keys.all? { |k| [:title, :url].include? k }
         raise ArgumentError, "invalid window selector: #{sel.inspect}"
       end
@@ -44,27 +38,48 @@ module Watir
   end # WindowSwitching
 
   class Window
-    def initialize(driver, id)
-      @driver, @id = driver, id
+    include EventuallyPresent
+
+    def initialize(driver, selector)
+      @driver   = driver
+      @selector = selector
+
+      if selector.empty?
+        @handle = driver.window_handle
+      elsif selector.has_key? :handle
+        @handle = selector.delete :handle
+      else
+        unless selector.keys.all? { |k| [:title, :url].include? k }
+          raise ArgumentError, "invalid window selector: #{selector.inspect}"
+        end
+      end
     end
 
     def inspect
-      '#<%s:0x%x id=%s>' % [self.class, hash*2, @id.to_s]
+      '#<%s:0x%x located=%s>' % [self.class, hash*2, !!@handle]
     end
 
+    def exists?
+      handle
+      true
+    rescue NoMatchingWindowFoundException
+      false
+    end
+    alias_method :present?, :exists? # for Wait::EventuallyPresent
+
     def ==(other)
       return false unless other.kind_of?(self.class)
 
-      @id == other.id
+      handle == other.handle
     end
     alias_method :eql?, :==
 
     def hash
-      @id.hash ^ self.class.hash
+      handle.hash ^ self.class.hash
     end
 
     def current?
-      @driver.window_handle == @id
+      @driver.window_handle == handle
     end
 
     def close
@@ -91,14 +106,37 @@ module Watir
         return self
       end
 
-      @driver.switch_to.window(@id, &blk)
+      @driver.switch_to.window(handle, &blk)
       self
     end
 
     protected
 
-    def id
-      @id
+    def handle
+      @handle ||= locate
+    end
+
+    private
+
+    def selector_string
+      @selector.inspect
+    end
+
+    def locate
+      handle = @driver.window_handles.find { |handle|
+        matches?(handle)
+      }
+
+      handle or raise NoMatchingWindowFoundException, @selector.inspect
+    end
+
+    def matches?(handle)
+      @driver.switch_to.window(handle) {
+        matches_title = @selector[:title].nil? || @selector[:title] === @driver.title
+        matches_url   = @selector[:url].nil? || @selector[:url] === @driver.current_url
+
+        matches_title && matches_url
+      }
     end
 
   end # Window

data/spec/browser_spec.rb

@@ -47,6 +47,25 @@ describe Watir::Browser do
     end
   end
 
+  describe "#send_key{,s}" do
+    it "sends keystrokes to the active element" do
+      browser.goto WatirSpec.files + "/forms_with_input_elements.html"
+
+      browser.send_keys "hello"
+      browser.text_field(:id => "new_user_first_name").value.should == "hello"
+    end
+
+    it "sends keys to a frame" do
+      browser.goto WatirSpec.files + "/frames.html"
+      tf = browser.frame.text_field(:id => "senderElement")
+      tf.clear
+
+      browser.frame.send_keys "hello"
+
+      tf.value.should == "hello"
+    end
+  end
+
   bug "http://github.com/jarib/watirspec/issues/issue/8", [:webdriver, :ie], [:webdriver, :chrome] do
     it "raises an error when trying to interact with a closed browser" do
       b = WatirSpec.new_browser

data/spec/element_spec.rb

@@ -10,4 +10,22 @@ describe Watir::Element do
     end
   end
 
+  describe "#present?" do
+    before do
+      browser.goto("file://" + File.expand_path("html/wait.html", File.dirname(__FILE__)))
+    end
+
+    it "returns true if the element exists and is visible" do
+      browser.div(:id, 'foo').should be_present
+    end
+
+    it "returns false if the element exists but is not visible" do
+      browser.div(:id, 'bar').should_not be_present
+    end
+
+    it "returns false if the element does not exist" do
+      browser.div(:id, 'should-not-exist').should_not be_present
+    end
+  end
+
 end

data/spec/wait_spec.rb

@@ -1,29 +1,40 @@
 require File.expand_path("watirspec/spec_helper", File.dirname(__FILE__))
-require "watir-webdriver/extensions/wait"
 
 describe Watir::Wait do
   describe "#until" do
     it "waits until the block returns true" do
-      Wait::until(1) { true }.should be_true
+      Wait.until(0.5) { true }.should be_true
     end
 
     it "times out" do
       lambda do
-        Wait::until(1) { false }
+        Wait.until(0.5) { false }
       end.should raise_error(Watir::Wait::TimeoutError)
     end
+
+    it "times out with a custom message" do
+      lambda do
+        Wait.until(0.5, "oops") { false }
+      end.should raise_error(Watir::Wait::TimeoutError, "timed out after 0.5 seconds, oops")
+    end
   end
 
   describe "#while" do
     it "waits while the block returns true" do
-      Wait::while(1) { false }.should == nil
+      Wait.while(0.5) { false }.should == nil
     end
 
     it "times out" do
       lambda do
-        Wait::while(1) { true }
+        Wait.while(0.5) { true }
       end.should raise_error(Watir::Wait::TimeoutError)
     end
+
+    it "times out with a custom message" do
+      lambda do
+        Wait.while(0.5, "oops") { true }
+      end.should raise_error(Watir::Wait::TimeoutError, "timed out after 0.5 seconds, oops")
+    end
   end
 end
 
@@ -33,20 +44,6 @@ describe Watir::Element do
     browser.goto("file://" + File.expand_path("html/wait.html", File.dirname(__FILE__)))
   end
 
-  describe "#present?" do
-    it "returns true if the element exists and is visible" do
-      browser.div(:id, 'foo').should be_present
-    end
-
-    it "returns false if the element exists but is not visible" do
-      browser.div(:id, 'bar').should_not be_present
-    end
-
-    it "returns false if the element does not exist" do
-      browser.div(:id, 'should-not-exist').should_not be_present
-    end
-  end
-
   describe "#when_present" do
     it "yields when the element becomes present" do
       called = false
@@ -74,7 +71,7 @@ describe Watir::Element do
     it "times out when not given a block" do
       lambda {
         browser.div(:id, 'bar').when_present(1).click
-      }.should raise_error(Watir::Wait::TimeoutError)
+      }.should raise_error(Watir::Wait::TimeoutError, 'timed out after 1 seconds, waiting for {:id=>"bar", :tag_name=>"div"} to become present')
     end
   end
 
@@ -87,7 +84,7 @@ describe Watir::Element do
     it "times out if the element doesn't appear" do
       lambda do
         browser.div(:id, 'bar').wait_until_present(1)
-      end.should raise_error(Watir::Wait::TimeoutError)
+      end.should raise_error(Watir::Wait::TimeoutError, 'timed out after 1 seconds, waiting for {:id=>"bar", :tag_name=>"div"} to become present')
     end
   end
 
@@ -105,7 +102,7 @@ describe Watir::Element do
     it "times out" do
       lambda do
         browser.div(:id, 'foo').wait_while_present(1)
-      end.should raise_error(Watir::Wait::TimeoutError)
+      end.should raise_error(Watir::Wait::TimeoutError, 'timed out after 1 seconds, waiting for {:id=>"foo", :tag_name=>"div"} to disappear')
     end
   end
 

data/watir-webdriver.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "selenium-webdriver", '>= 0.1.2'
 
-  s.add_development_dependency "rspec", "~> 2.1.0"
+  s.add_development_dependency "rspec", "~> 2.3.0"
   s.add_development_dependency "yard", "~> 0.6"
   s.add_development_dependency "webidl", ">= 0.0.6"
   s.add_development_dependency "sinatra", "~> 1.0"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - Jari Bakken
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 +01:00
+date: 2011-01-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,9 +42,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 1
+        - 3
         - 0
-        version: 2.1.0
+        version: 2.3.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -180,6 +180,7 @@ files:
 - lib/watir-webdriver/locators/text_field_locator.rb
 - lib/watir-webdriver/row_container.rb
 - lib/watir-webdriver/version.rb
+- lib/watir-webdriver/wait.rb
 - lib/watir-webdriver/window_switching.rb
 - lib/watir-webdriver/xpath_support.rb
 - lib/yard/handlers/watir.rb