Improve Struct and Member stringification

ctrueden · ctrueden · commit 6c888668c461 · 2024-05-22T20:07:21.000-05:00
diff --git a/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/AnnotatedOpDependencyMember.java b/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/AnnotatedOpDependencyMember.java
@@ -33,6 +33,7 @@
 import org.scijava.ops.engine.OpDependencyMember;
 import org.scijava.ops.spi.OpDependency;
 import org.scijava.struct.Member;
+import org.scijava.struct.Structs;
 
 import java.lang.reflect.Type;
 import java.util.function.Supplier;
@@ -144,4 +145,9 @@ private synchronized void generateDescription() {
 	public Type type() {
 		return type;
 	}
+
+	@Override
+	public String toString() {
+		return Structs.toString(this);
+	}
 }
diff --git a/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/ConvertedParameterMember.java b/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/ConvertedParameterMember.java
@@ -33,6 +33,7 @@
 
 import org.scijava.struct.ItemIO;
 import org.scijava.struct.Member;
+import org.scijava.struct.Structs;
 
 /**
  * {@link Member} whose {@link Type} has been converted into another
@@ -85,4 +86,9 @@ public ItemIO getIOType() {
 	public boolean isRequired() {
 		return original.isRequired();
 	}
+
+	@Override
+	public String toString() {
+		return Structs.toString(this);
+	}
 }
diff --git a/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/OpRetypingMemberParser.java b/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/OpRetypingMemberParser.java
@@ -39,6 +39,7 @@
 import org.scijava.struct.Member;
 import org.scijava.struct.MemberParser;
 import org.scijava.struct.Struct;
+import org.scijava.struct.Structs;
 
 public class OpRetypingMemberParser implements
 	MemberParser<RetypingRequest, Member<?>>
@@ -112,6 +113,11 @@ public Type type() {
 			public ItemIO getIOType() {
 				return fmt.itemIO();
 			}
+
+			@Override
+			public String toString() {
+				return Structs.toString(this);
+			}
 		};
 	}
 
diff --git a/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/SynthesizedParameterMember.java b/scijava-ops-engine/src/main/java/org/scijava/ops/engine/struct/SynthesizedParameterMember.java
@@ -33,6 +33,7 @@
 
 import org.scijava.struct.ItemIO;
 import org.scijava.struct.Member;
+import org.scijava.struct.Structs;
 
 /**
  * {@link Member} synthesized using constructor arguments
@@ -87,4 +88,9 @@ public ItemIO getIOType() {
 	public boolean isRequired() {
 		return isRequired;
 	}
+
+	@Override
+	public String toString() {
+		return Structs.toString(this);
+	}
 }
diff --git a/scijava-struct/src/main/java/org/scijava/struct/Structs.java b/scijava-struct/src/main/java/org/scijava/struct/Structs.java
@@ -33,8 +33,10 @@
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import org.scijava.common3.Classes;
+import org.scijava.types.Types;
 
 public final class Structs {
 
@@ -97,4 +99,33 @@ public static boolean isImmutable(final Class<?> type) {
 			Classes.isBoolean(type);
 	}
 
+	public static String toString(Struct struct) {
+		return toString(struct, 0);
+	}
+
+	public static String toString(Member<?> member) {
+		return toString(member, 0);
+	}
+
+	private static String toString(Struct struct, int level) {
+		String indent = " ".repeat(2 * level);
+		return indent + String.join("\n" + indent,
+			struct.members().stream()
+				.map(m -> toString(m, level))
+				.collect(Collectors.toList())
+		);
+	}
+
+	private static String toString(Member<?> member, int level) {
+		String desc = member.description();
+		String descriptionSuffix = desc == null ? "" : " {" + desc.trim() + "}";
+		return String.format("%s: %s%s [%s]%s%s",
+				member.key(),
+				Types.name(member.type()),
+				member.isRequired() ? "" : "?",
+				member.getIOType(),
+				descriptionSuffix,
+				member.isStruct() ? "\n" + toString(member.childStruct(), level + 1) : ""
+		);
+	}
 }
diff --git a/scijava-struct/src/test/java/org/scijava/struct/StructTest.java b/scijava-struct/src/test/java/org/scijava/struct/StructTest.java
@@ -130,6 +130,20 @@ public void testNestedStructs() {
         assertEquals("asdf", nestedMembers.get("vp.d"));
         assertEquals(5.4, nestedMembers.get("vp.o"));
         assertEquals("fdsa", nestedMembers.get("vp.p"));
+
+        var expectedString =
+          "np: org.scijava.struct.StructTest$NestedParameters [INPUT]\n" +
+            "  stuff: java.lang.String [INPUT]\n" +
+            "  vp: org.scijava.struct.StructTest$VariousParameters [INPUT]\n" +
+            "    a: int [INPUT]\n" +
+            "    b: java.lang.Double [INPUT]\n" +
+            "    c: byte [INPUT]\n" +
+            "    d: java.lang.Object [INPUT]\n" +
+            "    o: double [OUTPUT]\n" +
+            "    p: java.lang.String [OUTPUT]\n" +
+            "  things: java.lang.String [OUTPUT]\n" +
+            "junk: java.lang.String [INPUT]";
+        assertEquals(expectedString, Structs.toString(hlpStruct));
     }
 
     // -- Helper methods --
