Fix/enum return types and query params (#592)

* fix: enum return types generated without calling .toJson() method * fix: enums as query params generated with .name
trevorwang · Jun 29, 2023 · 2f9b6db · 2f9b6db
1 parent 7c9d815
commit 2f9b6db
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 5 deletions.
diff --git a/generator/CHANGELOG.md b/generator/CHANGELOG.md
@@ -1,4 +1,9 @@
 # Changelog
+## 7.0.7
+
+- Enums return types generated iterating over the enum values instead of calling `.toJson()` method
+- Enums as query parameters generated with `.name` instead of `toJson()`
+
 ## 7.0.6
 
 - Fix DateTime.toIso8601String() issue #586

diff --git a/generator/lib/src/generator.dart b/generator/lib/src/generator.dart
@@ -878,9 +878,19 @@ You should create a new class to encapsulate the response.
                   '$displayString.fromJson($_resultVar.data!,${_getInnerJsonSerializableMapperFn(returnType)})',
                 );
               } else {
-                mapperCode = refer(
-                  '${_displayString(returnType)}.fromJson($_resultVar.data!)',
-                );
+                if (_isEnum(returnType)) {
+                  mapperCode = refer(
+                    '${_displayString(returnType)}.values.firstWhere((e) => e.name == _result.data,'
+                    'orElse: () => throw ArgumentError('
+                    '\'${_displayString(returnType)} does not contain value \${_result.data}\','
+                    '),'
+                    ')',
+                  );
+                } else {
+                  mapperCode = refer(
+                    '${_displayString(returnType)}.fromJson($_resultVar.data!)',
+                  );
+                }
               }
               break;
             case retrofit.Parser.DartJsonMapper:
@@ -1297,6 +1307,12 @@ if (T != dynamic &&
         _typeChecker(Float).isExactlyType(returnType);
   }
 
+  bool _isEnum(DartType? dartType){
+    if (dartType == null || dartType.element == null){
+      return false;
+    }
+    return dartType.element is EnumElement;
+  }
   bool _isDateTime(DartType? dartType) {
     if (dartType == null) {
       return false;
@@ -1331,7 +1347,12 @@ if (T != dynamic &&
                       .nullSafeProperty('toIso8601String')
                       .call([])
                   : refer(p.displayName).property('toIso8601String').call([]);
-            } else {
+            } else if(_isEnum(p.type)) {
+              value = p.type.nullabilitySuffix == NullabilitySuffix.question
+                  ? refer(p.displayName)
+                      .nullSafeProperty('name')
+                  : refer(p.displayName).property('name');
+            }else{
               value = p.type.nullabilitySuffix == NullabilitySuffix.question
                   ? refer(p.displayName).nullSafeProperty('toJson').call([])
                   : refer(p.displayName).property('toJson').call([]);

diff --git a/generator/pubspec.yaml b/generator/pubspec.yaml
@@ -6,7 +6,7 @@ topics:
   - build-runner
   - codegen
   - api
-version: 7.0.6
+version: 7.0.7
 environment:
   sdk: '>=2.19.0 <4.0.0'
 

diff --git a/generator/test/src/generator_test_src.dart b/generator/test/src/generator_test_src.dart
@@ -380,6 +380,42 @@ abstract class StreamReturnType {
   Stream<User> getUser();
 }
 
+enum TestEnum { A, B }
+
+@ShouldGenerate(
+  '''
+    final value = TestEnum.values.firstWhere(
+      (e) => e.name == _result.data,
+      orElse: () => throw ArgumentError(
+        'TestEnum does not contain value \${_result.data}',
+      ),
+    );
+    return value;
+''',
+  contains: true,
+)
+@RestApi()
+abstract class EnumReturnType {
+  @GET('/')
+  Future<TestEnum> getTestEnum();
+}
+
+enum EnumParam {
+  enabled, disabled,
+}
+
+@ShouldGenerate(
+  '''
+    final queryParameters = <String, dynamic>{r'test': status?.name};
+''',
+  contains: true,
+)
+@RestApi()
+abstract class TestQueryParamEnum {
+  @GET('/test')
+  Future<void> getTest(@Query('test') EnumParam? status);
+}
+
 @ShouldGenerate(
   '''
   Stream<User> getUser() async* {