add orderObjectBy filter

Author: llwt

bower.json

@@ -3,7 +3,7 @@
   "main": [
     "dist/dtrw.filters.js"
     ],
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Provides common angular filters used in DevTRW projects",
   "authors": [
     "Steven Nance <steven@devtrw.com>"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-devtrw-filters",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "author": "Steven Nance <steven@devtrw.com>",
   "homepage": "https://github.com/devtrw/patient-forms",
   "repository": {

src/components/order-object-by/order-object-by-filter.js

@@ -0,0 +1,29 @@
+function orderObjectByFilter() {
+  return (items, field, reverse) => {
+    var filtered = [];
+    angular.forEach(items, function (item) {
+      filtered.push(item);
+    });
+    function index(obj, i) {
+      return obj[i];
+    }
+
+    filtered.sort(function (a, b) {
+      var comparator;
+      var reducedA = field.split('.').reduce(index, a);
+      var reducedB = field.split('.').reduce(index, b);
+      if (reducedA === reducedB) {
+        comparator = 0;
+      } else {
+        comparator = (reducedA > reducedB ? 1 : -1);
+      }
+      return comparator;
+    });
+    if (reverse) {
+      filtered.reverse();
+    }
+    return filtered;
+  };
+}
+
+export default orderObjectByFilter;

src/components/order-object-by/order-object-by-filter_test.js

@@ -0,0 +1,123 @@
+import ngModule from './order-object-by';
+
+describe(ngModule.name, function () { // jshint ignore:line
+
+  // load the filter's module
+  beforeEach(window.module(ngModule.name));
+
+  // initialize a new instance of the filter before each test
+  var orderObjectBy;
+  var obj = {
+    person_1: {
+      name:   'Amelia',
+      age:    30,
+      pet:    'cat',
+      grades: {
+        math:            90,
+        physics:         80,
+        computerScience: 50
+      }
+    },
+    person_2: {
+      name:   'Bernardette',
+      age:    20,
+      pet:    'cat',
+      grades: {
+        math:            80,
+        physics:         90,
+        computerScience: 100
+      }
+    },
+    person_3: {
+      name:   'Carol',
+      age:    40,
+      pet:    'hedgehog',
+      grades: {
+        math:            100,
+        physics:         50,
+        computerScience: 100
+      }
+    }
+  };
+  beforeEach(inject(function ($filter) {
+    orderObjectBy = $filter('orderObjectBy');
+  }));
+
+  it('should sort by the name field', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'name'),
+      [obj.person_1, obj.person_2, obj.person_3]
+    );
+  });
+
+  it('should sort by name field reverted', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'name', true),
+      [obj.person_3, obj.person_2, obj.person_1]
+    );
+  });
+
+  it('should sort by age field', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'age'),
+      [obj.person_2, obj.person_1, obj.person_3]
+    );
+  });
+
+  it('should sort by age field reverted', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'age', true),
+      [obj.person_3, obj.person_1, obj.person_2]
+    );
+  });
+
+  it('should sort by pet field', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'pet'),
+      [obj.person_1, obj.person_2, obj.person_3]
+    );
+  });
+
+  it('should sort by grades.math', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'grades.math'),
+      [obj.person_2, obj.person_1, obj.person_3]
+    );
+  });
+
+  it('should sort by grades.math reverted', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'grades.math', true),
+      [obj.person_3, obj.person_1, obj.person_2]
+    );
+  });
+
+  it('should sort by grades.physics', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'grades.physics'),
+      [obj.person_3, obj.person_1, obj.person_2]
+    );
+  });
+
+  it('should sort by grades.physics reverted', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'grades.physics', true),
+      [obj.person_2, obj.person_1, obj.person_3]
+    );
+  });
+
+  it('should sort by grades.computerScience', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'grades.computerScience'),
+      [obj.person_1, obj.person_2, obj.person_3]
+    );
+  });
+
+  it('should sort by grades.computerScience reverted', function () {
+    assert.deepEqual(
+      orderObjectBy(obj, 'grades.computerScience', true),
+      [obj.person_3, obj.person_2, obj.person_1]
+    );
+  });
+
+});

src/components/order-object-by/order-object-by.js

@@ -0,0 +1,7 @@
+import filter from './order-object-by-filter';
+
+const ngModule = angular.module('dtrw.filters.order-object-by', []);
+
+ngModule.filter('orderObjectBy', filter);
+
+export default ngModule;

src/filters.js

@@ -1,8 +1,10 @@
 import hyphenatedToCamelCase from './components/hyphenated-to-camel-case/hyphenated-to-camel-case';
+import orderObjectBy         from './components/order-object-by/order-object-by';
 import ucFirst               from './components/uc-first/uc-first';
 
 const ngModule = angular.module('dtrw.filters', [
   hyphenatedToCamelCase.name,
+  orderObjectBy.name,
   ucFirst.name
 ]);
 

src/filters_test.js

@@ -1,7 +1,8 @@
 import 'angular-mocks/angular-mocks';
 
-import './components/uc-first/uc-first-filter_test';
 import './components/hyphenated-to-camel-case/hyphenated-to-camel-case-filter_test';
+import './components/order-object-by/order-object-by-filter_test';
+import './components/uc-first/uc-first-filter_test';
 
 import filters from './filters';
 
@@ -21,4 +22,7 @@ describe(filters.name, () => {
   it('should have the hyphenatedToCamelCase filter defined', () => {
     assert.isFunction($filter('hyphenatedToCamelCase'));
   });
+  it('should have the orderObjectBy filter', () => {
+    assert.isFunction($filter('orderObjectBy'));
+  });
 });