[GR-21376] Update String#insert to call primitive replace

PullRequest: truffleruby/3368

Author: bjfish

CHANGELOG.md

@@ -15,6 +15,7 @@ Bug fixes:
 * Fix `rb_scan_args_kw` macro to avoid shadowing variables (#2649, @aardvark179).
 * Fix `String#unpack("Z")` to not advance after the null byte, like CRuby (#2659, @aardvark179).
 * Fix `Float#round` to avoid losing precision during the rounding process (@aardvark179).
+* Fix `String#insert` to not call a subclassed string method (@bjfish).
 
 Compatibility:
 

spec/ruby/core/string/insert_spec.rb

@@ -69,4 +69,13 @@
       "あれ".insert 0, pat
     end.should raise_error(Encoding::CompatibilityError)
   end
+
+  it "should not call subclassed string methods" do
+    cls = Class.new(String) do
+      def replace(arg)
+        raise "should not call replace"
+      end
+    end
+    cls.new("abcd").insert(0, 'X').should == "Xabcd"
+  end
 end

src/main/java/org/truffleruby/core/string/StringNodes.java

@@ -1882,10 +1882,10 @@ protected int ord(Object string,
 
     }
 
-    @CoreMethod(names = "replace", required = 1, raiseIfNotMutableSelf = true)
+    @Primitive(name = "string_replace", raiseIfNotMutable = 0)
     @NodeChild(value = "string", type = RubyNode.class)
     @NodeChild(value = "other", type = RubyBaseNodeWithExecute.class)
-    public abstract static class ReplaceNode extends CoreMethodNode {
+    public abstract static class ReplaceNode extends PrimitiveNode {
 
         @CreateCast("other")
         protected ToStrNode coerceOtherToString(RubyBaseNodeWithExecute other) {

src/main/ruby/truffleruby/core/string.rb

@@ -172,6 +172,10 @@ def hex
     Primitive.string_to_inum(self, 16, false, true)
   end
 
+  def replace(other)
+    Primitive.string_replace(self, other)
+  end
+
   def reverse
     Primitive.dup_as_string_instance(self).reverse!
   end
@@ -392,7 +396,7 @@ def encode!(to=undefined, from=undefined, **options)
           status = ec.primitive_convert src, dest, nil, nil
         end
 
-        return replace(dest)
+        return Primitive.string_replace(self, dest)
       else
         force_encoding to_enc
       end
@@ -568,10 +572,10 @@ def inspect
 
   def prepend(*others)
     if others.size == 1
-      replace(StringValue(others.first) + self)
+      Primitive.string_replace(self, StringValue(others.first) + self)
     else
       reduced = others.reduce(''.encode(self.encoding)) { |memo, other| memo + StringValue(other) }
-      replace(StringValue(reduced) + self)
+      Primitive.string_replace(self, StringValue(reduced) + self)
     end
   end
 
@@ -622,7 +626,7 @@ def sub(pattern, replacement=undefined, &block)
     matches = Truffle::StringOperations.gsub_internal_matches(false, self, pattern)
     res = Truffle::StringOperations.gsub_match_and_replace(s, matches, replacement, &block)
     Primitive.regexp_last_match_set(Primitive.caller_special_variables, matches.last)
-    s.replace(res) if res
+    Primitive.string_replace(s, res) if res
     s
   end
 
@@ -637,7 +641,7 @@ def sub!(pattern, replacement=undefined, &block)
     res = Truffle::StringOperations.gsub_match_and_replace(self, matches, replacement, &block)
     Primitive.regexp_last_match_set(Primitive.caller_special_variables, matches.last)
     if res
-      replace(res)
+      Primitive.string_replace(self, res)
       self
     else
       nil
@@ -867,7 +871,7 @@ def gsub(pattern, replacement=undefined, &block)
     matches = Truffle::StringOperations.gsub_internal_matches(true, self, pattern)
     res = Truffle::StringOperations.gsub_match_and_replace(s, matches, replacement, &block)
     Primitive.regexp_last_match_set(Primitive.caller_special_variables, matches.last)
-    s.replace(res) if res
+    Primitive.string_replace(s, res) if res
     s
   end
 
@@ -882,7 +886,7 @@ def gsub!(pattern, replacement=undefined, &block)
     res = Truffle::StringOperations.gsub_match_and_replace(self, matches, replacement, &block)
     Primitive.regexp_last_match_set(Primitive.caller_special_variables, matches.last)
     if res
-      replace(res)
+      Primitive.string_replace(self, res)
       self
     else
       nil
@@ -946,7 +950,7 @@ def scrub(replace = nil, &block)
 
   def scrub!(replace = nil, &block)
     return self if valid_encoding?
-    replace(scrub(replace, &block))
+    Primitive.string_replace(self, scrub(replace, &block))
     self
   end
 
@@ -1151,13 +1155,13 @@ def insert(index, other)
     Primitive.check_mutable_string self
 
     if index == 0
-      replace(other + self)
+      Primitive.string_replace(self, other + self)
     elsif index == length
       self << other
     else
       left = self[0...index]
       right = self[index..-1]
-      replace(left + other + right)
+      Primitive.string_replace(self, left + other + right)
     end
 
     self
@@ -1297,7 +1301,7 @@ def unicode_normalize(form = :nfc)
   end
 
   def unicode_normalize!(form = :nfc)
-    replace(unicode_normalize(form))
+    Primitive.string_replace(self, unicode_normalize(form))
   end
 
   def unicode_normalized?(form = :nfc)