appium_lib_core 5.0.0.beta4 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc30b79d80c1606288087e36a6ed024c3be91ffbc6c5b8b04c9c9c1537d1d9e
-  data.tar.gz: 06b4f5cdbadb770ce7ce4eecd3fcdaf78c002c13982b6a0573e30a0c3aee9d02
+  metadata.gz: fc513ad9f9ba5689303763b09a884af18e1a9eb80e78a6e05cf838551905f732
+  data.tar.gz: 59241d4d8626cf39eeb63a51291f18deca6759bdba95a8e2bb942173e0b5df9e
 SHA512:
-  metadata.gz: c68d806651e436131ebd91c9f9b520a8de1a95ad82ee67988c7f475b6ce2c016b50fa15e1ee4f0813f55d59e5237bea34c209096436807ba7f8eb2ac9afbb123
-  data.tar.gz: 3982388d81e2d3d59b51cde803e5e83521772700fc8a82d0733ba650c25b2f46578bb9490113a8792a5b5e24d22488110ff3a6e727cb8d22a210c6bf4fb8632e
+  metadata.gz: 867c6a7bfbdf95243fae3a6292f0349bf9bda1fbb83b44cb7d2e12e8f5e0ecb2f41fb6103aeebdcaaded1024cbb16cd2d758d73bef9bf00697325d75b5c2d027
+  data.tar.gz: 345771f473fca33668d101f00be374ebb3b345b6795c5392b9955da73bb45588e5589b70ba8c983ce161e35c311b2f18adfd7bac3a8d816ba93863820b05b4f6

data/CHANGELOG.md

@@ -5,6 +5,7 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
+- Allow to override an existing method by `Appium::Core::Base::Driver#add_command` since Appium drivers/plugins allow to override them
 
 ### Bug fixes
 
@@ -17,6 +18,11 @@ Read `release_notes.md` for commit level details.
 - Support Ruby 2.5+
 - Raises `::Appium::Core::Error::ArgumentError` instead of `ArgumentError` for this library specific argument errors
 
+## [4.7.0] - 2021-07-17
+
+### Enhancements
+- Add `satellites` option in `Appium::Core::Base::Driver#set_location`
+
 ## [4.6.0] - 2021-06-03
 
 ### Enhancements
@@ -25,7 +31,7 @@ Read `release_notes.md` for commit level details.
 ## [4.5.0] - 2021-03-14
 
 ### Enhancements
-- Add `speed` argument for `Appium::Core::Base::Driver#set_location` since Appium 1.21.0 
+- Add `speed` argument for `Appium::Core::Base::Driver#set_location` since Appium 1.21.0
 - Add `multiple` and `match_neighbour_threshold` arguments for `Appium::Core::Base::Driver#find_image_occurrence`
 
 ## [4.4.1(4.4.0)] - 2021-02-15(2021-02-13)

data/Rakefile

@@ -38,6 +38,7 @@ namespace :test do
   namespace :unit do
     desc('Run all iOS related unit tests in test directory')
     Rake::TestTask.new(:ios) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/ios/**/*_test.rb']
@@ -45,6 +46,7 @@ namespace :test do
 
     desc('Run all Android related unit tests in test directory')
     Rake::TestTask.new(:android) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/android/**/*_test.rb']
@@ -52,6 +54,7 @@ namespace :test do
 
     desc('Run all common related unit tests in test directory')
     Rake::TestTask.new(:common) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/common/**/*_test.rb']
@@ -59,6 +62,7 @@ namespace :test do
 
     desc('Run all Windows related unit tests in test directory')
     Rake::TestTask.new(:windows) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/windows/**/*_test.rb']

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.0.0.beta4'
+  spec.add_runtime_dependency 'selenium-webdriver', '4.0.0.rc1'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'bundler', '>= 1.14'
@@ -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.13.0'
-  spec.add_development_dependency 'rubocop', '1.12.0'
+  spec.add_development_dependency 'webmock', '~> 3.14.0'
+  spec.add_development_dependency 'rubocop', '1.12.1'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional_test.yml

@@ -103,7 +103,7 @@ jobs:
     - template: ./functional/ios_setup.yml
       parameters:
         xcodeVersion: ${{ parameters.xcodeForIOS }}
-    - script: brew install ffmpeg && brew tap wix/brew && brew install wix/brew/applesimutils
+    - script: brew install ffmpeg && brew tap wix/brew && brew install applesimutils
       displayName: Install ffmpeg and applesimutils
     - template: ./functional/run_appium.yml
     - script: bundle exec rake test:func:ios TESTS=test/functional/ios/ios/mjpeg_server_test.rb,test/functional/ios/ios/mobile_commands_test.rb

data/docs/mobile_command.md

@@ -9,7 +9,7 @@ We can invoke them via `execute_script` command with `mobile:` arguments.
     - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android
 - iOS:
     - https://github.com/appium/appium/tree/master/docs/en/writing-running-appium/ios
-    
+
 
 ```ruby
 # Android shell : https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/android-shell.md
@@ -28,7 +28,8 @@ To handle it, we would recommend you to handle the error based on the error mess
 
 ```ruby
 error = assert_raises ::Selenium::WebDriver::Error::UnknownError do
-  @driver.execute_script 'mobile: scrollToPage', { element: el.ref, scrollToPage: -100 }
+  _, element_id = el.ref
+  @driver.execute_script 'mobile: scrollToPage', { element: element_id, scrollToPage: -100 }
 end
 assert error.message.include? 'be a non-negative integer'
 ```

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

@@ -133,7 +133,7 @@ module Appium
 
         # command for Appium 2.0.
         def add_command(method:, url:, name:, &block)
-          raise ::Appium::Core::Error::ArgumentError, "#{name} is already defined" if @available_commands.key? name
+          ::Appium::Logger.info "Overriding the method '#{name}' for '#{url}'" if @available_commands.key? name
 
           @available_commands[name] = [method, url]
 
@@ -207,7 +207,8 @@ module Appium
           # For W3C
           # https://github.com/SeleniumHQ/selenium/commit/b618499adcc3a9f667590652c5757c0caa703289
           # execute_atom :isDisplayed, element
-          execute :is_element_displayed, id: element.ref
+          _, element_id = element.ref
+          execute :is_element_displayed, id: element_id
         end
 
         # For Appium
@@ -215,7 +216,8 @@ module Appium
         def element_attribute(element, name)
           # For W3C in Selenium Client
           # execute_atom :getAttribute, element, name
-          execute :get_element_attribute, id: element.ref, name: name
+          _, element_id = element.ref
+          execute :get_element_attribute, id: element_id, name: name
         end
 
         # For Appium
@@ -227,26 +229,39 @@ module Appium
 
         # For Appium
         # override
-        def find_element_by(how, what, parent = nil)
+        def find_element_by(how, what, parent_ref = [])
           how, what = convert_locator(how, what)
 
-          id = if parent
-                 execute :find_child_element, { id: parent }, { using: how, value: what }
+          return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
+
+          parent_type, parent_id = parent_ref
+          id = case parent_type
+               when :element
+                 execute :find_child_element, { id: parent_id }, { using: how, value: what.to_s }
+               when :shadow_root
+                 execute :find_shadow_child_element, { id: parent_id }, { using: how, value: what.to_s }
                else
-                 execute :find_element, {}, { using: how, value: what }
+                 execute :find_element, {}, { using: how, value: what.to_s }
                end
+
           ::Appium::Core::Element.new self, element_id_from(id)
         end
 
         # For Appium
         # override
-        def find_elements_by(how, what, parent = nil)
+        def find_elements_by(how, what, parent_ref = [])
           how, what = convert_locator(how, what)
 
-          ids = if parent
-                  execute :find_child_elements, { id: parent }, { using: how, value: what }
+          return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
+
+          parent_type, parent_id = parent_ref
+          ids = case parent_type
+                when :element
+                  execute :find_child_elements, { id: parent_id }, { using: how, value: what.to_s }
+                when :shadow_root
+                  execute :find_shadow_child_elements, { id: parent_id }, { using: how, value: what.to_s }
                 else
-                  execute :find_elements, {}, { using: how, value: what }
+                  execute :find_elements, {}, { using: how, value: what.to_s }
                 end
 
           ids.map { |id| ::Appium::Core::Element.new self, element_id_from(id) }
@@ -283,9 +298,10 @@ module Appium
 
         # For Appium
         # No implementation for W3C webdriver module
-        def set_location(lat, lon, alt = 0.0, speed: nil)
+        def set_location(lat, lon, alt = 0.0, speed: nil, satellites: nil)
           loc = { latitude: lat, longitude: lon, altitude: alt }
           loc[:speed] = speed unless speed.nil?
+          loc[:satellites] = satellites unless satellites.nil?
           execute :set_location, {}, { location: loc }
         end
 
@@ -326,12 +342,12 @@ module Appium
           execute :get_log_events, {}, args
         end
 
-        def take_viewport_screenshot
+        def viewport_screenshot
           execute_script('mobile: viewportScreenshot')
         end
 
-        def take_element_screenshot(element)
-          execute :take_element_screenshot, id: element.ref
+        def element_screenshot(element_id)
+          execute :take_element_screenshot, id: element_id
         end
 
         private

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

@@ -57,8 +57,6 @@ module Appium
         # @return [::Appium::Core::Base::Bridge]
         #
         def create_bridge(**opts)
-          # TODO: probably Appium does not need this.
-          opts[:url] ||= service_url(opts)
           caps = opts.delete(:capabilities)
           # NOTE: This is deprecated
           cap_array = caps.is_a?(Hash) ? [caps] : Array(caps)
@@ -125,8 +123,17 @@ module Appium
         #                     Other place holders can be specified with +:+ prefix like +:id+.
         #                     Then, the +:id+ will be replaced with a given value as the seconds argument of +execute+
         # @param [Symbol] name The name of method that is called as the driver instance method.
-        # @param [Proc] block The block to involve as the method
-        # @raise [ArgumentError] If the given +name+ is already defined or +method+ are invalid value.
+        # @param [Proc] block The block to involve as the method.
+        #                     Please define a method that has the same +name+ with arguments you want.
+        #                     The method must has +execute+ method. tHe +execute+ is calls the +url+
+        #                     with the given parameters.
+        #                     The first argument should be +name+ as symbol.
+        #                     The second argument should be hash. If keys in the hash matches +:+ prefix
+        #                     string in the given url, the matched string in the given url will be
+        #                     values in the hash.
+        #                     The third argument should be hash. The hash will be the request body.
+        #                     Please read examples below for more details.
+        # @raise [ArgumentError] If the given +method+ is invalid value.
         #
         # @example
         #
@@ -153,6 +160,7 @@ module Appium
         #   # ':session_id' in the given 'url' is replaced with current 'session id'.
         #   @driver.test_command(1)
         #
+        #
         #   @driver.add_command(
         #     method: :post,
         #     url: 'session/:session_id/element/:id/custom/action',
@@ -167,7 +175,8 @@ module Appium
         #   # ':session_id' in the given url is replaced with current 'session id'.
         #   # ':id' in the given url is replaced with the given 'element_id'.
         #   e = @driver.find_element :accessibility_id, 'an element'
-        #   @driver.test_action_command(e.ref, 'action')
+        #   _, element_id = e.ref
+        #   @driver.test_action_command(element_id, 'action')
         #
         def add_command(method:, url:, name:, &block)
           unless AVAILABLE_METHODS.include? method
@@ -434,30 +443,6 @@ module Appium
         end
         alias set_context context=
 
-        # Set the value to element directly
-        #
-        # @example
-        #
-        #   @driver.set_immediate_value element, 'hello'
-        #
-        def set_immediate_value(element, *value)
-          ::Appium::Logger.warn '[DEPRECATION] driver#set_immediate_value(element, *value) is deprecated. ' \
-            'Use Element#immediate_value(*value) instead'
-          @bridge.set_immediate_value(element, *value)
-        end
-
-        # Replace the value to element directly
-        #
-        # @example
-        #
-        #   @driver.replace_value element, 'hello'
-        #
-        def replace_value(element, *value)
-          ::Appium::Logger.warn '[DEPRECATION] driver#replace_value(element, *value) is deprecated. ' \
-            'Use Element#replace_value(*value) instead'
-          @bridge.replace_value(element, *value)
-        end
-
         # Place a file in a specific location on the device.
         # On iOS, the server should have ifuse libraries installed and configured properly for this feature to work on
         # real devices.

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

@@ -52,19 +52,26 @@ module Appium
         # @param [String, Number] latitude Set the latitude.
         # @param [String, Number] longitude Set the longitude.
         # @param [String, Number] altitude Set the altitude.
-        # @param [String, Number] speed Set the speed to apply the location on Android real devices @since Appium 1.21.0.
+        # @param [String, Number] speed Set the speed to apply the location on Android real devices
+        #                               in meters/second @since Appium 1.21.0 and in knots for emulators @since Appium 1.22.0.
+        # @param [String, Number] satellites Sets the count of geo satellites being tracked in range 1..12 @since Appium 1.22.0.
+        #                                    This number is respected on Emulators.
         # @param [::Selenium::WebDriver::Location]
         #
         # @example
         #
         #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
         #
-        def set_location(latitude, longitude, altitude, speed: nil)
-          if speed.nil?
+        def set_location(latitude, longitude, altitude, speed: nil, satellites: nil)
+          if speed.nil? && satellites.nil?
             self.location = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
           else
             loc = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
-            @bridge.set_location loc.latitude, loc.longitude, loc.altitude, speed: Float(speed)
+
+            speed = Float(speed) unless speed.nil?
+            satellites = Integer(satellites) unless satellites.nil?
+
+            @bridge.set_location loc.latitude, loc.longitude, loc.altitude, speed: speed, satellites: satellites
           end
         end
       end

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

@@ -82,11 +82,12 @@ module Appium
         #     @@driver.element_screenshot_as element, :base64 #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
         #
         def element_screenshot_as(element, format)
+          _, element_id = element.ref
           case format
           when :base64
-            bridge.take_element_screenshot(element)
+            bridge.element_screenshot element_id
           when :png
-            bridge.take_element_screenshot(element).unpack('m')[0]
+            bridge.element_screenshot(element_id).unpack('m')[0]
           else
             raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
           end
@@ -106,7 +107,7 @@ module Appium
             ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
                                   'It should end with .png extension'
           end
-          viewport_screenshot_encode64 = bridge.take_viewport_screenshot
+          viewport_screenshot_encode64 = bridge.viewport_screenshot
           File.open(png_path, 'wb') { |f| f << viewport_screenshot_encode64.unpack('m')[0] }
         end
       end

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

@@ -17,12 +17,12 @@ module Appium
     class Base
       module Device
         module Value
-          def set_immediate_value(element, *value)
-            execute :set_immediate_value, { id: element.ref }, generate_value_and_text(value)
+          def set_immediate_value(element_id, *value)
+            execute :set_immediate_value, { id: element_id }, generate_value_and_text(value)
           end
 
-          def replace_value(element, *value)
-            execute :replace_value, { id: element.ref }, generate_value_and_text(value)
+          def replace_value(element_id, *value)
+            execute :replace_value, { id: element_id }, generate_value_and_text(value)
           end
 
           private

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

@@ -195,7 +195,10 @@ module Appium
       end
 
       def args_with_ele_ref(args)
-        args[:element] = args[:element].ref if args.key? :element
+        if args.key? :element
+          _, element_id = args[:element].ref
+          args[:element] = element_id
+        end
         args
       end
     end # class TouchAction

data/lib/appium_lib_core/element.rb

@@ -59,20 +59,20 @@ module Appium
       #
       # @example
       #
-      #   @driver.immediate_value 'hello'
+      #   element.immediate_value 'hello'
       #
       def immediate_value(*value)
-        @bridge.set_immediate_value(self, *value)
+        @bridge.set_immediate_value @id, *value
       end
 
       # Replace the value to element directly
       #
       # @example
       #
-      #   @driver.replace_value 'hello'
+      #   element.replace_value 'hello'
       #
       def replace_value(*value)
-        @bridge.replace_value(self, *value)
+        @bridge.replace_value @id, *value
       end
 
       # For use with location_rel.
@@ -108,7 +108,7 @@ module Appium
       #     element.screenshot #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
       #
       def screenshot
-        bridge.take_element_screenshot(self)
+        bridge.element_screenshot @id
       end
 
       # Return an element screenshot in the given format
@@ -123,9 +123,9 @@ module Appium
       def screenshot_as(format)
         case format
         when :base64
-          bridge.take_element_screenshot(self)
+          bridge.element_screenshot @id
         when :png
-          bridge.take_element_screenshot(self).unpack('m')[0]
+          bridge.element_screenshot(@id).unpack('m')[0]
         else
           raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
         end

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.0.0.beta4' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-06-11' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0.rc1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-09-09' unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,12 @@
+#### v4.7.0 2021-07-17
+
+- [0059974](https://github.com/appium/ruby_lib_core/commit/0059974b0b1d79a822db84d8b0169e8393e00ef9) Release 4.7.0
+- [0f93a52](https://github.com/appium/ruby_lib_core/commit/0f93a52bbdc44bf916c9b974fe9fd09d48e5ff39) test: add more example and test (#328)
+- [9e37b3b](https://github.com/appium/ruby_lib_core/commit/9e37b3bc15f72f7c0117a49945a3fe482598f374) feat: add satellites for Android emulators (#327)
+- [3063a73](https://github.com/appium/ruby_lib_core/commit/3063a73fa291dc378daa53b7df2e4b0b8a6f03d2) ci: calls quit_driver to ensure close the previous session
+- [43fb9e7](https://github.com/appium/ruby_lib_core/commit/43fb9e77f5492a92f4f8c5a5bda71be9c3a9e2c8) chore: tweak naming in an internal variable
+
+
 #### v4.6.0 2021-06-03
 
 - [0dacfab](https://github.com/appium/ruby_lib_core/commit/0dacfab1256e1447e1f7a5974dfcf48ee0a72b9d) Release 4.6.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta4
+  version: 5.0.0.rc1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta4
+        version: 4.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta4
+        version: 4.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.12.1
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement