testcentricity_web 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86bf1650818c1a41d7cde9464f2afee848f7a10b
-  data.tar.gz: 814d2c1cb45f34d130c42e4c4792ae26cb4b9027
+  metadata.gz: 79a7fa37b1e2a170c3dfe53463b2f32c345c6bc8
+  data.tar.gz: 12b13c153ae52006acef1010136cb532aff35bb8
 SHA512:
-  metadata.gz: 839940ee91bca0d4452b8454f785074d38f19d2cb274f13602ae0578d34e1c3318599bf0f68fe6af350177324aaa9fe3de91a10ca8df7d1b7f8c0b1ff9d6adef
-  data.tar.gz: c87998b0ca92c78b08044583fc9a872fc0b0ef229b9ca7c519081cb72a53d6820ce4021b339711e1c035650c040fc0cf3ad68c058b9df092de16958339e5e7f6
+  metadata.gz: 171dd73728c60562a7ce1895c2e9a18631440c7cdb6d7c375d95621c674d129870d63836213506db407eada9cc8a3249bc6863078e1f0cb80f59999d2b4be9b2
+  data.tar.gz: 3059f83f6a3258232ea6aa41ae89cd7a76ddb6780cc0a427f185e9cd4d7f9a6b15e66a8bd4d968a64efad5424dcc8043b4830ab73743b1168d39a11bdb37bf83

data/lib/testcentricity_web/browser_helper.rb

@@ -2,7 +2,7 @@ module TestCentricity
   module Browsers
     include Capybara::DSL
 
-    # Sets the size of the selenium browser window.
+    # Sets the size of the browser window.
     #
     # @param resolution [Array] the desired [width, height]
     # @example

data/lib/testcentricity_web/page_objects_helper.rb

@@ -7,6 +7,15 @@ module TestCentricity
     include RSpec::Matchers
     include Test::Unit::Assertions
 
+    # Define a trait for this page object.
+    #
+    # @param trait_name [symbol] name of trait
+    # @param block [&block] trait value
+    # @example
+    #   trait(:page_name)     { 'Shopping Basket' }
+    #   trait(:page_url)      { "/shopping_basket" }
+    #   trait(:page_locator)  { "//body[@class='shopping_baskets']" }
+    #
     def self.trait(trait_name, &block)
       define_method(trait_name.to_s, &block)
     end
@@ -15,14 +24,38 @@ module TestCentricity
       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 locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   button :checkout_button, "button.checkout_button"
+    #   button :login_button,    "//input[@id='submit_button']"
+    #
     def self.button(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :button);end))
     end
 
+    # Define and instantiate a text field UI Element for this page object.
+    #
+    # @param element_name [symbol] name of text field object
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   textfield :user_id_field,  "//input[@id='UserName']"
+    #   textfield :password_field, "consumer_password"
+    #
     def self.textfield(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :textfield);end))
     end
 
+    # Define and instantiate a checkbox UI Element for this page object.
+    #
+    # @param element_name [symbol] name of checkbox object
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   checkbox :remember_checkbox,     "//input[@id='RememberUser']"
+    #   checkbox :accept_terms_checkbox, "accept_terms_conditions"
+    #
     def self.checkbox(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :checkbox);end))
     end

data/lib/testcentricity_web/page_sections_helper.rb

@@ -16,6 +16,14 @@ module TestCentricity
       @context = context
     end
 
+    # Define a trait for this page section.
+    #
+    # @param trait_name [symbol] name of trait
+    # @param block [&block] trait value
+    # @example
+    #   trait(:section_locator)  { "//div[@class='Messaging_Applet']" }
+    #   trait(:list_table_name)  { 'Messages' }
+    #
     def self.trait(trait_name, &block)
       define_method(trait_name.to_s, &block)
     end
@@ -24,14 +32,38 @@ module TestCentricity
       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 locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   button :checkout_button, "button.checkout_button"
+    #   button :login_button,    "//input[@id='submit_button']"
+    #
     def self.button(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :button);end))
     end
 
+    # Define and instantiate a text field UI Element for this page section.
+    #
+    # @param element_name [symbol] name of text field object
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   textfield :user_id_field,  "//input[@id='UserName']"
+    #   textfield :password_field, "consumer_password"
+    #
     def self.textfield(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :textfield);end))
     end
 
+    # Define and instantiate a checkbox UI Element for this page section.
+    #
+    # @param element_name [symbol] name of checkbox object
+    # @param locator [String] css selector or xpath expression that uniquely identifies object
+    # @example
+    #   checkbox :remember_checkbox,     "//input[@id='RememberUser']"
+    #   checkbox :accept_terms_checkbox, "accept_terms_conditions"
+    #
     def self.checkbox(element_name, locator)
       class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :checkbox);end))
     end
@@ -69,11 +101,23 @@ module TestCentricity
       @parent = parent
     end
 
+    # Does Section object exists?
+    #
+    # @return [Boolean]
+    # @example
+    #   navigation_toolbar.exists?
+    #
     def exists?
       section, _ = find_section
       section != nil
     end
 
+    # Is Section object visible?
+    #
+    # @return [Boolean]
+    # @example
+    #   navigation_toolbar.visible?
+    #
     def visible?
       section, type = find_section
       exists = section
@@ -94,10 +138,22 @@ module TestCentricity
       (exists && !invisible) ? true : false
     end
 
+    # Is Section object hidden (not visible)?
+    #
+    # @return [Boolean]
+    # @example
+    #   navigation_toolbar.hidden?
+    #
     def hidden?
       not visible?
     end
 
+    # Wait until the Section object exists, or until the specified wait time has expired.
+    #
+    # @param seconds [Integer, Float] wait time in seconds
+    # @example
+    #   navigation_toolbar.wait_until_exists(0.5)
+    #
     def wait_until_exists(seconds)
       timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
       wait = Selenium::WebDriver::Wait.new(timeout: timeout)
@@ -106,6 +162,12 @@ module TestCentricity
       raise "Could not find section #{get_locator} after #{timeout} seconds" unless exists?
     end
 
+    # Wait until the Section object no longer exists, or until the specified wait time has expired.
+    #
+    # @param seconds [Integer, Float] wait time in seconds
+    # @example
+    #   navigation_toolbar.wait_until_gone(5)
+    #
     def wait_until_gone(seconds)
       timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
       wait = Selenium::WebDriver::Wait.new(timeout: timeout)

data/lib/testcentricity_web/ui_elements_helper.rb

@@ -45,6 +45,11 @@ module TestCentricity
       @alt_locator = nil
     end
 
+    # Click on an object
+    #
+    # @example
+    #   basket_link.click
+    #
     def click
       obj, _ = find_element
       object_not_found_exception(obj, nil)
@@ -55,6 +60,11 @@ module TestCentricity
       end
     end
 
+    # Double-click on an object
+    #
+    # @example
+    #   file_image.double_click
+    #
     def double_click
       obj, _ = find_element
       object_not_found_exception(obj, nil)
@@ -73,17 +83,35 @@ module TestCentricity
       obj.set(value)
     end
 
+    # Send keystrokes to this object.
+    #
+    # @param keys [String] keys
+     # @example
+    #   comment_field.send_keys(:enter)
+    #
     def send_keys(*keys)
       obj, _ = find_element
       object_not_found_exception(obj, nil)
       obj.send_keys(*keys)
     end
 
+    # Does UI object exists?
+    #
+    # @return [Boolean]
+    # @example
+    #   basket_link.exists?
+    #
     def exists?
       obj, _ = find_element
       obj != nil
     end
 
+    # Is UI object visible?
+    #
+    # @return [Boolean]
+    # @example
+    #   remember_me_checkbox.visible?
+    #
     def visible?
       obj, type = find_element
       exists = obj
@@ -106,32 +134,68 @@ module TestCentricity
       (exists && !invisible) ? true : false
     end
 
+    # Is UI object hidden (not visible)?
+    #
+    # @return [Boolean]
+    # @example
+    #   remember_me_checkbox.hidden?
+    #
     def hidden?
       not visible?
     end
 
+    # Is UI object enabled?
+    #
+    # @return [Boolean]
+    # @example
+    #   login_button.enabled?
+    #
     def enabled?
       not disabled?
     end
 
+    # Is UI object disabled (not enabled)?
+    #
+    # @return [Boolean]
+    # @example
+    #   login_button.disabled?
+    #
     def disabled?
       obj, _ = find_element
       object_not_found_exception(obj, nil)
       obj.disabled?
     end
 
+    # Is text field set to read-only?
+    #
+    # @return [Boolean]
+    # @example
+    #   comments_field.read_only?
+    #
     def read_only?
       obj, _ = find_element
       object_not_found_exception(obj, nil)
       !!obj.native.attribute('readonly')
     end
 
+    # Return maxlength character count of a text field.
+    #
+    # @return [Integer]
+    # @example
+    #   max_num_chars = comments_field.get_max_length
+    #
     def get_max_length
       obj, _ = find_element
       object_not_found_exception(obj, nil)
       obj.native.attribute('maxlength')
     end
 
+    # Is checkbox checked?
+    #
+    # @return [Boolean]
+    # @example
+    #   remember_me_checkbox.checked?
+    #
     def checked?
       obj, _ = find_element
       object_not_found_exception(obj, 'Checkbox')
@@ -152,6 +216,12 @@ module TestCentricity
           assert_equal(state, actual, "Expected #{@locator} to be #{state} but found #{actual} instead")
     end
 
+    # Wait until the object exists, or until the specified wait time has expired.
+    #
+    # @param seconds [Integer, Float] wait time in seconds
+    # @example
+    #   run_button.wait_until_exists(0.5)
+    #
     def wait_until_exists(seconds)
       timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
       wait = Selenium::WebDriver::Wait.new(timeout: timeout)
@@ -160,6 +230,12 @@ module TestCentricity
       raise "Could not find element #{@locator} after #{timeout} seconds" unless exists?
     end
 
+    # Wait until the object no longer exists, or until the specified wait time has expired.
+    #
+    # @param seconds [Integer, Float] wait time in seconds
+    # @example
+    #   logout_button.wait_until_gone(5)
+    #
     def wait_until_gone(seconds)
       timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
       wait = Selenium::WebDriver::Wait.new(timeout: timeout)
@@ -168,6 +244,12 @@ module TestCentricity
       raise "Element #{@locator} remained visible after #{timeout} seconds" if exists?
     end
 
+    # Wait until the object's value equals the specified value, or until the specified wait time has expired.
+    #
+    # @param seconds [Integer, Float] wait time in seconds
+    # @example
+    #   card_authorized_label.wait_until_value_is(5, 'Card authorized')
+    #
     def wait_until_value_is(value, seconds)
       timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
       wait = Selenium::WebDriver::Wait.new(timeout: timeout)
@@ -176,6 +258,12 @@ module TestCentricity
       raise "Value of UI element #{@locator} failed to equal '#{value}' after #{timeout} seconds" unless exists?
     end
 
+    # Wait until the object's value changes to a different value, or until the specified wait time has expired.
+    #
+    # @param seconds [Integer, Float] wait time in seconds
+    # @example
+    #   basket_grand_total_label.wait_until_value_changes(5)
+    #
     def wait_until_value_changes(seconds)
       value = get_value
       timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
@@ -203,6 +291,11 @@ module TestCentricity
           assert_equal(expected.strip, actual.strip, "Expected #{@locator} to display '#{expected}' but found '#{actual}'")
     end
 
+    # Hover the cursor over an object
+    #
+    # @example
+    #   basket_link.hover
+    #
     def hover
       obj, _ = find_element
       object_not_found_exception(obj, nil)
@@ -256,12 +349,24 @@ module TestCentricity
       obj.first('option[selected]').text
     end
 
+    # Return number of rows in a table object.
+    #
+    # @return [Integer]
+    # @example
+    #   num_rows = list_table.get_row_count
+    #
     def get_row_count
       wait_until_exists(5)
       row_count = page.all(:xpath, "#{@locator}/tbody/tr", :visible => :all).count
       row_count
     end
 
+    # Return number of columns in a table object.
+    #
+    # @return [Integer]
+    # @example
+    #   num_columns = list_table.get_column_count
+    #
     def get_column_count
       row_count = get_row_count
       if row_count == 0
@@ -273,6 +378,13 @@ module TestCentricity
       end
     end
 
+    # Click in the specified cell in a table object.
+    #
+    # @param row [Integer] row number
+    # @param column [Integer] column number
+    # @example
+    #   list_table.click_table_cell(3, 5)
+    #
     def click_table_cell(row, column)
       row_count = get_row_count
       raise "Row #{row} exceeds number of rows (#{row_count}) in table #{@locator}" if row > row_count
@@ -283,6 +395,13 @@ module TestCentricity
       clear_alt_locator
     end
 
+    # Double-click in the specified cell in a table object.
+    #
+    # @param row [Integer] row number
+    # @param column [Integer] column number
+    # @example
+    #   list_table.double_click_table_cell(3, 5)
+    #
     def double_click_table_cell(row, column)
       row_count = get_row_count
       raise "Row #{row} exceeds number of rows (#{row_count}) in table #{@locator}" if row > row_count
@@ -293,6 +412,13 @@ module TestCentricity
       clear_alt_locator
     end
 
+    # Click the link object embedded within the specified cell in a table object.
+    #
+    # @param row [Integer] row number
+    # @param column [Integer] column number
+    # @example
+    #   list_table.click_table_cell_link(3, 1)
+    #
     def click_table_cell_link(row, column)
       row_count = get_row_count
       raise "Row #{row} exceeds number of rows (#{row_count}) in table #{@locator}" if row > row_count

data/lib/testcentricity_web/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - A.J. Mrozinski