testcentricity_apps 4.0.15 → 4.1.0

data/lib/testcentricity_apps/app_elements/app_element.rb

@@ -141,6 +141,7 @@ module TestCentricity
             end
           end
         end
+
         caption
       end
 
@@ -176,12 +177,14 @@ module TestCentricity
       def visible?
         obj = element
         return false if obj.nil?
+
         begin
           obj.displayed?
         rescue
           reset_mru_cache
           obj = element
           return false if obj.nil?
+
           obj.displayed?
         end
       end
@@ -480,13 +483,17 @@ module TestCentricity
       def double_tap
         obj = element
         object_not_found_exception(obj)
-        driver.action
-              .click_and_hold(obj)
-              .release
-              .pause(duration: 0.2)
-              .click_and_hold(obj)
-              .release
-              .perform
+        if Environ.is_macos?
+          Environ.appium_driver.execute_script('macos: doubleClick', { elementId: cell_obj.id })
+        else
+          driver.action
+                .click_and_hold(obj)
+                .release
+                .pause(duration: 0.2)
+                .click_and_hold(obj)
+                .release
+                .perform
+        end
       end
 
       # Long press on a UI element
@@ -514,7 +521,27 @@ module TestCentricity
               .perform
       end
 
+      # Right click on a UI element. MacOS apps only.
+      #
+      # @example
+      #   chart_image.right_click
+      #
+      def right_click
+        raise "Right click is not supported for #{Environ.device_os} platforms" unless Environ.is_macos?
+
+        obj = element
+        object_not_found_exception(obj)
+        Environ.appium_driver.execute_script('macos: rightClick', { elementId: obj.id })
+      end
+
+      # Hover over a UI element. MacOS apps only.
+      #
+      # @example
+      #   chart_image.hover
+      #
       def hover
+        raise "Hover is not supported for #{Environ.device_os} platforms" unless Environ.is_macos?
+
         obj = element
         object_not_found_exception(obj)
         Environ.appium_driver.execute_script('macos: hover', { elementId: obj.id })
@@ -570,6 +597,7 @@ module TestCentricity
       #
       def scroll_into_view(scroll_mode = :vertical)
         return if visible?
+
         case scroll_mode
         when :vertical
           start_direction = :down
@@ -614,11 +642,12 @@ module TestCentricity
       #
       def swipe_gesture(direction, distance = 0.5)
         raise 'Scroll distance must be less than 1' if distance > 1
+
         obj = element
         object_not_found_exception(obj)
         start_pt = [(obj.location.x + (obj.size.width * 0.5)).to_i, (obj.location.y + (obj.size.height * 0.5)).to_i]
 
-        if distance < 0
+        if distance.negative?
           top = (start_pt[1] - obj.size.height).to_i
           bottom = (start_pt[1] + obj.size.height).to_i
           left = (start_pt[0] - obj.size.width).to_i
@@ -677,6 +706,7 @@ module TestCentricity
                 parent_obj.find_element(@locator.keys[0], @locator.values[0])
               else
                 return @mru_object if @mru_locator == @locator && !@mru_object.nil?
+
                 find_element(@locator.keys[0], @locator.values[0])
               end
         puts "Found object '#{@name}' - #{@locator}" if ENV['DEBUG']
@@ -693,7 +723,7 @@ module TestCentricity
       private
 
       def object_not_found_exception(obj)
-        @type.nil? ? object_type = 'Object' : object_type = @type
+        object_type = @type.nil? ? 'Object' : @type
         raise ObjectNotFoundError.new("#{object_type} named '#{@name}' (#{get_locator}) not found") unless obj
       end
 

data/lib/testcentricity_apps/app_elements/list.rb

@@ -1,9 +1,7 @@
 module TestCentricity
   module AppElements
     class AppList < AppUIElement
-      attr_accessor :list_item
-      attr_accessor :scrolling
-      attr_accessor :item_objects
+      attr_accessor :list_item, :scrolling, :item_objects
 
       def initialize(name, parent, locator, context)
         super
@@ -57,9 +55,10 @@ module TestCentricity
         if Environ.is_ios? && obj.attribute(:type) == 'XCUIElementTypePickerWheel'
           raise 'This method is not supported for XCUIElementTypePickerWheel controls'
         end
+
         list_loc = get_list_item_locator
         items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
-        if items.size > 0 && Environ.is_android?
+        if items.size.positive? && Environ.is_android?
           start_count = items.count
           direction = @scrolling == :horizontal ? :right : :down
           scroll_count = 0
@@ -94,6 +93,7 @@ module TestCentricity
         if Environ.is_ios? && obj.attribute(:type) == 'XCUIElementTypePickerWheel'
           raise 'This method is not supported for XCUIElementTypePickerWheel controls'
         end
+
         list_loc = get_list_item_locator
         items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
         items.each do |item|

data/lib/testcentricity_apps/app_elements/menu.rb

@@ -1,8 +1,7 @@
 module TestCentricity
   module AppElements
     class AppMenu < AppUIElement
-      attr_accessor :menu_item
-      attr_accessor :key_map
+      attr_accessor :menu_item, :key_map
 
       def initialize(name, parent, locator, context)
         super
@@ -142,6 +141,7 @@ module TestCentricity
         when :keys, :keyboard
           keys = @key_map[item]
           raise "No key map found for item #{item}" if keys.empty?
+
           Environ.appium_driver.execute_script('macos: keys', { keys: keys })
         else
           raise "#{method} is not a valid selector"

data/lib/testcentricity_apps/app_elements/menubar.rb

@@ -18,28 +18,6 @@ module TestCentricity
       :menubar
     end
 
-    # Declare and instantiate a single menu UI Element for this MenuBar object.
-    #
-    # @param element_name [Symbol] name of menu object (as a symbol)
-    # @param locator [Hash] { locator_strategy: locator_identifier }
-    # @example
-    #   menu :convert_menu, { xpath: '//XCUIElementTypeMenuBarItem[6]' }
-    #
-    def self.menu(element_name, locator)
-      define_section_element(element_name, TestCentricity::AppElements::AppMenu, locator)
-    end
-
-    # Declare and instantiate a collection of menus for this MenuBar object.
-    #
-    # @param element_hash [Hash] names of menus (as symbol) and locator Hash
-    # @example
-    #   menus convert_menu: { xpath: '//XCUIElementTypeMenuBarItem[6]' },
-    #         view_menu:    { xpath: '//XCUIElementTypeMenuBarItem[5]' }
-    #
-    def self.menus(element_hash)
-      element_hash.each_pair { |element_name, locator| menu(element_name, locator) }
-    end
-
     # Return the number of menus in a MenuBar object.
     #
     # @return [Integer]

data/lib/testcentricity_apps/app_elements/selectlist.rb

@@ -42,9 +42,9 @@ module TestCentricity
           raise 'This method is not supported for XCUIElementTypePickerWheel controls'
         end
         list_loc = get_list_item_locator
-        self.click if Environ.is_macos?
+        click if Environ.is_macos?
         items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
-        self.click if Environ.is_macos?
+        click if Environ.is_macos?
         items.count
       end
 
@@ -62,12 +62,12 @@ module TestCentricity
           raise 'This method is not supported for XCUIElementTypePickerWheel controls'
         end
         list_loc = get_list_item_locator
-        self.click if Environ.is_macos?
+        click if Environ.is_macos?
         items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
         items.each do |item|
           list_items.push(item.text)
         end
-        self.click if Environ.is_macos?
+        click if Environ.is_macos?
         list_items
       end
 
@@ -91,7 +91,7 @@ module TestCentricity
           obj.send_keys(item)
         else
           list_loc = get_list_item_locator
-          self.click if Environ.is_macos?
+          click if Environ.is_macos?
           items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
           if item.is_a?(Integer)
             items[item - 1].click

data/lib/testcentricity_apps/app_elements/switch.rb

@@ -17,7 +17,7 @@ module TestCentricity
         object_not_found_exception(obj)
 
         if Environ.is_ios?
-          state =  obj.attribute(:value)
+          state = obj.attribute(:value)
           state.to_bool
         else
           state = obj.attribute(:checked)

data/lib/testcentricity_apps/app_elements/table.rb

@@ -0,0 +1,397 @@
+module TestCentricity
+  module AppElements
+    class AppTable < AppUIElement
+      attr_accessor :table_row, :table_column, :table_cell, :table_header, :table_header_cell, :table_row_expand
+
+      def initialize(name, parent, locator, context)
+        super
+        @type = :table
+        table_spec = if %i[mac ios].include?(Environ.device_os)
+                       {
+                         table_row: { class: 'XCUIElementTypeTableRow' },
+                         table_column: { class: 'XCUIElementTypeTableColumn' },
+                         table_cell: { class_chain: '**/XCUIElementTypeCell/XCUIElementTypeStaticText' },
+                         table_header: { class: 'XCUIElementTypeGroup' },
+                         table_header_cell: { class: 'XCUIElementTypeButton' },
+                         table_row_expand: { class: 'XCUIElementTypeDisclosureTriangle' },
+                       }
+                     else
+                       {
+                         table_row: nil,
+                         table_column: nil,
+                         table_cell: nil,
+                         table_header: nil,
+                         table_header_cell: nil,
+                         table_row_expand: nil,
+                       }
+                     end
+        define_table_elements(table_spec)
+      end
+
+      def define_table_elements(element_spec)
+        element_spec.each do |element, value|
+          case element
+          when :table_row
+            @table_row = value
+          when :table_column
+            @table_column = value
+          when :table_cell
+            @table_cell = value
+          when :table_header
+            @table_header = value
+          when :table_header_cell
+            @table_header_cell = value
+          when :table_row_expand
+            @table_row_expand = value
+          else
+            raise "#{element} is not a recognized table element"
+          end
+        end
+      end
+
+      # Return number of rows in a table object.
+      #
+      # @return [Integer]
+      # @example
+      #   num_rows = sidebar_table.get_row_count
+      #
+      def get_row_count
+        obj = element
+        object_not_found_exception(obj)
+        row_loc = get_row_locator
+        items = obj.find_elements(row_loc.keys[0], row_loc.values[0])
+        items.count
+      end
+
+      # Return number of columns in a table object.
+      #
+      # @return [Integer]
+      # @example
+      #   num_columns = sidebar_table.get_column_count
+      #
+      def get_column_count
+        obj = element
+        object_not_found_exception(obj)
+        col_loc = get_column_locator
+        items = obj.find_elements(col_loc.keys[0], col_loc.values[0])
+        items.count
+      end
+
+      # Wait until the table's row count equals the specified value, or until the specified wait time has expired. If the wait
+      # time is nil, then the wait time will be Environ.default_max_wait_time.
+      #
+      # @param value [Integer or Hash] value expected or comparison hash
+      # @param seconds [Integer or Float] wait time in seconds
+      # @example
+      #   sidebar_table.wait_until_row_count_is(10, 15)
+      #     or
+      #   sidebar_table.wait_until_row_count_is({ greater_than_or_equal: 1 }, 5)
+      #
+      def wait_until_row_count_is(value, seconds = nil, post_exception = true)
+        timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+        wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+        wait.until { compare(value, get_row_count) }
+      rescue
+        if post_exception
+          raise "Value of Table #{object_ref_message} failed to equal '#{value}' after #{timeout} seconds" unless get_row_count == value
+        else
+          get_row_count == value
+        end
+      end
+
+      # Wait until the table's row count changes to a different value, or until the specified wait time has expired. If the
+      # wait time is nil, then the wait time will be Environ.default_max_wait_time.
+      #
+      # @param seconds [Integer or Float] wait time in seconds
+      # @example
+      #   sidebar_table.wait_until_row_count_changes(5)
+      #
+      def wait_until_row_count_changes(seconds = nil, post_exception = true)
+        value = get_row_count
+        timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+        wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+        wait.until { get_row_count != value }
+      rescue
+        if post_exception
+          raise "Value of Table #{object_ref_message} failed to change from '#{value}' after #{timeout} seconds" if get_row_count == value
+        else
+          get_row_count == value
+        end
+      end
+
+      # Return array of strings of all values in each cell in the specified row of a table object.
+      #
+      # @return [Array]
+      # @example
+      #   sidebar_row_data = sidebar_table.get_table_row(4)
+      #
+      def get_table_row(row)
+        columns = []
+        # find table element
+        obj = element
+        object_not_found_exception(obj)
+        # find all rows in table
+        row_loc = get_row_locator
+        rows = obj.find_elements(row_loc.keys[0], row_loc.values[0])
+        raise "Row #{row} exceeds number of rows (#{rows.count}) in table #{object_ref_message}" if row > rows.count
+
+        # find all cells in the desired row
+        row_obj = rows[row - 1]
+        cell_loc = get_cell_locator
+        items = row_obj.find_elements(cell_loc.keys[0], cell_loc.values[0])
+        # retrieve caption for each cell in table row
+        items.each do |item|
+          columns.push(item.text)
+        end
+        columns
+      end
+
+      # Return array of strings of all values in each cell in the specified column of a table object.
+      #
+      # @return [Array]
+      # @example
+      #   sidebar_col_data = sidebar_table.get_table_column(2)
+      #
+      def get_table_column(column)
+        row_data = []
+        column_count = get_column_count
+        raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
+
+        # find table element
+        obj = element
+        object_not_found_exception(obj)
+        # find all rows in table
+        row_loc = get_row_locator
+        rows = obj.find_elements(row_loc.keys[0], row_loc.values[0])
+        # find all cells in the current row
+        cell_loc = get_cell_locator
+        rows.each do |row|
+          cells = row.find_elements(cell_loc.keys[0], cell_loc.values[0])
+          # retrieve caption from cell in specified column
+          cell_obj = cells[column - 1]
+          value = ''
+          value = cell_obj.text unless cell_obj.nil?
+          row_data.push(value)
+        end
+        row_data
+      end
+
+      # Return text contained in specified cell of a table object.
+      #
+      # @param row [Integer] row number
+      # @param column [Integer] column number
+      # @return [String] value of table cell
+      # @example
+      #   sidebar_table.get_table_cell(4, 5)
+      #
+      def get_table_cell(row, column)
+        cell_obj = find_cell(row, column)
+        value = ''
+        value = cell_obj.text unless cell_obj.nil?
+        value
+      end
+
+      # Return array of strings of all captions in each cell in the header of a table object.
+      #
+      # @return [Array]
+      # @example
+      #   sidebar_header = sidebar_table.get_header_columns
+      #
+      def get_header_columns
+        header = []
+        obj = element
+        object_not_found_exception(obj)
+        header_loc = get_header_locator
+        header_obj = obj.find_element(header_loc.keys[0], header_loc.values[0])
+        raise "Could not find header object for table #{object_ref_message}" if header_obj.nil?
+
+        header_cell_loc = get_header_cell_locator
+        items = header_obj.find_elements(header_cell_loc.keys[0], header_cell_loc.values[0])
+        items.each do |item|
+          header.push(item.text)
+        end
+        header
+      end
+
+      # Search for the specified text value in the specified row of the table object.
+      # Returns the number of the first column that contains the search value.
+      #
+      # @param row [Integer] row number
+      # @param search_value [String] value to be searched for
+      # @return [Integer] column number of table cell that contains search value
+      # @example
+      #   bom_table.find_in_table_row(4, 'High-speed Framus bolts')
+      #
+      def find_in_table_row(row, search_value)
+        (1..get_column_count).each do |column|
+          return column if get_table_cell(row, column) == search_value
+        end
+        nil
+      end
+
+      # Search for the specified text value in the specified column of the table object.
+      # Returns the number of the first row that contains the search value.
+      #
+      # @param column [Integer] column number
+      # @param search_value [String] value to be searched for
+      # @return [Integer] row number of table cell that contains search value
+      # @example
+      #   playlist_table.find_in_table_column(1, 'Ashes to Ashes')
+      #
+      def find_in_table_column(column, search_value)
+        (1..get_row_count).each do |row|
+          return row if get_table_cell(row, column) == search_value
+        end
+        nil
+      end
+
+      # Tap in the specified cell in a table object.
+      #
+      # @param row [Integer] row number
+      # @param column [Integer] column number
+      # @example
+      #   playlist_table.tap_table_cell(3, 5)
+      #
+      def tap_table_cell(row, column)
+        cell_obj = find_cell(row, column)
+        raise "Cell [#{row}, #{column}] not found in table #{object_ref_message}" if cell_obj.nil?
+
+        if Environ.is_macos?
+          Environ.appium_driver.execute_script('macos: click', { elementId: cell_obj.id })
+        else
+          driver.action
+                .click_and_hold(cell_obj)
+                .release
+                .perform
+        end
+      end
+
+      # Double-tap in the specified cell in a table object.
+      #
+      # @param row [Integer] row number
+      # @param column [Integer] column number
+      # @example
+      #   playlist_table.double_tap_table_cell(3, 5)
+      #
+      def double_tap_table_cell(row, column)
+        cell_obj = find_cell(row, column)
+        raise "Cell [#{row}, #{column}] not found in table #{object_ref_message}" if cell_obj.nil?
+
+        if Environ.is_macos?
+          Environ.appium_driver.execute_script('macos: doubleClick', { elementId: cell_obj.id })
+        else
+          driver.action
+                .click_and_hold(cell_obj)
+                .release
+                .pause(duration: 0.2)
+                .click_and_hold(cell_obj)
+                .release
+                .perform
+        end
+      end
+
+      # Right click in the specified cell in a table object.
+      #
+      # @param row [Integer] row number
+      # @param column [Integer] column number
+      # @example
+      #   playlist_table.right_click_table_cell(3, 5)
+      #
+      def right_click_table_cell(row, column)
+        raise "Right click is not supported for #{Environ.device_os} platforms" unless Environ.is_macos?
+
+        cell_obj = find_cell(row, column)
+        raise "Cell [#{row}, #{column}] not found in table #{object_ref_message}" if cell_obj.nil?
+
+        Environ.appium_driver.execute_script('macos: rightClick', { elementId: cell_obj.id })
+      end
+
+      def row_selected?(row)
+        cell_obj = find_cell(row, 1)
+        cell_obj.selected?
+      end
+
+      private
+
+      def get_row_locator
+        if @table_row.nil?
+          case Environ.device_os
+          when :mac, :ios
+            define_table_elements({ :table_row => { class: 'XCUIElementTypeTableRow' } })
+          when :android
+            raise 'No table_row element defined'
+          end
+        end
+        @table_row
+      end
+
+      def get_column_locator
+        if @table_column.nil?
+          case Environ.device_os
+          when :mac, :ios
+            define_table_elements({ :table_column => { class: 'XCUIElementTypeTableColumn' } })
+          when :android
+            raise 'No table_column element defined'
+          end
+        end
+        @table_column
+      end
+
+      def get_cell_locator
+        if @table_cell.nil?
+          case Environ.device_os
+          when :mac, :ios
+            define_table_elements({ :table_cell => { class_chain: '**/XCUIElementTypeCell/XCUIElementTypeStaticText' } })
+          when :android
+            raise 'No table_cell element defined'
+          end
+        end
+        @table_cell
+      end
+
+      def get_header_locator
+        if @table_header.nil?
+          case Environ.device_os
+          when :mac, :ios
+            define_table_elements({ :table_header => { class: 'XCUIElementTypeGroup' } })
+          when :android
+            raise 'No table_header element defined'
+          end
+        end
+        @table_header
+      end
+
+      def get_header_cell_locator
+        if @table_header_cell.nil?
+          case Environ.device_os
+          when :mac, :ios
+            define_table_elements({ :table_header_cell => { class: 'XCUIElementTypeButton' } })
+          when :android
+            raise 'No table_header_cell element defined'
+          end
+        end
+        @table_header_cell
+      end
+
+      def find_cell(row, column)
+        column_count = get_column_count
+        raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
+
+        # find table element
+        obj = element
+        object_not_found_exception(obj)
+        # find all rows in table
+        row_loc = get_row_locator
+        rows = obj.find_elements(row_loc.keys[0], row_loc.values[0])
+        raise "Row #{row} exceeds number of rows (#{rows.count}) in table #{object_ref_message}" if row > rows.count
+
+        # find all cells in the desired row
+        row_obj = rows[row - 1]
+        cell_loc = get_cell_locator
+        cells = row_obj.find_elements(cell_loc.keys[0], cell_loc.values[0])
+        # return cell in specified column
+        cells[column - 1]
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/data_objects/data_objects_helper.rb

@@ -15,9 +15,7 @@ module TestCentricity
 
 
   class DataObject
-    attr_accessor :current
-    attr_accessor :context
-    attr_accessor :hash_table
+    attr_accessor :current, :context, :hash_table
 
     def initialize(data)
       @hash_table = data
@@ -36,8 +34,7 @@ module TestCentricity
   class DataPresenter
     include Virtus.model
 
-    attr_accessor :current
-    attr_accessor :context
+    attr_accessor :current, :context
 
     def initialize(data)
       self.attributes = data unless data.nil?
@@ -55,8 +52,7 @@ module TestCentricity
 
 # :nocov:
   class DataSource
-    attr_accessor :file_path
-    attr_accessor :node
+    attr_accessor :file_path, :node
 
     def read_yaml_node_data(file_name, node_name)
       @file_path = "#{PRIMARY_DATA_PATH}#{file_name}"