[rb] deprecate old JWP capabilities aliases

titusfortner · titusfortner · commit 9776b0bced18 · 2022-12-24T20:56:10.000-06:00
diff --git a/rb/lib/selenium/webdriver/remote/capabilities.rb b/rb/lib/selenium/webdriver/remote/capabilities.rb
@@ -59,10 +59,25 @@ class Capabilities
         # Backward compatibility
         #
 
-        alias_method :version, :browser_version
-        alias_method :version=, :browser_version=
-        alias_method :platform, :platform_name
-        alias_method :platform=, :platform_name=
+        def version
+          WebDriver.logger.deprecate('`Capabilities#version`', '`Capabilities#browser_version`', id: :jwp_caps)
+          browser_version
+        end
+
+        def version=(value)
+          WebDriver.logger.deprecate('`Capabilities#version=`', '`Capabilities#browser_version=`', id: :jwp_caps)
+          self.browser_version = value
+        end
+
+        def platform
+          WebDriver.logger.deprecate('`Capabilities#platform`', '`Capabilities#platform_name`', id: :jwp_caps)
+          platform_name
+        end
+
+        def platform=(value)
+          WebDriver.logger.deprecate('`Capabilities#platform=`', '`Capabilities#platform_name=`', id: :jwp_caps)
+          self.platform_name = value
+        end
 
         #
         # Convenience methods for the common choices.
diff --git a/rb/spec/integration/selenium/webdriver/element_spec.rb b/rb/spec/integration/selenium/webdriver/element_spec.rb
@@ -94,7 +94,6 @@ module WebDriver
         expect(element.text).to be_empty
       end
 
-
       it 'should send string keys' do
         driver.navigate.to url_for('formPage.html')
         wait_for_element(id: 'working')
diff --git a/rb/spec/integration/selenium/webdriver/spec_support/test_environment.rb b/rb/spec/integration/selenium/webdriver/spec_support/test_environment.rb
@@ -165,7 +165,7 @@ def current_env
           {
             browser: browser,
             driver: driver,
-            version: driver_instance.capabilities.version,
+            version: driver_instance.capabilities.browser_version,
             platform: Platform.os,
             ci: Platform.ci
           }
diff --git a/rb/spec/unit/selenium/webdriver/remote/capabilities_spec.rb b/rb/spec/unit/selenium/webdriver/remote/capabilities_spec.rb
@@ -131,51 +131,83 @@ module Remote
                                           {'browserName' => 'firefox'}).as_json).to eq(expected)
           expect(Capabilities.first_match(Capabilities.chrome, Capabilities.firefox).as_json).to eq(expected)
         end
-      end
 
-      context 'timeouts' do
-        let(:as_json) do
-          {
-            'browserName' => 'chrome',
-            'timeouts' => {
-              'implicit' => 1,
-              'pageLoad' => 2,
-              'script' => 3
+        it 'sets browser version with version' do
+          capabilities = Capabilities.new
+          expect {
+            capabilities.version = 1
+          }.to have_deprecated(:jwp_caps)
+          expect(capabilities.browser_version).to eq 1
+        end
+
+        it 'gets browser version with version' do
+          capabilities = Capabilities.new
+          capabilities.browser_version = 1
+          expect {
+            expect(capabilities.version).to eq 1
+          }.to have_deprecated(:jwp_caps)
+        end
+
+        it 'sets platform name with platform' do
+          capabilities = Capabilities.new
+          capabilities.platform_name = 'this'
+          expect {
+            expect(capabilities.platform).to eq 'this'
+          }.to have_deprecated(:jwp_caps)
+        end
+
+        it 'gets platform name with platform' do
+          capabilities = Capabilities.new
+          expect {
+            capabilities.platform = 'this'
+          }.to have_deprecated(:jwp_caps)
+          expect(capabilities.platform_name).to eq 'this'
+        end
+
+        context 'timeouts' do
+          let(:as_json) do
+            {
+              'browserName' => 'chrome',
+              'timeouts' => {
+                'implicit' => 1,
+                'pageLoad' => 2,
+                'script' => 3
+              }
             }
-          }
-        end
-
-        it 'processes timeouts as hash' do
-          caps = Capabilities.chrome(timeouts: {implicit: 1, page_load: 2, script: 3})
-          expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
-          expect(caps.implicit_timeout).to eq(1)
-          expect(caps.page_load_timeout).to eq(2)
-          expect(caps.script_timeout).to eq(3)
-          expect(caps.as_json).to eq(as_json)
-        end
-
-        it 'processes timeouts via timeouts reader' do
-          caps = Capabilities.chrome
-          caps.timeouts[:implicit] = 1
-          caps.timeouts[:page_load] = 2
-          caps.timeouts[:script] = 3
-          expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
-          expect(caps.implicit_timeout).to eq(1)
-          expect(caps.page_load_timeout).to eq(2)
-          expect(caps.script_timeout).to eq(3)
-          expect(caps.as_json).to eq(as_json)
-        end
-
-        it 'processes timeouts via per-timeout writers' do
-          caps = Capabilities.chrome
-          caps.implicit_timeout = 1
-          caps.page_load_timeout = 2
-          caps.script_timeout = 3
-          expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
-          expect(caps.implicit_timeout).to eq(1)
-          expect(caps.page_load_timeout).to eq(2)
-          expect(caps.script_timeout).to eq(3)
-          expect(caps.as_json).to eq(as_json)
+          end
+
+          it 'processes timeouts as hash' do
+            caps = Capabilities.chrome(timeouts: {implicit: 1, page_load: 2, script: 3})
+            expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
+            expect(caps.implicit_timeout).to eq(1)
+            expect(caps.page_load_timeout).to eq(2)
+            expect(caps.script_timeout).to eq(3)
+            expect(caps.as_json).to eq(as_json)
+          end
+
+          it 'processes timeouts via timeouts reader' do
+            caps = Capabilities.chrome
+            caps.timeouts[:implicit] = 1
+            caps.timeouts[:page_load] = 2
+            caps.timeouts[:script] = 3
+            expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
+            expect(caps.implicit_timeout).to eq(1)
+            expect(caps.page_load_timeout).to eq(2)
+            expect(caps.script_timeout).to eq(3)
+            expect(caps.as_json).to eq(as_json)
+          end
+
+          it 'processes timeouts via per-timeout writers' do
+            caps = Capabilities.chrome
+            caps.implicit_timeout = 1
+            caps.page_load_timeout = 2
+            caps.script_timeout = 3
+            expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
+            expect(caps.implicit_timeout).to eq(1)
+            expect(caps.page_load_timeout).to eq(2)
+            expect(caps.script_timeout).to eq(3)
+            expect(caps.as_json).to eq(as_json)
+          end
         end
       end
     end # Remote

Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ def current_env`
`165`	`165`	`{`
`166`	`166`	`browser: browser,`
`167`	`167`	`driver: driver,`
`168`		`- version: driver_instance.capabilities.version,`
	`168`	`+ version: driver_instance.capabilities.browser_version,`
`169`	`169`	`platform: Platform.os,`
`170`	`170`	`ci: Platform.ci`
`171`	`171`	`}`