PHPStan improvements (#65)

guillaume-sainthillier · web-flow · commit 2e36bcdcd946 · 2024-10-25T08:12:37.000+02:00
- Set max level in PHPStan config
- Use PHPStan in tests dir
- Use PHPStan config in CI
diff --git a/.github/workflows/phpstan.yaml b/.github/workflows/phpstan.yaml
@@ -33,4 +33,4 @@ jobs:
 
             -   name: Analyze code for issues
                 run: |
-                    php vendor/bin/phpstan analyse src --level 8
+                    php vendor/bin/phpstan analyse
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,6 +1,8 @@
 parameters:
-    level: 8
+    level: max
     paths:
         - 'src'
+        - 'tests'
     excludePaths:
         - 'src/zugferd10'
+        - 'tests/zugferd10'
diff --git a/src/zugferd2/Reader.php b/src/zugferd2/Reader.php
@@ -16,6 +16,7 @@ public function __construct(private readonly SerializerInterface $serializer)
 
     public function transform(string $xml): CrossIndustryInvoice
     {
+        // @phpstan-ignore-next-line
         return $this->serializer->deserialize($xml, CrossIndustryInvoice::class, 'xml');
     }
 
diff --git a/tests/zugferd2/Tests/Legacy/BuilderTest.php b/tests/zugferd2/Tests/Legacy/BuilderTest.php
@@ -198,7 +198,7 @@ public function testBuildXRechnungExample(): void
 
         $xml = Builder::create()->transform($invoice);
         self::assertNotEmpty($xml);
-        $referenceFile = file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_XRECHNUNG_Einfach.xml');
+        $referenceFile = (string)file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_XRECHNUNG_Einfach.xml');
         $referenceFile = ReaderAndBuildTest::reformatXml($referenceFile);
         $xml = ReaderAndBuildTest::reformatXml($xml);
         self::assertEquals($referenceFile, $xml);
@@ -389,7 +389,7 @@ public function testBuildXRechnungExtendedExample(): void
 
         $xml = Builder::create()->transform($invoice);
         self::assertNotEmpty($xml);
-        $referenceFile = file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_XRECHNUNG_Extended.xml');
+        $referenceFile = (string)file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_XRECHNUNG_Extended.xml');
         $referenceFile = ReaderAndBuildTest::reformatXml($referenceFile);
         $xml = ReaderAndBuildTest::reformatXml($xml);
         self::assertEquals($referenceFile, $xml);
diff --git a/tests/zugferd2/Tests/Legacy/ReaderAndBuildTest.php b/tests/zugferd2/Tests/Legacy/ReaderAndBuildTest.php
@@ -24,7 +24,7 @@ public function setupAnnotationRegistry(): void
     /** @dataProvider dataProvider */
     public function testGetDocument(string $filename): void
     {
-        $xml = file_get_contents(__DIR__ . '/official_example_xml/' . $filename);
+        $xml = (string)file_get_contents(__DIR__ . '/official_example_xml/' . $filename);
         $obj = Reader::create()->transform($xml);
         $str = Builder::create()->transform($obj);
 
@@ -36,7 +36,10 @@ public function testGetDocument(string $filename): void
         self::assertTrue(true);
     }
 
-    public function dataProvider()
+    /**
+     * @return string[][]
+     */
+    public function dataProvider(): array
     {
         return [
             ['zugferd_2p1_BASIC-WL_Einfach.xml'],
diff --git a/tests/zugferd2/Tests/Legacy/ValidatorTest.php b/tests/zugferd2/Tests/Legacy/ValidatorTest.php
@@ -9,18 +9,18 @@
 
 class ValidatorTest extends TestCase
 {
-    public function testXsdSuccess()
+    public function testXsdSuccess(): void
     {
         $validator = new Validator();
-        $xml = file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_EN16931_Einfach.xml');
+        $xml = (string)file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_EN16931_Einfach.xml');
         $errors = $validator->validateAgainstXsd($xml, Validator::SCHEMA_EN16931);
         self::assertNull($errors, $errors ?? '');
     }
 
-    public function testXsdFail()
+    public function testXsdFail(): void
     {
         $validator = new Validator();
-        $xml = file_get_contents(__DIR__ . '/references/broken_example.xml');
+        $xml = (string)file_get_contents(__DIR__ . '/references/broken_example.xml');
         $errors = $validator->validateAgainstXsd($xml, Validator::SCHEMA_EN16931);
         self::assertNotNull($errors, 'Validator says broken xml is valid.');
     }
diff --git a/tests/zugferd2/Tests/ProfileXRechnungTest.php b/tests/zugferd2/Tests/ProfileXRechnungTest.php
@@ -362,7 +362,7 @@ public function testBuildXRechnungReisekostenabrechnung(): void
         $additionalReferencedDocument->attachmentBinaryObject = $additionalReferencedDocumentBinaryObject = new BinaryObject();
         $additionalReferencedDocumentBinaryObject->filename = 'Hotelrechnung-Immo.pdf';
         $additionalReferencedDocumentBinaryObject->mimeCode = 'application/pdf';
-        $additionalReferencedDocumentBinaryObject->value = base64_encode(file_get_contents(__DIR__ . '/Examples/XRECHNUNG/Attachments/EN16931_Betriebskostenabrechnung_Abrechnung 2010.pdf'));
+        $additionalReferencedDocumentBinaryObject->value = base64_encode((string)file_get_contents(__DIR__ . '/Examples/XRECHNUNG/Attachments/EN16931_Betriebskostenabrechnung_Abrechnung 2010.pdf'));
 
         $invoice->supplyChainTradeTransaction->applicableHeaderTradeSettlement = new HeaderTradeSettlement();
         $invoice->supplyChainTradeTransaction->applicableHeaderTradeSettlement->currency = 'EUR';
@@ -507,7 +507,7 @@ public function testBuildXRechnungBetrieskostenabrechnung(): void
         $additionalReferencedDocument->attachmentBinaryObject = $additionalReferencedDocumentBinaryObject = new BinaryObject();
         $additionalReferencedDocumentBinaryObject->filename = 'Betriebskostenabrechnung.pdf';
         $additionalReferencedDocumentBinaryObject->mimeCode = 'application/pdf';
-        $additionalReferencedDocumentBinaryObject->value = base64_encode(file_get_contents(__DIR__ . '/Examples/XRECHNUNG/Attachments/EN16931_Betriebskostenabrechnung_Abrechnung 2010.pdf'));
+        $additionalReferencedDocumentBinaryObject->value = base64_encode((string)file_get_contents(__DIR__ . '/Examples/XRECHNUNG/Attachments/EN16931_Betriebskostenabrechnung_Abrechnung 2010.pdf'));
 
         $invoice->supplyChainTradeTransaction->applicableHeaderTradeSettlement = new HeaderTradeSettlement();
         $invoice->supplyChainTradeTransaction->applicableHeaderTradeSettlement->currency = 'EUR';
diff --git a/tests/zugferd2/Tests/Traits/AssertXmlOutputTrait.php b/tests/zugferd2/Tests/Traits/AssertXmlOutputTrait.php
@@ -21,7 +21,7 @@ private function buildAndAssertXmlFromCII(CrossIndustryInvoice $invoice, string
         $result = (new Validator())->validateAgainstXsd($xml, $validatorSchema);
         self::assertNull($result, $result ?? '');
 
-        $referenceFile = file_get_contents($referenceFilePath);
+        $referenceFile = (string)file_get_contents($referenceFilePath);
         $referenceFile = ReaderAndBuildTest::reformatXml($referenceFile);
         self::assertEquals($referenceFile, $xml);
     }
diff --git a/tests/zugferd2/Tests/Traits/ReformatXmlTrait.php b/tests/zugferd2/Tests/Traits/ReformatXmlTrait.php
@@ -8,12 +8,12 @@ trait ReformatXmlTrait
 {
     public static function reformatXml(string $xml): string
     {
-        $xml = preg_replace('/<!--(.|\s)*?-->/', '', $xml);
+        $xml = (string)preg_replace('/<!--(.|\s)*?-->/', '', $xml);
 
         $doc = new \DOMDocument('1.0', 'UTF-8');
         $doc->preserveWhiteSpace = false;
         $doc->formatOutput = true;
         $doc->loadXML($xml);
-        return $doc->saveXML();
+        return (string)$doc->saveXML();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public function __construct(private readonly SerializerInterface $serializer)`
`16`	`16`
`17`	`17`	`public function transform(string $xml): CrossIndustryInvoice`
`18`	`18`	`{`
	`19`	`+ // @phpstan-ignore-next-line`
`19`	`20`	`return $this->serializer->deserialize($xml, CrossIndustryInvoice::class, 'xml');`
`20`	`21`	`}`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function setupAnnotationRegistry(): void`
`24`	`24`	`/** @dataProvider dataProvider */`
`25`	`25`	`public function testGetDocument(string $filename): void`
`26`	`26`	`{`
`27`		`- $xml = file_get_contents(__DIR__ . '/official_example_xml/' . $filename);`
	`27`	`+ $xml = (string)file_get_contents(__DIR__ . '/official_example_xml/' . $filename);`
`28`	`28`	`$obj = Reader::create()->transform($xml);`
`29`	`29`	`$str = Builder::create()->transform($obj);`
`30`	`30`
`@@ -36,7 +36,10 @@ public function testGetDocument(string $filename): void`
`36`	`36`	`self::assertTrue(true);`
`37`	`37`	`}`
`38`	`38`
`39`		`- public function dataProvider()`
	`39`	`+ /**`
	`40`	`+ * @return string[][]`
	`41`	`+ */`
	`42`	`+ public function dataProvider(): array`
`40`	`43`	`{`
`41`	`44`	`return [`
`42`	`45`	`['zugferd_2p1_BASIC-WL_Einfach.xml'],`
Original file line number	Diff line number	Diff line change
`@@ -9,18 +9,18 @@`
`9`	`9`
`10`	`10`	`class ValidatorTest extends TestCase`
`11`	`11`	`{`
`12`		`- public function testXsdSuccess()`
	`12`	`+ public function testXsdSuccess(): void`
`13`	`13`	`{`
`14`	`14`	`$validator = new Validator();`
`15`		`- $xml = file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_EN16931_Einfach.xml');`
	`15`	`+ $xml = (string)file_get_contents(__DIR__ . '/official_example_xml/zugferd_2p1_EN16931_Einfach.xml');`
`16`	`16`	`$errors = $validator->validateAgainstXsd($xml, Validator::SCHEMA_EN16931);`
`17`	`17`	`self::assertNull($errors, $errors ?? '');`
`18`	`18`	`}`
`19`	`19`
`20`		`- public function testXsdFail()`
	`20`	`+ public function testXsdFail(): void`
`21`	`21`	`{`
`22`	`22`	`$validator = new Validator();`
`23`		`- $xml = file_get_contents(__DIR__ . '/references/broken_example.xml');`
	`23`	`+ $xml = (string)file_get_contents(__DIR__ . '/references/broken_example.xml');`
`24`	`24`	`$errors = $validator->validateAgainstXsd($xml, Validator::SCHEMA_EN16931);`
`25`	`25`	`self::assertNotNull($errors, 'Validator says broken xml is valid.');`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ private function buildAndAssertXmlFromCII(CrossIndustryInvoice $invoice, string`
`21`	`21`	`$result = (new Validator())->validateAgainstXsd($xml, $validatorSchema);`
`22`	`22`	`self::assertNull($result, $result ?? '');`
`23`	`23`
`24`		`- $referenceFile = file_get_contents($referenceFilePath);`
	`24`	`+ $referenceFile = (string)file_get_contents($referenceFilePath);`
`25`	`25`	`$referenceFile = ReaderAndBuildTest::reformatXml($referenceFile);`
`26`	`26`	`self::assertEquals($referenceFile, $xml);`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,12 @@ trait ReformatXmlTrait`
`8`	`8`	`{`
`9`	`9`	`public static function reformatXml(string $xml): string`
`10`	`10`	`{`
`11`		`- $xml = preg_replace('/<!--(.\|\s)*?-->/', '', $xml);`
	`11`	`+ $xml = (string)preg_replace('/<!--(.\|\s)*?-->/', '', $xml);`
`12`	`12`
`13`	`13`	`$doc = new \DOMDocument('1.0', 'UTF-8');`
`14`	`14`	`$doc->preserveWhiteSpace = false;`
`15`	`15`	`$doc->formatOutput = true;`
`16`	`16`	`$doc->loadXML($xml);`
`17`		`- return $doc->saveXML();`
	`17`	`+ return (string)$doc->saveXML();`
`18`	`18`	`}`
`19`	`19`	`}`