Merge pull request #1 from sasezaki/initial-setup

initial setups

composer-require-checker.json

@@ -16,6 +16,8 @@
     "PHPStan\\Type\\ArrayType",
     "PHPStan\\Type\\Constant\\ConstantStringType",
     "PHPStan\\Type\\ObjectType",
-    "PHPStan\\Type\\Type"
+    "PHPStan\\Type\\Type",
+    "PhpParser\\Node\\Expr\\FuncCall",
+    "PhpParser\\Node\\Name"
   ]
 }

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "struggle-for-php/sfp-phpstan-dont-operation-inside-constructor",
-    "description": "Extra strict and opinionated resource operation rules.neon for PHPStan",
+    "description": "Extra strict and opinionated resource operation rules for PHPStan",
     "type": "phpstan-extension",
     "keywords": ["phpstan", "static analysis", "constructor", "operation", "resource"],
     "license": [
@@ -9,7 +9,7 @@
     "require": {
         "php": "^7.2.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
         "phpstan/phpstan": "^1.10",
-        "struggle-for-php/resource-operations": "^4.0.1"
+        "struggle-for-php/resource-operations": "^4.0.2"
     },
     "require-dev": {
         "laminas/laminas-coding-standard": "^2.0.0",

example/example.php

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

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

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

src/Rules/ResourceOperationFuncCallRule.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sfp\PHPStan\DontOperationInsideConstructor\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Name;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Sfp\ResourceOperations\ResourceOperations;
+
+use function in_array;
+use function sprintf;
+
+/**
+ * @implements Rule<Node\Expr\FuncCall>
+ */
+final class ResourceOperationFuncCallRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Expr\FuncCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if ($scope->getFunctionName() !== '__construct') {
+            return [];
+        }
+
+        if (! $node->name instanceof Name) {
+            return [];
+        }
+
+        $errors = [];
+        if (in_array($node->name->toString(), ResourceOperations::getFunctions(), true)) {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf("Don't resource operation inside constructor. function %s() is called.", $node->name->toString())
+            )->identifier('sfp-dont-operation.resourceOperationFuncCall')->build();
+        }
+
+        return $errors;
+    }
+}

src/Rules/ResourceOperationMethodCallRule.php

@@ -10,43 +10,47 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use Sfp\ResourceOperations\ResourceOperations;
 
+use function in_array;
+use function sprintf;
+use function strtolower;
+
 /**
  * @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;
-	}
+    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/ResourceOperationFuncCallRuleTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SfpTest\PHPStan\DontOperationInsideConstructor\Rules;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use Sfp\PHPStan\DontOperationInsideConstructor\Rules\ResourceOperationFuncCallRule;
+
+/**
+ * @extends RuleTestCase<ResourceOperationFuncCallRule>
+ * @covers \Sfp\PHPStan\DontOperationInsideConstructor\Rules\ResourceOperationFuncCallRule
+ */
+class ResourceOperationFuncCallRuleTest extends RuleTestCase
+{
+    public function getRule(): Rule
+    {
+        return new ResourceOperationFuncCallRule();
+    }
+
+    public function testProcess(): void
+    {
+        $this->analyse([__DIR__ . '/data/ResourceOperationFuncCall.php'], [
+            [
+                "Don't resource operation inside constructor. function fopen() is called.",
+                13,
+            ],
+        ]);
+    }
+}

test/Rules/ResourceOperationMethodCallRuleTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SfpTest\PHPStan\DontOperationInsideConstructor\Rules;
 
 use PHPStan\Rules\Rule;
@@ -8,21 +10,22 @@
 
 /**
  * @extends RuleTestCase<ResourceOperationMethodCallRule>
+ * @covers \Sfp\PHPStan\DontOperationInsideConstructor\Rules\ResourceOperationMethodCallRule
  */
 class ResourceOperationMethodCallRuleTest extends RuleTestCase
 {
-	public function getRule(): Rule
-	{
-	    return new ResourceOperationMethodCallRule();
-	}
+    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
-			]
-		]);
-	}
+    public function testProcess(): void
+    {
+        $this->analyse([__DIR__ . '/data/ResourceOperationMethodCall.php'], [
+            [
+                "Don't resource operation inside constructor. Method SplFileInfo::openfile() is called.",
+                14,
+            ],
+        ]);
+    }
 }

test/Rules/data/ResourceOperationFuncCall.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SfpTest\PHPStan\DontOperationInsideConstructor\Rules\data;
+
+use function fopen;
+
+class ResourceOperationFuncCall
+{
+    public function __construct()
+    {
+        $fp = fopen('test', 'r');
+
+        (function () {
+        })();
+    }
+}

test/Rules/data/ResourceOperationMethodCall.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SfpTest\PHPStan\DontOperationInsideConstructor\Rules\data;
+
+use SplFileInfo;
+
+class ResourceOperationMethodCall
+{
+    public function __construct()
+    {
+        $fileInfo = new SplFileInfo('test');
+        $fileInfo->openFile('r');
+    }
+}

test/example.output

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" failures="2" name="phpstan" tests="2" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/junit-team/junit5/r5.5.1/platform-tests/src/test/resources/jenkins-junit.xsd">
+  <testcase name="example/example.php:11">
+    <failure type="ERROR" message="Don't resource operation inside constructor. Method SplFileInfo::openfile() is called."/>
+  </testcase>
+  <testcase name="example/example.php:13">
+    <failure type="ERROR" message="Don't resource operation inside constructor. function fopen() is called."/>
+  </testcase>
+</testsuite>