add new rules docs (#155)

* add first docs

* next rule

* next rule

* next rule

* next rule

* next rule

* next rule

* next rule

* next rule

* add phpunit rules

* off

Author: TomasVotruba

README.md

@@ -1,4 +1,4 @@
 rules:
-    - Symplify\PHPStanRules\PHPStan\Rules\Doctrine\NoGetRepositoryOutsideServiceRule
-    - Symplify\PHPStanRules\PHPStan\Rules\Doctrine\NoParentRepositoryRule
-    - Symplify\PHPStanRules\PHPStan\Rules\Doctrine\NoRepositoryCallInDataFixtureRule
+    - Symplify\PHPStanRules\Rules\Doctrine\NoGetRepositoryOutsideServiceRule
+    - Symplify\PHPStanRules\Rules\Doctrine\NoParentRepositoryRule
+    - Symplify\PHPStanRules\Rules\Doctrine\NoRepositoryCallInDataFixtureRule

config/doctrine-rules.neon

@@ -0,0 +1,6 @@
+rules:
+    - Symplify\PHPStanRules\Rules\PHPUnit\PublicStaticDataProviderRule
+    - Symplify\PHPStanRules\Rules\PHPUnit\NoMockOnlyTestRule
+
+    - Symplify\PHPStanRules\Rules\Doctrine\NoDocumentMockingRule
+    - Symplify\PHPStanRules\Rules\Doctrine\NoEntityMockingRule

config/phpunit-rules.neon

@@ -70,4 +70,14 @@ final class ClassName
      * @var string
      */
     public const DOCTRINE_FIXTURE_INTERFACE = 'Doctrine\Common\DataFixtures\FixtureInterface';
+
+    /**
+     * @var string
+     */
+    public const ENTITY_REPOSITORY_CLASS = 'Doctrine\ORM\EntityRepository';
+
+    /**
+     * @var string
+     */
+    public const MOCK_OBJECT_CLASS = 'PHPUnit\Framework\MockObject\MockObject';
 }

src/Enum/ClassName.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\PHPStan\Rules\Doctrine;
+namespace Symplify\PHPStanRules\Rules\Doctrine;
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;

…ne/NoGetRepositoryOutsideServiceRule.php …ne/NoGetRepositoryOutsideServiceRule.phpsrc/PHPStan/Rules/Doctrine/NoGetRepositoryOutsideServiceRule.php renamed to src/Rules/Doctrine/NoGetRepositoryOutsideServiceRule.php src/PHPStan/Rules/Doctrine/NoGetRepositoryOutsideServiceRule.php renamed to src/Rules/Doctrine/NoGetRepositoryOutsideServiceRule.php

@@ -2,21 +2,22 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\PHPStan\Rules\Doctrine;
+namespace Symplify\PHPStanRules\Rules\Doctrine;
 
 use PhpParser\Node;
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Class_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 
 /**
  * Check if class extends repository class,
  * the entity manager should be injected via constructor instead
  *
- * @see \Symplify\PHPStanRules\Tests\PHPStan\Rule\NoParentRepositoryRule\NoParentRepositoryRuleTest
+ * @see \Symplify\PHPStanRules\Tests\Rules\Doctrine\NoParentRepositoryRule\NoParentRepositoryRuleTest
  *
  * @implements Rule<Class_>
  */
@@ -27,11 +28,6 @@ final class NoParentRepositoryRule implements Rule
      */
     public const ERROR_MESSAGE = 'Extending EntityRepository is not allowed, use constructor injection and pass entity manager instead';
 
-    /**
-     * @var string
-     */
-    private const ENTITY_REPOSITORY_CLASS = 'Doctrine\ORM\EntityRepository';
-
     public function getNodeType(): string
     {
         return Class_::class;
@@ -47,7 +43,7 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         $parentClass = $node->extends->toString();
-        if ($parentClass !== self::ENTITY_REPOSITORY_CLASS) {
+        if ($parentClass !== ClassName::ENTITY_REPOSITORY_CLASS) {
             return [];
         }
 

…ules/Doctrine/NoParentRepositoryRule.php …ules/Doctrine/NoParentRepositoryRule.phpsrc/PHPStan/Rules/Doctrine/NoParentRepositoryRule.php renamed to src/Rules/Doctrine/NoParentRepositoryRule.php src/PHPStan/Rules/Doctrine/NoParentRepositoryRule.php renamed to src/Rules/Doctrine/NoParentRepositoryRule.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\PHPStan\Rules\Doctrine;
+namespace Symplify\PHPStanRules\Rules\Doctrine;
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;

…ne/NoRepositoryCallInDataFixtureRule.php …ne/NoRepositoryCallInDataFixtureRule.phpsrc/PHPStan/Rules/Doctrine/NoRepositoryCallInDataFixtureRule.php renamed to src/Rules/Doctrine/NoRepositoryCallInDataFixtureRule.php src/PHPStan/Rules/Doctrine/NoRepositoryCallInDataFixtureRule.php renamed to src/Rules/Doctrine/NoRepositoryCallInDataFixtureRule.php

@@ -11,6 +11,7 @@
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\Testing\PHPUnitTestAnalyser;
 
@@ -26,11 +27,6 @@
      */
     public const ERROR_MESSAGE = 'Test should have at least one non-mocked property, to test something';
 
-    /**
-     * @var string
-     */
-    private const MOCK_OBJECT_CLASS = 'PHPUnit\Framework\MockObject\MockObject';
-
     public function getNodeType(): string
     {
         return InClassNode::class;
@@ -63,7 +59,7 @@ public function processNode(Node $node, Scope $scope): array
 
             $propertyClassName = $property->type->toString();
 
-            if ($propertyClassName !== self::MOCK_OBJECT_CLASS) {
+            if ($propertyClassName !== ClassName::MOCK_OBJECT_CLASS) {
                 $hasExclusivelyMockedProperties = false;
             }
         }

src/Rules/PHPUnit/NoMockOnlyTestRule.php

@@ -14,7 +14,7 @@
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 
 /**
- * @see \Symplify\PHPStanRules\Tests\PHPStan\Rule\NoRequiredOutsideClassRule\NoRequiredOutsideClassRuleTest
+ * @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoRequiredOutsideClassRule\NoRequiredOutsideClassRuleTest
  *
  * @implements Rule<Trait_>
  */
@@ -23,7 +23,7 @@ final class NoRequiredOutsideClassRule implements Rule
     /**
      * @var string
      */
-    public const ERROR_MESSAGE = 'Symfony #[Require]/@required should be used only in classes to avoid missuse';
+    public const ERROR_MESSAGE = 'Symfony #[Require]/@required should be used only in classes to avoid misuse';
 
     /**
      * @var string

src/Rules/Symfony/NoRequiredOutsideClassRule.php

@@ -22,11 +22,6 @@
  */
 final class NoStringInGetSubscribedEventsRule implements Rule
 {
-    /**
-     * @var string
-     */
-    private const EVENT_SUBSCRIBER_INTERFACE = 'Symfony\Component\EventDispatcher\EventSubscriberInterface';
-
     /**
      * @var string
      */
@@ -56,7 +51,7 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         // only handle symfony one
-        if (! $classReflection->implementsInterface(self::EVENT_SUBSCRIBER_INTERFACE)) {
+        if (! $classReflection->implementsInterface(ClassName::EVENT_SUBSCRIBER_INTERFACE)) {
             return [];
         }