Merge pull request #37 from nglrx/0.3.1

0.3.1

README.md

@@ -13,7 +13,7 @@ A collection of pipes for Angular apps.
 
 ## Installation
 
-Use [npm](https://www.npmjs.com/) to install  @nglrx/pipes.
+Use [npm](https://www.npmjs.com/) to install @nglrx/pipes.
 
 ```bash
 npm i @nglrx/pipes
@@ -157,7 +157,7 @@ Usage: `string | lowerCase`
 ### padEnd
 
 Pads the given string with a fill string so that the resulting string reaches the specified max length. The fill string is appended to the given string.\
-Default fill string is space ' '.
+Default fill string is space `' '`.
 
 Usage: `string | padEnd:maxLength[:fillString]`
 
@@ -170,7 +170,7 @@ Usage: `string | padEnd:maxLength[:fillString]`
 ### padStart
 
 Pads the given string with a fill string so that the resulting string reaches the specified max length. The fill string is prepended to the given string.\
-Default fill string is space ' '.
+Default fill string is space `' '`.
 
 Usage: `string | padStart:maxLength[:fillString]`
 
@@ -221,7 +221,7 @@ Usage: `string | slugify[:separator]`
 ### split
 
 Splits a given string into an array of sub-strings using an optional delimiter.\
-Default delimiter is space ' '.\
+Default delimiter is space `' '`.\
 Optionally, you may also specify a limit (integer) on the number of splits.
 
 Usage: `string | split[:delimiter][:limit]`
@@ -363,9 +363,11 @@ A collection of pipes exported by `NglrxGenericPipesModule`.
 
 ### length
 
-Returns the length of a given string or array.
+Returns the length of a given value of any supported type.\
+Supported data types are string, array, number, boolean, or any data type which has own property 'length'.\
+For an array the number of elements is returned. For others the number of characters in value is returned.
 
-Usage: `string-OR-array | length`
+Usage: `value | length`
 
 ```html
 {{ 'This is a test string!' | length }}
@@ -378,9 +380,11 @@ Usage: `string-OR-array | length`
 
 ### reverse
 
-Reverses a given string or array (of any type).
+Reverses a given value of any supported type.\
+Supported data types are string, array, number, boolean.\
+For an array the sequence of elements is reversed. For others the sequence of characters in value is reversed.
 
-Usage: `string-OR-array | reverse`
+Usage: `value | reverse`
 
 ```html
 {{ 'This is a test string!' | reverse }}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nglrx/pipes",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "author": "Kapil Neurgaonkar",
   "description": "A collection of pipes for Angular apps.",
   "license": "MIT",

packages/pipes/README.md

@@ -13,7 +13,7 @@ A collection of pipes for Angular apps.
 
 ## Installation
 
-Use [npm](https://www.npmjs.com/) to install  @nglrx/pipes.
+Use [npm](https://www.npmjs.com/) to install @nglrx/pipes.
 
 ```bash
 npm i @nglrx/pipes
@@ -157,7 +157,7 @@ Usage: `string | lowerCase`
 ### padEnd
 
 Pads the given string with a fill string so that the resulting string reaches the specified max length. The fill string is appended to the given string.\
-Default fill string is space ' '.
+Default fill string is space `' '`.
 
 Usage: `string | padEnd:maxLength[:fillString]`
 
@@ -170,7 +170,7 @@ Usage: `string | padEnd:maxLength[:fillString]`
 ### padStart
 
 Pads the given string with a fill string so that the resulting string reaches the specified max length. The fill string is prepended to the given string.\
-Default fill string is space ' '.
+Default fill string is space `' '`.
 
 Usage: `string | padStart:maxLength[:fillString]`
 
@@ -221,7 +221,7 @@ Usage: `string | slugify[:separator]`
 ### split
 
 Splits a given string into an array of sub-strings using an optional delimiter.\
-Default delimiter is space ' '.\
+Default delimiter is space `' '`.\
 Optionally, you may also specify a limit (integer) on the number of splits.
 
 Usage: `string | split[:delimiter][:limit]`
@@ -363,9 +363,11 @@ A collection of pipes exported by `NglrxGenericPipesModule`.
 
 ### length
 
-Returns the length of a given string or array.
+Returns the length of a given value of any supported type.\
+Supported data types are string, array, number, boolean, or any data type which has own property 'length'.\
+For an array the number of elements is returned. For others the number of characters in value is returned.
 
-Usage: `string-OR-array | length`
+Usage: `value | length`
 
 ```html
 {{ 'This is a test string!' | length }}
@@ -378,9 +380,11 @@ Usage: `string-OR-array | length`
 
 ### reverse
 
-Reverses a given string or array (of any type).
+Reverses a given value of any supported type.\
+Supported data types are string, array, number, boolean.\
+For an array the sequence of elements is reversed. For others the sequence of characters in value is reversed.
 
-Usage: `string-OR-array | reverse`
+Usage: `value | reverse`
 
 ```html
 {{ 'This is a test string!' | reverse }}

packages/pipes/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nglrx/pipes",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "author": "Kapil Neurgaonkar",
   "description": "A collection of pipes for Angular apps.",
   "license": "MIT",

packages/pipes/src/lib/generic/README.md

@@ -8,9 +8,11 @@ A collection of pipes exported by `NglrxGenericPipesModule`.
 
 ### length
 
-Returns the length of a given string or array.
+Returns the length of a given value of any supported type.\
+Supported data types are string, array, number, boolean, or any data type which has own property 'length'.\
+For an array the number of elements is returned. For others the number of characters in value is returned.
 
-Usage: `string-OR-array | length`
+Usage: `value | length`
 
 ```html
 {{ 'This is a test string!' | length }}
@@ -23,9 +25,11 @@ Usage: `string-OR-array | length`
 
 ### reverse
 
-Reverses a given string or array (of any type).
+Reverses a given value of any supported type.\
+Supported data types are string, array, number, boolean.\
+For an array the sequence of elements is reversed. For others the sequence of characters in value is reversed.
 
-Usage: `string-OR-array | reverse`
+Usage: `value | reverse`
 
 ```html
 {{ 'This is a test string!' | reverse }}

packages/pipes/src/lib/generic/length/length.pipe.spec.ts

@@ -51,12 +51,12 @@ describe('LengthPipe', () => {
   });
 
   it(`should return null for unsupported types Object, Date`, () => {
-    expect(pipe.transform(obj)).toEqual(null);
-    expect(pipe.transform(date)).toEqual(null);
+    expect(pipe.transform(obj)).toBeNull();
+    expect(pipe.transform(date)).toBeNull();
   });
 
   it(`should be null safe`, () => {
-    expect(pipe.transform(null)).toEqual(null);
+    expect(pipe.transform(null)).toBeNull();
   });
 
 });

packages/pipes/src/lib/generic/length/length.pipe.ts

@@ -1,4 +1,5 @@
 import { Pipe, PipeTransform } from '@angular/core';
+
 import { TypeUtils } from '../../utils/type-utils';
 
 @Pipe({
@@ -7,7 +8,8 @@ import { TypeUtils } from '../../utils/type-utils';
 export class LengthPipe implements PipeTransform {
 
   transform(value: any): number {
-    if (TypeUtils.isString(value) || TypeUtils.isArray(value) || (value && value.hasOwnProperty('length'))) {
+    if (TypeUtils.isString(value) || TypeUtils.isArray(value)
+      || (value && value.hasOwnProperty('length'))) {
       return value.length;
     } else if (TypeUtils.isNumber(value) || TypeUtils.isBoolean(value)) {
       return value.toString().length;

packages/pipes/src/lib/generic/reverse/reverse.pipe.spec.ts

@@ -49,12 +49,12 @@ describe('ReversePipe', () => {
   });
 
   it(`should return input for unsupported types Object, Date`, () => {
-    expect(pipe.transform(obj)).toEqual(obj);
-    expect(pipe.transform(date)).toEqual(date);
+    expect(pipe.transform(obj)).toBe(obj);
+    expect(pipe.transform(date)).toBe(date);
   });
 
   it(`should be null safe`, () => {
-    expect(pipe.transform(null)).toEqual(null);
+    expect(pipe.transform(null)).toBeNull();
   });
 
 });

packages/pipes/src/lib/generic/reverse/reverse.pipe.ts

@@ -1,4 +1,5 @@
 import { Pipe, PipeTransform } from '@angular/core';
+
 import { TypeUtils } from '../../utils/type-utils';
 
 @Pipe({

packages/pipes/src/lib/number/abs/abs.pipe.spec.ts

@@ -10,7 +10,8 @@ describe('AbsPipe', () => {
   const decimalNum = -459.1386;
   const absOfDecimalNum = 459.1386;
   const zero = 0;
-  const absOfZero = 0;
+  const infinity = Infinity;
+  const nan = NaN;
 
   beforeEach(() => {
     pipe = new AbsPipe();
@@ -33,11 +34,19 @@ describe('AbsPipe', () => {
   });
 
   it(`should return zero for absolute value of zero`, () => {
-    expect(pipe.transform(zero)).toEqual(absOfZero);
+    expect(pipe.transform(zero)).toEqual(zero);
+  });
+
+  it('should return NaN for absolute value of NaN', () => {
+    expect(pipe.transform(nan)).toEqual(nan);
+  });
+
+  it('should return Infinity for absolute value of Infinity', () => {
+    expect(pipe.transform(infinity)).toEqual(infinity);
   });
 
   it(`should be null safe`, () => {
-    expect(pipe.transform(null)).toEqual(0);
+    expect(pipe.transform(null)).toEqual(zero);
   });
 
 });

packages/pipes/src/lib/number/avg/avg.pipe.spec.ts

@@ -10,6 +10,9 @@ describe('AvgPipe', () => {
   const singleValueArr = [2];
   const avgOfSingleValueArr = 2
   const emptyArr = [];
+  const avgOfEmptyArr = 0;
+  const nanArray = [783, Infinity, NaN, 0, -391];
+  const avgOfNanArray = NaN;
 
   beforeEach(() => {
     pipe = new AvgPipe();
@@ -31,8 +34,12 @@ describe('AvgPipe', () => {
     expect(pipe.transform(singleValueArr)).toEqual(avgOfSingleValueArr);
   });
 
-  it(`should return null for an empty array`, () => {
-    expect(pipe.transform(emptyArr)).toBeNull();
+  it(`should return 0 for an empty array`, () => {
+    expect(pipe.transform(emptyArr)).toEqual(avgOfEmptyArr);
+  });
+
+  it('should return NaN if given array contains Infinity', () => {
+    expect(pipe.transform(nanArray)).toEqual(avgOfNanArray);
   });
 
   it(`should be null safe`, () => {

packages/pipes/src/lib/number/avg/avg.pipe.ts

@@ -1,14 +1,23 @@
 import { Pipe, PipeTransform } from '@angular/core';
+
 import { NumberUtils } from '../../utils/number-utils';
+import { TypeUtils } from '../../utils/type-utils';
 
 @Pipe({
   name: 'avg'
 })
 export class AvgPipe implements PipeTransform {
 
   transform(values: number[]): number {
+    if (TypeUtils.isNullOrUndefined(values)) {
+      return null;
+    } else if (TypeUtils.isEmpty(values)) {
+      return 0;
+    } else if (!TypeUtils.areFinite(values)) {
+      return NaN;
+    }
     const sum = NumberUtils.sum(values);
-    return sum ? sum / values.length : null;
+    return sum / values.length;
   }
 
 }

packages/pipes/src/lib/number/max/max.pipe.spec.ts

@@ -10,6 +10,8 @@ describe('MaxPipe', () => {
   const singleValueArr = [2];
   const maxOfSingleValueArr = 2
   const emptyArr = [];
+  const nanArray = [783, Infinity, NaN, 0, -391];
+  const maxOfNanArray = NaN;
 
   beforeEach(() => {
     pipe = new MaxPipe();
@@ -35,6 +37,10 @@ describe('MaxPipe', () => {
     expect(pipe.transform(emptyArr)).toBeNull();
   });
 
+  it('should return NaN if given array contains Infinity', () => {
+    expect(pipe.transform(nanArray)).toEqual(maxOfNanArray);
+  });
+
   it(`should be null safe`, () => {
     expect(pipe.transform(null)).toBeNull();
   });

packages/pipes/src/lib/number/max/max.pipe.ts

@@ -1,12 +1,14 @@
 import { Pipe, PipeTransform } from '@angular/core';
 
+import { TypeUtils } from '../../utils/type-utils';
+
 @Pipe({
   name: 'max'
 })
 export class MaxPipe implements PipeTransform {
 
   transform(values: number[]): number {
-    return values && values.length > 0 ? Math.max(...values) : null;
+    return TypeUtils.isEmpty(values) ? null : Math.max(...values);
   }
 
 }

packages/pipes/src/lib/number/min/min.pipe.spec.ts

@@ -10,6 +10,8 @@ describe('MinPipe', () => {
   const singleValueArr = [2];
   const minOfSingleValueArr = 2
   const emptyArr = [];
+  const nanArray = [783, Infinity, NaN, 0, -391];
+  const minOfNanArray = NaN;
 
   beforeEach(() => {
     pipe = new MinPipe();
@@ -35,6 +37,10 @@ describe('MinPipe', () => {
     expect(pipe.transform(emptyArr)).toBeNull();
   });
 
+  it('should return NaN if given array contains Infinity', () => {
+    expect(pipe.transform(nanArray)).toEqual(minOfNanArray);
+  });
+
   it(`should be null safe`, () => {
     expect(pipe.transform(null)).toBeNull();
   });

packages/pipes/src/lib/number/min/min.pipe.ts

@@ -1,12 +1,14 @@
 import { Pipe, PipeTransform } from '@angular/core';
 
+import { TypeUtils } from '../../utils/type-utils';
+
 @Pipe({
   name: 'min'
 })
 export class MinPipe implements PipeTransform {
 
   transform(values: number[]): number {
-    return values && values.length > 0 ? Math.min(...values) : null;
+    return TypeUtils.isEmpty(values) ? null : Math.min(...values);
   }
 
 }