watir-classic 3.3.0 → 3.4.0

data/lib/watir-classic/util.rb

@@ -1,25 +1,23 @@
 module Watir
   class Util
     class << self
-      #
-      # "Watir::Span" => "Span"
-      # 
+
+      # @example
+      #   Watir::Util.demodulize("Watir::Span") # => "Span"
       def demodulize(str)
         str.gsub(/^.*::/, '')
       end
 
-      #
-      # "FooBar" => "foo_bar"
-      # 
+      # @example
+      #   Watir::Util.underscore("FooBar") # => "foo_bar"
       def underscore(str)
         str.gsub(/\B[A-Z][^A-Z]/, '_\&').downcase.gsub(' ', '_')
       end
 
-      #
-      # "Checkboxes" => "Checkbox"
-      # "Bodies" => "Body"
-      # "Buttons" => "Button"
-      #
+      # @example
+      #   Watir::Util.singularize("Checkboxes") # => "Checkbox"
+      #   Watir::Util.singularize("Bodies") # => "Body"
+      #   Watir::Util.singularize("Buttons") # => "Button"
       def singularize(str)
         case str.downcase
         when "checkboxes"

data/lib/watir-classic/wait.rb

@@ -7,10 +7,16 @@ module Watir
     class TimeoutError < StandardError
     end
 
-    #
     # Wait until the block evaluates to true or times out.
     #
-
+    # @example
+    #   Watir::Wait.until(5) { browser.text_field.exists? }
+    #
+    # @param [Fixnum] timeout timeout to wait until block returns true.
+    # @yieldparam [self] instance instance of self.
+    # @raise [TimeoutError] when timeout exceeds.
+    # @see WaitHelper
+    # @see ElementExtensions
     def until(timeout = 60, &block)
       end_time = ::Time.now + timeout
 
@@ -23,9 +29,16 @@ module Watir
       raise TimeoutError, "timed out after #{timeout} seconds"
     end
 
-    #
     # Wait while the block evaluates to true or times out.
     #
+    # @example
+    #   Watir::Wait.while(5) { browser.text_field.exists? }
+    #
+    # @param [Fixnum] timeout timeout to wait while block returns true.
+    # @yieldparam [self] instance instance of self.
+    # @raise [TimeoutError] when timeout exceeds.
+    # @see WaitHelper
+    # @see ElementExtensions    
     def while(timeout = 60, &block)
       end_time = ::Time.now + timeout
 
@@ -38,4 +51,4 @@ module Watir
     end
 
   end # Wait
-end # Watir
+end # Watir

data/lib/watir-classic/wait_helper.rb

@@ -1,12 +1,25 @@
-# include this module if there's a need to have wait_until and wait_while methods in some different scope
 module Watir
   module WaitHelper
+    # Wait until block evaluates to true or times out.
+    #
+    # @example
+    #   browser.wait_until(5) { browser.text_field.exists? }
+    #
+    # @see Wait
+    # @see ElementExtensions
     def wait_until(*args, &blk)
       Wait.until(*args, &blk)
     end
 
+    # Wait while block evaluates to true or times out.
+    #
+    # @example
+    #   browser.wait_while(5) { browser.text_field.exists? }
+    #
+    # @see Wait
+    # @see ElementExtensions
     def wait_while(*args, &blk)
       Wait.while(*args, &blk)
     end
   end
-end
+end

data/lib/watir-classic/win32.rb

@@ -3,6 +3,7 @@ require 'dl/struct'
 require 'Win32API'
 
 module Watir
+  # @private
   module Win32
     # this will find the IEDialog.dll file in its build location
     @@iedialog_file = (File.expand_path(File.dirname(__FILE__) + '/..') + "/watir-classic/IEDialog/Release/IEDialog.dll").gsub('/', '\\')
@@ -37,4 +38,4 @@ module Watir
       rtn == 1
     end
   end
-end  
+end  

data/lib/watir-classic/window.rb

@@ -1,11 +1,14 @@
 module Watir
+  # Returned by {IE#window}.
   class Window
     include ElementExtensions
 
     class << self
+      # @private
       attr_accessor :__main_ie
 
-      def wrap *meths
+      # @private
+      def wrap(*meths)
         meths.each do |meth|
           define_method meth do
             result = nil
@@ -16,7 +19,7 @@ module Watir
       end
     end
 
-    def initialize(main_browser, locators, browser=nil, &blk)
+    def initialize(main_browser, locators, browser=nil)
       valid_locators = [:title, :url, :hwnd, :index]
       locators.each_pair do |k, v| 
         raise ArgumentError, "Valid locators are #{valid_locators.join(", ")}" unless valid_locators.include?(k)
@@ -27,14 +30,36 @@ module Watir
       @browser = browser
     end
 
+    # @!method url
+    #   @return [String] url of the {Window}.
+    # @!method title
+    #   @return [String] title of the {Window}.
+    # @!method hwnd
+    #   @return [Fixnum] handle of the {Window}.
+    # @!method close
+    #   Close the {Window}.
     wrap :url, :title, :hwnd, :close
 
+    # @return [Browser] browser of the window.
     def browser
       @browser ||= begin
                     IE.find(@locators.keys.first, @locators.values.first)
                    end
     end
 
+    # Use the window.
+    #
+    # @example Change current window:
+    #   browser.window(:title => /foo/).use
+    #   browser.title # => "foo"
+    #
+    # @example Execute code in the other window:
+    #   browser.window(:title => /foo/).use do
+    #     browser.title # => "foo"
+    #   end
+    #   browser.title # => "current window title"
+    #
+    # @yield optional block in the context of new {Window}.
     def use(&blk)
       @main_browser.ie = browser.ie
       if blk
@@ -49,20 +74,23 @@ module Watir
       self
     end
 
+    # @return [Boolean] true when {Window} is the active {Browser} instance,
+    #   false otherwise
     def current?
       @main_browser.hwnd == browser.hwnd && @main_browser.html == browser.html
     end
 
+    # @return [Boolean] true when {Window} browser exists, false otherwise.
+    def present?
+      @browser = nil
+      browser && browser.exists?
+    end
+
     def ==(other)
       browser.hwnd == other.hwnd && browser.html == other.browser.html
     end
 
     alias_method :eql?, :==
 
-    def present?
-      @browser = nil
-      browser && browser.exists?
-    end
-
   end
 end

data/lib/watir-classic/xpath_locator.rb

@@ -1,4 +1,5 @@
 module Watir
+  # @private
   module XpathLocator
 
     def xmlparser_document_object

data/lib/watir-classic/yard/global_macros.rb

@@ -0,0 +1,7 @@
+# @!macro exists
+#   @raise [UnknownObjectException] when element does not exist.
+#   @raise [UnknownFrameException] when element is inside of a frame and
+#     that frame does not exist.
+
+# @!macro enabled
+#   @raise [ObjectDisabledException] when element is disabled.

data/spec/frame_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require File.expand_path("watirspec/spec_helper", File.dirname(__FILE__))
+
+describe "Frame" do
+  before :each do
+    browser.goto(WatirSpec.url_for("frames.html"))
+  end
+  
+  it "handles clicking elements without waiting" do
+    browser.frame(:id, "frame_1").text_field(:name, 'senderElement').value.should == 'send_this_value'
+    browser.frame(:id, "frame_2").text_field(:name, 'recieverElement').value.should == 'old_value'
+    browser.frame(:id, "frame_1").button(:id, 'send').click_no_wait
+    browser.frame(:id, "frame_2").text_field(:name, 'recieverElement').value.should == 'old_value'
+    browser.frame(:id, "frame_2").text_field(:name => 'recieverElement', :text => 'send_this_value').wait_until_present(10).should_not raise_error(Watir::Wait::TimeoutError)
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-classic
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-27 00:00:00.000000000 Z
+date: 2013-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: win32-process
@@ -254,11 +254,7 @@ files:
 - lib/watir-classic/IEDialog/stdafx.h
 - lib/watir-classic/browser.rb
 - lib/watir-classic/browsers.rb
-- lib/watir-classic/close_all.rb
 - lib/watir-classic/container.rb
-- lib/watir-classic/contrib/enabled_popup.rb
-- lib/watir-classic/contrib/ie-new-process.rb
-- lib/watir-classic/contrib/page_checker.rb
 - lib/watir-classic/cookies.rb
 - lib/watir-classic/core.rb
 - lib/watir-classic/dialogs/alert.rb
@@ -302,13 +298,14 @@ files:
 - lib/watir-classic/win32ole/history.txt
 - lib/watir-classic/window.rb
 - lib/watir-classic/xpath_locator.rb
+- lib/watir-classic/yard/global_macros.rb
 - spec/browser_spec.rb
 - spec/element_spec.rb
+- spec/frame_spec.rb
 - spec/implementation.rb
 - spec/link_spec.rb
 - spec/select_list_spec.rb
 - watir-classic.gemspec
-- watir.gif
 homepage: http://watir.com/
 licenses: []
 post_install_message: 
@@ -337,6 +334,7 @@ summary: Automated testing tool for web applications.
 test_files:
 - spec/browser_spec.rb
 - spec/element_spec.rb
+- spec/frame_spec.rb
 - spec/implementation.rb
 - spec/link_spec.rb
 - spec/select_list_spec.rb

data/lib/watir-classic/close_all.rb

@@ -1,31 +0,0 @@
-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/contrib/enabled_popup.rb

@@ -1,21 +0,0 @@
-# http://www.vbcity.com/forums/topic.asp?tid=108859
-require 'watir-classic/ie'
-module Watir
-  module PageContainer
-    include Win32
-    def enabled_popup(timeout=4)
-      # Use handle of our parent window to see if we have any currently
-      # enabled popup.
-      hwnd_modal = 0
-      Wait.until(timeout) do
-        hwnd_modal, arr = GetWindow.call(hwnd, GW_ENABLEDPOPUP)
-        hwnd_modal > 0
-      end
-      # use hwnd() method to find the IE or Container hwnd (overriden by IE)
-      if hwnd_modal == hwnd() || 0 == hwnd_modal
-        hwnd_modal = nil
-      end
-      hwnd_modal
-    end
-  end
-end

data/lib/watir-classic/contrib/ie-new-process.rb

@@ -1,27 +0,0 @@
-# based on http://svn.instiki.org/instiki/trunk/test/watir/e2e.rb
-# and http://rubyforge.org/pipermail/wtr-general/2005-November/004108.html
-
-require 'watir-classic/ie-process'
-
-class IEProcess < Watir::IE::Process 
-  def stop
-    right_to_terminate_process = 1
-    handle = Win32API.new('kernel32.dll', 'OpenProcess', 'lil', 'l').
-    call(right_to_terminate_process, 0, @process_id)
-    Win32API.new('kernel32.dll', 'TerminateProcess', 'll', 'l').call(handle, 0)
-  end
-  
-end
-
-module Watir
-  class IE
-    def process_id
-      @process_id ||= IEProcess.process_id_from_hwnd @ie.hwnd
-    end
-    attr_writer :process_id
-    def kill
-      iep = IEProcess.new process_id
-      iep.stop
-    end
-  end
-end

data/lib/watir-classic/contrib/page_checker.rb

@@ -1,29 +0,0 @@
-#  This module includes checkers which are run on every page load
-# 
-#  In order to use this module, add a require to one of your test scripts: 
-#  require 'watir-classic/contrib/page_checker'
-#  To add checkers, call the ie.add_checker method
-#
-#  ie.add_checker(PageCheckers::NAVIGATION_CHECKER)
-#
-#  Checkers are Ruby proc objects which are called within Watir::IE and passed 
-#  the current instance of ie. 
-
-module PageCheckers        
-
-	# This checker iterates through  the current document including any frames
-	# and checks for http errors, 404, 500 etc
-	NAVIGATION_CHECKER = lambda do |ie|
-		if ie.document.frames.length > 1
-			1.upto ie.document.frames.length do |i|
-				begin
-					ie.frame(:index, i).check_for_http_error
-				rescue Watir::Exception::UnknownFrameException
-					# frame can be already destroyed
-				end          
-			end
-		else
-			ie.check_for_http_error
-		end
-	end
-end