Merge pull request #182 from ghiscoding/feat/formatter-tests

feat(tests): add missing Formatter unit tests

Author: ghiscoding

src/app/modules/angular-slickgrid/formatters/collectionEditorFormatter.spec.ts

@@ -0,0 +1,75 @@
+import { Column } from '../models';
+import { collectionEditorFormatter } from './collectionEditorFormatter';
+import { Editors } from '../editors';
+
+describe('the CollectionEditor Formatter', () => {
+  let columnDef: Column;
+
+  beforeEach(() => {
+    columnDef = {
+      editor: {
+        model: Editors.singleSelect,
+        collection: [{ value: 1, label: 'foo' }, { value: 2, label: 'bar' }]
+      }
+    } as Column;
+    columnDef.internalColumnEditor = columnDef.editor;
+  });
+
+  it('should return same output when no value is passed', () => {
+    const valueArray = null;
+    const result = collectionEditorFormatter(0, 0, valueArray, {} as Column, {});
+    expect(result).toBe(null);
+  });
+
+  it('should return an empty array when value passed is an empty array', () => {
+    const valueArray = [];
+    const result = collectionEditorFormatter(0, 0, valueArray, {} as Column, {});
+    expect(result).toEqual([]);
+  });
+
+  it('should return original value when input is not an array', () => {
+    const inputValue = 'anything';
+    const result = collectionEditorFormatter(0, 0, inputValue, {} as Column, {});
+    expect(result).toBe(inputValue);
+  });
+
+  it('should return a CSV string when provided collection is an array of objects', () => {
+    const valueArray = [1, 2];
+    const result = collectionEditorFormatter(0, 0, valueArray, columnDef, {});
+    const outputCsv = 'foo, bar';
+    expect(result).toBe(`<span title="${outputCsv}">${outputCsv}</span>`);
+  });
+
+  it('should return a CSV string when provided collection is an array of strings', () => {
+    const valueArray = ['foo', 'bar'];
+    columnDef.editor.collection = ['foo', 'bar', 'apple'];
+
+    const result = collectionEditorFormatter(0, 0, valueArray, columnDef, {});
+
+    const outputCsv = 'foo, bar';
+    expect(result).toBe(`<span title="${outputCsv}">${outputCsv}</span>`);
+  });
+
+  it('should return a CSV string when provided collection is an array of objects', () => {
+    const valueArray = [1, 2];
+    columnDef.editor.collection = [{ id: 1, name: 'John' }, { id: 2, name: 'Bob' }];
+    columnDef.editor.customStructure = { label: 'name', value: 'id' };
+
+    const result = collectionEditorFormatter(0, 0, valueArray, columnDef, {});
+
+    const outputCsv = 'John, Bob';
+    expect(result).toBe(`<span title="${outputCsv}">${outputCsv}</span>`);
+  });
+
+  it('should return a string when provided input value is an object', () => {
+    const inputValue = 2;
+    const result = collectionEditorFormatter(0, 0, inputValue, columnDef, {});
+    expect(result).toBe('bar');
+  });
+
+  it('should return an empty string when provided input value is an object that is not part of the collection', () => {
+    const inputValue = 4;
+    const result = collectionEditorFormatter(0, 0, inputValue, columnDef, {});
+    expect(result).toBe('');
+  });
+});

src/app/modules/angular-slickgrid/formatters/collectionEditorFormatter.ts

@@ -8,7 +8,7 @@ import { findOrDefault } from '../services/utilities';
 export const collectionEditorFormatter: Formatter = (row: number, cell: number, value: any, columnDef: Column, dataContext: any) => {
   if (!value || !columnDef || !columnDef.internalColumnEditor || !columnDef.internalColumnEditor.collection
     || !columnDef.internalColumnEditor.collection.length) {
-    return '';
+    return value;
   }
 
   const { internalColumnEditor, internalColumnEditor: { collection } } = columnDef;

src/app/modules/angular-slickgrid/formatters/collectionFormatter.spec.ts

@@ -0,0 +1,57 @@
+import { Column } from '../models';
+import { collectionFormatter } from './collectionFormatter';
+
+describe('the Collection Formatter', () => {
+  it('should return same output when no value is passed', () => {
+    const valueArray = null;
+    const result = collectionFormatter(0, 0, valueArray, {} as Column, {});
+    expect(result).toBe(null);
+  });
+
+  it('should return an empty array when value passed is an empty array', () => {
+    const valueArray = [];
+    const result = collectionFormatter(0, 0, valueArray, {} as Column, {});
+    expect(result).toEqual([]);
+  });
+
+  it('should return original value when input is not an array', () => {
+    const inputValue = 'anything';
+    const result = collectionFormatter(0, 0, inputValue, {} as Column, {});
+    expect(result).toBe(inputValue);
+  });
+
+  it('should return a CSV string when value passed is an array of objects', () => {
+    const valueArray = [1, 2];
+    const columnDef = { params: { collection: [{ value: 1, label: 'foo' }, { value: 2, label: 'bar' }] } } as Column;
+    const result = collectionFormatter(0, 0, valueArray, columnDef, {});
+    const outputCsv = 'foo, bar';
+    expect(result).toBe(`<span title="${outputCsv}">${outputCsv}</span>`);
+  });
+
+  it('should return a CSV string when value passed is an array of objects', () => {
+    const valueArray = [1, 2];
+    const columnDef = {
+      params: {
+        collection: [{ id: 1, name: 'John' }, { id: 2, name: 'Bob' }],
+        customStructure: { label: 'name', value: 'id' }
+      }
+    } as Column;
+    const result = collectionFormatter(0, 0, valueArray, columnDef, {});
+    const outputCsv = 'John, Bob';
+    expect(result).toBe(`<span title="${outputCsv}">${outputCsv}</span>`);
+  });
+
+  it('should return a string when value passed is an object', () => {
+    const inputValue = 2;
+    const columnDef = { params: { collection: [{ value: 1, label: 'foo' }, { value: 2, label: 'bar' }] } } as Column;
+    const result = collectionFormatter(0, 0, inputValue, columnDef, {});
+    expect(result).toBe('bar');
+  });
+
+  it('should return an empty string when value passed is an object that is not part of the collection', () => {
+    const inputValue = 4;
+    const columnDef = { params: { collection: [{ value: 1, label: 'foo' }, { value: 2, label: 'bar' }] } } as Column;
+    const result = collectionFormatter(0, 0, inputValue, columnDef, {});
+    expect(result).toBe('');
+  });
+});

src/app/modules/angular-slickgrid/formatters/collectionFormatter.ts

@@ -8,7 +8,7 @@ import { findOrDefault } from '../services/utilities';
 export const collectionFormatter: Formatter = (row: number, cell: number, value: any, columnDef: Column, dataContext: any) => {
   if (!value || !columnDef || !columnDef.params || !columnDef.params.collection
     || !columnDef.params.collection.length) {
-    return '';
+    return value;
   }
 
   const { params, params: { collection } } = columnDef;

src/app/modules/angular-slickgrid/formatters/index.ts

@@ -73,16 +73,17 @@ export const Formatters = {
    * @example
    * // the grid will display 'foo' and 'bar' and not 1 and 2 from your dataset
    * { params: { collection: [{ value: 1, label: 'foo'}, {value: 2, label: 'bar' }] }}
-   * const dataset = [{ value: 1 },{ value: 2 }];
+   * const dataset = [1, 2];
    */
   collection: collectionFormatter,
 
   /**
-   * Looks up values from the columnDefinition.editor.collection property and displays the label in CSV or string format
+   * Roughly the same as the "collectionFormatter" except that it
+   * looks up values from the columnDefinition.editor.collection (instead of params) property and displays the label in CSV or string format
    * @example
    * // the grid will display 'foo' and 'bar' and not 1 and 2 from your dataset
-   * { params: { collection: [{ value: 1, label: 'foo'}, {value: 2, label: 'bar' }] }}
-   * const dataset = [{ value: 1 },{ value: 2 }];
+   * { editor: { collection: [{ value: 1, label: 'foo'}, {value: 2, label: 'bar' }] }}
+   * const dataset = [1, 2];
    */
   collectionEditor: collectionEditorFormatter,