Revert "Revert changes in deserialization, typescript"

This reverts commit 50f10a9.
eclipse · Oct 23, 2020 · 2bfc7db · 2bfc7db
1 parent fa78615
commit 2bfc7db
Show file tree

Hide file tree

Showing 11 changed files with 172 additions and 30 deletions.
diff --git a/.../src/main/java/org/eclipse/ice/dev/annotations/processors/DataElementWriterGenerator.java b/.../src/main/java/org/eclipse/ice/dev/annotations/processors/DataElementWriterGenerator.java
@@ -56,6 +56,15 @@ public List<GeneratedFileWriter> generate() {
 			.fields(data.getFields())
 			.types(data.getFields().getTypes())
 			.build());
+		try {
+			writers.add(TypeScriptWriter.builder()
+				.name(data.getName())
+				.fields(nonDefaults)
+				.types(nonDefaults.getTypes())
+				.build());
+		} catch (UnsupportedOperationException e) {
+			logger.info("Failed to create typescript writer for element:", e);
+		}
 
 		return writers;
 	}

diff --git a/...nnotations/src/main/java/org/eclipse/ice/dev/annotations/processors/TypeScriptWriter.java b/...nnotations/src/main/java/org/eclipse/ice/dev/annotations/processors/TypeScriptWriter.java
@@ -0,0 +1,112 @@
+/*******************************************************************************
+ * Copyright (c) 2020- UT-Battelle, LLC.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Daniel Bluhm - Initial implementation
+ *******************************************************************************/
+
+package org.eclipse.ice.dev.annotations.processors;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.util.Map;
+
+import javax.annotation.processing.Filer;
+import javax.tools.StandardLocation;
+
+import lombok.Builder;
+import lombok.NonNull;
+
+/**
+ * Writer for TypeScript representation of DataElement.
+ * @author Daniel Bluhm
+ */
+public class TypeScriptWriter
+	extends VelocitySourceWriter
+	implements GeneratedFileWriter
+{
+
+	/**
+	 * Template used for this writer.
+	 */
+	private static final String TYPESCRIPT_TEMPLATE = "templates/TypeScript.vm";
+
+	/**
+	 * Context key for name.
+	 */
+	private static final String NAME = "name";
+
+	/**
+	 * Context key for fields.
+	 */
+	private static final String FIELDS = "fields";
+
+	/**
+	 * Context key for types.
+	 */
+	private static final String TYPES = "types";
+
+	/**
+	 * Context key for primitiveMap.
+	 */
+	private static final String PRIMITIVE_MAP = "primitiveMap";
+
+	/**
+	 * Map of Java primitive + String type strings to TypeScript type strings.
+	 */
+	private static Map<String, String> primitiveMap = Map.ofEntries(
+		Map.entry("java.lang.String", "string"),
+		Map.entry("boolean", "boolean"),
+		Map.entry("float", "number"),
+		Map.entry("long", "number"),
+		Map.entry("int", "number"),
+		Map.entry("double", "number"),
+		Map.entry("java.util.Date", "Date")
+	);
+
+	/**
+	 * Name of file generated.
+	 */
+	private String filename;
+
+	/**
+	 * Create Writer.
+	 * @param name of TypeScript class generated.
+	 * @param fields present on data element.
+	 * @param types of fields.
+	 * @throws UnsupportedOperationException When any field is not supported.
+	 */
+	@Builder
+	public TypeScriptWriter(
+		String name, @NonNull Fields fields, @NonNull Types types
+	) {
+		super();
+		for (Field field : fields) {
+			if (!primitiveMap.containsKey(field.getType())) {
+				throw new UnsupportedOperationException(String.format(
+					"Field %s: type %s is unsupported",
+					field.getName(), field.getType()
+				));
+			}
+		}
+		this.template = TYPESCRIPT_TEMPLATE;
+		this.filename = name;
+		this.context.put(NAME, name);
+		this.context.put(FIELDS, fields);
+		this.context.put(TYPES, types);
+		this.context.put(PRIMITIVE_MAP, primitiveMap);
+	}
+
+	@Override
+	public Writer openWriter(Filer filer) throws IOException {
+		return filer.createResource(
+			StandardLocation.SOURCE_OUTPUT,
+			"",
+			String.format("frontend/%s.ts", filename)
+		).openWriter();
+	}
+}
diff --git a/...lipse.ice.dev/org.eclipse.ice.dev.annotations/src/main/resources/templates/DataElement.vm b/...lipse.ice.dev/org.eclipse.ice.dev.annotations/src/main/resources/templates/DataElement.vm
@@ -13,12 +13,16 @@ import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import lombok.AccessLevel;
+import lombok.Builder;
 import lombok.Data;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import lombok.AllArgsConstructor;
 import lombok.NonNull;
 import lombok.Setter;
 
@@ -28,7 +32,9 @@ import lombok.Setter;
  * This is an implementation of $interface that satisfies the dependencies of
  * the @DataElement Annotation and was auto-generated by the ICE Framework.
  */
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -37,12 +43,22 @@ import lombok.Setter;
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = ${class}.${class}Builder.class)
 public class ${class} implements ${interface}, Serializable {
 
 	/**
 	 * Logging tool
 	 */
 	private static final Logger logger = LoggerFactory.getLogger(${class}.class);
+
+	/**
+	 * Deserialization helpers.
+	 */
+	@JsonPOJOBuilder(withPrefix = "")
+	public static class ${class}Builder implements ${class}BuilderMeta {
+	}
+	private interface ${class}BuilderMeta {
+	}
 	#foreach($field in $fields)
 
 		#fielddoc
@@ -53,7 +69,7 @@ public class ${class} implements ${interface}, Serializable {
 		#if(!${field.Setter} || ${field.VarNameDifferent})
 	@Setter(AccessLevel.NONE)
 		#end
-		#fielddecl
+		#fielddecl(true)
 	#end
 	#foreach($field in ${fields.Constants})
 
@@ -82,25 +98,6 @@ public class ${class} implements ${interface}, Serializable {
 		#end
 	#end
 
-	/**
-	 * All args constructor for $class.
-	 *
-	 * Used in JSON Deserialization.
-	#foreach($field in $fields)
-	 * @param ${field.VarName} {@code #fieldtype} for field ${field.VarName}
-	#end
-	 */
-	@JsonCreator
-	public $class(
-	#foreach($field in $fields)
-		@JsonProperty("${field.VarName}") #fieldparametertype ${field.VarName}#if($foreach.hasNext),#end
-	#end
-	) {
-		#foreach($field in $fields)
-		this.${field.VarName} = ${field.VarName};
-		#end
-	}
-
 	/**
 	 * Copy constructor for $class.
 	 * @param other Instance of $class to copy

diff --git a/...e.ice.dev.annotations/src/test/resources/patterns/DataElement/AccessibilityPreserved.java b/...e.ice.dev.annotations/src/test/resources/patterns/DataElement/AccessibilityPreserved.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
 	public int shouldBePublic;
 	protected int shouldBeProtected;

diff --git a/...v.annotations/src/test/resources/patterns/DataElement/DefaultNonStringImplementation.java b/...v.annotations/src/test/resources/patterns/DataElement/DefaultNonStringImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
-	public int testInt = 42;
+	@Builder.Default public int testInt = 42;
 }
diff --git a/....dev.annotations/src/test/resources/patterns/DataElement/DefaultStringImplementation.java b/....dev.annotations/src/test/resources/patterns/DataElement/DefaultStringImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
-	@NonNull public String test = "A String Value";
+	@NonNull @Builder.Default public String test = "A String Value";
 }
diff --git a/...e.ice.dev.annotations/src/test/resources/patterns/DataElement/DefaultsImplementation.java b/...e.ice.dev.annotations/src/test/resources/patterns/DataElement/DefaultsImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,17 +9,18 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
 	@NonNull
 	@Getter(AccessLevel.NONE)
 	@Setter(AccessLevel.NONE)
-	protected UUID privateId = UUID.randomUUID();
-	protected long id = 0L;
-	@NonNull protected String name = "name";
-	@NonNull protected String description = "description";
-	@NonNull protected String comment = "no comment";
-	@NonNull protected String context = "default";
-	protected boolean required = false;
-	protected boolean secret = false;
+	@Builder.Default protected UUID privateId = UUID.randomUUID();
+	@Builder.Default protected long id = 0L;
+	@NonNull @Builder.Default protected String name = "name";
+	@NonNull @Builder.Default protected String description = "description";
+	@NonNull @Builder.Default protected String comment = "no comment";
+	@NonNull @Builder.Default protected String context = "default";
+	@Builder.Default protected boolean required = false;
+	@Builder.Default protected boolean secret = false;
 	protected JavascriptValidator<Test> validator;
 }
diff --git a/...lipse.ice.dev.annotations/src/test/resources/patterns/DataElement/ManyImplementation.java b/...lipse.ice.dev.annotations/src/test/resources/patterns/DataElement/ManyImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
 	public byte testByte;
 	public short testShort;

diff --git a/...v.annotations/src/test/resources/patterns/DataElement/ManyNonPrimitiveImplementation.java b/...v.annotations/src/test/resources/patterns/DataElement/ManyNonPrimitiveImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
 	@NonNull public UUID testUuid;
 	@NonNull public String testString;

diff --git a/...pse.ice.dev.annotations/src/test/resources/patterns/DataElement/SingleImplementation.java b/...pse.ice.dev.annotations/src/test/resources/patterns/DataElement/SingleImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
 	public int testInt;
 }
diff --git a/...annotations/src/test/resources/patterns/DataElement/SingleNonPrimitiveImplementation.java b/...annotations/src/test/resources/patterns/DataElement/SingleNonPrimitiveImplementation.java
@@ -1,4 +1,6 @@
+@Builder
 @Data
+@AllArgsConstructor
 @NoArgsConstructor
 @JsonAutoDetect(
 	fieldVisibility = Visibility.ANY,
@@ -7,6 +9,7 @@
 	setterVisibility = Visibility.NONE
 )
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(builder = TestImplementation.TestImplementationBuilder.class)
 public class TestImplementation implements Test, Serializable {
 	@NonNull public UUID testUuid;
 }