Use TypeChecker for all annotations

README.md

@@ -151,7 +151,7 @@ It holds the *DAOs* and, beyond that, takes care of initializing the database an
 
 The figure shows the relationship between *Entity*, *DAO* and *Database*.
 
-![Floor Architecture](img/floor-architecture.png)
+![Floor Architecture](https://raw.githubusercontent.com/vitusortner/floor/develop/img/floor-architecture.png)
 
 ## Querying
 Method signatures turn into query methods by adding the `@Query()` annotation with the query in parenthesis to them.
@@ -184,7 +184,7 @@ All these methods accept single or multiple entity instances.
 - **Insert**
 
     `@insert` marks a method as an insertion method.
-    WHen using the capitalized `@Insert` you can specify a conflict strategy.
+    When using the capitalized `@Insert` you can specify a conflict strategy.
     Else it just defaults to aborting the insert.
     These methods can return a `Future` of either `void`, `int` or `List<int>`.
     - `void` return nothing

floor/README.md

@@ -151,7 +151,7 @@ It holds the *DAOs* and, beyond that, takes care of initializing the database an
 
 The figure shows the relationship between *Entity*, *DAO* and *Database*.
 
-![Floor Architecture](../img/floor-architecture.png)
+![Floor Architecture](https://raw.githubusercontent.com/vitusortner/floor/develop/img/floor-architecture.png)
 
 ## Querying
 Method signatures turn into query methods by adding the `@Query()` annotation with the query in parenthesis to them.
@@ -184,7 +184,7 @@ All these methods accept single or multiple entity instances.
 - **Insert**
 
     `@insert` marks a method as an insertion method.
-    WHen using the capitalized `@Insert` you can specify a conflict strategy.
+    When using the capitalized `@Insert` you can specify a conflict strategy.
     Else it just defaults to aborting the insert.
     These methods can return a `Future` of either `void`, `int` or `List<int>`.
     - `void` return nothing

floor_generator/build.yaml

@@ -11,6 +11,7 @@ builders:
     builder_factories: ["floorBuilder"]
     # The 'partId' argument to 'SharedPartBuilder' is 'floor'
     build_extensions: {".dart": [".floor.g.part"]}
+    # Apply the Builder to the package with a direct dependency on the package exposing the builder
     auto_apply: dependents
     build_to: cache
     # To copy the '.g.dart' content into '.g.dart' in the source tree

floor_generator/lib/misc/query_method_processor_error.dart

@@ -0,0 +1,28 @@
+import 'package:analyzer/dart/element/element.dart';
+import 'package:source_gen/source_gen.dart';
+
+class QueryMethodProcessorError {
+  final MethodElement _methodElement;
+
+  QueryMethodProcessorError(final MethodElement methodElement)
+      : assert(methodElement != null),
+        _methodElement = methodElement;
+
+  // ignore: non_constant_identifier_names
+  InvalidGenerationSourceError get NO_QUERY_DEFINED {
+    return InvalidGenerationSourceError(
+      "You didn't define a query.",
+      todo: 'Define a query by adding SQL to the @Query() annotation.',
+      element: _methodElement,
+    );
+  }
+
+  // ignore: non_constant_identifier_names
+  InvalidGenerationSourceError get DOES_NOT_RETURN_FUTURE_NOR_STREAM {
+    return InvalidGenerationSourceError(
+      'All queries have to return a Future or Stream.',
+      todo: 'Define the return type as Future or Stream.',
+      element: _methodElement,
+    );
+  }
+}

floor_generator/lib/misc/type_utils.dart

@@ -1,22 +1,10 @@
-import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:floor_generator/misc/annotations.dart';
-import 'package:floor_generator/misc/constants.dart';
 import 'package:source_gen/source_gen.dart';
 
 @nonNull
 TypeChecker typeChecker(final Type type) => TypeChecker.fromRuntime(type);
 
-final _stringTypeChecker = typeChecker(String);
-
-final _boolTypeChecker = typeChecker(bool);
-
-final _intTypeChecker = typeChecker(int);
-
-final _doubleTypeChecker = typeChecker(double);
-
-final _streamTypeChecker = typeChecker(Stream);
-
 bool isString(final DartType type) {
   return _stringTypeChecker.isExactlyType(type);
 }
@@ -35,7 +23,7 @@ bool isDouble(final DartType type) {
 
 bool isList(final DartType type) {
   // TODO this weirdly fails when using a TypeChecker
-  return type.name == 'List' && _isDartCore(type);
+  return type.name == 'List' && type.element.library.isDartCore;
 }
 
 bool isSupportedType(final DartType type) {
@@ -51,38 +39,6 @@ bool isStream(final DartType type) {
   return _streamTypeChecker.isExactlyType(type);
 }
 
-bool isEntityAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.ENTITY;
-}
-
-bool isColumnInfoAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.COLUMN_INFO;
-}
-
-bool isPrimaryKeyAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.PRIMARY_KEY;
-}
-
-bool isQueryAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.QUERY;
-}
-
-bool isInsertAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.INSERT;
-}
-
-bool isUpdateAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.UPDATE;
-}
-
-bool isDeleteAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.DELETE;
-}
-
-bool isTransactionAnnotation(final ElementAnnotation annotation) {
-  return _getAnnotationName(annotation) == Annotation.TRANSACTION;
-}
-
 DartType flattenList(final DartType type) {
   return (type as ParameterizedType).typeArguments.first;
 }
@@ -91,10 +47,12 @@ DartType flattenStream(final DartType type) {
   return (type as ParameterizedType).typeArguments.first;
 }
 
-bool _isDartCore(final DartType type) {
-  return type.element.library.isDartCore;
-}
+final _stringTypeChecker = typeChecker(String);
 
-String _getAnnotationName(final ElementAnnotation annotation) {
-  return annotation.computeConstantValue().type.displayName;
-}
+final _boolTypeChecker = typeChecker(bool);
+
+final _intTypeChecker = typeChecker(int);
+
+final _doubleTypeChecker = typeChecker(double);
+
+final _streamTypeChecker = typeChecker(Stream);

floor_generator/lib/processor/dao_processor.dart

@@ -1,4 +1,6 @@
 import 'package:analyzer/dart/element/element.dart';
+import 'package:floor_annotation/floor_annotation.dart' as annotations
+    show Query, Insert, Update, delete, transaction;
 import 'package:floor_generator/misc/type_utils.dart';
 import 'package:floor_generator/processor/deletion_method_processor.dart';
 import 'package:floor_generator/processor/insertion_method_processor.dart';
@@ -61,7 +63,8 @@ class DaoProcessor extends Processor<Dao> {
 
   List<QueryMethod> _getQueryMethods(List<MethodElement> methods) {
     return methods
-        .where((method) => method.metadata.any(isQueryAnnotation))
+        .where((method) =>
+            typeChecker(annotations.Query).hasAnnotationOfExact(method))
         .map((method) => QueryMethodProcessor(method, _entities).process())
         .toList();
   }
@@ -70,28 +73,32 @@ class DaoProcessor extends Processor<Dao> {
     List<MethodElement> methodElements,
   ) {
     return methodElements
-        .where((method) => method.metadata.any(isInsertAnnotation))
+        .where((method) =>
+            typeChecker(annotations.Insert).hasAnnotationOfExact(method))
         .map((method) => InsertionMethodProcessor(method, _entities).process())
         .toList();
   }
 
   List<UpdateMethod> _getUpdateMethods(List<MethodElement> methods) {
     return methods
-        .where((method) => method.metadata.any(isUpdateAnnotation))
+        .where((method) =>
+            typeChecker(annotations.Update).hasAnnotationOfExact(method))
         .map((method) => UpdateMethodProcessor(method, _entities).process())
         .toList();
   }
 
   List<DeletionMethod> _getDeletionMethods(List<MethodElement> methods) {
     return methods
-        .where((method) => method.metadata.any(isDeleteAnnotation))
+        .where((method) => typeChecker(annotations.delete.runtimeType)
+            .hasAnnotationOfExact(method))
         .map((method) => DeletionMethodProcessor(method, _entities).process())
         .toList();
   }
 
   List<TransactionMethod> _getTransactionMethods(List<MethodElement> methods) {
     return methods
-        .where((method) => method.metadata.any(isTransactionAnnotation))
+        .where((method) => typeChecker(annotations.transaction.runtimeType)
+            .hasAnnotationOfExact(method))
         .map((method) =>
             TransactionMethodProcessor(method, _daoGetterName, _databaseName)
                 .process())

floor_generator/lib/processor/database_processor.dart

@@ -1,5 +1,6 @@
 import 'package:analyzer/dart/element/element.dart';
-import 'package:floor_annotation/floor_annotation.dart' as annotations;
+import 'package:floor_annotation/floor_annotation.dart' as annotations
+    show Database, dao, Entity;
 import 'package:floor_generator/misc/annotations.dart';
 import 'package:floor_generator/misc/constants.dart';
 import 'package:floor_generator/misc/database_processor_error.dart';

floor_generator/lib/processor/field_processor.dart

@@ -1,4 +1,6 @@
 import 'package:analyzer/dart/element/element.dart';
+import 'package:floor_annotation/floor_annotation.dart' as annotations
+    show ColumnInfo, PrimaryKey;
 import 'package:floor_generator/misc/constants.dart';
 import 'package:floor_generator/misc/type_utils.dart';
 import 'package:floor_generator/processor/processor.dart';
@@ -8,6 +10,8 @@ import 'package:source_gen/source_gen.dart';
 class FieldProcessor extends Processor<Field> {
   final FieldElement _fieldElement;
 
+  final _columnInfoTypeChecker = typeChecker(annotations.ColumnInfo);
+
   FieldProcessor(final FieldElement fieldElement)
       : assert(fieldElement != null),
         _fieldElement = fieldElement;
@@ -16,10 +20,11 @@ class FieldProcessor extends Processor<Field> {
   Field process() {
     final name = _fieldElement.name;
     final hasColumnInfoAnnotation =
-        _fieldElement.metadata.any(isColumnInfoAnnotation);
+        _columnInfoTypeChecker.hasAnnotationOfExact(_fieldElement);
     final columnName = _getColumnName(hasColumnInfoAnnotation, name);
     final isNullable = _getIsNullable(hasColumnInfoAnnotation);
-    final isPrimaryKey = _fieldElement.metadata.any(isPrimaryKeyAnnotation);
+    final isPrimaryKey =
+        typeChecker(annotations.PrimaryKey).hasAnnotationOfExact(_fieldElement);
 
     return Field(
       _fieldElement,
@@ -33,22 +38,20 @@ class FieldProcessor extends Processor<Field> {
 
   String _getColumnName(bool hasColumnInfoAnnotation, String name) {
     return hasColumnInfoAnnotation
-        ? _fieldElement.metadata
-                .firstWhere(isColumnInfoAnnotation)
-                .computeConstantValue()
+        ? _columnInfoTypeChecker
+                .firstAnnotationOfExact(_fieldElement)
                 .getField(AnnotationField.COLUMN_INFO_NAME)
-                .toStringValue() ??
+                ?.toStringValue() ??
             name
         : name;
   }
 
   bool _getIsNullable(bool hasColumnInfoAnnotation) {
     return hasColumnInfoAnnotation
-        ? _fieldElement.metadata
-                .firstWhere(isColumnInfoAnnotation)
-                .computeConstantValue()
+        ? _columnInfoTypeChecker
+                .firstAnnotationOfExact(_fieldElement)
                 .getField(AnnotationField.COLUMN_INFO_NULLABLE)
-                .toBoolValue() ??
+                ?.toBoolValue() ??
             true
         : true; // all Dart fields are nullable by default
   }

floor_generator/lib/processor/insertion_method_processor.dart

@@ -1,12 +1,14 @@
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
+import 'package:floor_annotation/floor_annotation.dart' as annotations
+    show Insert;
 import 'package:floor_generator/misc/annotations.dart';
 import 'package:floor_generator/misc/change_method_processor_helper.dart';
 import 'package:floor_generator/misc/constants.dart';
+import 'package:floor_generator/misc/type_utils.dart';
 import 'package:floor_generator/processor/processor.dart';
 import 'package:floor_generator/value_object/entity.dart';
 import 'package:floor_generator/value_object/insertion_method.dart';
-import 'package:floor_generator/misc/type_utils.dart';
 import 'package:source_gen/source_gen.dart';
 
 class InsertionMethodProcessor implements Processor<InsertionMethod> {
@@ -81,9 +83,8 @@ class InsertionMethodProcessor implements Processor<InsertionMethod> {
 
   @nonNull
   String _getOnConflictStrategy() {
-    final strategy = _methodElement.metadata
-        .firstWhere(isInsertAnnotation)
-        .computeConstantValue()
+    final strategy = typeChecker(annotations.Insert)
+        .firstAnnotationOfExact(_methodElement)
         .getField(AnnotationField.ON_CONFLICT)
         .toIntValue();
 

floor_generator/lib/processor/query_method_processor.dart

@@ -1,13 +1,19 @@
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
+import 'package:floor_annotation/floor_annotation.dart' as annotations
+    show Query;
+import 'package:floor_generator/misc/annotations.dart';
 import 'package:floor_generator/misc/constants.dart';
+import 'package:floor_generator/misc/query_method_processor_error.dart';
 import 'package:floor_generator/misc/type_utils.dart';
 import 'package:floor_generator/processor/processor.dart';
 import 'package:floor_generator/value_object/entity.dart';
 import 'package:floor_generator/value_object/query_method.dart';
 import 'package:source_gen/source_gen.dart';
 
 class QueryMethodProcessor extends Processor<QueryMethod> {
+  final QueryMethodProcessorError _processorError;
+
   final MethodElement _methodElement;
   final List<Entity> _entities;
 
@@ -17,8 +23,10 @@ class QueryMethodProcessor extends Processor<QueryMethod> {
   )   : assert(methodElement != null),
         assert(entities != null),
         _methodElement = methodElement,
-        _entities = entities;
+        _entities = entities,
+        _processorError = QueryMethodProcessorError(methodElement);
 
+  @nonNull
   @override
   QueryMethod process() {
     final name = _methodElement.displayName;
@@ -52,19 +60,17 @@ class QueryMethodProcessor extends Processor<QueryMethod> {
     );
   }
 
+  @nonNull
   String _getQuery() {
-    final query = _methodElement.metadata
-        .firstWhere(isQueryAnnotation)
-        .computeConstantValue()
+    final query = typeChecker(annotations.Query)
+        .firstAnnotationOfExact(_methodElement)
         .getField(AnnotationField.QUERY_VALUE)
-        .toStringValue();
+        ?.toStringValue();
+
+    if (query.isEmpty || query == null) throw _processorError.NO_QUERY_DEFINED;
+
+    // TODO parse query
 
-    if (query.isEmpty || query == null) {
-      throw InvalidGenerationSourceError(
-        "You didn't define a query.",
-        element: _methodElement,
-      );
-    }
     return query.replaceAll(RegExp(':'), r'$');
   }
 
@@ -75,6 +81,7 @@ class QueryMethodProcessor extends Processor<QueryMethod> {
         .toList();
   }
 
+  @nonNull
   DartType _getFlattenedReturnType(
     final DartType rawReturnType,
     final bool returnsStream,
@@ -90,6 +97,7 @@ class QueryMethodProcessor extends Processor<QueryMethod> {
     return type;
   }
 
+  @nonNull
   bool _getReturnsList(final DartType returnType, final bool returnsStream) {
     final type = returnsStream
         ? flattenStream(returnType)
@@ -103,10 +111,7 @@ class QueryMethodProcessor extends Processor<QueryMethod> {
     final bool returnsStream,
   ) {
     if (!rawReturnType.isDartAsyncFuture && !returnsStream) {
-      throw InvalidGenerationSourceError(
-        'All queries have to return a Future or Stream.',
-        element: _methodElement,
-      );
+      throw _processorError.DOES_NOT_RETURN_FUTURE_NOR_STREAM;
     }
   }