feat: blacklist use of namespaces. ban use of Knp timestampable

Author: JJuszczyk

Markup/Sniffs/Usage/NamespaceOverwrittenSniff.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+namespace Markup\Sniffs\Usage;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\UseStatementHelper;
+
+class NamespaceOverwrittenSniff implements Sniff
+{
+    private const BLACKLIST_NAMESPACES = [
+        [
+            'namespace' => 'Knp\\DoctrineBehaviors\\Model\\Timestampable\\Timestampable',
+            'require_use' => 'Phoenix\\Common\\Database\\Doctrine\\Entity\\Timestampable',
+        ],
+    ];
+
+    /**
+     * @return mixed[]
+     */
+    public function register()
+    {
+        return [
+            T_OPEN_TAG,
+        ];
+    }
+
+    /**
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile
+     * @param int $openTagPointer
+     */
+    public function process(File $phpcsFile, $openTagPointer)
+    {
+        $useStatements = UseStatementHelper::getUseStatements($phpcsFile, $openTagPointer);
+
+        foreach ($useStatements as $useStatement) {
+            foreach (self::BLACKLIST_NAMESPACES as $namespace) {
+                if (stripos($useStatement->getFullyQualifiedTypeName(), $namespace['namespace']) !== false) {
+                    $phpcsFile->addError(
+                        sprintf(
+                            "Class is %s overwritten, use %s instead",
+                            $useStatement->getFullyQualifiedTypeName(),
+                            $namespace['require_use']
+                        ),
+                        $useStatement->getPointer(),
+                        'BlacklistedNamespace'
+                    );
+                }
+            }
+        }
+    }
+}

Markup/ruleset.xml

@@ -38,6 +38,9 @@
             <property name="spacingBeforeFirst" value="0" />
         </properties>
     </rule>
+    <rule ref="Markup.Usage.NamespaceOverwritten.BlacklistedNamespace">
+        <type>error</type>
+    </rule>
 
     <!-- Remove unused use statements -->
     <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php">