added .remove(), .removeMany() methods and seperate unit tests

Author: liquidiert

lib/src/bindings/bindings.dart

@@ -59,6 +59,7 @@ class _ObjectBoxBindings {
   int Function(Pointer<Void> box, Pointer<Uint64> objects, Pointer<Uint64> ids, int mode) obx_box_put_many;
   int Function(Pointer<Void> box, int id) obx_box_remove;
   int Function(Pointer<Void> box, Pointer<Uint64> removed) obx_box_remove_all;
+  int Function(Pointer<Void> box, Pointer<Uint64> ids, Pointer<Uint64> removed) obx_box_remove_many;
 
   // box analytics
   int Function(Pointer<Void> box, int limit, Pointer<Uint64> count) obx_box_count;
@@ -132,6 +133,7 @@ class _ObjectBoxBindings {
     obx_box_put_many = _fn<obx_box_put_many_native_t>("obx_box_put_many").asFunction();
     obx_box_remove = _fn<obx_box_remove_native_t>("obx_box_remove").asFunction();
     obx_box_remove_all = _fn<obx_box_remove_all_native_t>("obx_box_remove_all").asFunction();
+    obx_box_remove_many = _fn<obx_box_remove_many_native_t>("obx_box_remove_many").asFunction();
 
     // box analytics
     obx_box_count = _fn<obx_box_count_native_t>("obx_box_count").asFunction();

lib/src/bindings/signatures.dart

@@ -56,5 +56,6 @@ typedef obx_box_put_many_native_t = Int32 Function(
     Pointer<Void> box, Pointer<Uint64> objects, Pointer<Uint64> ids, Int32 mode);
 typedef obx_box_remove_native_t = Int32 Function(Pointer<Void> box, Uint64 id);
 typedef obx_box_remove_all_native_t = Int32 Function(Pointer<Void> box, Pointer<Uint64> removed);
+typedef obx_box_remove_many_native_t = Int32 Function(Pointer<Void> box, Pointer<Uint64> ids, Pointer<Uint64> removed);
 typedef obx_box_count_native_t = Int32 Function(Pointer<Void> box, Uint64 limit, Pointer<Uint64> _count);
 typedef obx_box_is_empty_native_t = Int32 Function(Pointer<Void> box, Pointer<Uint8> is_empty);

lib/src/box.dart

@@ -1,5 +1,7 @@
 import "dart:ffi";
 
+import 'package:objectbox/src/common.dart';
+
 import "store.dart";
 import "bindings/bindings.dart";
 import "bindings/constants.dart";
@@ -166,27 +168,54 @@ class Box<T> {
     return _getMany(() => checkObxPtr(bindings.obx_box_get_all(_cBox), "failed to get all objects from box", true));
   }
 
-  // same as calling maxCount with limit := 0
-  int count() {
-    return maxCount(limit: 0);
-  }
-
-  int maxCount({int limit}) {
+  int count({int limit: 0}) {
     Pointer<Uint64> _count = Pointer<Uint64>.allocate();
-    checkObx(bindings.obx_box_count(_cBox, limit, _count));
-    return _count.load<int>();
+    try {
+      checkObx(bindings.obx_box_count(_cBox, limit, _count));
+      return _count.load<int>();
+    } finally {
+      _count.free();
+    }
   }
 
   bool isEmpty() {
     Pointer<Uint8> _isEmpty = Pointer<Uint8>.allocate();
-    checkObx(bindings.obx_box_is_empty(_cBox, _isEmpty));
-    return _isEmpty.load<int>() > 0 ? true : false;
+    try {
+      checkObx(bindings.obx_box_is_empty(_cBox, _isEmpty));
+      return _isEmpty.load<int>() > 0 ? true : false;
+    } finally {
+      _isEmpty.free();
+    }
+  }
+
+  bool remove(int id) {
+    try {
+      checkObx(bindings.obx_box_remove(_cBox, id));
+    } on ObjectBoxException catch (ex) {
+      if (ex.raw_msg == "code 404") return false;
+      else throw(ex);
+    }
+    return true;
+  }
+
+  int removeMany(List<int> ids) {
+    Pointer<Uint64> _removedIds = Pointer<Uint64>.allocate();
+    try {
+      checkObx(bindings.obx_box_remove_many(_cBox, IDArray(ids).ptr, _removedIds));
+      return _removedIds.load<int>();
+    } finally {
+      _removedIds.free();
+    }
   }
 
   int removeAll() {
     Pointer<Uint64> _removedItems = Pointer<Uint64>.allocate();
-    checkObx(bindings.obx_box_remove_all(_cBox, _removedItems));
-    return _removedItems.load<int>();
+    try {
+      checkObx(bindings.obx_box_remove_all(_cBox, _removedItems));
+      return _removedItems.load<int>();
+    } finally {
+      _removedItems.free();
+    }
   }
 
   get ptr => _cBox;

lib/src/common.dart

@@ -27,10 +27,11 @@ Version versionLib() {
   }
 }
 
-class ObjectBoxException {
+class ObjectBoxException implements Exception {
   final String message;
+  final String raw_msg;
 
-  ObjectBoxException(msg) : message = "ObjectBoxException: " + msg;
+  ObjectBoxException(msg) : message = "ObjectBoxException: " + msg, raw_msg = msg;
 
   String toString() => message;
 }

test/box_test.dart

@@ -19,6 +19,8 @@ void main() {
   Store store;
   Box box;
 
+  final List<TestEntity> simple_items = ["One", "Two", "Three", "Four", "Five", "Six"].map((s) => TestEntity.construct(s)).toList();
+
   group("box", () {
     setUp(() {
       store = Store([TestEntity_OBXDefs]);
@@ -93,16 +95,55 @@ void main() {
       expect(fetchedItems[2].text, equals("Two"));
     });
 
-    test(".count(), .isEmpty(), .removeAll() works", () {
-      final List<TestEntity> items = ["One", "Two"].map((s) => TestEntity.construct(s)).toList();
-      final List<int> ids = box.putMany(items);
-      
+    test(".count() works", () {
+      List<int> ids = box.putMany(simple_items);
       int count = box.count();
-      expect(count, greaterThanOrEqualTo(0));
+      expect(count, equals(6));
+      //add more
+      ids.addAll(box.putMany(simple_items));
+      count = box.count();
+      expect(count, equals(12));
+    });
+
+    test(".isEmpty() works", () {
       bool isEmpty = box.isEmpty();
+      expect(isEmpty, equals(true));
+      //check complementary
+      final List<int> ids = box.putMany(simple_items);
+      isEmpty = box.isEmpty();
       expect(isEmpty, equals(false));
+    });
+
+    test(".remove(id) works", () {
+      final List<int> ids = box.putMany(simple_items);
+      //check if single id remove works
+      box.remove(ids[1]);
+      expect(box.count(), equals(5));
+      //check what happens if id already deleted -> throws OBJBOXEX 404
+      bool success = box.remove(ids[1]);
+      expect(box.count(), equals(5));
+      expect(success, equals(false));
+    });
+
+    test(".removeMany(ids) works", () {
+      final List<int> ids = box.putMany(simple_items);
+      expect(box.count(), equals(6));
+      box.removeMany(ids.sublist(4));
+      expect(box.count(), equals(4));
+      //again test what happens if ids already deleted
+      box.removeMany(ids.sublist(4));
+      expect(box.count(), equals(4));
+    });
+
+    test(".removeAll() works", () {
+      List<int> ids = box.putMany(simple_items);
       int removed = box.removeAll();
-      expect(removed, greaterThan(0));
+      expect(removed, equals(6));
+      //try with different number of items
+      List<TestEntity> items = ["one", "two", "three"].map((s) => TestEntity.construct(s)).toList();
+      ids.addAll(box.putMany(items));
+      removed = box.removeAll();
+      expect(removed, equals(3));
     });
 
     tearDown(() {