project review

Author: bnasslahsen

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/HalProvider.java

@@ -22,7 +22,7 @@
 
 import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.util.Json;
-import org.springdoc.core.hal.CollectionModelContentConverter;
+import org.springdoc.core.converters.CollectionModelContentConverter;
 
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
@@ -40,7 +40,7 @@ private void init(){
 		if(repositoryRestConfiguration.useHalAsDefaultJsonMediaType()) {
 			Json.mapper().registerModule(new Jackson2HalModule());
 			ModelConverters.getInstance()
-					.addConverter(new CollectionModelContentConverter());
+					.addConverter(CollectionModelContentConverter.getConverter());
 		}
 	}
 }

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/SpringDocDataRestConfiguration.java

@@ -29,7 +29,7 @@
 import io.swagger.v3.oas.models.media.StringSchema;
 import org.springdoc.core.converters.Pageable;
 import org.springdoc.core.customizers.OpenApiCustomiser;
-import org.springdoc.core.hal.RepresentationModelLinksOASMixin;
+import org.springdoc.core.converters.RepresentationModelLinksOASMixin;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/hal/CollectionModelContentConverter.java renamed to springdoc-openapi-data-rest/src/main/java/org/springdoc/core/converters/CollectionModelContentConverter.java

@@ -1,4 +1,25 @@
-package org.springdoc.core.hal;
+/*
+ *
+ *  * Copyright 2019-2020 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 org.springdoc.core.converters;
+
+import java.util.Collection;
+import java.util.Iterator;
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.SerializerProvider;
@@ -11,16 +32,22 @@
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.media.StringSchema;
 
-import java.util.Collection;
-import java.util.Iterator;
-
 /**
  * Override resolved schema as there is a custom serializer that converts the data to a map before serializing it.
  *
  * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
  * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)
  */
 public class CollectionModelContentConverter implements ModelConverter {
+
+	private static final CollectionModelContentConverter collectionModelContentConverter = new CollectionModelContentConverter();
+
+	private CollectionModelContentConverter() { }
+
+	public static CollectionModelContentConverter getConverter() {
+		return collectionModelContentConverter;
+	}
+
     @Override
     public Schema<?> resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
         if (chain.hasNext() && type != null && type.getType() instanceof CollectionType

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/converters/RepresentationModelLinksOASMixin.java

@@ -0,0 +1,30 @@
+/*
+ *
+ *  * Copyright 2019-2020 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 org.springdoc.core.converters;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import org.springframework.hateoas.Links;
+import org.springframework.hateoas.mediatype.hal.RepresentationModelMixin;
+
+public abstract class RepresentationModelLinksOASMixin extends RepresentationModelMixin {
+    @Override
+    @Schema(ref = "#/components/schemas/Links")
+    public abstract Links getLinks();
+}

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/hal/RepresentationModelLinksOASMixin.java

@@ -23,11 +23,14 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
+import io.swagger.v3.core.converter.ModelConverters;
 import nonapi.io.github.classgraph.utils.FileUtils;
+import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.Constants;
+import org.springdoc.core.converters.CollectionModelContentConverter;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
@@ -77,4 +80,10 @@ public void testApp() throws Exception {
 		String expected = new String(fileBytes);
 		assertEquals(expected, result, true);
 	}
+
+	@AfterAll
+	public static void afterClass() {
+		ModelConverters.getInstance().removeConverter(CollectionModelContentConverter.getConverter());
+		System.clearProperty("spring.hateoas.use-hal-as-default-json-media-type");
+	}
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java

@@ -15,7 +15,7 @@
  *  * limitations under the License.
  *
  */
-package test.org.springdoc.api.app2;
+package test.org.springdoc.api.app1;
 
 import org.springframework.boot.CommandLineRunner;
 import org.springframework.context.annotation.Bean;

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/DatabaseLoader.java renamed to springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/DatabaseLoader.java

@@ -15,7 +15,7 @@
  *  * limitations under the License.
  *
  */
-package test.org.springdoc.api.app2;
+package test.org.springdoc.api.app1;
 
 import javax.persistence.Entity;
 import javax.persistence.GeneratedValue;

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/Employee.java renamed to springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/Employee.java

@@ -15,7 +15,7 @@
  *  * limitations under the License.
  *
  */
-package test.org.springdoc.api.app2;
+package test.org.springdoc.api.app1;
 
 import java.net.URI;
 import java.net.URISyntaxException;

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/EmployeeController.java renamed to springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/EmployeeController.java

@@ -15,7 +15,7 @@
  *  * limitations under the License.
  *
  */
-package test.org.springdoc.api.app2;
+package test.org.springdoc.api.app1;
 
 import org.springframework.data.repository.CrudRepository;
 

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/EmployeeRepository.java renamed to springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/EmployeeRepository.java

@@ -20,10 +20,9 @@
 
 import test.org.springdoc.api.AbstractSpringDocTest;
 
-import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
 
+@TestPropertySource(properties = "spring.hateoas.use-hal-as-default-json-media-type= false")
 public class SpringDocApp1Test extends AbstractSpringDocTest {
 
-	@SpringBootApplication
-	static class SpringDocTestApp {}
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/SpringDocApp1Test.java

@@ -0,0 +1,52 @@
+/*
+ *
+ *  * Copyright 2019-2020 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 test.org.springdoc.api.app1;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
+import org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer;
+import org.springframework.hateoas.server.core.EvoInflectorLinkRelationProvider;
+import org.springframework.http.MediaType;
+
+@SpringBootApplication
+public class SpringDocTestApp {
+
+	public static void main(String[] args) {
+		SpringApplication.run(SpringDocTestApp.class, args);
+	}
+
+	@Bean
+	public RepositoryRestConfigurer repositoryRestConfigurer() {
+		return new RepositoryRestConfigurer() {
+			@Override
+			public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
+				config.setDefaultMediaType(MediaType.APPLICATION_JSON);
+				config.useHalAsDefaultJsonMediaType(false);
+			}
+		};
+	}
+
+	@Bean
+	EvoInflectorLinkRelationProvider relProvider() {
+		return new EvoInflectorLinkRelationProvider();
+	}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/SpringDocTestApp.java

@@ -16,7 +16,7 @@
  *
  */
 
-package test.org.springdoc.api.app1;
+package test.org.springdoc.api.app2;
 
 import java.util.List;
 

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/HelloController.java renamed to springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/HelloController.java

@@ -16,7 +16,7 @@
  *
  */
 
-package test.org.springdoc.api.app1;
+package test.org.springdoc.api.app2;
 
 import io.swagger.v3.oas.annotations.media.Schema;
 

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app1/PersonDTO.java renamed to springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/PersonDTO.java

@@ -20,7 +20,11 @@
 
 import test.org.springdoc.api.AbstractSpringDocTest;
 
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
 public class SpringDocApp2Test extends AbstractSpringDocTest {
 
+	@SpringBootApplication
+	static class SpringDocTestApp {}
 
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app2/SpringDocApp2Test.java

@@ -26,4 +26,5 @@ public class SpringDocApp3Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication
 	static class SpringDocTestApp {}
+
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app3/SpringDocApp3Test.java

@@ -0,0 +1,47 @@
+/*
+ *
+ *  * Copyright 2019-2020 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 test.org.springdoc.api.app4;
+
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.stereotype.Component;
+
+/**
+ * Pre-load some data using a Spring Boot {@link CommandLineRunner}.
+ *
+ * @author Greg Turnquist
+ */
+@Component
+class DatabaseLoader {
+
+	/**
+	 * Use Spring to inject a {@link EmployeeRepository} that can then load data. Since this will run only after the app
+	 * is operational, the database will be up.
+	 *
+	 * @param repository
+	 */
+	@Bean
+	CommandLineRunner init(EmployeeRepository repository) {
+
+		return args -> {
+			repository.save(new Employee("Frodo", "Baggins", "ring bearer"));
+			repository.save(new Employee("Bilbo", "Baggins", "burglar"));
+		};
+	}
+
+}