Feature/enum support (#681)

* Integrated enum support in enteties and queries. Updated example project.

* Updated tests.

* Fixed analyze error.

* Removed commented extra code.

* Optimised serialization/deserialization of enum from String value to use enum indexes

* Fixed formatting issue.

* Updated example project by the actions menu to allow filter tasks by type.

* Updated documentation supported types.

* Requested changes.

docs/entities.md

@@ -45,6 +45,7 @@ Floor entities can hold values of the following Dart types which map to their co
 - `String` - TEXT
 - `bool` - INTEGER (0 = false, 1 = true)
 - `Uint8List` - BLOB
+- `enum` - INTEGER (records by the index 0..n)
 
 In case you want to store sophisticated Dart objects that can be represented by one of the above types, take a look at [Type Converters](type-converters.md).
 

example/lib/main.dart

@@ -32,7 +32,7 @@ class FloorApp extends StatelessWidget {
   }
 }
 
-class TasksWidget extends StatelessWidget {
+class TasksWidget extends StatefulWidget {
   final String title;
   final TaskDao dao;
 
@@ -42,35 +42,75 @@ class TasksWidget extends StatelessWidget {
     required this.dao,
   }) : super(key: key);
 
+  @override
+  State<StatefulWidget> createState() => TasksWidgetState();
+}
+
+class TasksWidgetState extends State<TasksWidget> {
+  TaskType? _selectedType;
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
-      appBar: AppBar(title: Text(title)),
+      appBar: AppBar(
+        title: Text(widget.title),
+        actions: <Widget>[
+          PopupMenuButton<int>(
+            itemBuilder: (context) {
+              return List.generate(
+                TaskType.values.length + 1, //Uses increment to handle All types
+                (index) {
+                  return PopupMenuItem<int>(
+                    value: index,
+                    child: Text(
+                      index == 0 ? 'All' : _getMenuType(index).title,
+                    ),
+                  );
+                },
+              );
+            },
+            onSelected: (index) {
+              setState(() {
+                _selectedType = index == 0 ? null : _getMenuType(index);
+              });
+            },
+          )
+        ],
+      ),
       body: SafeArea(
         child: Column(
           children: <Widget>[
-            TasksListView(dao: dao),
-            TasksTextField(dao: dao),
+            TasksListView(
+              dao: widget.dao,
+              selectedType: _selectedType,
+            ),
+            TasksTextField(dao: widget.dao),
           ],
         ),
       ),
     );
   }
+
+  TaskType _getMenuType(int index) => TaskType.values[index - 1];
 }
 
 class TasksListView extends StatelessWidget {
   final TaskDao dao;
+  final TaskType? selectedType;
 
   const TasksListView({
     Key? key,
     required this.dao,
+    required this.selectedType,
   }) : super(key: key);
 
   @override
   Widget build(BuildContext context) {
     return Expanded(
       child: StreamBuilder<List<Task>>(
-        stream: dao.findAllTasksAsStream(),
+        stream: selectedType == null
+            ? dao.findAllTasksAsStream()
+            : dao.findAllTasksByTypeAsStream(selectedType!),
         builder: (_, snapshot) {
           if (!snapshot.hasData) return Container();
 
@@ -105,20 +145,60 @@ class TaskListCell extends StatelessWidget {
   Widget build(BuildContext context) {
     return Dismissible(
       key: Key('${task.hashCode}'),
-      background: Container(color: Colors.red),
-      direction: DismissDirection.endToStart,
+      background: Container(
+        padding: const EdgeInsets.only(left: 16),
+        color: Colors.green,
+        child: const Align(
+          child: Text(
+            'Change status',
+            style: TextStyle(color: Colors.white),
+          ),
+          alignment: Alignment.centerLeft,
+        ),
+      ),
+      secondaryBackground: Container(
+        padding: const EdgeInsets.only(right: 16),
+        color: Colors.red,
+        child: const Align(
+          child: Text(
+            'Delete',
+            style: TextStyle(color: Colors.white),
+          ),
+          alignment: Alignment.centerRight,
+        ),
+      ),
+      direction: DismissDirection.horizontal,
       child: ListTile(
-        leading: Text(task.message),
+        title: Text(task.message),
+        subtitle: Text('Status: ${task.type.title}'),
         trailing: Text(task.timestamp.toIso8601String()),
       ),
-      onDismissed: (_) async {
-        await dao.deleteTask(task);
-
-        final scaffoldMessengerState = ScaffoldMessenger.of(context);
-        scaffoldMessengerState.hideCurrentSnackBar();
-        scaffoldMessengerState.showSnackBar(
-          const SnackBar(content: Text('Removed task')),
-        );
+      confirmDismiss: (direction) async {
+        String? statusMessage;
+        switch (direction) {
+          case DismissDirection.endToStart:
+            await dao.deleteTask(task);
+            statusMessage = 'Removed task';
+            break;
+          case DismissDirection.startToEnd:
+            final tasksLength = TaskType.values.length;
+            final nextIndex = (tasksLength + task.type.index + 1) % tasksLength;
+            final taskCopy = task.copyWith(type: TaskType.values[nextIndex]);
+            await dao.updateTask(taskCopy);
+            statusMessage = 'Updated task status by: ${taskCopy.type.title}';
+            break;
+          default:
+            break;
+        }
+
+        if (statusMessage != null) {
+          final scaffoldMessengerState = ScaffoldMessenger.of(context);
+          scaffoldMessengerState.hideCurrentSnackBar();
+          scaffoldMessengerState.showSnackBar(
+            SnackBar(content: Text(statusMessage)),
+          );
+        }
+        return statusMessage != null;
       },
     );
   }
@@ -174,7 +254,7 @@ class TasksTextField extends StatelessWidget {
     if (message.trim().isEmpty) {
       _textEditingController.clear();
     } else {
-      final task = Task(null, message, DateTime.now());
+      final task = Task.optional(message: message);
       await dao.insertTask(task);
       _textEditingController.clear();
     }

example/lib/task.dart

@@ -1,15 +1,65 @@
 import 'package:floor/floor.dart';
 
+enum TaskType {
+  open('Open'),
+  inProgress('In Progress'),
+  done('Done');
+
+  final String title;
+
+  const TaskType(this.title);
+}
+
 @entity
 class Task {
   @PrimaryKey(autoGenerate: true)
   final int? id;
 
   final String message;
 
+  final bool isRead;
+
   final DateTime timestamp;
 
-  Task(this.id, this.message, this.timestamp);
+  final TaskType type;
+
+  Task(this.id, this.isRead, this.message, this.timestamp, this.type);
+
+  factory Task.optional({
+    int? id,
+    DateTime? timestamp,
+    String? message,
+    bool? isRead,
+    TaskType? type,
+  }) =>
+      Task(
+        id,
+        isRead ?? false,
+        message ?? 'empty',
+        timestamp ?? DateTime.now(),
+        type ?? TaskType.open,
+      );
+
+  @override
+  String toString() {
+    return 'Task{id: $id, message: $message, read: $isRead, timestamp: $timestamp, type: $type}';
+  }
+
+  Task copyWith({
+    int? id,
+    String? message,
+    bool? isRead,
+    DateTime? timestamp,
+    TaskType? type,
+  }) {
+    return Task(
+      id ?? this.id,
+      isRead ?? this.isRead,
+      message ?? this.message,
+      timestamp ?? this.timestamp,
+      type ?? this.type,
+    );
+  }
 
   @override
   bool operator ==(Object other) =>
@@ -18,13 +68,15 @@ class Task {
           runtimeType == other.runtimeType &&
           id == other.id &&
           message == other.message &&
-          timestamp == other.timestamp;
+          isRead == other.isRead &&
+          timestamp == other.timestamp &&
+          type == other.type;
 
   @override
-  int get hashCode => id.hashCode ^ message.hashCode ^ timestamp.hashCode;
-
-  @override
-  String toString() {
-    return 'Task{id: $id, message: $message, timestamp: $timestamp}';
-  }
+  int get hashCode =>
+      id.hashCode ^
+      message.hashCode ^
+      isRead.hashCode ^
+      timestamp.hashCode ^
+      type.hashCode;
 }

example/lib/task_dao.dart

@@ -12,6 +12,9 @@ abstract class TaskDao {
   @Query('SELECT * FROM task')
   Stream<List<Task>> findAllTasksAsStream();
 
+  @Query('SELECT * FROM task WHERE type = :type')
+  Stream<List<Task>> findAllTasksByTypeAsStream(TaskType type);
+
   @insert
   Future<void> insertTask(Task task);