Add tests for the AbstractModel rules

Author: shochdoerfer

src/bitExpert/PHPStan/Magento/Rules/AbstractModelRetrieveCollectionViaFactoryRule.php

@@ -18,9 +18,12 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\VerbosityLevel;
 
 /**
  * Since 101.0.0 because collections should be used directly via factory
+ *
+ * @implements Rule<MethodCall>
  */
 class AbstractModelRetrieveCollectionViaFactoryRule implements Rule
 {
@@ -35,7 +38,7 @@ public function getNodeType(): string
     /**
      * @param Node $node
      * @param Scope $scope
-     * @return array
+     * @return (string|\PHPStan\Rules\RuleError)[] errors
      * @throws ShouldNotHappenException
      */
     public function processNode(Node $node, Scope $scope): array
@@ -61,7 +64,7 @@ public function processNode(Node $node, Scope $scope): array
         return [
             sprintf(
                 'Collections should be used directly via factory, not via %s::%s() method',
-                $type->describe(VerbosityLevel::type()),
+                $type->describe(VerbosityLevel::typeOnly()),
                 $node->name->name
             )
         ];

src/bitExpert/PHPStan/Magento/Rules/AbstractModelUseServiceContractRule.php

@@ -18,9 +18,12 @@
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\VerbosityLevel;
 
 /**
  * Since 100.1.0 entities must not be responsible for their own loading, service contracts should persist entities.
+ *
+ * @implements Rule<MethodCall>
  */
 class AbstractModelUseServiceContractRule implements Rule
 {
@@ -35,7 +38,7 @@ public function getNodeType(): string
     /**
      * @param Node $node
      * @param Scope $scope
-     * @return array
+     * @return (string|\PHPStan\Rules\RuleError)[] errors
      * @throws ShouldNotHappenException
      */
     public function processNode(Node $node, Scope $scope): array
@@ -61,7 +64,7 @@ public function processNode(Node $node, Scope $scope): array
         return [
             sprintf(
                 'Use service contracts to persist entities in favour of %s::%s() method',
-                $type->describe(VerbosityLevel::type()),
+                $type->describe(VerbosityLevel::typeOnly()),
                 $node->name->name
             )
         ];

tests/bitExpert/PHPStan/Magento/Rules/AbstractModelRetrieveCollectionViaFactoryRuleUnitTest.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the phpstan-magento package.
+ *
+ * (c) bitExpert AG
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace bitExpert\PHPStan\Magento\Rules;
+
+use bitExpert\PHPStan\Magento\Rules\Helper\SampleModel;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<AbstractModelRetrieveCollectionViaFactoryRule>
+ */
+class AbstractModelRetrieveCollectionViaFactoryRuleUnitTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new AbstractModelRetrieveCollectionViaFactoryRule();
+    }
+
+    public function testCheckCaughtException(): void
+    {
+        $this->analyse([__DIR__ . '/Helper/collection.php'], [
+            [
+                'Collections should be used directly via factory, not via ' .
+                    SampleModel::class . '::getCollection() method',
+                04
+            ]
+        ]);
+    }
+}

tests/bitExpert/PHPStan/Magento/Rules/AbstractModelUseServiceContractRuleUnitTest.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the phpstan-magento package.
+ *
+ * (c) bitExpert AG
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace bitExpert\PHPStan\Magento\Rules;
+
+use bitExpert\PHPStan\Magento\Rules\Helper\SampleModel;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<AbstractModelUseServiceContractRule>
+ */
+class AbstractModelUseServiceContractRuleUnitTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new AbstractModelUseServiceContractRule();
+    }
+
+    public function testCheckCaughtException(): void
+    {
+        $this->analyse([__DIR__ . '/Helper/service_contract.php'], [
+            [
+                'Use service contracts to persist entities in favour of ' . SampleModel::class . '::save() method',
+                04,
+            ],
+            [
+                'Use service contracts to persist entities in favour of ' . SampleModel::class . '::delete() method',
+                05,
+            ],
+            [
+                'Use service contracts to persist entities in favour of ' . SampleModel::class . '::load() method',
+                06,
+            ],
+        ]);
+    }
+}

tests/bitExpert/PHPStan/Magento/Rules/Helper/SampleModel.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the phpstan-magento package.
+ *
+ * (c) bitExpert AG
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace bitExpert\PHPStan\Magento\Rules\Helper;
+
+use Magento\Framework\Model\AbstractModel;
+
+class SampleModel extends AbstractModel
+{
+    public function __construct()
+    {
+    }
+}

tests/bitExpert/PHPStan/Magento/Rules/Helper/collection.php

@@ -0,0 +1,4 @@
+<?php
+
+$model = new \bitExpert\PHPStan\Magento\Rules\Helper\SampleModel();
+$model->getCollection();

tests/bitExpert/PHPStan/Magento/Rules/Helper/service_contract.php

@@ -0,0 +1,6 @@
+<?php
+
+$model = new \bitExpert\PHPStan\Magento\Rules\Helper\SampleModel();
+$model->save();
+$model->delete();
+$model->load(1);