appium_lib_core 6.2.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d75095d146ec0e3786352920f8d1fe385cedab5c8faddc6292db1cd94cd5e111
-  data.tar.gz: be514be276344a3b488238716890d3bd99fbc1d9da3317ccb4ee943da8cf9ee3
+  metadata.gz: c45a558b448d89b1b356b221257279ff8c148680a1dc09f7414877e6e59a6257
+  data.tar.gz: d09d57109c80759c9b92942b7f8e1424c2614f34e4fcdbe9f6d4d0e48ee41816
 SHA512:
-  metadata.gz: 40c066943b4d7c7f879a991b40b88d34da0317c0099c9fd14f011de8769d7d5cbc34665183b8f034ac532a7d5e5dd616aba4d433d4731fd37a9992ad82384108
-  data.tar.gz: a277b62b251f4557592bbccc79816fe75d833b324965d121225d39364bfa2d5f0b2e62eff41eafc7a11996564046775dd5da9c0c4e0b85ca0248b8e3ba9ae845
+  metadata.gz: 6f50481e6656b18e7dfe5dc631137ab1ab041c9c6087fcf27b1fd24e91814e83ce051f22db1a3e4b41f5d2a4b8320e2ac7c323638e9e9b76d2508d66a7992cdf
+  data.tar.gz: 0b04644ee8c7704080935777b01886cca17acce8dab8c7953b769c9dd9ca33efc588e3da5e08bba6a91f0ac17bde973c607f3b886c4724eb84be3c44aece2690

data/CHANGELOG.md

@@ -10,6 +10,12 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [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/lib/appium_lib_core/common/base/driver.rb

@@ -44,16 +44,25 @@ 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
-
         def initialize(bridge: nil, listener: nil, **opts)
+          original_opts = opts.dup
+
           # 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 +1078,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/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

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.3.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2023-03-14' 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.3.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -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