1<?php 2 3namespace dokuwiki\test\Parsing; 4 5use dokuwiki\Parsing\ModeRegistry; 6use dokuwiki\Parsing\ParserMode\ModeInterface; 7 8class ModeRegistryTest extends \DokuWikiTest 9{ 10 /** @var ModeRegistry */ 11 private $registry; 12 13 function setUp(): void 14 { 15 parent::setUp(); 16 ModeRegistry::reset(); 17 $this->registry = ModeRegistry::getInstance(); 18 } 19 20 function tearDown(): void 21 { 22 ModeRegistry::reset(); 23 parent::tearDown(); 24 } 25 26 function testSingleton() 27 { 28 $this->assertSame( 29 ModeRegistry::getInstance(), 30 ModeRegistry::getInstance() 31 ); 32 } 33 34 function testResetCreatesFreshInstance() 35 { 36 $first = ModeRegistry::getInstance(); 37 ModeRegistry::reset(); 38 $second = ModeRegistry::getInstance(); 39 $this->assertNotSame($first, $second); 40 } 41 42 function testConstructorPopulatesGlobal() 43 { 44 global $PARSER_MODES; 45 $this->assertIsArray($PARSER_MODES); 46 $this->assertArrayHasKey('container', $PARSER_MODES); 47 $this->assertArrayHasKey('formatting', $PARSER_MODES); 48 $this->assertArrayHasKey('substition', $PARSER_MODES); 49 $this->assertArrayHasKey('protected', $PARSER_MODES); 50 $this->assertArrayHasKey('disabled', $PARSER_MODES); 51 $this->assertArrayHasKey('paragraphs', $PARSER_MODES); 52 $this->assertArrayHasKey('baseonly', $PARSER_MODES); 53 } 54 55 function testGetCategories() 56 { 57 global $PARSER_MODES; 58 $this->assertSame($PARSER_MODES, $this->registry->getCategories()); 59 } 60 61 function testGetModesForSingleCategory() 62 { 63 $modes = $this->registry->getModesForCategories([ModeRegistry::CATEGORY_CONTAINER]); 64 $this->assertContains('listblock', $modes); 65 $this->assertContains('table', $modes); 66 $this->assertContains('quote', $modes); 67 $this->assertContains('hr', $modes); 68 } 69 70 function testGetModesForMultipleCategories() 71 { 72 $modes = $this->registry->getModesForCategories([ 73 ModeRegistry::CATEGORY_CONTAINER, 74 ModeRegistry::CATEGORY_BASEONLY, 75 ]); 76 $this->assertContains('listblock', $modes); 77 $this->assertContains('header', $modes); 78 } 79 80 function testGetModesForCategoriesDeduplicates() 81 { 82 $modes = $this->registry->getModesForCategories([ 83 ModeRegistry::CATEGORY_CONTAINER, 84 ModeRegistry::CATEGORY_CONTAINER, 85 ]); 86 $counts = array_count_values($modes); 87 foreach ($counts as $count) { 88 $this->assertEquals(1, $count); 89 } 90 } 91 92 function testGetModesForUnknownCategoryReturnsEmpty() 93 { 94 $modes = $this->registry->getModesForCategories(['nonexistent']); 95 $this->assertSame([], $modes); 96 } 97 98 function testRegisterMode() 99 { 100 global $PARSER_MODES; 101 $this->registry->registerMode(ModeRegistry::CATEGORY_CONTAINER, 'testmode'); 102 $this->assertContains('testmode', $PARSER_MODES[ModeRegistry::CATEGORY_CONTAINER]); 103 $this->assertContains( 104 'testmode', 105 $this->registry->getModesForCategories([ModeRegistry::CATEGORY_CONTAINER]) 106 ); 107 } 108 109 function testGlobalModificationsAreVisible() 110 { 111 global $PARSER_MODES; 112 $PARSER_MODES[ModeRegistry::CATEGORY_FORMATTING][] = 'custom_format'; 113 $modes = $this->registry->getModesForCategories([ModeRegistry::CATEGORY_FORMATTING]); 114 $this->assertContains('custom_format', $modes); 115 } 116 117 function testGetModesReturnsSortedArray() 118 { 119 $modes = $this->registry->getModes(); 120 $this->assertNotEmpty($modes); 121 122 $sortValues = array_column($modes, 'sort'); 123 $sorted = $sortValues; 124 sort($sorted); 125 $this->assertSame($sorted, $sortValues); 126 } 127 128 function testGetModesContainsExpectedKeys() 129 { 130 $modes = $this->registry->getModes(); 131 foreach ($modes as $entry) { 132 $this->assertArrayHasKey('sort', $entry); 133 $this->assertArrayHasKey('mode', $entry); 134 $this->assertArrayHasKey('obj', $entry); 135 $this->assertIsInt($entry['sort']); 136 $this->assertIsString($entry['mode']); 137 $this->assertInstanceOf(ModeInterface::class, $entry['obj']); 138 } 139 } 140 141 function testGetModesContainsBuiltinModes() 142 { 143 $modes = $this->registry->getModes(); 144 $modeNames = array_column($modes, 'mode'); 145 $this->assertContains('strong', $modeNames); 146 $this->assertContains('header', $modeNames); 147 $this->assertContains('listblock', $modeNames); 148 $this->assertContains('eol', $modeNames); 149 $this->assertContains('smiley', $modeNames); 150 $this->assertContains('acronym', $modeNames); 151 $this->assertContains('entity', $modeNames); 152 } 153 154 function testSortModes() 155 { 156 $a = ['sort' => 10, 'mode' => 'a']; 157 $b = ['sort' => 20, 'mode' => 'b']; 158 $this->assertLessThan(0, ModeRegistry::sortModes($a, $b)); 159 $this->assertGreaterThan(0, ModeRegistry::sortModes($b, $a)); 160 $this->assertEquals(0, ModeRegistry::sortModes($a, $a)); 161 } 162 163 function testBlockEolModesEmptyByDefault() 164 { 165 $this->assertSame([], $this->registry->getBlockEolModes()); 166 } 167 168 function testRegisterBlockEolMode() 169 { 170 $this->registry->registerBlockEolMode('listblock'); 171 $this->registry->registerBlockEolMode('table'); 172 $this->assertSame(['listblock', 'table'], $this->registry->getBlockEolModes()); 173 } 174 175 function testBlockEolModesResetWithInstance() 176 { 177 $this->registry->registerBlockEolMode('listblock'); 178 ModeRegistry::reset(); 179 $fresh = ModeRegistry::getInstance(); 180 $this->assertSame([], $fresh->getBlockEolModes()); 181 } 182 183 /** 184 * The default syntax setting must produce the exact same mode set as before 185 * the syntax setting was introduced (no-op guarantee). 186 */ 187 function testGetModesDefaultSyntaxMatchesLegacy() 188 { 189 global $conf; 190 $conf['syntax'] = 'dokuwiki'; 191 ModeRegistry::reset(); 192 $registry = ModeRegistry::getInstance(); 193 $modes = $registry->getModes(); 194 $modeNames = array_column($modes, 'mode'); 195 196 // All original built-in modes must be present 197 $expected = [ 198 'listblock', 'preformatted', 'notoc', 'nocache', 199 'header', 'table', 'linebreak', 'footnote', 200 'hr', 'unformatted', 'code', 'file', 'quote', 201 'internallink', 'rss', 'media', 'externallink', 202 'emaillink', 'windowssharelink', 'eol', 203 'strong', 'emphasis', 'underline', 'monospace', 204 'subscript', 'superscript', 'deleted', 205 'smiley', 'acronym', 'entity', 206 ]; 207 foreach ($expected as $mode) { 208 $this->assertContains($mode, $modeNames, "Mode '$mode' missing in dokuwiki syntax setting"); 209 } 210 } 211 212 /** DW-only modes must be absent when syntax is 'markdown' */ 213 function testGetModesDwModesSkippedInMarkdownOnly() 214 { 215 global $conf; 216 $conf['syntax'] = 'markdown'; 217 ModeRegistry::reset(); 218 $registry = ModeRegistry::getInstance(); 219 $modes = $registry->getModes(); 220 $modeNames = array_column($modes, 'mode'); 221 222 $dwOnly = [ 223 'emphasis', 'deleted', 'code', 'header', 'hr', 224 'linebreak', 'internallink', 'media', 'listblock', 'table', 225 'monospace', 'unformatted', 'file', 226 ]; 227 foreach ($dwOnly as $mode) { 228 $this->assertNotContains($mode, $modeNames, "DW mode '$mode' should not load in markdown-only mode"); 229 } 230 } 231 232 /** Always-loaded modes must still be present in markdown-only mode */ 233 function testGetModesAlwaysModesPresentInMarkdownOnly() 234 { 235 global $conf; 236 $conf['syntax'] = 'markdown'; 237 ModeRegistry::reset(); 238 $registry = ModeRegistry::getInstance(); 239 $modes = $registry->getModes(); 240 $modeNames = array_column($modes, 'mode'); 241 242 $always = [ 243 'strong', 'subscript', 'superscript', 244 'footnote', 'eol', 'preformatted', 245 'quote', 'externallink', 'emaillink', 'windowssharelink', 246 'notoc', 'nocache', 'rss', 247 'smiley', 'acronym', 'entity', 248 ]; 249 foreach ($always as $mode) { 250 $this->assertContains($mode, $modeNames, "Always-loaded mode '$mode' missing in markdown syntax setting"); 251 } 252 } 253 254 /** In mixed modes, DW modes must still load */ 255 function testGetModesMixedModesLoadDwModes() 256 { 257 $dwOnly = [ 258 'emphasis', 'deleted', 'code', 'header', 'hr', 259 'linebreak', 'internallink', 'media', 'listblock', 'table', 260 'monospace', 'unformatted', 'file', 261 ]; 262 263 foreach (['dw+md', 'md+dw'] as $syntax) { 264 global $conf; 265 $conf['syntax'] = $syntax; 266 ModeRegistry::reset(); 267 $registry = ModeRegistry::getInstance(); 268 $modes = $registry->getModes(); 269 $modeNames = array_column($modes, 'mode'); 270 271 foreach ($dwOnly as $mode) { 272 $this->assertContains($mode, $modeNames, "DW mode '$mode' missing in '$syntax' syntax setting"); 273 } 274 } 275 } 276 277 /** 278 * Verifies that each mode is loaded in the expected combinations of 279 * `$conf['syntax']`. One data set per (mode, syntax) pair. 280 * 281 * Add new mode-gating rules to {@see provideModeLoadingCases} — each 282 * entry lists the four syntax settings and whether the mode should be 283 * loaded there. 284 * 285 * @dataProvider provideModeLoadingCases 286 */ 287 function testModeLoadingBySyntax(string $mode, string $syntax, bool $shouldLoad): void 288 { 289 global $conf; 290 $conf['syntax'] = $syntax; 291 ModeRegistry::reset(); 292 $modeNames = array_column(ModeRegistry::getInstance()->getModes(), 'mode'); 293 294 if ($shouldLoad) { 295 $this->assertContains($mode, $modeNames, "$mode must load in '$syntax'"); 296 } else { 297 $this->assertNotContains($mode, $modeNames, "$mode must NOT load in '$syntax'"); 298 } 299 } 300 301 /** 302 * Data provider for {@see testModeLoadingBySyntax}. 303 * 304 * Declares, per parser mode, whether it should be loaded in each of the 305 * four `$conf['syntax']` settings (`dokuwiki`, `markdown`, `dw+md`, 306 * `md+dw`). Entries are expanded into one data set per (mode, syntax) 307 * pair so PHPUnit reports failures with a specific label. 308 * 309 * Five gating categories are represented: 310 * 311 * - **Always**: loaded unconditionally (no syntax-specific counterpart 312 * or conflict). Covers core formatting, paragraphs, and data-driven 313 * modes (smileys, acronyms, entities). 314 * - **DW-always**: loaded whenever DokuWiki is part of the syntax. Used 315 * for features that have a Markdown counterpart but no delimiter 316 * conflict (e.g. `**bold**` for emphasis). 317 * - **DW-preferred**: loaded only when DokuWiki is the primary syntax. 318 * Used when the delimiter conflicts with a Markdown mode in MD- 319 * preferred settings (e.g. `__` clashes with GFM strong). 320 * - **MD-always**: mirror — loaded whenever Markdown is part of the 321 * syntax. Used when the delimiter has no DokuWiki counterpart (e.g. 322 * `*` for emphasis). 323 * - **MD-preferred**: mirror — loaded only when Markdown is primary. 324 * Used when the delimiter conflicts with a DokuWiki mode in DW- 325 * preferred settings (e.g. `_`, `__`, `___` clash with Underline). 326 * 327 * Add a new line to the `$rules` table to register additional mode- 328 * gating rules. 329 * 330 * @return array<string, array{0: string, 1: string, 2: bool}> map from 331 * test-case label to [mode name, syntax setting, should-load] 332 */ 333 public static function provideModeLoadingCases(): array 334 { 335 $rules = [ 336 // Always-loaded (unconditional — no syntax-specific counterpart) 337 'strong' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 338 'subscript' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 339 'superscript' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 340 'footnote' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 341 'eol' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 342 'preformatted' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 343 'quote' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 344 'externallink' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 345 'emaillink' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 346 'windowssharelink' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 347 'notoc' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 348 'nocache' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 349 'rss' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 350 'smiley' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 351 'acronym' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 352 'entity' => ['dokuwiki' => true, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 353 // DW-always (features with MD counterparts but no delimiter clash) 354 'emphasis' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 355 'deleted' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 356 'code' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 357 'header' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 358 'hr' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 359 'linebreak' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 360 'internallink' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 361 'media' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 362 'listblock' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 363 'table' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 364 'monospace' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 365 'unformatted' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 366 'file' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => true ], 367 // MD-always (`*` / `~~` have no conflicting DW counterpart) 368 'gfm_emphasis' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 369 'gfm_emphasis_strong' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 370 'gfm_deleted' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 371 'gfm_backtick_single' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 372 'gfm_backtick_double' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 373 'gfm_header' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 374 'gfm_link' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 375 'gfm_media' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 376 'gfm_code' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 377 'gfm_file' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => true, 'md+dw' => true ], 378 // MD-preferred (`_`, `__`, `___` clash with Underline in DW) 379 'gfm_emphasis_underscore' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => false, 'md+dw' => true ], 380 'gfm_strong_underscore' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => false, 'md+dw' => true ], 381 'gfm_emphasis_strong_underscore' => ['dokuwiki' => false, 'markdown' => true, 'dw+md' => false, 'md+dw' => true ], 382 // DW-preferred (Underline's `__` clashes with GFM strong) 383 'underline' => ['dokuwiki' => true, 'markdown' => false, 'dw+md' => true, 'md+dw' => false], 384 ]; 385 386 $cases = []; 387 foreach ($rules as $mode => $bySyntax) { 388 foreach ($bySyntax as $syntax => $shouldLoad) { 389 $cases["$mode in $syntax"] = [$mode, $syntax, $shouldLoad]; 390 } 391 } 392 return $cases; 393 } 394 395} 396