appium_lib_core 4.1.0 → 5.6.0

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '4.1.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-12-25' unless defined? ::Appium::Core::DATE
+    VERSION = '5.6.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2022-11-08' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -17,23 +17,29 @@ require 'selenium-webdriver'
 require_relative 'appium_lib_core/version'
 require_relative 'appium_lib_core/common'
 require_relative 'appium_lib_core/driver'
-
 require_relative 'appium_lib_core/device'
-
-# Call patch after requiring other files
-require_relative 'appium_lib_core/patch'
+require_relative 'appium_lib_core/element'
 
 module Appium
-  # convert all keys (including nested) to symbols
+  # @private
+  #
+  # convert the top level keys to symbols.
   #
-  # based on deep_symbolize_keys & deep_transform_keys from rails
-  # https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84
   # @param [Hash] hash Hash value to make symbolise
-  def self.symbolize_keys(hash)
-    raise ArgumentError, 'symbolize_keys requires a hash' unless hash.is_a? Hash
+  def self.symbolize_keys(hash, nested: false, enable_deprecation_msg: true)
+    # FIXME: As https://github.com/appium/ruby_lib/issues/945, we must remove this implicit string to symbol.
+    # But appium_lib_core's some capability handling expect to be symbol, so we should test to remove
+    # the mehotds which expect the symbol first.
+    raise ::Appium::Core::Error::ArgumentError, 'symbolize_keys requires a hash' unless hash.is_a? Hash
 
     hash.each_with_object({}) do |pair, acc|
       key = begin
+        if enable_deprecation_msg && !(pair[0].is_a? Symbol)
+          ::Appium::Logger.warn("[Deprecation] The key '#{pair[0]}' must be a symbol while currently it " \
+                                "is #{pair[0].class.name}. Please define the key as a Symbol. " \
+                                'Converting it to Symbol for now.')
+        end
+
         pair[0].to_sym
       rescue StandardError => e
         ::Appium::Logger.warn(e.message)
@@ -41,7 +47,11 @@ module Appium
       end
 
       value = pair[1]
-      acc[key] = value.is_a?(Hash) ? symbolize_keys(value) : value
+      acc[key] = if nested
+                   value.is_a?(Hash) ? symbolize_keys(value, nested: false, enable_deprecation_msg: false) : value
+                 else
+                   value
+                 end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-26 00:00:00.000000000 Z
+date: 2022-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
-    - - ">="
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.14.1
+        version: '4.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
-    - - ">="
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.14.1
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +106,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.18.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.38.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -156,34 +142,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: pry-byebug
-  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: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -219,12 +177,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE/issue-report.md"
-- ".github/contributing.md"
-- ".github/issue_template.md"
-- ".github/workflows/unittest.yml"
-- ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -232,16 +184,8 @@ files:
 - Rakefile
 - Thorfile
 - appium_lib_core.gemspec
-- azure-pipelines.yml
 - bin/console
 - bin/setup
-- ci-jobs/functional/android_setup.yml
-- ci-jobs/functional/ios_setup.yml
-- ci-jobs/functional/publish_test_result.yml
-- ci-jobs/functional/run_appium.yml
-- ci-jobs/functional/start-emulator.sh
-- ci-jobs/functional_test.yml
-- docs/mobile_command.md
 - lib/appium_lib_core.rb
 - lib/appium_lib_core/android.rb
 - lib/appium_lib_core/android/device.rb
@@ -261,19 +205,19 @@ files:
 - lib/appium_lib_core/common.rb
 - lib/appium_lib_core/common/base.rb
 - lib/appium_lib_core/common/base/bridge.rb
-- lib/appium_lib_core/common/base/bridge/mjsonwp.rb
-- lib/appium_lib_core/common/base/bridge/w3c.rb
 - lib/appium_lib_core/common/base/capabilities.rb
-- lib/appium_lib_core/common/base/command.rb
+- lib/appium_lib_core/common/base/device_ime.rb
 - lib/appium_lib_core/common/base/driver.rb
+- lib/appium_lib_core/common/base/driver_settings.rb
+- lib/appium_lib_core/common/base/has_location.rb
+- lib/appium_lib_core/common/base/has_network_connection.rb
 - lib/appium_lib_core/common/base/http_default.rb
 - lib/appium_lib_core/common/base/platform.rb
+- lib/appium_lib_core/common/base/remote_status.rb
+- lib/appium_lib_core/common/base/rotable.rb
 - lib/appium_lib_core/common/base/screenshot.rb
 - lib/appium_lib_core/common/base/search_context.rb
 - lib/appium_lib_core/common/command.rb
-- lib/appium_lib_core/common/command/common.rb
-- lib/appium_lib_core/common/command/mjsonwp.rb
-- lib/appium_lib_core/common/command/w3c.rb
 - lib/appium_lib_core/common/device/app_management.rb
 - lib/appium_lib_core/common/device/app_state.rb
 - lib/appium_lib_core/common/device/battery_status.rb
@@ -287,6 +231,7 @@ files:
 - lib/appium_lib_core/common/device/ime_actions.rb
 - lib/appium_lib_core/common/device/keyboard.rb
 - lib/appium_lib_core/common/device/keyevent.rb
+- lib/appium_lib_core/common/device/orientation.rb
 - lib/appium_lib_core/common/device/screen_record.rb
 - lib/appium_lib_core/common/device/setting.rb
 - lib/appium_lib_core/common/device/touch_actions.rb
@@ -301,6 +246,7 @@ files:
 - lib/appium_lib_core/common/ws/websocket.rb
 - lib/appium_lib_core/device.rb
 - lib/appium_lib_core/driver.rb
+- lib/appium_lib_core/element.rb
 - lib/appium_lib_core/ios.rb
 - lib/appium_lib_core/ios/device.rb
 - lib/appium_lib_core/ios/device/clipboard.rb
@@ -313,19 +259,20 @@ files:
 - lib/appium_lib_core/ios/xcuitest/device/performance.rb
 - lib/appium_lib_core/ios/xcuitest/device/screen.rb
 - lib/appium_lib_core/ios_xcuitest.rb
-- lib/appium_lib_core/patch.rb
+- lib/appium_lib_core/mac2.rb
+- lib/appium_lib_core/mac2/bridge.rb
+- lib/appium_lib_core/mac2/device.rb
+- lib/appium_lib_core/mac2/device/screen.rb
 - lib/appium_lib_core/version.rb
 - lib/appium_lib_core/windows.rb
 - lib/appium_lib_core/windows/bridge.rb
 - lib/appium_lib_core/windows/device.rb
 - lib/appium_lib_core/windows/device/screen.rb
-- release_notes.md
-- script/commands.rb
 homepage: https://github.com/appium/ruby_lib_core/
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -333,15 +280,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Minimal Ruby library for Appium.
 test_files: []

data/.github/ISSUE_TEMPLATE/issue-report.md

@@ -1,29 +0,0 @@
----
-name: issue report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-## This is a
-* [ ] Bug report
-* [ ] Question
-* [ ] Feature Request
-
-## Summary
-
-## Environment
-* `ruby_lib_core` version:
-* Mobile platform/version/device under test:
-
-## Actual behaviour and steps to reproduce
-
-## Expected behaviour
-
-## Link to Appium/Ruby logs
-
-Create a [GIST](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here. 
-
-## Any additional comments

data/.github/contributing.md

@@ -1,26 +0,0 @@
-# Contributing
-
-For features or bug fixes, please submit a pull request. Ideally there would be a test as well. The remainder of this doc details how to run the tests.
-
-## Tests
-### Unit Tests
-- `rake test:unit` run on Travis automatically
-
-### Functional Tests
-- iOS
-    - `rake test:func:ios`
-- Android
-    - `rake test:func:android`
-
-## Merge
-- Squash and merge when we merge PRs to the master
-
-## Publishing on rubygems
-
-0. Ensure you have `~/.gem/credentials` If not run [the following command](http://guides.rubygems.org/make-your-own-gem/) (replace username with your rubygems user)
-> $ curl -u username https://rubygems.org/api/v1/api_key.yaml >
-~/.gem/credentials; chmod 0600 ~/.gem/credentials
-
-1. Bump the version number `thor bump`
-2. Generate release note, build and publish gem with `thor release`
-3. Update `changelog.md`

data/.github/issue_template.md

@@ -1,20 +0,0 @@
-## This is a
-* [ ] Bug report
-* [ ] Question
-* [ ] Feature Request
-
-## Summary
-
-## Environment
-* `ruby_lib_core` version:
-* Mobile platform/version/device under test:
-
-## Actual behaviour and steps to reproduce
-
-## Expected behaviour
-
-## Link to Appium/Ruby logs
-
-Create a [GIST](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here. 
-
-## Any additional comments

data/.github/workflows/unittest.yml

@@ -1,68 +0,0 @@
-name: Runs lint and unit tests
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
-
-    runs-on: ubuntu-latest
-
-    env:
-      UNIT_TEST: true
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run tests
-      run: |
-        bundle exec rake rubocop
-        bundle exec parallel_test test/unit/ -n 4
-        AUTOMATION_NAME_DROID=espresso bundle exec parallel_test test/unit/android -n 4
-        AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec parallel_test test/unit -n 4
-
-  test-win:
-    strategy:
-      fail-fast: false
-      matrix:
-        # Does not add 2.7 on Windows so far since a command fails only on Windows
-        ruby: [2.4, 2.5, 2.6]
-
-    runs-on: windows-latest
-
-    env:
-      UNIT_TEST: true
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Install dependencies
-        run: |
-          gem install ffi
-          bundle install
-          gem uninstall --force eventmachine && gem install eventmachine --platform ruby
-      - name: Run tests
-        run: |
-          parallel_test test/unit/ -n 4
-
-          setx AUTOMATION_NAME_DROID espresso
-          parallel_test test/unit/android -n 4
-
-          setx AUTOMATION_NAME_DROID appium
-          setx AUTOMATION_NAME_IOS appium
-          parallel_test test/unit -n 4

data/.gitignore

@@ -1,18 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/docs/
-/pkg/
-/spec/reports/
-/tmp/
-
-# for Mac
-.DS_Store
-
-# for IDE
-.idea
-
-.coverage

data/.rubocop.yml

@@ -1,58 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.4
-Layout/LineLength:
-  Max: 128
-Layout/RescueEnsureAlignment:
-  Enabled: false
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: false
-Layout/EmptyLineBetweenDefs:
-  Enabled: false
-Layout/HashAlignment:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Max: 14
-Metrics/PerceivedComplexity:
-  Max: 14
-Metrics/ParameterLists:
-  Enabled: false
-Lint/NestedMethodDefinition:
-  Enabled: false
-Style/ZeroLengthPredicate:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/CommentedKeyword:
-  Enabled: false
-Style/PercentLiteralDelimiters:
-  Enabled: false
-Style/SymbolArray:
-  Enabled: false
-Style/UnpackFirst:
-  Enabled: false
-Naming/AccessorMethodName:
-  Enabled: false
-Naming/MemoizedInstanceVariableName:
-  Enabled: true
-  Exclude:
-    - test/**/*
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-Style/CaseLikeIf:
-  Enabled: false
-Style/RedundantRegexpEscape:
-  Enabled: false
-Style/OptionalBooleanParameter:
-  Enabled: false
-Style/ExplicitBlockArgument:
-  Enabled: false
-Style/KeywordParametersOrder:
-  Enabled: false

data/azure-pipelines.yml

@@ -1,15 +0,0 @@
-# Ruby
-# Package your Ruby project.
-# Add steps that install rails, analyze code, save build artifacts, deploy, and more:
-# https://docs.microsoft.com/azure/devops/pipelines/languages/ruby
-jobs:
-  - template: ./ci-jobs/functional_test.yml
-
-# Runs tests nightly to make sure they works against appium@beta
-schedules:
-  - cron: "0 0 * * *"
-    displayName: Daily Nightly build (UTC)
-    branches:
-      include:
-        - master
-    always: true

data/ci-jobs/functional/android_setup.yml

@@ -1,3 +0,0 @@
-steps:
-- script: bash ci-jobs/functional/start-emulator.sh
-  displayName: Create and run Emulator

data/ci-jobs/functional/ios_setup.yml

@@ -1,7 +0,0 @@
-steps:
-- script: sudo xcode-select -s /Applications/Xcode_${{ parameters.xcodeVersion }}.app/Contents/Developer
-  displayName: Xcode Select ${{ parameters.xcodeVersion }}
-- script: xcrun simctl list
-  displayName: List Installed Simulators
-- script: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
-  displayName: Disable pasteboard automatic sync

data/ci-jobs/functional/publish_test_result.yml

@@ -1,18 +0,0 @@
-steps:
-- task: PublishTestResults@2
-  condition: always()
-  inputs:
-    testResultsFiles: 'test/reports/TEST-AppiumLibCoreTest*.xml'
-    testRunTitle: '$(Agent.JobName)'
-- task: ArchiveFiles@2
-  condition: always()
-  inputs:
-    rootFolderOrFile: 'test/report'
-    archiveType: 'zip'
-    archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'
-    replaceExistingArchive: true
-- task: PublishBuildArtifacts@1
-  condition: always()
-  inputs:
-    pathtoPublish: '$(Build.ArtifactStagingDirectory)'
-    artifactName: '$(Agent.JobName)'

data/ci-jobs/functional/run_appium.yml

@@ -1,25 +0,0 @@
-steps:
-- task: NodeTool@0
-  inputs:
-    versionSpec: 10.x
-  displayName: Install Node 10.x
-- script: npm install -g appium@${APPIUM_VERSION}
-  displayName: Install appium beta
-- script: npm install -g mjpeg-consumer
-  displayName: Install MJPEG Consumer
-- script: npm list --depth 2 -g || echo 'ok'
-  displayName: Installed node dependencies
-- task: UseRubyVersion@0
-  inputs:
-    versionSpec: '2.7'
-- script: |
-    mkdir -p test/report
-    nohup appium --relaxed-security --log-timestamp --log-no-colors > test/report/appium.out 2>&1 &
-  displayName: Run Appium in background
-  env:
-    JAVA_HOME: $(JAVA_HOME_11_X64)
-    PATH: $(JAVA_HOME_11_X64)/bin:$(PATH)
-- script: |
-    gem install bundler;
-    bundle install --retry=3 --jobs=4 --path vendor/bundle;
-  displayName: Install Gems

data/ci-jobs/functional/start-emulator.sh

@@ -1,26 +0,0 @@
-#!/usr/bin/env bash
-
-# This script was copy-pasted from https://docs.microsoft.com/en-us/azure/devops/pipelines/languages/android?view=azure-devops#test-on-the-android-emulator
-# with some changes
-
-# Install AVD files
-declare -r emulator="system-images;android-${ANDROID_SDK_VERSION};google_apis;x86"
-echo "y" | ${ANDROID_HOME}/tools/bin/sdkmanager --install "$emulator"
-
-# Show a list of emulators
-${ANDROID_HOME}/tools/bin/avdmanager list
-
-# Create emulator
-echo "no" | ${ANDROID_HOME}/tools/bin/avdmanager create avd -d "Nexus 5X" -n testemulator -k "${emulator}" --force
-
-echo ${ANDROID_HOME}/emulator/emulator -list-avds
-
-echo "Starting emulator"
-
-# Start emulator in background
-nohup ${ANDROID_HOME}/emulator/emulator -avd testemulator -accel auto -no-boot-anim -gpu auto -no-snapshot > /dev/null 2>&1 &
-${ANDROID_HOME}/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed | tr -d '\r') ]]; do sleep 1; done; input keyevent 82'
-
-${ANDROID_HOME}/platform-tools/adb devices
-
-echo "Emulator started"