appium_lib_core 6.2.1 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d75095d146ec0e3786352920f8d1fe385cedab5c8faddc6292db1cd94cd5e111
-  data.tar.gz: be514be276344a3b488238716890d3bd99fbc1d9da3317ccb4ee943da8cf9ee3
+  metadata.gz: 3047299ce31d2eac69a3d62e52e2fa73ca02710e0f7c7d5d039e06e838822386
+  data.tar.gz: 2776a7ddebb3cc71a0334559c663b351c1f5f4dde223b313d3b581b91b83b402
 SHA512:
-  metadata.gz: 40c066943b4d7c7f879a991b40b88d34da0317c0099c9fd14f011de8769d7d5cbc34665183b8f034ac532a7d5e5dd616aba4d433d4731fd37a9992ad82384108
-  data.tar.gz: a277b62b251f4557592bbccc79816fe75d833b324965d121225d39364bfa2d5f0b2e62eff41eafc7a11996564046775dd5da9c0c4e0b85ca0248b8e3ba9ae845
+  metadata.gz: cfd4ad06897b4402556701ff40bb3722f4c5b8dd3b4704577ba7790c28f6e329d5aab83abbdea906c309897b9c95f87d61f6845e7eb8ef4f569105a82d816164
+  data.tar.gz: 6076c5d10ee6010eea91a78ff98aaa18187ef6c7c1519e024bba8b7207f4892311cea7ffcac0b081a5ebb39945d42eae46d1ca463fa581f6450d3e6b53f29731

data/CHANGELOG.md

@@ -10,6 +10,17 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [6.4.0] - 2023-04-30
+
+### Enhancements
+- Append `selenium-webdriver` `4.9` support
+
+## [6.3.0] - 2023-03-14
+
+### Enhancements
+- Support custom listener
+    - e.g. A listener named `CustomListener` which inherits `::Selenium::WebDriver::Support::AbstractEventListener` can set as `appium_lib: { listener: CustomListener.new}` capability
+
 ## [6.2.1] - 2023-03-09
 
 ### Enhancements

data/README.md

@@ -154,6 +154,29 @@ attached_driver.page_source
 Read [Appium/Core/Driver](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver) to catch up with available capabilities.
 Capabilities affect only ruby_lib is [Appium/Core/Options](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Options).
 
+
+### Gives custom listener
+
+An example to define a customer listener with [Selenium::WebDriver::Support::AbstractEventListener](https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/Support/AbstractEventListener.html)
+
+```ruby
+class CustomListener < ::Selenium::WebDriver::Support::AbstractEventListener
+  // something
+end
+capabilities: {
+  platformName: :ios,
+  platformVersion: '11.0',
+  deviceName: 'iPhone Simulator',
+  automationName: 'XCUITest',
+  app: '/path/to/MyiOS.app'
+},
+appium_lib: {
+  listener: CustomListener.new
+}
+@core = Appium::Core.for capabilities: capabilities, appium_lib: appium_lib
+@core.start_driver
+```
+
 # Development
 - Demo app
     - https://android.googlesource.com/platform/development/+/master/samples/ApiDemos

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.2', '< 4.9'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.2', '< 4.10'
   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.18.1'
-  spec.add_development_dependency 'rubocop', '1.47.0'
+  spec.add_development_dependency 'rubocop', '1.50.2'
   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/driver.rb

@@ -44,16 +44,26 @@ module Appium
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
         attr_reader :bridge
 
-        private
+        # override
+        def initialize(bridge: nil, listener: nil, **opts) # rubocop:disable Lint/MissingSuper
+          original_opts = opts.dup
 
-        def initialize(bridge: nil, listener: nil, **opts)
           # For ::Appium::Core::Waitable
           @wait_timeout = opts.delete(:wait_timeout)
           @wait_interval = opts.delete(:wait_interval)
 
-          super
+          # Selenium WebDriver attributes
+          @devtools = nil
+          @bidi = nil
+
+          # in the selenium webdriver as well
+          bridge ||= create_bridge(**opts)
+          add_extensions(bridge.browser)
+          @bridge = listener ? ::Appium::Support::EventFiringBridge.new(bridge, listener, **original_opts) : bridge
         end
 
+        private
+
         # Create a proper bridge instance.
         #
         # @return [::Appium::Core::Base::Bridge]
@@ -1069,7 +1079,7 @@ module Appium
         #
         # @param [String] img_path A path to a partial image you'd like to find
         #
-        # @return [Array<Selenium::WebDriver::Element>]
+        # @return [Array<::Appium::Core::Element>]
         #
         # @example
         #

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

@@ -41,6 +41,7 @@ module Appium
             @open_timeout = open_timeout
             @read_timeout = read_timeout
             @additional_headers = {}
+            super
           end
 
           # Update <code>server_url</code> provided when ruby_lib _core created a default http client.

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

@@ -24,7 +24,7 @@ module Appium
         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. '\
+            ::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) }
@@ -103,7 +103,7 @@ module Appium
         def save_viewport_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. '\
+            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. ' \
                                   'It should end with .png extension'
           end
           viewport_screenshot_encode64 = bridge.viewport_screenshot

data/lib/appium_lib_core/driver.rb

@@ -276,6 +276,23 @@ module Appium
       #     @core = Appium::Core.for(opts) # create a core driver with 'opts' and extend methods into 'self'
       #     @core.start_driver # start driver with 'url'. Connect to 'http://custom-host:8080/wd/hub.com'
       #
+      #     # With a custom listener
+      #     class CustomListener < ::Selenium::WebDriver::Support::AbstractEventListener
+      #       // something
+      #     end
+      #     capabilities: {
+      #       platformName: :ios,
+      #       platformVersion: '11.0',
+      #       deviceName: 'iPhone Simulator',
+      #       automationName: 'XCUITest',
+      #       app: '/path/to/MyiOS.app'
+      #     },
+      #     appium_lib: {
+      #       listener: CustomListener.new,
+      #     }
+      #     @core = Appium::Core.for capabilities: capabilities, appium_lib: appium_lib
+      #     @core.start_driver
+      #
       def self.for(opts = {})
         new.setup_for_new_session(opts)
       end
@@ -488,13 +505,7 @@ module Appium
       end
 
       def get_http_client(http_client: nil, open_timeout: nil, read_timeout: nil)
-        client = http_client || Appium::Core::Base::Http::Default.new
-
-        # open_timeout and read_timeout are explicit wait.
-        client.open_timeout = open_timeout if open_timeout
-        client.read_timeout = read_timeout if read_timeout
-
-        client
+        http_client || Appium::Core::Base::Http::Default.new(open_timeout: open_timeout, read_timeout: read_timeout)
       end
 
       # Ignore setting default wait if the target driver has no implementation

data/lib/appium_lib_core/element.rb

@@ -152,7 +152,7 @@ module Appium
       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. '\
+          ::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) }

data/lib/appium_lib_core/support/event_firing_bridge.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Support
+    class EventFiringBridge < ::Selenium::WebDriver::Support::EventFiringBridge
+      # This module inherits ::Selenium::WebDriver::Support::EventFiringBridge
+      # to provide customer listener availability.
+      # https://github.com/SeleniumHQ/selenium/blob/trunk/rb/lib/selenium/webdriver/support/event_firing_bridge.rb#L79
+
+      def initialize(delegate, listener, **opts)
+        @appium_options = opts
+        super delegate, listener
+      end
+
+      def find_element_by(how, what, parent = nil)
+        e = dispatch(:find, how, what, driver) do
+          @delegate.find_element_by how, what, parent
+        end
+
+        ::Appium::Core::Element.new self, e.ref.last
+      end
+
+      def find_elements_by(how, what, parent = nil)
+        es = dispatch(:find, how, what, driver) do
+          @delegate.find_elements_by(how, what, parent)
+        end
+
+        es.map { |e| ::Appium::Core::Element.new self, e.ref.last }
+      end
+
+      private
+
+      def create_element(ref)
+        ::Appium::Core::Element.new @delegate, ref
+      end
+
+      def driver
+        # To not gives the listener
+        @appium_options.delete(:listener)
+
+        @driver ||= ::Appium::Core::Base::Driver.new(bridge: self, listener: nil, **@appium_options)
+      end
+    end
+  end
+end

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '6.2.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2023-03-09' unless defined? ::Appium::Core::DATE
+    VERSION = '6.4.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2023-04-30' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -19,6 +19,7 @@ require_relative 'appium_lib_core/common'
 require_relative 'appium_lib_core/driver'
 require_relative 'appium_lib_core/device'
 require_relative 'appium_lib_core/element'
+require_relative 'appium_lib_core/support/event_firing_bridge'
 
 module Appium
   # @private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.4.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '4.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '4.10'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.47.0
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.47.0
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -259,6 +259,7 @@ files:
 - lib/appium_lib_core/mac2/bridge.rb
 - lib/appium_lib_core/mac2/device.rb
 - lib/appium_lib_core/mac2/device/screen.rb
+- lib/appium_lib_core/support/event_firing_bridge.rb
 - lib/appium_lib_core/version.rb
 - lib/appium_lib_core/windows.rb
 - lib/appium_lib_core/windows/bridge.rb
@@ -269,7 +270,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
@@ -284,8 +285,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Minimal Ruby library for Appium.
 test_files: []