Merge pull request #114 from icapps/feature/SimpleType

Support inline type definitions

Author: NicolaVerbeeck

.fvm/fvm_config.json

@@ -1,4 +1,21 @@
 # Changelog
+## [6.0.0] - 2022-10-04
+- Added the ability to specify simple fields in a more compact way, inline.
+
+Example: id and id2, name and name2 are equivalent notations
+```yaml
+ExampleModel:
+  properties:
+    id: string
+    id2: 
+      type: string
+      required: true
+    name: string?
+    name2:
+      type: string
+      required: false
+```
+
 ## [5.9.0] - 2022-03-29
 - *POTENTIALLY BREAKING CHANGE*: By default, fields with a default value will now accept 'null' to use their default value
 - Add options to control whether fields with default value accepts 'null' or not

CHANGELOG.md

@@ -85,7 +85,7 @@ UserModel:
       type: int
       ignore_equality: true
     include:
-      type: string
+      type: String
 ```
 
 ## explicit_to_json
@@ -174,7 +174,7 @@ UserModel:
       type: int
       default_value: 1
     name:
-      type: string
+      type: String
       required: true
       default_value: "'an example quoted string'"
 ```
@@ -204,7 +204,7 @@ UserModel:
       type: int
       default_value: 1
     name:
-      type: string
+      type: String
       required: true
       default_value: "'an example quoted string'"
 ```
@@ -219,7 +219,7 @@ UserModel:
       type: int
       default_value: 1
     name:
-      type: string
+      type: String
       required: true
       default_value: "'an example quoted string'"
       disallow_null: true
@@ -259,7 +259,20 @@ UserDetails:
   extends: UserModel
   properties:
     name:
-      type: string
+      type: String
+```
+
+## Builtin types
+The following framework types descriptors are known out of the box:
+```
+string/String
+int/integer
+bool/boolean
+double
+date/datetime
+dynamic/object/any
+array
+map
 ```
 
 ## Default setup
@@ -275,7 +288,7 @@ UserModel:
     id:
       type: int
     name:
-      type: string
+      type: String
     salary:
       type: double
     something:
@@ -286,7 +299,7 @@ UserModel:
     roles:
       type: array
       items:
-        type: string
+        type: String
     birthday:
       type: date
     addresses:
@@ -299,19 +312,19 @@ UserModel:
         key: String
         value: Address
     securityRole:
-      type: string
+      type: String
       jsonKey: securityIndicator
     dynamicField:
       type: dynamic
     includeIfNullField:
       include_if_null: false #If this field is null, this field will not be added to your json object (used for PATCH models)
-      type: string
+      type: String
     ignoreField:
       ignore: false #this field will not be final, and not be used in the json parsing
-      type: string
+      type: String
     mutableField:
       non_final: true #Field will not be marked final
-      type: string
+      type: String
     changedAt:
       type: datetime
     idToAddressList:
@@ -324,15 +337,15 @@ Address:
   path: webservice/user #Can also be package:... and/or end with the actual file (.dart)
   properties:
     street:
-      type: string
+      type: String
 
 #Custom base_directory
 CustomBaseDirectoryObject:
   base_directory: custom_models
   path: webservice
   properties:
     path:
-      type: string
+      type: String
 
 #Custom json converter. Use with converters property on models
 DateTimeConverter:
@@ -341,6 +354,25 @@ DateTimeConverter:
 
 ```
 
+## Inline types (since 6.0.0)
+
+In some cases, writing the full specification for simple fields is very verbose. Since 6.0.0 it is possible to write simple fields inline, without nesting below the field name:
+
+```yaml
+UserModel:
+  properties:
+    id: int
+    name: String
+    age: int
+    is_active: bool?
+    created_at: DateTime
+    roles: List<string>
+    customProperties: Map<String, Property>?
+```
+
+Currently all basic types are supported, simple Lists and Maps (no nested types, no nullable generic parameters) as well as references to other objects.
+Items post-fixed with `?` will be marked optional.
+
 ## Enum support
 
 Add enums with custom values

README.md

@@ -7,8 +7,6 @@ part 'ogm.g.dart';
 @JsonSerializable(explicitToJson: true)
 @DateTimeConverter()
 class OGM {
-  @JsonKey(name: 'structuredMessage', required: true, includeIfNull: false)
-  final String structuredMessage;
   @JsonKey(name: 'beneficiary', required: true, includeIfNull: false)
   final String beneficiary;
   @JsonKey(name: 'beneficiaryIBAN', required: true, includeIfNull: false)
@@ -19,6 +17,10 @@ class OGM {
   final String someThing;
   @JsonKey(name: 'some_ThinG_huGE', required: true, includeIfNull: false)
   final String someThinGHuGE;
+  @JsonKey(name: 'simpleFields', required: true)
+  final List<Testing> simpleFields;
+  @JsonKey(name: 'structuredMessage')
+  final String? structuredMessage;
   @JsonKey(name: 'securityIndicator', includeIfNull: false)
   final String? securityRole;
   @JsonKey(name: 'mutableProperty', includeIfNull: false)
@@ -27,18 +29,22 @@ class OGM {
   final DateTime? dateChange;
   @JsonKey(name: 'fields', includeIfNull: false)
   final List<List<Testing>>? fields;
+  @JsonKey(name: 'simpleMap')
+  final Map<String, Testing>? simpleMap;
 
   OGM({
-    required this.structuredMessage,
     required this.beneficiary,
     required this.beneficiaryIBAN,
     required this.testTest,
     required this.someThing,
     required this.someThinGHuGE,
+    required this.simpleFields,
+    this.structuredMessage,
     this.securityRole,
     this.mutableProperty,
     this.dateChange,
     this.fields,
+    this.simpleMap,
   });
 
   factory OGM.fromJson(Map<String, dynamic> json) => _$OGMFromJson(json);
@@ -50,42 +56,48 @@ class OGM {
       identical(this, other) ||
       other is OGM &&
           runtimeType == other.runtimeType &&
-          structuredMessage == other.structuredMessage &&
           beneficiary == other.beneficiary &&
           beneficiaryIBAN == other.beneficiaryIBAN &&
           testTest == other.testTest &&
           someThing == other.someThing &&
           someThinGHuGE == other.someThinGHuGE &&
+          simpleFields == other.simpleFields &&
+          structuredMessage == other.structuredMessage &&
           securityRole == other.securityRole &&
           mutableProperty == other.mutableProperty &&
           dateChange == other.dateChange &&
-          fields == other.fields;
+          fields == other.fields &&
+          simpleMap == other.simpleMap;
 
   @override
   int get hashCode =>
-      structuredMessage.hashCode ^
       beneficiary.hashCode ^
       beneficiaryIBAN.hashCode ^
       testTest.hashCode ^
       someThing.hashCode ^
       someThinGHuGE.hashCode ^
+      simpleFields.hashCode ^
+      structuredMessage.hashCode ^
       securityRole.hashCode ^
       mutableProperty.hashCode ^
       dateChange.hashCode ^
-      fields.hashCode;
+      fields.hashCode ^
+      simpleMap.hashCode;
 
   @override
   String toString() => 'OGM{'
-      'structuredMessage: $structuredMessage, '
       'beneficiary: $beneficiary, '
       'beneficiaryIBAN: $beneficiaryIBAN, '
       'testTest: $testTest, '
       'someThing: $someThing, '
       'someThinGHuGE: $someThinGHuGE, '
+      'simpleFields: $simpleFields, '
+      'structuredMessage: $structuredMessage, '
       'securityRole: $securityRole, '
       'mutableProperty: $mutableProperty, '
       'dateChange: $dateChange, '
-      'fields: $fields'
+      'fields: $fields, '
+      'simpleMap: $simpleMap'
       '}';
 }
 

example/.fvm/fvm_config.json

@@ -7,10 +7,10 @@ import 'package:model_generator_example/model/user/testing.dart';
 
 part 'admin_profile_data.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(explicitToJson: true)
 @immutable
 class AdminProfileData extends UserProfileDataExtended {
-  @JsonKey(name: 'privileges', required: true)
+  @JsonKey(name: 'privileges', required: true, includeIfNull: false)
   final String privileges;
 
   const AdminProfileData({
@@ -76,3 +76,17 @@ class AdminProfileData extends UserProfileDataExtended {
       'personsById: $personsById'
       '}';
 }
+
+AdminProfileData deserializeAdminProfileData(Map<String, dynamic> json) =>
+    AdminProfileData.fromJson(json);
+
+Map<String, dynamic> serializeAdminProfileData(AdminProfileData object) =>
+    object.toJson();
+
+List<AdminProfileData> deserializeAdminProfileDataList(
+        List<Map<String, dynamic>> jsonList) =>
+    jsonList.map((json) => AdminProfileData.fromJson(json)).toList();
+
+List<Map<String, dynamic>> serializeAdminProfileDataList(
+        List<AdminProfileData> objects) =>
+    objects.map((object) => object.toJson()).toList();