PHP84 : Add spec compliance

[veewee]

Q	A
Type	improvement
BC Break	yes
Fixed issues	#72

Summary

Implements the new PHP 8.4 spec-compliance RFC:

• https://wiki.php.net/rfc/domdocument_html5_parser
• https://wiki.php.net/rfc/opt_in_dom_spec_compliance
• https://wiki.php.net/rfc/dom_additions_84
  • Extra dom additions 1 nielsdos/php-src#93

Current stats:

 ...............................................................  63 / 607 ( 10%)
............................................................... 126 / 607 ( 20%)
............................................................... 189 / 607 ( 31%)
............................................................... 252 / 607 ( 41%)
............................................................... 315 / 607 ( 51%)
............................................................... 378 / 607 ( 62%)
............................................................... 441 / 607 ( 72%)
............................................................... 504 / 607 ( 83%)
............................................................... 567 / 607 ( 93%)
........................................                        607 / 607 (100%)

Time: 00:00.183, Memory: 34.43 MB

OK (607 tests, 1047 assertions)

Target PHP version: 8.1 (set by config file) Enabled extensions: dom.
Scanning files...
Analyzing files...

░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  60 / 383 (15%)
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 120 / 383 (31%)
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 180 / 383 (46%)
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 240 / 383 (62%)
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 300 / 383 (78%)
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 360 / 383 (93%)
░░░░░░░░░░░░░░░░░░░░░░░
------------------------------

       No errors found!

------------------------------

Checks took 2.46 seconds and used 87.322MB of memory
Psalm was able to infer types for 100% of the codebase

E.............E...................................   ( 50 / 304)
..................................................   (100 / 304)
...............................................EEE   (150 / 304)
..................................................   (200 / 304)
................................................T.   (250 / 304)
............................E....E................   (300 / 304)
....                                                 (304 / 304)

304 mutations were generated:
     296 mutants were killed
       0 mutants were configured to be ignored
       0 mutants were not covered by tests
       0 covered mutants were not detected
       7 errors were encountered
       0 syntax errors were encountered
       1 time outs were encountered
       0 mutants required more time than configured

Metrics:
         Mutation Score Indicator (MSI): 100%
         Mutation Code Coverage: 100%
         Covered Code MSI: 100%

Checklist:

• Upgrade to new DOM spec compliance implementation.
• Unit tests
• Psalm
• Cs-fixer
• Infection
• Update documentation for changed functions / added functions.
  • Review : Does the new API makes sense... ?
• Remove open TODOs

[veewee]

TODO : document new API for loading DOM

[veewee]

TODO : Add support

[nielsdos]

Just letting you know that while waiting for the reviews, I spent some time today implementing the missing APIs in a separate branch. (Can be found at nielsdos/php-src#93)
In particular:

• DOM\Element::$substitutedNodeValue (I might add the same one for DOM\Attr too, not sure yet)
• DOM\Element::getInScopeNamespaces(): array
• DOM\Element::rename(?string $namespaceURI, string $qualifiedName): void and also for DOM\Attr.

Fortunately, as expected, these were rather easy to implement.

[veewee]

Cool! I'm a bit busy this week but will try to play around with it soon :)

[veewee]

Just wanted to give you a small update @nielsdos :

• The new entity substitution works flawlessly
• Renaming nodes works in general, but I have a feeling there are a few cases not working properly (will come back to this when later, I now covered about half of the test-suite but I need to dive into the specifics so that I can give you more detailed information)
• Removing namespaces works as described above (one case still failing - need to dive into the specifics as well) - It's getting a bit/log more complex now though.
• The getInScopeNamespaces works theoretically, but I expect it to work a bit different. I've mentioned in your PR : Extra dom additions 1 nielsdos/php-src#93 (comment) (this results in the optimization code throwing 21 failures right now)

Tests: 608, Assertions: 1022, Errors: 20, Failures: 21.

Getting closer to the end goal :)

[nielsdos]

Thanks for the update! Nice to see ^^

I'll try to have a look soon-ish at how to deal with the getInScopeNamespaces() discrepancy.

As for the other issues: if you're stuck debugging them, I could always try to have a look at your code with a debug PHP build, if I know what test case to look for :)