appium_lib_core 8.0.2 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e57b152d3c94c2b86f65520b00899c2f9c5bd0231a8496c9f0726849601e93
-  data.tar.gz: ec392fd1c14218a5306489c05c3364dcd15a6a5f1191e2a42589698429fb9e8c
+  metadata.gz: ccf2b5c0df2ae8489c0c9b3382d260f2464c20828b02484888c7f1c738a42084
+  data.tar.gz: 6aa81ba96bd097f6075a947656533fd20476de3199855827d4278e71449b842e
 SHA512:
-  metadata.gz: d4525eac2deb92a9356842d1fa9d518029d8166df50dbc628661e3637ed3f1c0527bfdb7c302a6f2d3fc32c39eee2ca2ca405fd72b572e7413bb91ee0ec66b2b
-  data.tar.gz: 645d56159c0a8f444511ef25e6ef7d1ead6a428360928adc3219fc2c3e105d6d1fd6dbf204841a107657eecc64c6cfee0dd4326851771fc9eb73b1bc9f79c80b
+  metadata.gz: 7b7c967d705ffd0034af99c930ed6840e272a064cda6dd461710ac8990413b1ee7de7bbb577e9a3231113ec77c5007b737beb82811600c5d2061d21add41b129
+  data.tar.gz: 24405ae6731acb21cc504d0867410523a63943244d718700b0c24504bdf9cecae0ae54b7e5a647660cd8aec7e5bd9bd6391e160e1796246250e6dfecd78ca2ec

data/CHANGELOG.md

@@ -10,6 +10,15 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [9.0.0] - 2024-05-14
+
+### Deprecations
+- Stop converting snake cases to camel case for symbols in capabilities
+    - Please define camel/snake cases in capabilities as-is for the WebDriver capabilities
+- Stop implicit symbolizing capabilities
+    - Historically ruby_lib/ruby_lib_core symbolized capabilities keys from string internally.
+    - `Appium.symbolize_keys` to build symbolized capabilities if issues occurred by this change.
+
 ## [8.0.2] - 2024-04-26
 
 ### Enhancements

data/appium_lib_core.gemspec

@@ -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.23.0'
-  spec.add_development_dependency 'rubocop', '1.63.3'
+  spec.add_development_dependency 'rubocop', '1.63.5'
   spec.add_development_dependency 'appium_thor', '~> 2.0'
   spec.add_development_dependency 'parallel_tests'
   spec.add_development_dependency 'simplecov'

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

@@ -23,6 +23,20 @@ module Appium
         # Appium's capabilities could change by depending on Appium versions. So it does not have
         # standard options like chrome and firefox etc. So, the implementation should differ from
         # other browsers. But here should inherit `Options` to follow Selenium.
+
+        # Method override
+        # FIXME: when we drop "symbolize_keys", this can be removed.
+        def convert_key(key)
+          case key
+          when String
+            key.to_s
+          when Symbol
+            # here do not convert to camel case
+            key.to_s
+          else
+            raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
+          end
+        end
       end
     end
   end

data/lib/appium_lib_core/driver.rb

@@ -338,12 +338,6 @@ module Appium
       def setup_for_new_session(opts = {})
         @custom_url = opts.delete :url # to set the custom url as :url
 
-        # TODO: Remove when we implement Options
-        # The symbolize_keys is to keep compatiility for the legacy code, which allows capabilities to give 'string' as the key.
-        # The toplevel `caps`, `capabilities` and `appium_lib` are expected to be symbol.
-        # FIXME: First, please try to remove `nested: true` to `nested: false`.
-        opts = Appium.symbolize_keys(opts, nested: true)
-
         @caps = get_caps(opts)
 
         set_appium_lib_specific_values(get_appium_lib_opts(opts))
@@ -635,22 +629,27 @@ module Appium
         opts[:appium_lib] || {}
       end
 
+      # @private
+      def get_app
+        @caps[:app] || @caps['app']
+      end
+
       # @private
       # Path to the .apk, .app or .app.zip.
       # The path can be local, HTTP/S, Windows Share and other path like 'sauce-storage:'.
       # Use @caps[:app] without modifications if the path isn't HTTP/S or local path.
       def set_app_path
         # FIXME: maybe `:app` should check `app` as well.
-        return unless @caps && @caps[:app] && !@caps[:app].empty?
-        return if @caps[:app] =~ URI::DEFAULT_PARSER.make_regexp
-
-        app_path = File.expand_path(@caps[:app])
-        @caps[:app] = if File.exist? app_path
-                        app_path
-                      else
-                        ::Appium::Logger.warn("Use #{@caps[:app]} directly since #{app_path} does not exist.")
-                        @caps[:app]
-                      end
+        return unless @caps && get_app && !get_app.empty?
+        return if get_app =~ URI::DEFAULT_PARSER.make_regexp
+
+        app_path = File.expand_path(get_app)
+        @caps['app'] = if File.exist? app_path
+                         app_path
+                       else
+                         ::Appium::Logger.warn("Use #{get_app} directly since #{app_path} does not exist.")
+                         get_app
+                       end
       end
 
       # @private
@@ -676,7 +675,6 @@ module Appium
       # @private
       def set_appium_device
         # https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile
-        # TODO: check if the Appium.symbolize_keys(opts, nested: false) enoug with this
         @device = @caps[:platformName] || @caps['platformName']
         return @device unless @device
 
@@ -685,7 +683,6 @@ module Appium
 
       # @private
       def set_automation_name
-        # TODO: check if the Appium.symbolize_keys(opts, nested: false) enoug with this
         candidate = @caps[:automationName] || @caps['automationName']
         @automation_name = candidate if candidate
         @automation_name = convert_downcase @automation_name if @automation_name

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '8.0.2' unless defined? ::Appium::Core::VERSION
-    DATE    = '2024-04-26' unless defined? ::Appium::Core::DATE
+    VERSION = '9.0.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2024-05-14' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -22,15 +22,17 @@ require_relative 'appium_lib_core/element'
 require_relative 'appium_lib_core/support/event_firing_bridge'
 
 module Appium
-  # @private
-  #
   # convert the top level keys to symbols.
   #
   # @param [Hash] hash Hash value to make symbolise
+  #
+  # @example
+  # opts = Appium.symbolize_keys(opts)
+  #
   def self.symbolize_keys(hash, nested: false, enable_deprecation_msg: true)
     # FIXME: As https://github.com/appium/ruby_lib/issues/945, we must remove this implicit string to symbol.
     # But appium_lib_core's some capability handling expect to be symbol, so we should test to remove
-    # the mehotds which expect the symbol first.
+    # the methods which expect the symbol first.
     raise ::Appium::Core::Error::ArgumentError, 'symbolize_keys requires a hash' unless hash.is_a? Hash
 
     hash.each_with_object({}) do |pair, acc|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 9.0.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.63.3
+        version: 1.63.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.63.3
+        version: 1.63.5
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Minimal Ruby library for Appium.