Add generation of immutable models

lorenzleutgeb · kobylynskyi · commit 64197db85dd6 · 2020-06-16T15:19:52.000-05:00
diff --git a/docs/codegen-options.md b/docs/codegen-options.md
@@ -14,6 +14,7 @@
 | `generateAsyncApi`                              | Boolean                                                            | False                                         | If true, then wrap type into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType` |
 | `generateDataFetchingEnvironmentArgumentInApis` | Boolean                                                            | False                                         | If true, then `graphql.schema.DataFetchingEnvironment env` will be added as a last argument to all methods of root type resolvers and field resolvers. |
 | `generateEqualsAndHashCode`                     | Boolean                                                            | False                                         | Specifies whether generated model classes should have equals and hashCode methods defined. |
+| `generateImmutableModels`                       | Boolean                                                            | False                                         | Specifies whether generated model classes should be immutable. |
 | `generateToString`                              | Boolean                                                            | False                                         | Specifies whether generated model classes should have toString method defined. |
 | `apiNamePrefix`                                 | String                                                             | Empty                                         | Sets the prefix for GraphQL api classes (query, mutation, subscription). |
 | `apiNameSuffix`                                 | String                                                             | Resolver                                      | Sets the suffix for GraphQL api classes (query, mutation, subscription). |
@@ -100,4 +101,4 @@ Sample content of the file:
     "Price.amount": "java.math.BigDecimal"
   }
 }
-```
+```
diff --git a/plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java b/plugins/gradle/graphql-java-codegen-gradle-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/gradle/GraphQLCodegenGradleTask.java
@@ -59,6 +59,7 @@ public class GraphQLCodegenGradleTask extends DefaultTask implements GraphQLCode
     private Boolean generateApis = MappingConfigConstants.DEFAULT_GENERATE_APIS;
     private String modelValidationAnnotation;
     private Boolean generateEqualsAndHashCode = MappingConfigConstants.DEFAULT_EQUALS_AND_HASHCODE;
+    private Boolean generateImmutableModels = MappingConfigConstants.DEFAULT_GENERATE_IMMUTABLE_MODELS;
     private Boolean generateToString = MappingConfigConstants.DEFAULT_TO_STRING;
     private Boolean generateAsyncApi = MappingConfigConstants.DEFAULT_GENERATE_ASYNC_APIS;
     private Boolean generateParameterizedFieldsResolvers = MappingConfigConstants.DEFAULT_GENERATE_PARAMETERIZED_FIELDS_RESOLVERS;
@@ -100,6 +101,7 @@ public void generate() throws Exception {
         mappingConfig.setSubscriptionReturnType(subscriptionReturnType);
         mappingConfig.setCustomAnnotationsMapping(customAnnotationsMapping);
         mappingConfig.setGenerateEqualsAndHashCode(generateEqualsAndHashCode);
+        mappingConfig.setGenerateImmutableModels(generateImmutableModels);
         mappingConfig.setGenerateToString(generateToString);
         mappingConfig.setGenerateAsyncApi(generateAsyncApi);
         mappingConfig.setGenerateParameterizedFieldsResolvers(generateParameterizedFieldsResolvers);
@@ -359,6 +361,17 @@ public void setGenerateEqualsAndHashCode(Boolean generateEqualsAndHashCode) {
         this.generateEqualsAndHashCode = generateEqualsAndHashCode;
     }
 
+    @Input
+    @Optional
+    @Override
+    public Boolean getGenerateImmutableModels() {
+        return generateImmutableModels;
+    }
+
+    public void setGenerateImmutableModels(Boolean generateImmutableModels) {
+        this.generateImmutableModels = generateImmutableModels;
+    }
+
     @Input
     @Optional
     @Override
diff --git a/plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java b/plugins/maven/graphql-java-codegen-maven-plugin/src/main/java/io/github/kobylynskyi/graphql/codegen/GraphQLCodegenMojo.java
@@ -59,6 +59,9 @@ public class GraphQLCodegenMojo extends AbstractMojo implements GraphQLCodegenCo
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_EQUALS_AND_HASHCODE_STRING)
     private boolean generateEqualsAndHashCode;
 
+    @Parameter(defaultValue = MappingConfigConstants.DEFAULT_GENERATE_IMMUTABLE_MODELS_STRING)
+    private boolean generateImmutableModels;
+
     @Parameter(defaultValue = MappingConfigConstants.DEFAULT_TO_STRING_STRING)
     private boolean generateToString;
 
@@ -157,6 +160,7 @@ public void execute() throws MojoExecutionException {
         mappingConfig.setModelValidationAnnotation(modelValidationAnnotation);
         mappingConfig.setCustomAnnotationsMapping(customAnnotationsMapping != null ? customAnnotationsMapping : new HashMap<>());
         mappingConfig.setGenerateEqualsAndHashCode(generateEqualsAndHashCode);
+        mappingConfig.setGenerateImmutableModels(generateImmutableModels);
         mappingConfig.setGenerateToString(generateToString);
         mappingConfig.setSubscriptionReturnType(subscriptionReturnType);
         mappingConfig.setGenerateAsyncApi(generateAsyncApi);
@@ -364,6 +368,15 @@ public void setGenerateEqualsAndHashCode(boolean generateEqualsAndHashCode) {
         this.generateEqualsAndHashCode = generateEqualsAndHashCode;
     }
 
+    @Override
+    public Boolean getGenerateImmutableModels() {
+        return generateImmutableModels;
+    }
+
+    public void setGenerateImmutableModels(boolean generateImmutableModels) {
+        this.generateImmutableModels = generateImmutableModels;
+    }
+
     @Override
     public Boolean getGenerateToString() {
         return generateToString;
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/GraphQLCodegen.java b/src/main/java/com/kobylynskyi/graphql/codegen/GraphQLCodegen.java
@@ -92,6 +92,9 @@ private void initDefaultValues(MappingConfig mappingConfig) {
         if (mappingConfig.getParametrizedInputSuffix() == null) {
             mappingConfig.setParametrizedInputSuffix(MappingConfigConstants.DEFAULT_PARAMETRIZED_INPUT_SUFIX);
         }
+        if (mappingConfig.getGenerateImmutableModels() == null) {
+            mappingConfig.setGenerateImmutableModels(MappingConfigConstants.DEFAULT_GENERATE_IMMUTABLE_MODELS);
+        }
         if (mappingConfig.getGenerateToString() == null) {
             mappingConfig.setGenerateToString(MappingConfigConstants.DEFAULT_TO_STRING);
         }
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputDefinitionToDataModelMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputDefinitionToDataModelMapper.java
@@ -32,6 +32,7 @@ public static Map<String, Object> map(MappingContext mappingContext, ExtendedInp
         dataModel.put(FIELDS, InputValueDefinitionToParameterMapper.map(mappingContext, definition.getValueDefinitions(), definition.getName()));
         dataModel.put(BUILDER, mappingContext.getGenerateBuilder());
         dataModel.put(EQUALS_AND_HASH_CODE, mappingContext.getGenerateEqualsAndHashCode());
+        dataModel.put(IMMUTABLE_MODELS, mappingContext.getGenerateImmutableModels());
         dataModel.put(TO_STRING, mappingContext.getGenerateToString());
         dataModel.put(TO_STRING_FOR_REQUEST, mappingContext.getGenerateClient());
         return dataModel;
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/TypeDefinitionToDataModelMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/TypeDefinitionToDataModelMapper.java
@@ -20,6 +20,7 @@
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.CLASS_NAME;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.EQUALS_AND_HASH_CODE;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.FIELDS;
+import static com.kobylynskyi.graphql.codegen.model.DataModelFields.IMMUTABLE_MODELS;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.IMPLEMENTS;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.JAVA_DOC;
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.PACKAGE;
@@ -53,6 +54,7 @@ public static Map<String, Object> map(MappingContext mappingContext,
         dataModel.put(FIELDS, getFields(mappingContext, definition, document));
         dataModel.put(BUILDER, mappingContext.getGenerateBuilder());
         dataModel.put(EQUALS_AND_HASH_CODE, mappingContext.getGenerateEqualsAndHashCode());
+        dataModel.put(IMMUTABLE_MODELS, mappingContext.getGenerateImmutableModels());
         dataModel.put(TO_STRING, mappingContext.getGenerateToString());
         dataModel.put(TO_STRING_FOR_REQUEST, mappingContext.getGenerateClient());
         return dataModel;
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/DataModelFields.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/DataModelFields.java
@@ -16,6 +16,7 @@ public final class DataModelFields {
     public static final String OPERATIONS = "operations";
     public static final String BUILDER = "builder";
     public static final String EQUALS_AND_HASH_CODE = "equalsAndHashCode";
+    public static final String IMMUTABLE_MODELS = "immutableModels";
     public static final String TO_STRING = "toString";
     public static final String TO_STRING_FOR_REQUEST = "toStringForRequest";
     public static final String JAVA_DOC = "javaDoc";
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/GraphQLCodegenConfiguration.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/GraphQLCodegenConfiguration.java
@@ -134,6 +134,13 @@ public interface GraphQLCodegenConfiguration {
      */
     Boolean getGenerateEqualsAndHashCode();
 
+    /**
+     * Specifies whether generated model classes should be immutable.
+     *
+     * @return <b>true</b> if generated model classes should be immutable.
+     */
+    Boolean getGenerateImmutableModels();
+
     /**
      * Specifies whether generated model classes should have toString method defined.
      *
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfig.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfig.java
@@ -39,6 +39,7 @@ public class MappingConfig implements GraphQLCodegenConfiguration, Combinable<Ma
     private Boolean generateBuilder;
     private Boolean generateEqualsAndHashCode;
     private Boolean generateToString;
+    private Boolean generateImmutableModels;
     private Boolean generateAsyncApi;
     private Boolean generateParameterizedFieldsResolvers;
     private Boolean generateExtensionFieldsResolvers;
@@ -90,6 +91,7 @@ public void combine(MappingConfig source) {
         this.subscriptionReturnType = source.subscriptionReturnType != null ? source.subscriptionReturnType : this.subscriptionReturnType;
         this.generateBuilder = source.generateBuilder != null ? source.generateBuilder : this.generateBuilder;
         this.generateEqualsAndHashCode = source.generateEqualsAndHashCode != null ? source.generateEqualsAndHashCode : this.generateEqualsAndHashCode;
+        this.generateImmutableModels = source.generateImmutableModels != null ? source.generateImmutableModels : this.generateImmutableModels;
         this.generateToString = source.generateToString != null ? source.generateToString : this.generateToString;
         this.generateAsyncApi = source.generateAsyncApi != null ? source.generateAsyncApi : this.generateAsyncApi;
         this.generateParameterizedFieldsResolvers = source.generateParameterizedFieldsResolvers != null ? source.generateParameterizedFieldsResolvers : this.generateParameterizedFieldsResolvers;
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfigConstants.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfigConstants.java
@@ -13,6 +13,8 @@ public class MappingConfigConstants {
     public static final String DEFAULT_BUILDER_STRING = "true";
     public static final boolean DEFAULT_EQUALS_AND_HASHCODE = false;
     public static final String DEFAULT_EQUALS_AND_HASHCODE_STRING = "false";
+    public static final boolean DEFAULT_GENERATE_IMMUTABLE_MODELS = false;
+    public static final String DEFAULT_GENERATE_IMMUTABLE_MODELS_STRING = "false";
     public static final boolean DEFAULT_TO_STRING = false;
     public static final String DEFAULT_TO_STRING_STRING = "false";
     public static final boolean DEFAULT_GENERATE_PARAMETERIZED_FIELDS_RESOLVERS = true;
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingContext.java b/src/main/java/com/kobylynskyi/graphql/codegen/model/MappingContext.java
@@ -94,6 +94,11 @@ public Boolean getGenerateEqualsAndHashCode() {
         return config.getGenerateEqualsAndHashCode();
     }
 
+    @Override
+    public Boolean getGenerateImmutableModels() {
+        return config.getGenerateImmutableModels();
+    }
+
     @Override
     public Boolean getGenerateToString() {
         return config.getGenerateToString();
diff --git a/src/main/resources/templates/javaClassGraphqlType.ftl b/src/main/resources/templates/javaClassGraphqlType.ftl
@@ -61,6 +61,7 @@ public class ${className} implements java.io.Serializable<#if implements?has_con
     public ${field.type} get${field.name?cap_first}() {
         return ${field.name};
     }
+<#if !immutableModels>
 <#if field.javaDoc?has_content>
     /**
 <#list field.javaDoc as javaDocLine>
@@ -74,6 +75,7 @@ public class ${className} implements java.io.Serializable<#if implements?has_con
     public void set${field.name?cap_first}(${field.type} ${field.name}) {
         this.${field.name} = ${field.name};
     }
+</#if>
 
 </#list>
 <#if equalsAndHashCode>
diff --git a/src/test/java/com/kobylynskyi/graphql/codegen/GraphQLCodegenImmutableTest.java b/src/test/java/com/kobylynskyi/graphql/codegen/GraphQLCodegenImmutableTest.java
@@ -0,0 +1,47 @@
+package com.kobylynskyi.graphql.codegen;
+
+import com.kobylynskyi.graphql.codegen.model.MappingConfig;
+import com.kobylynskyi.graphql.codegen.utils.Utils;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+import java.util.Collections;
+import java.util.Objects;
+
+import static com.kobylynskyi.graphql.codegen.TestUtils.assertSameTrimmedContent;
+import static com.kobylynskyi.graphql.codegen.TestUtils.getFileByName;
+
+class GraphQLCodegenImmutableTest {
+
+    private GraphQLCodegen generator;
+    private final MappingConfig mappingConfig = new MappingConfig();
+
+    private final File outputBuildDir = new File("build/generated");
+    private final File outputJavaClassesDir = new File("build/generated/com/kobylynskyi/graphql/immutable");
+
+    @BeforeEach
+    void init() {
+        mappingConfig.setPackageName("com.kobylynskyi.graphql.immutable");
+        generator = new GraphQLCodegen(Collections.singletonList("src/test/resources/schemas/test.graphqls"),
+                outputBuildDir, mappingConfig);
+    }
+
+    @AfterEach
+    void cleanup() {
+        Utils.deleteDir(new File("build/generated"));
+    }
+
+    @Test
+    void generate_CheckFiles() throws Exception {
+        mappingConfig.setGenerateImmutableModels(true);
+        generator.generate();
+
+        File[] files = Objects.requireNonNull(outputJavaClassesDir.listFiles());
+
+        assertSameTrimmedContent(
+                new File("src/test/resources/expected-classes/immutable/Event.java.txt"),
+                getFileByName(files, "Event.java"));
+    }
+}
diff --git a/src/test/java/com/kobylynskyi/graphql/codegen/model/MappingConfigTest.java b/src/test/java/com/kobylynskyi/graphql/codegen/model/MappingConfigTest.java
@@ -38,6 +38,7 @@ void combineDefaultWithCustom() {
         assertTrue(mappingConfig.getGenerateBuilder());
         assertTrue(mappingConfig.getGenerateApis());
         assertTrue(mappingConfig.getGenerateEqualsAndHashCode());
+        assertFalse(mappingConfig.getGenerateImmutableModels());
         assertTrue(mappingConfig.getGenerateToString());
         assertEquals("ModelNamePrefix", mappingConfig.getModelNamePrefix());
         assertEquals("ModelNameSuffix", mappingConfig.getModelNameSuffix());
@@ -66,6 +67,7 @@ void combineCustomWithDefault() {
         assertTrue(mappingConfig.getGenerateBuilder());
         assertTrue(mappingConfig.getGenerateApis());
         assertTrue(mappingConfig.getGenerateEqualsAndHashCode());
+        assertFalse(mappingConfig.getGenerateImmutableModels());
         assertTrue(mappingConfig.getGenerateToString());
         assertEquals("ModelNamePrefix", mappingConfig.getModelNamePrefix());
         assertEquals("ModelNameSuffix", mappingConfig.getModelNameSuffix());
@@ -98,6 +100,7 @@ void combineCustomWithCustom() {
         assertFalse(mappingConfig.getGenerateBuilder());
         assertFalse(mappingConfig.getGenerateApis());
         assertFalse(mappingConfig.getGenerateEqualsAndHashCode());
+        assertTrue(mappingConfig.getGenerateImmutableModels());
         assertFalse(mappingConfig.getGenerateToString());
         assertEquals("ModelNamePrefix2", mappingConfig.getModelNamePrefix());
         assertEquals("ModelNameSuffix2", mappingConfig.getModelNameSuffix());
@@ -130,6 +133,7 @@ private static MappingConfig buildMappingConfig() {
         config.setGenerateBuilder(true);
         config.setGenerateApis(true);
         config.setGenerateEqualsAndHashCode(true);
+        config.setGenerateImmutableModels(false);
         config.setGenerateToString(true);
         config.setModelNamePrefix("ModelNamePrefix");
         config.setModelNameSuffix("ModelNameSuffix");
@@ -157,6 +161,7 @@ private static MappingConfig buildMappingConfig2() {
         config.setApiPackageName("ApiPackageName2");
         config.setGenerateBuilder(false);
         config.setGenerateApis(false);
+        config.setGenerateImmutableModels(true);
         config.setGenerateEqualsAndHashCode(false);
         config.setGenerateToString(false);
         config.setModelNamePrefix("ModelNamePrefix2");
diff --git a/src/test/resources/expected-classes/immutable/Event.java.txt b/src/test/resources/expected-classes/immutable/Event.java.txt

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	\| `generateAsyncApi` \| Boolean \| False \| If true, then wrap type into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType` \|
`15`	`15`	\| `generateDataFetchingEnvironmentArgumentInApis` \| Boolean \| False \| If true, then `graphql.schema.DataFetchingEnvironment env` will be added as a last argument to all methods of root type resolvers and field resolvers. \|
`16`	`16`	\| `generateEqualsAndHashCode` \| Boolean \| False \| Specifies whether generated model classes should have equals and hashCode methods defined. \|
	`17`	+\| `generateImmutableModels` \| Boolean \| False \| Specifies whether generated model classes should be immutable. \|
`17`	`18`	\| `generateToString` \| Boolean \| False \| Specifies whether generated model classes should have toString method defined. \|
`18`	`19`	\| `apiNamePrefix` \| String \| Empty \| Sets the prefix for GraphQL api classes (query, mutation, subscription). \|
`19`	`20`	\| `apiNameSuffix` \| String \| Resolver \| Sets the suffix for GraphQL api classes (query, mutation, subscription). \|
`@@ -100,4 +101,4 @@ Sample content of the file:`
`100`	`101`	`"Price.amount": "java.math.BigDecimal"`
`101`	`102`	`}`
`102`	`103`	`}`
`103`		-```
	`104`	+```
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,9 @@ private void initDefaultValues(MappingConfig mappingConfig) {`
`92`	`92`	`if (mappingConfig.getParametrizedInputSuffix() == null) {`
`93`	`93`	`mappingConfig.setParametrizedInputSuffix(MappingConfigConstants.DEFAULT_PARAMETRIZED_INPUT_SUFIX);`
`94`	`94`	`}`
	`95`	`+ if (mappingConfig.getGenerateImmutableModels() == null) {`
	`96`	`+ mappingConfig.setGenerateImmutableModels(MappingConfigConstants.DEFAULT_GENERATE_IMMUTABLE_MODELS);`
	`97`	`+ }`
`95`	`98`	`if (mappingConfig.getGenerateToString() == null) {`
`96`	`99`	`mappingConfig.setGenerateToString(MappingConfigConstants.DEFAULT_TO_STRING);`
`97`	`100`	`}`