Add InitializrMetadataV23JsonMapper

Author: YangSiJun528

initializr-web/src/main/java/io/spring/initializr/web/mapper/InitializrMetadataV23JsonMapper.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2012 - present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.spring.initializr.web.mapper;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import io.spring.initializr.metadata.InitializrMetadata;
+import io.spring.initializr.metadata.Type;
+
+import org.springframework.hateoas.TemplateVariable;
+import org.springframework.hateoas.TemplateVariables;
+
+/**
+ * A {@link InitializrMetadataJsonMapper} handling the metadata format for v2.3.
+ * <p>
+ * Version 2.3 adds support for configuration file formats, allowing users to specify
+ * their preferred configuration file format (e.g., properties, YAML).
+ *
+ * @author Sijun Yang
+ * @see InitializrMetadataVersion#V2_3
+ */
+public class InitializrMetadataV23JsonMapper extends InitializrMetadataV22JsonMapper {
+
+	@Override
+	protected TemplateVariables getTemplateVariables(Type type) {
+		return super.getTemplateVariables(type)
+			.concat(new TemplateVariable("configurationFileFormat", TemplateVariable.VariableType.REQUEST_PARAM));
+	}
+
+	@Override
+	protected void customizeParent(ObjectNode parent, InitializrMetadata metadata) {
+		super.customizeParent(parent, metadata);
+		singleSelect(parent, metadata.getConfigurationFileFormats());
+	}
+
+}

initializr-web/src/main/java/io/spring/initializr/web/mapper/InitializrMetadataVersion.java

@@ -40,7 +40,12 @@ public enum InitializrMetadataVersion {
 	/**
 	 * Add support for SemVer compliant version format.
 	 */
-	V2_2("application/vnd.initializr.v2.2+json");
+	V2_2("application/vnd.initializr.v2.2+json"),
+
+	/**
+	 * Add support for selecting the project's configuration file format.
+	 */
+	V2_3("application/vnd.initializr.v2.3+json");
 
 	private final MediaType mediaType;
 

initializr-web/src/test/java/io/spring/initializr/web/mapper/InitializrMetadataV23JsonMapperTests.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2012 - present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.spring.initializr.web.mapper;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.spring.initializr.generator.test.InitializrMetadataTestBuilder;
+import io.spring.initializr.metadata.InitializrMetadata;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link InitializrMetadataV23JsonMapper}.
+ *
+ * @author Sijun Yang
+ */
+class InitializrMetadataV23JsonMapperTests {
+
+	private static final ObjectMapper objectMapper = new ObjectMapper();
+
+	private final InitializrMetadataV23JsonMapper mapper = new InitializrMetadataV23JsonMapper();
+
+	@Test
+	void writeConfigurationFileFormatMetadata() throws JsonProcessingException {
+		InitializrMetadata metadata = new InitializrMetadataTestBuilder()
+			.addConfigurationFileFormats("properties", true)
+			.addConfigurationFileFormats("yaml", false)
+			.build();
+		String json = this.mapper.write(metadata, null);
+		JsonNode result = objectMapper.readTree(json);
+
+		assertThat(result.has("configurationFileFormat")).isTrue();
+		JsonNode formatsNode = result.get("configurationFileFormat");
+		assertThat(formatsNode.get("type").asText()).isEqualTo("single-select");
+		assertThat(formatsNode.get("default").asText()).isEqualTo("properties");
+		assertThat(formatsNode.get("values")).hasSize(2);
+	}
+
+	@Test
+	void writeTemplatedUriWithConfigurationFileFormatParameter() throws JsonProcessingException {
+		InitializrMetadata metadata = new InitializrMetadataTestBuilder()
+			.addType("id", true, "action", "build", "dialect", "format")
+			.build();
+		String json = this.mapper.write(metadata, null);
+		JsonNode result = objectMapper.readTree(json);
+
+		assertThat(result.at("/_links/id/href").asText())
+			.isEqualTo("/action?type=id{&dependencies,packaging,javaVersion,"
+					+ "language,bootVersion,groupId,artifactId,version,name,description,packageName,configurationFileFormat}");
+	}
+
+}