refactor: run rector with boolean strict and add phpstan strict rules…

…. php-cs with some strict rules
FriendsOfCXML · May 31, 2024 · 96d43f5 · 96d43f5
1 parent 30df470
commit 96d43f5
Show file tree

Hide file tree

Showing 130 changed files with 633 additions and 355 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ composer.lock
 .idea
 /.phpunit.result.cache
 /.phpunit.cache
+/.phpstan/
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -4,7 +4,9 @@
 
 use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
+use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
 use PhpCsFixer\Fixer\FunctionNotation\NativeFunctionInvocationFixer;
+use PhpCsFixer\Runner\Parallel\ParallelConfig;
 
 $finder = Finder::create()
     ->in(__DIR__.'/src')
@@ -14,11 +16,13 @@
 $config = new Config();
 
 return $config
+    ->setParallelConfig((new ParallelConfig()))
     ->setRiskyAllowed(true)
     ->setRules([
         '@PSR2' => true,
         '@PSR1' => true,
         '@PhpCsFixer' => true,
+        '@PhpCsFixer:risky' => true,
         '@Symfony' => true,
         '@Symfony:risky' => false,
         'native_function_invocation' => [
@@ -32,10 +36,18 @@
         'pow_to_exponentiation' => true,
         'combine_nested_dirname' => true,
         'phpdoc_separation' => false,
+        'phpdoc_align' => ['align' => 'left'],
         '@PHP82Migration' => true,
-        'global_namespace_import' => [
-            'import_classes' => false,
-        ],
+        'global_namespace_import' => ['import_classes' => false],
+        'modernize_strpos' => true,
+        'function_declaration' => ['closure_function_spacing' => 'one', 'closure_fn_spacing' => 'one'],
+        'phpdoc_to_comment' => ['ignored_tags' => ['todo', 'var', 'property']],
+        'general_phpdoc_annotation_remove' => ['annotations' => ['expectedDeprecation']],
+        'array_syntax' => ['syntax' => 'short'],
+        'cast_spaces' => ['space' => 'none'],
+        'concat_space' => ['spacing' => 'one'],
+        'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
+        'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['arguments', 'arrays', 'match', 'parameters']],
     ])
     ->setFinder($finder)
 ;
diff --git a/composer.json b/composer.json
@@ -42,7 +42,12 @@
     "php-parallel-lint/php-parallel-lint": "*",
     "enlightn/security-checker": "*",
     "symfony/routing": "^4.4.44 || ^5.0.0 || ^6.0.0",
-    "rector/rector": "^1.1"
+    "rector/rector": "^1.1",
+    "phpstan/extension-installer": "^1.3",
+    "phpstan/phpstan-strict-rules": "^1.6",
+    "phpstan/phpstan-deprecation-rules": "^1.2",
+    "goetas/jms-serializer-phpstan-extension": "^1.0",
+    "tomasvotruba/type-coverage": "^0.3.0"
   },
   "autoload": {
     "psr-4": {
@@ -56,8 +61,14 @@
   },
   "scripts": {
     "test": "vendor/bin/phpunit --testdox tests",
-    "cs-check": "PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer check --allow-risky=yes --diff",
-    "cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --allow-risky=yes --diff",
-    "phpstan": "vendor/bin/phpstan analyze"
+    "cs-check": "PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer check --diff",
+    "cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --diff",
+    "phpstan": "vendor/bin/phpstan analyze",
+    "rector": "vendor/bin/rector process"
+  },
+  "config": {
+    "allow-plugins": {
+      "phpstan/extension-installer": true
+    }
   }
 }
diff --git a/phpstan.neon → phpstan.dist.neon b/phpstan.neon → phpstan.dist.neon
@@ -1,7 +1,24 @@
 parameters:
+    type_coverage:
+        return_type: 100
+        param_type: 98
+        property_type: 100
+        print_suggestions: true
+        declare: 100
+
+    parallel:
+        # this should be LESS than you total number of cores to prevent clogging your system
+        maximumNumberOfProcesses: 2
+
+    tmpDir: .phpstan
+
     level: max
+
     paths:
        - src/
+       - tests/
+
+    editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
 
     excludePaths:
         - %rootDir%/../../../vendor/*

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="tests/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache">
-<!--    <coverage>-->
-<!--        <report>-->
-<!--            <html outputDirectory="./.tmp/report" lowUpperBound="35" highLowerBound="70"/>-->
-<!--        </report>-->
-<!--    </coverage>-->
+    <coverage>
+        <report>
+            <html outputDirectory="./.tmp/report" lowUpperBound="35" highLowerBound="70"/>
+        </report>
+    </coverage>
     <testsuites>
         <testsuite name="cXML Test Suite">
             <directory>tests/</directory>

diff --git a/rector.php b/rector.php
@@ -21,6 +21,7 @@
         SetList::PRIVATIZATION,
         SetList::EARLY_RETURN,
         SetList::INSTANCEOF,
+        SetList::STRICT_BOOLEANS,
     ])
     ->withPhpSets()
 ;
diff --git a/src/CXml/Authentication/AuthenticatorInterface.php b/src/CXml/Authentication/AuthenticatorInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CXml\Authentication;
 
 use CXml\Context;

diff --git a/src/CXml/Authentication/SimpleSharedSecretAuthenticator.php b/src/CXml/Authentication/SimpleSharedSecretAuthenticator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CXml\Authentication;
 
 use CXml\Context;

diff --git a/src/CXml/Builder.php b/src/CXml/Builder.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CXml;
 
 use CXml\Exception\CXmlException;
@@ -101,7 +103,7 @@ private function buildHeader(): Header
         return new Header(
             new Party($this->from),
             new Party($this->to),
-            new Party($this->sender, $this->senderUserAgent)
+            new Party($this->sender, $this->senderUserAgent),
         );
     }
 
@@ -117,7 +119,7 @@ public function build(string $deploymentMode = null): CXml
                     $this->payloadIdentityFactory->newPayloadIdentity(),
                     new Request($this->payload, $this->status, null, $deploymentMode),
                     $this->buildHeader(),
-                    $this->locale
+                    $this->locale,
                 );
                 break;
 
@@ -127,7 +129,7 @@ public function build(string $deploymentMode = null): CXml
                     $this->payloadIdentityFactory->newPayloadIdentity(),
                     new Message($this->payload, $this->status),
                     $this->buildHeader(),
-                    $this->locale
+                    $this->locale,
                 );
                 break;
 
@@ -143,7 +145,7 @@ public function build(string $deploymentMode = null): CXml
                 $cXml = CXml::forResponse(
                     $this->payloadIdentityFactory->newPayloadIdentity(),
                     new Response($status, $this->payload),
-                    $this->locale
+                    $this->locale,
                 );
                 break;
 
@@ -153,7 +155,7 @@ public function build(string $deploymentMode = null): CXml
                     $cXml = CXml::forResponse(
                         $this->payloadIdentityFactory->newPayloadIdentity(),
                         new Response($this->status),
-                        $this->locale
+                        $this->locale,
                     );
 
                     break;

diff --git a/src/CXml/Builder/OrderRequestBuilder.php b/src/CXml/Builder/OrderRequestBuilder.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CXml\Builder;
 
 use CXml\Model\Address;
@@ -58,7 +60,7 @@ public static function fromPunchOutOrderMessage(
         string $currency = null,
         string $orderId = null,
         \DateTimeInterface $orderDate = null,
-        string $language = 'en'
+        string $language = 'en',
     ): self {
         if (($supplierOrderInfo = $punchOutOrderMessage->getPunchOutOrderMessageHeader()->getSupplierOrderInfo()) instanceof \CXml\Model\SupplierOrderInfo) {
             $orderId ??= $supplierOrderInfo->getOrderId();
@@ -79,7 +81,7 @@ public static function fromPunchOutOrderMessage(
             $orderId,
             $orderDate,
             $currency,
-            $language
+            $language,
         );
 
         $orb->setShipTo($punchOutOrderMessage->getPunchOutOrderMessageHeader()->getShipTo());
@@ -93,7 +95,7 @@ public static function fromPunchOutOrderMessage(
                 $item->getItemDetail()->getUnitPrice()->getMoney()->getValueCent(),
                 [
                     new Classification('custom', '0'), // TODO make this configurable
-                ]
+                ],
             );
         }
 
@@ -108,7 +110,7 @@ public function billTo(
         string $email = null,
         Phone $phone = null,
         string $fax = null,
-        string $url = null
+        string $url = null,
     ): self {
         $this->billTo = new BillTo(
             new Address(
@@ -119,8 +121,8 @@ public function billTo(
                 $email,
                 $phone,
                 $fax,
-                $url
-            )
+                $url,
+            ),
         );
 
         return $this;
@@ -130,14 +132,14 @@ public function shipTo(
         string $name,
         PostalAddress $postalAddress,
         array $carrierIdentifiers = [],
-        string $carrierAccountNo = null
+        string $carrierAccountNo = null,
     ): self {
         $this->shipTo = new ShipTo(
             new Address(
                 new MultilanguageString($name, null, $this->language),
-                $postalAddress
+                $postalAddress,
             ),
-            $carrierAccountNo ? TransportInformation::fromContractAccountNumber($carrierAccountNo) : null
+            null !== $carrierAccountNo && '' !== $carrierAccountNo && '0' !== $carrierAccountNo ? TransportInformation::fromContractAccountNumber($carrierAccountNo) : null,
         );
 
         foreach ($carrierIdentifiers as $domain => $identifier) {
@@ -184,7 +186,7 @@ public function addItem(
         int $unitPrice,
         array $classifications,
         \DateTimeInterface $requestDeliveryDate = null,
-        ItemOut $parent = null
+        ItemOut $parent = null,
     ): self {
         $lineNumber = \count($this->items) + 1;
 
@@ -196,17 +198,17 @@ public function addItem(
                 new Description(
                     $description,
                     null,
-                    $this->language
+                    $this->language,
                 ),
                 $unitOfMeasure,
                 new MoneyWrapper(
                     $this->currency,
-                    $unitPrice
+                    $unitPrice,
                 ),
-                $classifications
+                $classifications,
             ),
             $requestDeliveryDate,
-            $parent instanceof ItemOut ? $parent->getLineNumber() : null
+            $parent instanceof ItemOut ? $parent->getLineNumber() : null,
         );
 
         $this->items[] = $item;
@@ -221,7 +223,7 @@ public function addComment(string $value = null, string $type = null, string $la
             $value,
             $type,
             $lang,
-            $attachmentUrl
+            $attachmentUrl,
         );
 
         return $this;
@@ -231,7 +233,7 @@ public function addContact(string $name, string $email, string $role = Contact::
     {
         $contact = new Contact(
             new MultilanguageString($name, null, $this->language),
-            $role
+            $role,
         );
         $contact->addEmail($email);
 
@@ -256,11 +258,10 @@ private function buildOrderRequestHeader(): OrderRequestHeader
             $this->billTo,
             new MoneyWrapper($this->currency, $this->total),
             OrderRequestHeader::TYPE_NEW,
-            $this->contacts
+            $this->contacts,
         )
             ->setShipping($this->shipping)
-            ->setTax($this->tax)
-        ;
+            ->setTax($this->tax);
 
         foreach ($this->comments as $comment) {
             $orh->addComment($comment);
@@ -280,7 +281,7 @@ public function build(): OrderRequest
         }
 
         return OrderRequest::create(
-            $this->buildOrderRequestHeader()
+            $this->buildOrderRequestHeader(),
         )->addItems($this->items);
     }
 

diff --git a/src/CXml/Builder/ProductActivityMessageBuilder.php b/src/CXml/Builder/ProductActivityMessageBuilder.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CXml\Builder;
 
 use CXml\Model\Contact;
@@ -29,17 +31,16 @@ public static function create(string $messageId, string $warehouseCodeDomain): s
     public function addProductActivityDetail(string $sku, string $warehouseCode, int $stockLevel, array $extrinsics = null): self
     {
         $inventory = Inventory::create()
-            ->setStockOnHandQuantity(new InventoryQuantity($stockLevel, 'EA'))
-        ;
+            ->setStockOnHandQuantity(new InventoryQuantity($stockLevel, 'EA'));
 
         $activityDetail = ProductActivityDetail::create(
             new ItemId($sku, null, $sku),
             $inventory,
             Contact::create(new MultilanguageString($warehouseCode, null, 'en'), 'locationFrom')
-                ->addIdReference($this->warehouseCodeDomain, $warehouseCode)
+                ->addIdReference($this->warehouseCodeDomain, $warehouseCode),
         );
 
-        if ($extrinsics) {
+        if (null !== $extrinsics && [] !== $extrinsics) {
             foreach ($extrinsics as $k => $v) {
                 $activityDetail->addExtrinsicAsKeyValue($k, $v);
             }