test.js

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var tape = require( 'tape' );
var noop = require( '@stdlib/utils/noop' );
var funseq = require( './../lib' );


// TESTS //

tape( 'main export is a function', function test( t ) {
	t.ok( true, __filename );
	t.equal( typeof funseq, 'function', 'main export is a function' );
	t.end();
});

tape( 'the function throws an error if not provided multiple functions to execute sequentially', function test( t ) {
	t.throws( foo, Error, 'throws an error' );
	t.throws( bar, Error, 'throws an error' );
	t.end();

	function foo() {
		funseq();
	}

	function bar() {
		funseq( noop );
	}
});

tape( 'the function throws an error if not provided a function', function test( t ) {
	var values;
	var i;

	values = [
		'5',
		5,
		NaN,
		null,
		undefined,
		true,
		[],
		{}
	];

	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue1( values[i] ), TypeError, 'throws an error when provided '+values[i] );
		t.throws( badValue2( values[i] ), TypeError, 'throws an error when provided '+values[i] );
		t.throws( badValue3( values[i] ), TypeError, 'throws an error when provided '+values[i] );
	}
	t.end();

	function badValue1( value ) {
		return function badValue() {
			funseq( value, noop );
		};
	}

	function badValue2( value ) {
		return function badValue() {
			funseq( noop, value );
		};
	}

	function badValue3( value ) {
		return function badValue() {
			funseq( noop, noop, value );
		};
	}
});

tape( 'the function returns a function', function test( t ) {
	var fcn = funseq( noop, noop );
	t.strictEqual( typeof fcn, 'function', 'returns a function' );
	t.end();
});

tape( 'the function returns a pipeline function', function test( t ) {
	var f;
	var v;

	function a( x ) {
		return x * 3;
	}

	function b( z ) {
		return z + 5;
	}

	function c( r ) {
		return r / 10;
	}

	f = funseq( a, b, c );
	v = f( 5 );

	t.strictEqual( v, 2, 'returns pipeline result' );
	t.end();
});

tape( 'the pipeline function supports providing a leftmost multi-parameter function', function test( t ) {
	var f;
	var v;

	function a( x, y ) {
		return x * y;
	}

	function b( z ) {
		return z + 5;
	}

	function c( r ) {
		return r / 10;
	}

	f = funseq( a, b, c );
	v = f( 5, 3 );

	t.strictEqual( v, 2, 'returns pipeline result' );
	t.end();
});