meeane-page-object 0.1.10 → 0.1.11

data/lib/page-object/loads_platform.rb

@@ -1,26 +1,26 @@
-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)
-      }
-      message = 'Unable to pick a platform for the provided browser.'
-      message += "\nnil was passed to the PageObject constructor instead of a valid browser object." if browser.nil?
-      raise message 
-    end
-  end
-end
+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)
+      }
+      message = 'Unable to pick a platform for the provided browser.'
+      message += "\nnil was passed to the PageObject constructor instead of a valid browser object." if browser.nil?
+      raise message 
+    end
+  end
+end

data/lib/page-object/locator_generator.rb

@@ -1,129 +1,129 @@
-module PageObject
-  module LocatorGenerator
-
-    BASIC_ELEMENTS = [:abbr,
-                      :address,
-                      :article,
-                      :as,
-                      :aside,
-                      :bdi,
-                      :bdo,
-                      :blockquote,
-                      :body,
-                      :br,
-                      :caption,
-                      :cite,
-                      :code,
-                      :col,
-                      :colgroup,
-                      :command,
-                      :data,
-                      :datalist,
-                      :dd,
-                      :del,
-                      :details,
-                      :dfn,
-                      :dialog,
-                      :dl,
-                      :dt,
-                      :em,
-                      :embed,
-                      :fieldset,
-                      :figcaption,
-                      :figure,
-                      :footer,
-                      :head,
-                      :header,
-                      :hgroup,
-                      :hr,
-                      :ins,
-                      :kbd,
-                      :keygen,
-                      :legend,
-                      :map,
-                      :mark,
-                      :menu,
-                      :meta,
-                      :meter,
-                      :nav,
-                      :noscript,
-                      :object,
-                      :optgroup,
-                      :output,
-                      :param,
-                      :pre,
-                      :progress,
-                      :rp,
-                      :rt,
-                      :ruby,
-                      :samp,
-                      :section,
-                      :small,
-                      :strong,
-                      :style,
-                      :sub,
-                      :summary,
-                      :sup,
-                      :time,
-                      :title,
-                      :track,
-                      :var,
-                      :wbr]
-
-
-    ADVANCED_ELEMENTS = [:text_field,
-                         :hidden_field,
-                         :text_area,
-                         :select_list,
-                         :link,
-                         :checkbox,
-                         :radio_button,
-                         :button,
-                         :div,
-                         :span,
-                         :table,
-                         :cell,
-                         :image,
-                         :form,
-                         :list_item,
-                         :ordered_list,
-                         :unordered_list,
-                         :h1,
-                         :h2,
-                         :h3,
-                         :h4,
-                         :h5,
-                         :h6,
-                         :paragraph,
-                         :label,
-                         :file_field,
-                         :area,
-                         :canvas,
-                         :audio,
-                         :video,
-                         :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
+module PageObject
+  module LocatorGenerator
+
+    BASIC_ELEMENTS = [:abbr,
+                      :address,
+                      :article,
+                      :as,
+                      :aside,
+                      :bdi,
+                      :bdo,
+                      :blockquote,
+                      :body,
+                      :br,
+                      :caption,
+                      :cite,
+                      :code,
+                      :col,
+                      :colgroup,
+                      :command,
+                      :data,
+                      :datalist,
+                      :dd,
+                      :del,
+                      :details,
+                      :dfn,
+                      :dialog,
+                      :dl,
+                      :dt,
+                      :em,
+                      :embed,
+                      :fieldset,
+                      :figcaption,
+                      :figure,
+                      :footer,
+                      :head,
+                      :header,
+                      :hgroup,
+                      :hr,
+                      :ins,
+                      :kbd,
+                      :keygen,
+                      :legend,
+                      :map,
+                      :mark,
+                      :menu,
+                      :meta,
+                      :meter,
+                      :nav,
+                      :noscript,
+                      :object,
+                      :optgroup,
+                      :output,
+                      :param,
+                      :pre,
+                      :progress,
+                      :rp,
+                      :rt,
+                      :ruby,
+                      :samp,
+                      :section,
+                      :small,
+                      :strong,
+                      :style,
+                      :sub,
+                      :summary,
+                      :sup,
+                      :time,
+                      :title,
+                      :track,
+                      :var,
+                      :wbr]
+
+
+    ADVANCED_ELEMENTS = [:text_field,
+                         :hidden_field,
+                         :text_area,
+                         :select_list,
+                         :link,
+                         :checkbox,
+                         :radio_button,
+                         :button,
+                         :div,
+                         :span,
+                         :table,
+                         :cell,
+                         :image,
+                         :form,
+                         :list_item,
+                         :ordered_list,
+                         :unordered_list,
+                         :h1,
+                         :h2,
+                         :h3,
+                         :h4,
+                         :h5,
+                         :h6,
+                         :paragraph,
+                         :label,
+                         :file_field,
+                         :area,
+                         :canvas,
+                         :audio,
+                         :video,
+                         :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

@@ -1,17 +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
+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

@@ -1,108 +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
+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