page-object 0.2 → 0.2.1

data/lib/page-object/elements/list_item.rb

@@ -1,7 +1,7 @@
 module PageObject
   module Elements
     class ListItem < Element
-  
+
     end
   end
 end

data/lib/page-object/elements/option.rb

@@ -1,7 +1,7 @@
 module PageObject
   module Elements
     class Option < Element
-  
+
     end
   end
 end

data/lib/page-object/elements/ordered_list.rb

@@ -2,12 +2,12 @@ module PageObject
   module Elements
     class OrderedList < Element
       include Enumerable
-      
+
       def initialize(element, platform)
         @element = element
         include_platform_for platform
       end
-      
+
       #
       # iterator that yields with a PageObject::Elements::ListItem
       #
@@ -15,16 +15,16 @@ module PageObject
       #
       def each
         for index in 1..self.items do
-          yield self[index-1] 
+          yield self[index-1]
         end
-      end      
-      
+      end
+
       protected
-      
+
       def child_xpath
         ".//child::li"
       end
-      
+
       def self.watir_finders
         [:class, :id, :index, :xpath]
       end
@@ -32,16 +32,16 @@ module PageObject
       def include_platform_for platform
         super
         if platform[:platform] == :watir
-          require 'page-object/platforms/watir_ordered_list'
-          self.class.send :include, PageObject::Platforms::WatirOrderedList
+          require 'page-object/platforms/watir/ordered_list'
+          self.class.send :include, PageObject::Platforms::Watir::OrderedList
         elsif platform[:platform] == :selenium
-          require 'page-object/platforms/selenium_ordered_list'
-          self.class.send :include, PageObject::Platforms::SeleniumOrderedList
+          require 'page-object/platforms/selenium/ordered_list'
+          self.class.send :include, PageObject::Platforms::Selenium::OrderedList
         else
-          raise ArgumentError, "expect platform to be :watir or :selenium"          
+          raise ArgumentError, "expect platform to be :watir or :selenium"
         end
       end
-  
+
     end
   end
 end

data/lib/page-object/elements/select_list.rb

@@ -12,7 +12,7 @@ module PageObject
       def child_xpath
         ".//child::option"
       end
-      
+
       def self.watir_finders
         super + [:text, :value]
       end
@@ -20,13 +20,13 @@ module PageObject
       def include_platform_for platform
         super
         if platform[:platform] == :watir
-          require 'page-object/platforms/watir_select_list'
-          self.class.send :include, PageObject::Platforms::WatirSelectList
+          require 'page-object/platforms/watir/select_list'
+          self.class.send :include, PageObject::Platforms::Watir::SelectList
         elsif platform[:platform] == :selenium
-          require 'page-object/platforms/selenium_select_list'
-          self.class.send :include, PageObject::Platforms::SeleniumSelectList
+          require 'page-object/platforms/selenium/select_list'
+          self.class.send :include, PageObject::Platforms::Selenium::SelectList
         else
-          raise ArgumentError, "expect platform to be :watir or :selenium"          
+          raise ArgumentError, "expect platform to be :watir or :selenium"
         end
       end
 

data/lib/page-object/elements/span.rb

@@ -1,9 +1,9 @@
 module PageObject
   module Elements
     class Span < Element
-  
+
       protected
-      
+
       def self.watir_finders
         [:class, :id, :index, :xpath]
       end

data/lib/page-object/elements/table.rb

@@ -2,12 +2,12 @@ module PageObject
   module Elements
     class Table < Element
       include Enumerable
-      
+
       def initialize(element, platform)
         @element = element
         include_platform_for platform
       end
-      
+
       #
       # iterator that yields with a PageObject::Elements::TableRow
       #
@@ -15,26 +15,26 @@ module PageObject
       #
       def each
         for index in 1..self.rows do
-          yield self[index-1] 
+          yield self[index-1]
         end
       end
-      
+
       protected
-      
+
       def child_xpath
         ".//child::tr"
       end
-      
+
       def include_platform_for platform
         super
         if platform[:platform] == :watir
-          require 'page-object/platforms/watir_table'
-          self.class.send :include, PageObject::Platforms::WatirTable
+          require 'page-object/platforms/watir/table'
+          self.class.send :include, PageObject::Platforms::Watir::Table
         elsif platform[:platform] == :selenium
-          require 'page-object/platforms/selenium_table'
-          self.class.send :include, PageObject::Platforms::SeleniumTable
+          require 'page-object/platforms/selenium/table'
+          self.class.send :include, PageObject::Platforms::Selenium::Table
         else
-          raise ArgumentError, "expect platform to be :watir or :selenium"          
+          raise ArgumentError, "expect platform to be :watir or :selenium"
         end
       end
     end

data/lib/page-object/elements/table_row.rb

@@ -7,7 +7,7 @@ module PageObject
         @element = element
         include_platform_for platform
       end
-      
+
       #
       # iterator that yields with a PageObject::Elements::TableCell
       #
@@ -15,26 +15,26 @@ module PageObject
       #
       def each
         for index in 1..self.columns do
-          yield self[index-1] 
+          yield self[index-1]
         end
       end
 
       protected
-      
+
       def child_xpath
         ".//child::td|th"
       end
-      
+
       def include_platform_for platform
         super
         if platform[:platform] == :watir
-          require 'page-object/platforms/watir_table_row'
-          self.class.send :include, PageObject::Platforms::WatirTableRow
+          require 'page-object/platforms/watir/table_row'
+          self.class.send :include, PageObject::Platforms::Watir::TableRow
         elsif platform[:platform] == :selenium
-          require 'page-object/platforms/selenium_table_row'
-          self.class.send :include, PageObject::Platforms::SeleniumTableRow
+          require 'page-object/platforms/selenium/table_row'
+          self.class.send :include, PageObject::Platforms::Selenium::TableRow
         else
-          raise ArgumentError, "expect platform to be :watir or :selenium"          
+          raise ArgumentError, "expect platform to be :watir or :selenium"
         end
       end
     end

data/lib/page-object/elements/text_area.rb

@@ -3,19 +3,19 @@ module PageObject
     class TextArea < Element
 
       protected
-      
+
       def self.watir_finders
         super + [:tag_name]
       end
-      
+
       def self.watir_mapping
         super.merge({:css => :tag_name})
       end
-      
+
       def self.selenium_finders
         super + [:css]
       end
-      
+
       def self.selenium_mapping
         super.merge({:tag_name => :css})
       end

data/lib/page-object/elements/text_field.rb

@@ -3,19 +3,19 @@ module PageObject
     class TextField < Element
 
       protected
-      
+
       def self.watir_finders
         super + [:tag_name]
       end
-      
+
       def self.watir_mapping
         super.merge({:css => :tag_name})
       end
-      
+
       def self.selenium_finders
         super + [:css]
       end
-      
+
       def self.selenium_mapping
         super.merge({:tag_name => :css})
       end

data/lib/page-object/elements/unordered_list.rb

@@ -2,12 +2,12 @@ module PageObject
   module Elements
     class UnorderedList < Element
       include Enumerable
-      
+
       def initialize(element, platform)
         @element = element
         include_platform_for platform
       end
-      
+
       #
       # iterator that yields with a PageObject::Elements::ListItem
       #
@@ -15,17 +15,17 @@ module PageObject
       #
       def each
         for index in 1..self.items do
-          yield self[index-1] 
+          yield self[index-1]
         end
       end
-      
-      
+
+
       protected
-      
+
       def child_xpath
         ".//child::li"
       end
-      
+
       def self.watir_finders
         [:class, :id, :index, :xpath]
       end
@@ -33,16 +33,16 @@ module PageObject
       def include_platform_for platform
         super
         if platform[:platform] == :watir
-          require 'page-object/platforms/watir_unordered_list'
-          self.class.send :include, PageObject::Platforms::WatirUnorderedList
+          require 'page-object/platforms/watir/unordered_list'
+          self.class.send :include, PageObject::Platforms::Watir::UnorderedList
         elsif platform[:platform] == :selenium
-          require 'page-object/platforms/selenium_unordered_list'
-          self.class.send :include, PageObject::Platforms::SeleniumUnorderedList
+          require 'page-object/platforms/selenium/unordered_list'
+          self.class.send :include, PageObject::Platforms::Selenium::UnorderedList
         else
-          raise ArgumentError, "expect platform to be :watir or :selenium"          
+          raise ArgumentError, "expect platform to be :watir or :selenium"
         end
       end
-  
+
     end
   end
 end

data/lib/page-object/loads_platform.rb

@@ -0,0 +1,24 @@
+module PageObject
+  #
+  # module which provides a function for determining
+  # which platform to provide to the page object
+  # 
+  module LoadsPlatform
+    #
+    # Determines which platform the Page Object should use based upon browser
+    #
+    # @example
+    #  platform =  load_platform(watir_webdriver_browser, PageObject.Adapters.list).send(:new, watir_webdriver_browser)
+    # 
+    # @param [Object] A browser driver that has a supported adapter
+    # @param [adapters] a list of adapters that are currently supported
+    # @returns [PageObject] 
+    #
+    def load_platform(browser, adapters)
+      adapters.each_value { |adapter|
+        return adapter.create_page_object(browser) if adapter.is_for?(browser)
+      }
+      raise 'Unable to pick a platform for the provided browser'
+    end
+  end
+end

data/lib/page-object/page_factory.rb

@@ -19,7 +19,7 @@ module PageObject
   #   end
   #
   module PageFactory
-    
+
     #
     # Create and navigate to a page object.  The navigation will only work if the
     # 'page_url' method was call on the page object.
@@ -31,7 +31,7 @@ module PageObject
     def visit_page(page_class, &block)
       on_page page_class, true, &block
     end
-    
+
     #
     # Create a page object.
     #
@@ -45,6 +45,6 @@ module PageObject
       block.call page if block
       page
     end
-    
+
   end
 end

data/lib/page-object/platforms.rb

@@ -0,0 +1,18 @@
+require 'page-object/loads_platform'
+
+module PageObject
+  module Platforms
+    @@adapters = {}
+
+    def self.get
+      @@adapters
+    end
+
+    def self.register(key, adapter)
+      @@adapters[key] = adapter
+    end
+  end
+end
+require 'page-object/platforms/watir'
+require 'page-object/platforms/selenium'
+

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

@@ -0,0 +1,16 @@
+module PageObject
+  module Platforms
+    module Selenium
+
+      def self.create_page_object(browser)
+        require 'page-object/platforms/selenium/page_object'
+        return Object::PageObject::Platforms::Selenium::PageObject.new(browser)
+      end
+
+      def self.is_for?(browser)
+        browser.is_a? Object::Selenium::WebDriver::Driver
+      end
+    end
+  end
+end
+PageObject::Platforms.register(:selenium, PageObject::Platforms::Selenium)

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

@@ -0,0 +1,15 @@
+module PageObject
+  module Platforms
+    module Selenium
+      module Button
+        #
+        # Override PageObject::PLatforms::SeleniumElement#text because
+        # #text does not reliabably return a value in Selenium
+        #
+        def text
+          raise "text is not available on button element in Selenium"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+module PageObject
+  module Platforms
+    #
+    # Selenium implementation of the common functionality found across all elements
+    #
+    module Selenium
+      module Element
+
+        #
+        # return true if an element is visible
+        #
+        def visible?
+          @element.displayed?
+        end
+
+        #
+        # return true if an element exists
+        #
+        def exists?
+          nil != @element
+        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.attribute('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 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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not present in #{timeout} seconds"})
+          wait.until do
+            self.exists?
+          end
+        end
+
+        #
+        # Waits until the element is visible
+        #
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        #
+        def when_visible(timeout=5)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not present in #{timeout} seconds"})
+          wait.until do
+            self.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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not present in #{timeout} seconds"})
+          wait.until do
+            not self.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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => message})
+          wait.until &block
+        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)
+        wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => message})
+        wait.until &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
+      #
+      end
+    end
+  end
+end