test/commands/MakeTestCommand.js

//--------------------------------------------------------
//-- Node IoC - Test - Command - Make Test
//--------------------------------------------------------

import GeneratorCommand from '../../console/GeneratorCommand';


/**
 * Command that makes a test class file inside the test folder.
 *
 * @memberof test.commands
 * @augments console.GeneratorCommand
 * @hideconstructor
 */
class MakeTestCommand extends GeneratorCommand {

	/**
	 * Class dependencies: <code>['helper.path', 'helper.string', 'test.type']</code>.
	 *
	 * @type {Array<string>}
	 */
	static get dependencies() {
		return (super.dependencies || []).concat(['helper.path', 'helper.string', 'test.type']);
	}

	/**
	 * @inheritdoc
	 */
	get name() {
		return 'make:test';
	}

	/**
	 * @inheritdoc
	 */
	get files() {
		const types = this.testTypes.map((name) => {
			const typeClassName = `${name[0].toUpperCase()}${name.slice(1)}Test`;

			return { [name]: this.app.formatPath(__dirname, 'stubs', `${typeClassName}.stub`) };
		});

		return Object.assign({}, ...types);
	}

	/**
	 * @inheritdoc
	 */
	get destination() {
		return this.app.testPath(this.testTypeName, this.getNamespace());
	}

	/**
	 * @inheritdoc
	 */
	get options() {
		return super.options.concat([
			['type', '', this.t('commands.make-test.options.type')],
			['for',  '', this.t('commands.make-test.options.for')]
		]);
	}

	/**
	 * @inheritdoc
	 */
	get flags() {
		return this.testTypes.map((type) => {
			return [type, this.t(`commands.make-test.flags.${type}`)];
		});
	}

	/**
	 * @inheritdoc
	 */
	get patterns() {
		return {
			TEST_CASE_PATH: this.app.formatPath(this.pathHelper.relative(this.pathHelper.dirname(this.getDestination()), this.app.testPath('TestCase')))
		};
	}

	/**
	 * @inheritdoc
	 */
	async handle() {
		const testType = this.testTypeName;
		const type     = this.stringHelper.lower(testType);
		const name     = this.parameter('class');

		this.debug(this.t('commands.make-test.messages.generating', { type, name }));
		await this.generate(testType);
		this.info(this.t('commands.make-test.messages.success', { type, name }));
	}

	/**
	 * Get the test namespace, which could be a class in the application.
	 *
	 * @returns {string} The namespace.
	 */
	getNamespace() {
		return this.option('for') || '';
	}

	/**
	 * Get the test type.
	 *
	 * @type {string}
	 */
	get testTypeName() {
		for (const value of this.testTypes) {
			if (this.flag(value)) {
				return value;
			}
		}

		const type = this.option('type');

		return this.testTypes.includes(type) ? type : this.defaultType;
	}

	/**
	 * Get available test types.
	 *
	 * @type {Array<string>}
	 */
	get testTypes() {
		return this.testType.values();
	}

	/**
	 * Default type accessor.
	 *
	 * @type {string}
	 */
	get defaultType() {
		return this.testType.UNIT;
	}

	/**
	 * String helper.
	 *
	 * @type {support.helpers.StringHelper}
	 */
	get stringHelper() {
		return this.helperString;
	}

	/**
	 * Path helper.
	 *
	 * @type {support.helpers.PathHelper}
	 */
	get pathHelper() {
		return this.helperPath;
	}

}


export default MakeTestCommand;