[rb] add mutable and immutable record objects to manage serialization

Author: titusfortner

rb/lib/selenium/webdriver/bidi.rb

@@ -24,7 +24,6 @@ class BiDi
       autoload :LogHandler, 'selenium/webdriver/bidi/log_handler'
       autoload :Browser, 'selenium/webdriver/bidi/browser'
       autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
-      autoload :Struct, 'selenium/webdriver/bidi/struct'
       autoload :Network, 'selenium/webdriver/bidi/network'
       autoload :InterceptedRequest, 'selenium/webdriver/bidi/network/intercepted_request'
       autoload :InterceptedResponse, 'selenium/webdriver/bidi/network/intercepted_response'

rb/lib/selenium/webdriver/bidi/log_handler.rb

@@ -21,8 +21,8 @@ module Selenium
   module WebDriver
     class BiDi
       class LogHandler
-        ConsoleLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source, :method, :args)
-        JavaScriptLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source)
+        ConsoleLogEntry = WebDriver::Types::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source, :method, :args)
+        JavaScriptLogEntry = WebDriver::Types::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source)
 
         def initialize(bidi)
           @bidi = bidi

rb/lib/selenium/webdriver/common/types.rb

@@ -0,0 +1,45 @@
+# 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 Types
+      autoload :Data, 'selenium/webdriver/common/types/data'
+      autoload :Struct, 'selenium/webdriver/common/types/struct'
+
+      def self.camel_to_snake(s)
+        s = s.to_s
+        s.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+         .tr('-', '_')
+         .downcase
+         .sub(/\A_/, '')
+      end
+
+      def self.normalize_args(args, opts)
+        unless args.empty? || (args.length == 1 && args.first.is_a?(Hash))
+          raise ArgumentError, 'positional args not allowed; use keywords or a single hash'
+        end
+
+        raw = opts.any? ? opts : (args.first || {})
+        raw.transform_keys { |k| camel_to_snake(k.to_s).to_sym }
+      end
+    end
+  end # WebDriver
+end # Selenium

rb/lib/selenium/webdriver/common/types/data.rb

@@ -0,0 +1,39 @@
+# 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
+    module Types
+      class Data < ::Data
+        def self.define(*members, &blk)
+          klass = super(*members.map(&:to_sym), &blk)
+
+          klass.singleton_class.prepend(Module.new {
+            def new(*args, **opts)
+              norm = WebDriver::Types.normalize_args(args, opts)
+              super(*members.map { |m| norm[m] })
+            end
+          })
+
+          klass
+        end
+      end
+    end # Types
+  end # WebDriver
+end # Selenium

rb/lib/selenium/webdriver/bidi/struct.rb renamed to rb/lib/selenium/webdriver/common/types/struct.rb

@@ -19,24 +19,25 @@
 
 module Selenium
   module WebDriver
-    class BiDi
+    module Types
       class Struct < ::Struct
         class << self
-          def new(*args, &block)
-            super do
-              define_method(:initialize) do |**kwargs|
-                converted_kwargs = kwargs.transform_keys { |key| self.class.camel_to_snake(key.to_s).to_sym }
-                super(*converted_kwargs.values_at(*self.class.members))
+          def define(*members, &blk)
+            klass = super(*members.map(&:to_sym), keyword_init: true, &blk)
+
+            klass.singleton_class.prepend(Module.new {
+              def new(*args, **opts)
+                norm = WebDriver::Types.normalize_args(args, opts)
+                super(**members.to_h { |m| [m, norm[m]] })
               end
-              class_eval(&block) if block
-            end
-          end
+            })
 
-          def camel_to_snake(camel_str)
-            camel_str.gsub(/([A-Z])/, '_\1').downcase
+            klass
           end
+
+          alias new define
         end
       end
-    end # BiDi
+    end # Types
   end # WebDriver
 end # Selenium

rb/sig/selenium/web_driver/script.rbs renamed to rb/sig/lib/selenium/webdriver/common/script.rbs

@@ -0,0 +1,9 @@
+module Selenium
+  module WebDriver
+    module Types
+      def self.camel_to_snake: (String s) -> String
+
+      def self.normalize_args: (Array[untyped] args, Hash[untyped, untyped] opts) -> Hash[Symbol, untyped]
+    end
+  end
+end

rb/sig/lib/selenium/webdriver/common/types.rbs

@@ -0,0 +1,9 @@
+module Selenium
+  module WebDriver
+    module Types
+      class Data < ::Data
+        def self.define: (*untyped members, ?blk { () -> void }) -> Class
+      end
+    end
+  end
+end

rb/sig/lib/selenium/webdriver/common/types/data.rbs

@@ -0,0 +1,9 @@
+module Selenium
+  module WebDriver
+    module Types
+      class Struct < ::Struct
+        def self.define: (*untyped members, ?keyword_init: bool, ?blk { () -> void }) -> Class
+      end
+    end
+  end
+end