[GR-45621] Add syntaxerror path

PullRequest: truffleruby/4213

Author: andrykonchin

CHANGELOG.md

@@ -80,6 +80,7 @@ Compatibility:
 * Remove deprecated `Fixnum` and `Bignum` constants (#3039, @andrykonchin).
 * Add `rb_enc_interned_str_cstr` function (#3408, @goyox86, @thomasmarshall).
 * Add `rb_str_to_interned_str` function (#3408, @thomasmarshall).
+* Add `SyntaxError#path` method (#3039, @wasabigeek).
 
 Performance:
 

spec/ruby/core/exception/fixtures/syntax_error.rb

@@ -0,0 +1 @@
+1+1=2

spec/ruby/core/exception/syntax_error_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../../spec_helper'
+
+ruby_version_is "3.2" do
+  describe "SyntaxError#path" do
+    it "returns the file path provided to eval" do
+      filename = "speccing.rb"
+
+      -> {
+        eval("if true", TOPLEVEL_BINDING, filename)
+      }.should raise_error(SyntaxError) { |e|
+        e.path.should == filename
+      }
+    end
+
+    it "returns the file path that raised an exception" do
+      expected_path = fixture(__FILE__, "syntax_error.rb")
+
+      -> {
+        require_relative "fixtures/syntax_error"
+      }.should raise_error(SyntaxError) { |e| e.path.should == expected_path }
+    end
+
+    it "returns nil when constructed directly" do
+      SyntaxError.new.path.should == nil
+    end
+  end
+end

spec/ruby/core/kernel/eval_spec.rb

@@ -135,7 +135,7 @@
   it "includes file and line information in syntax error" do
     expected = 'speccing.rb'
     -> {
-      eval('if true',TOPLEVEL_BINDING, expected)
+      eval('if true', TOPLEVEL_BINDING, expected)
     }.should raise_error(SyntaxError) { |e|
       e.message.should =~ /#{expected}:1:.+/
     }
@@ -144,7 +144,7 @@
   it "evaluates string with given filename and negative linenumber" do
     expected_file = 'speccing.rb'
     -> {
-      eval('if true',TOPLEVEL_BINDING, expected_file, -100)
+      eval('if true', TOPLEVEL_BINDING, expected_file, -100)
     }.should raise_error(SyntaxError) { |e|
       e.message.should =~ /#{expected_file}:-100:.+/
     }

src/main/java/org/truffleruby/core/exception/SyntaxErrorNodes.java

@@ -12,12 +12,17 @@
 import org.truffleruby.annotations.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
 import org.truffleruby.annotations.CoreModule;
+import org.truffleruby.core.encoding.Encodings;
 import org.truffleruby.core.klass.RubyClass;
 import org.truffleruby.annotations.Visibility;
 import org.truffleruby.language.objects.AllocationTracing;
 
+import com.oracle.truffle.api.CompilerDirectives;
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.object.Shape;
+import com.oracle.truffle.api.source.Source;
 
 @CoreModule(value = "SyntaxError", isClass = true)
 public abstract class SyntaxErrorNodes {
@@ -35,4 +40,27 @@ RubySyntaxError allocateSyntaxError(RubyClass rubyClass) {
 
     }
 
+    @CoreMethod(names = "path")
+    public abstract static class PathNode extends CoreMethodArrayArgumentsNode {
+
+        @TruffleBoundary
+        @Specialization
+        Object path(RubySyntaxError syntaxError) {
+            if (!syntaxError.hasSourceLocation()) {
+                return nil;
+            }
+
+            Source source;
+            try {
+                source = syntaxError.getSourceLocation().getSource();
+            } catch (UnsupportedMessageException e) {
+                throw CompilerDirectives.shouldNotReachHere(e);
+            }
+
+            var path = getLanguage().getPathToTStringCache().getCachedPath(source);
+            return createString(path, Encodings.UTF_8);
+        }
+
+    }
+
 }