From 3cb4dda2d62c7c5f499d81ff1b34cd0e3ccfb9be Mon Sep 17 00:00:00 2001
From: Tomas Votruba <tomas.vot@gmail.com>
Date: Tue, 17 Dec 2024 10:06:11 +0100
Subject: [PATCH] Add NoValueObjectInServiceConstructorRule (#152)

---
 src/Enum/RuleIdentifier.php                   |  5 ++
 .../NoValueObjectInServiceConstructorRule.php | 72 +++++++++++++++++++
 2 files changed, 77 insertions(+)
 create mode 100644 src/Rules/NoValueObjectInServiceConstructorRule.php

diff --git a/src/Enum/RuleIdentifier.php b/src/Enum/RuleIdentifier.php
index 9f84e80e..380fa315 100644
--- a/src/Enum/RuleIdentifier.php
+++ b/src/Enum/RuleIdentifier.php
@@ -160,4 +160,9 @@ final class RuleIdentifier
      * @var string
      */
     public const SYMFONY_REQUIRE_INVOKABLE_CONTROLLER = 'symfony.requireInvokableController';
+
+    /**
+     * @var string
+     */
+    public const NO_VALUE_OBJECT_IN_SERVICE_CONSTRUCTOR = 'symplify.noValueObjectInServiceConstructor';
 }
diff --git a/src/Rules/NoValueObjectInServiceConstructorRule.php b/src/Rules/NoValueObjectInServiceConstructorRule.php
new file mode 100644
index 00000000..d97b3f3e
--- /dev/null
+++ b/src/Rules/NoValueObjectInServiceConstructorRule.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
+
+/**
+ * @implements Rule<ClassMethod>
+ */
+final class NoValueObjectInServiceConstructorRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return ClassMethod::class;
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if ($node->name->toString() !== '__construct') {
+            return [];
+        }
+
+        if (! $scope->isInClass()) {
+            return [];
+        }
+
+        $classReflection = $scope->getClassReflection();
+
+        // value objects can accept value objects
+        if ($this->isValueObject($classReflection->getName())) {
+            return [];
+        }
+
+        $ruleErrors = [];
+
+        foreach ($node->params as $param) {
+            if (! $param->type instanceof Name) {
+                continue;
+            }
+
+            $paramType = $param->type->toString();
+            if (! $this->isValueObject($paramType)) {
+                continue;
+            }
+
+            $ruleErrors[] = RuleErrorBuilder::message(sprintf(
+                'Value object "%s" cannot be passed to constructor of a service. Pass it as a method argument instead',
+                $paramType
+            ))
+                ->identifier(RuleIdentifier::NO_VALUE_OBJECT_IN_SERVICE_CONSTRUCTOR)
+                ->build();
+        }
+
+        return $ruleErrors;
+    }
+
+    private function isValueObject(string $className): bool
+    {
+        return preg_match('#(ValueObject|DataObject|Models)#', $className) === 1;
+    }
+}