page-object 2.2.2 → 2.3.0

data/lib/page-object/element_locators.rb

@@ -1,21 +1,21 @@
-require 'page-object/locator_generator'
-
-module PageObject
-  module  ElementLocators
-
-    def self.included(cls)
-      ::PageObject::LocatorGenerator.generate_locators(cls)
-    end
-
-    def element(tag, identifier={:index => 0})
-      platform.element_for(tag, identifier.clone)
-    end
-
-    private
-
-    def locator(identifier)
-      identifier[0] ? identifier[0] : {:index => 0}
-    end
-
-  end
-end
+require 'page-object/locator_generator'
+
+module PageObject
+  module  ElementLocators
+
+    def self.included(cls)
+      ::PageObject::LocatorGenerator.generate_locators(cls)
+    end
+
+    def element(tag, identifier={:index => 0})
+      platform.element_for(tag, identifier.clone)
+    end
+
+    private
+
+    def locator(identifier)
+      identifier[0] ? identifier[0] : {:index => 0}
+    end
+
+  end
+end

data/lib/page-object/elements.rb

@@ -1,61 +1,62 @@
-module PageObject
-  module Elements
-    class << self
-
-      #
-      # method to return the collection of tag_name to class mappings
-      #
-      def tag_to_class
-        @tag_to_class ||= {}
-      end
-
-      def type_to_class
-        @type_to_class ||= {}
-      end
-
-      #
-      # method to return the element for a tag_name
-      #
-      def element_class_for(tag_name, type=nil)
-        return type_to_class[type.to_sym] if type
-        tag_to_class[tag_name.to_sym] || ::PageObject::Elements::Element
-      end
-
-    end
-  end
-end
-
-
-require 'page-object/elements/element'
-require 'page-object/elements/link'
-require 'page-object/elements/text_field'
-require 'page-object/elements/select_list'
-require 'page-object/elements/check_box'
-require 'page-object/elements/button'
-require 'page-object/elements/radio_button'
-require 'page-object/elements/div'
-require 'page-object/elements/table'
-require 'page-object/elements/table_cell'
-require 'page-object/elements/table_row'
-require 'page-object/elements/span'
-require 'page-object/elements/image'
-require 'page-object/elements/hidden_field'
-require 'page-object/elements/form'
-require 'page-object/elements/text_area'
-require 'page-object/elements/list_item'
-require 'page-object/elements/unordered_list'
-require 'page-object/elements/ordered_list'
-require 'page-object/elements/option'
-require 'page-object/elements/heading'
-require 'page-object/elements/paragraph'
-require 'page-object/elements/label'
-require 'page-object/elements/file_field'
-require 'page-object/elements/area'
-require 'page-object/elements/canvas'
-require 'page-object/elements/media'
-require 'page-object/elements/audio'
-require 'page-object/elements/video'
-require 'page-object/elements/bold'
-require 'page-object/elements/italic'
-
-
+module PageObject
+  module Elements
+    class << self
+
+      #
+      # method to return the collection of tag_name to class mappings
+      #
+      def tag_to_class
+        @tag_to_class ||= {}
+      end
+
+      def type_to_class
+        @type_to_class ||= {}
+      end
+
+      #
+      # method to return the element for a tag_name
+      #
+      def element_class_for(tag_name, type=nil)
+        return type_to_class[type.to_sym] if type
+        tag_to_class[tag_name.to_sym] || ::PageObject::Elements::Element
+      end
+
+    end
+  end
+end
+
+
+require 'page-object/elements/element'
+require 'page-object/elements/link'
+require 'page-object/elements/text_field'
+require 'page-object/elements/date_field'
+require 'page-object/elements/select_list'
+require 'page-object/elements/check_box'
+require 'page-object/elements/button'
+require 'page-object/elements/radio_button'
+require 'page-object/elements/div'
+require 'page-object/elements/table'
+require 'page-object/elements/table_cell'
+require 'page-object/elements/table_row'
+require 'page-object/elements/span'
+require 'page-object/elements/image'
+require 'page-object/elements/hidden_field'
+require 'page-object/elements/form'
+require 'page-object/elements/text_area'
+require 'page-object/elements/list_item'
+require 'page-object/elements/unordered_list'
+require 'page-object/elements/ordered_list'
+require 'page-object/elements/option'
+require 'page-object/elements/heading'
+require 'page-object/elements/paragraph'
+require 'page-object/elements/label'
+require 'page-object/elements/file_field'
+require 'page-object/elements/area'
+require 'page-object/elements/canvas'
+require 'page-object/elements/media'
+require 'page-object/elements/audio'
+require 'page-object/elements/video'
+require 'page-object/elements/bold'
+require 'page-object/elements/italic'
+
+

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

@@ -1,9 +1,9 @@
-module PageObject
-  module Elements
-    class Area < Element
-
-    end
-
-    ::PageObject::Elements.type_to_class[:area] = ::PageObject::Elements::Area
-  end
-end
+module PageObject
+  module Elements
+    class Area < Element
+
+    end
+
+    ::PageObject::Elements.type_to_class[:area] = ::PageObject::Elements::Area
+  end
+end

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

@@ -1,9 +1,9 @@
-module PageObject
-  module Elements
-    class Audio < Media
-
-    end
-
-    ::PageObject::Elements.type_to_class[:audio] = ::PageObject::Elements::Audio
-  end
-end
+module PageObject
+  module Elements
+    class Audio < Media
+
+    end
+
+    ::PageObject::Elements.type_to_class[:audio] = ::PageObject::Elements::Audio
+  end
+end

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

@@ -1,9 +1,9 @@
-module PageObject
-  module Elements
-    class Bold < Element
-
-    end
-
-    ::PageObject::Elements.tag_to_class[:b] = ::PageObject::Elements::Bold
-  end
-end
+module PageObject
+  module Elements
+    class Bold < Element
+
+    end
+
+    ::PageObject::Elements.tag_to_class[:b] = ::PageObject::Elements::Bold
+  end
+end

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

@@ -1,12 +1,12 @@
-module PageObject
-  module Elements
-    class Button < Element
-
-    end
-
-    ::PageObject::Elements.type_to_class[:submit] = ::PageObject::Elements::Button
-    ::PageObject::Elements.type_to_class[:image] = ::PageObject::Elements::Button
-    ::PageObject::Elements.type_to_class[:button] = ::PageObject::Elements::Button
-    ::PageObject::Elements.type_to_class[:reset] = ::PageObject::Elements::Button
-  end
-end
+module PageObject
+  module Elements
+    class Button < Element
+
+    end
+
+    ::PageObject::Elements.type_to_class[:submit] = ::PageObject::Elements::Button
+    ::PageObject::Elements.type_to_class[:image] = ::PageObject::Elements::Button
+    ::PageObject::Elements.type_to_class[:button] = ::PageObject::Elements::Button
+    ::PageObject::Elements.type_to_class[:reset] = ::PageObject::Elements::Button
+  end
+end

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

@@ -1,10 +1,10 @@
-module PageObject
-  module Elements
-    class Canvas < Element
-
-    end
-
-    ::PageObject::Elements.type_to_class[:canvas] = ::PageObject::Elements::Canvas
-  end
-end
-
+module PageObject
+  module Elements
+    class Canvas < Element
+
+    end
+
+    ::PageObject::Elements.type_to_class[:canvas] = ::PageObject::Elements::Canvas
+  end
+end
+

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

@@ -1,9 +1,9 @@
-module PageObject
-  module Elements
-    class CheckBox < Element
-
-    end
-
-    ::PageObject::Elements.type_to_class[:checkbox] = ::PageObject::Elements::CheckBox
-  end
-end
+module PageObject
+  module Elements
+    class CheckBox < Element
+
+    end
+
+    ::PageObject::Elements.type_to_class[:checkbox] = ::PageObject::Elements::CheckBox
+  end
+end

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

@@ -0,0 +1,10 @@
+module PageObject
+  module Elements
+    class DateField < Element
+
+    end
+
+    ::PageObject::Elements.type_to_class[:date] = ::PageObject::Elements::DateField
+  end
+end
+

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

@@ -1,9 +1,9 @@
-module PageObject
-  module Elements
-    class Div < Element
-
-    end
-
-    ::PageObject::Elements.tag_to_class[:div] = ::PageObject::Elements::Div
-  end
-end
+module PageObject
+  module Elements
+    class Div < Element
+
+    end
+
+    ::PageObject::Elements.tag_to_class[:div] = ::PageObject::Elements::Div
+  end
+end

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

@@ -1,159 +1,212 @@
-require 'page-object/nested_elements'
-require 'watir/extensions/select_text'
-
-module PageObject
-  module Elements
-    #
-    # Contains functionality that is common across all elements.
-    #
-    # @see PageObject::Platforms::Watir::Element for the Watir version of all common methods
-    #
-    class Element
-      include ::PageObject::NestedElements
-
-      attr_reader :element
-
-      def initialize(element)
-        @element = element
-        @platform = PageObject::Platforms::Watir::PageObject.new(@element)
-      end
-
-      #
-      # return true if the element is not enabled
-      #
-      def disabled?
-        not enabled?
-      end
-
-      #
-      # specify plural form of element
-      #
-      def self.plural_form
-        "#{self.to_s.split('::')[-1].
-            gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
-            gsub(/([a-z\d])([A-Z])/, '\1_\2').
-            tr("-", "_").
-            downcase}s"
-      end
-
-      #
-      # Keeps checking until the element is visible
-      #
-      # @param [Integer] (defaults to: 5) seconds to wait before timing out
-      #
-      def check_visible(timeout=::PageObject.default_element_wait)
-        timed_loop(timeout) do |element|
-          element.visible?
-        end
-      end
-
-      #
-      # Keeps checking until the element exists
-      #
-      # @param [Integer] (defaults to: 5) seconds to wait before timing out
-      #
-      def check_exists(timeout=::PageObject.default_element_wait)
-        timed_loop(timeout) do |element|
-          element.exists?
-        end
-      end
-
-      #
-      # compare this element to another to determine if they are equal
-      #
-      def ==(other)
-        other.is_a? self.class and element == other.element
-      end
-
-      #
-      # find the parent element
-      #
-      def parent(opt = {})
-        parent = element.parent(opt)
-        type = element.type if parent.tag_name.to_sym == :input
-        cls = ::PageObject::Elements.element_class_for(parent.tag_name, type)
-        cls.new(parent.to_subtype)
-      end
-
-      #
-      # Waits until the element is present
-      #
-      # @param [Integer] (defaults to: 5) seconds to wait before timing out
-      #
-      def when_present(timeout=::PageObject.default_element_wait)
-        element.wait_until(timeout: timeout, message: "Element not present in #{timeout} seconds", &:present?)
-        self
-      end
-
-      #
-      # Waits until the element is not present
-      #
-      # @param [Integer] (defaults to: 5) seconds to wait before
-      # timing out
-      #
-      def when_not_present(timeout=::PageObject.default_element_wait)
-        element.wait_while(timeout: timeout, message: "Element still present in #{timeout} seconds", &:present?)
-      end
-
-      #
-      # Waits until the element is visible
-      #
-      # @param [Integer] (defaults to: 5) seconds to wait before timing out
-      #
-      def when_visible(timeout=::PageObject.default_element_wait)
-        when_present(timeout)
-        element.wait_until(timeout: timeout, message: "Element not visible in #{timeout} seconds", &:visible?)
-        self
-      end
-
-      #
-      # Waits until the element is not visible
-      #
-      # @param [Integer] (defaults to: 5) seconds to wait before timing out
-      #
-      def when_not_visible(timeout=::PageObject.default_element_wait)
-        when_present(timeout)
-        element.wait_while(timeout: timeout, message: "Element still visible after #{timeout} seconds", &:visible?)
-      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 occurs
-      #
-      def wait_until(timeout=::PageObject.default_element_wait, message=nil, &block)
-        element.wait_until(timeout: timeout, message: message, &block)
-      end
-
-      def name
-        element.attribute(:name)
-      end
-
-      # @private
-      # delegate calls to driver element
-      def method_missing(*args, &block)
-        m = args.shift
-        element.send m, *args, &block
-      end
-
-      def respond_to_missing?(m,*args)
-        element.respond_to?(m) || super
-      end
-
-      private
-
-      def timed_loop(timeout)
-        end_time = ::Time.now + timeout
-        until ::Time.now > end_time
-          result = yield(self)
-          return result if result
-          sleep 0.5
-        end
-        false
-      end
-
-    end
-  end
-end
+require 'page-object/nested_elements'
+
+module PageObject
+  module Elements
+    #
+    # Contains functionality that is common across all elements.
+    #
+    # @see PageObject::Platforms::Watir::Element for the Watir version of all common methods
+    #
+    class Element
+      include ::PageObject::NestedElements
+
+      attr_reader :element
+
+      def initialize(element)
+        @element = element
+        @platform = PageObject::Platforms::Watir::PageObject.new(@element)
+      end
+
+      #
+      # return true if the element is not enabled
+      #
+      def disabled?
+        not enabled?
+      end
+
+      #
+      # return true if the element exists and is visible
+      #
+      def present?
+        element.present?
+      end
+
+      def drag_and_drop_on(droppable)
+        droppable_native = droppable.kind_of?(PageObject::Elements::Element) ? droppable.element : droppable
+        element.drag_and_drop_on(droppable_native)
+      end
+
+      #
+      # specify plural form of element
+      #
+      def self.plural_form
+        "#{self.to_s.split('::')[-1].
+            gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').
+            tr("-", "_").
+            downcase}s"
+      end
+
+      #
+      # Keeps checking until the element is visible
+      #
+      # @param [Integer] (defaults to: 5) seconds to wait before timing out
+      #
+      def check_visible(timeout=::PageObject.default_element_wait)
+        timed_loop(timeout) do |element|
+          element.present?
+        end
+      end
+
+      #
+      # Keeps checking until the element exists
+      #
+      # @param [Integer] (defaults to: 5) seconds to wait before timing out
+      #
+      def check_exists(timeout=::PageObject.default_element_wait)
+        timed_loop(timeout) do |element|
+          element.exists?
+        end
+      end
+
+      #
+      # compare this element to another to determine if they are equal
+      #
+      def ==(other)
+        other.is_a? self.class and element == other.element
+      end
+
+      #
+      # find the parent element
+      #
+      def parent(opt = {})
+        parent = element.parent(opt)
+        pageobject_wrapper(parent)
+      end
+
+      #
+      # Return the element that exists at the same level of the DOM
+      # immediately prior to this element
+      #
+      def preceding_sibling(opt = {})
+        sibling = element.preceding_sibling(opt)
+        pageobject_wrapper(sibling)
+      end
+
+      #
+      # Return the element that exists at the same level of the DOM
+      # immediately after this element
+      #
+      def following_sibling(opt={})
+        sibling = element.following_sibling(opt)
+        pageobject_wrapper(sibling)
+      end
+
+      #
+      # Return all elements that are direct children of this element's parent
+      #
+      def siblings(opt={})
+        siblings = element.siblings(opt)
+        siblings.collect {|sibling| pageobject_wrapper(sibling)}
+      end
+
+      #
+      # Return all elements that are children of this element
+      #
+      def children(opt={})
+        children = element.children(opt)
+        children.collect {|child| pageobject_wrapper(child)}
+      end
+
+      #
+      # Return all elements that exist at the same level of the DOM
+      # immediately prior to this element
+      #
+      def preceding_siblings(opt={})
+        siblings = element.preceding_siblings(opt)
+        siblings.collect {|sibling| pageobject_wrapper(sibling)}
+      end
+
+      #
+      # Return all elements that exist at the same level of the DOM
+      # immediately after this element
+      #
+      def following_siblings(opt={})
+        siblings = element.following_siblings(opt)
+        siblings.collect {|sibling| pageobject_wrapper(sibling)}
+      end
+
+      #
+      # Waits until the element is present
+      #
+      # @param [Integer] (defaults to: 5) seconds to wait before timing out
+      #
+      def when_present(timeout=::PageObject.default_element_wait)
+        element.wait_until(timeout: timeout, message: "Element not present in #{timeout} seconds", &:present?)
+        self
+      end
+      alias_method :when_visible, :when_present
+
+      #
+      # Waits until the element is not present
+      #
+      # @param [Integer] (defaults to: 5) seconds to wait before
+      # timing out
+      #
+      def when_not_present(timeout=::PageObject.default_element_wait)
+        element.wait_while(timeout: timeout, message: "Element still present in #{timeout} seconds", &:present?)
+      end
+      alias_method :when_not_visible, :when_not_present
+
+      #
+      # 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 occurs
+      #
+      def wait_until(timeout=::PageObject.default_element_wait, message=nil, &block)
+        element.wait_until(timeout: timeout, message: message, &block)
+      end
+
+      def name
+        element.attribute(:name)
+      end
+
+      # @private
+      # delegate calls to driver element
+      def method_missing(method, *args, &block)
+        if element.respond_to?(method)
+          element.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(m,*args)
+        element.respond_to?(m) || super
+      end
+
+      protected
+
+      def pageobject_wrapper(watir_object)
+        type = element.type if watir_object.tag_name.to_sym == :input
+        cls = ::PageObject::Elements.element_class_for(watir_object.tag_name, type)
+        cls.new(watir_object.to_subtype)
+      end
+
+      private
+
+      def timed_loop(timeout)
+        end_time = ::Time.now + timeout
+        until ::Time.now > end_time
+          result = yield(self)
+          return result if result
+          sleep 0.5
+        end
+        false
+      end
+
+    end
+  end
+end