1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<?php
/**
* Checks hook documentation is up to date.
*
* @file
* @author Niklas Laxström
* @copyright Copyright © 2012-2013, Niklas Laxström
* @license GPL-2.0+
*/
class HookDocTest extends MediaWikiTestCase {
protected $documented = array();
protected $used = array();
protected $paths = array(
'php' => array(
'',
'api',
'ffs',
'messagegroups',
'specials',
'tag',
'translationaids',
'ttmserver',
'utils',
'webservices',
),
'js' => array(
'resources/js',
),
);
protected function setUp() {
parent::setUp();
$contents = file_get_contents( __DIR__ . '/../../hooks.txt' );
$blocks = preg_split( '/\n\n/', $contents );
$type = false;
foreach ( $blocks as $block ) {
if ( $block === '=== PHP events ===' ) {
$type = 'php';
continue;
} elseif ( $block === '=== JavaScript events ===' ) {
$type = 'js';
continue;
} elseif ( !$type ) {
continue;
}
if ( $type ) {
list( $name, $params ) = self::parseDocBlock( $block );
$this->documented[$type][$name] = $params;
}
}
$prefix = __DIR__ . '/../..';
foreach ( $this->paths['php'] as $path ) {
$path = "$prefix/$path/";
$hooks = self::getHooksFromPath( $path, 'self::getPHPHooksFromFile' );
foreach ( $hooks as $name => $params ) {
$this->used['php'][$name] = $params;
}
}
foreach ( $this->paths['js'] as $path ) {
$path = "$prefix/$path/";
$hooks = self::getHooksFromPath( $path, 'self::getJSHooksFromFile' );
foreach ( $hooks as $name => $params ) {
$this->used['js'][$name] = $params;
}
}
}
protected static function getJSHooksFromFile( $file ) {
$content = file_get_contents( $file );
$m = array();
preg_match_all( '/(?:mw\.translateHooks\.run)\(\s*([\'"])(.*?)\1/', $content, $m );
$hooks = array();
foreach ( $m[2] as $hook ) {
$hooks[$hook] = array();
}
return $hooks;
}
protected static function getPHPHooksFromFile( $file ) {
$content = file_get_contents( $file );
$m = array();
preg_match_all( '/(?:wfRunHooks|Hooks\:\:run)\(\s*([\'"])(.*?)\1/', $content, $m );
$hooks = array();
foreach ( $m[2] as $hook ) {
$hooks[$hook] = array();
}
return $hooks;
}
protected static function getHooksFromPath( $path, $callback ) {
$hooks = array();
$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 = array();
foreach ( $matches as $match ) {
$params[$match[2]] = $match[1];
}
return array( $name, $params );
}
public function testHookIsDocumentedPHP() {
foreach ( $this->used['php'] as $hook => $params ) {
$this->assertArrayHasKey( $hook, $this->documented['php'], "PHP hook $hook is documented" );
}
}
public function testHookExistsPHP() {
foreach ( $this->documented['php'] as $hook => $params ) {
$this->assertArrayHasKey( $hook, $this->used['php'], "Documented php hook $hook exists" );
}
}
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" );
}
}
}
|
