appium_lib_core 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15447eabf9741951c87185aa6844f1b7acfab0bbcef6e70061ccebbd423dc00b
-  data.tar.gz: a135b4d1b7b4cfd49cce6a684a98fcb508a5a7f8bf770c35b2c323ac74a4f5e2
+  metadata.gz: 9c40ff7aa2c8ad3b9c93cd6e9997aa98bbe62d5118184ce58a802edf7c731ec2
+  data.tar.gz: 78eb1cf6946e248a60f0f7b598ab7274add5bbc502f247534ba0d65f14078648
 SHA512:
-  metadata.gz: 424e4f1bf4e4fa14bf5582cf74ff32cc248ab430878900bb154ed4a12ad089a84c6c087cee9f2db352ed2292e781c278510d8cb4c86b9582e9af4eb56a705e0f
-  data.tar.gz: 7d95d25ff6b670c3bd0a2ac6a295a4ef085bbde7479a40fdb0fece4100d1e2a76ba3ab814b0225de007f748f1c6d0f3c0d7b36df1b4010a11dad3951570d90b9
+  metadata.gz: eecd7b626412b0103ee2bd15ed684d22264a56eac4469adf2b0b3f8ad659c753ba17cbb2009b9ac71168f12636f41aa251962a7889d7bae4673a697c1bce0e63
+  data.tar.gz: cc0f29f03d38beca513472101b19dbf36031a3622aa6cd6edb29c3b296a09b1577ffe6d8fc74a0e7766e10eb21dc60a805f977735b47edd088f9934d4b463960

data/CHANGELOG.md

@@ -10,6 +10,27 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [5.2.0] - 2022-06-19
+
+### Enhancements
+
+- Update base Selenium Ruby client to `4.2+`
+  - Please call `key_action` or set `[::Selenium::WebDriver::Interactions.key('keyboard')]` as the deviecs parameter to build `driver.send_keys().perform` W3C action.
+    - `driver.key_action.send_keys('xxx').perform` instead of `driver.action.send_keys('xxx').perform`, or `driver.action(devices: [::Selenium::WebDriver::Interactions.key('keyboard')]).send_keys('xxx').perform`.
+    - [This PR change](https://github.com/appium/ruby_lib_core/pull/381/files) will help to update your some actions.
+
+## [5.1.2] - 2022-06-02
+
+### Enhancements
+
+- Limit selenium webdriver version less than `4.2`
+
+## [5.1.1] - 2022-04-18
+
+### Enhancements
+
+- Remove unneccessry files from gem package to reduce the size.
+
 ## [5.1.0] - 2021-12-25
 
 ### Enhancements

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

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -16,13 +16,13 @@ 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) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.0'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.2'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'rake', '~> 13.0'
@@ -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.24.0'
+  spec.add_development_dependency 'rubocop', '1.30.1'
   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

@@ -153,30 +153,26 @@ module Appium
           execute :status
         end
 
-        # Perform touch actions for W3C module.
+        # Perform 'touch' actions for W3C module.
         # Generate +touch+ pointer action here and users can use this via +driver.action+
         # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
         # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
         # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
         #
-        # The pointer type is 'touch' by default in the Appium Ruby client. (The selenium one is 'mouse')
+        # The pointer type is 'touch' by default in the Appium Ruby client.
         #
         # @example
         #
         #     element = @driver.find_element(:id, "some id")
         #     @driver.action.click(element).perform # The 'click' is a part of 'PointerActions'
         #
-        def action(async = false)
-          action_builder = ::Selenium::WebDriver::ActionBuilder.new(
+        def action(_deprecated_async = nil, async: false, devices: nil)
+          ::Selenium::WebDriver::ActionBuilder.new(
             self,
-            ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'touch'),
-            ::Selenium::WebDriver::Interactions.key('keyboard'),
-            async
+            devices: devices || [::Selenium::WebDriver::Interactions.pointer(:touch, name: 'touch')],
+            async: async,
+            duration: 50 # milliseconds
           )
-          # 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
 
         # Port from MJSONWP
@@ -189,12 +185,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

@@ -181,6 +181,31 @@ module Appium
 
         ### Methods for Appium
 
+        # Perform 'key' actions for W3C module.
+        # Generate +key+ pointer action here and users can use this via +driver.key_action+
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
+        #
+        # The pointer type is 'key' by default in the Appium Ruby client.
+        # +driver.action+ in Appium Ruby client has 'pointer' action by default.
+        # This method is a shortcut to set 'key' type.
+        # Hense this method is equal to +driver.action(devices: [::Selenium::WebDriver::Interactions.key('keyboard')])+
+        # as below example.
+        #
+        # @example
+        #
+        #     element = @driver.find_element(:id, "some id")
+        #     @driver.key_action.send_key('hiあ').perform # The 'send_key' is a part of 'KeyActions'
+        #     # is equal to:
+        #     # @driver.action(devices: [::Selenium::WebDriver::Interactions.key('keyboard')]).send_keys('hiあ').perform
+        #
+        def key_action(async: false)
+          @bridge.action(
+            async: async,
+            devices: [::Selenium::WebDriver::Interactions.key('keyboard')]
+          )
+        end
+
         # Lock the device
         # @return [String]
         #

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/driver.rb

@@ -76,6 +76,13 @@ module Appium
         path: 'directConnectPath'
       }.freeze
 
+      W3C_KEYS = {
+        protocol: 'appium:directConnectProtocol',
+        host: 'appium:directConnectHost',
+        port: 'appium:directConnectPort',
+        path: 'appium:directConnectPath'
+      }.freeze
+
       # @return [string] Returns a protocol such as http/https
       attr_reader :protocol
 
@@ -89,10 +96,10 @@ module Appium
       attr_reader :path
 
       def initialize(capabilities)
-        @protocol = capabilities[KEYS[:protocol]]
-        @host = capabilities[KEYS[:host]]
-        @port = capabilities[KEYS[:port]]
-        @path = capabilities[KEYS[:path]]
+        @protocol = capabilities[W3C_KEYS[:protocol]] || capabilities[KEYS[:protocol]]
+        @host = capabilities[W3C_KEYS[:host]] || capabilities[KEYS[:host]]
+        @port = capabilities[W3C_KEYS[:port]] || capabilities[KEYS[:port]]
+        @path = capabilities[W3C_KEYS[:path]] || capabilities[KEYS[:path]]
       end
     end
 
@@ -175,7 +182,8 @@ module Appium
       # - <code>directConnectPort</code>
       # - <code>directConnectPath</code>
       #
-      # Ignore them if this parameter is <code>false</code>. Defaults to true.
+      # ignore them if this parameter is <code>false</code>. Defaults to true.
+      # These keys can have <code>appium:</code> prefix.
       #
       # @return [Bool]
       attr_reader :direct_connect

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.1.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-12-25' unless defined? ::Appium::Core::DATE
+    VERSION = '5.2.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2022-06-19' 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.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.30.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.30.1
 - !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
@@ -292,14 +274,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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, 3.1]
-
-    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