Support embedded objects

.github/workflows/ci.yml

@@ -83,7 +83,7 @@ jobs:
 
       - name: Install dependencies
         run: flutter packages get
-        working-directory: floor
+        working-directory: floor_common
 
       - name: Run generator
         run: flutter packages pub run build_runner build --delete-conflicting-outputs

example/lib/database.dart

@@ -2,14 +2,15 @@ import 'dart:async';
 
 import 'package:example/task.dart';
 import 'package:example/task_dao.dart';
+import 'package:example/timestamp.dart';
 import 'package:example/type_converter.dart';
 import 'package:floor/floor.dart';
 import 'package:sqflite/sqflite.dart' as sqflite;
 
 part 'database.g.dart';
 
-@Database(version: 1, entities: [Task])
 @TypeConverters([DateTimeConverter, TaskTypeConverter])
+@Database(version: 1, entities: [Task], embeds: [Timestamp])
 abstract class FlutterDatabase extends FloorDatabase {
   TaskDao get taskDao;
 }

example/lib/main.dart

@@ -1,6 +1,7 @@
 import 'package:example/database.dart';
 import 'package:example/task.dart';
 import 'package:example/task_dao.dart';
+import 'package:example/timestamp.dart';
 import 'package:flutter/material.dart';
 
 Future<void> main() async {
@@ -179,7 +180,7 @@ class TaskListCell extends StatelessWidget {
       child: ListTile(
         title: Text(task.message),
         subtitle: Text('Status: ${task.statusTitle}'),
-        trailing: Text(task.timestamp.toIso8601String()),
+        trailing: Text(task.timestamp.format()),
       ),
       confirmDismiss: (direction) async {
         String? statusMessage;
@@ -263,7 +264,13 @@ class TasksTextField extends StatelessWidget {
     if (message.trim().isEmpty) {
       _textEditingController.clear();
     } else {
-      final task = Task.optional(message: message, type: TaskType.task);
+      final task = Task.optional(
+          message: message,
+          type: TaskType.task,
+          timestamp: Timestamp(
+            createdAt: DateTime.now(),
+            updatedAt: DateTime.now(),
+          ));
       await dao.insertTask(task);
       _textEditingController.clear();
     }

example/lib/task.dart

@@ -1,3 +1,4 @@
+import 'package:example/timestamp.dart';
 import 'package:floor/floor.dart';
 
 enum TaskStatus {
@@ -29,7 +30,7 @@ class Task {
 
   final bool? isRead;
 
-  final DateTime timestamp;
+  final Timestamp timestamp;
 
   final TaskStatus? status;
 
@@ -46,7 +47,7 @@ class Task {
 
   factory Task.optional({
     int? id,
-    DateTime? timestamp,
+    Timestamp? timestamp,
     String? message,
     bool? isRead,
     TaskStatus? status,
@@ -56,7 +57,11 @@ class Task {
         id,
         isRead ?? false,
         message ?? 'empty',
-        timestamp ?? DateTime.now(),
+        timestamp ??
+            Timestamp(
+              createdAt: DateTime.now(),
+              updatedAt: DateTime.now(),
+            ),
         status,
         type,
       );
@@ -70,7 +75,7 @@ class Task {
     int? id,
     String? message,
     bool? isRead,
-    DateTime? timestamp,
+    Timestamp? timestamp,
     TaskStatus? status,
     TaskType? type,
   }) {

example/lib/timestamp.dart

@@ -0,0 +1,37 @@
+import 'package:floor/floor.dart';
+import 'package:intl/intl.dart';
+
+@Embed()
+@Entity()
+class Timestamp {
+  @ColumnInfo(name: 'created_at')
+  final DateTime createdAt;
+
+  @ColumnInfo(name: 'updated_at')
+  final DateTime updatedAt;
+
+  Timestamp({required this.createdAt, required this.updatedAt});
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is Timestamp &&
+          runtimeType == other.runtimeType &&
+          createdAt == other.createdAt &&
+          updatedAt == other.updatedAt;
+
+  @override
+  int get hashCode => createdAt.hashCode ^ updatedAt.hashCode;
+
+  String format() {
+    final DateFormat formatter = DateFormat('yyyy-MM-dd');
+    final String formattedCreatedAt = formatter.format(createdAt);
+    final String formattedUpdatedAt = formatter.format(updatedAt);
+    return 'Created at: $formattedCreatedAt \nUpdated at: $formattedUpdatedAt';
+  }
+
+  @override
+  String toString() {
+    return 'Timestamp(createdAt: $createdAt, updatedAt: $updatedAt)';
+  }
+}

example/pubspec.lock

@@ -223,7 +223,7 @@ packages:
       path: "../floor"
       relative: true
     source: path
-    version: "1.4.2"
+    version: "1.5.0"
   floor_annotation:
     dependency: transitive
     description:
@@ -311,6 +311,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.0.2"
+  intl:
+    dependency: "direct main"
+    description:
+      name: intl
+      sha256: "910f85bce16fb5c6f614e117efa303e85a1731bb0081edf3604a2ae6e9a3cc91"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.17.0"
   io:
     dependency: transitive
     description:

example/pubspec.yaml

@@ -15,6 +15,7 @@ dependencies:
   flutter:
     sdk: flutter
   sqflite: any # This dependency is needed to solve the problem with warning about transitive dependencies
+  intl: ^0.17.0
 
 dev_dependencies:
   analyzer: ^6.4.1

example/test/main_test.dart

@@ -14,6 +14,8 @@ void main() {
   });
 
   tearDown(() async {
+    //Delay is necessary, otherwise test wil fail after completion
+    await Future.delayed(const Duration(milliseconds: 100));
     await database.close();
   });
 

floor_annotation/lib/floor_annotation.dart

@@ -5,6 +5,7 @@ export 'src/dao.dart';
 export 'src/database.dart';
 export 'src/database_view.dart';
 export 'src/delete.dart';
+export 'src/embed.dart';
 export 'src/entity.dart';
 export 'src/foreign_key.dart';
 export 'src/fts.dart';

floor_annotation/lib/src/database.dart

@@ -6,13 +6,17 @@ class Database {
   /// The entities the database manages.
   final List<Type> entities;
 
+  /// The embeds the database manages.
+  final List<Type> embeds;
+
   /// The views the database manages.
   final List<Type> views;
 
   /// Marks a class as a FloorDatabase.
   const Database({
     required this.version,
     required this.entities,
+    this.embeds = const [],
     this.views = const [],
   });
 }

floor_annotation/lib/src/embed.dart

@@ -0,0 +1,5 @@
+class Embed {
+  const Embed();
+}
+
+const embed = Embed();

floor_generator/lib/misc/constants.dart

@@ -4,6 +4,7 @@ abstract class AnnotationField {
   static const onConflict = 'onConflict';
 
   static const databaseVersion = 'version';
+  static const databaseEmbeds = 'embeds';
   static const databaseEntities = 'entities';
   static const databaseViews = 'views';
 

floor_generator/lib/misc/extension/embeds_extension.dart

@@ -0,0 +1,13 @@
+import 'package:analyzer/dart/element/type.dart';
+import 'package:collection/collection.dart';
+import 'package:floor_generator/value_object/embed.dart';
+import 'package:floor_generator/value_object/type_converter.dart';
+
+extension EmbedsExtension on Iterable<Embed> {
+  /// Returns the [Embed] in the closest [TypeConverterScope] for
+  /// [dartType] or null
+  Embed? getClosestOrNull(DartType dartType) {
+    return toList().firstWhereOrNull(
+        (embed) => embed.classElement.name == dartType.toString());
+  }
+}

floor_generator/lib/misc/extension/field_element_extension.dart

@@ -0,0 +1,15 @@
+import 'package:analyzer/dart/element/element.dart';
+import 'package:floor_annotation/floor_annotation.dart' as annotations;
+import 'package:floor_generator/misc/type_utils.dart';
+
+extension FieldElementExtension on FieldElement {
+  bool shouldBeIncluded() {
+    final isIgnored = hasAnnotation(annotations.ignore.runtimeType);
+    return !(isStatic || isSynthetic || isIgnored);
+  }
+
+  bool get isEmbedded {
+    return (type.element?.hasAnnotation(annotations.Embed) ?? false) &&
+        type.element is ClassElement;
+  }
+}