testcentricity_web 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a7fa37b1e2a170c3dfe53463b2f32c345c6bc8
-  data.tar.gz: 12b13c153ae52006acef1010136cb532aff35bb8
+  metadata.gz: 8eac97f61bc406208f747ef3f6b85c0078d41498
+  data.tar.gz: cf07e512e939c2af1ab03a8823e14457393cc678
 SHA512:
-  metadata.gz: 171dd73728c60562a7ce1895c2e9a18631440c7cdb6d7c375d95621c674d129870d63836213506db407eada9cc8a3249bc6863078e1f0cb80f59999d2b4be9b2
-  data.tar.gz: 3059f83f6a3258232ea6aa41ae89cd7a76ddb6780cc0a427f185e9cd4d7f9a6b15e66a8bd4d968a64efad5424dcc8043b4830ab73743b1168d39a11bdb37bf83
+  metadata.gz: 93d41573d1d76f30c80e691ae2b71168ea54e4a026ef8ed252bd3a66a32e287d8c179dd76dd7b37ca0e04e9ec82b8fb3a5b40bf3371aa7531528a32a8fdf2cd8
+  data.tar.gz: c7967d82b27dc411ace1e3a99f3b1a32677b5f0b1354ed0ef8de3283dcc6bae6487aa2097877cf73cd2c32e516e7a28be6594ac7b829e1b6e34664b4cd728851

data/lib/testcentricity_web/page_objects_helper.rb

@@ -9,7 +9,7 @@ module TestCentricity
 
     # Define a trait for this page object.
     #
-    # @param trait_name [symbol] name of trait
+    # @param trait_name [symbol] name of trait (as a symbol)
     # @param block [&block] trait value
     # @example
     #   trait(:page_name)     { 'Shopping Basket' }
@@ -20,13 +20,21 @@ module TestCentricity
       define_method(trait_name.to_s, &block)
     end
 
+    # Define and instantiate a generic UI Element for this page object.
+    #
+    # @param element_name [symbol] name of UI object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   element :siebel_view,  'div#_sweview'
+    #   element :siebel_busy,  "//html[contains(@class, 'siebui-busy')]"
+    #
     def self.element(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, nil);end))
     end
 
     # Define and instantiate a button UI Element for this page object.
     #
-    # @param element_name [symbol] name of button object
+    # @param element_name [symbol] name of button object (as a symbol)
     # @param locator [String] css selector or xpath expression that uniquely identifies object
     # @example
     #   button :checkout_button, "button.checkout_button"
@@ -38,7 +46,7 @@ module TestCentricity
 
     # Define and instantiate a text field UI Element for this page object.
     #
-    # @param element_name [symbol] name of text field object
+    # @param element_name [symbol] name of text field object (as a symbol)
     # @param locator [String] css selector or xpath expression that uniquely identifies object
     # @example
     #   textfield :user_id_field,  "//input[@id='UserName']"
@@ -50,7 +58,7 @@ module TestCentricity
 
     # Define and instantiate a checkbox UI Element for this page object.
     #
-    # @param element_name [symbol] name of checkbox object
+    # @param element_name [symbol] name of checkbox object (as a symbol)
     # @param locator [String] css selector or xpath expression that uniquely identifies object
     # @example
     #   checkbox :remember_checkbox,     "//input[@id='RememberUser']"
@@ -60,22 +68,61 @@ module TestCentricity
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :checkbox);end))
     end
 
+    # Define and instantiate a label UI Element for this page object.
+    #
+    # @param element_name [symbol] name of label object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   label :welcome_label,      'div.Welcome'
+    #   label :rollup_price_label, "//div[contains(@id, 'Rollup Item Price')]"
+    #
     def self.label(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :label);end))
     end
 
+    # Define and instantiate a link UI Element for this page object.
+    #
+    # @param element_name [symbol] name of link object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   link :registration_link,    "a.account-nav__link.register"
+    #   link :shopping_basket_link, "//a[@href='shopping_basket']"
+    #
     def self.link(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :link);end))
     end
 
+    # Define and instantiate a table UI Element for this page object.
+    #
+    # @param element_name [symbol] name of table object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   table :payments_table, "//table[@class='payments_table']"
+    #
     def self.table(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :table);end))
     end
 
+    # Define and instantiate a select list UI Element for this page object.
+    #
+    # @param element_name [symbol] name of select list object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   selectlist :category_selector, "search_form_category_chosen"
+    #   selectlist :gender_select,     "//select[@id='customer_gender']"
+    #
     def self.selectlist(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :selectlist);end))
     end
 
+    # Define and instantiate an image UI Element for this page object.
+    #
+    # @param element_name [symbol] name of image object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   image :basket_item_image,    "div.product_image"
+    #   image :corporate_logo_image, "//img[@alt='MyCompany_logo']"
+    #
     def self.image(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :image);end))
     end
@@ -128,6 +175,12 @@ module TestCentricity
       raise "Expected page to have content '#{content}'" unless page.has_content?(:visible, content)
     end
 
+    # Does Page object exists?
+    #
+    # @return [Boolean]
+    # @example
+    #   home_page.exists?
+    #
     def exists?
       saved_wait_time = Capybara.default_max_wait_time
       Capybara.default_max_wait_time = 0.1
@@ -144,6 +197,12 @@ module TestCentricity
       Capybara.default_max_wait_time = saved_wait_time
     end
 
+    # Is current Page object URL secure?
+    #
+    # @return [Boolean]
+    # @example
+    #   home_page.secure?
+    #
     def secure?
       !current_url.match(/^https/).nil?
     end

data/lib/testcentricity_web/page_sections_helper.rb

@@ -18,7 +18,7 @@ module TestCentricity
 
     # Define a trait for this page section.
     #
-    # @param trait_name [symbol] name of trait
+    # @param trait_name [symbol] name of trait (as a symbol)
     # @param block [&block] trait value
     # @example
     #   trait(:section_locator)  { "//div[@class='Messaging_Applet']" }
@@ -28,13 +28,21 @@ module TestCentricity
       define_method(trait_name.to_s, &block)
     end
 
+    # Define and instantiate a generic UI Element for this page section.
+    #
+    # @param element_name [symbol] name of UI object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   element :undo_record_item,  "//li[@rn='Undo Record']/a"
+    #   element :basket_header,     "div.basket_header"
+    #
     def self.element(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, nil);end))
     end
 
     # Define and instantiate a button UI Element for this page section.
     #
-    # @param element_name [symbol] name of button object
+    # @param element_name [symbol] name of button object (as a symbol)
     # @param locator [String] css selector or xpath expression that uniquely identifies object
     # @example
     #   button :checkout_button, "button.checkout_button"
@@ -46,7 +54,7 @@ module TestCentricity
 
     # Define and instantiate a text field UI Element for this page section.
     #
-    # @param element_name [symbol] name of text field object
+    # @param element_name [symbol] name of text field object (as a symbol)
     # @param locator [String] css selector or xpath expression that uniquely identifies object
     # @example
     #   textfield :user_id_field,  "//input[@id='UserName']"
@@ -58,7 +66,7 @@ module TestCentricity
 
     # Define and instantiate a checkbox UI Element for this page section.
     #
-    # @param element_name [symbol] name of checkbox object
+    # @param element_name [symbol] name of checkbox object (as a symbol)
     # @param locator [String] css selector or xpath expression that uniquely identifies object
     # @example
     #   checkbox :remember_checkbox,     "//input[@id='RememberUser']"
@@ -68,22 +76,61 @@ module TestCentricity
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :checkbox);end))
     end
 
+    # Define and instantiate a label UI Element for this page section.
+    #
+    # @param element_name [symbol] name of label object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   label :welcome_label,      'div.Welcome'
+    #   label :rollup_price_label, "//div[contains(@id, 'Rollup Item Price')]"
+    #
     def self.label(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :label);end))
     end
 
+    # Define and instantiate a link UI Element for this page section.
+    #
+    # @param element_name [symbol] name of link object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   link :registration_link,    "a.account-nav__link.register"
+    #   link :shopping_basket_link, "//a[@href='shopping_basket']"
+    #
     def self.link(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :link);end))
     end
 
+    # Define and instantiate a table UI Element for this page section.
+    #
+    # @param element_name [symbol] name of table object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   table :payments_table, "//table[@class='payments_table']"
+    #
     def self.table(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :table);end))
     end
 
+    # Define and instantiate a select list UI Element for this page section.
+    #
+    # @param element_name [symbol] name of select list object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   selectlist :category_selector, "search_form_category_chosen"
+    #   selectlist :gender_select,     "//select[@id='customer_gender']"
+    #
     def self.selectlist(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :selectlist);end))
     end
 
+    # Define and instantiate an image UI Element for this page section.
+    #
+    # @param element_name [symbol] name of image object (as a symbol)
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   image :basket_item_image,    "div.product_image"
+    #   image :corporate_logo_image, "//img[@alt='MyCompany_logo']"
+    #
     def self.image(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :image);end))
     end

data/lib/testcentricity_web/ui_elements_helper.rb

@@ -71,6 +71,13 @@ module TestCentricity
       page.driver.browser.mouse.double_click(obj.native)
     end
 
+    # Click at a specific location within an an object
+    #
+    # @param x [Integer] X offset
+    # @param y [Integer] Y offset
+    # @example
+    #   basket_item_image.click_at(10, 10)
+    #
     def click_at(x, y)
       obj, _ = find_element
       raise "Object #{@locator} not found" unless obj

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '0.5.3'
+  VERSION = '0.5.4'
 end

data/testcentricity_web.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |spec|
   spec.email         = ['test_automation@icloud.com']
   spec.summary       = %q{A Page Object and Data Object Model Framework for desktop and responsive mobile web testing}
   spec.description = %q{
-    TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a
-    Page Object Model DSL, for use with Capybara and selenium-webdriver. Supports testing against locally
-    hosted desktop browsers (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers
-    (using Firefox), or on cloud hosted browsers on BrowserStack, Sauce Labs, or CrossBrowserTesting.}
+    TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a Page Object
+    Model DSL, for use with Capybara and selenium-webdriver. Supports testing against locally hosted desktop browsers
+    (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers (using Firefox), or on cloud hosted
+    browsers using the BrowserStack, Sauce Labs, or CrossBrowserTesting services.}
   spec.homepage      = ''
   spec.license       = 'BSD3'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - A.J. Mrozinski
@@ -158,10 +158,10 @@ dependencies:
         version: 1.1.1
 description: |2-
 
-      TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a
-      Page Object Model DSL, for use with Capybara and selenium-webdriver. Supports testing against locally
-      hosted desktop browsers (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers
-      (using Firefox), or on cloud hosted browsers on BrowserStack, Sauce Labs, or CrossBrowserTesting.
+      TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a Page Object
+      Model DSL, for use with Capybara and selenium-webdriver. Supports testing against locally hosted desktop browsers
+      (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers (using Firefox), or on cloud hosted
+      browsers using the BrowserStack, Sauce Labs, or CrossBrowserTesting services.
 email:
 - test_automation@icloud.com
 executables: []