TagHookTest::getHookHandler() - Code Metrics - JeroenDeDauw/ParserHooks - Measure and Improve Code Quality continuously with Scrutinizer

TagHookTest::getHookHandler() A
last analyzed 2020-12-27 19:41 UTC

↳ Parent: TagHookTest

Complexity

Conditions	2
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	1
nop	0
dl	0
loc	32
rs	9.408
c	0
b	0
f	0

<?php

namespace ParserHooks\Tests;

use ParamProcessor\ProcessedParam;
use ParamProcessor\ProcessingResult;
use Parser;
use ParserHooks\FunctionRunner;
use ParserHooks\HookDefinition;
use ParserHooks\HookRegistrant;
use ParserHooks\HookRunner;
use ParserOptions;
use PHPUnit\Framework\TestCase;
use Title;
use User;

/**
 * @group ParserHooks
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class TagHookTest extends TestCase {

	const HOOK_NAME = 'systemtest_tagextension';

	/**
	 * @var Parser
	 */
	protected $parser;

	public function setUp(): void {
		$this->parser = $this->getSomeParser();
	}

	protected function getSomeParser() {
		if ( class_exists( \MediaWiki\MediaWikiServices::class ) ) {
			$services = \MediaWiki\MediaWikiServices::getInstance();
			if ( is_callable( $services, 'getParserFactory' ) ) {
				return $services->getParserFactory()->create();

			}
		}
		// Fallback for MW < 1.32
		global $wgParserConf;
		return new Parser( $wgParserConf );
	}

	public function testParserFunctionReceivesArguments() {
		$this->registerParserHook();

		$name = self::HOOK_NAME;

		$result = $this->getParsedText(
			"||<$name 1337=yes>Jeroen</$name>|||"
		);

		$this->assertInternalType( 'string', $result );
		$this->assertContains(
			"||-Jeroen-|||",
			$result
		);
	}

	protected function getParsedText( $text ) {
		return $this->parser->parse(
			$text,
			Title::newFromText( "Test" ),
			ParserOptions::newFromUserAndLang( new User(), $GLOBALS['wgContLang'] ),
			false
		)->getText();
	}

	protected function registerParserHook() {
		$runner = $this->getHookRunner();

		$registrant = new HookRegistrant( $this->parser );
		$registrant->registerHook( $runner );
	}

	protected function getHookRunner() {
		return new HookRunner(
			$this->getHookDefinition(),
			$this->getHookHandler()
		);
	}

	protected function getHookDefinition() {
		return new HookDefinition(
			self::HOOK_NAME,
			[
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				[
					'name' => 'name',
					'message' => 'abc',
				],
				[
					'name' => 'awesomeness',
					'message' => 'abc',
					'type' => 'integer',
					'default' => 9001,
				],
				[
					'name' => '1337',
					'message' => 'abc',
					'type' => 'boolean',
					'default' => false,
				],
			],
			[
				'name'
			]
		);
	}

	protected function getHookHandler() {
		$hookHandler = $this->createMock( 'ParserHooks\HookHandler' );

		$hookHandler->expects( $this->once() )
			->method( 'handle' )
			->with(
				$this->isInstanceOf( 'Parser' ),
				$this->callback( function( $var ) {
					if ( !( $var instanceof ProcessingResult ) ) {
						return false;
					}

					$params = $var->getParameters();
					$expectedParams = [
						'1337' => new ProcessedParam( '1337', true, false, '1337', 'yes' ),
						'awesomeness' => new ProcessedParam( 'awesomeness', 9001, true, null, null ),
						'name' => new ProcessedParam( 'name', 'Jeroen', false, 'name', 'Jeroen' ),
					];

					asort( $params );
					asort( $expectedParams );

					return $params == $expectedParams;
				} )
			)
			->will( $this->returnCallback( function( Parser $parser, ProcessingResult $result ) {
				$params = $result->getParameters();
				return '-' . $params['name']->getValue() . '-';
			} ) );

		return $hookHandler;
	}



}


1			<?php
2
3			namespace ParserHooks\Tests;
4
5			use ParamProcessor\ProcessedParam;
6			use ParamProcessor\ProcessingResult;
7			use Parser;
8			use ParserHooks\FunctionRunner;
9			use ParserHooks\HookDefinition;
10			use ParserHooks\HookRegistrant;
11			use ParserHooks\HookRunner;
12			use ParserOptions;
13			use PHPUnit\Framework\TestCase;
14			use Title;
15			use User;
16
17			/**
18			* @group ParserHooks
19			* @licence GNU GPL v2+
20			* @author Jeroen De Dauw < [email protected] >
21			*/
22			class TagHookTest extends TestCase {
23
24			const HOOK_NAME = 'systemtest_tagextension';
25
26			/**
27			* @var Parser
28			*/
29			protected $parser;
30
31			public function setUp(): void {
32			$this->parser = $this->getSomeParser();
33			}
34
35			protected function getSomeParser() {
36			if ( class_exists( \MediaWiki\MediaWikiServices::class ) ) {
37			$services = \MediaWiki\MediaWikiServices::getInstance();
38			if ( is_callable( $services, 'getParserFactory' ) ) {
39			return $services->getParserFactory()->create();
			0 ignored issues – show Bug introduced 2020-04-16 20:30 UTC by Report Bug Copy Issue Report The method `getParserFactory` cannot be called on `$services` (of type `callable`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
40			}
41			}
42			// Fallback for MW < 1.32
43			global $wgParserConf;
44			return new Parser( $wgParserConf );
45			}
46
47			public function testParserFunctionReceivesArguments() {
48			$this->registerParserHook();
49
50			$name = self::HOOK_NAME;
51
52			$result = $this->getParsedText(
53			"\|\|<$name 1337=yes>Jeroen</$name>\|\|\|"
54			);
55
56			$this->assertInternalType( 'string', $result );
57			$this->assertContains(
58			"\|\|-Jeroen-\|\|\|",
59			$result
60			);
61			}
62
63			protected function getParsedText( $text ) {
64			return $this->parser->parse(
65			$text,
66			Title::newFromText( "Test" ),
67			ParserOptions::newFromUserAndLang( new User(), $GLOBALS['wgContLang'] ),
68			false
69			)->getText();
70			}
71
72			protected function registerParserHook() {
73			$runner = $this->getHookRunner();
74
75			$registrant = new HookRegistrant( $this->parser );
76			$registrant->registerHook( $runner );
77			}
78
79			protected function getHookRunner() {
80			return new HookRunner(
81			$this->getHookDefinition(),
82			$this->getHookHandler()
83			);
84			}
85
86			protected function getHookDefinition() {
87			return new HookDefinition(
88			self::HOOK_NAME,
89			[
			0 ignored issues – show Documentation introduced 2017-06-13 12:17 UTC by Report Bug Copy Issue Report `array(array('name' => 'n...', 'default' => false))` is of type `array<integer,array,{"0"...efault\":\"false\"}>"}>`, but the function expects a `array<integer,object<Par...essor\ParamDefinition>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90			[
91			'name' => 'name',
92			'message' => 'abc',
93			],
94			[
95			'name' => 'awesomeness',
96			'message' => 'abc',
97			'type' => 'integer',
98			'default' => 9001,
99			],
100			[
101			'name' => '1337',
102			'message' => 'abc',
103			'type' => 'boolean',
104			'default' => false,
105			],
106			],
107			[
108			'name'
109			]
110			);
111			}
112
113			protected function getHookHandler() {
114			$hookHandler = $this->createMock( 'ParserHooks\HookHandler' );
115
116			$hookHandler->expects( $this->once() )
117			->method( 'handle' )
118			->with(
119			$this->isInstanceOf( 'Parser' ),
120			$this->callback( function( $var ) {
121			if ( !( $var instanceof ProcessingResult ) ) {
122			return false;
123			}
124
125			$params = $var->getParameters();
126			$expectedParams = [
127			'1337' => new ProcessedParam( '1337', true, false, '1337', 'yes' ),
128			'awesomeness' => new ProcessedParam( 'awesomeness', 9001, true, null, null ),
129			'name' => new ProcessedParam( 'name', 'Jeroen', false, 'name', 'Jeroen' ),
130			];
131
132			asort( $params );
133			asort( $expectedParams );
134
135			return $params == $expectedParams;
136			} )
137			)
138			->will( $this->returnCallback( function( Parser $parser, ProcessingResult $result ) {
139			$params = $result->getParameters();
140			return '-' . $params['name']->getValue() . '-';
141			} ) );
142
143			return $hookHandler;
144			}
145
146
147
148			}
149

JeroenDeDauw / ParserHooks

TagHookTest::getHookHandler() A last analyzed 2020-12-27 19:41 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TagHookTest::getHookHandler() A
last analyzed 2020-12-27 19:41 UTC