commonwatir 1.6.6 → 1.6.7.rc1

data/CHANGES

@@ -1,3 +1,32 @@
+== Version 1.6.7 - 2010/10/21
+
+=== General improvements
+
+* added new waiting methods on Watir::Element: #when_present, #wait_until_present and #wait_while_present (Jari Bakken and Jarmo Pertman)
+* added new waiting methods on Watir::IE and Watir::Firefox: #wait_until and #wait_while (Jari Bakken and Jarmo Pertman)
+* added method #present? for Watir::Element (Jari Bakken and Jarmo Pertman)
+* deprecated old waiting methods in Watir::Waiter which will be removed in some future version - use Watir::Wait instead (Jarmo Pertman)
+
+=== IE improvements
+
+* removed Watir::Simple (Željko Filipin)
+* #click_no_wait was not working with frame elements. Closes http://jira.openqa.org/browse/WTR-459 (Jarmo Pertman)
+
+=== Firefox improvements
+
+* get_attribute_value now works with attributes named something like "foo-bar" (Alan Shields)
+
+=== Cleanup & Maintenance
+
+* cleaned up repo at GitHub
+* merge licenses into one (Željko Filipin)
+* Rakefile works now under non-Windows systems too (Alan Shields)
+* Removed datahandler.rb
+
+
+Whole Changelog is available at http://github.com/bret/watir/compare/v1.6.6...v1.6.7
+
+
 == Version 1.6.6 - 2010/10/2
 
 === IE improvements

data/LICENSE

@@ -1,22 +1,34 @@
-(The MIT License)
+---------------------------------------------------------------------------
+Copyright (c) 2004 - 2006, Paul Rogers
+Copyright (c) 2006 - 2007, Angrez Singh
+Copyright (c) 2004 - 2010, Bret Pettichord
+All rights reserved.
 
-Copyright (c) 2008, 2009 Bret Pettichord
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+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/VERSION

@@ -1 +1 @@
-1.6.6
+1.6.7.rc1

data/lib/watir/element_extensions.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module Watir
+# This assumes that Element#visible? is defined
+  module ElementExtensions
+
+    #
+    # Wraps a {Celerity,Watir}::Element so that any subsequent method calls are
+    # put on hold until the element is present 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
+
+    #
+    # Returns true if the element exists and is visible on the page
+    #
+
+    def present?
+      exists? && visible?
+    end
+
+    #
+    # Waits until the element is present.
+    #
+    # Optional argument:
+    #
+    #   timeout   -  seconds to wait before timing out (default: 60)
+    #
+    #     browser.button(:id, 'foo').when_present.click
+    #     browser.div(:id, 'bar').when_present { |div| ... }
+    #     browser.p(:id, 'baz').when_present(60).text
+    #
+
+    def when_present(timeout = 60)
+      if block_given?
+        Watir::Wait.until(timeout) { self.present? }
+        yield self
+      else
+        return WhenPresentDecorator.new(self, timeout)
+      end
+    end
+
+    def wait_until_present(timeout = 60)
+      Watir::Wait.until(timeout) { self.present? }
+    end
+
+    def wait_while_present(timeout = 60)
+      Watir::Wait.while(timeout) { self.present? }
+    end
+
+  end # module ElementExtensions
+end

data/lib/watir/version.rb

@@ -0,0 +1,4 @@
+module Watir
+  version_file = File.dirname(__FILE__) + '/../../VERSION'
+  VERSION = File.exists?(version_file) ? File.read(version_file).strip : "0.0.0"
+end

data/lib/watir/wait.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Watir
+  module Wait
+    extend self
+
+    class TimeoutError < StandardError
+    end
+
+    #
+    # Wait until the block evaluates to true or times out.
+    #
+
+    def until(timeout = 60, &block)
+      end_time = ::Time.now + timeout
+
+      until ::Time.now > end_time
+        result = yield(self)
+        return result if result
+        sleep 0.1
+      end
+
+      raise TimeoutError, "timed out after #{timeout} seconds"
+    end
+
+    #
+    # Wait while the block evaluates to true or times out.
+    #
+    def while(timeout = 60, &block)
+      end_time = ::Time.now + timeout
+
+      until ::Time.now > end_time
+        return unless yield(self)
+        sleep 0.1
+      end
+
+      raise TimeoutError, "timed out after #{timeout} seconds"
+    end
+
+  end # Wait
+end # Watir

data/lib/watir/wait_helper.rb

@@ -0,0 +1,12 @@
+# include this module if there's a need to have wait_until and wait_while methods in some different scope
+module Watir
+  module WaitHelper
+    def wait_until(*args, &blk)
+      Wait.until(*args, &blk)
+    end
+
+    def wait_while(*args, &blk)
+      Wait.while(*args, &blk)
+    end
+  end
+end

data/lib/watir/waiter.rb

@@ -1,3 +1,8 @@
+#######
+#
+# Using Watir::Waiter is DEPRECATED and will be removed in some newer version of Watir! Use Watir::Wait and Watir::ElementExtensions methods instead!
+#
+#######
 require 'watir/exceptions'
 
 module Watir
@@ -37,6 +42,7 @@ class Waiter
 
   def initialize(timeout=@@default_timeout,
                  polling_interval=@@default_polling_interval)
+    Kernel.warn "Using Watir::Waiter is DEPRECATED and will be removed in some newer version of Watir! Use Watir::Wait and Watir::ElementExtensions methods instead!"
     @timeout = timeout
     @polling_interval = polling_interval
     @timer = TimeKeeper.new

data/lib/watir.rb

@@ -3,5 +3,11 @@
 # implementations. The 'watir/browser' library will autoload the actual
 # implementations.
 
-require 'watir/waiter'
+require 'watir/version'
+require 'watir/waiter' # this will be removed in some future version
+require 'watir/wait'
+require 'watir/wait_helper'
+require 'watir/element_extensions'
+require 'watir/exceptions'
+require 'watir/matches'
 require 'watir/browser'

data/unittests/attach_to_existing_window_test.rb

@@ -1,5 +1,4 @@
 # feature tests for attaching to existing IE windows
-# revision: $Revision: 1417 $
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..') unless $SETUP_LOADED
 require 'unittests/setup'

data/unittests/buttons_test.rb

@@ -1,5 +1,4 @@
 # feature tests for Buttons
-# revision: $Revision$
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..') unless $SETUP_LOADED
 require 'unittests/setup'

data/unittests/html/blankpage.html

@@ -5,7 +5,6 @@ Test page for buttons
 </title>
 </head>
 <body>
-CVS Revision: $Revision $
 <br>
 Blank page to fill in the frames
 </body>

data/unittests/html/buttons1.html

@@ -6,7 +6,6 @@ Test page for buttons
   <link rel="stylesheet" type="text/css" href="watir_unit_tests.css">
 </head>
 <body>
-CVS Revision: $Revision$
 <br>
 <br>
 <table>

data/unittests/html/buttons2.html

@@ -6,7 +6,6 @@ Test page for buttons
   <link rel="stylesheet" type="text/css" href="watir_unit_tests.css">
 </head>
 <body>
-CVS Revision: $Revision: 1.0 $
 <br>
 <br>
 <table>

data/unittests/html/entertainment_com.html

@@ -27,7 +27,6 @@
 
 
 <link rel="stylesheet" href="/consumer_site_styles.css" type="text/css" />
-<script language="JavaScript" src="/html/functions.js"></script>
 
 <script language="JavaScript">
 	function careers_popup() {

data/unittests/html/wait.html

@@ -0,0 +1,15 @@
+<html>
+<head>
+    <title>Wait Tests</title>
+    <script type="text/javascript">
+        function toggleDiv() {
+            var divStyle = document.getElementById('div1').style;
+            divStyle.display = divStyle.display == "none" ? "" : "none";
+        }
+    </script>
+</head>
+
+<div id="div1">div1</div>
+<a id="link1" href="javascript:void(0)" onclick="javascript:setTimeout(toggleDiv, 500);">Click me!</a>
+
+</html>

data/unittests/wait_test.rb

@@ -0,0 +1,119 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..') unless $SETUP_LOADED
+require 'unittests/setup'
+
+class Wait < Test::Unit::TestCase
+  include Watir::Exception
+  location __FILE__
+
+  def setup
+    uses_page "wait.html"
+    browser.refresh
+  end
+
+  def test_wait_until
+    div = browser.div(:id => "div1")
+    assert div.visible?
+    browser.link(:id => "link1").click
+
+    browser.wait_until(2) {not div.visible?}
+    assert !div.visible?
+  end
+
+  def test_wait_until_exception
+    assert_raises(Watir::Wait::TimeoutError) {browser.wait_until(0.1) {false}}
+  end
+
+  def test_wait_while
+    div = browser.div(:id => "div1")
+    assert div.visible?
+    browser.link(:id => "link1").click
+
+    browser.wait_while(2) {div.visible?}
+    assert !div.visible?
+  end
+
+  def test_wait_while_exception
+    assert_raises(Watir::Wait::TimeoutError) {browser.wait_while(0.1) {true}}
+  end
+
+  def test_present?
+    div = browser.div(:id => "div1")
+    assert div.exists?
+    assert div.visible?
+    assert div.present?
+
+    browser.link(:id => "link1").click
+    browser.wait_until(2) {!div.visible?}
+    assert div.exists?
+    assert !div.visible?
+    assert !div.present?
+
+    non_existing_div = browser.div(:id => "non-existing")
+    assert !non_existing_div.exists?
+    assert_raises(Watir::Exception::UnknownObjectException) {non_existing_div.visible?}
+    assert !non_existing_div.present?
+  end
+
+  def test_when_present
+    browser.link(:id => "link1").click
+    div = browser.div(:id => "div1")
+    assert_equal "div1", div.when_present(2).text
+    assert div.visible?
+  end
+
+  def test_when_present_block
+    browser.link(:id => "link1").click
+    div = browser.div(:id => "div1")
+    div.when_present(2) do |d|
+      assert_equal "div1", d.text
+    end
+    assert div.visible?
+  end
+
+  def test_when_present_exceptions
+    assert_raises(NoMethodError) {browser.div(:id => "div1").when_present(0.1).non_existing_method}
+    assert_raises(Watir::Wait::TimeoutError) {browser.div(:id => "non-existing").when_present(0.1).text}
+  end
+
+  def test_wait_until_present
+    browser.link(:id => "link1").click
+
+    div = browser.div(:id => "div1")
+    browser.link(:id => "link1").click
+    div.wait_until_present(2)
+    assert div.visible?
+  end
+
+  def test_wait_until_present_exception
+    assert_raises(Watir::Wait::TimeoutError) {browser.div(:id => "non-existing").wait_until_present(0.1)}
+  end
+
+  def test_wait_while_present
+    div = browser.div(:id => "div1")
+    browser.link(:id => "link1").click
+    div.wait_while_present(2)
+    assert !div.visible?
+  end
+
+  def test_wait_while_present_exception
+    assert_raises(Watir::Wait::TimeoutError) {browser.div(:id => "div1").wait_while_present(0.1)}
+  end
+
+  def test_wait_module_until
+    div = browser.div(:id => "div1")
+    assert div.visible?
+    browser.link(:id => "link1").click
+
+    Watir::Wait.until(2) {not div.visible?}
+    assert !div.visible?
+  end
+
+  def test_wait_module_while
+    div = browser.div(:id => "div1")
+    assert div.visible?
+    browser.link(:id => "link1").click
+
+    Watir::Wait.while(2) {div.visible?}
+    assert !div.visible?
+  end
+end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: commonwatir
 version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
+  hash: 977940594
+  prerelease: true
   segments: 
   - 1
   - 6
-  - 6
-  version: 1.6.6
+  - 7
+  - rc1
+  version: 1.6.7.rc1
 platform: ruby
 authors: 
 - Bret Pettichord
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -06:00
+date: 2010-10-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,11 +45,15 @@ files:
 - lib/watir/assertions.rb
 - lib/watir/browser.rb
 - lib/watir/browsers.rb
+- lib/watir/element_extensions.rb
 - lib/watir/exceptions.rb
 - lib/watir/matches.rb
 - lib/watir/options.rb
 - lib/watir/testcase.rb
+- lib/watir/version.rb
+- lib/watir/wait.rb
 - lib/watir/waiter.rb
+- lib/watir/wait_helper.rb
 - lib/watir.rb
 - Rakefile
 - LICENSE
@@ -77,6 +82,7 @@ files:
 - unittests/html/select_lists.html
 - unittests/html/utf8.html
 - unittests/html/visibility.html
+- unittests/html/wait.html
 - unittests/html/watir_unit_tests.css
 - unittests/html/whitespace.html
 - unittests/inspect_test.rb
@@ -93,6 +99,7 @@ files:
 - unittests/strong_test.rb
 - unittests/utf8_test.rb
 - unittests/visibility_test.rb
+- unittests/wait_test.rb
 - unittests/whitespace_test.rb
 has_rdoc: true
 homepage: http://www.watir.com
@@ -116,12 +123,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: wtr
@@ -152,6 +161,7 @@ test_files:
 - unittests/html/select_lists.html
 - unittests/html/utf8.html
 - unittests/html/visibility.html
+- unittests/html/wait.html
 - unittests/html/watir_unit_tests.css
 - unittests/html/whitespace.html
 - unittests/inspect_test.rb
@@ -168,4 +178,5 @@ test_files:
 - unittests/strong_test.rb
 - unittests/utf8_test.rb
 - unittests/visibility_test.rb
+- unittests/wait_test.rb
 - unittests/whitespace_test.rb