/*______________
| ______ | U I Z E J A V A S C R I P T F R A M E W O R K
| / / | ---------------------------------------------------
| / O / | MODULE : Uize.Test.Uize.Array.Util Class
| / / / |
| / / / /| | ONLINE : http://uize.com
| /____/ /__/_| | COPYRIGHT : (c)2011-2016 UIZE
| /___ | LICENSE : Available under MIT License or GNU General Public License
|_______________| http://uize.com/license.html
*/
/* Module Meta Data
type: Test
importance: 1
codeCompleteness: 100
docCompleteness: 100
*/
/*?
Introduction
The =Uize.Test.Uize.Array.Util= module defines a suite of unit tests for the =Uize.Array.Util= module.
*DEVELOPERS:* `Chris van Rensburg`
*/
Uize.module ({
name:'Uize.Test.Uize.Array.Util',
builder:function () {
'use strict';
return Uize.Test.resolve ({
title:'Uize.Array.Util Module Test',
test:[
Uize.Test.requiredModulesTest ('Uize.Array.Util'),
Uize.Test.staticMethodsTest ([
['Uize.Array.Util.replaceContents',
[
{
title:'A reference to the array whose elements are being replaced is returned',
test:function () {
var
_arrayA = [],
_arrayB = [1,2,3],
_result = Uize.Array.Util.replaceContents (_arrayA,_arrayB)
;
return this.expectSameAs (_arrayA,_result);
}
},
{
title:'The array whose elements are being used as the replacement elements is not modified',
test:function () {
var
_arrayA = [],
_arrayB = [1,2,3],
_result = Uize.Array.Util.replaceContents (_arrayA,_arrayB)
;
return this.expect ([1,2,3],_arrayB);
}
},
{
title:'Test that this method produces the expected result and doesn\'t explode when the same array is specified for array A and array B',
test:function () {
var
_arrayA = [1,2,3],
_result = Uize.Array.Util.replaceContents (_arrayA,_arrayA)
;
return this.expect ([1,2,3],_result) && this.expect ([1,2,3],_arrayA);
}
},
['Replacing the contents of an empty array A with the contents of an empty array B leaves array A empty',
[[],[]],
[]
],
['Replacing the contents of an empty array A with the contents of a non-empty array B leaves array A with the elements of array B',
[[],[1,2,3]],
[1,2,3]
],
['Replacing the contents of a non-empty array A with the contents of a non-empty array B leaves array A with the elements of array B',
[[1,2,3],[4,5,6]],
[4,5,6]
],
['Not specifying a second array results in the first array being emptied out',
[[1,2,3]],
[]
],
['Specifying the value null for the second array results in the first array being emptied out',
[[1,2,3],null],
[]
],
['Specifying the value undefined for the second array results in the first array being emptied out',
[[1,2,3],undefined],
[]
]
],
null,
{cloneArguments:true}
],
['Uize.Array.Util.swapContents',
[
{
title:'A reference to array A is returned',
test:function () {
var
_arrayA = [1,2,3],
_arrayB = [4,5,6,7,8],
_result = Uize.Array.Util.swapContents (_arrayA,_arrayB)
;
return this.expectSameAs (_arrayA,_result);
}
},
{
title:'Test that this method produces the expected result and doesn\'t explode when the same array is specified for array A and array B',
test:function () {
var
_arrayA = [1,2,3],
_result = Uize.Array.Util.swapContents (_arrayA,_arrayA)
;
return this.expect ([1,2,3],_result) && this.expect ([1,2,3],_arrayA);
}
},
{
title:'Test that swapping the contents of an empty array A with a non-empty array B behaves as expected',
test:function () {
var
_arrayA = [],
_arrayB = [1,2,3]
;
Uize.Array.Util.swapContents (_arrayA,_arrayB);
return this.expect ([1,2,3],_arrayA) && this.expect ([],_arrayB);
}
},
{
title:'Test that swapping the contents of a non-empty array A with an empty array B behaves as expected',
test:function () {
var
_arrayA = [1,2,3],
_arrayB = []
;
Uize.Array.Util.swapContents (_arrayA,_arrayB);
return this.expect ([],_arrayA) && this.expect ([1,2,3],_arrayB);
}
},
{
title:'Test that swapping the contents of a non-empty array A with a non-empty array B behaves as expected',
test:function () {
var
_arrayA = [1,2,3],
_arrayB = [4,5,6,7,8]
;
Uize.Array.Util.swapContents (_arrayA,_arrayB);
return this.expect ([4,5,6,7,8],_arrayA) && this.expect ([1,2,3],_arrayB);
}
},
{
title:'Test that swapping the contents of an empty array A with an empty array B behaves as expected',
test:function () {
var
_arrayA = [],
_arrayB = []
;
Uize.Array.Util.swapContents (_arrayA,_arrayB);
return this.expect ([],_arrayA) && this.expect ([],_arrayB);
}
}
]
],
['Uize.Array.Util.flatten',
[
['Flattening an empty array results in an empty array',
[[]],
[]
],
['Test that flattening an array that is already flat is handled correctly',
[[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18]],
[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18]
],
/*** test support for the optional depth parameter ***/
['Flattening a non-flat array to a depth of 0 leaves the array unflattened',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0],0],
[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0]
],
['Test that flattening a non-flat array to a depth of 1 is handled correctly',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0],1],
[0,0,1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1,0,0]
],
['Test that flattening a non-flat array to a depth of 2 is handled correctly',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0],2],
[0,0,1,1,2,2,[3,3,[4,4,4,4],3,3],2,2,1,1,0,0]
],
['Test that flattening a non-flat array to a depth of Infinity is handled correctly',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0],Infinity],
[0,0,1,1,2,2,3,3,4,4,4,4,3,3,2,2,1,1,0,0]
],
/*** test defaulting of the depth paramter ***/
['When the optional depth parameter is not specified, its value is defaulted to Infinity',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0]],
[0,0,1,1,2,2,3,3,4,4,4,4,3,3,2,2,1,1,0,0]
],
['When the value undefined is specified for the optional depth parameter, its value is defaulted to Infinity',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0],undefined],
[0,0,1,1,2,2,3,3,4,4,4,4,3,3,2,2,1,1,0,0]
],
['When the value null is specified for the optional depth parameter, its value is defaulted to Infinity',
[[0,0,[1,1,[2,2,[3,3,[4,4,4,4],3,3],2,2],1,1],0,0],null],
[0,0,1,1,2,2,3,3,4,4,4,4,3,3,2,2,1,1,0,0]
],
/*** test support for the optional target paramter ***/
{
title:'The optional target parameter is defaulted to false if no value is specified for it',
test:function () {
var
_sourceArray = [1,[2,[3,[4],5],6],7],
_result = Uize.Array.Util.flatten (_sourceArray)
;
return this.expect ([1,2,3,4,5,6,7],_result) && this.expectSameAs (_sourceArray,_result);
}
},
{
title:'When the value false is specified for the optional target parameter, the result replaces the source array\'s original contents',
test:function () {
var
_sourceArray = [1,[2,[3,[4],5],6],7],
_result = Uize.Array.Util.flatten (_sourceArray,null,false)
;
return this.expect ([1,2,3,4,5,6,7],_result) && this.expectSameAs (_sourceArray,_result);
}
},
{
title:'When the value true is specified for the optional target parameter, the result is returned in a new array and the source array is not modified',
test:function () {
var
_sourceArray = [1,[2,[3,[4],5],6],7],
_result = Uize.Array.Util.flatten (_sourceArray,null,true)
;
return (
this.expect ([1,2,3,4,5,6,7],_result) &&
this.expect ([1,[2,[3,[4],5],6],7],_sourceArray) &&
this.expect (true,_result != _sourceArray)
);
}
},
{
title:'When a different array is specified for the target parameter, the result replaces the contents of that array and the source array is not modified',
test:function () {
var
_sourceArray = [1,[2,[3,[4],5],6],7],
_targetArray = ['a','whole','bunch','of','crap','that','goes','bye','bye'],
_result = Uize.Array.Util.flatten (_sourceArray,null,_targetArray)
;
return (
this.expectSameAs (_targetArray,_result) &&
this.expect ([1,2,3,4,5,6,7],_targetArray) &&
this.expect ([1,[2,[3,[4],5],6],7],_sourceArray)
);
}
},
{
title:'When the source array is specified as the target array, the result replaces the source array\'s original contents',
test:function () {
var
_sourceArray = [1,[2,[3,[4],5],6],7],
_result = Uize.Array.Util.flatten (_sourceArray,null,false)
;
return this.expect ([1,2,3,4,5,6,7],_result) && this.expectSameAs (_sourceArray,_result);
}
}
],
null,
{cloneArguments:true}
],
['Uize.Array.Util.sum',[
['The sum of an array with no elements is 0',
[[]],
0
],
['The sum of an array with multiple elements is computed correctly',
[[1,2,3,4,5,6,7,8,9,10]],
55
],
['The elements of the array being summed are coerced to numbers when calculating the sum',
[['1','2','3','4','5','6','7','8','9','10']],
55
]
]]
])
]
});
}
});