firewatir 1.6.5 → 1.6.6.rc1

data/LICENSE

@@ -1,32 +1,32 @@
----------------------------------------------------------------------------
- Copyright (c) 2004 - 2005, Paul Rogers and Bret Pettichord
- Copyright (c) 2006 - 2007, Angrez Singh
- Copyright (c) 2008, Bret Pettichord
- 
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
- 
- 1. Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- 
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
- 
- 3. Neither the names Angrez Singh nor the names of contributors to
- this software may be used to endorse or promote products derived from this
- software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
- IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
- CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- --------------------------------------------------------------------------
+---------------------------------------------------------------------------
+ Copyright (c) 2004 - 2005, Paul Rogers and Bret Pettichord
+ Copyright (c) 2006 - 2007, Angrez Singh
+ Copyright (c) 2008, Bret Pettichord
+ 
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+ 
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+ 
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ 
+ 3. Neither the names Angrez Singh nor the names of contributors to
+ this software may be used to endorse or promote products derived from this
+ software without specific prior written permission.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+ IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ --------------------------------------------------------------------------
  (based on BSD Open Source License)

data/README.rdoc

@@ -0,0 +1,112 @@
+= FireWatir
+This is FireWatir, Web Application Testing In Ruby using Firefox browser
+
+Project Home:: http://www.watir.com
+Gem:: http://gemcutter.org/gems/firewatir
+Source Code:: http://github.com/bret/watir
+General Usage Discussions:: http://groups.google.com/group/watir-general
+Development Discussions:: http://rubyforge.org/mailman/listinfo/wtr-development
+Bugs, Issues, Roadmap:: http://jira.openqa.org/browse/WTR
+
+== DESCRIPTION
+
+Firewatir is part of Watir project, a family of open-source drivers for automating web browsers.
+For other browsers please see www.watir.com
+
+== EXAMPLES
+* http://watir.com/examples
+
+Start new Firefox browser driver
+
+  # using Watir::Browser interface
+  require 'watir'
+  Watir::Browser.default = 'firefox'
+  browser = Watir::Browser.new
+
+  # or using Firewatir library directly
+  require 'firewatir'
+  browser = FireWatir::Firefox.new
+
+Typical usage
+
+  require "firewatir"
+  # go to the page you want to test
+  ff = FireWatir::Firefox.start("http://myserver/mypage")
+
+  # enter "Angrez" into an input field named "username"
+  ff.text_field(:name, "username").set("Angrez")
+
+  # enter "Ruby Co" into input field with id "company_ID"
+  ff.text_field(:id, "company_ID").set("Ruby Co")
+
+  # click on a link that has "green" somewhere in the text that is displayed
+  # to the user, using a regular expression
+  ff.link(:text, /green/)
+
+  # click button that has a caption of "Cancel"
+  ff.button(:value, "Cancel").click
+
+== FEATURES
+
+FireWatir allows your script to read and interact with HTML objects--HTML tags and their attributes and contents.
+Types of objects that FireWatir can identify include:
+
+  Type         Description
+  ===========  ===============================================================
+  button       <tt><input></tt> tags, with the type="button" attribute
+  check_box    <tt><input></tt> tags, with the type="checkbox" attribute
+  div          <tt><div></tt> tags
+  form
+  frame
+  hidden       hidden <tt><input></tt> tags
+  image        <tt><img></tt> tags
+  label
+  link         <tt><a></tt> (anchor) tags
+  p            <tt><p></tt> (paragraph) tags
+  radio        radio buttons; <tt><input></tt> tags, with the type="radio" attribute
+  select_list  <tt><select></tt> tags, known informally as drop-down boxes
+  span         <tt><span></tt> tags
+  table        <tt><table></tt> tags
+  text_field   <tt><input></tt> tags with the type="text" attribute (a single-line
+               text field), the type="text_area" attribute (a multi-line
+               text field), and the type="password" attribute (a
+               single-line field in which the input is replaced with asterisks)
+
+In general, there are several ways to identify a specific object.  FireWatir's
+syntax is in the form (how, what), where "how" is a means of identifying
+the object, and "what" is the specific string or regular expression
+that FireWatir will seek, as shown in the examples above.  Available "how"
+options depend upon the type of object, but here are a few examples:
+
+   How           Description
+   ============  ===============================================================
+   :id           Used to find an object that has an "id=" attribute. Since each
+                 id should be unique, according to the XHTML specification,
+                 this is recommended as the most reliable method to find an
+                 object.
+   :name         Used to find an object that has a "name=" attribute.  This is
+                 useful for older versions of HTML, but "name" is deprecated
+                 in XHTML.
+   :value        Used to find a text field with a given default value, or a
+                 button with a given caption
+   :index        Used to find the nth object of the specified type on a page.
+                 For example, button(:index, 2) finds the second button.
+                 Current versions of FireWatir use 1-based indexing, but future
+                 versions will use 0-based indexing.
+   :xpath	     The xpath expression for identifying the element.
+
+Note that the XHTML specification requires that tags and their attributes be
+in lower case.  FireWatir doesn't enforce this; FireWatir will find tags and
+attributes whether they're in upper, lower, or mixed case.  This is either
+a bug or a feature.
+
+
+== INSTALL
+* http://wiki.openqa.org/display/WTR/FireWatir+Installation
+
+Firewatir gen is normally installed during watir gem installation
+however you need to install Jssh to communicate with Firefox.
+
+  [sudo] gem install firewatir
+
+

data/VERSION

@@ -0,0 +1 @@
+1.6.6.rc1

data/lib/firewatir.rb

@@ -1,40 +1,41 @@
-$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'socket'
-require 'active_support'
-
-require 'firewatir/exceptions'
-require 'firewatir/jssh_socket'
-require 'firewatir/container'
-require "firewatir/element"
-require "firewatir/document"
-
-require "firewatir/elements/form"
-require "firewatir/elements/frame"
-require "firewatir/elements/non_control_element"
-require "firewatir/elements/non_control_elements"
-require "firewatir/elements/table"
-require "firewatir/elements/table_row"
-require "firewatir/elements/table_cell"
-require "firewatir/elements/image"
-require "firewatir/elements/link"
-require "firewatir/elements/input_element"
-require "firewatir/elements/select_list"
-require "firewatir/elements/option"
-require "firewatir/elements/button"
-require "firewatir/elements/text_field"
-require "firewatir/elements/hidden"
-require "firewatir/elements/file_field"
-require "firewatir/elements/radio_check_common"
-require "firewatir/element_collections"
-
-require 'watir/matches'
-require 'firewatir/firefox'
-require 'firewatir/version'
-require 'watir'
-
-
-
-# this only has an effect if firewatir is required before anyone invokes 
-# Browser.new. Thus it has no effect when Browser.new itself autoloads this library.
-Watir::Browser.default = 'firefox'
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'socket'
+gem 'activesupport', '=2.3.9'
+require 'active_support'
+
+require 'firewatir/exceptions'
+require 'firewatir/jssh_socket'
+require 'firewatir/container'
+require "firewatir/element"
+require "firewatir/document"
+
+require "firewatir/elements/form"
+require "firewatir/elements/frame"
+require "firewatir/elements/non_control_element"
+require "firewatir/elements/non_control_elements"
+require "firewatir/elements/table"
+require "firewatir/elements/table_row"
+require "firewatir/elements/table_cell"
+require "firewatir/elements/image"
+require "firewatir/elements/link"
+require "firewatir/elements/input_element"
+require "firewatir/elements/select_list"
+require "firewatir/elements/option"
+require "firewatir/elements/button"
+require "firewatir/elements/text_field"
+require "firewatir/elements/hidden"
+require "firewatir/elements/file_field"
+require "firewatir/elements/radio_check_common"
+require "firewatir/element_collections"
+
+require 'watir/matches'
+require 'firewatir/firefox'
+require 'watir'
+
+
+#--
+# this only has an effect if firewatir is required before anyone invokes 
+# Browser.new. Thus it has no effect when Browser.new itself autoloads this library.
+#++
+Watir::Browser.default = 'firefox'

data/lib/firewatir/container.rb

@@ -1,491 +1,491 @@
-=begin
-    #
-    # This module contains the factory methods that are used to access most html objects
-    #
-    # For example, to access a button on a web page that has the following html
-    #  <input type = button name= 'b1' value='Click Me' onClick='javascript:doSomething()'>
-    #
-    # the following Firewatir code could be used
-    #
-    #  ff.button(:name, 'b1').click
-    #
-    # or
-    #
-    #  ff.button(:value, 'Click Me').to_s
-    # 
-    # One can use any attribute to uniquely identify an element including the user defined attributes
-    # that is rendered on the HTML screen. Though, Attribute used to access an element depends on the type of element,
-    # attributes used frequently to address an element are listed below
-    #
-    #    :index      - find the item using the index in the container ( a container can be a document, 
-    #    		a TableCell, a Span, a Div or a P)
-    #                  index is 1 based
-    #    :name       - find the item using the name attribute
-    #    :id         - find the item using the id attribute
-    #    :value      - find the item using the value attribute
-    #    :caption    - same as value
-    #    :xpath      - finds the item using xpath query
-    #
-    # Typical Usage
-    #
-    #    ff.button(:id,    'b_1')                       # access the button with an ID of b_1
-    #    ff.button(:name,  'verify_data')               # access the button with a name of verify_data
-    #    ff.button(:value, 'Login')                     # access the button with a value (the text displayed on the button) of Login
-    #    ff.button(:caption, 'Login')                   # same as above
-    #    ff.button(:value, /Log/)                       # access the button that has text matching /Log/
-    #    ff.button(:index, 2)                           # access the second button on the page ( 1 based, so the first button is accessed with :index,1)
-    #
-=end
-
-require 'firewatir/exceptions'
-
-module FireWatir
-  module Container 
-    include FireWatir
-    include Watir::Exception
-    include JsshSocket
-    
-    # IP Address of the machine where the script is to be executed. Default to localhost.
-    MACHINE_IP = "127.0.0.1"
-        
-    # The default color for highlighting objects as they are accessed.
-    DEFAULT_HIGHLIGHT_COLOR = "yellow"
-    
-    public
-    #
-    # Description:
-    #    Used to access a frame element. Usually an <frame> or <iframe> HTML tag.
-    #
-    # Input:
-    #   - how - The attribute used to identify the framet.
-    #   - what - The value of that attribute. 
-    #   If only one parameter is supplied, "how" is by default taken as name and the 
-    #   parameter supplied becomes the value of the name attribute.
-    #
-    # Typical usage:
-    #
-    #   ff.frame(:index, 1) 
-    #   ff.frame(:name , 'main_frame')
-    #   ff.frame('main_frame')        # in this case, just a name is supplied.
-    #
-    # Output:
-    #   Frame object.
-    #
-    def frame(how, what = nil)
-      locate if respond_to?(:locate)
-      if(what == nil)
-        what = how
-        how = :name
-      end
-      Frame.new(self, how, what)
-    end
-    
-    #
-    # Description:
-    #   Used to access a form element. Usually an <form> HTML tag.
-    #
-    # Input:
-    #   - how - The attribute used to identify the form.
-    #   - what - The value of that attribute. 
-    #   If only one parameter is supplied, "how" is by default taken as name and the 
-    #   parameter supplied becomes the value of the name attribute.
-    #
-    # Typical usage:
-    #
-    #   ff.form(:index, 1) 
-    #   ff.form(:name , 'main_form')
-    #   ff.form('main_form')        # in this case, just a name is supplied.
-    #
-    # Output:
-    #   Form object.
-    #
-    def form(how, what=nil)   
-      locate if respond_to?(:locate)
-      if(what == nil)
-        what = how
-        how = :name
-      end    
-      Form.new(self, how, what)
-    end
-    
-    #
-    # Description:
-    #   Used to access a table. Usually an <table> HTML tag. 
-    #
-    # Input:
-    #   - how - The attribute used to identify the table.
-    #   - what - The value of that attribute. 
-    #
-    # Typical usage:
-    #
-    #   ff.table(:index, 1) #index starts from 1.
-    #   ff.table(:id, 'main_table')
-    #
-    # Output:
-    #   Table object.
-    #
-    def table(how, what=nil)
-      locate if respond_to?(:locate)
-      Table.new(self, how, what)
-    end
-    
-    #
-    # Description:
-    #   Used to access a table cell. Usually an <td> HTML tag. 
-    #
-    # Input:
-    #   - how - The attribute used to identify the cell.
-    #   - what - The value of that attribute. 
-    # 
-    # Typical Usage:
-    #   ff.cell(:id, 'tb_cell')
-    #   ff.cell(:index, 1)
-    #
-    # Output:
-    #    TableCell Object
-    #
-    def cell(how, what=nil)
-      locate if respond_to?(:locate)
-      TableCell.new(self, how, what)
-    end
-    
-    # 
-    # Description:
-    #   Used to access a table row. Usually an <tr> HTML tag. 
-    # 
-    # Input:
-    #   - how - The attribute used to identify the row.
-    #   - what - The value of that attribute. 
-    #
-    # Typical Usage:
-    #   ff.row(:id, 'tb_row')
-    #   ff.row(:index, 1)
-    #
-    # Output: 
-    #   TableRow object
-    #
-    def row(how, what=nil)
-      locate if respond_to?(:locate)
-      TableRow.new(self, how, what)
-    end
-    
-    # 
-    # Description:
-    #   Used to access a button element. Usually an <input type = "button"> HTML tag.
-    # 
-    # Input:
-    #   - how - The attribute used to identify the row.
-    #   - what - The value of that attribute. 
-    # 
-    # Typical Usage:
-    #    ff.button(:id,    'b_1')                       # access the button with an ID of b_1
-    #    ff.button(:name,  'verify_data')               # access the button with a name of verify_data
-    #
-    #    if only a single parameter is supplied,  then :value is used as 'how' and parameter supplied is used as what. 
-    #
-    #    ff.button('Click Me')                          # access the button with a value of Click Me
-    #
-    # Output:
-    #   Button element.
-    #
-    def button(how, what=nil)
-      locate if respond_to?(:locate)
-      if what.nil? && String === how
-        what = how
-        how = :value
-      end    
-      Button.new(self, how, what)
-    end    
-    
-    # 
-    # Description:
-    #   Used for accessing a file field. Usually an <input type = file> HTML tag.  
-    #  
-    # Input:
-    #   - how - Attribute used to identify the file field element
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #    ff.file_field(:id,   'up_1')                     # access the file upload fff.d with an ID of up_1
-    #    ff.file_field(:name, 'upload')                   # access the file upload fff.d with a name of upload
-    #
-    # Output:
-    #   FileField object
-    #
-    def file_field(how, what = nil)
-      locate if respond_to?(:locate)
-      FileField.new(self, how, what)
-    end    
-    
-    #
-    # Description:
-    #   Used for accessing a text field. Usually an <input type = text> HTML tag. or a text area - a  <textarea> tag
-    #
-    # Input:
-    #   - how - Attribute used to identify the text field element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #    ff.text_field(:id,   'user_name')                 # access the text field with an ID of user_name
-    #    ff.text_field(:name, 'address')                   # access the text field with a name of address
-    #
-    # Output:
-    #   TextField object.
-    #
-    def text_field(how, what = nil)
-      locate if respond_to?(:locate)
-      TextField.new(self, how, what)
-    end    
-    
-    # 
-    # Description:
-    #   Used to access hidden field element. Usually an <input type = hidden> HTML tag
-    #
-    # Input:
-    #   - how - Attribute used to identify the hidden element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #    ff.hidden(:id,   'user_name')                 # access the hidden element with an ID of user_name
-    #    ff.hidden(:name, 'address')                   # access the hidden element with a name of address
-    #
-    # Output:
-    #   Hidden object.
-    #
-    def hidden(how, what=nil)
-      locate if respond_to?(:locate)
-      return Hidden.new(self, how, what)
-    end
-    
-    #
-    # Description:
-    #   Used to access select list element. Usually an <select> HTML tag.
-    #
-    # Input:
-    #   - how - Attribute used to identify the select element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #    ff.select_list(:id,   'user_name')                 # access the select list with an ID of user_name
-    #    ff.select_list(:name, 'address')                   # access the select list with a name of address
-    #
-    # Output:
-    #   Select List object.
-    #
-    def select_list(how, what=nil) 
-      locate if respond_to?(:locate)
-      return SelectList.new(self, how, what)
-    end
-    
-    #
-    # Description:
-    #   Used to access checkbox element. Usually an <input type = checkbox> HTML tag.
-    #
-    # Input:
-    #   - how - Attribute used to identify the check box element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #   ff.checkbox(:id,   'user_name')                 # access the checkbox element with an ID of user_name
-    #   ff.checkbox(:name, 'address')                   # access the checkbox element with a name of address
-    #   In many instances, checkboxes on an html page have the same name, but are identified by different values. An example is shown next.
-    #
-    #   <input type = checkbox name = email_frequency value = 'daily' > Daily Email
-    #   <input type = checkbox name = email_frequency value = 'Weekly'> Weekly Email
-    #   <input type = checkbox name = email_frequency value = 'monthly'>Monthly Email
-    #
-    #   FireWatir can access these using the following:
-    #
-    #   ff.checkbox(:id, 'day_to_send' , 'monday' )         # access the check box with an id of day_to_send and a value of monday
-    #   ff.checkbox(:name ,'email_frequency', 'weekly')     # access the check box with a name of email_frequency and a value of 'weekly'
-    #
-    # Output:
-    #   Checkbox object.
-    #
-    def checkbox(how, what=nil, value = nil) 
-      locate if respond_to?(:locate)
-      return CheckBox.new(self, how, what, value) 
-    end
-    
-    #
-    # Description:
-    #   Used to access radio button element. Usually an <input type = radio> HTML tag.
-    #
-    # Input:
-    #   - how - Attribute used to identify the radio button element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #   ff.radio(:id,   'user_name')                 # access the radio button element with an ID of user_name
-    #   ff.radio(:name, 'address')                   # access the radio button element with a name of address
-    #   In many instances, radio buttons on an html page have the same name, but are identified by different values. An example is shown next.
-    #
-    #   <input type = radio name = email_frequency value = 'daily' > Daily Email
-    #   <input type = radio name = email_frequency value = 'Weekly'> Weekly Email
-    #   <input type = radio name = email_frequency value = 'monthly'>Monthly Email
-    #
-    #   FireWatir can access these using the following:
-    #
-    #   ff.radio(:id, 'day_to_send' , 'monday' )         # access the radio button with an id of day_to_send and a value of monday
-    #   ff.radio(:name ,'email_frequency', 'weekly')     # access the radio button with a name of email_frequency and a value of 'weekly'
-    #
-    # Output:
-    #   Radio button object.
-    #
-    def radio(how, what=nil, value = nil) 
-      locate if respond_to?(:locate)
-      return Radio.new(self, how, what, value) 
-    end
-    
-    #
-    # Description:
-    #   Used to access link element. Usually an <a> HTML tag.
-    #
-    # Input:
-    #   - how - Attribute used to identify the link element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #    ff.link(:id,   'user_name')                 # access the link element with an ID of user_name
-    #    ff.link(:name, 'address')                   # access the link element with a name of address
-    #
-    # Output:
-    #   Link object.
-    #
-    def link(how, what=nil) 
-      locate if respond_to?(:locate)
-      return Link.new(self, how, what)
-    end
-    
-    #
-    # Description:
-    #   Used to access image element. Usually an <img> HTML tag.
-    #
-    # Input:
-    #   - how - Attribute used to identify the image element.
-    #   - what - Value of that attribute. 
-    #
-    # Typical Usage:
-    #
-    #    ff.image(:id,   'user_name')                 # access the image element with an ID of user_name
-    #    ff.image(:name, 'address')                   # access the image element with a name of address
-    #
-    # Output:
-    #   Image object.
-    #
-    def image(how, what = nil)
-      locate if respond_to?(:locate)
-      Image.new(self, how, what)
-    end    
-    
-    
-    #
-    # Description:
-    #   Used to access a definition list element - a <dl> HTML tag.
-    #
-    # Input:
-    #   - how - Attribute used to identify the definition list element.
-    #   - what - Value of that attribute.
-    #
-    # Typical Usage:
-    #
-    #    ff.dl(:id, 'user_name')                    # access the dl element with an ID of user_name
-    #    ff.dl(:title, 'address')                   # access the dl element with a title of address
-    #
-    # Returns:
-    #   Dl object.
-    #
-    def dl(how, what = nil)
-      locate if respond_to?(:locate)
-      Dl.new(self, how, what)
-    end
-
-    #
-    # Description:
-    #   Used to access a definition term element - a <dt> HTML tag.
-    #
-    # Input:
-    #   - how  - Attribute used to identify the image element.
-    #   - what - Value of that attribute.
-    #
-    # Typical Usage:
-    #
-    #    ff.dt(:id, 'user_name')                    # access the dt element with an ID of user_name
-    #    ff.dt(:title, 'address')                   # access the dt element with a title of address
-    #
-    # Returns:
-    #   Dt object.
-    #
-    def dt(how, what = nil)
-      locate if respond_to?(:locate)
-      Dt.new(self, how, what)
-    end
-
-    #
-    # Description:
-    #   Used to access a definition description element - a <dd> HTML tag.
-    #
-    # Input:
-    #   - how  - Attribute used to identify the image element.
-    #   - what - Value of that attribute.
-    #
-    # Typical Usage:
-    #
-    #    ff.dd(:id, 'user_name')                    # access the dd element with an ID of user_name
-    #    ff.dd(:title, 'address')                   # access the dd element with a title of address
-    #
-    # Returns:
-    #   Dd object.
-    #
-    def dd(how, what = nil)
-      locate if respond_to?(:locate)
-      Dd.new(self, how, what)
-    end
-
-    # Description:
-    #	Searching for Page Elements. Not for external consumption.
-    #        
-    # def ole_inner_elements
-    # return document.body.all 
-    # end
-    # private :ole_inner_elements
-    
-    
-    # 
-    # Description:
-    #   This method shows the available objects on the current page.
-    #   This is usually only used for debugging or writing new test scripts.
-    #   This is a nice feature to help find out what HTML objects are on a page
-    #   when developing a test case using FireWatir.
-    #
-    # Typical Usage:
-    #   ff.show_all_objects
-    #
-    # Output:
-    #   Prints all the available elements on the page.
-    #
-    def show_all_objects
-      puts "-----------Objects in the current context-------------" 
-      locate if respond_to?(:locate)
-      elements = Document.new(self).all
-      puts elements.length
-      elements.each  do |n|
-        puts n.tagName
-        puts n.to_s
-        puts "------------------------------------------" 
-      end
-      puts "Total number of objects in the current context :	#{elements.length}"
-      return elements
-      # Test the index access. 
-      # puts doc[35].to_s
-    end
-    
-  end
-end # module 
-
+=begin
+    #
+    # This module contains the factory methods that are used to access most html objects
+    #
+    # For example, to access a button on a web page that has the following html
+    #  <input type = button name= 'b1' value='Click Me' onClick='javascript:doSomething()'>
+    #
+    # the following Firewatir code could be used
+    #
+    #  ff.button(:name, 'b1').click
+    #
+    # or
+    #
+    #  ff.button(:value, 'Click Me').to_s
+    # 
+    # One can use any attribute to uniquely identify an element including the user defined attributes
+    # that is rendered on the HTML screen. Though, Attribute used to access an element depends on the type of element,
+    # attributes used frequently to address an element are listed below
+    #
+    #    :index      - find the item using the index in the container ( a container can be a document, 
+    #    		a TableCell, a Span, a Div or a P)
+    #                  index is 1 based
+    #    :name       - find the item using the name attribute
+    #    :id         - find the item using the id attribute
+    #    :value      - find the item using the value attribute
+    #    :caption    - same as value
+    #    :xpath      - finds the item using xpath query
+    #
+    # Typical Usage
+    #
+    #    ff.button(:id,    'b_1')                       # access the button with an ID of b_1
+    #    ff.button(:name,  'verify_data')               # access the button with a name of verify_data
+    #    ff.button(:value, 'Login')                     # access the button with a value (the text displayed on the button) of Login
+    #    ff.button(:caption, 'Login')                   # same as above
+    #    ff.button(:value, /Log/)                       # access the button that has text matching /Log/
+    #    ff.button(:index, 2)                           # access the second button on the page ( 1 based, so the first button is accessed with :index,1)
+    #
+=end
+
+require 'firewatir/exceptions'
+
+module FireWatir
+  module Container 
+    include FireWatir
+    include Watir::Exception
+    include JsshSocket
+    
+    # IP Address of the machine where the script is to be executed. Default to localhost.
+    MACHINE_IP = "127.0.0.1"
+        
+    # The default color for highlighting objects as they are accessed.
+    DEFAULT_HIGHLIGHT_COLOR = "yellow"
+    
+    public
+    #
+    # Description:
+    #    Used to access a frame element. Usually an <frame> or <iframe> HTML tag.
+    #
+    # Input:
+    #   - how - The attribute used to identify the framet.
+    #   - what - The value of that attribute. 
+    #   If only one parameter is supplied, "how" is by default taken as name and the 
+    #   parameter supplied becomes the value of the name attribute.
+    #
+    # Typical usage:
+    #
+    #   ff.frame(:index, 1) 
+    #   ff.frame(:name , 'main_frame')
+    #   ff.frame('main_frame')        # in this case, just a name is supplied.
+    #
+    # Output:
+    #   Frame object.
+    #
+    def frame(how, what = nil)
+      locate if respond_to?(:locate)
+      if(what == nil)
+        what = how
+        how = :name
+      end
+      Frame.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access a form element. Usually an <form> HTML tag.
+    #
+    # Input:
+    #   - how - The attribute used to identify the form.
+    #   - what - The value of that attribute. 
+    #   If only one parameter is supplied, "how" is by default taken as name and the 
+    #   parameter supplied becomes the value of the name attribute.
+    #
+    # Typical usage:
+    #
+    #   ff.form(:index, 1) 
+    #   ff.form(:name , 'main_form')
+    #   ff.form('main_form')        # in this case, just a name is supplied.
+    #
+    # Output:
+    #   Form object.
+    #
+    def form(how, what=nil)   
+      locate if respond_to?(:locate)
+      if(what == nil)
+        what = how
+        how = :name
+      end    
+      Form.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access a table. Usually an <table> HTML tag. 
+    #
+    # Input:
+    #   - how - The attribute used to identify the table.
+    #   - what - The value of that attribute. 
+    #
+    # Typical usage:
+    #
+    #   ff.table(:index, 1) #index starts from 1.
+    #   ff.table(:id, 'main_table')
+    #
+    # Output:
+    #   Table object.
+    #
+    def table(how, what=nil)
+      locate if respond_to?(:locate)
+      Table.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access a table cell. Usually an <td> HTML tag. 
+    #
+    # Input:
+    #   - how - The attribute used to identify the cell.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage:
+    #   ff.cell(:id, 'tb_cell')
+    #   ff.cell(:index, 1)
+    #
+    # Output:
+    #    TableCell Object
+    #
+    def cell(how, what=nil)
+      locate if respond_to?(:locate)
+      TableCell.new(self, how, what)
+    end
+    
+    # 
+    # Description:
+    #   Used to access a table row. Usually an <tr> HTML tag. 
+    # 
+    # Input:
+    #   - how - The attribute used to identify the row.
+    #   - what - The value of that attribute. 
+    #
+    # Typical Usage:
+    #   ff.row(:id, 'tb_row')
+    #   ff.row(:index, 1)
+    #
+    # Output: 
+    #   TableRow object
+    #
+    def row(how, what=nil)
+      locate if respond_to?(:locate)
+      TableRow.new(self, how, what)
+    end
+    
+    # 
+    # Description:
+    #   Used to access a button element. Usually an <input type = "button"> HTML tag.
+    # 
+    # Input:
+    #   - how - The attribute used to identify the row.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage:
+    #    ff.button(:id,    'b_1')                       # access the button with an ID of b_1
+    #    ff.button(:name,  'verify_data')               # access the button with a name of verify_data
+    #
+    #    if only a single parameter is supplied,  then :value is used as 'how' and parameter supplied is used as what. 
+    #
+    #    ff.button('Click Me')                          # access the button with a value of Click Me
+    #
+    # Output:
+    #   Button element.
+    #
+    def button(how, what=nil)
+      locate if respond_to?(:locate)
+      if what.nil? && String === how
+        what = how
+        how = :value
+      end    
+      Button.new(self, how, what)
+    end    
+    
+    # 
+    # Description:
+    #   Used for accessing a file field. Usually an <input type = file> HTML tag.  
+    #  
+    # Input:
+    #   - how - Attribute used to identify the file field element
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #    ff.file_field(:id,   'up_1')                     # access the file upload fff.d with an ID of up_1
+    #    ff.file_field(:name, 'upload')                   # access the file upload fff.d with a name of upload
+    #
+    # Output:
+    #   FileField object
+    #
+    def file_field(how, what = nil)
+      locate if respond_to?(:locate)
+      FileField.new(self, how, what)
+    end    
+    
+    #
+    # Description:
+    #   Used for accessing a text field. Usually an <input type = text> HTML tag. or a text area - a  <textarea> tag
+    #
+    # Input:
+    #   - how - Attribute used to identify the text field element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.text_field(:id,   'user_name')                 # access the text field with an ID of user_name
+    #    ff.text_field(:name, 'address')                   # access the text field with a name of address
+    #
+    # Output:
+    #   TextField object.
+    #
+    def text_field(how, what = nil)
+      locate if respond_to?(:locate)
+      TextField.new(self, how, what)
+    end    
+    
+    # 
+    # Description:
+    #   Used to access hidden field element. Usually an <input type = hidden> HTML tag
+    #
+    # Input:
+    #   - how - Attribute used to identify the hidden element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.hidden(:id,   'user_name')                 # access the hidden element with an ID of user_name
+    #    ff.hidden(:name, 'address')                   # access the hidden element with a name of address
+    #
+    # Output:
+    #   Hidden object.
+    #
+    def hidden(how, what=nil)
+      locate if respond_to?(:locate)
+      return Hidden.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access select list element. Usually an <select> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the select element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.select_list(:id,   'user_name')                 # access the select list with an ID of user_name
+    #    ff.select_list(:name, 'address')                   # access the select list with a name of address
+    #
+    # Output:
+    #   Select List object.
+    #
+    def select_list(how, what=nil) 
+      locate if respond_to?(:locate)
+      return SelectList.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access checkbox element. Usually an <input type = checkbox> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the check box element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #   ff.checkbox(:id,   'user_name')                 # access the checkbox element with an ID of user_name
+    #   ff.checkbox(:name, 'address')                   # access the checkbox element with a name of address
+    #   In many instances, checkboxes on an html page have the same name, but are identified by different values. An example is shown next.
+    #
+    #   <input type = checkbox name = email_frequency value = 'daily' > Daily Email
+    #   <input type = checkbox name = email_frequency value = 'Weekly'> Weekly Email
+    #   <input type = checkbox name = email_frequency value = 'monthly'>Monthly Email
+    #
+    #   FireWatir can access these using the following:
+    #
+    #   ff.checkbox(:id, 'day_to_send' , 'monday' )         # access the check box with an id of day_to_send and a value of monday
+    #   ff.checkbox(:name ,'email_frequency', 'weekly')     # access the check box with a name of email_frequency and a value of 'weekly'
+    #
+    # Output:
+    #   Checkbox object.
+    #
+    def checkbox(how, what=nil, value = nil) 
+      locate if respond_to?(:locate)
+      return CheckBox.new(self, how, what, value) 
+    end
+    
+    #
+    # Description:
+    #   Used to access radio button element. Usually an <input type = radio> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the radio button element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #   ff.radio(:id,   'user_name')                 # access the radio button element with an ID of user_name
+    #   ff.radio(:name, 'address')                   # access the radio button element with a name of address
+    #   In many instances, radio buttons on an html page have the same name, but are identified by different values. An example is shown next.
+    #
+    #   <input type = radio name = email_frequency value = 'daily' > Daily Email
+    #   <input type = radio name = email_frequency value = 'Weekly'> Weekly Email
+    #   <input type = radio name = email_frequency value = 'monthly'>Monthly Email
+    #
+    #   FireWatir can access these using the following:
+    #
+    #   ff.radio(:id, 'day_to_send' , 'monday' )         # access the radio button with an id of day_to_send and a value of monday
+    #   ff.radio(:name ,'email_frequency', 'weekly')     # access the radio button with a name of email_frequency and a value of 'weekly'
+    #
+    # Output:
+    #   Radio button object.
+    #
+    def radio(how, what=nil, value = nil) 
+      locate if respond_to?(:locate)
+      return Radio.new(self, how, what, value) 
+    end
+    
+    #
+    # Description:
+    #   Used to access link element. Usually an <a> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the link element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.link(:id,   'user_name')                 # access the link element with an ID of user_name
+    #    ff.link(:name, 'address')                   # access the link element with a name of address
+    #
+    # Output:
+    #   Link object.
+    #
+    def link(how, what=nil) 
+      locate if respond_to?(:locate)
+      return Link.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access image element. Usually an <img> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the image element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.image(:id,   'user_name')                 # access the image element with an ID of user_name
+    #    ff.image(:name, 'address')                   # access the image element with a name of address
+    #
+    # Output:
+    #   Image object.
+    #
+    def image(how, what = nil)
+      locate if respond_to?(:locate)
+      Image.new(self, how, what)
+    end    
+    
+    
+    #
+    # Description:
+    #   Used to access a definition list element - a <dl> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the definition list element.
+    #   - what - Value of that attribute.
+    #
+    # Typical Usage:
+    #
+    #    ff.dl(:id, 'user_name')                    # access the dl element with an ID of user_name
+    #    ff.dl(:title, 'address')                   # access the dl element with a title of address
+    #
+    # Returns:
+    #   Dl object.
+    #
+    def dl(how, what = nil)
+      locate if respond_to?(:locate)
+      Dl.new(self, how, what)
+    end
+
+    #
+    # Description:
+    #   Used to access a definition term element - a <dt> HTML tag.
+    #
+    # Input:
+    #   - how  - Attribute used to identify the image element.
+    #   - what - Value of that attribute.
+    #
+    # Typical Usage:
+    #
+    #    ff.dt(:id, 'user_name')                    # access the dt element with an ID of user_name
+    #    ff.dt(:title, 'address')                   # access the dt element with a title of address
+    #
+    # Returns:
+    #   Dt object.
+    #
+    def dt(how, what = nil)
+      locate if respond_to?(:locate)
+      Dt.new(self, how, what)
+    end
+
+    #
+    # Description:
+    #   Used to access a definition description element - a <dd> HTML tag.
+    #
+    # Input:
+    #   - how  - Attribute used to identify the image element.
+    #   - what - Value of that attribute.
+    #
+    # Typical Usage:
+    #
+    #    ff.dd(:id, 'user_name')                    # access the dd element with an ID of user_name
+    #    ff.dd(:title, 'address')                   # access the dd element with a title of address
+    #
+    # Returns:
+    #   Dd object.
+    #
+    def dd(how, what = nil)
+      locate if respond_to?(:locate)
+      Dd.new(self, how, what)
+    end
+
+    # Description:
+    #	Searching for Page Elements. Not for external consumption.
+    #        
+    # def ole_inner_elements
+    # return document.body.all 
+    # end
+    # private :ole_inner_elements
+    
+    
+    # 
+    # Description:
+    #   This method shows the available objects on the current page.
+    #   This is usually only used for debugging or writing new test scripts.
+    #   This is a nice feature to help find out what HTML objects are on a page
+    #   when developing a test case using FireWatir.
+    #
+    # Typical Usage:
+    #   ff.show_all_objects
+    #
+    # Output:
+    #   Prints all the available elements on the page.
+    #
+    def show_all_objects
+      puts "-----------Objects in the current context-------------" 
+      locate if respond_to?(:locate)
+      elements = Document.new(self).all
+      puts elements.length
+      elements.each  do |n|
+        puts n.tagName
+        puts n.to_s
+        puts "------------------------------------------" 
+      end
+      puts "Total number of objects in the current context :	#{elements.length}"
+      return elements
+      # Test the index access. 
+      # puts doc[35].to_s
+    end
+    
+  end
+end # module 
+