appium_lib_core 5.0.0.rc5 → 5.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19a2c4c9f752e5f2e4287ce8b0d53bc428bafaa997b58c40bc0b796b878eadeb
-  data.tar.gz: 451e46bc56fa768879ab680520dff4ec137455ca020e1176f3022160d1a46009
+  metadata.gz: c4ee843cbe6c1b2cb6d84fcc40000c017d8334ba542012b304d21d66ffa9295a
+  data.tar.gz: c13938466767e24d8d9687d070e63510e73c52fb2d8640d9475e8a4b6ef68c89
 SHA512:
-  metadata.gz: e9e155e17e026514e12657489569b17b389d62cb9d7cd79e8a753e12b37571d4a9d3a3f28227b935b2d3d101747a7ce66d28ff7eb08f6c9cfb7c1c94ca7f3f03
-  data.tar.gz: 13e2620a48fe753b5647a0ffcb6bf370f54796aa3b87ca34522659c219474804dfa7843394307ad84b36dc377a10d2bd5bec782467354abb252e945c27cdd748
+  metadata.gz: a7d82afb3e81636c6759515dd3126ce44308bf61e419bb88860daf62574252ad66ef07d04b4d75a47044e162113436caabccef332d01abbd08fd0d3459b38985
+  data.tar.gz: 8940887d4f189c002dff3d68bd895059a4a085d94f69a582a0998e2a2be7e2a7c6d5ae7575ae71303b836413f3a3638bf8306a07071b5b2e7ed48a7da52b878a

data/.github/workflows/unittest.yml

@@ -29,9 +29,9 @@ jobs:
     - name: Run tests
       run: |
         bundle exec rake rubocop
-        bundle exec parallel_test test/unit/ -n 4
-        AUTOMATION_NAME_DROID=espresso bundle exec parallel_test test/unit/android -n 4
-        AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec parallel_test test/unit -n 4
+        bundle exec rake test:unit
+        AUTOMATION_NAME_DROID=espresso bundle exec rake test:unit:android
+        AUTOMATION_NAME_DROID=appium AUTOMATION_NAME_IOS=appium bundle exec rake test:unit
 
   test-win:
     strategy:
@@ -57,11 +57,11 @@ jobs:
           gem uninstall --force eventmachine && gem install eventmachine --platform ruby
       - name: Run tests
         run: |
-          parallel_test test/unit/ -n 4
+          rake test:unit
 
           setx AUTOMATION_NAME_DROID espresso
-          parallel_test test/unit/android -n 4
+          rake test:unit:android
 
           setx AUTOMATION_NAME_DROID appium
           setx AUTOMATION_NAME_IOS appium
-          parallel_test test/unit -n 4
+          rake test:unit

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 Layout/LineLength:
   Max: 128
 Layout/RescueEnsureAlignment:
@@ -56,3 +56,91 @@ Style/ExplicitBlockArgument:
   Enabled: false
 Style/KeywordParametersOrder:
   Enabled: false
+Gemspec/DateAssignment:
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Security/IoMethods:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/EndlessMethod:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/SelectByRegexp:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

data/CHANGELOG.md

@@ -25,6 +25,8 @@ Read `release_notes.md` for commit level details.
   - Removed `forceMjsonwp` to send only MJSONWP capabilities since Selenium cleint v4 no longer supports MJSONWP
 - No longer set default `timeouts` as `0`. ruby_lib_core calls `/timeouts` endpoint only when `appium_lib: { wait: 5 }` is provided explicitly
 - Raises `::Appium::Core::Error::ArgumentError` instead of `ArgumentError` for this library specific argument errors
+- Add `driver#wait`, `driver#wait_until`, `driver#wait_true`, `driver#wait_until_true` syntaxes
+  - Can give `driver` instance as its block variable
 
 ## [4.7.1] - 2021-09-26
 

data/appium_lib_core.gemspec

@@ -31,7 +31,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.14.0'
-  spec.add_development_dependency 'rubocop', '1.12.1'
+  spec.add_development_dependency 'rubocop', '1.22.2'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional/run_appium.yml

@@ -11,7 +11,7 @@ steps:
   displayName: Installed node dependencies
 - task: UseRubyVersion@0
   inputs:
-    versionSpec: '2.7'
+    versionSpec: '3.0'
 - script: |
     mkdir -p test/report
     nohup appium --relaxed-security --log-timestamp --log-no-colors > test/report/appium.out 2>&1 &

data/ci-jobs/functional_test.yml

@@ -1,7 +1,7 @@
 # jobs for functional test
 parameters:
   vmImage: 'macOS-10.15'
-  vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
+  vmImageForIOS: 'macOS-10.15'
   xcodeForIOS: 12.2
   xcodeForTVOS: 12.2
   androidSDK: 29  # API Level 30 emulators are more unstable than 29

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

@@ -51,7 +51,7 @@ module Appium
         end
 
         # Override
-        # Creates session handling both OSS and W3C dialects.
+        # Creates session handling.
         #
         # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
         # @return [::Selenium::WebDriver::Remote::Capabilities]
@@ -187,8 +187,8 @@ module Appium
 
         # Port from MJSONWP
         def send_keys_to_active_element(key)
-          text = ::Selenium::WebDriver::Keys.encode(key).join('')
-          execute :send_keys_to_active_element, {}, { value: text.split(//) }
+          text = ::Selenium::WebDriver::Keys.encode(key).join
+          execute :send_keys_to_active_element, {}, { value: text.chars }
         end
 
         # For Appium
@@ -319,11 +319,9 @@ module Appium
           data = execute :get_log, {}, { type: type.to_s }
 
           Array(data).map do |l|
-            begin
-              ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-            rescue KeyError
-              next
-            end
+            ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+          rescue KeyError
+            next
           end
         end
 

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

@@ -21,6 +21,7 @@ require_relative 'rotable'
 require_relative 'remote_status'
 require_relative 'has_location'
 require_relative 'has_network_connection'
+require_relative '../wait'
 
 module Appium
   module Core
@@ -38,6 +39,8 @@ module Appium
         include ::Appium::Core::Base::HasLocation
         include ::Appium::Core::Base::HasNetworkConnection
 
+        include ::Appium::Core::Waitable
+
         private
 
         # Private API.
@@ -48,11 +51,7 @@ module Appium
           super
         end
 
-        # Implements protocol handshake which:
-        #
-        #   1. Creates session with driver.
-        #   2. Sniffs response.
-        #   3. Based on the response, understands which dialect we should use.
+        # Create a proper bridge instance.
         #
         # @return [::Appium::Core::Base::Bridge]
         #
@@ -83,7 +82,7 @@ module Appium
         def update_sending_request_to(protocol:, host:, port:, path:)
           unless @bridge.http&.class&.method_defined? :update_sending_request_to
             ::Appium::Logger.warn "#{@bridge.http&.class} has no 'update_sending_request_to'. " \
-              'It keeps current connection target.'
+                                  'It keeps current connection target.'
             return
           end
 

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

@@ -63,8 +63,8 @@ module Appium
         def save_element_screenshot(element, 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'
+            ::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 << element_screenshot_as(element, :png) }
         end

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

@@ -39,11 +39,11 @@ module Appium
             end
 
             # Keep .split(//) for backward compatibility for now
-            text = keys.join('')
+            text = keys.join
 
             # FIXME: further work for W3C. Over appium 1.15.0 or later
             # { value: text.split(//), text: text }
-            { value: text.split(//) }
+            { value: text.chars }
           end
         end # module Value
       end # module Device

data/lib/appium_lib_core/common/wait.rb

@@ -38,6 +38,8 @@ module Appium
         #
         #     result = Appium::Core::Wait.until { @driver.find_element(:id, 'something') }
         #
+        #     result = Appium::Core::Wait.until(timeout: 30, message: 'timeout') { @driver.find_element(:id, 'something') }
+        #
         #     result = Appium::Core::Wait.until(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -82,6 +84,8 @@ module Appium
         #
         #     Appium::Core::Wait.until_true { @driver.find_element(:id, 'something') }
         #
+        #     Appium::Core::Wait.until_true(timeout: 30) { @driver.find_element(:id, 'something') }
+        #
         #     Appium::Core::Wait.until_true(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -133,17 +137,31 @@ module Appium
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
-      # @example
+      # @example With core instance
       #
       #   @core.wait_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @core.wait_until_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_until_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      # @example With driver instance
+      #
+      #   @driver.wait_true { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_true(timeout: 30, interval: 2) { |d| driver.find_element :accessibility_id, 'something' }
       #
-      def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
-        Wait.until_true(timeout: timeout || @wait_timeout,
-                        interval: interval || @wait_interval,
+      #   @driver.wait_until_true { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_until_true(timeout: 30, interval: 2) { |d| driver.find_element :accessibility_id, 'something' }
+      #
+      def wait_until_true(timeout: nil, interval: nil, message: nil, ignored: nil, &block)
+        Wait.until_true(timeout: timeout || @wait_timeout || ::Appium::Core::Wait::DEFAULT_TIMEOUT,
+                        interval: interval || @wait_interval || ::Appium::Core::Wait::DEFAULT_INTERVAL,
                         message: message,
                         ignored: ignored,
-                        object: self) { yield }
+                        object: self,
+                        &block)
       end
+      alias wait_true wait_until_true
 
       # Check every interval seconds to see if yield doesn't raise an exception.
       # Give up after timeout seconds.
@@ -155,17 +173,31 @@ module Appium
       # @param [String] message Exception message if timed out.
       # @param [Array, Exception] ignored Exceptions to ignore while polling (default: Exception)
       #
-      # @example
+      # @example With core instance
       #
       #   @core.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @core.wait_until { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_until(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      # @example With driver instance
+      #
+      #   @driver.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @driver.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
+      #
+      #   @driver.wait_until { |d| d.find_element :accessibility_id, 'something' }
+      #   @driver.wait_until(timeout: 30, interval: 2) { |d| d.find_element :accessibility_id, 'something' }
       #
-      def wait(timeout: nil, interval: nil, message: nil, ignored: nil)
-        Wait.until(timeout: timeout || @wait_timeout,
-                   interval: interval || @wait_interval,
+      def wait_until(timeout: nil, interval: nil, message: nil, ignored: nil, &block)
+        Wait.until(timeout: timeout || @wait_timeout || ::Appium::Core::Wait::DEFAULT_TIMEOUT,
+                   interval: interval || @wait_interval || ::Appium::Core::Wait::DEFAULT_INTERVAL,
                    message: message,
                    ignored: ignored,
-                   object: self) { yield }
+                   object: self,
+                   &block)
       end
+      alias wait wait_until
     end
   end # module Core
 end # module Appium

data/lib/appium_lib_core/driver.rb

@@ -51,7 +51,7 @@ module Appium
 
         @port = appium_lib_opts.fetch :port, Driver::DEFAULT_APPIUM_PORT
 
-        # timeout and interval used in ::Appium::Comm.wait/wait_true
+        # timeout and interval used in ::Appium::Commn.wait/wait_true
         @wait_timeout  = appium_lib_opts.fetch :wait_timeout, ::Appium::Core::Wait::DEFAULT_TIMEOUT
         @wait_interval = appium_lib_opts.fetch :wait_interval, ::Appium::Core::Wait::DEFAULT_INTERVAL
 

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.0.0.rc5' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-10-15' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0.rc6' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-10-23' unless defined? ::Appium::Core::DATE
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc5
+  version: 5.0.0.rc6
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.22.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.22.2
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement