watir-webdriver 0.6.1 → 0.6.2

data/lib/watir-webdriver/elements/file_field.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 module Watir
   class FileField < Input
+
     #
     # Set the file field to the given path
     #
     # @param [String] a path
-    #
     # @raise [Errno::ENOENT] if the file doesn't exist
     #
 
@@ -15,16 +15,18 @@ module Watir
     end
 
     #
-    # Set the file field to the given path
+    # Sets the file field to the given path
     #
-    # @param [String] a path
+    # @param [String] path
     #
+
     def value=(path)
       assert_exists
       path = path.gsub(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
       @element.send_keys path
     end
-  end
+
+  end # FileField
 
   module Container
     def file_field(*args)

data/lib/watir-webdriver/elements/generated.rb

@@ -62,13 +62,17 @@ module Watir
 
 
 
+
+
+
+
 
 
 
 
 
  class HTMLElement < Element
-   attributes(:string => [:access_key, :access_key_label, :class_name, :command_icon, :command_label, :command_type, :content_editable, :dir, :item_id, :item_value, :lang, :title], :token_list => [:class_list, :dropzone, :item_prop, :item_ref, :item_type], :bool => [:command_checked, :command_disabled, :command_hidden, :draggable, :hidden, :content_editable, :item_scope, :spellcheck, :translate], :html_element => [:context_menu], :string_map => [:dataset], :function => [:onabort, :onblur, :oncancel, :oncanplay, :oncanplaythrough, :onchange, :onclick, :onclose, :oncontextmenu, :oncuechange, :ondblclick, :ondrag, :ondragend, :ondragenter, :ondragleave, :ondragover, :ondragstart, :ondrop, :ondurationchange, :onemptied, :onended, :onerror, :onfocus, :oninput, :oninvalid, :onkeydown, :onkeypress, :onkeyup, :onload, :onloadeddata, :onloadedmetadata, :onloadstart, :onmousedown, :onmousemove, :onmouseout, :onmouseover, :onmouseup, :onmousewheel, :onpause, :onplay, :onplaying, :onprogress, :onratechange, :onreset, :onscroll, :onseeked, :onseeking, :onselect, :onshow, :onstalled, :onsubmit, :onsuspend, :ontimeupdate, :onvolumechange, :onwaiting], :properties_collection => [:properties], :style => [:style], :int => [:tab_index])
+   attributes(:string => [:access_key, :access_key_label, :command_icon, :command_label, :command_type, :content_editable, :dir, :item_id, :item_value, :lang, :title], :bool => [:command_checked, :command_disabled, :command_hidden, :draggable, :hidden, :content_editable, :item_scope, :spellcheck, :translate], :html_element => [:context_menu], :string_map => [:dataset], :token_list => [:dropzone, :item_prop, :item_ref, :item_type], :function => [:onabort, :onblur, :oncancel, :oncanplay, :oncanplaythrough, :onchange, :onclick, :onclose, :oncontextmenu, :oncuechange, :ondblclick, :ondrag, :ondragend, :ondragenter, :ondragleave, :ondragover, :ondragstart, :ondrop, :ondurationchange, :onemptied, :onended, :onerror, :onfocus, :oninput, :oninvalid, :onkeydown, :onkeypress, :onkeyup, :onload, :onloadeddata, :onloadedmetadata, :onloadstart, :onmousedown, :onmousemove, :onmouseout, :onmouseover, :onmouseup, :onmousewheel, :onpause, :onplay, :onplaying, :onprogress, :onratechange, :onreset, :onscroll, :onseeked, :onseeking, :onselect, :onshow, :onstalled, :onsubmit, :onsuspend, :ontimeupdate, :onvolumechange, :onwaiting], :properties_collection => [:properties], :style => [:style], :int => [:tab_index])
  end
  class HTMLElementCollection < ElementCollection
    def element_class
@@ -200,7 +204,7 @@ module Watir
    end
  end
  class TextArea < HTMLElement
-   attributes(:bool => [:autofocus, :disabled, :read_only, :required, :will_validate], :int => [:cols, :max_length, :rows, :selection_end, :selection_start, :text_length], :string => [:default_value, :dir_name, :name, :placeholder, :selection_direction, :type, :validation_message, :validity, :value, :wrap], :html_element => [:form], :list => [:labels])
+   attributes(:string => [:autocomplete, :default_value, :dir_name, :input_mode, :name, :placeholder, :selection_direction, :type, :validation_message, :validity, :value, :wrap], :bool => [:autofocus, :disabled, :read_only, :required, :will_validate], :int => [:cols, :max_length, :rows, :selection_end, :selection_start, :text_length], :html_element => [:form], :list => [:labels])
  end
  class TextAreaCollection < ElementCollection
    def element_class
@@ -248,7 +252,7 @@ module Watir
    end
  end
  class Input < HTMLElement
-   attributes(:string => [:accept, :alt, :autocomplete, :default_value, :dir_name, :form_action, :form_enctype, :form_method, :form_target, :max, :min, :name, :pattern, :placeholder, :selection_direction, :src, :step, :type, :validation_message, :validity, :value], :bool => [:autofocus, :checked, :default_checked, :disabled, :form_no_validate, :indeterminate, :multiple, :read_only, :required, :will_validate], :list => [:files, :labels], :html_element => [:form, :list], :int => [:height, :max_length, :selection_end, :selection_start, :size, :width], :date => [:value_as_date], :float => [:value_as_number])
+   attributes(:string => [:accept, :alt, :autocomplete, :default_value, :dir_name, :form_action, :form_enctype, :form_method, :form_target, :input_mode, :max, :min, :name, :pattern, :placeholder, :selection_direction, :src, :step, :type, :validation_message, :validity, :value], :bool => [:autofocus, :checked, :default_checked, :disabled, :form_no_validate, :indeterminate, :multiple, :read_only, :required, :will_validate], :list => [:files, :labels], :html_element => [:form, :list], :int => [:height, :max_length, :selection_end, :selection_start, :size, :width], :date => [:value_as_date], :float => [:value_as_number])
  end
  class InputCollection < ElementCollection
    def element_class
@@ -308,7 +312,7 @@ module Watir
  end
  # do nothing
  class TableHeaderCell < TableCell
-   attributes(:string => [:scope])
+   attributes(:string => [:abbr, :scope])
  end
  class TableHeaderCellCollection < ElementCollection
    def element_class
@@ -372,7 +376,7 @@ module Watir
  end
  # do nothing
  class Table < HTMLElement
-   attributes(:string => [:border], :html_element => [:caption, :t_foot, :t_head], :html_collection => [:rows, :t_bodies])
+   attributes(:html_element => [:caption, :t_foot, :t_head], :html_collection => [:rows, :t_bodies])
  end
  class TableCollection < ElementCollection
    def element_class
@@ -380,7 +384,7 @@ module Watir
    end
  end
  class Table < HTMLElement
-   attributes(:string => [:align, :bg_color, :cell_padding, :cell_spacing, :frame, :rules, :summary, :width])
+   attributes(:string => [:align, :bg_color, :border, :cell_padding, :cell_spacing, :frame, :rules, :summary, :width])
  end
  # do nothing
  class Area < HTMLElement
@@ -500,7 +504,7 @@ module Watir
  end
  # do nothing
  class Image < HTMLElement
-   attributes(:string => [:alt, :cross_origin, :src, :use_map], :bool => [:complete, :map], :int => [:height, :natural_height, :natural_width, :width])
+   attributes(:string => [:alt, :cross_origin, :src, :srcset, :use_map], :bool => [:complete, :map], :int => [:height, :natural_height, :natural_width, :width])
  end
  class ImageCollection < ElementCollection
    def element_class
@@ -1170,7 +1174,7 @@ module Watir
    # @return [DataCollection]
    #
 
-   def data(*args)
+   def datas(*args)
      DataCollection.new(self, extract_selector(args).merge(:tag_name => "data"))
    end
 

data/lib/watir-webdriver/elements/image.rb

@@ -2,6 +2,12 @@
 module Watir
   class Image < HTMLElement
 
+    #
+    # Returns true if image is loaded.
+    #
+    # @return [Boolean]
+    #
+
     def loaded?
       return false unless complete?
 
@@ -12,9 +18,9 @@ module Watir
     end
 
     #
-    # returns the image's width in pixels
+    # Returns the image's width in pixels.
     #
-    # @return [Integer] width
+    # @return [Fixnum] width
     #
 
     def width
@@ -23,9 +29,9 @@ module Watir
     end
 
     #
-    # returns the image's height in pixels
+    # Returns the image's height in pixels.
     #
-    # @return [Integer] height
+    # @return [Fixnum] width
     #
 
     def height
@@ -54,5 +60,4 @@ module Watir
      alias_method :image, :img
      alias_method :images, :imgs
   end # Container
-
 end # Watir

data/lib/watir-webdriver/elements/input.rb

@@ -4,6 +4,12 @@ module Watir
 
     alias_method :readonly?, :read_only?
 
+    #
+    # Returns true if input is enabled.
+    #
+    # @return [Boolean]
+    #
+
     def enabled?
       !disabled?
     end

data/lib/watir-webdriver/elements/option.rb

@@ -8,7 +8,10 @@ module Watir
   class Option < HTMLElement
 
     #
-    # Select this option
+    # Selects this option.
+    #
+    # @example
+    #   browser.select(:id => "foo").options.first.select
     #
 
     def select
@@ -17,7 +20,10 @@ module Watir
     end
 
     #
-    # Toggle the selected state of this option
+    # Toggles the selected state of this option.
+    #
+    # @example
+    #   browser.select(:id => "foo").options.first.toggle
     #
 
     def toggle
@@ -25,6 +31,13 @@ module Watir
       @element.click
     end
 
+    #
+    # Clears (i.e. toggles selected state) option.
+    #
+    # @example
+    #   browser.select(:id => "foo").options.first.clear
+    #
+
     def clear
       @element.click if selected?
     end
@@ -32,12 +45,25 @@ module Watir
     #
     # Is this option selected?
     #
+    # @return [Boolean]
+    #
 
     def selected?
       assert_exists
       @element.selected?
     end
 
+    #
+    # Returns the text of option.
+    #
+    # Note that the text is either one of the following respectively:
+    #   * label attribute
+    #   * text attribute
+    #   * inner element text
+    #
+    # @return [String]
+    #
+
     def text
       assert_exists
 

data/lib/watir-webdriver/elements/radio.rb

@@ -1,8 +1,9 @@
 # encoding: utf-8
 module Watir
   class Radio < Input
+
     #
-    # Select this radio button.
+    # Selects this radio button.
     #
 
     def set
@@ -15,11 +16,14 @@ module Watir
     #
     # Is this radio set?
     #
+    # @return [Boolean]
+    #
 
     def set?
       assert_exists
       @element.selected?
     end
+
   end # Radio
 
   module Container

data/lib/watir-webdriver/elements/select.rb

@@ -14,7 +14,7 @@ module Watir
     end
 
     #
-    # Clear all selected options
+    # Clears all selected options.
     #
 
     def clear
@@ -28,7 +28,7 @@ module Watir
     end
 
     #
-    # Get all the options in the select list
+    # Gets all the options in the select list
     #
     # @return [Watir::OptionCollection]
     #
@@ -41,7 +41,7 @@ module Watir
     #
     # Returns true if the select list has one or more options where text or label matches the given value.
     #
-    # @param [String, Regexp] value A value.
+    # @param [String, Regexp] str_or_rx
     # @return [Boolean]
     #
 
@@ -55,7 +55,7 @@ module Watir
     # Select the option(s) whose text or label matches the given string.
     # If this is a multi-select and several options match the value given, all will be selected.
     #
-    # @param [String, Regexp] value A value.
+    # @param [String, Regexp] str_or_rx
     # @raise [Watir::Exception::NoValueFoundException] if the value does not exist.
     # @return [String] The text of the option selected. If multiple options match, returns the first match.
     #
@@ -69,7 +69,7 @@ module Watir
     #
     # @see +select+
     #
-    # @param [String, Regexp] value A value.
+    # @param [String, Regexp] str_or_rx
     # @raise [Watir::Exception::NoValueFoundException] if the value does not exist.
     # @return [String] The option selected. If multiple options match, returns the first match
     #
@@ -79,10 +79,10 @@ module Watir
     end
 
     #
-    # Returns true if any of the selected options' text or label match the given value.
+    # Returns true if any of the selected options' text or label matches the given value.
     #
-    # @param [String, Regexp] value A value.
-    # @raise [Watir::Exception::UnknownObjectException] if the value does not exist.
+    # @param [String, Regexp] str_or_rx
+    # @raise [Watir::Exception::UnknownObjectException] if the options do not exist
     # @return [Boolean]
     #
 
@@ -111,7 +111,9 @@ module Watir
 
 
     #
-    # @return [Array<Watir::Option>] An array of Watir::Option elements that are currently selected.
+    # Returns an array of currently selected options.
+    #
+    # @return [Array<Watir::Option>]
     #
 
     def selected_options

data/lib/watir-webdriver/elements/table.rb

@@ -4,6 +4,12 @@ module Watir
   class Table < HTMLElement
     include RowContainer
 
+    #
+    # Represents table rows as hashes
+    #
+    # @return [Array<Hash>]
+    #
+
     def hashes
       all_rows   = rows.to_a
       header_row = all_rows.shift or raise Exception::Error, "no rows in table"
@@ -24,8 +30,9 @@ module Watir
     end
 
     #
-    # Get the n'th row of this table.
+    # Returns row of this table with given index.
     #
+    # @param [Fixnum] idx
     # @return Watir::TableRow
     #
 

data/lib/watir-webdriver/elements/table_cell.rb

@@ -11,7 +11,7 @@ module Watir
       value = attribute_value :colspan
       value ? Integer(value) : 1
     end
-  end
+  end # TableCell
 
   class TableCellCollection < ElementCollection
     attr_writer :locator_class
@@ -32,5 +32,5 @@ module Watir
       elements
     end
 
-  end
-end
+  end # TableCellCollection
+end # Watir

data/lib/watir-webdriver/elements/table_row.rb

@@ -22,7 +22,6 @@ module Watir
     end
   end # TableRow
 
-
   class TableRowCollection < ElementCollection
     attr_writer :locator_class
 

data/lib/watir-webdriver/elements/table_section.rb

@@ -2,8 +2,14 @@ module Watir
   class TableSection < HTMLElement
     include RowContainer
 
+    #
+    # Returns table section row with given index.
+    #
+    # @param [Fixnum] idx
+    #
+
     def [](idx)
       row(:index => idx)
     end
-  end
-end
+  end # TableSection
+end # Watir

data/lib/watir-webdriver/elements/text_area.rb

@@ -1,5 +1,5 @@
 module Watir
   class TextArea < HTMLElement
     include UserEditable
-  end
-end
+  end # TextArea
+end # Watir

data/lib/watir-webdriver/elements/text_field.rb

@@ -18,7 +18,7 @@ module Watir
       selector[:tag_name] = "input or textarea"
       selector.inspect
     end
-  end
+  end # TextField
 
   module Container
     def text_field(*args)
@@ -41,4 +41,4 @@ module Watir
       TextField
     end
   end # TextFieldCollection
-end
+end # Watir

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

@@ -22,7 +22,7 @@ module Watir
     #
 
     def alert(&blk)
-      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.alert.close)'
+      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.alert.ok)'
       execute_script "window.alert = function(msg) { window.__lastWatirAlert = msg; }"
       yield
       execute_script "return window.__lastWatirAlert"
@@ -39,7 +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)'
+      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.alert.ok)'
       execute_script "window.confirm = function(msg) { window.__lastWatirConfirm = msg; return #{!!bool} }"
       yield
       execute_script "return window.__lastWatirConfirm"
@@ -57,7 +57,7 @@ module Watir
     #
 
     def prompt(answer, &blk)
-      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.prompt.close)'
+      warn 'AlertHelper is deprecated. Use the new Alert API instead (e.g. browser.alert.ok)'
       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/extensions/nokogiri.rb

@@ -10,5 +10,5 @@ module Watir
       doc.inner_text
     end
 
-  end
-end
+  end # Browser
+end # Watir