appium_lib_core 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e2dbd7b380dcd0da03d143584cae02352fcdf588a36d6b720aab8bcc6201936
-  data.tar.gz: f00fef37488b8f7d204adda5be37b21fbe5752d74f171d7dca943ff745a55df7
+  metadata.gz: 9668fe14e164d0c0c79f9d651fbc1452b0ec736965bc6da01791ea47153bc1b0
+  data.tar.gz: 141ee5425f08eef464d40b6fef0c1a396a5d382576100718f6d3efee1842fac0
 SHA512:
-  metadata.gz: c13250cfda4fcce3c70ce5059823cbd28cf64f3e420ad7687239d8369052458bfadfade17cacbea433a449313b745a73bcab22c674ba823545ee6522afa61f2d
-  data.tar.gz: 87e62233b19a677ba6fd4a33b44314efc70535d59f4855855397b5dd787b036256fbb854efd0c0d750eb99009c8721c60548d2590843a81e9aad8a74e155b7ce
+  metadata.gz: bda31b12a734ce4d95d4f13517f50e3fe69deb34596a7d3cba326191325c9e42825e9dafd65975ba6a6bf65f45432698e370aa1f848f37507c15ff7a2d5237c8
+  data.tar.gz: e69702c72a42d84ca442294afb91087e195fb8f326a051a2796d3b829c6dd5ba143d51574ed3d14caae0f3fe2a318c86db80b23d484343bee930104ef9986742

data/CHANGELOG.md

@@ -10,6 +10,17 @@ 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

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

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/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 = '4.1.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-12-25' 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/release_notes.md

@@ -1,3 +1,9 @@
+#### 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-26 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -325,7 +325,7 @@ homepage: https://github.com/appium/ruby_lib_core/
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -340,8 +340,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Minimal Ruby library for Appium.
 test_files: []