OpParser: make authors tag more flexible

hinerm · hinerm · commit 9f2bc718a4e1 · 2024-03-06T08:45:43.000-06:00
diff --git a/scijava-ops-ext-parser/src/main/java/org/scijava/ops/parser/OpParser.java b/scijava-ops-ext-parser/src/main/java/org/scijava/ops/parser/OpParser.java
@@ -127,7 +127,8 @@ public static String parseOpDocument(String inputYamlPath)
 			version = (String) opsYaml.remove(VERSION_KEY);
 		}
 		if (opsYaml.containsKey(AUTHOR_KEY)) {
-			authors = (List<String>) opsYaml.remove(AUTHOR_KEY);
+			authors = getListHelper(AUTHOR_KEY, opsYaml);
+			opsYaml.remove(AUTHOR_KEY);
 		}
 
 		// We assume the remaining entries are nested maps of classes to (maps of
@@ -155,17 +156,19 @@ public static String parseOpDocument(String inputYamlPath)
 				if (opMetadata.containsKey(ALIAS_KEY)) {
 					Object alias = opMetadata.get(ALIAS_KEY);
 					if (alias instanceof String) {
-						opNames.add((String)alias);
-					} else if (alias instanceof List) {
-						opNames.addAll((List<String>)alias);
+						opNames.add((String) alias);
 					}
-				} else {
+					else if (alias instanceof List) {
+						opNames.addAll((List<String>) alias);
+					}
+				}
+				else {
 					opNames.add("ext." + methodName);
 				}
 
 				List<String> opAuthors = authors;
 				if (opMetadata.containsKey(AUTHOR_KEY)) {
-					opAuthors = (List<String>) opMetadata.get(AUTHOR_KEY);
+					opAuthors = getListHelper(AUTHOR_KEY, opMetadata);
 				}
 
 				// If a global namespace is specified, we also alias the Op by its
@@ -197,6 +200,22 @@ public static String parseOpDocument(String inputYamlPath)
 		return new Yaml().dump(data);
 	}
 
+	/**
+	 * Helper method to extract a key from a map that may point to a single
+	 * {@link String}, or a {@link List} thereof.
+	 */
+	private static List<String> getListHelper(String key,
+		Map<String, Object> map)
+	{
+		Object value = map.get(key);
+		if (value instanceof List) {
+			return (List<String>) value;
+		}
+		List<String> result = new ArrayList<>();
+		result.add((String) value);
+		return result;
+	}
+
 	/**
 	 * Helper method to generate a properly formatted "source" string
 	 *
diff --git a/scijava-ops-ext-parser/src/test/java/org/scijava/ops/parser/TestOpParser.java b/scijava-ops-ext-parser/src/test/java/org/scijava/ops/parser/TestOpParser.java
@@ -49,7 +49,8 @@ public void validateParsing() throws ClassNotFoundException {
 
 		String expected = //
 			"- op:" //
-				+ "\n    names: [arrays.toStringDeep, fun.stringMaker, test.deepToString]" //
+				+
+				"\n    names: [arrays.toStringDeep, fun.stringMaker, test.deepToString]" //
 				+ "\n    description: ''" //
 				+
 				"\n    source: javaMethod:/java.util.Arrays.deepToString%28%5BLjava.lang.Object%3B%29" //
diff --git a/scijava-ops-ext-parser/src/test/resources/test-ops.yaml b/scijava-ops-ext-parser/src/test/resources/test-ops.yaml
@@ -14,7 +14,6 @@ java.lang.System:
   arraycopy:
     priority: "50"
     description: "a useful op"
-    authors:
-      - "You-know-who"
+    authors: "You-know-who"
     type: "Computer2"
 

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,8 @@ public void validateParsing() throws ClassNotFoundException {`
`49`	`49`
`50`	`50`	`String expected = //`
`51`	`51`	`"- op:" //`
`52`		`- + "\n names: [arrays.toStringDeep, fun.stringMaker, test.deepToString]" //`
	`52`	`+ +`
	`53`	`+ "\n names: [arrays.toStringDeep, fun.stringMaker, test.deepToString]" //`
`53`	`54`	`+ "\n description: ''" //`
`54`	`55`	`+`
`55`	`56`	`"\n source: javaMethod:/java.util.Arrays.deepToString%28%5BLjava.lang.Object%3B%29" //`