init

Author: sasezaki

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "struggle-for-php/sfp-phpstan-dont-operation-inside-constructor",
-    "description": "Extra strict and opinionated resource operation rules for PHPStan",
+    "description": "Extra strict and opinionated resource operation rules.neon for PHPStan",
     "type": "phpstan-extension",
     "keywords": ["phpstan", "static analysis", "constructor", "operation", "resource"],
     "license": [

example/example.php

@@ -0,0 +1,16 @@
+<?php
+namespace SfpExample\PHPStan\DontOperationInsideConstructor;
+
+class Example
+{
+	public function __construct()
+	{
+		$fileInfo = new \SplFileInfo('test');
+		$fileInfo->openFile('r');
+	}
+
+	public static function factory() : self
+	{
+	    return new self();
+	}
+}

example/phpstan.neon

@@ -0,0 +1,11 @@
+#./vendor/bin/phpstan analyse -c ./example/phpstan.neon
+
+parameters:
+	level: 5
+	bootstrapFiles:
+		- %currentWorkingDirectory%/vendor/autoload.php
+	paths:
+		- %currentWorkingDirectory%/example
+
+includes:
+	- %currentWorkingDirectory%/rules.neon

phpcs.xml

@@ -23,4 +23,4 @@
         <exclude name="Generic.Files.LineLength"/>
         <exclude name="WebimpressCodingStandard.Formatting.StringClassReference" />
     </rule>
-</ruleset>
+</ruleset>

phpstan.neon

@@ -7,5 +7,5 @@ parameters:
 		- test/Rules/data/*
 
 includes:
-	- vendor/phpstan/phpstan-phpunit/extension.neon
+#	- vendor/phpstan/phpstan-phpunit/extension.neon
 	- vendor/phpstan/phpstan-phpunit/rules.neon

rules.neon

@@ -0,0 +1,2 @@
+rules:
+	- Sfp\PHPStan\DontOperationInsideConstructor\Rules\ResourceOperationMethodCallRule

src/Rules/ResourceOperationMethodCallRule.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sfp\PHPStan\DontOperationInsideConstructor\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Sfp\ResourceOperations\ResourceOperations;
+
+/**
+ * @implements Rule<Node\Expr\MethodCall>
+ */
+final class ResourceOperationMethodCallRule implements Rule
+{
+	public function getNodeType(): string
+	{
+		return Node\Expr\MethodCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (! $node->name instanceof Node\Identifier) {
+			// @codeCoverageIgnoreStart
+			return []; // @codeCoverageIgnoreEnd
+		}
+
+		if ($scope->getFunctionName() !== '__construct') {
+			return [];
+		}
+
+		$calledOnType = $scope->getType($node->var);
+
+		$methodNames = [];
+		foreach ($calledOnType->getObjectClassNames() as $objectClassName) {
+			$methodNames [] = $objectClassName . '::' .strtolower($node->name->name);
+		}
+
+		$errors = [];
+		foreach ($methodNames as $methodName) {
+			if (in_array($methodName, ResourceOperations::getMethods(), true)) {
+				$errors[] = RuleErrorBuilder::message(
+					sprintf("Don't resource operation inside constructor. Method %s() is called.", $methodName)
+				)->identifier('sfp-dont-operation.resourceOperationMethodCall')->build();
+			}
+		}
+
+		return $errors;
+	}
+}

test/Rules/ResourceOperationMethodCallRuleTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace SfpTest\PHPStan\DontOperationInsideConstructor\Rules;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use Sfp\PHPStan\DontOperationInsideConstructor\Rules\ResourceOperationMethodCallRule;
+
+/**
+ * @extends RuleTestCase<ResourceOperationMethodCallRule>
+ */
+class ResourceOperationMethodCallRuleTest extends RuleTestCase
+{
+	public function getRule(): Rule
+	{
+	    return new ResourceOperationMethodCallRule();
+	}
+
+	public function testProcess(): void
+	{
+		$this->analyse([__DIR__ . '/data/resourceOperationMethodCall.php'], [
+			[
+				"Don't resource operation inside constructor. Method SplFileInfo::openfile() is called.",
+				8
+			]
+		]);
+	}
+}

test/Rules/data/resourceOperationMethodCall.php

@@ -0,0 +1,10 @@
+<?php
+
+class Test
+{
+	public function __construct()
+	{
+		$fileInfo = new SplFileInfo('test');
+		$fileInfo->openFile('r');
+	}
+}