testcentricity_apps 4.0.10

data/lib/testcentricity_apps/app_elements/button.rb

@@ -0,0 +1,10 @@
+module TestCentricity
+  module AppElements
+    class AppButton < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :button
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/checkbox.rb

@@ -0,0 +1,61 @@
+module TestCentricity
+  module AppElements
+    class AppCheckBox < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :checkbox
+      end
+
+      # Is checkbox checked?
+      #
+      # @return [Boolean]
+      # @example
+      #   remember_me_checkbox.checked?
+      #
+      def checked?
+        obj = element
+        object_not_found_exception(obj)
+        if Environ.is_macos?
+          state = obj.value
+          state.to_bool
+        else
+          obj.selected?
+        end
+      end
+
+      # Set the check state of a checkbox object.
+      #
+      # @example
+      #   remember_me_checkbox.check
+      #
+      def check
+        set_checkbox_state(true)
+      end
+
+      # Uncheck a checkbox object.
+      #
+      # @example
+      #   remember_me_checkbox.uncheck
+      #
+      def uncheck
+        set_checkbox_state(false)
+      end
+
+      # Set the check state of a checkbox object.
+      #
+      # @param state [Boolean] true = checked / false = unchecked
+      # @example
+      #   remember_me_checkbox.set_checkbox_state(true)
+      #
+      def set_checkbox_state(state)
+        obj = element
+        object_not_found_exception(obj)
+        if state
+          obj.click unless obj.selected?
+        else
+          obj.click if obj.selected?
+        end
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/image.rb

@@ -0,0 +1,10 @@
+module TestCentricity
+  module AppElements
+    class AppImage < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :image
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/label.rb

@@ -0,0 +1,10 @@
+module TestCentricity
+  module AppElements
+    class AppLabel < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :label
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/list.rb

@@ -0,0 +1,188 @@
+module TestCentricity
+  module AppElements
+    class AppList < AppUIElement
+      attr_accessor :list_item
+      attr_accessor :scrolling
+      attr_accessor :item_objects
+
+      def initialize(name, parent, locator, context)
+        super
+        @type = :list
+        @item_objects = nil
+        @scrolling = :vertical
+        @list_item = case Environ.device_os
+                     when :ios, :mac
+                       { class: 'XCUIElementTypeOther' }
+                     when :android
+                       { class: 'android.view.ViewGroup' }
+                     else
+                       nil
+                     end
+      end
+
+      def define_list_elements(element_spec)
+        element_spec.each do |element, value|
+          case element
+          when :list_item
+            @list_item = value
+          when :scrolling
+            @scrolling = value
+          else
+            raise "#{element} is not a recognized list element"
+          end
+        end
+      end
+
+      def scroll_mode
+        obj = element
+        object_not_found_exception(obj)
+        @scrolling
+      end
+
+      def item_refs
+        obj = element
+        object_not_found_exception(obj)
+        @item_objects
+      end
+
+      # Return the number of items in a list object.
+      #
+      # @return [Integer]
+      # @example
+      #   num_nav_items = nav_list.get_item_count
+      #
+      def get_item_count
+        obj = element
+        object_not_found_exception(obj)
+        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?
+          start_count = items.count
+          direction = @scrolling == :horizontal ? :right : :down
+          scroll_count = 0
+          loop do
+            save_count = items.count
+            swipe_gesture(direction)
+            scroll_count += 1
+            obj.find_elements(list_loc.keys[0], list_loc.values[0]).each do |item|
+              items.push(item) unless items.include?(item)
+            end
+            break if items.count == save_count
+          end
+          direction = @scrolling == :horizontal ? :left : :up
+          scroll_count.times do
+            swipe_gesture(direction)
+          end
+        end
+        @item_objects = items if Environ.is_android? && start_count < items.count
+        items.count
+      end
+
+      # Return array of strings of all items in a list object.
+      #
+      # @return [Array]
+      # @example
+      #   nav_items = nav_list.get_options
+      #
+      def get_list_items
+        list_items = []
+        obj = element
+        object_not_found_exception(obj)
+        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|
+          list_items.push(item.text)
+        end
+        list_items
+      end
+
+      def get_list_item(index)
+        items = get_list_items
+        items[index - 1]
+      end
+
+      # Select the specified item in a list object. Accepts a String or Integer.
+      #
+      # @param item [String, Integer] text or index of item to select
+      #
+      # @example
+      #   province_list.choose_item(2)
+      #   province_list.choose_item('Manitoba')
+      #
+      def choose_item(item)
+        obj = element
+        object_not_found_exception(obj)
+        if Environ.is_ios? && obj.attribute(:type) == 'XCUIElementTypePickerWheel'
+          obj.send_keys(item)
+        else
+          list_loc = get_list_item_locator
+          items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
+          if item.is_a?(Integer)
+            items[item - 1].click
+          else
+            items.each do |list_item|
+              if list_item.text == item
+                list_item.click
+                break
+              end
+            end
+          end
+        end
+      end
+
+      # Wait until the list's item_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
+      #   search_results_list.wait_until_item_count_is(10, 15)
+      #     or
+      #   search_results_list.wait_until_item_count_is({ :greater_than_or_equal => 1 }, 5)
+      #
+      def wait_until_item_count_is(value, seconds = nil)
+        timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+        wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+        wait.until { compare(value, get_item_count) }
+      rescue
+        raise "Value of List #{object_ref_message} failed to equal '#{value}' after #{timeout} seconds" unless get_item_count == value
+      end
+
+      # Wait until the list's item_count changes, 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
+      #   search_results_list.wait_until_item_count_changes(10)
+      #
+      def wait_until_item_count_changes(seconds = nil)
+        value = get_item_count
+        timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+        wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+        wait.until { get_item_count != value }
+      rescue
+        raise "Value of List #{object_ref_message} failed to change from '#{value}' after #{timeout} seconds" if get_item_count == value
+      end
+
+      private
+
+      def get_list_item_locator
+        if @list_item.nil?
+          case Environ.device_os
+          when :ios, :mac
+            define_list_elements({ :list_item => { class: 'XCUIElementTypeOther' } } )
+          when :android
+            define_list_elements({ :list_item => { class: 'android.view.ViewGroup' } } )
+          end
+        end
+        @list_item
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/menu.rb

@@ -0,0 +1,159 @@
+module TestCentricity
+  module AppElements
+    class AppMenu < AppUIElement
+      attr_accessor :menu_item
+      attr_accessor :key_map
+
+      def initialize(name, parent, locator, context)
+        super
+        @type = :menu
+        @menu_item = { class: 'XCUIElementTypeMenuItem' }
+        @key_map = nil
+      end
+
+      def define_menu_elements(element_spec)
+        element_spec.each do |element, value|
+          case element
+          when :menu_item
+            @menu_item = value
+          when :key_map
+            @key_map = value
+          else
+            raise "#{element} is not a recognized menu element"
+          end
+        end
+      end
+
+      # Return the number of menu items in a menu object.
+      #
+      # @return [Integer]
+      # @example
+      #   num_menu_items = view_menu.get_item_count
+      #
+      def get_item_count
+        obj = element
+        object_not_found_exception(obj)
+        menu_loc = get_menu_item_locator
+        items = obj.find_elements(menu_loc.keys[0], menu_loc.values[0])
+        items.count
+      end
+
+      # Return array of strings of all menu item captions in a menu object.
+      #
+      # @return [Array]
+      # @example
+      #   view_items = view_menu.get_menu_items
+      #
+      def get_menu_items
+        menu_items = []
+        obj = element
+        object_not_found_exception(obj)
+        menu_loc = get_menu_item_locator
+        items = obj.find_elements(menu_loc.keys[0], menu_loc.values[0])
+        items.each do |item|
+          menu_items.push(item.text)
+        end
+        menu_items
+      end
+
+      alias get_list_items get_menu_items
+
+      # Return text caption of menu item at specified index.
+      #
+      # @return [String]
+      # @example
+      #   menu_item_text = view_menu.get_menu_item(3)
+      #
+      def get_menu_item(index)
+        items = get_menu_items
+        items[index - 1]
+      end
+
+      alias get_list_item get_menu_item
+
+      def get_item_data(index = nil)
+        menu_items = []
+        obj = element
+        object_not_found_exception(obj)
+        menu_loc = get_menu_item_locator
+        items = obj.find_elements(menu_loc.keys[0], menu_loc.values[0])
+        items.each do |item|
+          caption = item.text
+          state = item.enabled?
+          menu_items.push(
+            {
+              caption: caption,
+              enabled: state
+            }
+          )
+        end
+        if index.nil?
+          menu_items
+        else
+          menu_items[index - 1]
+        end
+      end
+
+      # Return enabled state of menu item at specified index.
+      #
+      # @return [Boolean]
+      # @example
+      #   menu_item_status = view_menu.get_item_enabled(3)
+      #
+      def get_item_enabled(index)
+        obj = element
+        object_not_found_exception(obj)
+        menu_loc = get_menu_item_locator
+        items = obj.find_elements(menu_loc.keys[0], menu_loc.values[0])
+        items[index - 1].enabled?
+      end
+
+      # Select the specified menu item in a menu object using the specified selection method (mouse or keyboard shortcut).
+      # Accepts a String or Integer representing either the menu item caption or item index.
+      #
+      # @param item [String, Integer] menu item text or index of menu item to select
+      # @param method [Symbol] valid selectors are :mouse, :keys, or :keyboard (default = :mouse)
+      #
+      # @example
+      #   view_menu.choose_menu_item(2)
+      #   view_menu.choose_menu_item('Programmer')
+      #
+      def choose_menu_item(item, method = :mouse)
+        obj = element
+        object_not_found_exception(obj)
+        case method
+        when :mouse
+          self.click unless self.visible?
+          menu_loc = get_menu_item_locator
+          items = obj.find_elements(menu_loc.keys[0], menu_loc.values[0])
+          case
+          when item == :last
+            items.last.click
+          when item.is_a?(Integer)
+            items[item - 1].click
+          else
+            items.each do |list_item|
+              if list_item.text == item
+                list_item.click
+                break
+              end
+            end
+          end
+        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"
+        end
+      end
+
+      private
+
+      def get_menu_item_locator
+        define_menu_elements({ :menu_item => { class: 'XCUIElementTypeMenuItem' } }) if @menu_item.nil?
+        @menu_item
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/menubar.rb

@@ -0,0 +1,78 @@
+module TestCentricity
+  class MenuBar < TestCentricity::ScreenSection
+    trait(:section_name)    { 'Menu Bar' }
+    trait(:section_locator) { { class_chain: '**/XCUIElementTypeMenuBar' } }
+
+    # Menu Bar UI elements
+    list :menu_list, { xpath: '//XCUIElementTypeMenuBar' }
+
+    def initialize(name, parent, locator, context)
+      super
+      @parent = nil
+      # define the menu bar item element for the menu bar list object
+      list_elements = { list_item: { xpath: '(//XCUIElementTypeMenuBarItem)' } }
+      menu_list.define_list_elements(list_elements)
+    end
+
+    def get_object_type
+      :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]
+    # @example
+    #   num_menus = menu_bar.get_item_count
+    #
+    def get_item_count
+      menu_list.get_item_count
+    end
+
+    # Return array of strings of all menus in a MenuBar object.
+    #
+    # @return [Array]
+    # @example
+    #   menu_items = menu_bar.get_menubar_items
+    #
+    def get_menubar_items
+      menu_list.get_list_items
+    end
+
+    alias get_list_items get_menubar_items
+
+    # Return text caption of menu item at specified index.
+    #
+    # @return [String]
+    # @example
+    #   menubar_item_text = menu_bar.get_menubar_item(3)
+    #
+    def get_menubar_item(index)
+      items = get_list_items
+      items[index - 1]
+    end
+
+    alias get_list_item get_menubar_item
+  end
+end

data/lib/testcentricity_apps/app_elements/radio.rb

@@ -0,0 +1,61 @@
+module TestCentricity
+  module AppElements
+    class AppRadio < AppUIElement
+      def initialize(name, parent, locator, context)
+        super
+        @type = :radio
+      end
+
+      # Is radio selected?
+      #
+      # @return [Boolean]
+      # @example
+      #   unicode_radio.selected?
+      #
+      def selected?
+        obj = element
+        object_not_found_exception(obj)
+        if Environ.is_macos?
+          state = obj.value
+          state.to_bool
+        else
+          obj.selected?
+        end
+      end
+
+      # Set the selected state of a radio button object.
+      #
+      # @example
+      #   unicode_radio.select
+      #
+      def select
+        set_selected_state(true)
+      end
+
+      # Unselect a radio button object.
+      #
+      # @example
+      #   unicode_radio.unselect
+      #
+      def unselect
+        set_selected_state(false)
+      end
+
+      # Set the selected state of a radio button object.
+      #
+      # @param state [Boolean] true = selected / false = unselected
+      # @example
+      #   ascii_radio.set_selected_state(true)
+      #
+      def set_selected_state(state)
+        obj = element
+        object_not_found_exception(obj)
+        if state
+          obj.click unless obj.selected?
+        else
+          obj.click if obj.selected?
+        end
+      end
+    end
+  end
+end

data/lib/testcentricity_apps/app_elements/selectlist.rb

@@ -0,0 +1,126 @@
+module TestCentricity
+  module AppElements
+    class AppSelectList < AppUIElement
+      attr_accessor :list_item
+
+      def initialize(name, parent, locator, context)
+        super
+        @type = :selectlist
+        @list_item = case Environ.device_os
+                     when :mac
+                       { class: 'XCUIElementTypeMenuItem' }
+                     when :ios
+                       { class: 'XCUIElementTypeOther' }
+                     when :android
+                       { class: 'android.view.ViewGroup' }
+                     else
+                       nil
+                     end
+      end
+
+      def define_list_elements(element_spec)
+        element_spec.each do |element, value|
+          case element
+          when :list_item
+            @list_item = value
+          else
+            raise "#{element} is not a recognized selectlist element"
+          end
+        end
+      end
+
+      # Return the number of items in a list object.
+      #
+      # @return [Integer]
+      # @example
+      #   num_convert_items = convert_list.get_list_items
+      #
+      def get_item_count
+        obj = element
+        object_not_found_exception(obj)
+        if Environ.is_ios? && obj.attribute(:type) == 'XCUIElementTypePickerWheel'
+          raise 'This method is not supported for XCUIElementTypePickerWheel controls'
+        end
+        list_loc = get_list_item_locator
+        self.click if Environ.is_macos?
+        items = obj.find_elements(list_loc.keys[0], list_loc.values[0])
+        self.click if Environ.is_macos?
+        items.count
+      end
+
+      # Return array of strings of all items in a selectlist object.
+      #
+      # @return [Array]
+      # @example
+      #   convert_items = convert_list.get_list_items
+      #
+      def get_list_items
+        list_items = []
+        obj = element
+        object_not_found_exception(obj)
+        if Environ.is_ios? && obj.attribute(:type) == 'XCUIElementTypePickerWheel'
+          raise 'This method is not supported for XCUIElementTypePickerWheel controls'
+        end
+        list_loc = get_list_item_locator
+        self.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?
+        list_items
+      end
+
+      def get_list_item(index)
+        items = get_list_items
+        items[index - 1]
+      end
+
+      # Select the specified item in a selectlist object. Accepts a String or Integer.
+      #
+      # @param item [String, Integer] text or index of item to select
+      #
+      # @example
+      #   convert_list.choose_item(2)
+      #   convert_list.choose_item('Power')
+      #
+      def choose_item(item)
+        obj = element
+        object_not_found_exception(obj)
+        if Environ.is_ios? && obj.attribute(:type) == 'XCUIElementTypePickerWheel'
+          obj.send_keys(item)
+        else
+          list_loc = get_list_item_locator
+          self.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
+          else
+            items.each do |list_item|
+              if list_item.text == item
+                list_item.click
+                break
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def get_list_item_locator
+        if @list_item.nil?
+          case Environ.device_os
+          when :mac
+            define_list_elements({ :list_item => { class: 'XCUIElementTypeMenuItem' } } )
+          when :ios
+            define_list_elements({ :list_item => { class: 'XCUIElementTypeOther' } } )
+          when :android
+            define_list_elements({ :list_item => { class: 'android.view.ViewGroup' } } )
+          end
+        end
+        @list_item
+      end
+    end
+  end
+end