testimonium 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d6661e3f0e21f8df37dd23a84fc92092445b8d9a6e256876b0661b3615206d7
-  data.tar.gz: e9c06ae626a5835604507cc18d0358b453b14ada9ae5a03b97ee0eaebe026df7
+  metadata.gz: b21b53f330b2f5650b1955c05221bdb92e6796e8375d8c99f9222954ab3e6598
+  data.tar.gz: 29562b6c0cb967808d7e1c45843527764ce476d968d9269cb37317781e19040c
 SHA512:
-  metadata.gz: 731ef578679790ce44444ec4cb9d01efe81d4ca95195b4e4b5b5cd500c8bea498ff8e63b94862c84d93671eb1ff70a4907c88f974669f53e13e462819eea5693
-  data.tar.gz: 27c500ed8845606215f33485c1d061eba4a6f5c98ab15b732b264cc16a9df6d6b3b032eddc6b8b90e9aa2a3dd4247bdd6fb513502aa537ab5debe35b3696431a
+  metadata.gz: 9cc0ce457603e0207038623812c406b25abbc1ca5d73b4a82fefc14b2f9f71a4e7bc7f140733cd2710dbc00034a6a22b09cecacd26bfe3d5d9ce6b13748c1330
+  data.tar.gz: a13d134380a80097d4c5aec069f837bfac65c4c81a5b289105d1ef7c88b7c3fa4042ccaef2e95abb6c01abc233db4af05223b743b6236e4b14759172cc913ae7

data/lib/testimonium/find_functions.rb

@@ -3,7 +3,12 @@
 module Testimonium
   # Find functions
   module Find
-    # Find element by xpath
+    # Find element by xpath.
+    #
+    # @param xpath [String] Element Xpath.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    # @return [element] if element is found.
     def find_element_by_xpath(path, timeout = 3, retries = 5)
       element = nil
       count = 0
@@ -17,54 +22,80 @@ module Testimonium
         rescue Selenium::WebDriver::Error::NoSuchElementError
         end
 
-        log("Found on attempt #{count}") if element
+        logger("Found '#{path}' on attempt #{count}") if element
         return element if element
       end
 
-      log("Failed to find: '#{path}'. Number of attempts: #{count}")
-      false
+      logger("Failed to find '#{path}'. Number of attempts: #{count}")
+      nil
     end
 
-    # Find element by element id
-    def find_element_by_id(id_string, timeout = 2, retries = 5)
-      find_element_id(id_string, timeout, retries)
+    # Find element by element id.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    # @return [element] if element is found.
+    def find_element_by_id(id, timeout = 2, retries = 5)
+      find_element_id(id, timeout, retries)
     end
 
-    # Find element by text
-    def find_element_by_text(text_string, timeout = 2, retries = 5)
-      if device_android
-        return find_element_by_xpath("//*[@text='#{text_string}']", timeout, retries)
-      end
-      return find_text_ios(text_string, timeout, retries) if device_ios
+    # Find element by text.
+    #
+    # @param text [String] Element Text.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    # @return [element] if element is found.
+    def find_element_by_text(text, timeout = 2, retries = 5)
+      return find_element_by_xpath("//*[@text='#{text}']", timeout, retries) if device_android
+      return find_text_ios(text, timeout, retries) if device_ios
     end
 
-    # Android only: Needs app package name set as const. _ANDROID_PACKAGE_
+    # Find element by resourceid.
+    #
+    # Android only - Needs app package name set as constant ANDROID_PACKAGE.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    # @return [element] if element is found.
     def find_element_by_resourceid(id, timeout = 2, retries = 5)
       if defined?(ANDROID_PACKAGE).nil?
-        log('ANDROID_PACKAGE variable is missing.')
+        logger('ANDROID_PACKAGE is missing.', 'fatal')
         raise Selenium::WebDriver::Error::NoSuchElementError
       end
 
       find_element_by_xpath("//*[@resource-id='#{ANDROID_PACKAGE}:id/#{id}']", timeout, retries)
     end
 
-    # Needs app package name set as const. _ANDROID_PACKAGE_
-    def find_all_elements_by_id(id_string, timeout = 2, retries = 5)
+    # Find all elements with id.
+    #
+    # Android needs app package name set as constant ANDROID_PACKAGE.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    # @return [list] if elements are found.
+    def find_all_elements_by_id(id, timeout = 2, retries = 5)
       list = nil
+      count = 0
 
       retries.times do
         sleep timeout
+        count += 1
 
         begin
-          list = ids(id_string) if device_android
-          list = find_elements(:id, id_string) if device_ios
+          list = ids(id) if device_android
+          list = find_elements(:id, id) if device_ios
         rescue Selenium::WebDriver::Error::NoSuchElementError
         end
 
+        logger("Found all elements with id '#{id}' on attempt #{count}") if list
         return list if list
       end
 
-      false
+      logger("Failed to find elements with id '#{id}'. Number of attempts: #{count}")
+      nil
     end
   end
 end

data/lib/testimonium/help_functions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 def find_function(function_type, parameter, timeout_time = 2, retries = 5)
   element = nil
   count = 0
@@ -14,11 +16,11 @@ def find_function(function_type, parameter, timeout_time = 2, retries = 5)
     rescue Selenium::WebDriver::Error::NoSuchElementError
     end
 
-    log("Found: '#{parameter}' on attempt #{count}") if element
+    logger("Found: '#{parameter}' on attempt #{count}") if element
     return element if element
   end
 
-  log("Failed to find: '#{function_type} = #{parameter}'. Number of attempts: #{count}")
+  logger("Failed to find: '#{function_type} = #{parameter}'. Number of attempts: #{count}")
   false
 end
 
@@ -37,3 +39,18 @@ end
 def device_ios
   ENV['PLATFORM'] == 'ios'
 end
+
+# @param msg [String] the log message
+# @param severity [String] the severity of the message, 'debug' by default
+def logger(msg, severity = 'debug')
+  logger = Logger.new($stdout)
+  logger.formatter = proc { |severity, datetime, _progname, msg| "#{severity}, #{datetime}, #{msg}\n" }
+
+  if severity.eql?('debug')
+    logger.debug(msg)
+  elsif severity.eql?('fatal')
+    logger.fatal(msg)
+  else
+    logger.info(msg)
+  end
+end

data/lib/testimonium/tap_functions.rb

@@ -3,26 +3,44 @@
 module Testimonium
   # Tap functions
   module Tap
-    # Tap element by element id
-    def tap_element_by_id(id_string, timeout = 2, retries = 5)
-      find_element_by_id(id_string, timeout, retries).click
+    # Tap element by id.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    def tap_element_by_id(id, timeout = 2, retries = 5)
+      find_element_by_id(id, timeout, retries).click
     end
 
-    # Tap element by text
-    def tap_element_by_text(text_string, timeout = 2, retries = 5)
-      find_element_by_text(text_string, timeout, retries).click if device_android
-      find_text_ios(text_string, timeout, retries).click if device_ios
+    # Tap element by text.
+    #
+    # @param text [String] Element Text.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
+    def tap_element_by_text(text, timeout = 2, retries = 5)
+      find_element_by_text(text, timeout, retries).click if device_android
+      find_text_ios(text, timeout, retries).click if device_ios
     end
 
-    # Tap element by xpath
+    # Tap element by xpath.
+    #
+    # @param xpath [String] Element Xpath.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
     def tap_element_by_xpath(path, timeout = 2, retries = 5)
       find_element_by_xpath(path, timeout, retries).click
     end
 
-    # Android only: Needs app package name set as const. _ANDROID_PACKAGE_
+    # Tap element by resourceid.
+    #
+    # Android only: Needs app package name set as constant ANDROID_PACKAGE.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
     def tap_element_by_resourceid(id, timeout = 2, retries = 5)
       if defined?(ANDROID_PACKAGE).nil?
-        log('ANDROID_PACKAGE variable is missing.')
+        logger('ANDROID_PACKAGE is missing.', 'fatal')
         raise Selenium::WebDriver::Error::NoSuchElementError
       end
 

data/lib/testimonium/validate_functions.rb

@@ -3,32 +3,42 @@
 module Testimonium
   # Validate functions
   module Validate
-    # Validate element by element id
+    # Validate element by element id.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
     def validate_element_by_id(id, timeout = 2, retries = 5)
-      unless find_element_by_id(id, timeout, retries)
-        raise Selenium::WebDriver::Error::NoSuchElementError
-      end
+      raise Selenium::WebDriver::Error::NoSuchElementError unless find_element_by_id(id, timeout, retries)
     end
 
-    # Validate element by text
+    # Validate element by text.
+    #
+    # @param text [String] Element Text.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
     def validate_element_by_text(text, timeout = 5, retries = 5)
-      unless find_element_by_text(text, timeout, retries)
-        raise Selenium::WebDriver::Error::NoSuchElementError
-      end
+      raise Selenium::WebDriver::Error::NoSuchElementError unless find_element_by_text(text, timeout, retries)
     end
 
-    # Validate element by xpath
+    # Validate element by xpath.
+    #
+    # @param xpath [String] Element Xpath.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
     def validate_element_by_xpath(path, timeout = 2, retries = 5)
-      unless find_element_by_xpath(path, timeout, retries)
-        raise Selenium::WebDriver::Error::NoSuchElementError
-      end
+      raise Selenium::WebDriver::Error::NoSuchElementError unless find_element_by_xpath(path, timeout, retries)
     end
 
-    # Android only: Needs app package name set as const. _ANDROID_PACKAGE_
+    # Validate element by resourceid.
+    #
+    # Android only: Needs app package name set as constant ANDROID_PACKAGE.
+    #
+    # @param id [String] Element ID.
+    # @param timeout [Integer] Timeout seconds between retries.
+    # @param retries [Integer] Amount of retries.
     def validate_element_by_resourceid(id, timeout = 2, retries = 5)
-      unless find_element_by_resourceid(id, timeout, retries)
-        raise Selenium::WebDriver::Error::NoSuchElementError
-      end
+      raise Selenium::WebDriver::Error::NoSuchElementError unless find_element_by_resourceid(id, timeout, retries)
     end
   end
 end

data/lib/testimonium/version.rb

@@ -2,5 +2,5 @@
 
 # Current version
 module Testimonium
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testimonium
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - M2mobi
@@ -83,5 +83,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: testimonium-1.2.0
+summary: testimonium-1.2.1
 test_files: []