watir 2.0.4 → 3.0.0.rc1

data/CHANGES

@@ -1,3 +1,44 @@
+== 3.0.0 - 2012/01/13 - more conformance with WatirSpec
+
+* Button#text returns value if exists instead of text
+* Browser#goto prepends url automatically with http:// if scheme is missing
+* Browser#element(s)_by_(xpath/css) are now private methods - use #element(:css => ...) and #element(:xpath => ...) instead
+* Browser#label supports searching by :for attribute
+* Browser#options method for searching <option> elements
+* Browser#body, #thead, #tfoot, #tbody, #frameset and #fieldset added
+* Browser#window and Browser#windows added implementing window switching API (https://github.com/jarib/watirspec/blob/master/window_switching_spec.rb)
+* Element#present? returns false if exception is thrown by #exists? or #visible?
+* Element#style returns CSS text instead of OLE object
+* Element#text returns an empty string for non-visible elements
+* Element#parent returns correct instance of Element class (e.g. Div instead of Element)
+* Element#focus focuses document before focusing on the element
+* Element#right_click and Element#double_click added
+* Element#to_subtype added which returns specific instance of Watir::Element subclass
+* Element#send_keys added
+* Element#eql? as an alias for Element#== added
+* Element#tag_name added
+* ElementCollection#[] method supports negative indexes like regular Arrays
+* ElementCollection#[] returns always an object, even if the index is out of bounds
+* FileField#set and Image#save uses correct Windows file path (e.g. convert "\"-es into "/"-es)
+* FileField#set raises Errno::ENOENT instead of WatirException if file doesn't exist
+* FileField#value= as an alias for FileField#set added
+* Font#color, #face and #size added
+* Form#submit triggers onSubmit event and doesn't submit the form if event's callback returns false
+* Frame#execute_script added
+* Image#file_size, #height and #width return integer instead of a string
+* Image#save blocking fixed
+* Meta#content and #http_equiv added
+* Option code rewritten, causing changes in its API
+* SelectList code rewritten, causing changes in its API
+* SelectList#(selected_)options returns now Options collection instead of an array of strings
+* Table and its subelements code rewritten, causing changes in its API
+* Table#strings and #hashes added
+* TextField#label added
+* searching elements will find only correct types - e.g. using Browser#div returns only DIV element even if all other provided selectors match
+* all selectors and tag of the element needs to match even if searching by :id
+* supporting html5 data-* attributes by using :data_* for locating and #data_* for retrieving attribute values
+* many other internal changes
+
 == Version 2.0.4 - 2011/10/29
 
 * IE#execute_script escapes multi-line JavaScript scripts

data/VERSION

@@ -1 +1 @@
-2.0.4
+3.0.0.rc1

data/lib/watir/collections.rb

@@ -1,25 +1,13 @@
 module Watir
   class InputElementCollections < ElementCollections
     def each
-      @container.input_element_locator(@how, @what, element_class::INPUT_TYPES, element_class).each {|element| yield element}
+      @container.locator_for(InputElementLocator, element_class::INPUT_TYPES, @how, @what, element_class).each {|element| yield element}
     end    
   end
 
-  class Frames < ElementCollections
-    def each
-      @container.locator_for(FrameLocator, @how, @what).each {|element| yield element}
-    end
-  end
-
-  class Forms < ElementCollections
-    def each
-      @container.locator_for(FormLocator, @how, @what).each {|element| yield element}
-    end    
-  end
-  
   class HTMLElements < ElementCollections
     def each
-      @container.locator_for(ElementLocator, @how, @what).each { |element| yield element }
+      @container.locator_for(TaggedElementLocator, ["*"], @how, @what, Element).each { |element| yield element }
     end
   end
 
@@ -44,10 +32,14 @@ module Watir
   class Inses < ElementCollections
     def element_class; Ins; end
   end
-  
-  %w[Link Li Map Area Image Table TableRow TableCell
+
+  class TableSectionCollection < ElementCollections
+    def element_class; TableSection; end
+  end
+
+  %w[Form Frame Link Li Map Area Image Table TableRow TableCell TableHeader TableFooter TableBody
      Label Pre P Span Div Dl Dt Dd Strong Em Del
-     Font H1 H2 H3 H4 H5 H6 Meta Ol Ul].each do |element|
+     Font H1 H2 H3 H4 H5 H6 Meta Ol Ul FieldSet Option].each do |element|
     module_eval %Q{
       class #{element}s < ElementCollections; end
     }

data/lib/watir/container.rb

@@ -98,20 +98,8 @@ module Watir
     # Not for external use, but cannot set to private due to usages in Element
     # classes.
 
-    def input_element_locator(how, what, types, klass=nil)
-      locator = InputElementLocator.new self, types, klass
-      locator.set_specifier how, what
-      locator
-    end
-    
-    def tagged_element_locator(tag, how, what, klass=nil)
-      locator = TaggedElementLocator.new self, tag, klass
-      locator.set_specifier how, what
-      locator
-    end
-
-    def locator_for(locator_class, how, what)
-      locator = locator_class.new self
+    def locator_for(locator_class, tags, how, what, klass)
+      locator = locator_class.new self, tags, klass
       locator.set_specifier how, what
       locator
     end

data/lib/watir/core.rb

@@ -27,6 +27,7 @@ require 'watir/table'
 require 'watir/image'
 require 'watir/link'
 require 'watir/html_element'
+require 'watir/window'
 
 require 'watir/win32'
 require 'watir/modal_dialog'

data/lib/watir/dialogs/file_field.rb

@@ -8,12 +8,14 @@ module Watir
       assert_file_exists(file_path)
       assert_exists
       click_no_wait
-      set_file_name file_path
+      set_file_name file_path.gsub(File::SEPARATOR, File::ALT_SEPARATOR)
       open_button.click
     end
 
+    alias_method :value=, :set
+
     def assert_file_exists(file_path)
-      raise WatirException, "#{file_path} has to exist to set!" unless File.exists?(file_path)
+      raise Errno::ENOENT, "#{file_path} has to exist to set!" unless File.exists?(file_path)
     end
 
     def set_file_name(path_to_file)

data/lib/watir/element.rb

@@ -31,10 +31,14 @@ module Watir
     end
 
     def locate
-      return if [Element, TableBodies].include? self.class
-      tag = self.class.const_defined?(:TAG) ? self.class::TAG : self.class.name.split("::").last
-      @o = @container.tagged_element_locator(tag, @how, @what).locate
-    end    
+      return if self.class == Element
+
+      tags = @how.is_a?(Hash) && @how[:tag_name] ? [@how[:tag_name].upcase] :
+             self.class.const_defined?(:TAG) ? [self.class::TAG] : 
+             self.class.const_defined?(:TAGS) ? self.class::TAGS :
+             [self.class.name.split("::").last.upcase]
+      @o = @container.locator_for(TaggedElementLocator, tags, @how, @what, self.class).locate
+    end  
 
     # Return the ole object, allowing any methods of the DOM that Watir doesn't support to be used.
     def ole_object
@@ -50,19 +54,18 @@ module Watir
     end
 
     private
-    def self.def_wrap(ruby_method_name, ole_method_name=nil)
-      ole_method_name = ruby_method_name unless ole_method_name
-      class_eval "def #{ruby_method_name}
+    def self.def_wrap(method_name, ole_method_name=nil)
+      class_eval "def #{method_name}
                           assert_exists
-                          ole_object.invoke('#{ole_method_name}')
+                          ole_object.invoke('#{ole_method_name || method_name}')
                         end"
     end
 
-    def self.def_wrap_guard(method_name)
+    def self.def_wrap_guard(method_name, ole_method_name = nil)
       class_eval "def #{method_name}
                           assert_exists
                           begin
-                            ole_object.invoke('#{method_name}')
+                            ole_object.invoke('#{ole_method_name || method_name}')
                           rescue
                             ''
                           end
@@ -74,8 +77,12 @@ module Watir
     def assert_exists
       locate
       unless ole_object
-        raise UnknownObjectException.new(
-                Watir::Exception.message_for_unable_to_locate(@how, @what))
+        if self.is_a?(Frame)
+          raise UnknownFrameException.new(Watir::Exception.message_for_unable_to_locate(@how, @what))
+        else
+          raise UnknownObjectException.new(
+                  Watir::Exception.message_for_unable_to_locate(@how, @what))
+        end
       end
     end
 
@@ -97,10 +104,6 @@ module Watir
     # return the title of the element
     def_wrap_guard :title
 
-    def_wrap_guard :currentstyle
-    # return current style instead of the inline style of the element
-    alias style currentstyle
-
     def_wrap_guard :alt
     def_wrap_guard :src
 
@@ -108,8 +111,6 @@ module Watir
     def_wrap_guard :type # input elements only
     # return the url the link points to
     def_wrap :href # link only
-    # return the ID of the control that this label is associated with
-    def_wrap :for, :htmlFor # label only
     # return the class name of the element
     # raise an ObjectNotFound exception if the object cannot be found
     def_wrap :class_name, :className
@@ -117,6 +118,55 @@ module Watir
     def_wrap :unique_number, :uniqueNumber
     # Return the outer html of the object - see http://msdn.microsoft.com/workshop/author/dhtml/reference/properties/outerhtml.asp?frame=true
     def_wrap :html, :outerHTML
+    # Return the "for" attribute for label
+    def_wrap_guard :for, :htmlFor
+    # Return the content attribute for meta tag
+    def_wrap_guard :content
+    # Return the http-equiv attribute for meta tag
+    def_wrap_guard :http_equiv, :httpEquiv
+    # Return font tag attributes
+    def_wrap_guard :color
+    def_wrap_guard :face
+    def_wrap_guard :size
+    # Return option label attribute
+    def_wrap_guard :label
+    # Return table rules attribute
+    def_wrap_guard :rules
+    # Return td headers attribute
+    def_wrap_guard :headers
+
+    def tag_name
+      assert_exists
+      @o.tagName.downcase
+    end
+
+    # returns specific Element subclass for current Element
+    def to_subtype
+      assert_exists
+
+      tag = tag_name
+      if tag == "html"
+        html_element(:ole_object, ole_object)
+      elsif tag == "input"
+        self.send(ole_object.invoke('type'), :ole_object, ole_object)
+      elsif tag == "select"
+        self.select_list(:ole_object, ole_object)
+      else
+        self.send(tag.downcase, :ole_object, ole_object)
+      end
+    end
+
+    # send keys to element
+    def send_keys(key_string)
+      focus
+      page_container.send_keys key_string
+    end
+
+    # return the css style as a string
+    def style
+      assert_exists
+      ole_object.style.cssText
+    end
 
     # return the text before the element
     def before_text # label only
@@ -138,18 +188,18 @@ module Watir
       end
     end
 
-    # Return the innerText of the object
+    # Return the innerText of the object or an empty string if the object is
+    # not visible
     # Raise an ObjectNotFound exception if the object cannot be found
     def text
       assert_exists
-      return ole_object.innerText.strip
+      visible? ? ole_object.innerText.strip : ""
     end
 
     # IE9 only returns empty string for ole_object.name for non-input elements
     # so get at it through the attribute which will make the matchers work
     def name
-      assert_exists
-      ole_object.getAttribute('name') || ''
+      attribute_value('name') || ''
     end
 
     def __ole_inner_elements
@@ -165,7 +215,9 @@ module Watir
     # Return the element immediately containing self. 
     def parent
       assert_exists
-      result = Element.new(ole_object.parentelement)
+      parent_element = ole_object.parentelement
+      return unless parent_element
+      result = Element.new(parent_element).to_subtype
       result.set_container self
       result
     end
@@ -178,6 +230,8 @@ module Watir
       ole_object.sourceindex <=> other.ole_object.sourceindex
     end
 
+    alias_method :eql?, :==
+
     # Return true if self is contained earlier in the html than other. 
     alias :before? :<
     # Return true if self is contained later in the html than other. 
@@ -256,9 +310,18 @@ module Watir
       @container.wait
     end
 
+    def right_click
+      perform_action {fire_event("oncontextmenu"); @container.wait}
+    end
+
+    def double_click
+      perform_action {fire_event("ondblclick"); @container.wait}
+    end
+
     def replace_method(method)
       method == 'click' ? 'click!' : method
     end
+
     private :replace_method
 
     def build_method(method_name, *args)
@@ -271,6 +334,7 @@ module Watir
       end
       "#{replace_method(method_name)}(#{arguments.join(',')})"
     end
+
     private :build_method
 
     def generate_ruby_code(element, method_name, *args)
@@ -280,6 +344,7 @@ module Watir
                     "require '#{File.expand_path(File.dirname(__FILE__))}/core';#{element}.#{method};"
       return ruby_code
     end
+
     private :generate_ruby_code
 
     def spawned_no_wait_command(command)
@@ -297,15 +362,12 @@ module Watir
     private :spawned_no_wait_command
 
     def click!
-      assert_exists
-      assert_enabled
-
-      highlight(:set)
-      # Not sure why but in IE9 Document mode, passing a parameter
-      # to click seems to work. Firing the onClick event breaks other tests
-      # so this seems to be the safest change and also works fine in IE8
-      ole_object.click(0)
-      highlight(:clear)
+      perform_action do
+        # Not sure why but in IE9 Document mode, passing a parameter
+        # to click seems to work. Firing the onClick event breaks other tests
+        # so this seems to be the safest change and also works fine in IE8
+        ole_object.click(0)
+      end
     end
 
     # Flash the element the specified number of times.
@@ -326,15 +388,12 @@ module Watir
     #   raises: UnknownObjectException  if the object is not found
     #           ObjectDisabledException if the object is currently disabled
     def fire_event(event)
-      assert_exists
-      assert_enabled
-      highlight(:set)
-      dispatch_event(event)
-      @container.wait
-      highlight(:clear)
+      perform_action {dispatch_event(event); @container.wait}
     end
 
     def dispatch_event(event)
+      assert_exists
+
       if IE.version_parts.first.to_i >= 9
         if @container.page_container.document_mode.to_i >= 9
           ole_object.dispatchEvent(create_event(event))
@@ -347,34 +406,34 @@ module Watir
     end
 
     def create_event(event)
-       event =~ /on(.*)/i
-       event = $1 if $1
-       event.downcase!
-       # See http://www.howtocreate.co.uk/tutorials/javascript/domevents
-       case event
-         when 'abort', 'blur', 'change', 'error', 'focus', 'load',
-              'reset', 'resize', 'scroll', 'select', 'submit', 'unload'
-           event_name = :initEvent
-           event_type = 'HTMLEvents'
-           event_args = [event, true, true]
-         when 'keydown', 'keypress', 'keyup'
-           event_name = :initKeyboardEvent
-           event_type = 'KeyboardEvent'
-           # 'type', bubbles, cancelable, windowObject, ctrlKey, altKey, shiftKey, metaKey, keyCode, charCode
-           event_args = [event, true, true, @container.page_container.document.parentWindow.window, false, false, false, false, 0, 0]
-         when 'click', 'dblclick', 'mousedown', 'mousemove', 'mouseout', 'mouseover', 'mouseup',
-              'contextmenu', 'drag', 'dragstart', 'dragenter', 'dragover', 'dragleave', 'dragend', 'drop', 'selectstart'
-           event_name = :initMouseEvent
-           event_type = 'MouseEvents'
-           # 'type', bubbles, cancelable, windowObject, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget
-           event_args = [event, true, true, @container.page_container.document.parentWindow.window, 1, 0, 0, 0, 0, false, false, false, false, 0, @container.page_container.document]
-         else
-           raise UnhandledEventException, "Don't know how to trigger event '#{event}'"
-       end
-       event = @container.page_container.document.createEvent(event_type)
-       event.send event_name, *event_args
-       event
+     event =~ /on(.*)/i
+     event = $1 if $1
+     event.downcase!
+     # See http://www.howtocreate.co.uk/tutorials/javascript/domevents
+     case event
+       when 'abort', 'blur', 'change', 'error', 'focus', 'load',
+            'reset', 'resize', 'scroll', 'select', 'submit', 'unload'
+         event_name = :initEvent
+         event_type = 'HTMLEvents'
+         event_args = [event, true, true]
+       when 'keydown', 'keypress', 'keyup'
+         event_name = :initKeyboardEvent
+         event_type = 'KeyboardEvent'
+         # 'type', bubbles, cancelable, windowObject, ctrlKey, altKey, shiftKey, metaKey, keyCode, charCode
+         event_args = [event, true, true, @container.page_container.document.parentWindow.window, false, false, false, false, 0, 0]
+       when 'click', 'dblclick', 'mousedown', 'mousemove', 'mouseout', 'mouseover', 'mouseup',
+            'contextmenu', 'drag', 'dragstart', 'dragenter', 'dragover', 'dragleave', 'dragend', 'drop', 'selectstart'
+         event_name = :initMouseEvent
+         event_type = 'MouseEvents'
+         # 'type', bubbles, cancelable, windowObject, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget
+         event_args = [event, true, true, @container.page_container.document.parentWindow.window, 1, 0, 0, 0, 0, false, false, false, false, 0, @container.page_container.document]
+       else
+         raise UnhandledEventException, "Don't know how to trigger event '#{event}'"
      end
+     event = @container.page_container.document.createEvent(event_type)
+     event.send event_name, *event_args
+     event
+   end
 
     # This method sets focus on the active element.
     #   raises: UnknownObjectException  if the object is not found
@@ -382,6 +441,7 @@ module Watir
     def focus
       assert_exists
       assert_enabled
+      @page_container.focus
       ole_object.focus
     end
 
@@ -401,7 +461,7 @@ module Watir
     #   raises: UnknownObjectException  if the object is not found
     def enabled?
       assert_exists
-      return ! disabled
+      !disabled
     end
 
     # If any parent element isn't visible then we cannot write to the
@@ -432,36 +492,32 @@ module Watir
     # Returns null if attribute doesn't exist.
     def attribute_value(attribute_name)
       assert_exists
-      return ole_object.getAttribute(attribute_name)
+      ole_object.getAttribute(attribute_name)
+    end
+
+    def perform_action
+      assert_exists
+      assert_enabled
+      highlight(:set)
+      yield
+      highlight(:clear)
     end
 
+    private :perform_action
+
     def method_missing(method_name, *args, &block)
-      if method_name.to_s =~ /(.*)_no_wait/ && self.respond_to?($1)
-        assert_exists
-        assert_enabled
-        highlight(:set)
-        ruby_code = generate_ruby_code(self, $1, *args)
-        system(spawned_no_wait_command(ruby_code))
-        highlight(:clear)
+      meth = method_name.to_s
+      if meth =~ /(.*)_no_wait/ && self.respond_to?($1)
+        perform_action do
+          ruby_code = generate_ruby_code(self, $1, *args)
+          system(spawned_no_wait_command(ruby_code))
+        end
+      elsif meth =~ /^data_(.*)/
+        self.send(:attribute_value, meth.gsub("_", "-")) || ''
       else
         super
       end
     end
-  end
-
-  class ElementMapper # Still to be used
-    include Container
-
-    def initialize wrapper_class, container, how, what
-      @wrapper_class = wrapper_class
-      set_container
-      @how = how
-      @what = what
-    end
-
-    def method_missing method, *args
-      locate
-      @wrapper_class.new(@o).send(method, *args)
-    end
+      
   end
 end