appium_lib_core 3.11.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dd7162d340f5712d5ecef7ef6061f8b19d1ad66d528a674563b3eb315de066b
-  data.tar.gz: 024f6ac6c493595db8251eca602e5a1976376364f84225b6c1cb8e69ca97550d
+  metadata.gz: 9668fe14e164d0c0c79f9d651fbc1452b0ec736965bc6da01791ea47153bc1b0
+  data.tar.gz: 141ee5425f08eef464d40b6fef0c1a396a5d382576100718f6d3efee1842fac0
 SHA512:
-  metadata.gz: 26086370c36d9d98676a78e42c831bb91040d4024ecb6059a49e27b185aaa669f0b1d5fcccce8702f78d44b93436ea26c86ff92065e42d2783fed9d46e338909
-  data.tar.gz: 7545b8db05d2259a7efc56ec3baf7fbc3b5a25929f11e6d80c951fe0005c690af51fca4f07bd2c178bf3cdfe00508a596fe56e467f7b4e678cd2c28c70369ba8
+  metadata.gz: bda31b12a734ce4d95d4f13517f50e3fe69deb34596a7d3cba326191325c9e42825e9dafd65975ba6a6bf65f45432698e370aa1f848f37507c15ff7a2d5237c8
+  data.tar.gz: e69702c72a42d84ca442294afb91087e195fb8f326a051a2796d3b829c6dd5ba143d51574ed3d14caae0f3fe2a318c86db80b23d484343bee930104ef9986742

data/.github/workflows/unittest.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7]
+        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
 
     runs-on: ubuntu-latest
 
@@ -38,7 +38,7 @@ jobs:
       fail-fast: false
       matrix:
         # Does not add 2.7 on Windows so far since a command fails only on Windows
-        ruby: [2.2, 2.3, 2.4, 2.5, 2.6]
+        ruby: [2.4, 2.5, 2.6]
 
     runs-on: windows-latest
 

data/.rubocop.yml

@@ -1,7 +1,15 @@
 AllCops:
-  TargetRubyVersion: 2.3
-Metrics/LineLength:
+  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:
@@ -18,9 +26,6 @@ Metrics/ParameterLists:
   Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false
-# TODO: Replace <<- with <<~ after dropping Ruby 2.2
-Layout/IndentHeredoc:
-  Enabled: false
 Style/ZeroLengthPredicate:
   Enabled: false
 Style/Documentation:
@@ -29,12 +34,9 @@ Style/CommentedKeyword:
   Enabled: false
 Style/PercentLiteralDelimiters:
   Enabled: false
-Style/BracesAroundHashParameters:
-  Enabled: false
 Style/SymbolArray:
   Enabled: false
-# TODO: will remove after stopping support 2.2
-Style/NumericPredicate:
+Style/UnpackFirst:
   Enabled: false
 Naming/AccessorMethodName:
   Enabled: false
@@ -44,5 +46,13 @@ Naming/MemoizedInstanceVariableName:
     - test/**/*
 Naming/RescuedExceptionsVariableName:
   Enabled: false
-Layout/RescueEnsureAlignment:
+Style/CaseLikeIf:
+  Enabled: false
+Style/RedundantRegexpEscape:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/ExplicitBlockArgument:
+  Enabled: false
+Style/KeywordParametersOrder:
   Enabled: false

data/CHANGELOG.md

@@ -10,6 +10,49 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [4.2.0] - 2021-01-02
+
+### Enhancements
+- Add  `Element#screenshot`, `Element#screenshot_as` and `Element#save_screenshot` in Element module
+    - `Element#screenshot_as` and `Element#save_screenshot` are same as `Driver#element_screenshot_as` and `Driver#save_element_screenshot`
+    - `Element#screenshot` is same as `Element#screenshot_as(:base64)`
+
+### Bug fixes
+
+### Deprecations
+
+## [4.1.1] - 2020-12-25
+
+### Enhancements
+- Ruby 3.0 support
+    - Arguments in `@driver.execute_cdp`
+        - It should be like `@driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'` as keyword arguments
+          instead of `@driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }` in Ruby 3
+          
+### Bug fixes
+
+### Deprecations
+
+## [4.0.0] - 2020-12-19
+
+Supported Ruby version is 2.4+
+
+### Enhancements
+
+### Bug fixes
+
+### Deprecations
+- No longer work with `forceMjsonwp` capability to force the session MJSONWP
+
+## [3.11.1] - 2020-11-20
+
+### Enhancements
+
+### Bug fixes
+- Fix `install_app` to be able to set no args for options
+
+### Deprecations
+
 ## [3.11.0] - 2020-08-01
 
 ### Enhancements

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/appium_lib_core.svg)](https://badge.fury.io/rb/appium_lib_core)
 
-[![Build Status](https://dev.azure.com/kazucocoa/ruby_lib_core/_apis/build/status/ruby_lib_core?branchName=master)](https://dev.azure.com/kazucocoa/ruby_lib_core/_build/latest?definitionId=9&branchName=master)
+[![Build Status](https://dev.azure.com/AppiumCI/Appium%20CI/_apis/build/status/appium.ruby_lib_core?branchName=master)](https://dev.azure.com/AppiumCI/Appium%20CI/_build/latest?definitionId=54&branchName=master)
 
 This library is a Ruby client for Appium.  The gem is available via [appium_lib_core](https://rubygems.org/gems/appium_lib_core).
 

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.2'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'webmock', '~> 3.8.0'
-  spec.add_development_dependency 'rubocop', '0.68.1'
+  spec.add_development_dependency 'webmock', '~> 3.11.0'
+  spec.add_development_dependency 'rubocop', '1.7.0'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional/ios_setup.yml

@@ -3,3 +3,5 @@ steps:
   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/run_appium.yml

@@ -11,11 +11,14 @@ steps:
   displayName: Installed node dependencies
 - task: UseRubyVersion@0
   inputs:
-    versionSpec: '2.4' # so far, bundler does not work over 2.5 since it raises openssl error
+    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;

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

@@ -18,7 +18,7 @@ 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 -no-snapshot > /dev/null 2>&1 &
+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

data/ci-jobs/functional_test.yml

@@ -2,10 +2,9 @@
 parameters:
   vmImage: 'macOS-10.15'
   vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
-  xcodeForIOS: 11.5
-  xcodeForTVOS: 11.5
+  xcodeForIOS: 12.2
+  xcodeForTVOS: 12.2
   androidSDK: 30
-  androidBuildToolsVersion: '28.0.3'
   appiumVersion: 'beta'
   ignoreVersionSkip: true
   CI: true
@@ -155,7 +154,6 @@ jobs:
       ANDROID_SDK_VERSION: ${{ parameters.androidSDK }}
       IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
       APPIUM_VERSION: ${{ parameters.appiumVersion }}
-      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
     strategy:
       matrix:
         uiautomator2:
@@ -177,7 +175,6 @@ jobs:
       ANDROID_SDK_VERSION: ${{ parameters.androidSDK }}
       IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
       APPIUM_VERSION: ${{ parameters.appiumVersion }}
-      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
     strategy:
       matrix:
         uiautomator2:
@@ -199,7 +196,6 @@ jobs:
       ANDROID_SDK_VERSION: ${{ parameters.androidSDK }}
       IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
       APPIUM_VERSION: ${{ parameters.appiumVersion }}
-      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
     strategy:
       matrix:
         uiautomator2:
@@ -221,7 +217,6 @@ jobs:
       ANDROID_SDK_VERSION: ${{ parameters.androidSDK }}
       IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
       APPIUM_VERSION: ${{ parameters.appiumVersion }}
-      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
     strategy:
       matrix:
         uiautomator2:
@@ -231,7 +226,7 @@ jobs:
     steps:
       - template: ./functional/android_setup.yml
       - template: ./functional/run_appium.yml
-      - script: bundle exec rake test:func:android TESTS=test/functional/android/android/mobile_commands_test.rb,test/functional/android/android/search_context_test.rb,test/functional/android/android/mjpeg_server_test.rb
+      - script: bundle exec rake test:func:android TESTS=test/functional/android/android/search_context_test.rb,test/functional/android/android/mjpeg_server_test.rb
         displayName: Run tests func_test_android_android2
       - template: ./functional/publish_test_result.yml
 
@@ -243,7 +238,6 @@ jobs:
       ANDROID_SDK_VERSION: ${{ parameters.androidSDK }}
       IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
       APPIUM_VERSION: ${{ parameters.appiumVersion }}
-      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
     strategy:
       matrix:
         uiautomator2:
@@ -266,7 +260,6 @@ jobs:
       AUTOMATION_NAME_DROID: espresso
       IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
       APPIUM_VERSION: ${{ parameters.appiumVersion }}
-      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
     strategy:
       matrix:
         uiautomator2:
@@ -289,7 +282,6 @@ jobs:
 #      ANDROID_SDK_VERSION: ${{ parameters.androidSDK }}
 #      IGNORE_VERSION_SKIP: ${{ parameters.ignoreVersionSkip }}
 #      APPIUM_VERSION: ${{ parameters.appiumVersion }}
-#      ANDROID_BUILD_TOOLS_VERSION: ${{ parameters.androidBuildToolsVersion }}
 #    strategy:
 #      matrix:
 #        uiautomator2:

data/lib/appium_lib_core.rb

@@ -34,11 +34,11 @@ module Appium
 
     hash.each_with_object({}) do |pair, acc|
       key = begin
-              pair[0].to_sym
-            rescue StandardError => e
-              ::Appium::Logger.warn(e.message)
-              pair[0]
-            end
+        pair[0].to_sym
+      rescue StandardError => e
+        ::Appium::Logger.warn(e.message)
+        pair[0]
+      end
 
       value = pair[1]
       acc[key] = value.is_a?(Hash) ? symbolize_keys(value) : value

data/lib/appium_lib_core/android/device.rb

@@ -25,7 +25,7 @@ module Appium
       module Device
         extend Forwardable
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
 
         # @!method open_notifications
         #   Open Android notifications
@@ -290,16 +290,16 @@ module Appium
         #   @driver.finger_print 1
         #
 
-        # @!method execute_cdp(cmd, params)
+        # @!method execute_cdp(cmd, **params)
         #     Execute Chrome Devtools protocol commands
         #     https://chromedevtools.github.io/devtools-protocol
         #
         # @param [String] cmd The name of command
-        # @param [Hash] params The parameter for the command as hash.
+        # @option params The parameter for the command as keyword options.
         #
         # @example
         #
-        #   @driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }
+        #   @driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'
         #   @driver.execute_cdp 'Page.getResourceTree'
         #
 
@@ -307,7 +307,7 @@ module Appium
         ## class << self
         ####
 
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         class << self
           def extended(_mod)

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

@@ -60,9 +60,6 @@ module Appium
         # Creates session handling both OSS and W3C dialects.
         # Copy from Selenium::WebDriver::Remote::Bridge to keep using +merged_capabilities+ for Appium
         #
-        # If +desired_capabilities+ has +forceMjsonwp: true+ in the capability, this bridge works with mjsonwp protocol.
-        # If +forceMjsonwp: false+ or no the capability, it depends on server side whether this bridge works as w3c or mjsonwp.
-        #
         # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] desired_capabilities A capability
         # @return [::Selenium::WebDriver::Remote::Capabilities, ::Selenium::WebDriver::Remote::W3C::Capabilities]
         #
@@ -76,25 +73,6 @@ module Appium
         #       platformVersion: '11.4',
         #       deviceName: 'iPhone Simulator',
         #       useNewWDA: true,
-        #       forceMjsonwp: true
-        #     },
-        #     appium_lib: {
-        #       wait: 30
-        #     }
-        #   }
-        #   core = ::Appium::Core.for(caps)
-        #   driver = core.start_driver #=> driver.dialect == :oss
-        #
-        # @example
-        #
-        #   opts = {
-        #     caps: {
-        #       platformName: :ios,
-        #       automationName: 'XCUITest',
-        #       app: 'test/functional/app/UICatalog.app.zip',
-        #       platformVersion: '11.4',
-        #       deviceName: 'iPhone Simulator',
-        #       useNewWDA: true,
         #     },
         #     appium_lib: {
         #       wait: 30
@@ -194,21 +172,17 @@ module Appium
           force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
           desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
 
-          if force_mjsonwp
-            {
-              desiredCapabilities: desired_capabilities
-            }
-          else
-            new_caps = add_appium_prefix(desired_capabilities)
-            w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
-
-            {
-              desiredCapabilities: desired_capabilities,
-              capabilities: {
-                firstMatch: [w3c_capabilities]
-              }
+          ::Appium::Logger.warn "'forceMjsonwp' no longer works. Sending both W3C and MJSONWP capabilities" if force_mjsonwp
+
+          new_caps = add_appium_prefix(desired_capabilities)
+          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
+
+          {
+            desiredCapabilities: desired_capabilities,
+            capabilities: {
+              firstMatch: [w3c_capabilities]
             }
-          end
+          }
         end
       end # class Bridge
     end # class Base

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

@@ -27,7 +27,7 @@ module Appium
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
         include ::Appium::Core::Base::SearchContext
-        include ::Appium::Core::Base::TakeScreenshot
+        include ::Appium::Core::Base::TakesScreenshot
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
@@ -311,6 +311,7 @@ module Appium
 
         # Perform a block within the given context, then switch back to the starting context.
         # @param [String] context The context to switch to for the duration of the block.
+        # @param [Proc] block The block to involve within the context
         #
         # @example
         #
@@ -318,8 +319,8 @@ module Appium
         #     @driver.find_element :tag, "button"
         #   end # The result of 'find_element :tag, "button"'
         #
-        def within_context(context)
-          block_given? ? @bridge.within_context(context, &Proc.new) : @bridge.within_context(context)
+        def within_context(context, &block)
+          block_given? ? @bridge.within_context(context, &block) : @bridge.within_context(context)
         end
 
         # Change to the default context. This is equivalent to +set_context nil+.

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

@@ -36,7 +36,8 @@ module Appium
 
           attr_reader :additional_headers
 
-          def initialize(open_timeout: nil, read_timeout: nil)
+          # override
+          def initialize(open_timeout: nil, read_timeout: nil) # rubocop:disable Lint/MissingSuper
             @open_timeout = open_timeout
             @read_timeout = read_timeout
             @additional_headers = {}

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

@@ -15,7 +15,7 @@
 module Appium
   module Core
     class Base
-      module TakeScreenshot
+      module TakesScreenshot
         #
         # Save a PNG screenshot to the given path
         #

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

@@ -18,7 +18,6 @@ module Appium
       module SearchContext
         # referenced: ::Selenium::WebDriver::SearchContext
 
-        # rubocop:disable Layout/AlignHash
         FINDERS = ::Selenium::WebDriver::SearchContext::FINDERS.merge(
           accessibility_id:     'accessibility id',
           image:                '-image',
@@ -37,9 +36,8 @@ module Appium
           # Tizen with Tizen prefix
           tizen_uiautomation:   '-tizen uiautomation'
         )
-        # rubocop:enable Layout/AlignHash
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         #
         # Find the first element matching the given arguments
         #
@@ -129,7 +127,7 @@ module Appium
         #     # For Tizen
         #     @driver.find_elements :tizen_uiautomation, '....'
         #
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         def find_element(*args)
           how, what = extract_args(args)
           by = _set_by_from_finders(how)

data/lib/appium_lib_core/common/command/common.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Layout/AlignHash
 module Appium
   module Core
     # ref: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js
@@ -109,4 +108,3 @@ module Appium
     end # module Commands
   end # module Core
 end # module Appium
-# rubocop:enable Layout/AlignHash

data/lib/appium_lib_core/common/command/mjsonwp.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Layout/AlignHash
 module Appium
   module Core
     module Commands
@@ -27,4 +26,3 @@ module Appium
     end # module Commands
   end # module Core
 end # Appium
-# rubocop:enable Layout/AlignHash

data/lib/appium_lib_core/common/command/w3c.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable Layout/AlignHash
 module Appium
   module Core
     module Commands
@@ -55,4 +54,3 @@ module Appium
     end # module Commands
   end # module Core
 end # module Appium
-# rubocop:enable Layout/AlignHash

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

@@ -34,7 +34,7 @@ module Appium
             execute :app_strings, {}, opts
           end
 
-          def background_app(duration = 0) # rubocop:disable Lint/UnusedMethodArgument
+          def background_app(duration = 0)
             # Should override in each driver
             raise NotImplementedError
           end
@@ -47,7 +47,7 @@ module Appium
                           grant_permissions: nil)
             args = { appPath: path }
 
-            args[:options] = {} unless options?(replace, timeout, allow_test_packages, use_sdcard, grant_permissions)
+            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?
@@ -92,8 +92,8 @@ module Appium
 
           private
 
-          def options?(replace, timeout, allow_test_packages, use_sdcard, grant_permissions)
-            replace.nil? || timeout.nil? || allow_test_packages.nil? || use_sdcard.nil? || grant_permissions.nil?
+          def options?(*args)
+            args.compact.any?
           end
         end # module AppManagement
       end # module Device

data/lib/appium_lib_core/common/touch_action/multi_touch.rb

@@ -24,8 +24,8 @@ module Appium
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver
-    #   action_1 = TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
-    #   action_2 = TouchAction.new(@driver).tap(element: el, x: 50, y:5, count: 3)
+    #   action_1 = Appium::Core::TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
+    #   action_2 = Appium::Core::TouchAction.new(@driver).tap(element: el, x: 50, y:5, count: 3)
     #
     #   multi_touch_action = MultiTouch.new(@driver)
     #   multi_touch_action.add action_1

data/lib/appium_lib_core/common/touch_action/touch_actions.rb

@@ -27,9 +27,9 @@ module Appium
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver
-    #   action = TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
+    #   action = Appium::Core::TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
     #   action.perform
-    #   action = TouchAction.new(@driver).swipe(....)
+    #   action = Appium::Core::TouchAction.new(@driver).swipe(....)
     #   action.perform
     #
     class TouchAction
@@ -59,7 +59,7 @@ module Appium
       # Press down for a specific duration.
       # Alternatively, you can use +press(...).wait(...).release()+ instead of +long_press+ if duration doesn't work well.
       # https://github.com/appium/ruby_lib/issues/231#issuecomment-269895512
-      # e.g. Appium::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
+      # e.g. Appium::Core::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
       #
       # @param opts [Hash] Options
       # @option opts [WebDriver::Element] element the element to press.

data/lib/appium_lib_core/common/wait.rb

@@ -53,7 +53,7 @@ module Appium
               return yield(object)
             rescue ::Errno::ECONNREFUSED => e
               raise e
-            rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
+            rescue *ignored => last_error
               # swallowed
             end
             sleep interval
@@ -98,7 +98,7 @@ module Appium
               return result if result
             rescue ::Errno::ECONNREFUSED => e
               raise e
-            rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
+            rescue *ignored => last_error
               # swallowed
             end
             sleep interval

data/lib/appium_lib_core/driver.rb

@@ -494,7 +494,7 @@ module Appium
       private
 
       # @private
-      def extend_for(device:, automation_name:)
+      def extend_for(device:, automation_name:) # rubocop:disable Metrics/CyclomaticComplexity
         extend Appium::Core
         extend Appium::Core::Device
 
@@ -505,21 +505,39 @@ module Appium
             ::Appium::Core::Android::Espresso::Bridge.for self
           when :uiautomator2
             ::Appium::Core::Android::Uiautomator2::Bridge.for self
+          when :gecko
+            ::Appium::Logger.debug('Gecko Driver for Android')
           else # default and UiAutomator
             ::Appium::Core::Android::Uiautomator1::Bridge.for self
           end
         when :ios, :tvos
           case automation_name
+          when :safari
+            ::Appium::Logger.debug('SafariDriver for iOS')
           when :xcuitest
             ::Appium::Core::Ios::Xcuitest::Bridge.for self
           else # default and UIAutomation
             ::Appium::Core::Ios::Uiautomation::Bridge.for self
           end
         when :mac
-          # no Mac specific extentions
-          ::Appium::Logger.debug('mac')
+          case automation_name
+          when :safari
+            ::Appium::Logger.debug('SafariDriver for macOS')
+          when :gecko
+            ::Appium::Logger.debug('Gecko Driver for macOS')
+          when :mac2
+            ::Appium::Logger.debug('macOS XCUITest')
+          else
+            # no Mac specific extentions
+            ::Appium::Logger.debug('macOS Native')
+          end
         when :windows
-          ::Appium::Core::Windows::Bridge.for self
+          case automation_name
+          when :gecko
+            ::Appium::Logger.debug('Gecko Driver for Windows')
+          else
+            ::Appium::Core::Windows::Bridge.for self
+          end
         when :tizen
           # https://github.com/Samsung/appium-tizen-driver
           ::Appium::Logger.debug('tizen')
@@ -531,6 +549,8 @@ module Appium
           when :mac
             # In this case also can be mac
             ::Appium::Logger.debug('mac')
+          when :gecko # other general platform
+            ::Appium::Logger.debug('Gecko Driver')
           else
             ::Appium::Logger.warn("No matched driver by platformName: #{device} and automationName: #{automation_name}")
           end

data/lib/appium_lib_core/ios/xcuitest/device.rb

@@ -23,7 +23,7 @@ module Appium
         module Device
           extend Forwardable
 
-          # rubocop:disable Metrics/LineLength
+          # rubocop:disable Layout/LineLength
 
           # @!method hide_keyboard(close_key = nil, strategy = nil)
           # Hide the onscreen keyboard
@@ -171,7 +171,7 @@ module Appium
           #   @driver.battery_info #=> { state: :full, level: 0.7 }
           #
 
-          # rubocop:enable Metrics/LineLength
+          # rubocop:enable Layout/LineLength
 
           ####
           ## class << self

data/lib/appium_lib_core/patch.rb

@@ -21,6 +21,9 @@ module Appium
       # To extend Appium related SearchContext into ::Selenium::WebDriver::Element
       include ::Appium::Core::Base::SearchContext
 
+      # TODO: Probably can remove own TakesScreenshot since Selenium 4
+      include ::Appium::Core::Base::TakesScreenshot
+
       # Returns the value of attributes like below. Read each platform to know more details.
       #
       # uiautomator2: https://github.com/appium/appium-uiautomator2-server/blob/203cc7e57ce477f3cff5d95b135d1b3450a6033a/app/src/main/java/io/appium/uiautomator2/utils/Attribute.java#L19
@@ -99,6 +102,56 @@ module Appium
         w = driver.window_size
         ::Selenium::WebDriver::Point.new "#{center_x} / #{w.width.to_f}", "#{center_y} / #{w.height.to_f}"
       end
+
+      # Return an element screenshot as base64
+      #
+      # @return String Base 64 encoded string
+      #
+      # @example
+      #
+      #     element.screenshot #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
+      #
+      def screenshot
+        bridge.take_element_screenshot(self)
+      end
+
+      # Return an element screenshot in the given format
+      #
+      # @param [:base64, :png] format
+      # @return String screenshot
+      #
+      # @example
+      #
+      #     element.screenshot_as :base64 #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
+      #
+      def screenshot_as(format)
+        case format
+        when :base64
+          bridge.take_element_screenshot(self)
+        when :png
+          bridge.take_element_screenshot(self).unpack('m')[0]
+        else
+          raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
+        end
+      end
+
+      # Save an element screenshot to the given path
+      #
+      # @param [String] png_path A path to save the screenshot
+      # @return [File] Path to the element screenshot.
+      #
+      # @example
+      #
+      #   element.save_screenshot("fine_name.png")
+      #
+      def save_screenshot(png_path)
+        extension = File.extname(png_path).downcase
+        if extension != '.png'
+          ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
+                                'It should end with .png extension'
+        end
+        File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
+      end
     end
   end # module Core
 end # module Appium

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '3.11.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-08-01' unless defined? ::Appium::Core::DATE
+    VERSION = '4.2.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-01-02' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core/windows/device.rb

@@ -20,7 +20,7 @@ module Appium
       module Device
         extend Forwardable
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
 
         # @since Appium 1.18.0
         # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil, time_limit: nil, fps: nil, preset: nil, video_filter: nil, capture_clicks: nil, capture_cursor: nil, audio_input: nil)
@@ -69,7 +69,7 @@ module Appium
         #    @driver.start_recording_screen capture_cursor: true, capture_clicks: true, time_limit: '260'
         #
 
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         ####
         ## class << self

data/release_notes.md

@@ -1,3 +1,53 @@
+#### v4.2.0 2021-01-02
+
+- [e55b2b6](https://github.com/appium/ruby_lib_core/commit/e55b2b6f7fe293091be0d3835075e66c74f3b9dd) Release 4.2.0
+- [b0cd235](https://github.com/appium/ruby_lib_core/commit/b0cd235a7fb6e5a8957871650bf86962cf0e0368) feat: append screenshot in element module as well (#297)
+
+
+#### v4.1.1 2020-12-25
+
+- [3a4cf56](https://github.com/appium/ruby_lib_core/commit/3a4cf56c73a64fb10ca0b7fecc5800719838095c) Release 4.1.1
+- [6b2d7dd](https://github.com/appium/ruby_lib_core/commit/6b2d7ddf027b5a9f49cbe9a7f5622eb345e2c076) fix: keyword argument in Ruby 3
+
+
+#### v4.1.0 2020-12-25
+
+- [89110a9](https://github.com/appium/ruby_lib_core/commit/89110a995b869471a134f8c45ebe8dfbaabfba63) Release 4.1.0
+- [c833315](https://github.com/appium/ruby_lib_core/commit/c83331560738c0a656509516fc5f610855d5dfed) chore(deps-dev): update rubocop requirement from = 1.6.1 to = 1.7.0 (#294)
+- [83d57aa](https://github.com/appium/ruby_lib_core/commit/83d57aa3ad7fd100c081ecc21ab0d5c5d40bf95f) feat: support Ruby 3 (#295)
+- [e13c58f](https://github.com/appium/ruby_lib_core/commit/e13c58fe4355dcb2631f0a42248d991165f428f7) feat: bump rubocop (#293)
+
+
+#### v4.0.0 2020-12-19
+
+- [66e2306](https://github.com/appium/ruby_lib_core/commit/66e23069722d5ccd9ca10f5a1bdf2733cb249a2c) Release 4.0.0
+- [4ba9098](https://github.com/appium/ruby_lib_core/commit/4ba9098188b51d3534e35b0fae9340de7100f516) feat: drop forcemjsonwp (#291)
+- [5df301c](https://github.com/appium/ruby_lib_core/commit/5df301cb559eed1431cc790655dc89c22be54eb9) chore(deps-dev): update webmock requirement from ~> 3.10.0 to ~> 3.11.0 (#290)
+- [76c0ff7](https://github.com/appium/ruby_lib_core/commit/76c0ff7fa540261c5793cde1f79dc14bf752fd35) feat: bump supported ruby version (#289)
+- [ea5dd00](https://github.com/appium/ruby_lib_core/commit/ea5dd0008a56821750a5b256b912f252dd46b78d) test: add a few steps
+- [9c56f30](https://github.com/appium/ruby_lib_core/commit/9c56f302d46b2ea5d970c79536260720a6bd25ec) docs: add full module path in example
+- [f88ae2c](https://github.com/appium/ruby_lib_core/commit/f88ae2c0d6e02d40089298e8bf5ec19b2af012cd) chore: Add mac2 sample and log (#288)
+- [39e4611](https://github.com/appium/ruby_lib_core/commit/39e4611adac83dee85c21893fc1f904bf828f21e) ci: bump iOS versions (#287)
+- [d76ebdd](https://github.com/appium/ruby_lib_core/commit/d76ebddf0d0f664e49a616a1f94425eba887245e) docs: update badge
+
+
+#### v3.11.1 2020-11-20
+
+- [4fe582c](https://github.com/appium/ruby_lib_core/commit/4fe582c1318c2b5de83fcf87e36d1fedab8ed81a) Release 3.11.1
+- [e017ebc](https://github.com/appium/ruby_lib_core/commit/e017ebcaa8c50653e2f45871465c78ad5a8ce81e) fix: install_app args options bug (#286)
+- [e7b881c](https://github.com/appium/ruby_lib_core/commit/e7b881c19be1b3a9acf7d01f34f59307b8e16b89) chore(deps-dev): update webmock requirement from ~> 3.9.1 to ~> 3.10.0 (#284)
+- [d1e8cb8](https://github.com/appium/ruby_lib_core/commit/d1e8cb864f00d4f4bd307b523cc205ee2a636d33) feat: add safari and geckodriver (#283)
+- [569ea09](https://github.com/appium/ruby_lib_core/commit/569ea09f7777dd2508f1919ddcf9b88aba272647) test: use predicate instead of name for 'value' (#282)
+- [e4d63eb](https://github.com/appium/ruby_lib_core/commit/e4d63eb82248a79b41fbbc39db5b03cc35d447cd) ci: remove duplicated test running
+- [30be7dc](https://github.com/appium/ruby_lib_core/commit/30be7dca0ec3cdcafa647899447387924970df34) test: fix tests
+- [94d4250](https://github.com/appium/ruby_lib_core/commit/94d4250033107ff956a2b9c1f0b30fedba286b5d) test: remove a trick
+- [6605f78](https://github.com/appium/ruby_lib_core/commit/6605f78fb0d996faad7f1e21f1876eab5184d430) test: tweak test cases
+- [7dbbadb](https://github.com/appium/ruby_lib_core/commit/7dbbadbda69ee2f710393768fb994e8e43adb3bb) fix lint
+- [7619052](https://github.com/appium/ruby_lib_core/commit/76190523c95e3f6a1ab9a9af48d60605d2f87266) tweak test cases
+- [87cb224](https://github.com/appium/ruby_lib_core/commit/87cb224a3f32261823fd5bacd9349cbe2158b54c) chore(deps-dev): update webmock requirement from ~> 3.8.0 to ~> 3.9.1 (#281)
+- [577a75a](https://github.com/appium/ruby_lib_core/commit/577a75a690b6f0688dead506c26704c82ea6f2e9) ci: update for espresso (#280)
+
+
 #### v3.11.0 2020-08-01
 
 - [0ed888e](https://github.com/appium/ruby_lib_core/commit/0ed888efd87def79cdb1ca922268b466485a2261) Release 3.11.0

data/script/commands.rb

@@ -17,9 +17,9 @@ require './lib/appium_lib_core'
 
 module Script
   class CommandsChecker
-    attr_reader :spec_commands
-    attr_reader :implemented_mjsonwp_commands, :implemented_w3c_commands, :implemented_core_commands
-    attr_reader :webdriver_oss_commands, :webdriver_w3c_commands
+    attr_reader :spec_commands,
+                :implemented_mjsonwp_commands, :implemented_w3c_commands, :implemented_core_commands,
+                :webdriver_oss_commands, :webdriver_w3c_commands
 
     # Set commands implemented in this core library.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-01 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -120,28 +120,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -333,7 +333,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="