Merge pull request #201 from FormidableLabs/feature/data-sorting-prop

Feature/data sorting prop

src/victory-util/data.js

@@ -1,4 +1,4 @@
-import { assign, uniq, range, last, isFunction, property } from "lodash";
+import { assign, uniq, range, last, isFunction, property, sortBy } from "lodash";
 import Helpers from "./helpers";
 import Collection from "./collection";
 import Log from "./log";
@@ -90,7 +90,25 @@ export default {
           typeof y === "string" ? { _y: stringMap.y[y], yName: y } : {}
         );
     });
-    return this.cleanData(data, props);
+
+    const sortedData = this.sortData(data, props.sortKey);
+
+    return this.cleanData(sortedData, props);
+  },
+
+  /**
+   * Returns sorted data. If no sort keys are provided, data is returned unaltered.
+   * Sort key should correspond to the `iteratees` argument in lodash `sortBy` function.
+   * @param {Array} dataset: the original domain
+   * @param {Function} sortKey: the sort key
+   * @returns {Array} the sorted data
+   */
+  sortData(dataset, sortKey) {
+    if (!sortKey) {
+      return dataset;
+    }
+
+    return sortBy(dataset, sortKey);
   },
 
   /**

test/client/spec/victory-util/data.spec.js

@@ -168,6 +168,33 @@ describe("helpers/data", () => {
       expect(returnData).to.eql(expectedReturnWithEventKeys);
     });
 
+    it("does not sort data when function not passed", () => {
+      const data = [{x: 2, y: 2}, {x: 1, y: 3}, {x: 3, y: 1}];
+      const props = {data};
+
+      const returnData = Data.getData(props);
+
+      expect(returnData).to.eql([
+        {_x: 2, x: 2, _y: 2, y: 2, eventKey: 0},
+        {_x: 1, x: 1, _y: 3, y: 3, eventKey: 1},
+        {_x: 3, x: 3, _y: 1, y: 1, eventKey: 2}
+      ]);
+    });
+
+    it("sorts data according to passed function", () => {
+      const data = [{x: 2, y: 2}, {x: 1, y: 3}, {x: 3, y: 1}];
+      const sortKey = ["_x"];
+      const props = {data, sortKey};
+
+      const returnData = Data.getData(props);
+
+      expect(returnData).to.eql([
+        {_x: 1, x: 1, _y: 3, y: 3, eventKey: 0},
+        {_x: 2, x: 2, _y: 2, y: 2, eventKey: 1},
+        {_x: 3, x: 3, _y: 1, y: 1, eventKey: 2}
+      ]);
+    });
+
     it("generates a dataset from domain", () => {
       const generatedReturn = [{x: 0, y: 0}, {x: 10, y: 10}];
       const expectedReturn = [{_x: 0, x: 0, _y: 0, y: 0}, {_x: 10, x: 10, _y: 10, y: 10}];