Maps\Tests\Integration\MediaWiki\ParserHooks\ParserHookTest

Complexity

Total Complexity

13

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setUpBeforeClass()	0	5	2
	parametersProvider()	0	1	?
A	testRender()	0	24	3
	getInstance()	0	1	?
A	processingProvider()	0	3	1
A	testParamProcessing()	0	30	3
A	getDefaultValues()	0	13	3
A	arrayWrap()	0	8	1

<?php

namespace Maps\Tests\Integration\MediaWiki\ParserHooks;

use ParamProcessor\ParamDefinition;
use ParamProcessor\Processor;
use PHPUnit\Framework\TestCase;

/**
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
abstract class ParserHookTest extends TestCase {

	public static function setUpBeforeClass() {
		if ( !defined( 'MEDIAWIKI' ) ) {
			self::markTestSkipped( 'MediaWiki is not available' );
		}
	}

	/**
	 * @since 2.0
	 * @return array
	 */
	public abstract function parametersProvider();

	/**
	 * Triggers the render process with different sets of parameters to see if
	 * no errors or notices are thrown and the result indeed is a string.
	 *
	 * @dataProvider parametersProvider
	 * @since 2.0
	 *
	 * @param array $parameters
	 * @param string|null $expected
	 */
	public function testRender( array $parameters, $expected = null ) {
		$parserHook = $this->getInstance();

		$parser = new \Parser();
		$parser->mOptions = new \ParserOptions();
		$parser->clearState();
		$parser->setTitle( \Title::newMainPage() );

		$renderResult = call_user_func_array(
			[ $parserHook, 'renderFunction' ],
			array_merge( [ &$parser ], $parameters )
		);

		if ( is_string( $renderResult ) ) {
			$this->assertTrue( true );
		} else {
			$this->assertInternalType( 'array', $renderResult );
			$this->assertInternalType( 'string', $renderResult[0] );
		}

		if ( $expected !== null ) {
			$this->assertEquals( $expected, $renderResult[0] );
		}
	}

	/**
	 * @since 2.0
	 * @return \ParserHook
	 */
	protected abstract function getInstance();

	public function processingProvider() {
		return [];
	}

	/**
	 * @dataProvider processingProvider
	 * @since 3.0
	 */
	public function testParamProcessing( array $parameters, array $expectedValues ) {
		$definitions = $this->getInstance()->getParamDefinitions();

		$processor = Processor::newDefault();
		$processor->setParameters( $parameters, $definitions );

		$result = $processor->processParameters();

		if ( $result->hasFatal() ) {
			$this->fail(
				'Fatal error occurred during the param processing: ' . $processor->hasFatalError()->getMessage()
			);
		}

		$actual = $result->getParameters();

		$expectedValues = array_merge( $this->getDefaultValues(), $expectedValues );

		foreach ( $expectedValues as $name => $expected ) {
			$this->assertArrayHasKey( $name, $actual );

			$this->assertEquals(
				$expected,
				$actual[$name]->getValue(),
				'Expected ' . var_export( $expected, true )
				. ' should match actual '
				. var_export( $actual[$name]->getValue(), true )
			);
		}
	}

	/**
	 * Returns an array with the default values of the parameters.
	 */
	private function getDefaultValues() {
		$definitions = ParamDefinition::getCleanDefinitions( $this->getInstance()->getParamDefinitions() );

		$defaults = [];

		foreach ( $definitions as $definition ) {
			if ( !$definition->isRequired() ) {
				$defaults[$definition->getName()] = $definition->getDefault();
			}
		}

		return $defaults;
	}

	protected function arrayWrap( array $elements ) {
		return array_map(
			function ( $element ) {
				return [ $element ];
			},
			$elements
		);
	}

}