page-object 2.2.6 → 2.3.0

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

data/lib/page-object/page_populator.rb

@@ -1,105 +1,105 @@
-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.
-    #
-    # Checkbox 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 data [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.to_h.each do |key, value|
-        populate_section(key, value) if value.respond_to?(:to_h)
-        populate_value(self, key, value)
-      end
-    end
-
-    private
-
-    def populate_section(section, data)
-      return unless self.respond_to? section
-      data.to_h.each do |key, value|
-        populate_value(self.send(section), key, value)
-      end
-    end
-
-    def populate_value(receiver, key, value)
-      populate_checkbox(receiver, key, value) if is_checkbox?(receiver, key) and is_enabled?(receiver, key)
-      populate_radiobuttongroup(receiver, key, value) if is_radiobuttongroup?(receiver, key)
-      populate_radiobutton(receiver, key, value) if is_radiobutton?(receiver, key) and is_enabled?(receiver, key)
-      populate_select_list(receiver, key, value) if is_select_list?(receiver, key)
-      populate_text(receiver, key, value) if is_text?(receiver, key) and is_enabled?(receiver, key)
-    end
-    
-    def populate_text(receiver, key, value)
-      receiver.send "#{key}=", value
-    end
-
-    def populate_checkbox(receiver, key, value)
-      return receiver.send "check_#{key}" if value
-      receiver.send "uncheck_#{key}"
-    end
-
-    def populate_radiobutton(receiver, key, value)
-      receiver.send "select_#{key}" if value
-    end
-
-    def populate_radiobuttongroup(receiver, key, value)
-      receiver.send("select_#{key}", value)
-    end
-
-    def populate_select_list(receiver, key, value)
-      receiver.send "#{key}=", value
-    end
-
-    def is_text?(receiver, key)
-      return false if is_select_list?(receiver, key)
-      receiver.respond_to?("#{key}=".to_sym)
-    end
-
-    def is_checkbox?(receiver, key)
-      receiver.respond_to?("check_#{key}".to_sym)
-    end
-
-    def is_radiobutton?(receiver, key)
-      receiver.respond_to?("select_#{key}".to_sym)
-    end
-
-    def is_radiobuttongroup?(receiver, key)
-      receiver.respond_to?("select_#{key}".to_sym) and receiver.respond_to?("#{key}_values")
-    end
-
-    def is_select_list?(receiver, key)
-      receiver.respond_to?("#{key}_options".to_sym)
-    end
-
-    def is_enabled?(receiver, key)
-      return false if is_radiobuttongroup?(receiver, key)
-      return true if (receiver.send "#{key}_element").tag_name == "textarea"
-      element = receiver.send("#{key}_element")
-      element.enabled? and element.present?
-    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.
+    #
+    # Checkbox 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 data [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.to_h.each do |key, value|
+        populate_section(key, value) if value.respond_to?(:to_h)
+        populate_value(self, key, value)
+      end
+    end
+
+    private
+
+    def populate_section(section, data)
+      return unless self.respond_to? section
+      data.to_h.each do |key, value|
+        populate_value(self.send(section), key, value)
+      end
+    end
+
+    def populate_value(receiver, key, value)
+      populate_checkbox(receiver, key, value) if is_checkbox?(receiver, key) and is_enabled?(receiver, key)
+      populate_radiobuttongroup(receiver, key, value) if is_radiobuttongroup?(receiver, key)
+      populate_radiobutton(receiver, key, value) if is_radiobutton?(receiver, key) and is_enabled?(receiver, key)
+      populate_select_list(receiver, key, value) if is_select_list?(receiver, key)
+      populate_text(receiver, key, value) if is_text?(receiver, key) and is_enabled?(receiver, key)
+    end
+    
+    def populate_text(receiver, key, value)
+      receiver.send "#{key}=", value
+    end
+
+    def populate_checkbox(receiver, key, value)
+      return receiver.send "check_#{key}" if value
+      receiver.send "uncheck_#{key}"
+    end
+
+    def populate_radiobutton(receiver, key, value)
+      receiver.send "select_#{key}" if value
+    end
+
+    def populate_radiobuttongroup(receiver, key, value)
+      receiver.send("select_#{key}", value)
+    end
+
+    def populate_select_list(receiver, key, value)
+      receiver.send "#{key}=", value
+    end
+
+    def is_text?(receiver, key)
+      return false if is_select_list?(receiver, key)
+      receiver.respond_to?("#{key}=".to_sym)
+    end
+
+    def is_checkbox?(receiver, key)
+      receiver.respond_to?("check_#{key}".to_sym)
+    end
+
+    def is_radiobutton?(receiver, key)
+      receiver.respond_to?("select_#{key}".to_sym)
+    end
+
+    def is_radiobuttongroup?(receiver, key)
+      receiver.respond_to?("select_#{key}".to_sym) and receiver.respond_to?("#{key}_values")
+    end
+
+    def is_select_list?(receiver, key)
+      receiver.respond_to?("#{key}_options".to_sym)
+    end
+
+    def is_enabled?(receiver, key)
+      return false if is_radiobuttongroup?(receiver, key)
+      return true if (receiver.send "#{key}_element").tag_name == "textarea"
+      element = receiver.send("#{key}_element")
+      element.enabled? and element.present?
+    end
+  end
+end