meeane-page-object 0.1.10 → 0.1.11

data/lib/page-object/page_populator.rb

@@ -1,92 +1,92 @@
-module PageObject
-  module PagePopulator
-
-    #
-    # This method will populate all matched page TextFields,
-    # TextAreas, SelectLists, FileFields, Checkboxes, and Radio Buttons from the
-    # Hash passed as an argument.  The way it find an element is by
-    # matching the Hash key to the name you provided when declaring
-    # the element on your page.
-    #
-    # Checkboxes and Radio Button values must be true or false.
-    #
-    # @example
-    #   class ExamplePage
-    #     include PageObject
-    #
-    #     text_field(:username, :id => 'username_id')
-    #     checkbox(:active, :id => 'active_id')
-    #   end
-    #
-    #   ...
-    #
-    #   @browser = Watir::Browser.new :firefox
-    #   example_page = ExamplePage.new(@browser)
-    #   example_page.populate_page_with :username => 'a name', :active => true
-    #
-    # @param [Hash] the data to use to populate this page.  The key
-    # can be either a string or a symbol.  The value must be a string
-    # for TextField, TextArea, SelectList, and FileField and must be true or
-    # false for a Checkbox or RadioButton.
-    #
-    def populate_page_with(data)
-      data.each do |key, value|
-        populate_checkbox(key, value) if is_checkbox?(key) and is_enabled?(key)
-        populate_radiobuttongroup(key, value) if is_radiobuttongroup?(key)
-        populate_radiobutton(key, value) if is_radiobutton?(key) and is_enabled?(key)
-        populate_text(key, value) if is_text?(key) and is_enabled?(key)
-        populate_label(key, value) if is_label?(key)
-      end
-    end
-
-    private
-
-    def populate_text(key, value)
-      self.send "#{key}=", value
-    end
-
-    def populate_checkbox(key, value)
-      return self.send "check_#{key}" if value
-      return self.send "uncheck_#{key}"
-    end
-
-    def populate_radiobutton(key, value)
-      return self.send "select_#{key}" if value
-    end
-
-    def populate_radiobuttongroup(key, value)
-      return self.send("select_#{key}", value)
-    end
-
-    def populate_label(key, value)
-      return self.send "choose_#{key}"
-    end
-
-    def is_text?(key)
-      respond_to?("#{key}=".to_sym)
-    end
-
-    def is_checkbox?(key)
-      respond_to?("check_#{key}".to_sym)
-    end
-
-    def is_radiobutton?(key)
-      respond_to?("select_#{key}".to_sym)
-    end
-
-    def is_radiobuttongroup?(key)
-      respond_to?("select_#{key}".to_sym) and respond_to?("#{key}_values")
-    end
-
-    def is_label?(key)
-      respond_to?("choose_#{key}".to_sym)
-    end
-
-    def is_enabled?(key)
-      return false if is_radiobuttongroup?(key)
-      return true if (self.send "#{key}_element").tag_name == "textarea"
-      element = self.send("#{key}_element")
-      element.enabled? and element.visible?
-    end
-  end
-end
+module PageObject
+  module PagePopulator
+
+    #
+    # This method will populate all matched page TextFields,
+    # TextAreas, SelectLists, FileFields, Checkboxes, and Radio Buttons from the
+    # Hash passed as an argument.  The way it find an element is by
+    # matching the Hash key to the name you provided when declaring
+    # the element on your page.
+    #
+    # Checkboxe and Radio Button values must be true or false.
+    #
+    # @example
+    #   class ExamplePage
+    #     include PageObject
+    #
+    #     text_field(:username, :id => 'username_id')
+    #     checkbox(:active, :id => 'active_id')
+    #   end
+    #
+    #   ...
+    #
+    #   @browser = Watir::Browser.new :firefox
+    #   example_page = ExamplePage.new(@browser)
+    #   example_page.populate_page_with :username => 'a name', :active => true
+    #
+    # @param [Hash] the data to use to populate this page.  The key
+    # can be either a string or a symbol.  The value must be a string
+    # for TextField, TextArea, SelectList, and FileField and must be true or
+    # false for a Checkbox or RadioButton.
+    #
+    def populate_page_with(data)
+      data.each do |key, value|
+        populate_checkbox(key, value) if is_checkbox?(key) and is_enabled?(key)
+        populate_radiobuttongroup(key, value) if is_radiobuttongroup?(key)
+        populate_radiobutton(key, value) if is_radiobutton?(key) and is_enabled?(key)
+        populate_text(key, value) if is_text?(key) and is_enabled?(key)
+        populate_label(key, value) if is_label?(key)
+      end
+    end
+
+    private
+
+    def populate_text(key, value)
+      self.send "#{key}=", value
+    end
+
+    def populate_checkbox(key, value)
+      return self.send "check_#{key}" if value
+      return self.send "uncheck_#{key}"
+    end
+
+    def populate_radiobutton(key, value)
+      return self.send "select_#{key}" if value
+    end
+
+    def populate_radiobuttongroup(key, value)
+      return self.send("select_#{key}", value)
+    end
+
+    def populate_label(key, value)
+      return self.send "choose_#{key}"
+    end
+
+    def is_text?(key)
+      respond_to?("#{key}=".to_sym)
+    end
+
+    def is_checkbox?(key)
+      respond_to?("check_#{key}".to_sym)
+    end
+
+    def is_radiobutton?(key)
+      respond_to?("select_#{key}".to_sym)
+    end
+
+    def is_radiobuttongroup?(key)
+      respond_to?("select_#{key}".to_sym) and respond_to?("#{key}_values")
+    end
+
+    def is_label?(key)
+      respond_to?("choose_#{key}".to_sym)
+    end
+
+    def is_enabled?(key)
+      return false if is_radiobuttongroup?(key)
+      return true if (self.send "#{key}_element").tag_name == "textarea"
+      element = self.send("#{key}_element")
+      element.enabled? and element.visible?
+    end
+  end
+end

data/lib/page-object/platforms.rb

@@ -1,18 +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_webdriver'
-require 'page-object/platforms/selenium_webdriver'
-
+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_webdriver'
+require 'page-object/platforms/selenium_webdriver'
+

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

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

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

@@ -1,15 +1,15 @@
-module PageObject
-  module Platforms
-    module SeleniumWebDriver
-      module Button
-        #
-        # Override PageObject::PLatforms::SeleniumElement#text because
-        # #text does not reliably return a value in Selenium
-        #
-        def text
-          raise "text is not available on button element in Selenium"
-        end
-      end
-    end
-  end
+module PageObject
+  module Platforms
+    module SeleniumWebDriver
+      module Button
+        #
+        # Override PageObject::PLatforms::SeleniumElement#text because
+        # #text does not reliably 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_webdriver/check_box.rb

@@ -1,29 +1,29 @@
-module PageObject
-  module Platforms
-    module SeleniumWebDriver
-      module CheckBox
-
-        #
-        # check the checkbox
-        #
-        def check
-          element.click unless element.selected?
-        end
-
-        #
-        # uncheck the checkbox
-        #
-        def uncheck
-          element.click if element.selected?
-        end
-
-        #
-        # return true if it is checked
-        #
-        def checked?
-          element.selected?
-        end
-      end
-    end
-  end
-end
+module PageObject
+  module Platforms
+    module SeleniumWebDriver
+      module CheckBox
+
+        #
+        # check the checkbox
+        #
+        def check
+          element.click unless element.selected?
+        end
+
+        #
+        # uncheck the checkbox
+        #
+        def uncheck
+          element.click if element.selected?
+        end
+
+        #
+        # return true if it is checked
+        #
+        def checked?
+          element.selected?
+        end
+      end
+    end
+  end
+end

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

@@ -1,291 +1,291 @@
-require 'watir-webdriver/atoms'
-
-module PageObject
-  module Platforms
-    #
-    # Selenium implementation of the common functionality found across all elements
-    #
-    module SeleniumWebDriver
-      module Element
-        include Watir::Atoms
-
-        #
-        # return true if an element is visible
-        #
-        def visible?
-          element.displayed?
-        end
-
-        #
-        # return true if an element exists
-        #
-        def exists?
-          not element.nil?
-        end
-
-        #
-        # flash the element by temporarily changing the background color
-        #
-        def flash
-          original_color = attribute('backgroundColor')
-          the_bridge = bridge
-          10.times do |n|
-            color = (n % 2 == 0) ? 'red' : original_color
-            the_bridge.executeScript("arguments[0].style.backgroundColor = '#{color}'", element)
-          end
-        end
-        
-        #
-        # Get the text for the element
-        #
-        # @return [String]
-        #
-        def text
-          element.text
-        end
-
-        #
-        # Get the html for the element
-        #
-        # @return [String]
-        #
-        def html
-          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:getOuterHtml)
-          bridge.executeScript(script, element).strip
-        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
-
-        #
-        # Fire the provided event on the current element
-        #
-        def fire_event(event_name)
-          event_name = event_name.to_s.sub(/^on/, '').downcase
-          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:fireEvent)
-          bridge.executeScript(script, element, event_name)
-        end
-
-        #
-        # hover over the element
-        #
-        def hover
-          mouse = Selenium::WebDriver::Mouse.new(bridge)
-          mouse.move_to(element)
-        end
-
-        #
-        # hover over the element
-        #
-        def double_click
-          mouse = Selenium::WebDriver::Mouse.new(bridge)
-          mouse.double_click(element)
-        end
-
-        #
-        # find the parent element
-        #
-        def parent
-          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:getParentElement)
-          parent = bridge.executeScript(script, element)
-          type = element.attribute(:type).to_s.downcase if parent.tag_name.to_sym == :input
-          cls = ::PageObject::Elements.element_class_for(parent.tag_name, type)
-          cls.new(parent, :platform => :selenium_webdriver)
-        end
-
-        #
-        # Set the focus to the current element
-        #
-        def focus
-          bridge.executeScript("return arguments[0].focus()", element)
-        end
-
-        #
-        # Select the provided text
-        #
-        def select_text(text)
-          Watir::Atoms.load(:selectText)
-          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:selectText)
-          bridge.executeScript(script, element, text)
-        end
-
-        #
-        # Click this element
-        #
-        def right_click
-          element.context_click
-        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)
-          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not present in #{timeout} seconds"})
-          wait.until do
-            self.exists?
-          end
-          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)
-          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element still present in #{timeout} seconds"})
-          wait.until do
-            not_present = false
-            begin
-              not_present = false if element and element.displayed?
-            rescue Selenium::WebDriver::Error::ObsoleteElementError
-              not_present = true
-            end
-            not_present
-          end
-        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)
-          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not visible in #{timeout} seconds"})
-          wait.until do
-            self.visible?
-          end
-          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)
-          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element still visible in #{timeout} seconds"})
-          wait.until do
-            not self.visible?
-          end
-          self
-        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)
-          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
-        #
-        def send_keys(*args)
-          element.send_keys(*args)
-        end
-         
-        #
-        # clear the contents of the element
-        #
-        def clear
-          element.clear
-        end
-
-        #
-        # get the id of the element
-        #
-        def id
-          attribute(:id)
-        end
-
-        #
-        # Scroll until the element is viewable
-        #
-        def scroll_into_view
-          element.location_once_scrolled_into_view
-        end
-
-        private
-
-        def bridge
-          bridge = element.instance_variable_get(:@bridge)
-        end
-      end
-    end
-  end
-end
+require 'watir-webdriver/atoms'
+
+module PageObject
+  module Platforms
+    #
+    # Selenium implementation of the common functionality found across all elements
+    #
+    module SeleniumWebDriver
+      module Element
+        include Watir::Atoms
+
+        #
+        # return true if an element is visible
+        #
+        def visible?
+          element.displayed?
+        end
+
+        #
+        # return true if an element exists
+        #
+        def exists?
+          not element.nil?
+        end
+
+        #
+        # flash the element by temporarily changing the background color
+        #
+        def flash
+          original_color = attribute('backgroundColor')
+          the_bridge = bridge
+          10.times do |n|
+            color = (n % 2 == 0) ? 'red' : original_color
+            the_bridge.executeScript("arguments[0].style.backgroundColor = '#{color}'", element)
+          end
+        end
+        
+        #
+        # Get the text for the element
+        #
+        # @return [String]
+        #
+        def text
+          element.text
+        end
+
+        #
+        # Get the html for the element
+        #
+        # @return [String]
+        #
+        def html
+          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:getOuterHtml)
+          bridge.executeScript(script, element).strip
+        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
+
+        #
+        # Fire the provided event on the current element
+        #
+        def fire_event(event_name)
+          event_name = event_name.to_s.sub(/^on/, '').downcase
+          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:fireEvent)
+          bridge.executeScript(script, element, event_name)
+        end
+
+        #
+        # hover over the element
+        #
+        def hover
+          mouse = Selenium::WebDriver::Mouse.new(bridge)
+          mouse.move_to(element)
+        end
+
+        #
+        # hover over the element
+        #
+        def double_click
+          mouse = Selenium::WebDriver::Mouse.new(bridge)
+          mouse.double_click(element)
+        end
+
+        #
+        # find the parent element
+        #
+        def parent
+          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:getParentElement)
+          parent = bridge.executeScript(script, element)
+          type = element.attribute(:type).to_s.downcase if parent.tag_name.to_sym == :input
+          cls = ::PageObject::Elements.element_class_for(parent.tag_name, type)
+          cls.new(parent, :platform => :selenium_webdriver)
+        end
+
+        #
+        # Set the focus to the current element
+        #
+        def focus
+          bridge.executeScript("return arguments[0].focus()", element)
+        end
+
+        #
+        # Select the provided text
+        #
+        def select_text(text)
+          Watir::Atoms.load(:selectText)
+          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:selectText)
+          bridge.executeScript(script, element, text)
+        end
+
+        #
+        # Click this element
+        #
+        def right_click
+          element.context_click
+        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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not present in #{timeout} seconds"})
+          wait.until do
+            self.exists?
+          end
+          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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element still present in #{timeout} seconds"})
+          wait.until do
+            not_present = false
+            begin
+              not_present = false if element and element.displayed?
+            rescue Selenium::WebDriver::Error::ObsoleteElementError
+              not_present = true
+            end
+            not_present
+          end
+        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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element not visible in #{timeout} seconds"})
+          wait.until do
+            self.visible?
+          end
+          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)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Element still visible in #{timeout} seconds"})
+          wait.until do
+            not self.visible?
+          end
+          self
+        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)
+          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
+        #
+        def send_keys(*args)
+          element.send_keys(*args)
+        end
+         
+        #
+        # clear the contents of the element
+        #
+        def clear
+          element.clear
+        end
+
+        #
+        # get the id of the element
+        #
+        def id
+          attribute(:id)
+        end
+
+        #
+        # Scroll until the element is viewable
+        #
+        def scroll_into_view
+          element.location_once_scrolled_into_view
+        end
+
+        private
+
+        def bridge
+          bridge = element.instance_variable_get(:@bridge)
+        end
+      end
+    end
+  end
+end