Ruby 3.2 struct compatibility

Author: Arcovion

Gemfile.lock

@@ -7,30 +7,31 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.4.4)
-    rake (13.0.3)
-    rbs (1.5.1)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rbs (1.8.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   typed_struct!
 
 BUNDLED WITH
-   2.1.4
+   2.4.0.dev

lib/typed_struct.rb

@@ -19,13 +19,17 @@ class TypedStruct < Struct
 
   class << self
     def new(opts = Options.new, **properties)
+      if const_defined?("RSpec") && RUBY_VERSION < "3.2" && opts[:keyword_init].nil?
+        opts[:keyword_init] = false
+      end
+
       properties.each_key do |prop|
         if method_defined?(prop)
-          $stdout.puts OVERRIDING_NATIVE_METHOD_MSG % [prop.inspect, caller(3).first]
+          warn OVERRIDING_NATIVE_METHOD_MSG % [prop.inspect, caller(3).first]
         end
       end
 
-      super(*properties.keys, keyword_init: true).tap do |klass|
+      super(opts[:class_name], *properties.keys, keyword_init: opts[:keyword_init]).tap do |klass|
         klass.class.instance_eval do
           include TypeChecking
           attr_reader :options
@@ -35,9 +39,25 @@ def new(opts = Options.new, **properties)
           @options = { types: properties, options: opts }
 
           define_method :[]= do |key, val|
+            if key.is_a?(Integer)
+              key = if key.negative?
+                offset = self.members.size + key
+                if offset.negative?
+                  raise IndexError, "offset #{key} too small for struct(size:#{self.members.size})"
+                end
+                self.members[offset]
+              elsif key >= self.members.size
+                raise IndexError, "offset #{key} too large for struct(size:#{self.members.size})"
+              else
+                self.members[key]
+              end
+            end
+            unless properties.key?(key)
+              raise NameError, "no member '#{key}' in struct"
+            end
             prop = properties[key]
             unless val_is_type? val, prop
-              raise "Unexpected type #{val.class} for #{key.inspect} (expected #{prop})"
+              raise TypeError, "unexpected type #{val.class} for #{key.inspect} (expected #{prop})"
             end
 
             super key, val
@@ -53,18 +73,41 @@ def new(opts = Options.new, **properties)
     end
   end
 
-  def initialize(**attrs)
+  def initialize(*positional_attrs, **attrs)
     opts = self.__class__.options
+    if opts[:options][:keyword_init] == true && !positional_attrs.empty?
+      raise ArgumentError, "wrong number of arguments (given #{positional_attrs.size}, expected 0)"
+    elsif (opts[:options][:keyword_init] == false && !attrs.empty?) ||
+        (opts[:options][:keyword_init] != true && !positional_attrs.empty?)
+      positional_attrs << attrs unless attrs.empty?
+      attrs = positional_attrs.zip(self.members).to_h(&:reverse)
+    end
+
+    if !positional_attrs.empty? && attrs.size > self.members.size
+      raise ArgumentError, "struct size differs"
+    elsif !(attrs.keys - self.members).empty?
+      raise ArgumentError, "unknown keywords: #{(attrs.keys - self.members).join(', ')}"
+    end
+
     vals = opts[:types].to_h do |prop, expected_type|
       value = attrs.fetch(prop, opts[:options][:default])
       unless val_is_type? value, expected_type
-        raise "Unexpected type #{value.class} for #{prop.inspect} (expected #{expected_type})"
+        raise TypeError, "unexpected type #{value.class} for #{prop.inspect} (expected #{expected_type})"
       end
       [prop, value]
     end
 
-    super **vals
+    if opts[:options][:keyword_init]
+      super **vals
+    else
+      super *vals.values
+    end
   end
 
-  Options = TypedStruct.new({ default: nil }, default: Rbs("untyped"))
+  Options = TypedStruct.new(
+    { default: nil, keyword_init: true },
+    default: Rbs("untyped"),
+    keyword_init: Rbs("bool?"),
+    class_name: Rbs("String? | Symbol?")
+  )
 end