Merge pull request #129 from icapps/feature/jsonValue-in-enums

Added jsonValue field in enums

Author: ikbendewilliam

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
-## [7.0.0] - 2022-12-25
+## [7.0.0] - 2023-01-10
+- Updated min dart version to >2.17
 - Added support for generating drift tables by adding `generate_drift_table: true` on model definition
+- Added jsonValue to enum values to easily map from/to json values
 
 ## [6.1.0] - 2022-10-14
 - Support passing a directory instead of a file. All .yaml files inside this folder (recursively) will be used to build the final model data.

example/lib/custom_model_directory/article/custom_base_directory_obj.dart

@@ -198,6 +198,7 @@ Book:
     publishers:
       type: array
       required: false # this is NOT required, so will be added to the getModel method as optional
+      ignore_for_table: true
       items:
         type: Person
     category: BookCategory

example/lib/database/model/book/book.dart

@@ -3,7 +3,7 @@ description: A project used to demo the model generator
 version: 1.0.0+1
 
 environment:
-  sdk: ">=2.12.0 <3.0.0"
+  sdk: ">=2.17.0 <3.0.0"
 
 dependencies:
   drift: ^2.3.0 # This is added since we can now generate database tables

example/lib/model/article/no_custom_base_directory_obj.dart

@@ -164,14 +164,14 @@ class DriftModelWriter {
   @override
   $uppercaseFieldName fromSql(String fromDb) {
     for (final value in $uppercaseFieldName.values) {
-      if (value.toString() == fromDb) return value;
+      if (value.jsonValue == fromDb) return value;
     }
     return $uppercaseFieldName.values.first;
   }
 
   @override
   String toSql($uppercaseFieldName value) {
-    return value.toString();
+    return value.jsonValue;
   }
 }""");
     }

example/lib/model/book/book.dart

@@ -19,18 +19,32 @@ class EnumModelWriter {
     }
 
     sb.writeln('enum ${jsonModel.name} {');
+    var first = true;
     jsonModel.fields?.forEach((key) {
       final jsonValue = key.value == null || key.value?.isEmpty == null
           ? key.serializedName
           : key.value;
       final description = key.description;
+
+      if (first) {
+        first = false;
+      } else {
+        sb.writeln(',');
+      }
       if (description != null) {
         sb.writeln('  ///$description');
       }
       sb
         ..writeln("  @JsonValue('$jsonValue')")
-        ..writeln('  ${key.name},');
+        ..write("  ${key.name}('$jsonValue')");
     });
+    if (jsonModel.fields?.isNotEmpty == true) {
+      sb.writeln(';');
+    }
+    sb.writeln('');
+    sb.writeln('  final String jsonValue;');
+    sb.writeln('');
+    sb.writeln('  const ${jsonModel.name}(this.jsonValue);');
     sb.writeln('}');
 
     if (jsonModel.generateMap) {

example/lib/model/book/book_category.dart

@@ -33,13 +33,13 @@ class PersonTableGenderConverter extends TypeConverter<Gender, String> {
   @override
   Gender fromSql(String fromDb) {
     for (final value in Gender.values) {
-      if (value.toString() == fromDb) return value;
+      if (value.jsonValue == fromDb) return value;
     }
     return Gender.values.first;
   }
 
   @override
   String toSql(Gender value) {
-    return value.toString();
+    return value.jsonValue;
   }
 }

example/lib/model/ogm.dart

@@ -37,13 +37,13 @@ class PersonTableGenderConverter extends TypeConverter<Gender, String> {
   @override
   Gender fromSql(String fromDb) {
     for (final value in Gender.values) {
-      if (value.toString() == fromDb) return value;
+      if (value.jsonValue == fromDb) return value;
     }
     return Gender.values.first;
   }
 
   @override
   String toSql(Gender value) {
-    return value.toString();
+    return value.jsonValue;
   }
 }

example/lib/model/user/person/gender.dart

@@ -4,9 +4,13 @@ import 'package:json_annotation/json_annotation.dart';
 
 enum MyEnumModel {
   @JsonValue('customValue')
-  MY_VALUE_1,
+  MY_VALUE_1('customValue'),
   @JsonValue('MY_VALUE_2')
-  MY_VALUE_2,
+  MY_VALUE_2('MY_VALUE_2');
+
+  final String jsonValue;
+
+  const MyEnumModel(this.jsonValue);
 }
 
 const MyEnumModelMapping = {

example/lib/model/user/person/person.dart

@@ -4,9 +4,13 @@ import 'package:json_annotation/json_annotation.dart';
 
 enum MyEnumModel {
   @JsonValue('customValue')
-  MY_VALUE_1,
+  MY_VALUE_1('customValue'),
   @JsonValue('MY_VALUE_2')
-  MY_VALUE_2,
+  MY_VALUE_2('MY_VALUE_2');
+
+  final String jsonValue;
+
+  const MyEnumModel(this.jsonValue);
 }
 
 const MyEnumModelMapping = {