Add specs for ObjectSpace::WeakKeyMap

[Feature #18498]

spec/ruby/core/objectspace/weakkeymap/element_reference_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../../../spec_helper'
+
+ruby_version_is "3.3" do
+  describe "ObjectSpace::WeakKeyMap#[]" do
+    it "is faithful to the map's content" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2 = %w[a b].map(&:upcase)
+      ref1, ref2 = %w[x y]
+      map[key1] = ref1
+      map[key1].should == ref1
+      map[key1] = ref1
+      map[key1].should == ref1
+      map[key2] = ref2
+      map[key1].should == ref1
+      map[key2].should == ref2
+    end
+
+    it "matches using equality semantics" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2 = %w[a a].map(&:upcase)
+      ref = "x"
+      map[key1] = ref
+      map[key2].should == ref
+    end
+  end
+end

spec/ruby/core/objectspace/weakkeymap/element_set_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../../../spec_helper'
+
+ruby_version_is "3.3" do
+  describe "ObjectSpace::WeakKeyMap#[]=" do
+    def should_accept(map, key, value)
+      (map[key] = value).should == value
+      map.should.key?(key)
+      map[key].should == value
+    end
+
+    def should_not_accept(map, key, value)
+      -> { map[key] = value }.should raise_error(ArgumentError)
+    end
+
+    it "is correct" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2 = %w[a b].map(&:upcase)
+      ref1, ref2 = %w[x y]
+      should_accept(map, key1, ref1)
+      should_accept(map, key1, ref1)
+      should_accept(map, key2, ref2)
+      map[key1].should == ref1
+    end
+
+    it "requires the keys to implement #hash" do
+      map = ObjectSpace::WeakKeyMap.new
+      -> { map[BasicObject.new] = 1 }.should raise_error(NoMethodError, "undefined method `hash' for an instance of BasicObject")
+    end
+
+    it "accepts frozen keys or values" do
+      map = ObjectSpace::WeakKeyMap.new
+      x = Object.new
+      should_accept(map, x, true)
+      should_accept(map, x, false)
+      should_accept(map, x, 42)
+      should_accept(map, x, :foo)
+
+      y = Object.new.freeze
+      should_accept(map, x, y)
+      should_accept(map, y, x)
+    end
+
+    it "rejects symbols as keys" do
+      map = ObjectSpace::WeakKeyMap.new
+      should_not_accept(map, :foo, true)
+      should_not_accept(map, rand.to_s.to_sym, true)
+    end
+
+    it "rejects integers as keys" do
+      map = ObjectSpace::WeakKeyMap.new
+      should_not_accept(map, 42, true)
+      should_not_accept(map, 2 ** 68, true)
+    end
+
+    it "rejects floats as keys" do
+      map = ObjectSpace::WeakKeyMap.new
+      should_not_accept(map, 4.2, true)
+    end
+
+    it "rejects booleans as keys" do
+      map = ObjectSpace::WeakKeyMap.new
+      should_not_accept(map, true, true)
+      should_not_accept(map, false, true)
+    end
+
+    it "rejects nil as keys" do
+      map = ObjectSpace::WeakKeyMap.new
+      should_not_accept(map, nil, true)
+    end
+  end
+end

spec/ruby/core/objectspace/weakkeymap/getkey_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../../../spec_helper'
+
+ruby_version_is "3.3" do
+  describe "ObjectSpace::WeakKeyMap#getkey" do
+    it "returns the existing equal key" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2 = %w[a a].map(&:upcase)
+
+      map[key1] = true
+      map.getkey(key2).should equal(key1)
+      map.getkey("X").should == nil
+    end
+  end
+end

spec/ruby/core/objectspace/weakkeymap/inspect_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../../spec_helper'
+
+ruby_version_is "3.3" do
+  describe "ObjectSpace::WeakKeyMap#inspect" do
+    it "only displays size in output" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2, key3 = "foo", "bar", "bar"
+      map.inspect.should =~ /\A\#<ObjectSpace::WeakKeyMap:0x\h+ size=0>\z/
+      map[key1] = 1
+      map.inspect.should =~ /\A\#<ObjectSpace::WeakKeyMap:0x\h+ size=1>\z/
+      map[key2] = 2
+      map.inspect.should =~ /\A\#<ObjectSpace::WeakKeyMap:0x\h+ size=2>\z/
+      map[key3] = 3
+      map.inspect.should =~ /\A\#<ObjectSpace::WeakKeyMap:0x\h+ size=2>\z/
+    end
+  end
+end

spec/ruby/core/objectspace/weakkeymap/key_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../../../spec_helper'
+
+ruby_version_is "3.3" do
+  describe "ObjectSpace::WeakKeyMap#key?" do
+    it "recognizes keys in use" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2 = %w[a b].map(&:upcase)
+      ref1, ref2 = %w[x y]
+
+      map[key1] = ref1
+      map.key?(key1).should == true
+      map[key1] = ref1
+      map.key?(key1).should == true
+      map[key2] = ref2
+      map.key?(key2).should == true
+    end
+
+    it "matches using equality semantics" do
+      map = ObjectSpace::WeakKeyMap.new
+      key1, key2 = %w[a a].map(&:upcase)
+      ref = "x"
+      map[key1] = ref
+      map.key?(key2).should == true
+    end
+
+    it "reports true if the pair exists and the value is nil" do
+      map = ObjectSpace::WeakKeyMap.new
+      key = Object.new
+      map[key] = nil
+      map.key?(key).should == true
+    end
+  end
+end

weakmap.c

@@ -727,8 +727,9 @@ wkmap_aset(VALUE self, VALUE key, VALUE value)
     struct weakkeymap *w;
     TypedData_Get_Struct(self, struct weakkeymap, &weakkeymap_type, w);
 
-    if (!(FL_ABLE(key) && !SYMBOL_P(key) && !RB_BIGNUM_TYPE_P(key))) {
+    if (!FL_ABLE(key) || SYMBOL_P(key) || RB_BIGNUM_TYPE_P(key) || RB_TYPE_P(key, T_FLOAT)) {
         rb_raise(rb_eArgError, "WeakKeyMap must be garbage collectable");
+        UNREACHABLE_RETURN(Qnil);
     }
 
     st_index_t hash = wkmap_lookup_hash(w, key);