Feature: Add support for ByteArrays/Blobs

This connects the dart type Uint8List to the SQLite data type BLOB and adjusts some tests for that. Fixes #229.
pinchbv · Feb 13, 2020 · 95b87c9 · 95b87c9
1 parent 5aa9486
commit 95b87c9
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 10 deletions.
diff --git a/floor/test/integration/database.g.dart b/floor/test/integration/database.g.dart
diff --git a/floor/test/integration/database_test.dart b/floor/test/integration/database_test.dart
@@ -1,3 +1,5 @@
+import 'dart:typed_data';
+
 import 'package:floor/floor.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:matcher/matcher.dart';
@@ -212,15 +214,15 @@ void main() {
 
     group('foreign key', () {
       test('foreign key constraint failed exception', () {
-        final dog = Dog(null, 'Peter', 'Pete', 2);
+        final dog = Dog(null, 'Peter', 'Pete', 2, Uint8List(8));
 
         expect(() => dogDao.insertDog(dog), _throwsDatabaseException);
       });
 
       test('find dog for person', () async {
         final person = Person(1, 'Simon');
         await personDao.insertPerson(person);
-        final dog = Dog(2, 'Peter', 'Pete', person.id);
+        final dog = Dog(2, 'Peter', 'Pete', person.id, Uint8List(8));
         await dogDao.insertDog(dog);
 
         final actual = await dogDao.findDogForPersonId(person.id);
@@ -231,7 +233,7 @@ void main() {
       test('cascade delete dog on deletion of person', () async {
         final person = Person(1, 'Simon');
         await personDao.insertPerson(person);
-        final dog = Dog(2, 'Peter', 'Pete', person.id);
+        final dog = Dog(2, 'Peter', 'Pete', person.id, Uint8List(8));
         await dogDao.insertDog(dog);
 
         await personDao.deletePerson(person);
@@ -387,15 +389,15 @@ void main() {
         final actual = await personDao.findPersonsWithNamesLike('%a%');
 
         final expectedPersons =
-            persons.where((person) => person.name.contains('a'));
+        persons.where((person) => person.name.contains('a'));
         expect(actual, equals(expectedPersons));
       });
     });
   });
 }
 
 final _throwsDatabaseException =
-    throwsA(const TypeMatcher<DatabaseException>());
+throwsA(const TypeMatcher<DatabaseException>());
 
 extension on String {
   String reversed() => split('').reversed.join();

diff --git a/floor/test/integration/model/dog.dart b/floor/test/integration/model/dog.dart
@@ -1,5 +1,8 @@
+import 'dart:typed_data';
+
 import 'package:floor/floor.dart';
 
+import '../../test_util/list_helper.dart';
 import 'person.dart';
 
 @Entity(
@@ -25,7 +28,9 @@ class Dog {
   @ColumnInfo(name: 'owner_id')
   final int ownerId;
 
-  Dog(this.id, this.name, this.nickName, this.ownerId);
+  final Uint8List picture;
+
+  Dog(this.id, this.name, this.nickName, this.ownerId, this.picture);
 
   @override
   bool operator ==(Object other) =>
@@ -35,6 +40,7 @@ class Dog {
           id == other.id &&
           name == other.name &&
           nickName == other.nickName &&
+          ListHelper.deepEquals(picture, other.picture) &&
           ownerId == other.ownerId;
 
   @override
@@ -43,6 +49,6 @@ class Dog {
 
   @override
   String toString() {
-    return 'Dog{id: $id, name: $name, nickName: $nickName, ownerId: $ownerId}';
+    return 'Dog{id: $id, name: $name, nickName: $nickName, ownerId: $ownerId, picture: $picture}';
   }
 }
diff --git a/floor/test/test_util/list_helper.dart b/floor/test/test_util/list_helper.dart
@@ -0,0 +1,22 @@
+import 'dart:typed_data';
+
+class ListHelper{
+  static bool deepEquals(final Uint8List l1,final Uint8List l2){
+    if(identical(l1,l2)){
+      return true;
+    }
+    if(l1 == null || l2 == null){
+      return false;
+    }
+    if(l1.length!=l2.length) {
+      return false;
+    }
+    for(int i=0; i < l1.length ; ++i) {
+      if (l1.elementAt(i) != l2.elementAt(i)) {
+        return false;
+      }
+    }
+    return true;
+  }
+}
+
diff --git a/floor_generator/lib/misc/constants.dart b/floor_generator/lib/misc/constants.dart
@@ -33,6 +33,7 @@ abstract class SqlType {
   static const INTEGER = 'INTEGER';
   static const TEXT = 'TEXT';
   static const REAL = 'REAL';
+  static const BLOB = 'BLOB';
 }
 
 abstract class OnConflictStrategy {

diff --git a/floor_generator/lib/processor/entity_processor.dart b/floor_generator/lib/processor/entity_processor.dart
@@ -266,6 +266,8 @@ class EntityProcessor extends Processor<Entity> {
       return '$parameterValue as String';
     } else if (parameterType.isDartCoreInt) {
       return '$parameterValue as int';
+    } else if (parameterType.getDisplayString() == 'Uint8List') {
+      return '$parameterValue';
     } else {
       return '$parameterValue as double'; // must be double
     }

diff --git a/floor_generator/lib/processor/field_processor.dart b/floor_generator/lib/processor/field_processor.dart
@@ -66,6 +66,8 @@ class FieldProcessor extends Processor<Field> {
       return SqlType.INTEGER;
     } else if (type.isDartCoreDouble) {
       return SqlType.REAL;
+    } else if (type.getDisplayString() == 'Uint8List') {
+      return SqlType.BLOB;
     }
     throw InvalidGenerationSourceError(
       'Column type is not supported for $type.',