[#218,refactor,query][m]: refactor query object sort attribute structure as described in #218 - fixes #218.

docs/models.markdown

@@ -193,7 +193,7 @@ Query object has the following key attributes:
 
  * size (=limit): number of results to return
  * from (=offset): offset into result set - http://www.elasticsearch.org/guide/reference/api/search/from-size.html
- * sort: sort order - <http://www.elasticsearch.org/guide/reference/api/search/sort.html>
+ * sort: sort order - see below
  * query: Query in ES Query DSL <http://www.elasticsearch.org/guide/reference/api/search/query.html>
  * filter: See filters and <a href="http://www.elasticsearch.org/guide/reference/query-dsl/filtered-query.html">Filtered Query</a>
  * fields: set of fields to return - http://www.elasticsearch.org/guide/reference/api/search/fields.html
@@ -212,6 +212,24 @@ Additions:
 * filters: array of ElasticSearch filters. These will be and-ed together for
   execution.
 
+#### Sort
+
+Sort structure is inspired by <http://www.elasticsearch.org/guide/reference/api/search/sort.html> but with some standardization.
+
+Sort structure must be as follows:
+
+    "sort" : [
+          { field: "post_date",  "order" : "desc"},
+          { field: "user" },
+          { "name" : "desc" },
+          { "age" : "desc" },
+          {"_score": null}
+      ]
+
+If order is omitted it is assumed to be "desc" except in the case of _score.
+_score is a special case which is used for match score if that is supported by
+the backend.
+
 #### Examples
 
 <pre>

src/backend.elasticsearch.js

@@ -119,6 +119,19 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
       return out;
     },
 
+    // convert from Recline sort structure to ES form
+    // http://www.elasticsearch.org/guide/reference/api/search/sort.html
+    this._normalizeSort = function(sort) {
+      var out = _.map(sort, function(sortObj) {
+        var _tmp = {};
+        var _tmp2 = _.clone(sortObj);
+        delete _tmp2['field'];
+        _tmp[sortObj.field] = _tmp2;
+        return _tmp;
+      });
+      return out;
+    },
+
     this._convertFilter = function(filter) {
       var out = {};
       out[filter.type] = {}
@@ -137,10 +150,12 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
     // @return deferred supporting promise API
     this.query = function(queryObj) {
       var esQuery = (queryObj && queryObj.toJSON) ? queryObj.toJSON() : _.extend({}, queryObj);
-      var queryNormalized = this._normalizeQuery(queryObj);
+      esQuery.query = this._normalizeQuery(queryObj);
       delete esQuery.q;
       delete esQuery.filters;
-      esQuery.query = queryNormalized;
+      if (esQuery.sort && esQuery.sort.length > 0) {
+        esQuery.sort = this._normalizeSort(esQuery.sort);
+      }
       var data = {source: JSON.stringify(esQuery)};
       var url = this.endpoint + '/_search';
       var jqxhr = makeRequest({

src/backend.memory.js

@@ -67,14 +67,15 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
       results = this._applyFilters(results, queryObj);
       results = this._applyFreeTextQuery(results, queryObj);
 
-      // not complete sorting!
+      // TODO: this is not complete sorting!
+      // What's wrong is we sort on the *last* entry in the sort list if there are multiple sort criteria
       _.each(queryObj.sort, function(sortObj) {
-        var fieldName = _.keys(sortObj)[0];
+        var fieldName = sortObj.field;
         results = _.sortBy(results, function(doc) {
           var _out = doc[fieldName];
           return _out;
         });
-        if (sortObj[fieldName].order == 'desc') {
+        if (sortObj.order == 'desc') {
           results.reverse();
         }
       });

src/view.slickgrid.js

@@ -119,15 +119,17 @@ my.SlickGrid = Backbone.View.extend({
     // Column sorting
     var sortInfo = this.model.queryState.get('sort');
     if (sortInfo){
-      var column = _.keys(sortInfo[0])[0];
-      var sortAsc = !(sortInfo[0][column].order == 'desc');
+      var column = sortInfo[0].field;
+      var sortAsc = !(sortInfo[0].order == 'desc');
       this.grid.setSortColumn(column, sortAsc);
     }
 
     this.grid.onSort.subscribe(function(e, args){
       var order = (args.sortAsc) ? 'asc':'desc';
-      var sort = [{}];
-      sort[0][args.sortCol.field] = {order: order};
+      var sort = [{
+        field: args.sortCol.field,
+        order: order
+      }];
       self.model.query({sort: sort});
     });
 

test/backend.memory.test.js

@@ -40,7 +40,7 @@ test('query sort', function () {
   var data = _wrapData();
   var queryObj = {
     sort: [
-      {'y': {order: 'desc'}}
+      {field: 'y', order: 'desc'}
     ]
   };
   data.query(queryObj).then(function(out) {
@@ -49,7 +49,7 @@ test('query sort', function () {
 
   var queryObj = {
     sort: [
-      {'country': {order: 'desc'}}
+      {field: 'country', order: 'desc'}
     ]
   };
   data.query(queryObj).then(function(out) {
@@ -58,7 +58,7 @@ test('query sort', function () {
 
   var queryObj = {
     sort: [
-      {'country': {order: 'asc'}}
+      {field: 'country', order: 'asc'}
     ]
   };
   data.query(queryObj).then(function(out) {
@@ -216,7 +216,7 @@ test('query sort', function () {
   var data = dataset._store.data;
   var queryObj = {
     sort: [
-      {'y': {order: 'desc'}}
+      {field: 'y', order: 'desc'}
     ]
   };
   dataset.query(queryObj).then(function() {