watir-webdriver 0.5.8 → 0.6.0

data/README.md

@@ -6,11 +6,6 @@ See http://rubyforge.org/pipermail/wtr-development/2009-October/001313.html.
 
 [![Build Status](https://secure.travis-ci.org/watir/watir-webdriver.png)](http://travis-ci.org/watir/watir-webdriver)
 
-API docs
---------
-
-http://jarib.github.com/watir-webdriver/doc/
-
 Example
 -------
 ```ruby
@@ -39,9 +34,16 @@ watir-webdriver uses [watirspec](http://github.com/watir/watirspec) for testing.
 
 Specs specific to watir-webdriver are found in spec/*_spec.rb, with watirspec in spec/watirspec.
 
+API docs
+--------
+
+* http://rdoc.info/gems/watir-webdriver/ (basic docs, updated on every release)
+* http://watir.github.com/watir-webdriver/doc/ (includes all attribute methods, updated occasionally)
+
 See also
 --------
 
+* http://watirwebdriver.com
 * http://github.com/jarib/webidl
 * http://github.com/watir/watirspec
 * http://selenium.googlecode.com

data/lib/watir-webdriver.rb

@@ -7,6 +7,7 @@ require 'watir-webdriver/exception'
 require 'watir-webdriver/xpath_support'
 require 'watir-webdriver/window'
 require 'watir-webdriver/has_window'
+require 'watir-webdriver/alert'
 require 'watir-webdriver/atoms'
 require 'watir-webdriver/container'
 require 'watir-webdriver/cookies'
@@ -16,6 +17,7 @@ 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/screenshot'
 
 module Watir
   @always_locate = true

data/lib/watir-webdriver/alert.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Watir
+  class Alert
+
+    include EventuallyPresent
+
+    def initialize(target_locator)
+      @target_locator = target_locator
+      @alert = nil
+    end
+
+    def text
+      assert_exists
+      @alert.text
+    end
+
+    def ok
+      assert_exists
+      @alert.accept
+    end
+
+    def close
+      assert_exists
+      @alert.dismiss
+    end
+
+    def set(value)
+      assert_exists
+      @alert.send_keys(value)
+    end
+
+    def exists?
+      assert_exists
+      true
+    rescue UnknownObjectException
+      false
+    end
+    alias_method :present?, :exists?
+
+    def selector_string
+      'alert'
+    end
+
+    private
+
+    def assert_exists
+      @alert = @target_locator.alert
+    rescue Selenium::WebDriver::Error::NoAlertPresentError
+      raise UnknownObjectException, 'unable to locate alert'
+    end
+
+  end # Alert
+end # Watir

data/lib/watir-webdriver/browser.rb

@@ -102,6 +102,10 @@ module Watir
       @driver.page_source
     end
 
+    def alert
+      Alert.new driver.switch_to
+    end
+
     def refresh
       @driver.navigate.refresh
       run_checkers
@@ -132,6 +136,19 @@ module Watir
       @driver.switch_to.active_element.send_keys(*args)
     end
 
+    #
+    # Handles screenshot of current pages.
+    #
+    # @example
+    #   browser.screenshot.save("screenshot.png")
+    #
+    # @return [Watir::Screenshot]
+    #
+
+    def screenshot
+      Screenshot.new driver
+    end
+
     def add_checker(checker = nil, &block)
       if block_given?
         @error_checkers << block

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

@@ -1,5 +1,7 @@
 module Watir
 
+  #
+  # Deprecated, use the new Alert API instead.
   #
   # Module provided by optional require:
   #
@@ -20,6 +22,7 @@ module Watir
     #
 
     def alert(&blk)
+      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.alert.close)'
       execute_script "window.alert = function(msg) { window.__lastWatirAlert = msg; }"
       yield
       execute_script "return window.__lastWatirAlert"
@@ -36,6 +39,7 @@ module Watir
     #   end #=> "the confirm message"
 
     def confirm(bool, &blk)
+      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.confirm.close)'
       execute_script "window.confirm = function(msg) { window.__lastWatirConfirm = msg; return #{!!bool} }"
       yield
       execute_script "return window.__lastWatirConfirm"
@@ -53,6 +57,7 @@ module Watir
     #
 
     def prompt(answer, &blk)
+      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.prompt.close)'
       execute_script "window.prompt = function(text, value) { window.__lastWatirPrompt = { message: text, default_value: value }; return #{MultiJson.encode answer}; }"
       yield
       result = execute_script "return window.__lastWatirPrompt"

data/lib/watir-webdriver/screenshot.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+module Watir
+  class Screenshot
+
+    def initialize(driver)
+      @driver = driver
+    end
+
+    #
+    # Saves screenshot to given path.
+    #
+    # @param [String] path
+    #
+
+    def save(path)
+      @driver.save_screenshot(path)
+    end
+
+    #
+    # Represents screenshot as PNG image string.
+    #
+    # @return [String]
+    #
+
+    def png
+      @driver.screenshot_as(:png)
+    end
+
+    #
+    # Represents screenshot as Base64 encoded string.
+    #
+    # @return [String]
+    #
+
+    def base64
+      @driver.screenshot_as(:base64)
+    end
+
+  end # Screenshot
+end # Watir

data/lib/watir-webdriver/version.rb

@@ -1,3 +1,3 @@
 module Watir
-  VERSION = "0.5.8"
+  VERSION = "0.6.0"
 end

data/spec/alert_spec.rb

@@ -1,49 +1,91 @@
 require File.expand_path("watirspec/spec_helper", File.dirname(__FILE__))
-require "watir-webdriver/extensions/alerts"
 
-describe "AlertHelper" do
+describe 'Alert API' do
   before do
     browser.goto WatirSpec.url_for("alerts.html", :needs_server => true)
   end
 
-  it "handles an alert()" do
-    returned = browser.alert do
-      browser.button(:id => "alert").click
-    end
-
-    returned.should == "ok"
+  after do
+    browser.alert.close if browser.alert.exists?
   end
 
-  it "handles a confirmed confirm()" do
-    returned = browser.confirm(true) do
-      browser.button(:id => "confirm").click
+  context 'alert' do
+    describe '#text' do
+      it 'returns text of alert' do
+        browser.button(:id => 'alert').click
+        browser.alert.text.should == 'ok'
+      end
     end
 
-    returned.should == "set the value"
+    describe '#exists?' do
+      it 'returns false if alert is present' do
+        browser.alert.should_not exist
+      end
 
-    browser.button(:id => "confirm").value.should == "true"
-  end
+      it 'returns true if alert is present' do
+        browser.button(:id => 'alert').click
+        browser.alert.should exist
+      end
+    end
+
+    describe '#ok' do
+      it 'closes alert' do
+        browser.button(:id => 'alert').click
+        browser.alert.ok
+        browser.alert.should_not exist
+      end
+    end
 
-  it "handles a cancelled confirm()" do
-    returned = browser.confirm(false) do
-      browser.button(:id => "confirm").click
+    describe '#close' do
+      it 'closes alert' do
+        browser.button(:id => 'alert').click
+        browser.alert.close
+        browser.alert.should_not exist
+      end
     end
 
-    returned.should == "set the value"
+    describe 'when_present' do
+      it 'waits until alert is present and goes on' do
+        browser.button(:id => 'timeout-alert').click
+        browser.alert.when_present.close
+        browser.alert.should_not exist
+      end
 
-    browser.button(:id => "confirm").value.should == "false"
+      it 'raises error if alert is not present after timeout' do
+        browser.button(:id => 'timeout-alert').click
+        lambda {
+          browser.alert.when_present(1).close
+        }.should raise_error(Watir::Wait::TimeoutError, 'timed out after 1 seconds, waiting for alert to become present')
+      end
+    end
   end
 
-  it "handles a prompt()" do
-    returned = browser.prompt("my name") do
-      browser.button(:id => "prompt").click
+  context 'confirm' do
+    describe '#ok' do
+      it 'accepts confirm' do
+        browser.button(:id => 'confirm').click
+        browser.alert.ok
+        browser.button(:id => 'confirm').value.should == "true"
+      end
     end
 
-    returned.should == {
-      :message       => "enter your name",
-      :default_value => "John Doe"
-    }
+    describe '#close' do
+      it 'cancels confirm' do
+        browser.button(:id => 'confirm').click
+        browser.alert.close
+        browser.button(:id => 'confirm').value.should == "false"
+      end
+    end
+  end
 
-    browser.button(:id => "prompt").value.should == "my name"
+  context 'prompt' do
+    describe '#set' do
+      it 'enters text to prompt' do
+        browser.button(:id => 'prompt').click
+        browser.alert.set 'My Name'
+        browser.alert.ok
+        browser.button(:id => 'prompt').value.should == 'My Name'
+      end
+    end
   end
 end

data/spec/browser_spec.rb

@@ -118,4 +118,10 @@ describe Watir::Browser do
       lambda { browser.inspect }.should_not raise_error
     end
   end
+
+  describe '#screenshot' do
+    it 'returns an instance of of Watir::Screenshot' do
+      browser.screenshot.should be_kind_of(Watir::Screenshot)
+    end
+  end
 end

data/spec/html/alerts.html

@@ -7,5 +7,6 @@
     <input id=alert type=button onclick="alert('ok')" value=Alert>
     <input id=confirm type=button onclick="this.value = confirm('set the value')" value=Confirm>
     <input id=prompt type=button onclick='this.value = prompt("enter your name", "John Doe")' value=Prompt>
+    <input id=timeout-alert type=button onclick="setTimeout('alert(\'ok\')', 3000)" value=Timeout-Alert>
   </body>
-</html>
+</html>

data/spec/screenshot_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path("watirspec/spec_helper", File.dirname(__FILE__))
+
+describe Watir::Screenshot do
+  describe '#png' do
+    it 'gets png representation of screenshot from WebDriver' do
+      browser.driver.should_receive(:screenshot_as).with(:png)
+      browser.screenshot.png
+    end
+  end
+
+  describe '#base64' do
+    it 'gets base64 representation of screenshot from WebDriver' do
+      browser.driver.should_receive(:screenshot_as).with(:base64)
+      browser.screenshot.base64
+    end
+  end
+
+  describe '#save' do
+    it 'saves screenshot to given file' do
+      path = "#{Dir.tmpdir}/test.png"
+      browser.driver.should_receive(:save_screenshot).with(path)
+      browser.screenshot.save(path)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-webdriver
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -171,6 +171,7 @@ files:
 - README.md
 - Rakefile
 - lib/watir-webdriver.rb
+- lib/watir-webdriver/alert.rb
 - lib/watir-webdriver/aliases.rb
 - lib/watir-webdriver/atoms.rb
 - lib/watir-webdriver/atoms/README
@@ -223,6 +224,7 @@ files:
 - lib/watir-webdriver/locators/element_locator.rb
 - lib/watir-webdriver/locators/text_field_locator.rb
 - lib/watir-webdriver/row_container.rb
+- lib/watir-webdriver/screenshot.rb
 - lib/watir-webdriver/user_editable.rb
 - lib/watir-webdriver/version.rb
 - lib/watir-webdriver/wait.rb
@@ -244,6 +246,7 @@ files:
 - spec/implementation.rb
 - spec/input_spec.rb
 - spec/locator_spec_helper.rb
+- spec/screenshot_spec.rb
 - spec/spec_helper.rb
 - spec/special_chars_spec.rb
 - spec/wait_spec.rb
@@ -290,6 +293,7 @@ test_files:
 - spec/implementation.rb
 - spec/input_spec.rb
 - spec/locator_spec_helper.rb
+- spec/screenshot_spec.rb
 - spec/spec_helper.rb
 - spec/special_chars_spec.rb
 - spec/wait_spec.rb