chore(vars-create-input): Adding Create Factories to Input types (#451)

* chore(vars-generator): Applying vars generation to input types * Adding codegen artifacts to e2e tests * Adding codegen artifacts to e2e tristate * Adding Unit Test
gql-dart · Mar 5, 2024 · bfafca5 · bfafca5
1 parent 44c3686
commit bfafca5
Show file tree

Hide file tree

Showing 10 changed files with 134 additions and 10 deletions.
diff --git a/codegen/end_to_end_test/build.yaml b/codegen/end_to_end_test/build.yaml
@@ -25,6 +25,7 @@ targets:
       gql_build|schema_builder:
         enabled: true
         options:
+          vars_create_factories: true
           enum_fallbacks:
             LengthUnit: METER
           type_overrides:

diff --git a/codegen/end_to_end_test/lib/graphql/__generated__/schema.schema.gql.dart b/codegen/end_to_end_test/lib/graphql/__generated__/schema.schema.gql.dart
diff --git a/codegen/end_to_end_test/test/schema/input_test.dart b/codegen/end_to_end_test/test/schema/input_test.dart
@@ -13,6 +13,13 @@ void main() {
         ..favorite_color.red = 225);
     });
 
+    test('can be instantiated via create factory', () {
+      GReviewInput.create(
+          stars: 4,
+          commentary: "This was a great movie!",
+          favorite_color: GColorInput.create(red: 255, green: 123, blue: 225));
+    });
+
     test('can be serialized and deserialized', () {
       final input = GReviewInput((b) => b
         ..stars = 4

diff --git a/codegen/end_to_end_test_tristate/build.yaml b/codegen/end_to_end_test_tristate/build.yaml
@@ -25,6 +25,7 @@ targets:
       gql_build|schema_builder:
         enabled: true
         options:
+          vars_create_factories: true
           tristate_optionals: true
           enum_fallbacks:
             LengthUnit: METER

diff --git a/codegen/end_to_end_test_tristate/lib/graphql/__generated__/schema.schema.gql.dart b/codegen/end_to_end_test_tristate/lib/graphql/__generated__/schema.schema.gql.dart
diff --git a/codegen/gql_build/lib/gql_build.dart b/codegen/gql_build/lib/gql_build.dart
@@ -58,7 +58,8 @@ Builder schemaBuilder(
         typeOverrideMap(options.config["type_overrides"]),
         enumFallbackConfig(options.config),
         generatePossibleTypesConfig(options.config),
-        triStateOptionalsConfig(options.config));
+        triStateOptionalsConfig(options.config),
+        varsCreateFactoriesConfig(options.config));
 
 /// Builds an aggregate Serlializers object for [built_value]s
 ///

diff --git a/codegen/gql_build/lib/src/schema_builder.dart b/codegen/gql_build/lib/src/schema_builder.dart
@@ -15,9 +15,14 @@ class SchemaBuilder implements Builder {
   final EnumFallbackConfig enumFallbackConfig;
   final bool generatePossibleTypesMap;
   final TriStateValueConfig triStateValueConfig;
+  final bool generateVarsCreateFactories;
 
-  SchemaBuilder(this.typeOverrides, this.enumFallbackConfig,
-      this.generatePossibleTypesMap, this.triStateValueConfig);
+  SchemaBuilder(
+      this.typeOverrides,
+      this.enumFallbackConfig,
+      this.generatePossibleTypesMap,
+      this.triStateValueConfig,
+      this.generateVarsCreateFactories);
 
   @override
   Map<String, List<String>> get buildExtensions => {
@@ -49,6 +54,7 @@ class SchemaBuilder implements Builder {
       generatePossibleTypesMap: generatePossibleTypesMap,
       allocator: allocator,
       triStateValueConfig: triStateValueConfig,
+      generateVarsCreateFactories: generateVarsCreateFactories,
     );
 
     return writeDocument(

diff --git a/codegen/gql_code_builder/lib/schema.dart b/codegen/gql_code_builder/lib/schema.dart
@@ -13,9 +13,15 @@ Library buildSchemaLibrary(SourceNode schemaSource, String partUrl,
     Map<String, Reference> typeOverrides, EnumFallbackConfig enumFallbackConfig,
     {bool generatePossibleTypesMap = false,
     Allocator? allocator,
-    TriStateValueConfig triStateValueConfig = TriStateValueConfig.never}) {
-  final lib = buildSchema(schemaSource, typeOverrides, enumFallbackConfig,
-      allocator ?? Allocator(), triStateValueConfig) as Library;
+    TriStateValueConfig triStateValueConfig = TriStateValueConfig.never,
+    bool generateVarsCreateFactories = false}) {
+  final lib = buildSchema(
+      schemaSource,
+      typeOverrides,
+      enumFallbackConfig,
+      allocator ?? Allocator(),
+      triStateValueConfig,
+      generateVarsCreateFactories) as Library;
 
   final Code? possibleTypes;
   if (generatePossibleTypesMap && lib.body.isNotEmpty) {

diff --git a/codegen/gql_code_builder/lib/src/schema.dart b/codegen/gql_code_builder/lib/src/schema.dart
@@ -15,6 +15,7 @@ Spec? buildSchema(
   EnumFallbackConfig enumFallbackConfig,
   Allocator allocator,
   TriStateValueConfig triStateValueConfig,
+  bool generateVarsCreateFactories,
 ) =>
     schemaSource.document
         .accept(
@@ -24,6 +25,7 @@ Spec? buildSchema(
             enumFallbackConfig,
             allocator,
             triStateValueConfig,
+            generateVarsCreateFactories,
           ),
         )
         ?.first;
@@ -36,8 +38,15 @@ class _SchemaBuilderVisitor extends SimpleVisitor<List<Spec>?> {
   final Allocator allocator;
   final TriStateValueConfig triStateValueConfig;
 
-  const _SchemaBuilderVisitor(this.schemaSource, this.typeOverrides,
-      this.enumFallbackConfig, this.allocator, this.triStateValueConfig);
+  final bool generateVarsCreateFactories;
+
+  const _SchemaBuilderVisitor(
+      this.schemaSource,
+      this.typeOverrides,
+      this.enumFallbackConfig,
+      this.allocator,
+      this.triStateValueConfig,
+      this.generateVarsCreateFactories);
 
   @override
   List<Spec> visitDocumentNode(
@@ -57,8 +66,8 @@ class _SchemaBuilderVisitor extends SimpleVisitor<List<Spec>?> {
   List<Spec> visitInputObjectTypeDefinitionNode(
     InputObjectTypeDefinitionNode node,
   ) {
-    final inputClass =
-        buildInputClass(node, schemaSource, typeOverrides, triStateValueConfig);
+    final inputClass = buildInputClass(node, schemaSource, typeOverrides,
+        triStateValueConfig, generateVarsCreateFactories);
 
     return switch (triStateValueConfig) {
       TriStateValueConfig.never => [inputClass],

diff --git a/codegen/gql_code_builder/lib/src/schema/input.dart b/codegen/gql_code_builder/lib/src/schema/input.dart
@@ -1,6 +1,7 @@
 import "package:code_builder/code_builder.dart";
 import "package:gql/ast.dart";
 import "package:gql_code_builder/src/config/tristate_optionals_config.dart";
+import "package:gql_code_builder/src/required_vars_constructor.dart";
 import "package:gql_code_builder/src/tristate_optionals.dart";
 
 import "../../source.dart";
@@ -12,6 +13,7 @@ List<Class> buildInputClasses(
   Map<String, Reference> typeOverrides,
   Allocator allocator,
   TriStateValueConfig triStateValueConfig,
+  bool generateVarsCreateFactories,
 ) =>
     schemaSource.document.definitions
         .whereType<InputObjectTypeDefinitionNode>()
@@ -21,6 +23,7 @@ List<Class> buildInputClasses(
         schemaSource,
         typeOverrides,
         triStateValueConfig,
+        generateVarsCreateFactories,
       );
       final serializer = nullAwareJsonSerializerClass(
           inputClass, allocator, schemaSource, typeOverrides);
@@ -32,6 +35,7 @@ Class buildInputClass(
   SourceNode schemaSource,
   Map<String, Reference> typeOverrides,
   TriStateValueConfig triStateValueConfig,
+  bool generateVarsCreateFactories,
 ) =>
     builtClass(
       name: node.name.value,
@@ -46,6 +50,23 @@ Class buildInputClass(
       ),
       hasCustomSerializer:
           triStateValueConfig == TriStateValueConfig.onAllNullableFields,
+      constructors: [
+        if (generateVarsCreateFactories)
+          builtCreateConstructor(
+            name: node.name.value,
+            getters: node.fields.map<Method>(
+              (node) => buildOptionalGetter(
+                nameNode: node.name,
+                typeNode: node.type,
+                schemaSource: schemaSource,
+                typeOverrides: typeOverrides,
+                useTriStateValueForNullableTypes: triStateValueConfig,
+              ),
+            ),
+            schemaSource: schemaSource,
+            typeOverrides: typeOverrides,
+          ),
+      ],
       initializers: {
         if (triStateValueConfig == TriStateValueConfig.onAllNullableFields)
           ..._inputClassValueInitializers(node)