gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/MediaWiki/Hooks/SpecialStatsAddExtraTest.php

<?php

namespace SMW\Tests\MediaWiki\Hooks;

use SMW\MediaWiki\Hooks\SpecialStatsAddExtra;
use SMW\Services\ServicesFactory as ApplicationFactory;

/**
 * @covers \SMW\MediaWiki\Hooks\SpecialStatsAddExtra
 * @group smenatic-mediawiki
 *
 * @license GPL-2.0-or-later
 * @since 1.9
 *
 * @author mwjames
 */
class SpecialStatsAddExtraTest extends \PHPUnit\Framework\TestCase {

	protected function tearDown(): void {
		ApplicationFactory::clear();

		parent::tearDown();
	}

	public function testCanConstruct() {
		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$this->assertInstanceOf(
			SpecialStatsAddExtra::class,
			new SpecialStatsAddExtra( $store )
		);
	}

	/**
	 * @dataProvider statisticsDataProvider
	 */
	public function testProcess( $setup, $expected ) {
		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$store->expects( $this->atLeastOnce() )
			->method( 'getStatistics' )
			->willReturn( $setup['statistics'] );

		$extraStats = $setup['extraStats'];

		$instance = new SpecialStatsAddExtra( $store );

		$instance->setOptions(
			[
				'SMW_EXTENSION_LOADED' => true
			]
		);

		$this->assertTrue(
			$instance->process( $extraStats )
		);

		$this->assertTrue(
			$this->matchArray( $extraStats, $expected['statistics'] )
		);
	}

	public function testProcess_FakeStats() {
		$extraStats = [];

		$statistics = [
			'QUERY' => 2002,
			'QUERYFORMATS' => [ 'foo' => 9999 ]
		];

		$expected = [
			'smw-statistics' => [
				[ 'name' => "<span class='plainlinks'>&nbsp;&nbsp;-&nbsp;&nbsp;smw-statistics-query-inline</span>", 'number' => 2002 ],
				[ 'name' => '&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;smw-statistics-query-format.foo', 'number' => 9999 ],
				[ 'name' => 'smw-statistics-datatype-count', 'number' => 1 ]
			]
		];

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$store->expects( $this->atLeastOnce() )
			->method( 'getStatistics' )
			->willReturn( $statistics );

		$instance = new SpecialStatsAddExtra(
			$store
		);

		$instance->setDataTypeLabels( [ 'Bar' ] );

		$instance->setOptions(
			[
				'SMW_EXTENSION_LOADED' => true,
				'plain.msg_key' => true,
				'no.tooltip' => true
			]
		);

		$instance->process( $extraStats );

		$this->assertEquals(
			$expected,
			$extraStats
		);
	}

	public function matchArray( array $matcher, $searchValue ) {
		foreach ( $matcher as $key => $value ) {

			if ( $searchValue === $key || $searchValue === $value ) {
				return true;
			}

			if ( is_array( $value ) ) {
				return $this->matchArray( $value, $searchValue );
			}
		}

		return $searchValue !== null ? false : true;
	}

	public function statisticsDataProvider() {
		$input = [
			'PROPUSES' => 1001
		];

		# 0
		$provider[] = [
			[
				'extraStats' => [],
				'statistics' => $input
			],
			[
				'statistics' => 1001
			]
		];

		# 1 unknown
		$provider[] = [
			[
				'extraStats' => [],
				'statistics' => [ 'Yeey' => 2002 ]
			],
			[
				'statistics' => null
			]
		];

		# 2 MW 1.21+
		$provider[] = [
			[
				'extraStats' => [],
				'statistics' => $input
			],
			[
				'statistics' => 1001
			]
		];

		# 3 MW 1.21+ - unknown
		$provider[] = [
			[
				'extraStats' => [],
				'statistics' => [ 'Quuxy' => 2002 ]
			],
			[
				'statistics' => null
			]
		];

		return $provider;
	}

}