appium_lib_core 5.0.2 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e643028012001727a3587bf56c533a58f3156cb54a33ce6ae76344032b6eba2b
-  data.tar.gz: e267c16743d9ae2054c82aaf2af36743eadcf11405cda1bc65d0988e2a0b019d
+  metadata.gz: 7498caac67adf73e6d5a8f7127fe6441eadb7cfa705496e72c616d3c389337c7
+  data.tar.gz: 851dca60890fa41293cae401d308e43f34d3fe94f49fbbe951407a00dea2a329
 SHA512:
-  metadata.gz: 2e433f4df5d820edd9a8625b0e53e3d16eb498310e3d7891ae4f5002bae518488a4595398a294b3f2a7a7a81d84dce0ded6ede87289d5a47f6a5a6f9a4ca0656
-  data.tar.gz: 07ccc1ce6007394bb72328cfd0f2f7ed292f0456177baef9dc9aec999ba511565dcd9635f10c5ce7e43383a115801d5d3c728a52a08c20a254558d4752ddc863
+  metadata.gz: 8a4e1dc7ee2b28b0ccfba5e0255d30370232313d4ae51d36b61fca2d0431cf7617b03696529207c8c8de666fba504491d73d2a6ef28c3f6c5cb5cc1612ae5c9d
+  data.tar.gz: '09528fb3002fd25934c5f1bd0d539e2b13798701b18803de0bda4410ab8fb7116b1458ef619d0d43050548a2deb57ef86848bc3a9a46ac954551fd93e8bc176f'

data/CHANGELOG.md

@@ -10,6 +10,27 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [5.1.1] - 2022-04-18
+
+### Enhancements
+
+- Remove unneccessry files from gem package to reduce the size.
+
+## [5.1.0] - 2021-12-25
+
+### Enhancements
+- Make default pointerType `touch` for the pointer in W3C actions instead of `mouse` for Appium
+    - This change should not affect W3C actions
+
+## [5.0.3] - 2021-12-13
+
+### Enhancements
+- Can add more arguments in `install_app`
+    - e.g. Add `timeoutMs` for XCUITest driver as `@driver.install_app("/path/to/test.ipa", timeoutMs: 20000)`
+
+### Bug fixes
+- (internal) Allow to access to `bridge` attribute in `driver` instance for appium_flutter_finder
+
 ## [5.0.2] - 2021-12-01
 
 ### Bug fixes

data/README.md

@@ -43,7 +43,7 @@ $ appium --relaxed-security # To run all tests in local
 ```bash
 $ bundle install
 $ rake test:func:android # Andorid, uiautomator2
-$ AUTOMATION_NAME_DROID=espresso rake test:func:android # Andorid, uiautomator2
+$ APPIUM_DRIVER=espresso rake test:func:android # Andorid, uiautomator2
 $ rake test:func:ios     # iOS
 ```
 

data/appium_lib_core.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/appium/ruby_lib_core/'
   spec.license       = 'Apache-2.0'
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(doc|test|spec|features)/})
+    f.match(%r{(^(doc|docs|test|spec|features|ci-jobs|.github|script)/|release_notes.md|.gitignore|azure-pipelines.yml|.rubocop.yml)})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.14.0'
-  spec.add_development_dependency 'rubocop', '1.23.0'
+  spec.add_development_dependency 'rubocop', '1.27.0'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'parallel_tests'
   spec.add_development_dependency 'simplecov'

data/lib/appium_lib_core/common/base/bridge.rb

@@ -159,8 +159,7 @@ module Appium
         # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
         # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
         #
-        # 'mouse' action is by default in the Ruby client. Appium server force the +mouse+ action to +touch+ once in
-        # the server side. So we don't consider the case.
+        # The pointer type is 'touch' by default in the Appium Ruby client. (The selenium one is 'mouse')
         #
         # @example
         #
@@ -168,9 +167,14 @@ module Appium
         #     @driver.action.click(element).perform # The 'click' is a part of 'PointerActions'
         #
         def action(async = false)
-          # Used for default duration of each touch actions
-          # Override from 250 milliseconds to 50 milliseconds
-          action_builder = super
+          action_builder = ::Selenium::WebDriver::ActionBuilder.new(
+            self,
+            ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'touch'),
+            ::Selenium::WebDriver::Interactions.key('keyboard'),
+            async
+          )
+          # Used for default duration of each touch actions.
+          # Override from 250 milliseconds to 50 milliseconds in PointerActions included by ::Selenium::WebDriver::ActionBuilder
           action_builder.default_move_duration = 0.05
           action_builder
         end
@@ -185,12 +189,6 @@ module Appium
           ::Selenium::WebDriver::Remote::Capabilities.json_create execute(:get_capabilities)
         end
 
-        # Port from MJSONWP
-        def send_keys_to_active_element(key)
-          text = ::Selenium::WebDriver::Keys.encode(key).join
-          execute :send_keys_to_active_element, {}, { value: text.chars }
-        end
-
         # For Appium
         # override
         def page_source

data/lib/appium_lib_core/common/base/driver.rb

@@ -41,12 +41,12 @@ module Appium
 
         include ::Appium::Core::Waitable
 
-        private
-
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
         attr_reader :bridge
 
+        private
+
         def initialize(bridge: nil, listener: nil, **opts)
           # For ::Appium::Core::Waitable
           @wait_timeout = opts.delete(:wait_timeout)
@@ -609,7 +609,9 @@ module Appium
           @bridge.background_app(duration)
         end
 
-        # Install the given app onto the device
+        # Install the given app onto the device.
+        # Each options can be snake-case or camel-case. Snake-cases will be converted to camel-case
+        # as options value.
         #
         # @param [String] path The absolute local path or remote http URL to an .ipa or .apk file,
         #                      or a .zip containing one of these.
@@ -623,26 +625,26 @@ module Appium
         # @param [Boolean] grant_permissions Only for Android. whether to automatically grant application permissions
         #                                    on Android 6+ after the installation completes. +false+ by default
         #
+        # Other parameters such as https://github.com/appium/appium-xcuitest-driver#mobile-installapp also can be set.
+        # Then, arguments in snake case will be camel case as its request parameters.
+        #
         # @example
         #
         #   @driver.install_app("/path/to/test.apk")
         #   @driver.install_app("/path/to/test.apk", replace: true, timeout: 20000, allow_test_packages: true,
         #                       use_sdcard: false, grant_permissions: false)
+        #   @driver.install_app("/path/to/test.ipa", timeoutMs: 20000)
         #
-        def install_app(path,
-                        replace: nil,
-                        timeout: nil,
-                        allow_test_packages: nil,
-                        use_sdcard: nil,
-                        grant_permissions: nil)
-          @bridge.install_app(path,
-                              replace: replace,
-                              timeout: timeout,
-                              allow_test_packages: allow_test_packages,
-                              use_sdcard: use_sdcard,
-                              grant_permissions: grant_permissions)
+        def install_app(path, **options)
+          options = options.transform_keys { |key| key.to_s.gsub(/_./) { |v| v[1].upcase } } unless options.nil?
+          @bridge.install_app(path, options)
         end
 
+        # def capitalize(s)
+        #   chars =
+        #   chars[1:].map(&:capitalize).join
+        # end
+
         # @param [Strong] app_id BundleId for iOS or package name for Android
         # @param [Boolean] keep_data Only for Android. Whether to keep application data and caches after it is uninstalled.
         #                             +false+ by default

data/lib/appium_lib_core/common/command.rb

@@ -171,8 +171,6 @@ module Appium
         ime_deactivate: [:post, 'session/:session_id/ime/deactivate'],
         ime_activate_engine: [:post, 'session/:session_id/ime/activate'],
 
-        send_keys_to_active_element: [:post, 'session/:session_id/keys'],
-
         ### Logs
         get_available_log_types: [:get, 'session/:session_id/log/types'],
         get_log: [:post, 'session/:session_id/log'],

data/lib/appium_lib_core/common/device/app_management.rb

@@ -39,21 +39,9 @@ module Appium
             raise NotImplementedError
           end
 
-          def install_app(path,
-                          replace: nil,
-                          timeout: nil,
-                          allow_test_packages: nil,
-                          use_sdcard: nil,
-                          grant_permissions: nil)
+          def install_app(path, options = {})
             args = { appPath: path }
-
-            args[:options] = {} if options?(replace, timeout, allow_test_packages, use_sdcard, grant_permissions)
-
-            args[:options][:replace] = replace unless replace.nil?
-            args[:options][:timeout] = timeout unless timeout.nil?
-            args[:options][:allowTestPackages] = allow_test_packages unless allow_test_packages.nil?
-            args[:options][:useSdcard] = use_sdcard unless use_sdcard.nil?
-            args[:options][:grantPermissions] = grant_permissions unless grant_permissions.nil?
+            args[:options] = options unless options.empty?
 
             execute :install_app, {}, args
           end

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.0.2' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-12-01' unless defined? ::Appium::Core::DATE
+    VERSION = '5.1.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2022-04-18' unless defined? ::Appium::Core::DATE
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.27.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +171,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE/issue-report.md"
-- ".github/contributing.md"
-- ".github/dependabot.yml"
-- ".github/issue_template.md"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/unittest.yml"
-- ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -186,16 +178,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
@@ -278,8 +262,6 @@ files:
 - 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
@@ -299,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Minimal Ruby library for Appium.

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/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "11:00"
-  open-pull-requests-limit: 10

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/codeql-analysis.yml

@@ -1,70 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '39 12 * * 0'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

data/.github/workflows/unittest.yml

@@ -1,67 +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.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 rake test:unit
-        AUTOMATION_NAME_DROID=espresso bundle exec rake test:unit:android
-        AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec rake test:unit
-
-  test-win:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [2.6, 2.7, 3.0]
-
-    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: |
-          rake test:unit
-
-          setx AUTOMATION_NAME_DROID espresso
-          rake test:unit:android
-
-          setx AUTOMATION_NAME_DROID appium
-          setx AUTOMATION_NAME_IOS appium
-          rake test:unit

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