testcentricity_apps 4.0.10

data/lib/testcentricity_apps/exception_queue_helper.rb

@@ -0,0 +1,160 @@
+module TestCentricity
+  class ExceptionQueue
+    attr_accessor :error_queue
+    attr_accessor :active_ui_element
+
+    def self.enqueue_assert_equal(expected, actual, error_message)
+      is_equal = if expected.is_a?(String) && actual.is_a?(String)
+                   expected.downcase.strip == actual.downcase.strip
+                 else
+                   expected == actual
+                 end
+      unless is_equal
+        enqueue("#{error_message} to be\n  '#{expected}'\nbut found\n  '#{actual}'")
+        enqueue_screenshot
+      end
+    end
+
+    def self.enqueue_assert_not_equal(expected, actual, error_message)
+      unless expected != actual
+        enqueue("#{error_message} to not be equal to '#{expected}'")
+        enqueue_screenshot
+      end
+    end
+
+    def self.enqueue_exception(error_message)
+      enqueue(error_message)
+    end
+
+    def self.post_exceptions(preample_message = nil)
+      unless @error_queue.nil?
+        unless preample_message.nil?
+          @error_queue = "#{preample_message} - The following errors were found:\n_____________________________\n#{@error_queue}"
+        end
+        raise @error_queue
+      end
+    ensure
+      @error_queue = nil
+      @active_ui_element = nil
+    end
+
+    def self.enqueue_comparison(ui_object, state, actual, error_msg)
+      @active_ui_element = ui_object
+      if state.is_a?(Hash) && state.length == 1
+        state.each do |key, value|
+          case key
+          when :lt, :less_than
+            enqueue_exception("#{error_msg} be less than #{value} but found '#{actual}'") unless actual < value
+          when :lt_eq, :less_than_or_equal
+            enqueue_exception("#{error_msg} be less than or equal to #{value} but found '#{actual}'") unless actual <= value
+          when :gt, :greater_than
+            enqueue_exception("#{error_msg} be greater than #{value} but found '#{actual}'") unless actual > value
+          when :gt_eq, :greater_than_or_equal
+            enqueue_exception("#{error_msg} be greater than or equal to  #{value} but found '#{actual}'") unless actual >= value
+          when :starts_with
+            enqueue_exception("#{error_msg} start with '#{value}' but found '#{actual}'") unless actual.start_with?(value)
+          when :ends_with
+            enqueue_exception("#{error_msg} end with '#{value}' but found '#{actual}'") unless actual.end_with?(value)
+          when :contains
+            enqueue_exception("#{error_msg} contain '#{value}' but found '#{actual}'") unless actual.include?(value)
+          when :not_contains, :does_not_contain
+            enqueue_exception("#{error_msg} not contain '#{value}' but found '#{actual}'") if actual.include?(value)
+          when :not_equal
+            enqueue_exception("#{error_msg} not equal '#{value}' but found '#{actual}'") if actual == value
+          when :like, :is_like
+            actual_like = actual.delete("\n")
+            actual_like = actual_like.delete("\r")
+            actual_like = actual_like.delete("\t")
+            actual_like = actual_like.delete(' ')
+            actual_like = actual_like.downcase
+            expected    = value.delete("\n")
+            expected    = expected.delete("\r")
+            expected    = expected.delete("\t")
+            expected    = expected.delete(' ')
+            expected    = expected.downcase
+            enqueue_exception("#{error_msg} be like '#{value}' but found '#{actual}'") unless actual_like.include?(expected)
+          when :translate
+            expected = translate(value)
+            enqueue_assert_equal(expected, actual, error_msg)
+          when :translate_upcase
+            expected = translate(value)
+            expected = expected.is_a?(Array) ? expected.map(&:upcase) : expected.upcase
+            enqueue_assert_equal(expected, actual, error_msg)
+          when :translate_downcase
+            expected = translate(value)
+            expected = expected.is_a?(Array) ? expected.map(&:downcase) : expected.downcase
+            enqueue_assert_equal(expected, actual, error_msg)
+          when :translate_capitalize
+            expected = translate(value)
+            expected = expected.is_a?(Array) ? expected.map(&:capitalize) : expected.capitalize
+            enqueue_assert_equal(expected, actual, error_msg)
+          when :translate_titlecase
+            expected = translate(value)
+            expected = if expected.is_a?(Array)
+                         result = []
+                         expected.each do |item|
+                           result.push("#{item.split.each{ |item| item.capitalize! }.join(' ')}")
+                         end
+                         result
+                       else
+                         "#{expected.split.each{ |expected| expected.capitalize! }.join(' ')}"
+                       end
+            enqueue_assert_equal(expected, actual, error_msg)
+          else
+            raise "#{key} is not a valid comparison key"
+          end
+        end
+      else
+        enqueue_assert_equal(state, actual, error_msg)
+      end
+    end
+
+    private
+
+    def self.enqueue(message)
+      @error_queue = "#{@error_queue}#{message}\n\n"
+    end
+
+    def self.enqueue_screenshot
+      timestamp = Time.now.strftime('%Y%m%d%H%M%S%L')
+      filename = "Screenshot-#{timestamp}.png"
+      path = File.join Dir.pwd, 'reports/screenshots/', filename
+      # take screenshot
+      AppiumConnect.take_screenshot(path)
+      # add screenshot to queue
+      puts "Screenshot saved at #{path}"
+      screen_shot = {path: path, filename: filename}
+      Environ.save_screen_shot(screen_shot)
+    end
+
+    def self.translate(*args, **opts)
+      opts[:locale] ||= I18n.locale
+      opts[:raise] = true
+      I18n.translate(*args, **opts)
+    rescue I18n::MissingTranslationData => err
+      puts err
+      opts[:locale] = :en
+
+      # fallback to en if the translation is missing. If the translation isn't
+      # in en, then raise again.
+      disable_enforce_available_locales do
+        I18n.translate(*args, **opts)
+      end
+    end
+
+    def self.disable_enforce_available_locales
+      saved_enforce_available_locales = I18n.enforce_available_locales
+      I18n.enforce_available_locales = false
+      yield
+    ensure
+      I18n.enforce_available_locales = saved_enforce_available_locales
+    end
+  end
+
+
+  class ObjectNotFoundError < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/testcentricity_apps/utility_helpers.rb

@@ -0,0 +1,48 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+
+  def boolean?
+    [true, false].include? self
+  end
+end
+
+
+class String
+  def to_bool
+    return true if self == true || self =~ (/(true|t|yes|y|x|1)$/i)
+    return false if self == false || self.blank? || self =~ (/(false|f|no|n|0)$/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+
+  def string_between(marker1, marker2)
+    self[/#{Regexp.escape(marker1)}(.*?)#{Regexp.escape(marker2)}/m, 1]
+  end
+
+  def format_date_time(date_time_format)
+    return if self.blank?
+    new_date = DateTime.parse(self)
+    if ENV['LOCALE'] && date_time_format.is_a?(Symbol)
+      I18n.l(new_date, format: date_time_format)
+    else
+      new_date.strftime(date_time_format)
+    end
+  end
+
+  def titlecase
+    "#{self.split.each{ |text| text.capitalize! }.join(' ')}"
+  end
+
+  def is_int?
+    Integer(self) && true rescue false
+  end
+
+  def is_float?
+    Float(self) && true rescue false
+  end
+end

data/lib/testcentricity_apps/version.rb

@@ -0,0 +1,3 @@
+module TestCentricityApps
+  VERSION = '4.0.10'
+end

data/lib/testcentricity_apps/world_extensions.rb

@@ -0,0 +1,61 @@
+module WorldData
+  def environs
+    @environs ||= TestCentricity::EnvironData
+  end
+
+  # instantiate and register all data objects specified in data_objects method
+  #
+  def instantiate_data_objects
+    # return if data objects have already been instantiated and registered
+    return if TestCentricity::DataManager.loaded?
+
+    # instantiate all data objects
+    @data = {}
+    data_objects.each do |data_type, data_class|
+      @data[data_type] = data_class.new unless @data.has_key?(data_type)
+      # define data object accessor method
+      define_method(data_type) do
+        if instance_variable_defined?(:"@#{data_type}")
+          instance_variable_get(:"@#{data_type}")
+        else
+          instance_variable_set(:"@#{data_type}", TestCentricity::DataManager.find_data_object(data_type))
+        end
+      end
+    end
+    # register all data objects with DataManager
+    TestCentricity::DataManager.register_data_objects(@data)
+  end
+end
+
+
+module WorldScreens
+  # instantiate and register all screen objects specified in screen_objects method
+  #
+  def instantiate_screen_objects
+    # return if screen objects have already been instantiated and registered
+    return if TestCentricity::ScreenManager.loaded?
+
+    # instantiate all screen objects
+    @screens = {}
+    screen_objects.each do |screen_object, screen_class|
+      obj = screen_class.new
+      @screens[screen_object] = obj unless @screens.has_key?(screen_object)
+      screen_names = obj.screen_name
+      screen_names = Array(screen_names) if screen_names.is_a? String
+      screen_names.each do |name|
+        screen_key = name.gsub(/\s+/, '').downcase.to_sym
+        @screens[screen_key] = obj unless @screens.has_key?(screen_key)
+      end
+      # define screen object accessor method
+      define_method(screen_object) do
+        if instance_variable_defined?(:"@#{screen_object}")
+          instance_variable_get(:"@#{screen_object}")
+        else
+          instance_variable_set(:"@#{screen_object}", TestCentricity::ScreenManager.find_screen(screen_object))
+        end
+      end
+    end
+    # register all screen objects with ScreenManager
+    TestCentricity::ScreenManager.register_screen_objects(@screens)
+  end
+end

data/lib/testcentricity_apps.rb

@@ -0,0 +1,103 @@
+require 'test/unit'
+require 'appium_lib'
+
+require 'testcentricity_apps/version'
+require 'testcentricity_apps/world_extensions'
+require 'testcentricity_apps/exception_queue_helper'
+require 'testcentricity_apps/utility_helpers'
+require 'testcentricity_apps/appium_server'
+
+require 'testcentricity_apps/data_objects/data_objects_helper'
+require 'testcentricity_apps/data_objects/environment'
+
+require 'testcentricity_apps/app_core/appium_connect_helper'
+require 'testcentricity_apps/app_core/screen_objects_helper'
+require 'testcentricity_apps/app_core/screen_object'
+require 'testcentricity_apps/app_core/screen_section'
+
+require 'testcentricity_apps/app_elements/app_element'
+require 'testcentricity_apps/app_elements/alert'
+require 'testcentricity_apps/app_elements/button'
+require 'testcentricity_apps/app_elements/checkbox'
+require 'testcentricity_apps/app_elements/image'
+require 'testcentricity_apps/app_elements/label'
+require 'testcentricity_apps/app_elements/list'
+require 'testcentricity_apps/app_elements/menu'
+require 'testcentricity_apps/app_elements/menubar'
+require 'testcentricity_apps/app_elements/radio'
+require 'testcentricity_apps/app_elements/selectlist'
+require 'testcentricity_apps/app_elements/switch'
+require 'testcentricity_apps/app_elements/textfield'
+
+
+module TestCentricity
+  class ScreenManager
+    attr_accessor :current_screen
+
+    @screen_objects = {}
+
+    def self.register_screen_objects(screens)
+      @screen_objects = screens
+    end
+
+    # Have all ScreenObjects been registered?
+    #
+    # @return [Boolean] true if all ScreenObjects have been registered
+    # @example
+    #   TestCentricity::ScreenManager.loaded?
+    #
+    def self.loaded?
+      !@screen_objects.empty?
+    end
+
+    def self.find_screen(screen_name)
+      screen_id = (screen_name.is_a? String) ? screen_name.gsub(/\s+/, '').downcase.to_sym : screen_name
+      screen = @screen_objects[screen_id]
+      raise "No screen object defined for screen named '#{screen_name}'" unless screen
+      screen
+    end
+
+    # Get the currently active ScreenObject
+    #
+    # @return [ScreenObject]
+    # @example
+    #   active_screen = TestCentricity::ScreenManager.current_screen
+    #
+    def self.current_screen
+      @current_screen
+    end
+
+    # Sets the currently active ScreenObject
+    #
+    # @param screen [ScreenObject] Reference to the active ScreenObject
+    # @example
+    #   TestCentricity::ScreenManager.current_screen = product_search_screen
+    #
+    def self.current_screen=(screen)
+      @current_screen = screen
+    end
+  end
+
+
+  class DataManager
+    @data_objects = {}
+
+    def self.register_data_objects(data)
+      @data_objects = data
+    end
+
+    def self.find_data_object(data_object)
+      @data_objects[data_object]
+    end
+
+    # Have all DataObjects been registered?
+    #
+    # @return [Boolean] true if all DataObjects have been registered
+    # @example
+    #   TestCentricity::DataManager.loaded?
+    #
+    def self.loaded?
+      !@data_objects.empty?
+    end
+  end
+end

metadata

@@ -0,0 +1,322 @@
+--- !ruby/object:Gem::Specification
+name: testcentricity_apps
+version: !ruby/object:Gem::Version
+  version: 4.0.10
+platform: ruby
+authors:
+- A.J. Mrozinski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: appium_lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 15.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 15.1.0
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.22.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2-
+
+      The TestCentricity™ For Apps core framework for MacOS desktop app and iOS and Android mobile app testing implements a
+      Screen Object Model DSL for use with Cucumber or RSpec and Appium 2.x. The gem also facilitates the configuration of
+      the appropriate Appium capabilities required to establish a connection with locally hosted MacOS apps or locally or
+      cloud hosted iOS or Android devices or simulators (using BrowserStack, Sauce Labs, or TestingBot services).
+email:
+- testcentricity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/testcentricity_apps.rb
+- lib/testcentricity_apps/app_core/appium_connect_helper.rb
+- lib/testcentricity_apps/app_core/screen_object.rb
+- lib/testcentricity_apps/app_core/screen_objects_helper.rb
+- lib/testcentricity_apps/app_core/screen_section.rb
+- lib/testcentricity_apps/app_elements/alert.rb
+- lib/testcentricity_apps/app_elements/app_element.rb
+- lib/testcentricity_apps/app_elements/button.rb
+- lib/testcentricity_apps/app_elements/checkbox.rb
+- lib/testcentricity_apps/app_elements/image.rb
+- lib/testcentricity_apps/app_elements/label.rb
+- lib/testcentricity_apps/app_elements/list.rb
+- lib/testcentricity_apps/app_elements/menu.rb
+- lib/testcentricity_apps/app_elements/menubar.rb
+- lib/testcentricity_apps/app_elements/radio.rb
+- lib/testcentricity_apps/app_elements/selectlist.rb
+- lib/testcentricity_apps/app_elements/switch.rb
+- lib/testcentricity_apps/app_elements/textfield.rb
+- lib/testcentricity_apps/appium_server.rb
+- lib/testcentricity_apps/data_objects/data_objects_helper.rb
+- lib/testcentricity_apps/data_objects/environment.rb
+- lib/testcentricity_apps/exception_queue_helper.rb
+- lib/testcentricity_apps/utility_helpers.rb
+- lib/testcentricity_apps/version.rb
+- lib/testcentricity_apps/world_extensions.rb
+homepage: https://github.com/TestCentricity/testcentricity_apps
+licenses:
+- BSD-3-Clause
+metadata:
+  changelog_uri: https://github.com/TestCentricity/testcentricity_apps/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/TestCentricity/testcentricity_apps/issues
+  wiki_uri: https://github.com/TestCentricity/testcentricity_apps/wiki
+  documentation_uri: https://www.rubydoc.info/gems/testcentricity_apps
+  homepage_uri: https://github.com/TestCentricity/testcentricity_apps
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Appium
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A Screen Object Model Framework for MacOS desktop app and iOS and/or Android
+  mobile app testing
+test_files: []