centric_page_object 2.3.1

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

@@ -0,0 +1,52 @@
+require 'watir/elements/html_elements'
+
+module PageObject
+  module Elements
+    class TableRow < Element
+      include Enumerable
+
+      #
+      # iterator that yields with a PageObject::Elements::TableCell
+      #
+      def each(&block)
+        cell_items.each(&block)
+      end
+
+      #
+      # Return the PageObject::Elements::TableCell for the index provided.  Index
+      # is zero based.  If the index provided is a String then it
+      # will be matched with the text from the columns in the first row.
+      # The text can be a substring of the full column text.
+      #
+      def [](what)
+        idx = find_index(what)
+        idx && cell_items[idx]
+      end
+
+      #
+      # Returns the number of columns in the table.
+      #
+      def columns
+        cell_items.size
+      end
+
+      protected
+
+      def cell_items
+        @cell_items ||= element.cells.map do |obj|
+          ::PageObject::Elements::TableCell.new(obj)
+        end
+      end
+
+      def find_index(what)
+        return what if what.is_a? Integer
+
+        parent(tag_name: 'table').headers.find_index do |header|
+          header.text.include? what
+        end
+      end
+    end
+
+    ::PageObject::Elements.tag_to_class[:tr] = ::PageObject::Elements::TableRow
+  end
+end

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

@@ -0,0 +1,9 @@
+module PageObject
+  module Elements
+    class TextArea < Element
+
+    end
+
+    ::PageObject::Elements.tag_to_class[:textarea] = ::PageObject::Elements::TextArea
+  end
+end

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

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

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

@@ -0,0 +1,42 @@
+module PageObject
+  module Elements
+    class UnorderedList < Element
+      include Enumerable
+
+      #
+      # iterator that yields with a PageObject::Elements::ListItem
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def each(&block)
+        list_items.each(&block)
+      end
+
+      #
+      # Return the PageObject::Elements::ListItem for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def [](idx)
+        list_items[idx]
+      end
+
+      #
+      # Return the number of items contained in the unordered list
+      #
+      def items
+        list_items.size
+      end
+
+      #
+      # Return Array of ListItem objects that are children of the UnorderedList
+      #
+      def list_items
+        @list_items ||= children(tag_name: 'li')
+      end
+    end
+
+    ::PageObject::Elements.tag_to_class[:ul] = ::PageObject::Elements::UnorderedList
+  end
+end

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

@@ -0,0 +1,9 @@
+module PageObject
+  module Elements
+    class Video < Media
+
+    end
+
+    ::PageObject::Elements.type_to_class[:video] = ::PageObject::Elements::Video
+  end
+end

data/lib/page-object/elements.rb

@@ -0,0 +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/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/indexed_properties.rb

@@ -0,0 +1,41 @@
+module PageObject
+  module IndexedProperties
+    class TableOfElements
+      include PageObject
+
+      def initialize (browser, identifier_list)
+        initialize_browser(browser)
+        @identifier_list = identifier_list
+        @indexed_property_class = Class.new {
+          include PageObject
+          extend Accessors
+
+          def initialize (browser, index, identifier_list)
+            initialize_browser(browser)
+
+            identifier_list.each do |identifier|
+              type = identifier[0]
+              name = identifier[1]
+              how_and_what = identifier[2].clone # Cannot modify the original...
+              how_and_what.each do |key, value|
+                next if value.is_a? Regexp # Cannot format Regexp with %
+                if key == :index
+                  how_and_what[key] = (value % index).to_i
+                elsif key == :frame
+                  how_and_what[key] = value #passthrough frame without modification
+                else
+                  how_and_what[key] = value % index
+                end
+              end
+              self.class.send type, name, how_and_what unless Class.instance_methods.include? name
+            end
+          end
+        }
+      end
+
+      def [] (index)
+        @indexed_property_class.new(@browser, index, @identifier_list)
+      end
+    end
+  end
+end

data/lib/page-object/javascript/angularjs.rb

@@ -0,0 +1,14 @@
+module PageObject
+  module Javascript
+
+    module AngularJS
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return angular.element(document.body).injector().get(\'$http\').pendingRequests.length;'
+      end
+    end
+
+  end
+end

data/lib/page-object/javascript/jquery.rb

@@ -0,0 +1,14 @@
+module PageObject
+  module Javascript
+    
+    module JQuery
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return jQuery.active'
+      end
+    end
+    
+  end
+end

data/lib/page-object/javascript/prototype.rb

@@ -0,0 +1,14 @@
+module PageObject
+  module Javascript
+    
+    module Prototype
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return Ajax.activeRequestCount'
+      end
+    end
+    
+  end
+end

data/lib/page-object/javascript/yui.rb

@@ -0,0 +1,19 @@
+module PageObject
+  module Javascript
+
+    module YUI
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+         "var inProgress=0
+         for(var i=0; i < YAHOO.util.Connect._transaction_id; i++) {
+           if(YAHOO.util.Connect.isCallInProgress(i))
+             inProgress++;
+         }
+         return inProgress;"
+      end
+    end
+
+  end
+end

data/lib/page-object/javascript_framework_facade.rb

@@ -0,0 +1,80 @@
+require 'page-object/javascript/jquery'
+require 'page-object/javascript/prototype'
+require 'page-object/javascript/yui'
+require 'page-object/javascript/angularjs'
+
+
+module PageObject
+  #
+  # Provide hooks into different common Javascript Frameworks.
+  # Currently this module only supports jQuery and Prototype but it
+  # has the ability for you to plug your own framework into it and
+  # therefore have it work with this gem.  You do this by calling the
+  # #add_framework method.  The module you provide must implement the
+  # necessary methods.  Please look at the jQuery or Prototype
+  # implementations to determine the necessary methods
+  #
+  module JavascriptFrameworkFacade
+
+    class << self
+      #
+      # Set the framework to use.
+      #
+      # @param[Symbol] the framework to use.  :jquery, :prototype, :yui,
+      # and :angularjs are supported
+      #
+      def framework=(framework)
+        initialize_script_builder unless @builder
+        raise unknown_framework(framework) unless @builder[framework]
+        @framework = framework
+      end
+
+      #
+      # Get the framework that will be used
+      #
+      def framework
+        @framework
+      end
+
+      #
+      # Add a framework and make it available to the system.
+      #
+      def add_framework(key, value)
+        raise invalid_framework unless value.respond_to? :pending_requests
+        initialize_script_builder unless @builder
+        @builder[key] = value
+      end
+
+      #
+      # get the javascript to determine number of pending requests
+      #
+      def pending_requests
+        script_builder.pending_requests
+      end
+
+      def script_builder
+        initialize_script_builder unless @builder
+        @builder[@framework]
+      end
+
+      private
+
+      def initialize_script_builder
+        @builder = {
+          :jquery => ::PageObject::Javascript::JQuery,
+          :prototype => ::PageObject::Javascript::Prototype,
+          :yui => ::PageObject::Javascript::YUI,
+          :angularjs => ::PageObject::Javascript::AngularJS
+        }
+      end
+
+      def unknown_framework(framework)
+        "You specified the Javascript framework #{framework} and it is unknown to the system"
+      end
+
+      def invalid_framework
+        "The Javascript framework you provided does not implement the necessary methods"
+      end
+    end
+  end
+end

data/lib/page-object/locator_generator.rb

@@ -0,0 +1,183 @@
+module PageObject
+  module LocatorGenerator
+
+    BASIC_ELEMENTS = %i(
+        abbr
+        address
+        animate
+        animate_motion
+        animate_transform
+        article
+        as
+        aside
+        base
+        bdi
+        bdo
+        blockquote
+        body
+        br
+        caption
+        circle
+        cite
+        code
+        col
+        colgroup
+        command
+        cursor
+        data
+        datalist
+        dd
+        defs
+        del
+        desc
+        details
+        dfn
+        dialog
+        discard
+        dl
+        dt
+        ellipse
+        em
+        embed
+        fieldset
+        figcaption
+        figure
+        font
+        footer
+        foreign_object
+        g
+        head
+        header
+        hgroup
+        hr
+        html
+        ins
+        kbd
+        keygen
+        legend
+        line
+        linear_gradient
+        main
+        map
+        mark
+        marker
+        menu
+        menuitem
+        mesh_gradient
+        mesh_patch
+        mesh_row
+        meta
+        metadata
+        meter
+        mpath
+        nav
+        noscript
+        object
+        optgroup
+        output
+        p
+        param
+        path
+        pattern
+        polygon
+        polyline
+        pre
+        progress
+        q
+        radial_gradient
+        rect
+        rp
+        rt
+        ruby
+        s
+        samp
+        script
+        section
+        set
+        small
+        source
+        stop
+        strong
+        style
+        sub
+        summary
+        sup
+        switch
+        symbol
+        template
+        text_path
+        thread
+        time
+        title
+        track
+        tspan
+        u
+        use
+        var
+        view
+        wbr
+    )
+
+
+    ADVANCED_ELEMENTS = %i(
+        text_field
+        date_field
+        hidden_field
+        text_area
+        select_list
+        link
+        checkbox
+        radio_button
+        button
+        div
+        span
+        table
+        cell
+        row
+        image
+        form
+        list_item
+        ordered_list
+        unordered_list
+        h1
+        h2
+        h3
+        h4
+        h5
+        h6
+        paragraph
+        label
+        file_field
+        area
+        canvas
+        audio
+        video
+        b
+        i
+        svg
+    )
+
+    def self.generate_locators(target)
+      ADVANCED_ELEMENTS.each do |tag|
+        target.send(:define_method, "#{tag.to_s}_element") do |*identifier|
+          @platform.send "#{tag.to_s}_for", locator(identifier)
+        end
+
+        target.send(:define_method, "#{tag.to_s}_elements") do |*identifier|
+          @platform.send("#{tag.to_s}s_for", identifier[0] ? identifier[0] : {})
+        end
+      end
+
+      BASIC_ELEMENTS.each do |tag|
+        target.send(:define_method, "#{tag.to_s}_element") do |*identifier|
+          @platform.send :element_for, tag, locator(identifier)
+        end
+
+        target.send(:define_method, "#{tag.to_s}_elements") do |*identifier|
+          @platform.send(:elements_for, tag, identifier[0] ? identifier[0] : {})
+        end
+      end
+    end
+
+  end
+end

data/lib/page-object/nested_elements.rb

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

data/lib/page-object/page_factory.rb

@@ -0,0 +1,108 @@
+require 'page_navigation'
+
+module PageObject
+  #
+  # Module to facilitate to creating of page objects in step definitions.  You
+  # can make the methods below available to all of your step definitions by adding
+  # this module to World.  This idea was first discussed in Alister Scott's blog
+  # entry http://watirmelon.com/2011/06/07/removing-local-page-references-from-cucumber-steps/.
+  #
+  # @example Making the PageFactory available to your step definitions
+  #   World PageObject::PageFactory
+  #
+  # @example Visiting a page for the first time in a Scenario
+  #   visit_page MyPageObject do |page|
+  #     page.name = 'Cheezy'
+  #   end
+  #
+  # @example using a page that has already been visited in a Scenario
+  #   on_page MyPageObject do |page|
+  #     page.name.should == 'Cheezy'
+  #   end
+  #
+  # If you plan to use the navigate_to method you will need to ensure
+  # you setup the possible routes ahead of time.  You must always have
+  # a default route in order for this to work.  Here is an example of
+  # how you define routes:
+  #
+  # @example Example routes defined in env.rb
+  #   PageObject::PageFactory.routes = {
+  #     :default => [[PageOne,:method1], [PageTwoA,:method2], [PageThree,:method3]],
+  #     :another_route => [[PageOne,:method1, "arg1"], [PageTwoB,:method2b], [PageThree,:method3]]
+  #   }
+  #
+  # Notice the first entry of :another_route is passing an argument
+  # to the method.
+  #
+  module PageFactory
+    include PageNavigation
+
+
+    #
+    # Create and navigate to a page object.  The navigation will only work if the
+    # 'page_url' method was call on the page object.
+    #
+    # @param [PageObject, String] a class that has included the
+    # PageObject module or a string containing the name of the class
+    # @param Hash values that is pass through to page class a
+    # available in the @params instance variable.
+    # @param an optional block to be called
+    # @return [PageObject] the newly created page object
+    #
+    def visit_page(page_class, params={:using_params => {}}, &block)
+      on_page page_class, params, true, &block
+    end
+
+    # Support 'visit' for readability of usage
+    alias_method :visit, :visit_page
+
+    #
+    # Create a page object.
+    #
+    # @param [PageObject, String]  a class that has included the PageObject module or a string containing the name of the class
+    # @param Hash values that is pass through to page class a
+    # available in the @params instance variable.
+    # @param [Boolean]  a boolean indicating if the page should be visited?  default is false.
+    # @param [block]  an optional block to be called
+    # @return [PageObject] the newly created page object
+    #
+    def on_page(page_class, params={:using_params => {}}, visit=false, &block)
+      page_class = class_from_string(page_class) if page_class.is_a? String
+      return super(page_class, params, visit, &block) unless page_class.ancestors.include? PageObject
+      merged = page_class.params.merge(params[:using_params])
+      page_class.instance_variable_set("@merged_params", merged) unless merged.empty?
+      @current_page = page_class.new(@browser, visit)
+      block.call @current_page if block
+      @current_page
+    end
+
+    # Support 'on' for readability of usage
+    alias_method :on, :on_page
+    
+    #
+    # Create a page object if and only if the current page is the same page to be created
+    #
+    # @param [PageObject, String]  a class that has included the PageObject module or a string containing the name of the class
+    # @param Hash values that is pass through to page class a
+    # available in the @params instance variable.
+    # @param [block]  an optional block to be called
+    # @return [PageObject] the newly created page object
+    #
+    def if_page(page_class, params={:using_params => {}},&block)
+      page_class = class_from_string(page_class) if page_class.is_a? String
+      return @current_page unless @current_page.class == page_class
+      on_page(page_class, params, false, &block)
+    end
+
+    # Support 'if' for readability of usage
+    alias_method :if, :if_page
+
+    private
+    
+    def class_from_string(str)
+      str.split('::').inject(Object) do |mod, class_name|
+        mod.const_get(class_name)
+      end
+    end
+  end
+end