[rb][bidi] added script module command and types with test

TamsilAmani · TamsilAmani · commit 93bfbba3c752 · 2023-06-23T00:23:41.000+05:30
diff --git a/rb/.rubocop.yml b/rb/.rubocop.yml
@@ -59,11 +59,15 @@ Metrics/ModuleLength:
     - 'lib/selenium/webdriver/common/platform.rb'
     - 'spec/**/*'
 
+Metrics/ParameterLists:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Max: 9
   Exclude:
     - 'lib/selenium/webdriver/common/local_driver.rb'
     - 'lib/selenium/webdriver/common/logger.rb'
+    - 'lib/selenium/webdriver/bidi/script/protocol_value/remote_value.rb'
 
 Naming/FileName:
   Exclude:
diff --git a/rb/lib/selenium/webdriver/bidi.rb b/rb/lib/selenium/webdriver/bidi.rb
@@ -23,6 +23,7 @@ class BiDi
       autoload :Session, 'selenium/webdriver/bidi/session'
       autoload :LogInspector, 'selenium/webdriver/bidi/log_inspector'
       autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
+      autoload :ScriptManager, 'selenium/webdriver/bidi/script_manager'
 
       def initialize(url:)
         @ws = WebSocketConnection.new(url: url)
diff --git a/rb/lib/selenium/webdriver/bidi/script/evaluate_result/evaluate_result_exception.rb b/rb/lib/selenium/webdriver/bidi/script/evaluate_result/evaluate_result_exception.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# frozen_string_literal = true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class EvaluateResultException
+        attr_accessor :result_type, :realm_id, :exception_details
+
+        def initialize(realm_id, exception_details)
+          @result_type = EvaluateResultType::EXCEPTION
+          @realm_id = realm_id
+          @exception_details = exception_details
+        end
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/evaluate_result/evaluate_result_success.rb b/rb/lib/selenium/webdriver/bidi/script/evaluate_result/evaluate_result_success.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# frozen_string_literal = true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class EvaluateResultSuccess
+        attr_accessor :result_type, :realm_id, :result
+
+        def initialize(realm_id, value)
+          @result_type = EvaluateResultType::SUCCESS
+          @realm_id = realm_id
+          @result = value
+        end
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/evaluate_result/evaluate_result_type.rb b/rb/lib/selenium/webdriver/bidi/script/evaluate_result/evaluate_result_type.rb
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# frozen_string_literal = true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      module EvaluateResultType
+        SUCCESS = 'success'
+        EXCEPTION = 'exception'
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/evaluate_result/exception_details.rb b/rb/lib/selenium/webdriver/bidi/script/evaluate_result/exception_details.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# frozen_string_literal = true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class ExceptionDetails
+        attr_accessor :column_number, :exception, :line_number, :stack_trace, :text
+
+        def initialize(exception_details)
+          @column_number = exception_details.key?('columnNumber') ? exception_details['columnNumber'] : nil
+          @exception = exception_details.key?('exception') ? exception_details['exception'] : nil
+          @line_number = exception_details.key?('lineNumber') ? exception_details['lineNumber'] : nil
+          @stack_trace = exception_details.key?('stackTrace') ? exception_details['stackTrace'] : nil
+          @text = exception_details.key?('text') ? exception_details['text'] : nil
+        end
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_type/non_primitive_type.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_type/non_primitive_type.rb
@@ -30,8 +30,9 @@ module NonPrimitiveType
 
         def self.find_by_name(name)
           NonPrimitiveType.constants.each do |type|
-            return true if name.casecmp(type)
+            return NonPrimitiveType.const_get(type) if name.casecmp?(NonPrimitiveType.const_get(type))
           end
+          nil
         end
       end
     end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_type/primitive_type.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_type/primitive_type.rb
@@ -31,8 +31,8 @@ module PrimitiveType
 
         def self.find_by_name(name)
           PrimitiveType.constants.each do |type|
-            return true if name.casecmp(type)
-          end
+            return PrimitiveType.const_get(type) if name.casecmp?(PrimitiveType.const_get(type))
+          end; nil
         end
       end
     end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_type/remote_type.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_type/remote_type.rb
@@ -1,4 +1,4 @@
-# frozen_string_literal = true
+# frozen_string_literal: true
 
 # Licensed to the Software Freedom Conservancy (SFC) under one
 # or more contributor license agreements.  See the NOTICE file
@@ -39,8 +39,9 @@ module RemoteType
 
         def self.find_by_name(name)
           RemoteType.constants.each do |type|
-            return true if name.casecmp(type)
+            return RemoteType.const_get(type) if name.casecmp?(RemoteType.const_get(type))
           end
+          nil
         end
       end
     end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_type/special_number_type.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_type/special_number_type.rb
@@ -1,4 +1,4 @@
-# frozen_string_literal = true
+# frozen_string_literal: true
 
 # Licensed to the Software Freedom Conservancy (SFC) under one
 # or more contributor license agreements.  See the NOTICE file
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_value/local_value.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_value/local_value.rb
@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require_relative '../protocol_type/primitive_type'
+require_relative '../protocol_type/non_primitive_type'
+require_relative '../protocol_type/remote_type'
+require_relative '../protocol_type/special_number_type'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class LocalValue
+        TYPE_CONSTANT = 'type'
+        VALUE_CONSTANT = 'value'
+
+        def initialize(type, value: nil)
+          @type = type
+          @value = value unless type.eql?(PrimitiveType::UNDEFINED) && type.eql?(PrimitiveType::NULL)
+        end
+
+        def self.create_string_value(value)
+          LocalValue.new(PrimitiveType::STRING, value: value).as_json
+        end
+
+        def self.create_number_value(value)
+          LocalValue.new(PrimitiveType::NUMBER, value: value).as_json
+        end
+
+        def self.create_special_number_value(value)
+          LocalValue.new(PrimitiveType::SPECIAL_NUMBER, value: value).as_json
+        end
+
+        def self.create_undefined_value
+          LocalValue.new(PrimitiveType::UNDEFINED).as_json
+        end
+
+        def self.create_null_value
+          LocalValue.new(PrimitiveType::NULL).as_json
+        end
+
+        def self.create_boolean_value(value)
+          LocalValue.new(PrimitiveType::BOOLEAN, value: value).as_json
+        end
+
+        def self.create_big_int_value(value)
+          LocalValue.new(PrimitiveType::BIGINT, value: value).as_json
+        end
+
+        def self.create_array_value(value)
+          LocalValue.new(NonPrimitiveType::ARRAY, value: value).as_json
+        end
+
+        def self.create_date_value(value)
+          LocalValue.new(NonPrimitiveType::DATE, value: value).as_json
+        end
+
+        def self.create_map_value(map)
+          value = []
+          map.each { |k, v| value.push([k, v]) }
+          LocalValue.new(NonPrimitiveType::MAP, value: value).as_json
+        end
+
+        def self.create_object_value(map)
+          value = []
+          map.each { |k, v| value.push([k, v]) }
+          LocalValue.new(NonPrimitiveType::OBJECT, value: value).as_json
+        end
+
+        def self.create_regular_expression_value(value)
+          LocalValue.new(NonPrimitiveType::REGULAR_EXPRESSION, value: value).as_json
+        end
+
+        def self.create_set_value(value)
+          LocalValue.new(NonPrimitiveType::SET, value: value).as_json
+        end
+
+        def as_json
+          to_return = {'type' => @type}
+          to_return['value'] = @value unless @type.eql?(PrimitiveType::NULL) && @type.eql?(PrimitiveType::UNDEFINED)
+          to_return
+        end
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_value/reference_value.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_value/reference_value.rb
@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class ReferenceValue
+        REMOTE_REFERENCE_TYPE = {
+          HANDLE: 'handle',
+          SHARED_ID: 'shareId'
+        }.freeze
+
+        def initialize(handle, share_id)
+          if handle.eql? REMOTE_REFERENCE_TYPE[:HANDLE]
+            @handle = share_id
+          else
+            @handle = handle
+            @share_id = share_id
+          end
+        end
+
+        def as_map
+          to_return = {}
+          to_return[REMOTE_REFERENCE_TYPE[:HANDLE]] = @handle unless @handle.nil?
+          to_return[REMOTE_REFERENCE_TYPE[:SHARED_ID]] = @share_id unless @share_id.nil?
+          to_return
+        end
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_value/reg_exp_value.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_value/reg_exp_value.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      module RegExpValue
+        def self.create(pattern:, flags: nil)
+          {
+            'pattern' => pattern,
+            'flags' => flags
+          }
+        end
+      end
+    end
+  end
+end
diff --git a/rb/lib/selenium/webdriver/bidi/script/protocol_value/remote_value.rb b/rb/lib/selenium/webdriver/bidi/script/protocol_value/remote_value.rb
diff --git a/rb/lib/selenium/webdriver/bidi/script/realm_info/realm_info.rb b/rb/lib/selenium/webdriver/bidi/script/realm_info/realm_info.rb
diff --git a/rb/lib/selenium/webdriver/bidi/script/realm_info/realm_type.rb b/rb/lib/selenium/webdriver/bidi/script/realm_info/realm_type.rb
diff --git a/rb/lib/selenium/webdriver/bidi/script/realm_info/window_realm_info.rb b/rb/lib/selenium/webdriver/bidi/script/realm_info/window_realm_info.rb
diff --git a/rb/lib/selenium/webdriver/bidi/script_manager.rb b/rb/lib/selenium/webdriver/bidi/script_manager.rb
diff --git a/rb/spec/integration/selenium/webdriver/bidi/script_manager_spec.rb b/rb/spec/integration/selenium/webdriver/bidi/script_manager_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# frozen_string_literal = true`
	`1`	`+# frozen_string_literal: true`
`2`	`2`
`3`	`3`	`# Licensed to the Software Freedom Conservancy (SFC) under one`
`4`	`4`	`# or more contributor license agreements. See the NOTICE file`