external types: support external name for @entity #139

Author: greenrobot-team

generator/lib/src/code_builder.dart

@@ -271,6 +271,7 @@ class CodeBuilder extends Builder {
 
     entityInModel.name = entity.name;
     entityInModel.flags = entity.flags;
+    entityInModel.externalName = entity.externalName;
     entityInModel.constructorParams = entity.constructorParams;
 
     // here, the entity was found already and entityInModel and entity might differ, i.e. conflicts need to be resolved, so merge all properties first

generator/lib/src/code_chunks.dart

@@ -122,12 +122,16 @@ class CodeChunks {
   }
 
   static String createModelEntity(ModelEntity entity) {
+    var additionalArgs = '';
+    if (entity.externalName != null) {
+      additionalArgs += " externalName: '${entity.externalName}',";
+    }
     return '''
     $obxInt.ModelEntity(
       id: ${createIdUid(entity.id)},
       name: '${entity.name}',
       lastPropertyId: ${createIdUid(entity.lastPropertyId)},
-      flags: ${entity.flags},
+      flags: ${entity.flags},$additionalArgs
       properties: <$obxInt.ModelProperty>[
         ${entity.properties.map(createModelProperty).join(',')}
       ],

generator/lib/src/entity_resolver.dart

@@ -70,6 +70,11 @@ class EntityResolver extends Builder {
         null,
         uidRequest: !entityUid.isNull && entityUid.intValue == 0);
 
+    // @ExternalName
+    _externalNameChecker.runIfMatches(classElement, (annotation) {
+      entity.externalName = _readExternalNameParams(annotation);
+    });
+
     // Sync: check if enabled and options
     _syncChecker.runIfMatches(classElement, (annotation) {
       entity.flags |= OBXEntityFlags.SYNC_ENABLED;

generator/test/code_builder_test.dart

@@ -380,6 +380,26 @@ void main() {
   });
 
   group("ExternalType and ExternalName annotations", () {
+    test('annotations work on @Entity', () async {
+      final source = r'''
+      library example;     
+      import 'package:objectbox/objectbox.dart';
+      
+      @Entity()
+      @ExternalName(name: 'my-mongo-entity')     
+      class Example {
+        @Id()
+        int id = 0;
+      }
+      ''';
+
+      final testEnv = GeneratorTestEnv();
+      await testEnv.run(source);
+
+      final entity = testEnv.model.entities[0];
+      expect(entity.externalName, "my-mongo-entity");
+    });
+
     test('annotations work on properties', () async {
       final source = r'''
       library example;     

objectbox/lib/src/modelinfo/modelentity.dart

@@ -14,6 +14,7 @@ class ModelEntity {
   late String _name;
   IdUid lastPropertyId = const IdUid.empty();
   int _flags = 0;
+  String? externalName;
   final List<ModelProperty> _properties;
   final List<ModelRelation> _relations;
   final List<ModelBacklink> _backlinks;
@@ -72,6 +73,7 @@ class ModelEntity {
       required String name,
       required this.lastPropertyId,
       required int flags,
+      this.externalName,
       required List<ModelProperty> properties,
       required List<ModelRelation> relations,
       required List<ModelBacklink> backlinks})
@@ -94,6 +96,7 @@ class ModelEntity {
         _backlinks = [] {
     name = data['name'] as String?;
     flags = data['flags'] as int? ?? 0;
+    externalName = data['externalName'] as String?;
 
     final properties = data['properties'] as List;
     for (final p in properties) {
@@ -179,6 +182,7 @@ class ModelEntity {
     ret['lastPropertyId'] = lastPropertyId.toString();
     ret['name'] = name;
     if (flags != 0) ret['flags'] = flags;
+    if (externalName != null) ret['externalName'] = externalName;
     ret['properties'] =
         properties.map((p) => p.toMap(forModelJson: forModelJson)).toList();
     ret['relations'] =

objectbox/lib/src/native/model.dart

@@ -52,6 +52,15 @@ class Model {
 
     if (entity.flags != 0) _check(C.model_entity_flags(_cModel, entity.flags));
 
+    final externalName = entity.externalName?.toNativeUtf8();
+    if (externalName != null) {
+      try {
+        _check(C.model_entity_external_name(_cModel, externalName.cast()));
+      } finally {
+        calloc.free(externalName);
+      }
+    }
+
     // add all properties
     entity.properties.forEach(addProperty);
 

objectbox_test/test/box_test.dart

@@ -731,13 +731,13 @@ void main() {
     final box = store.box<EntityWithExternalType>();
     var testObject = EntityWithExternalType([90, 100, 110], [1, 2, 3]);
     testObject.mongoIdEntities
-        .add(EntityWithExternalType([120, 130, 140], null));
+        .add(EntityWithExternalType([120, 121, 122], null));
     final id = box.put(testObject);
     final item = box.get(id)!;
     expect(item.id, id);
     expect(item.mongoId, [90, 100, 110]);
     expect(item.mongoUuid, [1, 2, 3]);
-    expect(item.mongoIdEntities.first.mongoId, [120, 130, 140]);
+    expect(item.mongoIdEntities.first.mongoId, [120, 121, 122]);
   });
 
   test('.count() works', () {

objectbox_test/test/objectbox-model.json

@@ -729,6 +729,7 @@
       "id": "16:5931645853908059165",
       "lastPropertyId": "3:7670802129899081197",
       "name": "EntityWithExternalType",
+      "externalName": "my-mongo-entity",
       "properties": [
         {
           "id": "1:3044824951282217899",