fix(dynamite): Allow int enums

feat(dynamite_end_to_end_test): Add test for int enums Co-authored-by: Nikolas Rimikis <[email protected]> Signed-off-by: jld3103 <[email protected]> Signed-off-by: Nikolas Rimikis <[email protected]>
nextcloud · Dec 19, 2023 · 5ed0eb3 · 5ed0eb3
1 parent 9dcbd4c
commit 5ed0eb3
Show file tree

Hide file tree

Showing 31 changed files with 7,619 additions and 5,848 deletions.
diff --git a/packages/dynamite/dynamite/lib/src/builder/resolve_enum.dart b/packages/dynamite/dynamite/lib/src/builder/resolve_enum.dart
@@ -1,9 +1,7 @@
 import 'package:code_builder/code_builder.dart';
-import 'package:dynamite/src/builder/resolve_type.dart';
 import 'package:dynamite/src/builder/state.dart';
 import 'package:dynamite/src/helpers/built_value.dart';
 import 'package:dynamite/src/helpers/dart_helpers.dart';
-import 'package:dynamite/src/helpers/type_result.dart';
 import 'package:dynamite/src/models/openapi.dart' as openapi;
 import 'package:dynamite/src/models/type_result.dart';
 
@@ -16,92 +14,228 @@ TypeResult resolveEnum(
   final bool nullable = false,
 }) {
   if (state.resolvedTypes.add(TypeResultEnum(identifier, subResult))) {
-    state.output.add(
-      Class(
-        (final b) => b
-          ..name = identifier
-          ..extend = refer('EnumClass')
-          ..constructors.add(
-            Constructor(
-              (final b) => b
-                ..name = '_'
-                ..constant = true
-                ..requiredParameters.add(
-                  Parameter(
-                    (final b) => b
-                      ..name = 'name'
-                      ..toSuper = true,
-                  ),
-                ),
-            ),
-          )
-          ..fields.addAll(
-            schema.$enum!.map(
-              (final value) => Field(
-                (final b) {
-                  final result = resolveType(
-                    spec,
-                    state,
-                    '$identifier${toDartName(value, uppercaseFirstCharacter: true)}',
-                    schema,
-                    ignoreEnum: true,
-                  );
-                  b
-                    ..name = toDartName(value)
-                    ..static = true
-                    ..modifier = FieldModifier.constant
-                    ..type = refer(identifier)
-                    ..assignment = Code(
-                      '_\$${toCamelCase(identifier)}${toDartName(value, uppercaseFirstCharacter: true)}',
-                    );
+    var enumType = subResult.className;
+    if (enumType == 'JsonObject') {
+      enumType = 'Object';
+    }
+
+    final values = <String, Object?>{};
+    for (final enumValue in schema.$enum!) {
+      final dartName = toDartName(enumValue.toString());
+      var value = enumValue.value;
+      if (enumValue.isString) {
+        value = "r'$value'";
+      }
 
-                  if (toDartName(value) != value) {
-                    if (result.name != 'String' && result.name != 'int') {
-                      throw Exception(
-                        'Sorry enum values are a bit broken. '
-                        'See https://github.com/google/json_serializable.dart/issues/616. '
-                        'Please remove the enum values on $identifier.',
-                      );
-                    }
-                    b.annotations.add(
-                      refer('BuiltValueEnumConst').call([], {
-                        'wireName': refer(valueToEscapedValue(result, value)),
-                      }),
-                    );
-                  }
-                },
+      values[dartName] = value;
+    }
+
+    final $class = Class(
+      (final b) => b
+        ..name = identifier
+        ..extend = refer('DynamiteEnum<$enumType>')
+        ..constructors.add(
+          Constructor(
+            (final b) => b
+              ..name = '_'
+              ..constant = true
+              ..requiredParameters.add(
+                Parameter(
+                  (final b) => b
+                    ..name = 'name'
+                    ..toSuper = true,
+                ),
               ),
+          ),
+        )
+        ..fields.addAll(
+          values.entries.map(
+            (final enumValue) => Field(
+              (final b) {
+                b
+                  ..name = enumValue.key
+                  ..static = true
+                  ..modifier = FieldModifier.constant
+                  ..type = refer(identifier)
+                  ..assignment = Code('$identifier._(${enumValue.value})');
+              },
             ),
-          )
-          ..methods.addAll([
-            Method(
-              (final b) => b
-                ..name = 'values'
-                ..returns = refer('BuiltSet<$identifier>')
-                ..lambda = true
-                ..static = true
-                ..body = Code('_\$${toCamelCase(identifier)}Values')
-                ..type = MethodType.getter,
-            ),
-            Method(
-              (final b) => b
-                ..name = 'valueOf'
-                ..returns = refer(identifier)
-                ..lambda = true
-                ..static = true
-                ..requiredParameters.add(
-                  Parameter(
-                    (final b) => b
-                      ..name = 'name'
-                      ..type = refer(subResult.name),
-                  ),
-                )
-                ..body = Code('_\$valueOf$identifier(name)'),
-            ),
-            buildSerializer(identifier),
-          ]),
-      ),
+          ),
+        )
+        ..methods.addAll([
+          Method((final b) {
+            b
+              ..name = 'values'
+              ..returns = refer('BuiltSet<$identifier>')
+              ..lambda = true
+              ..static = true
+              ..type = MethodType.getter;
+
+            final buffer = StringBuffer()
+              ..writeln('BuiltSet<$identifier>(const <$identifier>[')
+              ..writeAll(values.entries.map((final enumValue) => '$identifier.${enumValue.key}'), ',\n')
+              ..writeln(',')
+              ..write('])');
+
+            b.body = Code(buffer.toString());
+          }),
+          Method((final b) {
+            b
+              ..name = 'valueOf'
+              ..returns = refer(identifier)
+              ..static = true
+              ..requiredParameters.add(
+                Parameter(
+                  (final b) => b
+                    ..name = 'name'
+                    ..type = refer(enumType),
+                ),
+              );
+            final buffer = StringBuffer()..writeln('switch (name) {');
+
+            for (final enumValue in values.entries) {
+              buffer
+                ..writeln('case ${enumValue.value}:')
+                ..writeln('return $identifier.${enumValue.key};');
+            }
+
+            buffer.writeln('default: throw ArgumentError(name); }');
+
+            b.body = Code(buffer.toString());
+          }),
+          buildSerializer(identifier, isCustom: true),
+        ]),
+    );
+
+    final serializer = Class(
+      (final b) => b
+        ..name = '_\$${identifier}Serializer'
+        ..implements.add(refer('PrimitiveSerializer<$identifier>'))
+        ..constructors.add(
+          Constructor(
+            (final b) => b..constant = true,
+          ),
+        )
+        ..fields.addAll([
+          Field((final b) {
+            b
+              ..static = true
+              ..modifier = FieldModifier.constant
+              ..type = refer('Map<$identifier, $enumType>')
+              ..name = '_toWire';
+            final buffer = StringBuffer()
+              ..writeln('<$identifier, $enumType>{')
+              ..writeAll(
+                values.entries.map((final enumValue) => '$identifier.${enumValue.key}:${enumValue.value}'),
+                ',\n',
+              )
+              ..writeln(',')
+              ..write('}');
+
+            b.assignment = Code(buffer.toString());
+          }),
+          Field((final b) {
+            b
+              ..static = true
+              ..modifier = FieldModifier.constant
+              ..type = refer('Map<$enumType, $identifier>')
+              ..name = '_fromWire';
+            final buffer = StringBuffer()
+              ..writeln('<$enumType, $identifier>{')
+              ..writeAll(
+                values.entries.map((final enumValue) => '${enumValue.value}:$identifier.${enumValue.key}'),
+                ',\n',
+              )
+              ..writeln(',')
+              ..write('}');
+
+            b.assignment = Code(buffer.toString());
+          }),
+        ])
+        ..methods.addAll([
+          Method(
+            (final b) => b
+              ..name = 'types'
+              ..lambda = true
+              ..type = MethodType.getter
+              ..returns = refer('Iterable<Type>')
+              ..annotations.add(refer('override'))
+              ..body = Code('const [$identifier]'),
+          ),
+          Method(
+            (final b) => b
+              ..name = 'wireName'
+              ..lambda = true
+              ..type = MethodType.getter
+              ..returns = refer('String')
+              ..annotations.add(refer('override'))
+              ..body = Code("r'$identifier'"),
+          ),
+          Method((final b) {
+            b
+              ..name = 'serialize'
+              ..returns = refer('Object')
+              ..annotations.add(refer('override'))
+              ..lambda = true
+              ..requiredParameters.addAll([
+                Parameter(
+                  (final b) => b
+                    ..name = 'serializers'
+                    ..type = refer('Serializers'),
+                ),
+                Parameter(
+                  (final b) => b
+                    ..name = 'object'
+                    ..type = refer(identifier),
+                ),
+              ])
+              ..optionalParameters.add(
+                Parameter(
+                  (final b) => b
+                    ..name = 'specifiedType'
+                    ..type = refer('FullType')
+                    ..named = true
+                    ..defaultTo = const Code('FullType.unspecified'),
+                ),
+              )
+              ..body = const Code('_toWire[object]!');
+          }),
+          Method((final b) {
+            b
+              ..name = 'deserialize'
+              ..returns = refer(identifier)
+              ..annotations.add(refer('override'))
+              ..lambda = true
+              ..requiredParameters.addAll([
+                Parameter(
+                  (final b) => b
+                    ..name = 'serializers'
+                    ..type = refer('Serializers'),
+                ),
+                Parameter(
+                  (final b) => b
+                    ..name = 'serialized'
+                    ..type = refer('Object'),
+                ),
+              ])
+              ..optionalParameters.add(
+                Parameter(
+                  (final b) => b
+                    ..name = 'specifiedType'
+                    ..type = refer('FullType')
+                    ..named = true
+                    ..defaultTo = const Code('FullType.unspecified'),
+                ),
+              )
+              ..body = const Code('_fromWire[serialized]!');
+          }),
+        ]),
     );
+
+    state.output.addAll([
+      $class,
+      serializer,
+    ]);
   }
   return TypeResultEnum(
     identifier,

diff --git a/packages/dynamite/dynamite/lib/src/builder/resolve_type.dart b/packages/dynamite/dynamite/lib/src/builder/resolve_type.dart
@@ -12,7 +12,6 @@ TypeResult resolveType(
   final State state,
   final String identifier,
   final openapi.Schema schema, {
-  final bool ignoreEnum = false,
   final bool nullable = false,
 }) {
   TypeResult? result;
@@ -178,7 +177,7 @@ TypeResult resolveType(
   }
 
   if (result != null) {
-    if (!ignoreEnum && schema.$enum != null) {
+    if (schema.$enum != null) {
       result = resolveEnum(
         spec,
         state,

diff --git a/packages/dynamite/dynamite/lib/src/builder/state.dart b/packages/dynamite/dynamite/lib/src/builder/state.dart
@@ -25,7 +25,7 @@ class State {
   /// Wether the state contains resolved types that need the built_value generator.
   bool get hasResolvedBuiltTypes => resolvedTypes
       .where(
-        (final type) => type is TypeResultEnum || (type is TypeResultObject && type.className != 'ContentString'),
+        (final type) => type is TypeResultObject && type.className != 'ContentString',
       )
       .isNotEmpty;
 }
diff --git a/packages/dynamite/dynamite/lib/src/helpers/type_result.dart b/packages/dynamite/dynamite/lib/src/helpers/type_result.dart
@@ -1,8 +1,11 @@
 import 'package:dynamite/src/helpers/dart_helpers.dart';
 import 'package:dynamite/src/models/type_result.dart';
 
-String valueToEscapedValue(final TypeResult result, final String value) {
-  if (result is TypeResultBase && result.name == 'String') {
+/// Escapes a [value] using the type specific syntax from [result].
+///
+/// Use [forceString] to ensure the returned value is a `String`.
+String valueToEscapedValue(final TypeResult result, final String value, {final bool forceString = false}) {
+  if ((result is TypeResultBase && result.name == 'String') || forceString) {
     return "'$value'";
   }
   if (result is TypeResultList) {

diff --git a/packages/dynamite/dynamite/lib/src/models/openapi.dart b/packages/dynamite/dynamite/lib/src/models/openapi.dart
@@ -1,4 +1,5 @@
 import 'package:built_collection/built_collection.dart';
+import 'package:built_value/json_object.dart';
 import 'package:built_value/serializer.dart';
 import 'package:built_value/standard_json_plugin.dart';
 import 'package:dynamite/src/models/openapi/components.dart';

diff --git a/packages/dynamite/dynamite/lib/src/models/openapi.g.dart b/packages/dynamite/dynamite/lib/src/models/openapi.g.dart
diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/schema.dart b/packages/dynamite/dynamite/lib/src/models/openapi/schema.dart
@@ -39,7 +39,7 @@ abstract class Schema implements Built<Schema, SchemaBuilder> {
   JsonObject? get $default;
 
   @BuiltValueField(wireName: 'enum')
-  BuiltList<String>? get $enum;
+  BuiltList<JsonObject>? get $enum;
 
   BuiltMap<String, Schema>? get properties;