Reformat, fix phpunit execution

z4kn4fein · Mar 31, 2024 · 2050543 · 2050543
1 parent 5b1a770
commit 2050543
Show file tree

Hide file tree

Showing 13 changed files with 81 additions and 91 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -72,6 +72,8 @@ jobs:
 
       - name: Execute coverage
         run: vendor/bin/phpunit --coverage-clover=coverage.xml --log-junit=tests.xml
+        env:
+          XDEBUG_MODE: coverage
 
       - name: SonarCloud Scan
         uses: SonarSource/sonarcloud-github-action@master

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,23 +1,13 @@
-<phpunit
-        backupGlobals="false"
-        backupStaticAttributes="false"
-        bootstrap="vendor/autoload.php"
-        colors="true"
-        convertErrorsToExceptions="true"
-        convertNoticesToExceptions="true"
-        convertWarningsToExceptions="true"
-        beStrictAboutTestsThatDoNotTestAnything="true"
-        beStrictAboutOutputDuringTests="true"
-        processIsolation="false"
-        stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Unit Tests">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" beStrictAboutTestsThatDoNotTestAnything="true" beStrictAboutOutputDuringTests="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <testsuites>
+    <testsuite name="Unit Tests">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
+</phpunit>
diff --git a/src/Constraints/Constraint.php b/src/Constraints/Constraint.php
@@ -94,9 +94,9 @@ public static function parseOrNull(string $constraintString): ?Constraint
      *
      * @param string $constraintString the string to parse
      *
-     * @throws SemverException when the constraint string is invalid
-     *
      * @return Constraint the parsed constraint
+     *
+     * @throws SemverException when the constraint string is invalid
      */
     public static function parse(string $constraintString): Constraint
     {

diff --git a/src/PreRelease.php b/src/PreRelease.php
@@ -83,9 +83,9 @@ public static function default(): PreRelease
     /**
      * @param string $preReleaseString the pre-release string
      *
-     * @throws SemverException when the given pre-release string is invalid
-     *
      * @return PreRelease the parsed pre-release part
+     *
+     * @throws SemverException when the given pre-release string is invalid
      */
     public static function parse(string $preReleaseString): PreRelease
     {

diff --git a/src/SemverException.php b/src/SemverException.php
@@ -9,6 +9,4 @@
 /**
  * Version and Constraint parsing throws this exception when the parsing fails due to an invalid format.
  */
-class SemverException extends Exception
-{
-}
+class SemverException extends Exception {}
diff --git a/src/Traits/Comparable.php b/src/Traits/Comparable.php
@@ -93,9 +93,9 @@ public function isNotEqual(Version $v): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return bool true when $v1 &lt; $v2, otherwise false
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function lessThan(string $v1, string $v2): bool
     {
@@ -111,9 +111,9 @@ public static function lessThan(string $v1, string $v2): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return bool true when $v1 &lt;= $v2, otherwise false
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function lessThanOrEqual(string $v1, string $v2): bool
     {
@@ -129,9 +129,9 @@ public static function lessThanOrEqual(string $v1, string $v2): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return bool true when $v1 &gt; $v2, otherwise false
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function greaterThan(string $v1, string $v2): bool
     {
@@ -147,9 +147,9 @@ public static function greaterThan(string $v1, string $v2): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return bool true when $v1 &gt;= $v2, otherwise false
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function greaterThanOrEqual(string $v1, string $v2): bool
     {
@@ -165,9 +165,9 @@ public static function greaterThanOrEqual(string $v1, string $v2): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return bool true when $v1 == $v2, otherwise false
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function equal(string $v1, string $v2): bool
     {
@@ -183,9 +183,9 @@ public static function equal(string $v1, string $v2): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return bool true when $v1 != $v2, otherwise false
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function notEqual(string $v1, string $v2): bool
     {
@@ -201,9 +201,9 @@ public static function notEqual(string $v1, string $v2): bool
      * @param string $v1 the left side of the comparison
      * @param string $v2 the right side of the comparison
      *
-     * @throws SemverException when the version strings are invalid
-     *
      * @return int -1 when $v1 < $v2, 0 when $v1 == $v2, 1 when $v1 > $v2
+     *
+     * @throws SemverException when the version strings are invalid
      */
     public static function compareString(string $v1, string $v2): int
     {

diff --git a/src/Traits/Copyable.php b/src/Traits/Copyable.php
@@ -21,16 +21,16 @@ trait Copyable
      * @param null|string $preRelease the pre-release part
      * @param null|string $buildMeta  the build metadata
      *
-     * @throws SemverException when the version parts are invalid
-     *
      * @return Version the new version
+     *
+     * @throws SemverException when the version parts are invalid
      */
     public function copy(
-        int $major = null,
-        int $minor = null,
-        int $patch = null,
-        string $preRelease = null,
-        string $buildMeta = null
+        ?int $major = null,
+        ?int $minor = null,
+        ?int $patch = null,
+        ?string $preRelease = null,
+        ?string $buildMeta = null
     ): Version {
         return self::create(
             null == $major ? $this->major : $major,

diff --git a/src/Traits/NextProducer.php b/src/Traits/NextProducer.php
@@ -19,11 +19,11 @@ trait NextProducer
      *
      * @param null|string $preRelease the pre-release part
      *
-     * @throws SemverException when the pre-release tag is non-null and invalid
-     *
      * @return Version the next major version
+     *
+     * @throws SemverException when the pre-release tag is non-null and invalid
      */
-    public function getNextMajorVersion(string $preRelease = null): Version
+    public function getNextMajorVersion(?string $preRelease = null): Version
     {
         return new Version(
             $this->major + 1,
@@ -38,11 +38,11 @@ public function getNextMajorVersion(string $preRelease = null): Version
      *
      * @param null|string $preRelease the pre-release part
      *
-     * @throws SemverException when the pre-release tag is non-null and invalid
-     *
      * @return Version the next minor version
+     *
+     * @throws SemverException when the pre-release tag is non-null and invalid
      */
-    public function getNextMinorVersion(string $preRelease = null): Version
+    public function getNextMinorVersion(?string $preRelease = null): Version
     {
         return new Version(
             $this->major,
@@ -57,11 +57,11 @@ public function getNextMinorVersion(string $preRelease = null): Version
      *
      * @param null|string $preRelease the pre-release part
      *
-     * @throws SemverException when the pre-release tag is non-null and invalid
-     *
      * @return Version the next patch version
+     *
+     * @throws SemverException when the pre-release tag is non-null and invalid
      */
-    public function getNextPatchVersion(string $preRelease = null): Version
+    public function getNextPatchVersion(?string $preRelease = null): Version
     {
         return new Version(
             $this->major,
@@ -76,11 +76,11 @@ public function getNextPatchVersion(string $preRelease = null): Version
      *
      * @param null|string $preRelease the pre-release part
      *
-     * @throws SemverException when the pre-release tag is non-null and invalid
-     *
      * @return Version the next pre-release version
+     *
+     * @throws SemverException when the pre-release tag is non-null and invalid
      */
-    public function getNextPreReleaseVersion(string $preRelease = null): Version
+    public function getNextPreReleaseVersion(?string $preRelease = null): Version
     {
         $pre = PreRelease::default();
         if (!empty($preRelease)) {
@@ -106,11 +106,11 @@ public function getNextPreReleaseVersion(string $preRelease = null): Version
      * @param int         $by         determines by which part the Version should be incremented
      * @param null|string $preRelease the optional pre-release part
      *
-     * @throws SemverException when the pre-release tag is non-null and invalid
-     *
      * @return Version the incremented version
+     *
+     * @throws SemverException when the pre-release tag is non-null and invalid
      */
-    public function inc(int $by, string $preRelease = null): Version
+    public function inc(int $by, ?string $preRelease = null): Version
     {
         switch ($by) {
             case Inc::MAJOR:

diff --git a/src/Traits/Sortable.php b/src/Traits/Sortable.php
@@ -60,9 +60,9 @@ public static function rsort(array $versions): array
      *
      * @param string[] $versions the version strings to sort
      *
-     * @throws SemverException when the given array contains an invalid version string
-     *
      * @return string[] the sorted array of version strings
+     *
+     * @throws SemverException when the given array contains an invalid version string
      */
     public static function sortString(array $versions): array
     {
@@ -79,9 +79,9 @@ public static function sortString(array $versions): array
      *
      * @param string[] $versions the version strings to sort
      *
-     * @throws SemverException when the given array contains an invalid version string
-     *
      * @return string[] the sorted array of version strings
+     *
+     * @throws SemverException when the given array contains an invalid version string
      */
     public static function rsortString(array $versions): array
     {

diff --git a/src/Version.php b/src/Version.php
@@ -35,18 +35,18 @@ class Version
     /**
      * Constructs a semantic version.
      *
-     * @param $major int The major version number
-     * @param $minor int The minor version number
-     * @param $patch int The patch version number
+     * @param                 $major      int The major version number
+     * @param                 $minor      int The minor version number
+     * @param                 $patch      int The patch version number
      * @param null|PreRelease $preRelease the pre-release part
      * @param null|string     $buildMeta  the build metadata
      */
     private function __construct(
         int $major,
         int $minor,
         int $patch,
-        PreRelease $preRelease = null,
-        string $buildMeta = null
+        ?PreRelease $preRelease = null,
+        ?string $buildMeta = null
     ) {
         $this->major = $major;
         $this->minor = $minor;
@@ -201,9 +201,9 @@ public static function parseOrNull(string $versionString, bool $strict = true):
      * @param string $versionString the version string
      * @param bool   $strict        enables or disables strict parsing
      *
-     * @throws SemverException when the given version string is invalid
-     *
      * @return Version the parsed version
+     *
+     * @throws SemverException when the given version string is invalid
      */
     public static function parse(string $versionString, bool $strict = true): Version
     {
@@ -261,16 +261,16 @@ public static function parse(string $versionString, bool $strict = true): Versio
      * @param null|string $preRelease the pre-release part
      * @param null|string $buildMeta  the build metadata
      *
-     * @throws SemverException when the version parts are invalid
-     *
      * @return Version the new version
+     *
+     * @throws SemverException when the version parts are invalid
      */
     public static function create(
         int $major,
         int $minor,
         int $patch,
-        string $preRelease = null,
-        string $buildMeta = null
+        ?string $preRelease = null,
+        ?string $buildMeta = null
     ): Version {
         self::ensure($major >= 0, 'The major number must be >= 0.');
         self::ensure($minor >= 0, 'The minor number must be >= 0.');
@@ -291,9 +291,9 @@ public static function create(
      * @param string $versionString    the version to check
      * @param string $constraintString the constraint to satisfy
      *
-     * @throws SemverException when the version string or the constraint string is invalid
-     *
      * @return bool true when the given version satisfies the given constraint, otherwise false
+     *
+     * @throws SemverException when the version string or the constraint string is invalid
      */
     public static function satisfies(string $versionString, string $constraintString): bool
     {

diff --git a/tests/ConstraintTest.php b/tests/ConstraintTest.php
@@ -76,7 +76,7 @@ public function testRanges()
         $this->assertEquals('<=1.0.0', (new Range($start, $end, Op::GREATER_THAN_OR_EQUAL))->opposite());
     }
 
-    public function dataInvalid(): array
+    public static function dataInvalid(): array
     {
         return [
             ['a'],
@@ -89,7 +89,7 @@ public function dataInvalid(): array
         ];
     }
 
-    public function dataSatisfies(): array
+    public static function dataSatisfies(): array
     {
         return [
             ["<\t1.0.0", '0.1.2'],
@@ -263,7 +263,7 @@ public function dataSatisfies(): array
         ];
     }
 
-    public function dataNotSatisfies(): array
+    public static function dataNotSatisfies(): array
     {
         return [
             ['~1.2.3-alpha.2', '1.3.4-alpha.2'],
@@ -443,7 +443,7 @@ public function dataNotSatisfies(): array
         ];
     }
 
-    public function dataParse(): array
+    public static function dataParse(): array
     {
         return [
             ['1.2.3 - 2.3.4', '>=1.2.3 <=2.3.4'],

diff --git a/tests/NextVersionsTest.php b/tests/NextVersionsTest.php
@@ -44,7 +44,7 @@ public function testInc(string $source, int $incBy, string $expected, ?string $p
         $this->assertEquals($expected, (string) Version::parse($source)->inc($incBy, $preRelease));
     }
 
-    public function data(): array
+    public static function data(): array
     {
         return [
             ['1.2.3', Inc::MAJOR, '2.0.0', null],