2.0.0 #23

ericsizemore · 2024-04-21T06:36:47Z

ericsizemore
Apr 21, 2024
Maintainer

A new Esi\CoverageCheck\Application class which extends Symfony\Component\Console\Application.
- Overrides getDefaultInputDefinition() and configureIO() to clean up help output.
New Utils class.
- Adds a new function isPossiblyClover(), which attempts to ensure the provided file is a PHPUnit generated clover file.
New Style\CoverageCheckStyle which extends Symfony\Console\Style\SymfonyStyle to format console output.
New shortcut for the --only-percentage option for the Console. You can use -O instead.
New option --show-files (shortcut -F), to break down metrics by file, and output the results via a table.
- This adds a new constant CoverageCheck::XPATH_FILES and the following functions:
  - CoverageCheck::processByFile()
  - CoverageCheckCommand::getFileTable()
  - CoverageCheckCommand::getResultOutput()

Minimum PHP version increased to 8.2.
- Symfony minimum ^7.0
- PHPUnit minimum ^11.0
The use of coverage:check when calling the Phar or the bin file is no longer needed.

# before
$ php vendor/bin/coverage-check coverage:check /path/to/clover.xml 90

# after
$ php vendor/bin/coverage-check /path/to/clover.xml 90

CoverageCheck::loadMetrics can now throw a RuntimeException if file_get_contents fails for whatever reason or if the new isPossiblyClover returns false.
- With the addition of the new --show-files option and related additions, the CoverageCheck::loadMetrics() now has one parameter: $xpath.
Class const XPATH_METRICS now has protected visibility.
Class const APPLICATION_NAME and VERSION moved from CoverageCheck to Application.
- Subsequently, Application now also overrides the parent Symfony\Component\Console\Application constructor and passes these values to the parent class.
Changed output message formats for CoverageCheck::nonConsoleCall and the Console to match more closely:
- Old messages:
  - Insufficient data for calculation. Please add more code.
  - Total code coverage is %s which is below the accepted %d%%
  - Total code coverage is %s - OK!
- New messages:
  - [ERROR] Insufficient data for calculation. Please add more code.
  - [ERROR] Total code coverage is %s which is below the accepted %d%%
  - [OK] Total code coverage is %s
Unit tests updated accordingly.

CoverageCheckCommand updated to use the Symfony\Console\Attribute\AsCommand attribute, as using the static properties is deprecated as of Symfony\Console 6.1.

Removed dev-dependency for phpstan\phpstan-symfony. Seemed to be a bit overkill to require a dependency for something I was able to solve with a couple extra lines, and was running into an issue where it seemed to suppress other issues from being reported.
Removed tests/console-application.php, since it was a requirement for phpstan-symfony.

The new --show-files option is not yet supported in CoverageCheck::nonConsoleCall().
Cleanup, and add to, documentation throughout.

Full Changelog: 1.0.0...2.0.0

This discussion was created from the release 2.0.0.