Add custom conversion to String for some classes

Author: andrykonchin

src/main/java/org/truffleruby/core/proc/ProcCallTargets.java

@@ -13,6 +13,7 @@
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
 import com.oracle.truffle.api.RootCallTarget;
 import com.oracle.truffle.api.nodes.RootNode;
+import org.truffleruby.core.string.StringUtils;
 import org.truffleruby.language.RubyLambdaRootNode;
 import org.truffleruby.language.RubyProcRootNode;
 import org.truffleruby.language.RubyRootNode;
@@ -92,4 +93,13 @@ private boolean validLambdaRootNode(RootCallTarget callTarget) {
         assert rootNode instanceof RubyLambdaRootNode : rootNode + " " + rootNode.getClass();
         return true;
     }
+
+    @Override
+    public String toString() {
+        return StringUtils.format(
+                "ProcCallTargets(callTargetForProc = %s, callTargetForLambda = %s, altCallTargetCompiler = %s)",
+                callTargetForProc,
+                callTargetForLambda,
+                altCallTargetCompiler);
+    }
 }

src/main/java/org/truffleruby/core/range/RubyIntRange.java

@@ -9,6 +9,7 @@
  */
 package org.truffleruby.core.range;
 
+import org.truffleruby.core.string.StringUtils;
 
 public final class RubyIntRange extends RubyIntOrLongRange {
 
@@ -21,4 +22,10 @@ public RubyIntRange(boolean excludedEnd, int begin, int end) {
         this.end = end;
     }
 
+    @Override
+    public String toString() {
+        String suffix = StringUtils.format("(begin = %s, end = %s, excludedEnd = %s)", begin, end, excludedEnd);
+        return super.toString() + suffix;
+    }
+
 }

src/main/java/org/truffleruby/core/range/RubyLongRange.java

@@ -9,6 +9,7 @@
  */
 package org.truffleruby.core.range;
 
+import org.truffleruby.core.string.StringUtils;
 
 public final class RubyLongRange extends RubyIntOrLongRange {
 
@@ -21,4 +22,10 @@ public RubyLongRange(boolean excludedEnd, long begin, long end) {
         this.end = end;
     }
 
+    @Override
+    public String toString() {
+        String suffix = StringUtils.format("(begin = %s, end = %s, excludedEnd = %s)", begin, end, excludedEnd);
+        return super.toString() + suffix;
+    }
+
 }

src/main/java/org/truffleruby/core/regexp/RubyRegexp.java

@@ -26,13 +26,15 @@
 import org.truffleruby.core.encoding.RubyEncoding;
 import org.truffleruby.core.kernel.KernelNodes;
 import org.truffleruby.core.klass.RubyClass;
+import org.truffleruby.core.string.StringUtils;
 import org.truffleruby.language.ImmutableRubyObjectNotCopyable;
 import org.truffleruby.core.string.TStringWithEncoding;
 import org.truffleruby.language.control.DeferredRaiseException;
 import org.truffleruby.language.dispatch.DispatchNode;
 
 @ExportLibrary(InteropLibrary.class)
-public final class RubyRegexp extends ImmutableRubyObjectNotCopyable implements TruffleObject, Comparable<RubyRegexp> {
+public final class RubyRegexp extends ImmutableRubyObjectNotCopyable
+        implements TruffleObject, Comparable<RubyRegexp> {
 
     @TruffleBoundary
     public static RubyRegexp create(RubyLanguage language,
@@ -121,4 +123,11 @@ public int compareTo(RubyRegexp o) {
             return options.compareTo(o.options);
         }
     }
+
+    @Override
+    public String toString() {
+        return StringUtils.format(
+                "RubyRegexp(source = %s, options = %s, encoding = %s)",
+                source, options, encoding);
+    }
 }

src/main/java/org/truffleruby/core/support/DetailedInspectingSupport.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2021, 2023 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 2.0, or
+ * GNU General Public License version 2, or
+ * GNU Lesser General Public License version 2.1.
+ */
+package org.truffleruby.core.support;
+
+public interface DetailedInspectingSupport {
+    public String toStringWithDetails();
+}

src/main/java/org/truffleruby/language/arguments/KeywordArgumentsDescriptor.java

@@ -10,6 +10,10 @@
 package org.truffleruby.language.arguments;
 
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
+import org.truffleruby.core.string.StringUtils;
+
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 /** An arguments descriptor that says that keyword arguments were passed (either foo(a: 1) or foo(**kw)). Note that
  * currently, if kw is empty, then this descriptor is used even though it is semantically the same as if no keyword
@@ -26,4 +30,10 @@ public final class KeywordArgumentsDescriptor extends ArgumentsDescriptor {
     public String[] getKeywords() {
         return keywords;
     }
+
+    @Override
+    public String toString() {
+        final String keywordsAsString = Stream.of(keywords).collect(Collectors.joining(", ", "[", "]"));
+        return StringUtils.format("KeywordArgumentsDescriptor(keywords = %s)", keywordsAsString);
+    }
 }

src/main/java/org/truffleruby/language/methods/ModuleBodyDefinition.java

@@ -14,6 +14,7 @@
 
 import org.truffleruby.collections.ConcurrentOperations;
 import org.truffleruby.core.module.RubyModule;
+import org.truffleruby.core.string.StringUtils;
 import org.truffleruby.language.LexicalScope;
 import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.annotations.Visibility;
@@ -85,4 +86,19 @@ private LexicalScope prepareLexicalScope(LexicalScope staticLexicalScope, Lexica
         }
     }
 
+    public RootCallTarget getCallTarget() {
+        return callTarget;
+    }
+
+    @Override
+    public String toString() {
+        return StringUtils.format(
+                "ModuleBodyDefinition(name = %s, sharedMethodInfo = %s, callTarget = %s, staticLexicalScope = %s, dynamicLexicalScopes = %s)",
+                this.name,
+                this.sharedMethodInfo.toStringWithDetails(),
+                this.callTarget,
+                this.staticLexicalScope,
+                this.dynamicLexicalScopes);
+    }
+
 }

src/main/java/org/truffleruby/language/methods/SharedMethodInfo.java

@@ -14,6 +14,8 @@
 import org.truffleruby.core.klass.RubyClass;
 import org.truffleruby.core.module.RubyModule;
 import org.truffleruby.core.proc.RubyProc;
+import org.truffleruby.core.string.StringUtils;
+import org.truffleruby.core.support.DetailedInspectingSupport;
 import org.truffleruby.language.LexicalScope;
 import org.truffleruby.language.RubyDynamicObject;
 import org.truffleruby.language.RubyGuards;
@@ -24,11 +26,13 @@
 import org.truffleruby.parser.OpenModule;
 import org.truffleruby.parser.ParserContext;
 
+import java.util.Arrays;
+
 /** SharedMethodInfo represents static information from the parser for either a method definition or a block like its
  * name, SourceSection, etc. Such information is always "original" since it comes from the source as opposed to
  * "aliased" (e.g. the aliased name of a method). In contrast, {@link InternalMethod} are runtime objects containing
  * properties that change for a method. */
-public final class SharedMethodInfo {
+public final class SharedMethodInfo implements DetailedInspectingSupport {
 
     private final SourceSection sourceSection;
     /** LexicalScope if it can be determined statically at parse time, otherwise null */
@@ -241,4 +245,13 @@ public String toString() {
         return getDescriptiveNameAndSource();
     }
 
+    @Override
+    public String toStringWithDetails() {
+        final String string = Arrays.deepToString(argumentDescriptors);
+
+        return StringUtils.format(
+                "SharedMethodInfo(sourceSection = %s, staticLexicalScope = %s, arity = %s, originName = %s, blockDepth = %s, parseName = %s, notes = %s, argumentDescriptors = %s)",
+                sourceSection, staticLexicalScope, arity, originalName, blockDepth, parseName, notes, string);
+    }
+
 }

src/main/java/org/truffleruby/parser/ArgumentDescriptor.java

@@ -26,6 +26,8 @@
  ***** END LICENSE BLOCK *****/
 package org.truffleruby.parser;
 
+import org.truffleruby.core.string.StringUtils;
+
 /** A description of a single argument in a Ruby argument list. */
 public final class ArgumentDescriptor {
     /** The type of the argument */
@@ -53,4 +55,9 @@ public ArgumentDescriptor(ArgumentType type) {
         this(type, null);
     }
 
+    @Override
+    public String toString() {
+        return StringUtils.format("ArgumentDescriptor(name = %s, type = %s)", name, type);
+    }
+
 }