Merge pull request #345 from comigor/fragments_glob_at_schema_level

fragments glob at schema level

Author: vasilich6107

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 7.1.1-beta.1
+
+- support of `fragments_glob` at schema level
+
 ## 7.1.0-beta.2
 
 - fix for https://github.com/comigor/artemis/issues/341

README.md

@@ -124,16 +124,18 @@ Each `SchemaMap` is configured this way:
 
 | Option | Default value | Description |
 | - | - | - |
-| `output` |  | Relative path to output the generated code. It should end with `.graphql.dart` or else the generator will need to generate one more file. |
-| `schema` | | Relative path to the GraphQL schema. | | `queries_glob` | | Glob that selects all query files to be used
-with this schema. | | `naming_scheme` | `pathedWithTypes` | The naming scheme to be used on generated classes
-names. `pathedWithTypes` is the default for retrocompatibility, where the names of previous types are used as prefix of
-the next class. This can generate duplication on certain schemas. With `pathedWithFields`, the names of previous fields
-are used as prefix of the next class and with `simple`, only the actual GraphQL class nameis considered. |
-| `type_name_field` | `__typename` | The name of the field used to differentiate interfaces and union types (
+| `output` | | Relative path to output the generated code. It should end with `.graphql.dart` or else the generator will
+need to generate one more file. | | `schema` | | Relative path to the GraphQL schema. | | `queries_glob` | | Glob that
+selects all query files to be used with this schema. | | `naming_scheme` | `pathedWithTypes` | The naming scheme to be
+used on generated classes names. `pathedWithTypes` is the default for retrocompatibility, where the names of previous
+types are used as prefix of the next class. This can generate duplication on certain schemas. With `pathedWithFields`,
+the names of previous fields are used as prefix of the next class and with `simple`, only the actual GraphQL class
+nameis considered. | | `type_name_field` | `__typename` | The name of the field used to differentiate interfaces and
+union types (
 commonly `__typename` or `__resolveType`). Note that `__typename` field are not added automatically to the query. If you
 want interface/union type resolution, you need to manually add it there or set `append_type_name` to `true`. |
-| `append_type_name` | `false` | Appends `type_name_field` value to the query selections set. |
+| `append_type_name` | `false` | Appends `type_name_field` value to the query selections set. | | `fragments_glob`
+| `null` | Import path to the file implementing fragments for all queries mapped in schema_mapping. |
 
 See [examples](./example) for more information and configuration options.
 

lib/builder.dart

@@ -93,19 +93,34 @@ class GraphQLQueryBuilder implements Builder {
   Future<void> build(BuildStep buildStep) async {
     final fragmentsGlob = options.fragmentsGlob;
     if (fragmentsGlob != null) {
-      fragmentsCommon.addAll(
-        (await readGraphQlFiles(buildStep, fragmentsGlob))
-            .map((e) => e.definitions.whereType<FragmentDefinitionNode>())
-            .expand((e) => e)
-            .toList(),
-      );
+      final commonFragments = (await readGraphQlFiles(buildStep, fragmentsGlob))
+          .map((e) => e.definitions.whereType<FragmentDefinitionNode>())
+          .expand((e) => e)
+          .toList();
 
-      if (fragmentsCommon.isEmpty) {
+      if (commonFragments.isEmpty) {
         throw MissingFilesException(fragmentsGlob);
       }
+
+      fragmentsCommon.addAll(commonFragments);
     }
 
     for (final schemaMap in options.schemaMapping) {
+      final schemaFragmentsGlob = schemaMap.fragmentsGlob;
+      if (schemaFragmentsGlob != null) {
+        final schemaFragments =
+            (await readGraphQlFiles(buildStep, schemaFragmentsGlob))
+                .map((e) => e.definitions.whereType<FragmentDefinitionNode>())
+                .expand((e) => e)
+                .toList();
+
+        if (schemaFragments.isEmpty) {
+          throw MissingFilesException(schemaFragmentsGlob);
+        }
+
+        fragmentsCommon.addAll(schemaFragments);
+      }
+
       final queriesGlob = schemaMap.queriesGlob;
       final schema = schemaMap.schema;
       final output = schemaMap.output;

lib/schema/options.dart

@@ -135,6 +135,9 @@ class SchemaMap {
   /// A [Glob] to find queries files.
   final String? queriesGlob;
 
+  /// A [Glob] to find your fragments files.
+  final String? fragmentsGlob;
+
   /// The resolve type field used on this schema.
   @JsonKey(defaultValue: '__typename')
   final String typeNameField;
@@ -160,6 +163,7 @@ class SchemaMap {
     this.output,
     this.schema,
     this.queriesGlob,
+    this.fragmentsGlob,
     this.typeNameField = '__typename',
     this.appendTypeName = false,
     this.namingScheme = NamingScheme.pathedWithTypes,

lib/schema/options.g2.dart

@@ -1,5 +1,5 @@
 name: artemis
-version: 7.1.0-beta.2
+version: 7.1.1-beta.1
 
 description: Build dart types from GraphQL schemas and queries (using Introspection Query).
 homepage: https://github.com/comigor/artemis

pubspec.yaml

@@ -107,6 +107,34 @@ void main() {
       throw Exception('Expected MissingFilesException');
     });
 
+    test('When user fragments_glob at schema level return empty file',
+        () async {
+      final anotherBuilder = graphQLQueryBuilder(BuilderOptions({
+        'generate_helpers': false,
+        'schema_mapping': [
+          {
+            'schema': 'api.schema.grqphql',
+            'fragments_glob': '**.schema',
+            'output': 'lib/some_query.dart',
+          },
+        ],
+      }));
+
+      try {
+        await testBuilder(
+            anotherBuilder,
+            {
+              'a|api.schema.graphql': ''' ''',
+              'a|queries/query.graphql': ''' ''',
+            },
+            onLog: print);
+      } on MissingFilesException catch (e) {
+        expect(e.globPattern, '**.schema');
+        return;
+      }
+      throw Exception('Expected MissingFilesException');
+    });
+
     test('When schema_mapping is empty', () async {
       try {
         final anotherBuilder = graphQLQueryBuilder(BuilderOptions({