Page MenuHomeWickedGov Phorge
Files F2753180

HookDocTest.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

HookDocTest.php
View Options

<?php
/**
* Checks hook documentation is up to date.
*
* @file
* @author Niklas Laxström
* @copyright Copyright © 2012-2013, Niklas Laxström
* @license GPL-2.0-or-later
*/
/** @coversNothing */
class HookDocTest extends MediaWikiIntegrationTestCase {
private array $documented = [];
private array $used = [];
private array $paths = [
'js' => [
'resources/js',
],
];
protected function setUp(): void {
parent::setUp();
$contents = file_get_contents( __DIR__ . '/../../hooks.txt' );
$blocks = preg_split( '/\n\n/', $contents );
$type = false;
foreach ( $blocks as $block ) {
if ( $block === '=== JavaScript events ===' ) {
$type = 'js';
continue;
} elseif ( !$type ) {
continue;
}
if ( $type ) {
[ $name, $params ] = self::parseDocBlock( $block );
$this->documented[$type][$name] = $params;
}
}
$prefix = __DIR__ . '/../..';
foreach ( $this->paths['js'] as $path ) {
$path = "$prefix/$path/";
$hooks = self::getHooksFromPath( $path, [ self::class, 'getJSHooksFromFile' ] );
foreach ( $hooks as $name => $params ) {
$this->used['js'][$name] = $params;
}
}
}
protected static function getJSHooksFromFile( $file ) {
$content = file_get_contents( $file );
$m = [];
preg_match_all( '/\bmw\.hook\(\s*[\'"]([^\'"]+)[\'"]\s*\).fire\(/', $content, $m );
$hooks = [];
foreach ( $m[1] as $hook ) {
$hooks[$hook] = [];
}
return $hooks;
}
protected static function getHooksFromPath( $path, $callback ) {
$hooks = [];
$dh = opendir( $path );
if ( $dh ) {
$file = readdir( $dh );
while ( $file !== false ) {
if ( filetype( $path . $file ) === 'file' ) {
$hooks = array_merge( $hooks, call_user_func( $callback, $path . $file ) );
}
$file = readdir( $dh );
}
closedir( $dh );
}
return $hooks;
}
protected static function parseDocBlock( $block ) {
preg_match( '/^;([^ ]+):/', $block, $match );
$name = $match[1];
preg_match_all( '/^ ([^ ]+)\s+([ ^])/', $block, $matches, PREG_SET_ORDER );
$params = [];
foreach ( $matches as $match ) {
$params[$match[2]] = $match[1];
}
return [ $name, $params ];
}
public function testHookIsDocumentedJS() {
foreach ( $this->used['js'] as $hook => $params ) {
$this->assertArrayHasKey( $hook, $this->documented['js'], "Js hook $hook is documented" );
}
}
public function testHookExistsJS() {
foreach ( $this->documented['js'] as $hook => $params ) {
$this->assertArrayHasKey( $hook, $this->used['js'], "Documented js hook $hook exists" );
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 20:53 (1 d, 6 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
de/4b/888e0072fa4382ec8329734e6bc9
Default Alt Text
HookDocTest.php (2 KB)

Event Timeline