Merge pull request #59 from marmelab/add-operators

Add several operators

Author: fzaninotto

README.md

@@ -262,6 +262,36 @@ If the REST flavor you want to simulate differs from the one chosen for FakeRest
 
 Note that all of the above apply only to collections. Single objects respond to `GET /bar`, `PUT /bar` and `PATCH /bar` in a manner identical to those operations for `/foo/:id`, including embedding. `POST /bar` and `DELETE /bar` are not enabled.
 
+## Supported Filters
+
+Operators are specified as suffixes on each filtered field. For instance, applying the `_lte` operator on the `price` field for the `books` resource is done by like this:
+
+    GET /books?filter={"price_lte":20} // return books where price is less than or equal to 20
+
+- `_eq`: check for equality on simple values:
+
+        GET /books?filter={"price_eq":20} // return books where price is equal to 20
+
+- `_neq`: check for inequality on simple values
+
+        GET /books?filter={"price_neq":20} // return books where price is not equal to 20
+
+- `_eq_any`: check for equality on any passed values
+
+        GET /books?filter={"price_eq_any":[20, 30]} // return books where price is equal to 20 or 30
+
+- `_neq_any`: check for inequality on any passed values
+
+        GET /books?filter={"price_neq_any":[20, 30]} // return books where price is not equal to 20 nor 30
+
+- `_inc_any`: check for items that includes any of the passed values
+
+        GET /books?filter={"authors_inc_any":['William Gibson', 'Pat Cadigan']} // return books where authors includes either 'William Gibson' or 'Pat Cadigan' or both
+
+- `_q`: check for items that contains the provided text
+
+        GET /books?filter={"author_q":['Gibson']} // return books where author includes 'Gibson' not considering the other fields
+
 ## Usage and Configuration
 
 ```js

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "fakerest",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "repository": "https://github.com/marmelab/FakeRest",
   "description": "Patch XMLHttpRequest to fake a REST server based on JSON data. ",
   "scripts": {

package.json

@@ -54,11 +54,46 @@ const getSimpleFilter = (key, value) => {
         let realKey = key.replace(/(_gt)$/, '');
         return item => get(item, realKey) > value;
     }
+    if (key.indexOf("_neq_any") !== -1) {
+      // not equal to any
+      let realKey = key.replace(/(_neq_any)$/, "");
+      let finalValue = Array.isArray(value) ? value : [value];
+      return (item) => finalValue.every((val) => get(item, realKey) != val);
+    }
     if (key.indexOf('_neq') !== -1) {
         // not equal
         let realKey = key.replace(/(_neq)$/, '');
         return item => get(item, realKey) != value;
     }
+    if (key.indexOf("_eq_any") !== -1) {
+      // equal any 
+      let realKey = key.replace(/(_eq_any)$/, "");
+      let finalValue = Array.isArray(value) ? value : [value];
+      return (item) => finalValue.some((val) => get(item, realKey) == val);
+    }
+    if (key.indexOf('_eq') !== -1) {
+        // equal
+        let realKey = key.replace(/(_eq)$/, '');
+        return item => get(item, realKey) == value;
+    }    
+    if (key.indexOf('_inc_any') !== -1) {
+        // include any
+        let realKey = key.replace(/(_inc_any)$/, "");
+        let finalValue = Array.isArray(value) ? value : [value];
+        return item => finalValue.some(val => get(item, realKey).includes(val));
+    }
+    if (key.indexOf('_inc') !== -1) {
+        // includes all
+        let realKey = key.replace(/(_inc)$/, "");
+        let finalValue = Array.isArray(value) ? value : [value];
+        return item => finalValue.every(val => get(item, realKey).includes(val));
+    }
+    if (key.indexOf('_ninc_any') !== -1) {
+        // does not include any
+        let realKey = key.replace(/(_ninc_any)$/, "");
+        let finalValue = Array.isArray(value) ? value : [value];
+        return item => finalValue.every(val => !get(item, realKey).includes(val));
+    }
     if (Array.isArray(value)) {
         return item => {
             if (Array.isArray(get(item, key))) {

src/Collection.js

@@ -375,6 +375,54 @@ describe("Collection", () => {
         ]);
       });
 
+      it("should filter by equality using _eq", () => {
+        const collection = new Collection([{ v: 1 }, { v: 2 }, { v: 3 }]);
+        expect(collection.getAll({ filter: { v_eq: 2 } })).toEqual([
+          { v: 2, id: 1 },
+        ]);
+      });
+
+      it("should filter using _eq_any", () => {
+        const collection = new Collection([{ v: 1 }, { v: 2 }, { v: 3 }]);
+        expect(collection.getAll({ filter: { v_eq_any: [1, 3] } })).toEqual([
+          { v: 1, id: 0 },
+          { v: 3, id: 2 },
+        ]);
+      });
+
+      it("should filter using _neq_any", () => {
+        const collection = new Collection([{ v: 1 }, { v: 2 }, { v: 3 }]);
+        expect(collection.getAll({ filter: { v_neq_any: [1, 3] } })).toEqual([
+          { v: 2, id: 1 },
+        ]);
+      });
+
+      it("should filter using _inc_any", () => {
+        const collection = new Collection([{ v: [1, 2] }, { v: [2, 4] }, { v: [3, 1] }]);
+        expect(collection.getAll({ filter: { v_inc_any: [1, 3] } })).toEqual([
+          { v: [1, 2], id: 0 },
+          { v: [3, 1], id: 2 },
+        ]);
+      });
+
+      it("should filter using _ninc_any", () => {
+        const collection = new Collection([{ v: [1, 2] }, { v: [2, 4] }, { v: [3, 1] }]);
+        expect(collection.getAll({ filter: { v_ninc_any: [1, 3] } })).toEqual([
+          { v: [2, 4], id: 1 },
+        ]);
+      });
+
+      it("should filter using _inc", () => {
+        const collection = new Collection([
+          { v: [1, 2] },
+          { v: [2, 4] },
+          { v: [3, 1] },
+        ]);
+        expect(collection.getAll({ filter: { v_inc: [1, 3] } })).toEqual([
+          { v: [3, 1], id: 2 },
+        ]);
+      });
+
       it("should filter by text search using _q", () => {
         const collection = new Collection([{ v: 'abCd' }, { v: 'cDef' }, { v: 'EFgh' }]);
         expect(collection.getAll({ filter: { v_q: 'cd' } })).toEqual([