Add encoding into string representation of ImmutableRubyString

andrykonchin · andrykonchin · commit 1b3ceb5d5009 · 2024-03-12T17:10:05.000+02:00
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_and_following_elements.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_and_following_elements.yaml
@@ -105,16 +105,16 @@ ast: |
                                               values = [
                                                   FrozenStringLiteralNode
                                                       attributes:
-                                                          definition = expression
+                                                          definition = "expression" (ASCII-8BIT)
                                                           flags = 0
-                                                          frozenString = bar
+                                                          frozenString = "bar" (UTF-8)
                                                           sourceCharIndex = 31
                                                           sourceLength = 5
                                                   FrozenStringLiteralNode
                                                       attributes:
-                                                          definition = expression
+                                                          definition = "expression" (ASCII-8BIT)
                                                           flags = 0
-                                                          frozenString = baz
+                                                          frozenString = "baz" (UTF-8)
                                                           sourceCharIndex = 38
                                                           sourceLength = 5
                                               ]
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_string_literal_in_when_clause.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_string_literal_in_when_clause.yaml
@@ -28,9 +28,9 @@ ast: |
                       leftNode_ =
                           FrozenStringLiteralNode
                               attributes:
-                                  definition = expression
+                                  definition = "expression" (ASCII-8BIT)
                                   flags = 0
-                                  frozenString = foo
+                                  frozenString = "foo" (UTF-8)
                                   sourceCharIndex = 13
                                   sourceLength = 5
                       rightNode_ =
diff --git a/spec/truffle/parsing/fixtures/case/without_expression_and_when/with_string_literal_in_when_clause.yaml b/spec/truffle/parsing/fixtures/case/without_expression_and_when/with_string_literal_in_when_clause.yaml
@@ -18,9 +18,9 @@ ast: |
           condition =
               FrozenStringLiteralNode
                   attributes:
-                      definition = expression
+                      definition = "expression" (ASCII-8BIT)
                       flags = 0
-                      frozenString = foo
+                      frozenString = "foo" (UTF-8)
                       sourceCharIndex = 10
                       sourceLength = 5
           elseBody =
diff --git a/spec/truffle/parsing/fixtures/hashes/with_string_key.yaml b/spec/truffle/parsing/fixtures/hashes/with_string_key.yaml
@@ -15,9 +15,9 @@ ast: |
           keyValues = [
               FrozenStringLiteralNode
                   attributes:
-                      definition = expression
+                      definition = "expression" (ASCII-8BIT)
                       flags = 0
-                      frozenString = foo
+                      frozenString = "foo" (UTF-8)
                       sourceCharIndex = 1
                       sourceLength = 5
               IntegerFixnumLiteralNode
diff --git a/spec/truffle/parsing/fixtures/method_calls/special_cases/method_-@_when_string_literal.yaml b/spec/truffle/parsing/fixtures/method_calls/special_cases/method_-@_when_string_literal.yaml
@@ -8,8 +8,8 @@ ruby: |
 ast: |
   FrozenStringLiteralNode
       attributes:
-          definition = method
+          definition = "method" (ASCII-8BIT)
           flags = 1
-          frozenString = foobar
+          frozenString = "foobar" (UTF-8)
           sourceCharIndex = 0
           sourceLength = 9
diff --git a/spec/truffle/parsing/fixtures/method_calls/special_cases/method_dedup_when_string_literal.yaml b/spec/truffle/parsing/fixtures/method_calls/special_cases/method_dedup_when_string_literal.yaml
@@ -8,8 +8,8 @@ ruby: |
 ast: |
   FrozenStringLiteralNode
       attributes:
-          definition = method
+          definition = "method" (ASCII-8BIT)
           flags = 1
-          frozenString = foobar
+          frozenString = "foobar" (UTF-8)
           sourceCharIndex = 0
           sourceLength = 14
diff --git a/spec/truffle/parsing/fixtures/method_calls/special_cases/method_freeze.yaml b/spec/truffle/parsing/fixtures/method_calls/special_cases/method_freeze.yaml
@@ -8,8 +8,8 @@ ruby: |
 ast: |
   FrozenStringLiteralNode
       attributes:
-          definition = method
+          definition = "method" (ASCII-8BIT)
           flags = 1
-          frozenString = foobar
+          frozenString = "foobar" (UTF-8)
           sourceCharIndex = 0
           sourceLength = 15
diff --git a/spec/truffle/parsing/fixtures/regexps/with_interpolation_without_expression.yaml b/spec/truffle/parsing/fixtures/regexps/with_interpolation_without_expression.yaml
@@ -42,7 +42,7 @@ ast: |
                           ObjectLiteralNode
                               attributes:
                                   flags = 0
-                                  object = ""
+                                  object = "" (UTF-8)
                                   sourceCharIndex = 2
                                   sourceLength = 3
               ToSNodeGen
diff --git a/spec/truffle/parsing/fixtures/strings/backtick_literal.yaml b/spec/truffle/parsing/fixtures/strings/backtick_literal.yaml
@@ -27,9 +27,9 @@ ast: |
           arguments = [
               FrozenStringLiteralNode
                   attributes:
-                      definition = expression
+                      definition = "expression" (ASCII-8BIT)
                       flags = 0
-                      frozenString = echo 1
+                      frozenString = "echo 1" (UTF-8)
                       sourceCharIndex = 0
                       sourceLength = 8
           ]
diff --git a/spec/truffle/parsing/fixtures/strings/backtick_literal_with_interpolation_without_expression.yaml b/spec/truffle/parsing/fixtures/strings/backtick_literal_with_interpolation_without_expression.yaml
@@ -53,7 +53,7 @@ ast: |
                                       ObjectLiteralNode
                                           attributes:
                                               flags = 0
-                                              object = ""
+                                              object = "" (UTF-8)
                                               sourceCharIndex = 8
                                               sourceLength = 4
                       ]
diff --git a/spec/truffle/parsing/fixtures/strings/encoding_of_backtick_literal/when_non_ascii_characters.yaml b/spec/truffle/parsing/fixtures/strings/encoding_of_backtick_literal/when_non_ascii_characters.yaml
@@ -27,9 +27,9 @@ ast: |
           arguments = [
               FrozenStringLiteralNode
                   attributes:
-                      definition = expression
+                      definition = "expression" (ASCII-8BIT)
                       flags = 0
-                      frozenString = echo \xFF 1
+                      frozenString = "echo \xFF 1" (ASCII-8BIT)
                       sourceCharIndex = 21
                       sourceLength = 13
           ]
diff --git a/spec/truffle/parsing/fixtures/strings/encoding_of_backtick_literal/when_utf8_characters.yaml b/spec/truffle/parsing/fixtures/strings/encoding_of_backtick_literal/when_utf8_characters.yaml
@@ -27,9 +27,9 @@ ast: |
           arguments = [
               FrozenStringLiteralNode
                   attributes:
-                      definition = expression
+                      definition = "expression" (ASCII-8BIT)
                       flags = 0
-                      frozenString = echo £ 1
+                      frozenString = "echo £ 1" (UTF-8)
                       sourceCharIndex = 21
                       sourceLength = 15
           ]
diff --git a/spec/truffle/parsing/fixtures/strings/literal_frozen.yaml b/spec/truffle/parsing/fixtures/strings/literal_frozen.yaml
@@ -10,8 +10,8 @@ ruby: |
 ast: |
   FrozenStringLiteralNode
       attributes:
-          definition = expression
+          definition = "expression" (ASCII-8BIT)
           flags = 1
-          frozenString = foobar
+          frozenString = "foobar" (UTF-8)
           sourceCharIndex = 30
           sourceLength = 8
diff --git a/spec/truffle/parsing/fixtures/strings/with_interpolation_without_expression.yaml b/spec/truffle/parsing/fixtures/strings/with_interpolation_without_expression.yaml
@@ -32,7 +32,7 @@ ast: |
                           ObjectLiteralNode
                               attributes:
                                   flags = 0
-                                  object = ""
+                                  object = "" (UTF-8)
                                   sourceCharIndex = 3
                                   sourceLength = 4
               ToSNodeGen
diff --git a/spec/truffle/parsing/fixtures/symbols/with_interpolation_without_expression.yaml b/spec/truffle/parsing/fixtures/symbols/with_interpolation_without_expression.yaml
@@ -10,6 +10,6 @@ ast: |
   ObjectLiteralNode
       attributes:
           flags = 0
-          object = ""
+          object = "" (UTF-8)
           sourceCharIndex = 4
           sourceLength = 4
diff --git a/src/main/java/org/truffleruby/core/string/ImmutableRubyString.java b/src/main/java/org/truffleruby/core/string/ImmutableRubyString.java
@@ -33,6 +33,7 @@
 import org.truffleruby.core.encoding.TStringUtils;
 import org.truffleruby.core.kernel.KernelNodes;
 import org.truffleruby.core.klass.RubyClass;
+import org.truffleruby.core.support.DetailedInspectingSupport;
 import org.truffleruby.language.ImmutableRubyObjectCopyable;
 import org.truffleruby.extra.ffi.Pointer;
 import org.truffleruby.language.RubyBaseNode;
@@ -44,7 +45,8 @@
 /** All ImmutableRubyString are interned and must be created through
  * {@link FrozenStringLiterals#getFrozenStringLiteral}. */
 @ExportLibrary(InteropLibrary.class)
-public final class ImmutableRubyString extends ImmutableRubyObjectCopyable implements TruffleObject {
+public final class ImmutableRubyString extends ImmutableRubyObjectCopyable
+        implements TruffleObject, DetailedInspectingSupport {
 
     public final TruffleString tstring;
     private final RubyEncoding encoding;
@@ -63,6 +65,11 @@ public String toString() {
         return tstring.toString();
     }
 
+    @Override
+    public String toStringWithDetails() {
+        return "\"" + tstring + "\" (" + encoding.name + ")";
+    }
+
     public TruffleString asTruffleStringUncached() {
         CompilerAsserts.neverPartOfCompilation("Only behind @TruffleBoundary");
         assert !tstring.isNative();

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ ast: \|`
`53`	`53`	`ObjectLiteralNode`
`54`	`54`	`attributes:`
`55`	`55`	`flags = 0`
`56`		`- object = ""`
	`56`	`+ object = "" (UTF-8)`
`57`	`57`	`sourceCharIndex = 8`
`58`	`58`	`sourceLength = 4`
`59`	`59`	`]`