Fixes

Removed escaping
Renamed namespace_restriction to namespace_constraints

Author: devtronic

README.md

@@ -0,0 +1,89 @@
+# PHPStan Namespace Constraints Rule
+
+This repository contains the code for the namespace_constraints rule for PHPStan.
+
+## Why?
+In the most architectures you should not depend on everything.
+With this rule you can ensure that a source namespace (RegEx Pattern) can only depend on code that lives in the target
+namespaces.
+
+## Installation
+```bash
+$ composer require --dev mintware-de/phpstan-namespace-constraints
+```
+
+## Configuration
+
+Add this to your `phpstan.neon`
+
+```neon
+# phpstan.neon
+includes:
+    - vendor/mintware-de/phpstan-namespace-constraints/src/Rules/rules.neon
+
+parameters:
+    namespace_constraints:
+        constraints:
+            - from: App\\SourceNamespace\\.* # Everything inside this namespace has access to
+              to: [App\\TargetNamespace\\.*] # this namespace
+```
+
+## Examples
+
+### Simple
+
+```mermaid
+graph TD;
+    App\Data-->App\Core;
+    App\UserInterface-->App\Data;
+```
+
+```neon
+# phpstan.neon
+includes:
+    - vendor/mintware-de/phpstan-namespace-constraints/src/Rules/rules.neon
+
+parameters:
+    namespace_constraints:
+        constraints:
+            - from: App\\Core(\\.*)?
+              to: [App\\Core(\\.*)?]
+            - from: App\\Data(\\.*)?
+              to: 
+                - App\\Core(\\.*)?
+                - App\\Data(\\.*)?
+            - from: App\\UserInterface(\\.*)?
+              to: 
+                - App\\Core(\\.*)?
+                - App\\Data(\\.*)?
+                - App\\UserInterface(\\.*)?
+```
+
+### Advanced
+
+```mermaid
+graph TD;
+    App\User\Core-->App\Shared\Core
+    App\Blog\Core-->App\Shared\Core
+    App\*\Core-->App\Shared\Core
+```
+
+
+```neon
+# phpstan.neon
+includes:
+    - vendor/mintware-de/phpstan-namespace-constraints/src/Rules/rules.neon
+
+parameters:
+    namespace_constraints:
+        constraints:
+            # App\User Constraints
+            - from: App\\User\\Core(\\.*)?
+              to: [App\\User\\Core(\\.*)?]
+            # App\\Blog\ Constraints
+            - from: App\\Blog\\Core(\\.*)?
+              to: [App\\Blog\\Core(\\.*)?]
+            # App\*\Core -> App\Shared\Core
+            - from: App\\(\w+)\\Core(\\.*)?
+              to: [App\\Shared\\Core(\\.*)?]
+```

composer.json

@@ -3,7 +3,7 @@
     "description": "A PHPStan rule for restricting namespace usings to control dependency inheritance.",
     "type": "library",
     "require": {
-        "php": "^7.0 || ^8.0",
+        "php": "^7.1 || ^8.0",
         "phpstan/phpstan": "^0.12.99",
         "nikic/php-parser": "^4.13"
     },

src/Rules/NamespaceRestrictionRule.php

@@ -51,12 +51,8 @@ public function processNode(Node $node, Scope $scope): array
             if ($constraint[self::CONSTRAINT_FROM] === null && $scope->getNamespace() !== null) {
                 continue;
             }
-            $escaped = addcslashes($constraint[self::CONSTRAINT_FROM] ?? '', '\\');
-            if ($escaped == null) {
-                $constraints[$constraint[self::CONSTRAINT_FROM]][] = [];
-                continue;
-            }
-            if (preg_match('~^'.$escaped.'$~', $scope->getNamespace() ?? '')) {
+
+            if (preg_match('~^'.$constraint[self::CONSTRAINT_FROM].'$~', $scope->getNamespace() ?? '')) {
                 if (!isset($constraints[$constraint[self::CONSTRAINT_FROM]])) {
                     $constraints[$constraint[self::CONSTRAINT_FROM]] = [];
                 }
@@ -85,7 +81,7 @@ public function processNode(Node $node, Scope $scope): array
 
             $fullPattern = '~^('.implode('|', $values).')$~';
 
-            if (!preg_match(addcslashes($fullPattern, '\\'), $name)) {
+            if (!preg_match($fullPattern, $name)) {
                 if (!isset($this->builtInChecks[$name])) {
                     $reflection = null;
                     if (class_exists($name)) {

src/Rules/rules.neon

@@ -5,12 +5,12 @@ services:
 	-
 		class: \MintwareDe\PhpStanNamespaceConstraints\Rules\NamespaceRestrictionRule
 		arguments:
-			constraints: '%namespace_restriction.constraints%'
+			constraints: '%namespace_constraints.constraints%'
 		tags:
 			- phpstan.rules.rule
 
 parametersSchema:
-    namespace_restriction: structure([
+    namespace_constraints: structure([
         constraints: listOf(structure([
             from: anyOf(null, string())
             to: listOf(string())

tests/Advanced/Blog/Core/BlogService.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Blog\Core;
+
+use MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Shared\Core\Entity\BlogEntry;
+
+class BlogService
+{
+    public function getEntry(): BlogEntry
+    {
+        return new BlogEntry();
+    }
+}

tests/Advanced/Blog/Core/InvalidBlogService.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Blog\Core;
+
+use MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\User\Core\UserService;
+
+class InvalidBlogService
+{
+    public function __construct(UserService $userService)
+    {
+        $userService->getUser();
+    }
+}

tests/Advanced/Shared/Core/Entity/BlogEntry.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Shared\Core\Entity;
+
+class BlogEntry
+{
+}

tests/Advanced/Shared/Core/Entity/User.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Shared\Core\Entity;
+
+class User
+{
+}

tests/Advanced/Shared/Core/InvalidService.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Shared\Core;
+
+use MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Blog\Core\BlogService;
+use MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\User\Core\UserService;
+
+class InvalidService
+{
+    public function __construct(BlogService $blogService, UserService $userService)
+    {
+        $blogService->getEntry();
+        $userService->getUser();
+    }
+}

tests/Advanced/User/Core/InvalidUserService.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\User\Core;
+
+use MintwareDe\Tests\PhpStanNamespaceConstraints\Advanced\Blog\Core\BlogService;
+
+class InvalidUserService
+{
+    public function __construct(BlogService $blogService)
+    {
+        $blogService->getEntry();
+    }
+}