add support for comma delimited string

update README

Author: danivek

README.md

@@ -4,7 +4,7 @@
 
 JSON API query parser for MongoDB/Mongoose queries.
 
-WIP
+Convert query object from any querystring parser to MongoDB/Mongoose queries.
 
 ## Installation
 ```bash
@@ -13,9 +13,99 @@ npm install --save json-api-mongo-parser
 
 ## Usage
 
-Some examples are available in [ tests folders](https://github.com/danivek/json-api-mongo-parser/blob/master/test/)
+```javascript
+// Input query object for the article resource
+var query = {
+  fields: {
+    article: 'title,body', // Can be comma delimited string or Array of string
+    people: 'firstname,lastname',
+    comment: 'title,body'
+  },
+  sort: '-title,body,+created', // Can be comma delimited string or Array of string
+  page: {
+    offset: 2,
+    limit: 10
+  },
+  include: 'author,comments.tag,comments.author,comments.author.tag' // Can be comma delimited string or Array of string
+}
+```
+
+```javascript
+var JSONAPIMongoParser = require(json-api-mongo-parser);
 
-More examples are coming soon.
+var jsonApiMongoParser = new JSONAPIMongoParser({
+  article: {
+    relationships: { // Declaring relationships with its type
+      author: 'people',
+      comments: 'comment',
+    }
+  },
+  comment: {
+    relationships: {
+      author: 'people',
+      tag: 'tag'
+    }
+  },
+  people: {
+    relationships: {
+      tag: 'tag'
+    }
+  }
+});
+
+// Parse
+jsonApiMongoParser.parse('article', query);
+```
+Output mongo query for the article resource :
+
+```javascript
+{
+  select: {
+    title: 1,
+    body: 1,
+    author: 1,
+    comments: 1
+  },
+  sort: {
+    title: -1,
+    body: 1,
+    created: 1
+  },
+  page: {
+    skip: 2,
+    limit: 10
+  },
+  populate: [{
+    path: 'author',
+    select: {
+      firstname: 1,
+      lastname: 1,
+      tag: 1
+    }
+  }, {
+    path: 'comments',
+    populate: [{
+      path: 'tag'
+    }, {
+      path: 'author',
+      populate: [{
+        path: 'tag'
+      }],
+      select: {
+        firstname: 1,
+        lastname: 1,
+        tag: 1
+      }
+    }],
+    select: {
+      title: 1,
+      body: 1,
+      author: 1,
+      tag: 1
+    }
+  }]
+}
+```
 
 ## Requirements
 
@@ -24,4 +114,3 @@ json-api-mongo-parser only use ECMAScript 2015 (ES6) features supported natively
 ## License
 
 [MIT](https://github.com/danivek/json-api-mongo-parser/blob/master/LICENSE)
-

lib/JSONAPIMongoParser.js

@@ -12,7 +12,13 @@ module.exports = class JSONAPIMongoParser {
 
     if (selectQuery) {
       if (selectQuery[type]) {
-        selectQuery[type].forEach(field => select[field] = 1);
+        let fields = selectQuery[type];
+        // Support for input comma delimited string
+        if (_.isString(fields)) {
+          fields = fields.split(',');
+        }
+
+        fields.forEach(field => select[field] = 1);
       }
 
       // Always select relationships if defined
@@ -26,6 +32,11 @@ module.exports = class JSONAPIMongoParser {
   parseSort(sortQuery) {
     const sort = {};
 
+    // Support for input comma delimited string
+    if (_.isString(sortQuery)) {
+      sortQuery = sortQuery.split(',');
+    }
+
     sortQuery.forEach((sortField) => {
       let field = sortField;
       const operator = sortField.charAt(0);
@@ -64,6 +75,11 @@ module.exports = class JSONAPIMongoParser {
     const output = [];
     const flatOptions = this._flattenOptions();
 
+    // Support for input comma delimited string
+    if (_.isString(includeQuery)) {
+      includeQuery = includeQuery.split(',');
+    }
+
     // Ignore include if no resources type are registered
     if (this.options[type]) {
       // Convert array of delimited string to tree

test/unit/JSONAPIMongoParser.test.js

@@ -10,7 +10,7 @@ describe('JSONAPIMongoParser', function() {
   let parser = new JSONAPIMongoParser();
 
   describe('parseFields', function() {
-    it('should parse fields query for a resource', function(done) {
+    it('should parse input fields array', function(done) {
       const fieldsQuery = {
         article: ['title', 'body']
       };
@@ -22,6 +22,18 @@ describe('JSONAPIMongoParser', function() {
       done();
     });
 
+    it('should parse input fields string', function(done) {
+      const fieldsQuery = {
+        article: 'title,body'
+      };
+      const select = parser.parseFields('article', fieldsQuery);
+      expect(select).to.eql({
+        title: 1,
+        body: 1
+      });
+      done();
+    });
+
     it('should parse fields query and always select relationships if it was defined on the resource', function(done) {
       let parser = new JSONAPIMongoParser({
         article: {
@@ -46,7 +58,7 @@ describe('JSONAPIMongoParser', function() {
   });
 
   describe('parseSort', function() {
-    it('should parse sort query', function(done) {
+    it('should parse input sort array', function(done) {
       const sortQuery = ['-title', 'body', '+created'];
       const sort = parser.parseSort(sortQuery);
       expect(sort).to.eql({
@@ -56,6 +68,17 @@ describe('JSONAPIMongoParser', function() {
       });
       done();
     });
+
+    it('should parse input sort string', function(done) {
+      const sortQuery = '-title,body,+created';
+      const sort = parser.parseSort(sortQuery);
+      expect(sort).to.eql({
+        title: -1,
+        body: 1,
+        created: 1
+      });
+      done();
+    });
   });
 
   describe('parsePage', function() {
@@ -119,7 +142,7 @@ describe('JSONAPIMongoParser', function() {
       done();
     });
 
-    it('should parse all include query', function(done) {
+    it('should parse input include array', function(done) {
       const parserAllInclude = new JSONAPIMongoParser({
         article: {
           relationships: {
@@ -158,6 +181,45 @@ describe('JSONAPIMongoParser', function() {
       done();
     });
 
+    it('should parse input include string', function(done) {
+      const parserAllInclude = new JSONAPIMongoParser({
+        article: {
+          relationships: {
+            author: 'people',
+            comments: 'comment',
+          }
+        },
+        comment: {
+          relationships: {
+            author: 'people',
+            tag: 'tag'
+          }
+        },
+        people: {
+          relationships: {
+            tag: 'tag'
+          }
+        },
+        tag: {}
+      });
+      const includeQuery = 'author,comments.tag,comments.author,comments.author.tag';
+      const populate = parserAllInclude.parseInclude('article', includeQuery);
+      expect(populate).to.eql([{
+        path: "author"
+      }, {
+        path: "comments",
+        populate: [{
+          path: 'tag'
+        }, {
+          path: "author",
+          populate: [{
+            path: "tag"
+          }]
+        }]
+      }])
+      done();
+    });
+
     it('should parse all include query with fields query', function(done) {
       const parserAllInclude = new JSONAPIMongoParser({
         article: {
@@ -245,16 +307,16 @@ describe('JSONAPIMongoParser', function() {
 
       const query = {
         fields: {
-          article: ['title', 'body'],
-          people: ['firstname', 'lastname'],
-          comment: ['title', 'body']
+          article: 'title,body',
+          people: 'firstname,lastname',
+          comment: 'title,body'
         },
-        sort: ['-title', 'body', '+created'],
+        sort: '-title,body,+created',
         page: {
           offset: 2,
           limit: 10
         },
-        include: ['author', 'comments.tag', 'comments.author', 'comments.author.tag']
+        include: 'author,comments.tag,comments.author,comments.author.tag'
       }
       const parseQuery = jsonApiMongoParser.parse('article', query);
       expect(parseQuery).to.eql({