watir-dom-wait 0.1.3 → 0.2.0

data/README.md

@@ -78,9 +78,9 @@ Watir::Dom::Wait.interval = 0.15
 
 ## How it works
 
-By attaching `DOMSubtreeModified` event to element. It's supported in all major browsers (except Presto-powered Opera).
+Using [MutationObserver](https://developer.mozilla.org/en/docs/Web/API/MutationObserver).
 
-Note, that it also rescues `Selenium::WebDriver::Error::StaleElementReferenceError` and `Selenium::WebDriver::Error::JavascriptError` when waits for DOM.
+Note, that it also rescues `Selenium::WebDriver::Error::StaleElementReferenceError`, `Selenium::WebDriver::Error::JavascriptError` and `Watir::Exception::UnknownObjectException` (only when its message contains `Element not found in the cache - perhaps the page has changed since it was looked up`) when waits for DOM.
 
 ## Contributors
 

data/lib/watir/dom/elements/element.rb

@@ -33,25 +33,16 @@ module Watir
       opts[:interval] ||= Dom::Wait.interval
       opts[:delay]    ||= Dom::Wait.delay
 
-      if block_given?
-        js = Dom::Wait::JAVASCRIPT.dup
-        browser.execute_script js, self, opts[:interval], opts[:delay]
-        Wait.until(opts[:timeout], message) { browser.execute_script(Dom::Wait::DOM_READY) == 0 }
-        yield self
-      else
-        WhenDOMChangedDecorator.new(self, opts, message)
+      Dom::Wait.rescue do
+        if block_given?
+          js = Dom::Wait::JAVASCRIPT.dup
+          browser.execute_script js, self, opts[:interval], opts[:delay]
+          Wait.until(opts[:timeout], message) { browser.execute_script(Dom::Wait::DOM_READY) == 0 }
+          yield self
+        else
+          WhenDOMChangedDecorator.new(self, opts, message)
+        end
       end
-
-    rescue Selenium::WebDriver::Error::StaleElementReferenceError, Selenium::WebDriver::Error::JavascriptError
-      # StaleElementReferenceError
-      #   element can become stale, so we just retry DOM waiting
-      #
-      # JavascriptError
-      #   in rare cases, args passed to execute script are not correct, for example:
-      #     correct:   [#<Watir::Body:0x6bb2ccb9de06cb92 located=false selector={:element=>(webdriver element)}>, 300, 3000]    [el, interval, delay]
-      #     incorrect: [0.3, 3000, nil]                                                                                         [interval, delay, ?]
-      #   TODO there might be some logic (bug?) in Selenium which does this
-      retry
     end
 
     #

data/lib/watir/dom/extensions/js/waitForDom.js

@@ -56,27 +56,30 @@ function Watir(options) {
   this.set(options);
 
   this.startedModifying = false;
-  this.domReady         = 1;
+  this.domReady = 1;
+  this.observers = {
+    forceReady:     null,
+    startModifying: null
+  }
 
-  this.bindDOMEvents();
+  this.addObservers();
   this.exitOnTimeout();
 };
 
-Watir.prototype.set = function (options) {
-  if (options == null) { 
+Watir.prototype.set = function(options) {
+  if (options == null) {
     options = {};
   }
 
   this.el       = options.el;
-  this.event    = options.event || 'DOMSubtreeModified';
   this.interval = options.interval;
   this.delay    = options.delay;
 
-  this.forceReady = this.wrappedForceReady();
+  this.forceReady     = this.wrappedForceReady();
   this.startModifying = this.wrappedStartModifying();
 }
 
-Watir.prototype.exitOnTimeout = function () {
+Watir.prototype.exitOnTimeout = function() {
   var that = this;
 
   Underscore.delay(function() {
@@ -86,29 +89,47 @@ Watir.prototype.exitOnTimeout = function () {
   }, this.delay);
 };
 
-Watir.prototype.bindDOMEvents = function() {
-  this.addEventListener(this.forceReady);
-  this.addEventListener(this.startModifying);
+Watir.prototype.addObservers = function() {
+  this.observers.forceReady     = this.observe(this.el, this.forceReady);
+  this.observers.startModifying = this.observe(this.el, this.startModifying);
 }
 
-Watir.prototype.unbindDOMEvents = function() {
-  this.removeEventListener(this.forceReady);
-  this.removeEventListener(this.startModifying);
+Watir.prototype.removeObservers = function() {
+  this.unobserve(this.observers.forceReady);
+  this.unobserve(this.observers.startModifying);
 }
 
-Watir.prototype.wrappedForceReady = function () {
+Watir.prototype.observe = function(el, fn) {
+  var observer = new MutationObserver(function(mutations) {
+    fn();
+  });
+  var config = {
+    attributes:    true,
+    childList:     true,
+    characterData: true,
+    subtree:       true
+  };
+  observer.observe(el, config);
+  return observer;
+};
+
+Watir.prototype.unobserve = function(observer) {
+  observer.disconnect();
+};
+
+Watir.prototype.wrappedForceReady = function() {
   return Underscore.bind(Underscore.debounce(this._forceReady, this.interval), this);
 };
 
-Watir.prototype.wrappedStartModifying = function () {
+Watir.prototype.wrappedStartModifying = function() {
   return Underscore.bind(Underscore.once(this._startModifying, this.interval), this);
 }
 
-Watir.prototype._forceReady = function() {
+Watir.prototype._forceReady = function(mutations) {
   var that = this;
 
   Underscore.once(function() {
-    that.unbindDOMEvents();
+    that.removeObservers();
     that.domReady -= 1;
   })();
 }
@@ -117,33 +138,8 @@ Watir.prototype._startModifying = function() {
   this.startedModifying = true;
 }
 
-Watir.prototype.addEventListener = (function() {
-  if (window.addEventListener) {
-    return function (fn) {
-      this.el.addEventListener(this.event, fn, false);
-    };
-  } else {
-    return function (fn) {
-      this.el.attachEvent('on' + this.event, fn)
-    };
-  }
-})();
-
-Watir.prototype.removeEventListener = (function() {
-  if (window.removeEventListener) {
-    return function (fn) {
-      this.el.removeEventListener(this.event, fn, false);
-    };
-  } else {
-    return function (fn) {
-      this.el.detachEvent('on' + this.event, fn)
-    };
-  }
-})();
-
 window.watir = new Watir({
   el:       arguments[0],
   interval: arguments[1] * 1000,
   delay:    arguments[2] * 1000,
 });
-

data/lib/watir/dom/wait.rb

@@ -28,6 +28,30 @@ module Watir
           @delay ||= 1
         end
 
+        #
+        # Executes block rescuing all necessary exceptions.
+        # @param [Proc] block
+        # @api private
+        #
+
+        def rescue(&block)
+          block.call
+        rescue Selenium::WebDriver::Error::StaleElementReferenceError, Exception::UnknownObjectException => error
+          msg = 'Element not found in the cache - perhaps the page has changed since it was looked up'
+          if error.is_a?(Watir::Exception::UnknownObjectException) && !error.message.include?(msg)
+            raise error
+          else
+            # element can become stale, so we just retry DOM waiting
+            retry
+          end
+        rescue Selenium::WebDriver::Error::JavascriptError
+          # in rare cases, args passed to execute script are not correct, for example:
+          #   correct:   [#<Watir::Body:0x6bb2ccb9de06cb92 located=false selector={:element=>(webdriver element)}>, 300, 3000]    [el, interval, delay]
+          #   incorrect: [0.3, 3000, nil]                                                                                         [interval, delay, ?]
+          # TODO there might be some logic (bug?) in Selenium which does this
+          retry
+        end
+
       end # << self
     end # Wait
   end # Dom
@@ -52,10 +76,12 @@ module Watir
         raise NoMethodError, "undefined method `#{m}' for #{@element.inspect}:#{@element.class}"
       end
 
-      @element.browser.execute_script @js, @element, @opts[:interval], @opts[:delay]
-      Watir::Wait.until(@opts[:timeout], @message) { @element.browser.execute_script(Dom::Wait::DOM_READY) == 0 }
+      Dom::Wait.rescue do
+        @element.browser.execute_script @js, @element, @opts[:interval], @opts[:delay]
+        Watir::Wait.until(@opts[:timeout], @message) { @element.browser.execute_script(Dom::Wait::DOM_READY) == 0 }
 
-      @element.__send__(m, *args, &block)
+        @element.__send__(m, *args, &block)
+      end
     end
 
     def respond_to?(*args)

data/lib/watir/dom/wait/version.rb

@@ -1,7 +1,7 @@
 module Watir
   module Dom
     module Wait
-      VERSION = "0.1.3"
+      VERSION = "0.2.0"
     end # Wait
   end # Dom
 end # Watir

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require "watir/dom/wait"
 
 RSpec.configure do |spec|
+  spec.filter_run_excluding bug: /\d+/
+
   spec.before(:all) do
     @browser = Watir::Browser.new
     @browser.goto "data:text/html,#{File.read('spec/support/html/wait_for_dom.html')}"

data/spec/support/html/wait_for_dom.html

@@ -17,30 +17,48 @@
         }, number * timeout);
       }
 
-	  function staleDiv(parent_id, child_id) {
+      function staleDiv(parent_id, child_id) {
         var parent  = document.getElementById(parent_id);
         var child   = document.getElementById(child_id);
-		var new_div = document.createElement("div");
-		new_div.id  = child_id;
-		new_div.style = 'display: block;';
+        var new_div = document.createElement("div");
+        new_div.id    = child_id;
+        new_div.style = 'display: block;';
 
         setTimeout(function() {
-		  parent.removeChild(child);
-		  parent.appendChild(new_div);
+          parent.removeChild(child);
+          parent.appendChild(new_div);
         }, 1000);
-	  }
+      }
+
+      function fadeIn(id, value) {
+        var el = document.getElementById(id);
+        el.style.opacity = '0.' + value;
+        if (value < 9) {
+          console.log(value);
+          value++;
+          setTimeout(function() { fadeIn(id, value) }, 400);
+        } else {
+          el.innerHTML = 'Faded';
+          return;
+        }
+      }
     </script>
   </head>
 
   <body>
-    <div id="container1">
-	  <div id="container2"></div>
-	</div>
-    <br />
     <button onclick="modifySubtree('container1', 5, 1000);" id="long">Start modifying subtree with 5 node operations and 1000 ms delay between them</button>
     <br />
     <button onclick="modifySubtree('container1', 20, 100);" id="quick">Start modifying subtree with 20 node operations and 100 ms delay between them</button>
     <br />
     <button onclick="modifySubtree('container2', 20, 100); staleDiv('container1', 'container2');" id="stale">Start modifying and then update child div</button>
+    <br />
+    <button onclick="fadeIn('span', 0)" id="fade">Start fading in text</button>
+    <br />
+    <div id="container1">
+      <div id="container2"></div>
+    </div>
+    <div id="container3">
+      <span id="span" style="opacity: 0">To Fade</span>
+    </div>
   </body>
 </html>

data/spec/watir-dom-wait/element_spec.rb

@@ -65,6 +65,14 @@ describe Watir::Element do
       end
     end
 
+    context "when effects are used" do
+      it "properly handles fading" do
+        @browser.button(:id => 'fade').click
+        text = @browser.div(:id => 'container3').when_dom_changed.span.text
+        expect(text).to eq('Faded')
+      end
+    end
+
     context "when element goes stale" do
       before(:all) do
         Watir.always_locate = false
@@ -78,9 +86,14 @@ describe Watir::Element do
         div = @browser.div(:id => 'container2')
         div.exists?
         @browser.refresh
-        expect {
-          div.when_dom_changed.text
-        }.not_to raise_error(Selenium::WebDriver::Error::StaleElementReferenceError)
+        expect { div.when_dom_changed.text }.not_to raise_error
+      end
+    end
+
+    context "when element cannot be located" do
+      it "relocates element" do
+        div = @browser.div(:id => 'doesnotexist')
+        expect { div.when_dom_changed.text }.to raise_error(Watir::Exception::UnknownObjectException)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-dom-wait
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -357748089059915628
+      hash: -2698553052236191813
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -357748089059915628
+      hash: -2698553052236191813
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23