Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added jsonValue field in enums #129

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions example/lib/database/model/book/book.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions example/lib/model/article/no_custom_base_directory_obj.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions example/lib/model/book/book.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 9 additions & 3 deletions example/lib/model/book/book_category.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions example/lib/model/ogm.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 13 additions & 9 deletions example/lib/model/user/person/gender.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions example/lib/model/user/person/person.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions example/lib/model/user/profile/admin_profile_data.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions example/lib/model/user/profile/user_profile_data.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions example/lib/model/user/project/project.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions example/lib/model/user/testing.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions example/model_generator/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions lib/writer/drift_model_writer.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}""");
}
Expand Down
16 changes: 15 additions & 1 deletion lib/writer/enum_model_writer.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
4 changes: 2 additions & 2 deletions test/writer/drift_model_writer/enum_field/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
4 changes: 2 additions & 2 deletions test/writer/drift_model_writer/enum_field_twice/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
8 changes: 6 additions & 2 deletions test/writer/enum_model_writer/custom-value-map-extension.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
8 changes: 6 additions & 2 deletions test/writer/enum_model_writer/custom-value-map.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
Loading