Query - mark offset and limit params deprecated, add missing tests

Author: vaind

lib/src/query/query.dart

@@ -97,9 +97,9 @@ class QueryStringProperty extends QueryProperty {
     return _opList(list, ConditionOp.notIn, caseSensitive);
   }
 
-  /// Using [withEqual] is deprecated, use [greaterOrEqual] instead.
   Condition greaterThan(String p,
-      {bool caseSensitive = false, bool withEqual = false}) {
+      {bool caseSensitive = false,
+      @Deprecated('Use greaterOrEqual() instead') bool withEqual = false}) {
     if (withEqual) {
       return greaterOrEqual(p, caseSensitive: caseSensitive);
     } else {
@@ -111,9 +111,9 @@ class QueryStringProperty extends QueryProperty {
     return _op(p, ConditionOp.greaterOrEq, caseSensitive);
   }
 
-  /// Using [withEqual] is deprecated, use [lessOrEqual] instead.
   Condition lessThan(String p,
-      {bool caseSensitive = false, bool withEqual = false}) {
+      {bool caseSensitive = false,
+      @Deprecated('Use lessOrEqual() instead') bool withEqual = false}) {
     if (withEqual) {
       return lessOrEqual(p, caseSensitive: caseSensitive);
     } else {
@@ -589,8 +589,9 @@ class Query<T> {
   ///
   /// Call with offset=0 to reset to the default behavior,
   /// i.e. starting from the first element.
-  void offset(int offset) {
+  Query<T> offset(int offset) {
     checkObx(bindings.obx_query_offset(_cQuery, offset));
+    return this;
   }
 
   /// Configure a [limit] for this query.
@@ -601,8 +602,9 @@ class Query<T> {
   ///
   /// Call with limit=0 to reset to the default behavior -
   /// zero limit means no limit applied.
-  void limit(int limit) {
+  Query<T> limit(int limit) {
     checkObx(bindings.obx_query_limit(_cQuery, limit));
+    return this;
   }
 
   /// Returns the number of matching Objects.
@@ -643,10 +645,9 @@ class Query<T> {
   }
 
   /// Finds Objects matching the query and returns their IDs.
-  ///
-  /// [offset] and [limit] are deprecated, explicitly call
-  /// the equally named methods.
-  List<int> findIds({int offset = 0, int limit = 0}) {
+  List<int> findIds(
+      {@Deprecated('Use offset() instead') int offset = 0,
+      @Deprecated('Use limit() instead') int limit = 0}) {
     if (offset > 0) {
       this.offset(offset);
     }
@@ -666,10 +667,9 @@ class Query<T> {
   }
 
   /// Finds Objects matching the query.
-  ///
-  /// [offset] and [limit] are deprecated, explicitly call
-  /// the equally named methods.
-  List<T> find({int offset = 0, int limit = 0}) {
+  List<T> find(
+      {@Deprecated('Use offset() instead') int offset = 0,
+      @Deprecated('Use limit() instead') int limit = 0}) {
     if (offset > 0) {
       this.offset(offset);
     }

test/query_test.dart

@@ -227,20 +227,19 @@ void main() {
     q3.close();
   });
 
-  test('.find returns List<TestEntity>', () {
+  test('.find offset and limit', () {
     box.put(TestEntity());
-    box.put(TestEntity(tString: 'test'));
-    box.put(TestEntity(tString: 'test'));
+    box.put(TestEntity(tString: 'a'));
+    box.put(TestEntity(tString: 'b'));
+    box.put(TestEntity(tString: 'c'));
 
-    final text = TestEntity_.tString;
+    var q = box.query().build();
+    expect(q.find().length, 4);
 
-    var q = box.query(text.notNull()).build();
-    expect(q.find().length, 2);
-    q.close();
+    expect(q.offset(2).find().map((e) => e.tString), equals(['b', 'c']));
+    expect(q.limit(1).find().map((e) => e.tString), equals(['b']));
+    expect(q.offset(0).find().map((e) => e.tString), equals([null]));
 
-    q = box.query(text.isNull()).build();
-    q.limit(1);
-    expect(q.find().length, 1);
     q.close();
   });