fix: keyword argument in Ruby 3

appium · Dec 26, 2020 · 6b2d7dd · 6b2d7dd
1 parent 943e0da
commit 6b2d7dd
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,9 +5,11 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
-- Ruby 3.0 support
 
 ### Bug fixes
+- Argument of `@driver.execute_cdp`
+    - It should be like `@driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'` as keyword arguments
+      instead of `@driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }` in Ruby 3
 
 ### Deprecations
 

diff --git a/lib/appium_lib_core/android/device.rb b/lib/appium_lib_core/android/device.rb
@@ -290,16 +290,16 @@ module Device
         #   @driver.finger_print 1
         #
 
-        # @!method execute_cdp(cmd, params)
+        # @!method execute_cdp(cmd, **params)
         #     Execute Chrome Devtools protocol commands
         #     https://chromedevtools.github.io/devtools-protocol
         #
         # @param [String] cmd The name of command
-        # @param [Hash] params The parameter for the command as hash.
+        # @option params The parameter for the command as keyword options.
         #
         # @example
         #
-        #   @driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }
+        #   @driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'
         #   @driver.execute_cdp 'Page.getResourceTree'
         #
 
@@ -415,7 +415,7 @@ def end_coverage(path, intent)
               # SeleniumWebdriver could already define this method
               return if method_defined? :execute_cdp
 
-              def execute_cdp(cmd, params = {})
+              def execute_cdp(cmd, **params)
                 execute :chrome_send_command, {}, { cmd: cmd, params: params }
               end
             end

diff --git a/test/unit/android/device/w3c/commands_test.rb b/test/unit/android/device/w3c/commands_test.rb
@@ -503,7 +503,7 @@ def test_chromium_send_command
               .with(body: { cmd: 'Page.captureScreenshot', params: { quality: 1, format: 'jpeg' } }.to_json)
               .to_return(headers: HEADER, status: 200, body: { value: { data: '/9j/4AAQSkZJRgABAQAAAQABAAD' } }.to_json)
 
-            r = @driver.execute_cdp 'Page.captureScreenshot', { quality: 1, format: 'jpeg' }
+            r = @driver.execute_cdp 'Page.captureScreenshot', quality: 1, format: 'jpeg'
 
             assert_requested(:post, "#{SESSION}/goog/cdp/execute", times: 1)
             assert_equal '/9j/4AAQSkZJRgABAQAAAQABAAD', r['data']