vapir-firefox 1.7.0.rc1

data/History.txt

@@ -0,0 +1,74 @@
+== Version 1.2.1 ==
+
+ * Fixed bug with frames in Firefox 3.
+ * Add Element#exist? (same as Element#exists?).
+
+== Version 1.2.0 ==
+
+User visible changes
+
+ * Add Button#locate from support-button.patch.
+ * Apply patch from Derek with support for winclicker.
+ * Fixed bug related to read_socket() error and changed HTML file textfields1.html so that it adheres to Firefox3 standards for firing the events.
+ 
+Internal changes
+
+ * Rename test for accuracy.
+ * Allow unit tests to be run from Eclipse.
+ * Fix internal spelling error.
+ * Move patch files to the attic.
+ * Added rake file. Updated gemspec.
+
+== Version 1.1.1 ==
+
+ * Contains couple of bug fixes and improved code related to "click()" events and page load.
+
+== Version 1.1.0 ==
+
+ * Re-factored the code for better understanding and ease of maintainability
+ * Added new exception and remove exit() call if we are unable to start firefox or connect to jssh
+ * Changed code so that only correct type of element is returned back to the user. 
+ * Changed code in iterators also so that it returns element of correct type.
+ * Added code to get text of javascript pop up.
+ * Fixed bugs: 11 (duplicate 16), 13 (duplicates 14, 15), 18, 19, 20, 21, 22, 23, 25, 26 (duplicate 27), 28, 29
+ * Added patch escaping_fix.patch for escaping quotes (") and backslash (\).
+ * Changed code to open and close Firefox more gracefully.
+ * Added code to show all objects in document or inside any element.
+ * Add methods like show_forms, show_images, show_frames, show_links etc
+ * Improved handling for Javascript pop ups. Currently only alert and confirm javascript pop up can be handled.
+ * Added support to get correct type of element like (Checkbox, Radiobutton) using XPath.
+ * Added code to start Firefox on Linux automatically
+ * Added new XPI for windows for showing up JSSh extension in Add-On’s/Extensions list
+
+== Version 1.0.2 ==
+
+This version addresses issues discovered in the prior release and is more compatible to Watir scripts, thanks to all the users for sharing their experiences with !FireWatir.
+
+ * Implemented to_s for all the elements which returns element specific attributes along with attributes that apply to all the elements.
+ * Implemented iterators for all the elements.
+ * Implemented show_all_objects.
+ * Added support to access 'button' elements. Thanks to patch send by Todd Fisher.
+ * Fixed bugs
+   * !FireWatir::Firefox.html doesn't exists, by cdc@cyphers.dns2go.com
+   * Cannot access button using value when the html is "<button type="submit">Sign In</button>" by Vikash Kumar.
+   * Firewatir fails finding link by text when html is "<a href="http://www.test.com"><span class="a">Go Test</span></a>" by Kevin Alsteens.
+   * elements_by_xpath bug by Dan Zwell. 
+   * !JavaScript redirection bug by Phil
+ * Made it more compatible with scripts written for watir.
+ * Code documentation.
+
+== Version 1.0.1 ==
+
+Along with the main endeavor of !FireWatir i.e the scripts written for IE on windows platform can be used with minimal changes on Firefox browser, !FireWatir comes with following additional features
+
+ * Platform independent, as there is nothing being used that is platform dependent. This enable !FireWatir to work on any platform with Firefox browser and the JSSh extension installed. It's been tested on Windows Server 2003 Enterprise Edition, Windows XP Professional SP2. It has not yet been tested on Linux and Mac, but it should work. The gems will be released after the testing.
+ * Script can be run on any remote machine, which means any machine connected to your network.
+ * !FireWatir is tested with ruby version 1.8.2 and 1.8.4.
+ * Tested on Firefox version 1.5, 1.5.0.4, 1.5.0.7 , 2.0 and 2.0.0.1.
+ * For handling !JavaScript popups no third party tool or dll is used, and the window need not to be a active window. Popups are handled in such a way that the action of clicking the popup buttons remains the same. But, the user experience differs in way that the popups are not visible to the users.
+ * Firefox has built in support for XPath, so it's faster to get an element by XPath on Firefox.
+ * Firefox browser is more compliant with w3c standards. [http://www.xulplanet.com/references/elemref/ Click here] for information on elements their methods and properties.
+ * It’s visibly faster when compared to Watir.
+ * Firefox will be started automatically for Windows when test script is exceuted. Currently it works only on Windows.
+ * Has support for Frames and IFrames.
+ * Added documentation, check  gems/docs.

data/LICENSE.txt

@@ -0,0 +1,42 @@
+The Vapir-Firefox library comes from a number of sources and authors, all released
+under the Modified BSD License:
+- Original contributions by Ethan:
+  Copyright: Ethan 2009-2010
+  License: Modified BSD license (full text below)
+
+- The Firewatir library from which Vapir-Firefox was forked:
+  Copyright: 
+    Copyright (c) 2004 - 2005, Paul Rogers and Bret Pettichord
+    Copyright (c) 2006 - 2007, Angrez Singh
+    Copyright (c) 2008, Bret Pettichord
+  License: Modified BSD license (full text below)
+
+
+Full text of the Modified BSD License:
+  All rights reserved.
+  
+  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 Paul Rogers, Bret Pettichord 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.

data/lib/vapir/ff.rb

@@ -0,0 +1 @@
+require 'vapir-firefox'

data/lib/vapir/firefox.rb

@@ -0,0 +1 @@
+require 'vapir-firefox'

data/lib/vapir-firefox/container.rb

@@ -0,0 +1,462 @@
+=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 'vapir-common/container'
+
+module Vapir
+  module Firefox::Container 
+    include Vapir::Container
+    
+    def extra_for_contained
+      default_extra_for_contained.merge(:jssh_socket => jssh_socket)
+    end
+
+    public
+    # Returns array of element objects that match the given XPath query.
+    #   Refer: https://developer.mozilla.org/en/DOM/document.evaluate
+    def element_objects_by_xpath(xpath)
+      elements=[]
+      result=document_object.evaluate(xpath, containing_object, nil, jssh_socket.Components.interfaces.nsIDOMXPathResult.ORDERED_NODE_ITERATOR_TYPE, nil)
+      while element=result.iterateNext
+        elements << element.store_rand_object_key(@browser_jssh_objects)
+      end
+      elements
+    end
+
+    # Returns the first element object that matches the given XPath query.
+    #   Refer: http://developer.mozilla.org/en/docs/DOM:document.evaluate
+    def element_object_by_xpath(xpath)
+      document_object.evaluate(xpath, containing_object, nil, jssh_socket.Components.interfaces.nsIDOMXPathResult.FIRST_ORDERED_NODE_TYPE, nil).singleNodeValue
+    end
+
+    # Returns the first element that matches the given xpath expression or query.
+    def element_by_xpath(xpath)
+      # TODO: move this to common; should work the same for IE 
+      base_element_class.factory(element_object_by_xpath(xpath), extra_for_contained)
+    end
+
+    # Returns the array of elements that match the given xpath query.
+    def elements_by_xpath(xpath)
+      # TODO/FIX: shouldn't this return an ElementCollection? tests seem to expect it not to, addressing it with 0-based indexing, but that seems insconsistent with everything else. 
+      # TODO: move this to common; should work the same for IE 
+      element_objects_by_xpath(xpath).map do |element_object|
+        base_element_class.factory(element_object, extra_for_contained)
+      end
+    end
+
+=begin    
+    #
+    # 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 or nil if the specified frame does not exist. 
+    #
+    def frame(how, what = nil)
+      element_by_howwhat(Firefox::Frame, 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)
+      element_by_howwhat(Firefox::Form, 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)
+      element_by_howwhat(Firefox::Table, 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.table_cell(:id, 'tb_cell')
+    #   ff.table_cell(:index, 1)
+    #
+    # Output:
+    #    TableCell Object
+    #
+    def table_cell(how, what=nil)
+      element_by_howwhat(Firefox::TableCell, 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 table_row(how, what=nil)
+      element_by_howwhat(Firefox::TableRow, 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)
+      element_by_howwhat(Firefox::Button, 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)
+      element_by_howwhat(Firefox::FileField, 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)
+      element_by_howwhat(Firefox::TextField, 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)
+      element_by_howwhat(Firefox::Hidden, 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) 
+      element_by_howwhat(Firefox::SelectList, how, what)
+    end
+    def option(how, what=nil) 
+      element_by_howwhat(Firefox::Option, how, what)
+    end
+=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
+    #
+    #   Vapir 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) 
+#      element_by_howwhat(Firefox::CheckBox, how, what, {:other_attributes => value ? {:value => value} : nil})
+#    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
+    #
+    #   Vapir 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)
+#      element_by_howwhat(Firefox::Radio, how, what, {:other_attributes => value ? {:value => value} : nil})
+#    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) 
+#      element_by_howwhat(Firefox::Link, 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)
+ #     element_by_howwhat(Firefox::Image, 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)
+#      element_by_howwhat(Firefox::Dl, 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)
+#      element_by_howwhat(Firefox::Dt, 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)
+#      element_by_howwhat(Firefox::Dd, 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
+  end
+end # module