appium_lib_core 3.11.1 → 4.2.1

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

@@ -525,6 +525,8 @@ module Appium
             ::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')

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.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-11-20' unless defined? ::Appium::Core::DATE
+    VERSION = '4.2.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-01-10' 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,45 @@
+#### v4.2.1 2021-01-10
+
+- [23e944e](https://github.com/appium/ruby_lib_core/commit/23e944ed72c6ea861532f5acc1381af4441705e6) Release 4.2.1
+- [1a416b1](https://github.com/appium/ruby_lib_core/commit/1a416b136beb2b9115d3eb6637b22817f0e55601) chore: move rotable for w3c (#300)
+- [95821c6](https://github.com/appium/ruby_lib_core/commit/95821c6f1a4ebc785e2dc3e6e16c1705521237e8) ci: bump android app (#299)
+- [4e1770e](https://github.com/appium/ruby_lib_core/commit/4e1770e3b9d6995b1d5430b9033097609edca1c8) chore(deps-dev): update rubocop requirement from = 1.7.0 to = 1.8.0 (#298)
+- [b230512](https://github.com/appium/ruby_lib_core/commit/b230512c52875ea70545d3d2262c306640f87f7d) chore: fix rubocop
+
+
+#### 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

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.1
+  version: 4.2.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-21 00:00:00.000000000 Z
+date: 2021-01-10 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.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.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.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +268,7 @@ files:
 - lib/appium_lib_core/common/base/driver.rb
 - lib/appium_lib_core/common/base/http_default.rb
 - lib/appium_lib_core/common/base/platform.rb
+- lib/appium_lib_core/common/base/rotable.rb
 - lib/appium_lib_core/common/base/screenshot.rb
 - lib/appium_lib_core/common/base/search_context.rb
 - lib/appium_lib_core/common/command.rb
@@ -287,6 +288,7 @@ files:
 - lib/appium_lib_core/common/device/ime_actions.rb
 - lib/appium_lib_core/common/device/keyboard.rb
 - lib/appium_lib_core/common/device/keyevent.rb
+- lib/appium_lib_core/common/device/orientation.rb
 - lib/appium_lib_core/common/device/screen_record.rb
 - lib/appium_lib_core/common/device/setting.rb
 - lib/appium_lib_core/common/device/touch_actions.rb
@@ -333,7 +335,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:
   - - ">="