appium_lib_core 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e1099c62a49f922529ee84563d0b475c160a981451da59210819e61956f985
-  data.tar.gz: bb653d62d35c461e8e0c9dcec726064992e735418b20c85b4aa6aae16d9b0a88
+  metadata.gz: 15447eabf9741951c87185aa6844f1b7acfab0bbcef6e70061ccebbd423dc00b
+  data.tar.gz: a135b4d1b7b4cfd49cce6a684a98fcb508a5a7f8bf770c35b2c323ac74a4f5e2
 SHA512:
-  metadata.gz: 1a18f9f6ea13b72f0aff09ea748c102fdfe202be60ac59f7fcaceee34485746a75fd83d8e438c2fd0447b64ce3c17655418ccdf599fba618afd75db7bab72e73
-  data.tar.gz: 6cac7cbba8c64d8f97fa34af6adc1b33f432549950551826cfc0e1d0340e0add900b85bf0c09cbbfa9fae551aec873d68b08b9f301d9ace40e9716d453c3ca4b
+  metadata.gz: 424e4f1bf4e4fa14bf5582cf74ff32cc248ab430878900bb154ed4a12ad089a84c6c087cee9f2db352ed2292e781c278510d8cb4c86b9582e9af4eb56a705e0f
+  data.tar.gz: 7d95d25ff6b670c3bd0a2ac6a295a4ef085bbde7479a40fdb0fece4100d1e2a76ba3ab814b0225de007f748f1c6d0f3c0d7b36df1b4010a11dad3951570d90b9

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# 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

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, 3.0]
+        ruby: [2.6, 2.7, 3.0, 3.1]
 
     runs-on: ubuntu-latest
 

data/.rubocop.yml

@@ -58,6 +58,8 @@ Style/KeywordParametersOrder:
   Enabled: false
 Gemspec/DateAssignment:
   Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
 Layout/LineEndStringConcatenationIndentation:
   Enabled: true
 Layout/SpaceBeforeBrackets:
@@ -104,6 +106,8 @@ Lint/UnexpectedBlockArity:
   Enabled: true
 Lint/UnmodifiedReduceAccumulator:
   Enabled: true
+Lint/UselessRuby2Keywords:
+  Enabled: true
 Security/IoMethods:
   Enabled: true
 Style/ArgumentsForwarding:
@@ -144,3 +148,5 @@ Style/StringChars:
   Enabled: true
 Style/SwapValues:
   Enabled: true
+Style/OpenStructUse:
+  Enabled: true

data/CHANGELOG.md

@@ -10,6 +10,31 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [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
+- (internal) Fix firstMatch format in a new session creation
+
+## [5.0.1] - 2021-11-23
+
+### Enhancements
+- Relaxed version restriction of selenium-webdriver
+
 ## [5.0.0] - 2021-11-05
 
 ### Enhancements

data/README.md

@@ -15,7 +15,7 @@ This library wraps [selenium-webdriver](https://github.com/SeleniumHQ/selenium/w
 
 # Migration from v4 to v5
 
-Please read `[5.0.0]` section in CHANGELOG.md
+Please read [`[5.0.0]`](CHANGELOG.md#500---2021-11-05) section in [CHANGELOG](CHANGELOG.md)
 
 # Related library
 - https://github.com/appium/ruby_lib

data/appium_lib_core.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.0.0'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.0'
   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.22.3'
+  spec.add_development_dependency 'rubocop', '1.24.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

@@ -77,8 +77,8 @@ module Appium
         def create_session(capabilities)
           @available_commands = ::Appium::Core::Commands::COMMANDS.dup
 
-          caps = add_appium_prefix(capabilities)
-          response = execute(:new_session, {}, { capabilities: { alwaysMatch: caps, firstMatch: [] } })
+          always_match = add_appium_prefix(capabilities)
+          response = execute(:new_session, {}, { capabilities: { alwaysMatch: always_match, firstMatch: [{}] } })
 
           @session_id = response['sessionId']
           raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
@@ -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

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/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.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-11-05' unless defined? ::Appium::Core::DATE
+    VERSION = '5.1.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-12-25' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,35 @@
+#### v5.1.0 2021-12-25
+
+- [b8b9f08](https://github.com/appium/ruby_lib_core/commit/b8b9f0858846279bbd993baa3aa4a8fdfc737b53) Release 5.1.0
+- [5979999](https://github.com/appium/ruby_lib_core/commit/59799994e91e126d57ce2cfd5b1446c48b381638) ci: add ruby 3.1 (#365)
+- [6df37c7](https://github.com/appium/ruby_lib_core/commit/6df37c7928b125295e657f007e6c6c135090ac82) chore: tune w3c actions (#364)
+- [1fdb794](https://github.com/appium/ruby_lib_core/commit/1fdb794153d74e54ca730d78eb38a59f1e3b9c72) chore(deps-dev): update rubocop requirement from = 1.23.0 to = 1.24.0 (#363)
+
+
+#### v5.0.3 2021-12-13
+
+- [7cee1b3](https://github.com/appium/ruby_lib_core/commit/7cee1b31647c453a546c450c35c37649462eed05) Release 5.0.3
+- [21bd5a5](https://github.com/appium/ruby_lib_core/commit/21bd5a5186dc25a9523ad8e7ec6275edbc79988e) fix: make bridge attribute non-private for flutter finder (#362)
+- [78e432e](https://github.com/appium/ruby_lib_core/commit/78e432e92571adfd80fe3ad4405010825e766fc5) chore: add changelog
+- [0b3c45c](https://github.com/appium/ruby_lib_core/commit/0b3c45cd6a059fd493bfcbd55ebe437291cbcdab) feat: do not restrict options in install_app (#361)
+
+
+#### v5.0.2 2021-12-01
+
+- [3cc0fb1](https://github.com/appium/ruby_lib_core/commit/3cc0fb129a0ec74367c716941adefae75fe6a6d6) Release 5.0.2
+- [a87c63a](https://github.com/appium/ruby_lib_core/commit/a87c63a5e00ca826eb89cee3b4874c4bbb787980) chore: tweak naming
+- [36e50b2](https://github.com/appium/ruby_lib_core/commit/36e50b28c04a5afda8d25f6b855d35fda5ff6b2b) fix: sends [{}] (#360)
+
+
+#### v5.0.1 2021-11-23
+
+- [f17ba52](https://github.com/appium/ruby_lib_core/commit/f17ba524608a6e715923331bb9bfff73e0709bcb) Release 5.0.1
+- [ee9cbc4](https://github.com/appium/ruby_lib_core/commit/ee9cbc42e0d3289bb4ab9b403d45867472241e97) feat: relax selenium webdriver version (#357)
+- [4c2948b](https://github.com/appium/ruby_lib_core/commit/4c2948b113106e01c8009555434b4d0fe0ae99f3) chore(deps-dev): update rubocop requirement from = 1.22.3 to = 1.23.0 (#354)
+- [abe2316](https://github.com/appium/ruby_lib_core/commit/abe2316b5a01a27bc657daeb41524afca4187c18) ci: add codeql-analysis (#355)
+- [1c87fc9](https://github.com/appium/ruby_lib_core/commit/1c87fc9b2e1ac7bd869ec61a0dc045b12d5ed887) docs: add link to changelog in migration guide
+
+
 #### v5.0.0 2021-11-05
 
 - [e2d1e2d](https://github.com/appium/ruby_lib_core/commit/e2d1e2da59b10f84b3c8ecafba7be6ab27223b73) Release 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-12-26 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.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ files:
 - ".github/contributing.md"
 - ".github/dependabot.yml"
 - ".github/issue_template.md"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/unittest.yml"
 - ".gitignore"
 - ".rubocop.yml"