page-object 0.2 → 0.2.1

data/lib/page-object/platforms/selenium/select_list.rb

@@ -0,0 +1,32 @@
+module PageObject
+  module Platforms
+    module Selenium
+      module SelectList
+
+        #
+        # Return the PageObject::Elements::Option for the index provided.  Index
+        # is zero based.
+        #
+        # @return [PageObject::Elements::Option]
+        #
+        def [](idx)
+          options[idx]
+        end
+
+        #
+        # Return an array of Options contained in the select lit.
+        #
+        # @return [array of PageObject::Elements::Option]
+        def options
+          options = @element.find_elements(:xpath, child_xpath)
+          elements = []
+          options.each do |opt|
+            elements << Object::PageObject::Elements::Option.new(opt, :platform => :selenium)
+          end
+          elements
+        end
+      end
+    end
+  end
+
+end

data/lib/page-object/platforms/selenium/table.rb

@@ -0,0 +1,40 @@
+module PageObject
+  module Platforms
+    module Selenium
+      module Table
+
+        #
+        # Return the PageObject::Elements::TableRow for the index provided.  Index
+        # is zero based.
+        #
+        # @return [PageObject::Elements::TableRow]
+        #
+        def [](idx)
+          eles = table_rows
+          Object::PageObject::Elements::TableRow.new(eles[idx], :platform => :selenium)
+        end
+
+        #
+        # Returns the number of rows in the table.
+        #
+        def rows
+          table_rows.size
+        end
+
+        #
+        # override PageObject::Platforms::SeleniumElement because exists? is not
+        # available on a table element in Selenium.
+        #
+        def exists?
+          raise "exists? not available on table element"
+        end
+
+        private
+
+        def table_rows
+          @element.find_elements(:xpath, child_xpath)
+        end
+      end
+    end
+  end
+end

data/lib/page-object/platforms/selenium/table_row.rb

@@ -0,0 +1,32 @@
+module PageObject
+  module Platforms
+    module Selenium
+
+      module TableRow
+
+        #
+        # Return the PageObject::Elements::TableCell for the index provided.  Index
+        # is zero based.
+        #
+        def [](idx)
+          els = table_cells
+          Object::PageObject::Elements::TableCell.new(els[idx], :platform => :selenium)
+        end
+
+        #
+        # Returns the number of columns in the table.
+        #
+        def columns
+          table_cells.size
+        end
+
+        private
+
+        def table_cells
+          element.find_elements(:xpath, child_xpath)
+        end
+
+      end
+    end
+  end
+end

data/lib/page-object/platforms/selenium/unordered_list.rb

@@ -0,0 +1,33 @@
+module PageObject
+  module Platforms
+    module Selenium
+      module UnorderedList
+
+        #
+        # Return the PageObject::Elements::ListItem for the index provided.  Index
+        # is zero based.
+        #
+        # @return [PageObject::Elements::ListItem]
+        #
+        def [](idx)
+          eles = list_items
+          Object::PageObject::Elements::ListItem.new(eles[idx], :platform => :selenium)
+        end
+
+        #
+        # Return the number of items contained in the unordered list
+        #
+        def items
+          list_items.size
+        end
+
+        private
+
+        def list_items
+          element.find_elements(:xpath, child_xpath)
+        end
+
+      end
+    end
+  end
+end

data/lib/page-object/platforms/watir.rb

@@ -0,0 +1,16 @@
+module PageObject
+  module Platforms
+    module Watir
+      def self.create_page_object(browser)
+        require 'page-object/platforms/watir/page_object'
+        PageObject::WatirPageObject.new(browser)
+      end
+
+      def self.is_for?(browser)
+        browser.is_a?(Object::Watir::Browser)
+      end
+    end
+  end
+end
+
+PageObject::Platforms.register(:watir, PageObject::Platforms::Watir)

data/lib/page-object/platforms/watir/element.rb

@@ -0,0 +1,154 @@
+module PageObject
+  module Platforms
+    #
+    # Watir implementation of the common functionality found across all elements
+    #
+    module Watir
+      module Element
+
+        #
+        # return true if an element is visible
+        #
+        def visible?
+          @element.present?
+        end
+
+        #
+        # return true if an element exists
+        #
+        def exists?
+          @element.exists?
+        end
+
+        #
+        # Get the text for the element
+        #
+        # @return [String]
+        #
+        def text
+          @element.text
+        end
+
+        #
+        # Get the value of this element
+        #
+        # @return [String]
+        #
+        def value
+          @element.value
+        end
+
+        #
+        # compare this element to another to determine if they are equal
+        #
+        def ==(other)
+          @element == other.element
+        end
+
+        #
+        # Get the tag name of this element
+        #
+        # @return [String]
+        #
+        def tag_name
+          @element.tag_name
+        end
+
+        #
+        # Get the value of a the given attribute of the element. Will return the current value, even if
+        # this has been modified after the page has been loaded. More exactly, this method will return
+        # the value of the given attribute, unless that attribute is not present, in which case the
+        # value of the property with the same name is returned. If neither value is set, nil is
+        # returned. The "style" attribute is converted as best can be to a text representation with a
+        # trailing semi-colon. The following are deemed to be "boolean" attributes, and will
+        # return either "true" or "false":
+        #
+        # async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked,
+        # defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate,
+        # iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate,
+        # nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking,
+        # selected, spellcheck, truespeed, willvalidate
+        #
+        # Finally, the following commonly mis-capitalized attribute/property names are evaluated as
+        # expected:
+        #
+        # class, readonly
+        #
+        # @param [String]
+        #   attribute name
+        # @return [String,nil]
+        #   attribute value
+        #
+        def attribute(attribute_name)
+          @element.attribute_value attribute_name
+        end
+
+        #
+        # Click this element
+        #
+        def click
+          @element.click
+        end
+
+        #
+        # Waits until the element is present
+        #
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        #
+        def when_present(timeout=5)
+          @element.wait_until_present(timeout)
+        end
+
+        #
+        # Waits until the element is visible
+        #
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        #
+        def when_visible(timeout=5)
+          Object::Watir::Wait.until(timeout, "Element was not visible in #{timeout} seconds") do
+            visible?
+          end
+        end
+
+        #
+        # Waits until the element is not visible
+        #
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        #
+        def when_not_visible(timeout=5)
+          Object::Watir::Wait.while(timeout, "Element still visible after #{timeout} seconds") do
+            visible?
+          end
+        end
+
+        #
+        # Waits until the block returns true
+        #
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        # @param [String] the message to display if the event timeouts
+        # @param the block to execute when the event occurrs
+        #
+        def wait_until(timeout=5, message=nil, &block)
+          Object::Watir::Wait.until(timeout, message, &block)
+        end
+        
+              #
+        # Send keystrokes to this element
+        #
+        # @param [String, Symbol, Array]
+        #
+        # Examples:
+        #
+        #     element.send_keys "foo"                     #=> value: 'foo'
+        #     element.send_keys "tet", :arrow_left, "s"   #=> value: 'test'
+        #     element.send_keys [:control, 'a'], :space   #=> value: ' '
+        #
+        # @see Selenium::WebDriver::Keys::KEYS
+        #
+        def send_keys(*args)
+          @element.send_keys(*args)
+        end
+      end
+    end
+  end
+end

data/lib/page-object/platforms/watir/form.rb

@@ -0,0 +1,16 @@
+module PageObject
+  module Platforms
+    module Watir
+      module Form
+
+        #
+        # Submit the form.
+        #
+        def submit
+          @element.submit
+        end
+
+      end
+    end
+  end
+end

data/lib/page-object/platforms/watir/image.rb

@@ -0,0 +1,22 @@
+module PageObject
+  module Platforms
+    module Watir
+      module Image
+
+        #
+        # Return the width of the image.
+        #
+        def width
+          @element.width
+        end
+
+        #
+        # Return the height of the image
+        #
+        def height
+          @element.height
+        end
+      end
+    end
+  end
+end

data/lib/page-object/platforms/watir/ordered_list.rb

@@ -0,0 +1,32 @@
+module PageObject
+  module Platforms
+    module Watir
+      module OrderedList
+
+        #
+        # Return the PageObject::Elements::ListItem for the index provided.  Index
+        # is zero based.
+        #
+        # @return [PageObject::Elements::ListItem]
+        #
+        def [](idx)
+          eles = list_items
+          PageObject::Elements::ListItem.new(eles[idx], :platform => :watir)
+        end
+
+        #
+        # Return the number of items contained in the ordered list
+        #
+        def items
+          list_items.size
+        end
+
+        private
+
+        def list_items
+          element.wd.find_elements(:xpath, child_xpath)
+        end
+      end
+    end
+  end
+end

data/lib/page-object/{watir_page_object.rb → platforms/watir/page_object.rb}

@@ -9,8 +9,10 @@ module PageObject
   # and use the methods dynamically added from the PageObject::Accessors module.
   #
   class WatirPageObject
+    attr_reader :browser
+
     def initialize(browser)
-      @browser = browser      
+      @browser = browser
     end
 
     #
@@ -44,14 +46,14 @@ module PageObject
     def title
       @browser.title
     end
-    
+
     #
     # platform method to wait for a block to return true
     # See PageObject#wait_until
     def wait_until(timeout, message = nil, &block)
       @browser.wait_until(timeout, message, &block)
     end
-    
+
     #
     # platform method to handle an alert popup
     # See PageObject#alert
@@ -59,7 +61,7 @@ module PageObject
     def alert(&block)
       @browser.alert(&block)
     end
-    
+
     #
     # platform method to handle a confirm popup
     # See PageObject#confirm
@@ -67,7 +69,7 @@ module PageObject
     def confirm(response, &block)
       @browser.confirm(response, &block)
     end
-    
+
     #
     # platform method to handle a prompt popup
     # See PageObject#prompt
@@ -75,6 +77,31 @@ module PageObject
     def prompt(answer, &block)
       @browser.prompt(answer, &block)
     end
+    
+    #
+    # platform method to handle attaching to a running window
+    # See PageObject#attach_to_window
+    #
+    def attach_to_window(identifier)
+      win_id = {identifier.keys.first => /#{Regexp.escape(identifier.values.first)}/}
+      @browser.window(win_id).use
+    end
+    
+    #
+    # platform method to handle switching to a frame
+    # See PageObject#switch_to_frame
+    #
+    def switch_to_frame(identifier)
+      @browser.wd.switch_to.frame(identifier)
+    end
+
+    #
+    # platform method to refresh the page
+    # See PageObject#refresh
+    #
+    def refresh
+      @browser.refresh
+    end
 
     #
     # platform method to get the value stored in a text field
@@ -84,7 +111,7 @@ module PageObject
       identifier = Elements::TextField.watir_identifier_for identifier
       @browser.text_field(identifier).value
     end
-    
+
     #
     # platform method to set the value for a text field
     # See PageObject::Accessors#text_field
@@ -93,7 +120,7 @@ module PageObject
       identifier = Elements::TextField.watir_identifier_for identifier
       @browser.text_field(identifier).set(value)
     end
-    
+
     #
     # platform method to retrieve a text field element
     # See PageObject::Accessors#text_field
@@ -103,7 +130,7 @@ module PageObject
       element = @browser.text_field(identifier)
       Elements::TextField.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to get the value stored in a hidden field
     # See PageObject::Accessors#hidden_field
@@ -112,7 +139,7 @@ module PageObject
       identifier = Elements::HiddenField.watir_identifier_for identifier
       @browser.hidden(identifier).value
     end
-    
+
     #
     # platform method to retrieve a hidden field element
     # See PageObject::Accessors#hidden_field
@@ -121,8 +148,8 @@ module PageObject
       identifier = Elements::HiddenField.watir_identifier_for identifier
       element = @browser.hidden(identifier)
       Elements::HiddenField.new(element, :platform => :watir)
-    end    
-    
+    end
+
     #
     # platform method to set text in a textarea
     # See PageObject::Accessors#text_area
@@ -131,7 +158,7 @@ module PageObject
       identifier = Elements::TextArea.watir_identifier_for identifier
       @browser.textarea(identifier).send_keys(value)
     end
-    
+
     #
     # platform method to get the text from a textarea
     # See PageObject::Accessors#text_area
@@ -140,7 +167,7 @@ module PageObject
       identifier = Elements::TextArea.watir_identifier_for identifier
       @browser.textarea(identifier).value
     end
-    
+
     #
     # platform method to get the text area element
     # See PageObject::Accessors#text_area
@@ -150,7 +177,7 @@ module PageObject
       element = @browser.textarea(identifier)
       Elements::TextArea.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to get the currently selected value from a select list
     # See PageObject::Accessors#select_list
@@ -159,7 +186,7 @@ module PageObject
       identifier = Elements::SelectList.watir_identifier_for identifier
       @browser.select_list(identifier).value
     end
-    
+
     #
     # platform method to select a value from a select list
     # See PageObject::Accessors#select_list
@@ -168,7 +195,7 @@ module PageObject
       identifier = Elements::SelectList.watir_identifier_for identifier
       @browser.select_list(identifier).select(value)
     end
-    
+
     #
     # platform method to return the select list element
     # See PageObject::Accessors#select_list
@@ -178,7 +205,7 @@ module PageObject
       element = @browser.select_list(identifier)
       Elements::SelectList.new(element, :platform => :watir)
     end
-        
+
     #
     # platform method to click a link
     # See PageObject::Accessors#link
@@ -187,7 +214,7 @@ module PageObject
       identifier = Elements::Link.watir_identifier_for identifier
       @browser.link(identifier).click if identifier
     end
-    
+
     #
     # platform method to return a PageObject::Elements::Link object
     # see PageObject::Accessors#link
@@ -224,7 +251,7 @@ module PageObject
       identifier = Elements::CheckBox.watir_identifier_for identifier
       @browser.checkbox(identifier).set?
     end
-    
+
     #
     # platform method to return a PageObject::Elements::CheckBox element
     # See PageObject::Accessors#checkbox
@@ -261,7 +288,7 @@ module PageObject
       identifier = Elements::RadioButton.watir_identifier_for identifier
       @browser.radio(identifier).set?
     end
-    
+
     #
     # platform method to return a PageObject::Eements::RadioButton element
     # See PageObject::Accessors#radio_button
@@ -271,7 +298,7 @@ module PageObject
       element = @browser.radio(identifier)
       PageObject::Elements::RadioButton.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to return the text for a div
     # See PageObject::Accessors#div
@@ -281,7 +308,7 @@ module PageObject
       identifier = Elements::Div.watir_identifier_for identifier
       @browser.div(identifier).text
     end
-    
+
     #
     # platform method to return a PageObject::Elements::Div element
     # See PageObject::Accessors#div
@@ -292,7 +319,7 @@ module PageObject
       element = @browser.div(identifier)
       PageObject::Elements::Div.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to return the text for a span
     # See PageObject::Accessors#span
@@ -302,7 +329,7 @@ module PageObject
       identifier = Elements::Span.watir_identifier_for identifier
       @browser.span(identifier).text
     end
-    
+
     #
     # platform method to return a PageObject::Elements::Span element
     # See PageObject::Accessors#span
@@ -313,7 +340,7 @@ module PageObject
       element = @browser.span(identifier)
       PageObject::Elements::Span.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to click a button
     # See PageObject::Accessors#button
@@ -322,7 +349,7 @@ module PageObject
       identifier = Elements::Button.watir_identifier_for identifier
       @browser.button(identifier).click
     end
-    
+
     #
     # platform method to retrieve a button element
     # See PageObject::Accessors#button
@@ -332,7 +359,7 @@ module PageObject
       element = @browser.button(identifier)
       PageObject::Elements::Button.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to retrieve a table element
     # See PageObject::Accessors#table
@@ -343,7 +370,7 @@ module PageObject
       element = @browser.table(identifier)
       PageObject::Elements::Table.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to retrieve the text from a table cell
     # See PageObject::Accessors#cell
@@ -353,7 +380,7 @@ module PageObject
       identifier = Elements::TableCell.watir_identifier_for identifier
       @browser.td(identifier).text
     end
-    
+
     #
     # platform method to retrieve a table cell element
     # See PageObject::Accessors#cell
@@ -364,7 +391,7 @@ module PageObject
       element = @browser.td(identifier)
       PageObject::Elements::TableCell.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to retrieve an image element
     # See PageObject::Accessors#image
@@ -374,7 +401,7 @@ module PageObject
       element = @browser.image(identifier)
       PageObject::Elements::Image.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to retrieve a form element
     # See PageObject::Accessors#form
@@ -384,7 +411,7 @@ module PageObject
       element = @browser.form(identifier)
       PageObject::Elements::Form.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to retrieve the text from a list item
     # See PageObject::Accessors#list_item
@@ -394,7 +421,7 @@ module PageObject
       identifier = Elements::ListItem.watir_identifier_for identifier
       @browser.li(identifier).text
     end
-    
+
     #
     # platform method to retrieve a list item element
     # See PageObject::Accessors#list_item
@@ -416,7 +443,7 @@ module PageObject
       element = @browser.ul(identifier)
       PageObject::Elements::UnorderedList.new(element, :platform => :watir)
     end
-    
+
     #
     # platform method to retrieve an ordered list element
     # See PageObject::Accessors#ordered_list
@@ -429,7 +456,7 @@ module PageObject
     end
 
     private
-    
+
     def add_tagname_if_needed identifier, tag
       return identifier if identifier.length < 2 and not identifier[:name]
       identifier[:tag_name] = tag if identifier[:name]