Refactored DBTable annotation. Now it allows to specify target class which allows to split class implementation and annotations.

Added ORM.addAdapter and ORM.setDefaultAdapter.

Author: ustims

CHANGELOG.md

@@ -1,3 +1,9 @@
+0.1.1
+-----
+
+- Refactored DBTable annotation. Now it allows to specify target class which 
+  allows to split class implementation and annotations.
+
 0.1.0
 -----
 

example/example.dart

@@ -85,7 +85,8 @@ dynamic example() async {
       'postgres://dart_orm_test:dart_orm_test@localhost:5432/dart_orm_test');
   await postgresqlAdapter.connect();
 
-  ORM.Model.ormAdapter = postgresqlAdapter;
+  ORM.addAdapter('postgres', postgresqlAdapter);
+  ORM.setDefaultAdapter('postgres');
 
   bool migrationResult = await ORM.Migrator.migrate();
   assert(migrationResult);
@@ -97,7 +98,8 @@ dynamic example() async {
       'mongodb://dart_orm_test:[email protected]/dart_orm_test');
   await mongoAdapter.connect();
 
-  ORM.Model.ormAdapter = mongoAdapter;
+  ORM.addAdapter('mongo', mongoAdapter);
+  ORM.setDefaultAdapter('mongo');
 
   migrationResult = await ORM.Migrator.migrate();
   assert(migrationResult);
@@ -108,7 +110,10 @@ dynamic example() async {
   MySQLDBAdapter mysqlAdapter = new MySQLDBAdapter(
       'mysql://dart_orm_test:dart_orm_test@localhost:3306/dart_orm_test');
   await mysqlAdapter.connect();
-  ORM.Model.ormAdapter = mysqlAdapter;
+
+  ORM.addAdapter('mysql', mysqlAdapter);
+  ORM.setDefaultAdapter('mysql');
+
   migrationResult = await ORM.Migrator.migrate();
   assert(migrationResult);
 

lib/dart_orm.dart

@@ -5,5 +5,6 @@ export 'src/annotations.dart';
 export 'src/migrator.dart';
 export 'src/model.dart';
 export 'src/operations.dart';
+export 'src/orm.dart';
 export 'src/sql_types.dart';
 export 'src/sql.dart';

lib/src/annotations.dart

@@ -2,7 +2,6 @@ library dart_orm.annotations;
 
 import 'dart:mirrors';
 
-import 'model.dart';
 import 'operations.dart';
 
 /**
@@ -20,9 +19,11 @@ class DBTable {
    * One can override this by providing
    * String parameter 'tableName' to constructor.
    */
-  const DBTable([this.name]);
+  const DBTable([this.name, this.annotationTarget]);
 
   final String name;
+
+  final Type annotationTarget;
 }
 
 /**
@@ -66,8 +67,20 @@ class AnnotationsParser {
             MirrorSystem.getName(metaInstanceMirror.type.simpleName);
 
         if (metaClassName == 'DBTable') {
+          DBTable dbTableAnnotation = (metaInstanceMirror.reflectee as DBTable);
+
+          // if annotation target is not provided then class annotated
+          // with DBTable is a model itself
           Table table = AnnotationsParser.constructTable(classMirror);
-          ormClasses[modelClassName] = table;
+
+          if (dbTableAnnotation.annotationTarget == null) {
+            ormClasses[modelClassName] = table;
+          } else {
+            // we have annotation target so let's get that class
+            ClassMirror target =
+                reflectClass(dbTableAnnotation.annotationTarget);
+            ormClasses[MirrorSystem.getName(target.simpleName)] = table;
+          }
         }
       }
     }
@@ -111,20 +124,22 @@ class AnnotationsParser {
   /**
    * Returns [Table] definition object for specified model class instance.
    */
-  static Table getTableForInstance(Model instance) {
+  static Table getTableForInstance(dynamic instance) {
     InstanceMirror mirror = reflect(instance);
     String instanceClassName = MirrorSystem.getName(mirror.type.simpleName);
 
     return ormClasses[instanceClassName];
   }
 
-  static dynamic getPropertyValueForField(Field field, Model instance) {
+  /// Returns [field] value for provided model [instance]
+  static dynamic getPropertyValueForField(Field field, dynamic instance) {
     InstanceMirror mirror = reflect(instance);
     return mirror.getField(field.constructedFromPropertyName).reflectee;
   }
 
+  /// Allows setting [field]'s [value] on provided object instance.
   static dynamic setPropertyValueForField(
-      Field field, dynamic value, Model instance) {
+      Field field, dynamic value, dynamic instance) {
     InstanceMirror mirror = reflect(instance);
     return mirror.setField(field.constructedFromPropertyName, value);
   }

lib/src/migrator.dart

@@ -8,6 +8,7 @@ import 'adapter.dart';
 import 'annotations.dart';
 import 'model.dart';
 import 'operations.dart';
+import 'orm.dart';
 
 final Logger log = new Logger('Migrator');
 
@@ -22,7 +23,7 @@ class OrmInfoTable extends Model {
 
 class Migrator {
   static Future<bool> migrate() async {
-    DBAdapter adapter = Model.ormAdapter;
+    DBAdapter adapter = getDefaultAdapter();
 
     // we store database schema and its version in
     // addition table called orm_info_table

lib/src/model.dart

@@ -6,21 +6,24 @@ import 'dart:mirrors';
 import 'adapter.dart';
 import 'annotations.dart';
 import 'operations.dart';
+import 'orm.dart' as orm;
 
 class Model {
   Table _tableDefinition;
-  static DBAdapter _sAdapter;
 
   Model() {
     _tableDefinition = AnnotationsParser.getTableForInstance(this);
   }
 
+  /// Adds adapter that will be used by models.
+  /// This is deprecated and will be removed in 0.2.0
+  /// Use [orm.addAdapter] and [orm.setDefaultAdapter] instead.
+  @deprecated
   static void set ormAdapter(DBAdapter adapter) {
-    _sAdapter = adapter;
+    orm.addAdapter('modelAdapter', adapter);
+    orm.setDefaultAdapter('modelAdapter');
   }
 
-  static DBAdapter get ormAdapter => _sAdapter;
-
   /**
    * Returns DBFieldSQL instance
    * for primary key defined in this model.
@@ -61,85 +64,26 @@ class Model {
    *
    * Throws [Exception] if model instance has not-null primary key.
    */
-  Future insert() async {
-    var primaryKeyValue = getPrimaryKeyValue();
-    if (primaryKeyValue != null) {
-      throw new Exception('insert() should not be called' +
-          'on instances with not-null primary key value, use update() instead.');
-    }
-
-    Insert insert = new Insert(_tableDefinition);
-
-    for (Field field in _tableDefinition.fields) {
-      if (!field.isPrimaryKey) {
-        insert.value(field.fieldName,
-            AnnotationsParser.getPropertyValueForField(field, this));
-      }
-    }
-
-    var newRecordId = await ormAdapter.insert(insert);
-    if (this.getPrimaryKeyField() != null) {
-      this.setPrimaryKeyValue(newRecordId);
-    }
-
-    return newRecordId;
-  }
+  Future insert() => orm.insert(this);
 
   /**
    * Updates this model instance data on database.
    * This model instance primary key should have a not null value.
    *
    * Throws [Exception] if this model instance is null.
    */
-  Future update() async {
-    var primaryKeyValue = getPrimaryKeyValue();
-    if (primaryKeyValue == null) {
-      throw new Exception('update() should not be called' +
-          'on instances with null primary key value, use insert() instead.');
-    }
-
-    Update update = new Update(_tableDefinition);
-
-    for (Field field in _tableDefinition.fields) {
-      var value = AnnotationsParser.getPropertyValueForField(field, this);
-      if (field.isPrimaryKey) {
-        update.where(new Equals(field.fieldName, value));
-      } else {
-        update.set(field.fieldName, value);
-      }
-    }
-
-    var updateResult = await ormAdapter.update(update);
-    return updateResult;
-  }
+  Future update() => orm.update(this);
 
   /**
    * Deletes this model instance data on database.
    * This model instance primary key should have a not null value.
    *
    * Throws [Exception] if this model instance is null.
    */
-  Future delete() async {
-    var primaryKeyValue = getPrimaryKeyValue();
-    if (primaryKeyValue == null) {
-      throw new Exception('delete() should not be called' +
-          'on instances with null primary key value.');
-    }
-
-    Delete delete = new Delete(_tableDefinition);
-
-    Field field = getPrimaryKeyField();
-    if (field != null) {
-      var value = AnnotationsParser.getPropertyValueForField(field, this);
-      delete.where(new Equals(field.fieldName, value));
-    }
-
-    var deleteResult = await ormAdapter.delete(delete);
-    return deleteResult;
-  }
+  Future delete() => orm.delete(this);
 
   Future<bool> save() async {
-    var primaryKeyValue = getPrimaryKeyValue();
+    var primaryKeyValue = this.getPrimaryKeyValue();
 
     if (primaryKeyValue != null) {
       var updateResult = this.update();
@@ -176,7 +120,7 @@ class FindBase extends Select {
     }
   }
 
-  static Future<Model> _executeFindOne(Type modelType, Select sql) async {
+  static Future _executeFindOne(Type modelType, Select sql) async {
     List<Model> foundModels = await _executeFind(modelType, sql);
     if (foundModels.length > 0) {
       return foundModels.last;
@@ -185,14 +129,13 @@ class FindBase extends Select {
     }
   }
 
-  static Future<List<Model>> _executeFind(
-      Type modelType, Select selectSql) async {
+  static Future<List> _executeFind(Type modelType, Select selectSql) async {
     Table modelTable = AnnotationsParser.getTableForType(modelType);
     ClassMirror modelMirror = reflectClass(modelType);
 
-    List<Model> foundInstances = new List<Model>();
+    List<dynamic> foundInstances = new List<dynamic>();
 
-    var rows = await Model.ormAdapter.select(selectSql);
+    var rows = await orm.getDefaultAdapter().select(selectSql);
     for (Map<String, dynamic> row in rows) {
       InstanceMirror newInstance =
           modelMirror.newInstance(new Symbol(''), [], new Map());
@@ -212,11 +155,11 @@ class FindBase extends Select {
 class Find extends FindBase {
   Find(Type modelType) : super(modelType);
 
-  Future<List<Model>> execute() => FindBase._executeFind(_modelType, this);
+  Future<List<dynamic>> execute() => FindBase._executeFind(_modelType, this);
 }
 
 class FindOne extends FindBase {
   FindOne(Type modelType) : super(modelType);
 
-  Future<Model> execute() => FindBase._executeFindOne(_modelType, this);
+  Future<dynamic> execute() => FindBase._executeFindOne(_modelType, this);
 }