From 20014bdfa74ceef0e88faaa3bf06bef7a73122df Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Thu, 14 Sep 2023 04:46:51 +0200
Subject: [PATCH] Remove `NamespaceDeclaration` sniff in favour of similar from
 PHPCSExtra

---
 .../NamespaceDeclarationStandard.xml          |  65 -----------
 .../Namespaces/NamespaceDeclarationSniff.php  | 110 ------------------
 .../NamespaceDeclarationUnitTest.1.inc        |   8 --
 .../NamespaceDeclarationUnitTest.2.inc        |  11 --
 .../NamespaceDeclarationUnitTest.php          |  49 --------
 Yoast/ruleset.xml                             |   9 ++
 6 files changed, 9 insertions(+), 243 deletions(-)
 delete mode 100644 Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml
 delete mode 100644 Yoast/Sniffs/Namespaces/NamespaceDeclarationSniff.php
 delete mode 100644 Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.1.inc
 delete mode 100644 Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.2.inc
 delete mode 100644 Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.php

diff --git a/Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml b/Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml
deleted file mode 100644
index 2bd53679..00000000
--- a/Yoast/Docs/Namespaces/NamespaceDeclarationStandard.xml
+++ /dev/null
@@ -1,65 +0,0 @@
-<?xml version="1.0"?>
-<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
-    title="Namespace Declarations"
-    >
-    <standard>
-    <![CDATA[
-    Scoped namespace declarations are not allowed.
-    ]]>
-    </standard>
-    <code_comparison>
-        <code title="Valid: Non-scoped namespace declaration.">
-        <![CDATA[
-namespace Yoast\Sub<em>;</em>
-        ]]>
-        </code>
-        <code title="Invalid: Scoped namespace declaration.">
-        <![CDATA[
-namespace Yoast\Scoped <em>{</em>
-    // Code.
-<em>}</em>
-        ]]>
-        </code>
-    </code_comparison>
-
-    <standard>
-    <![CDATA[
-    Namespace declarations without a namespace name are not allowed.
-    ]]>
-    </standard>
-    <code_comparison>
-        <code title="Valid: Named namespace declaration.">
-        <![CDATA[
-namespace <em>Yoast\Sub</em>;
-        ]]>
-        </code>
-        <code title="Invalid: Namespace declaration without a name (=global namespace).">
-        <![CDATA[
-namespace<em></em>;
-        ]]>
-        </code>
-    </code_comparison>
-
-    <standard>
-    <![CDATA[
-    There should be only one namespace declaration per file.
-    ]]>
-    </standard>
-    <code_comparison>
-        <code title="Valid: One named namespace declaration in a file.">
-        <![CDATA[
-namespace Yoast\Sub;
-        ]]>
-        </code>
-        <code title="Invalid: Multiple namespace declarations in a file.">
-        <![CDATA[
-namespace Yoast\Sub\A {
-}
-
-<em>namespace Yoast\Sub\B {
-}</em>
-        ]]>
-        </code>
-    </code_comparison>
-</documentation>
diff --git a/Yoast/Sniffs/Namespaces/NamespaceDeclarationSniff.php b/Yoast/Sniffs/Namespaces/NamespaceDeclarationSniff.php
deleted file mode 100644
index 1d9179a3..00000000
--- a/Yoast/Sniffs/Namespaces/NamespaceDeclarationSniff.php
+++ /dev/null
@@ -1,110 +0,0 @@
-<?php
-
-namespace YoastCS\Yoast\Sniffs\Namespaces;
-
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Sniffs\Sniff;
-use PHP_CodeSniffer\Util\Tokens;
-
-/**
- * Verify namespace declarations.
- *
- * This sniff:
- * - Forbids the use of namespace declarations without a namespace name.
- * - Forbids the use of scoped namespace declarations.
- * - Forbids having more than one namespace declaration in a file.
- *
- * {@internal This sniff might be a good candidate for pulling upstream in PHPCS
- * itself. An issue to that effect should be opened to see if there is interest.}}
- *
- * @package Yoast\YoastCS
- * @author  Juliette Reinders Folmer
- *
- * @since   1.2.0
- */
-class NamespaceDeclarationSniff implements Sniff {
-
-	/**
-	 * Returns an array of tokens this test wants to listen for.
-	 *
-	 * @return (int|string)[]
-	 */
-	public function register() {
-		return [
-			\T_OPEN_TAG,
-		];
-	}
-
-	/**
-	 * Processes this test, when one of its tokens is encountered.
-	 *
-	 * @param File $phpcsFile The file being scanned.
-	 * @param int  $stackPtr  The position of the current token in the stack passed in $tokens.
-	 *
-	 * @return int Stack pointer to skip the rest of the file.
-	 */
-	public function process( File $phpcsFile, $stackPtr ) {
-
-		$tokens = $phpcsFile->getTokens();
-
-		$statements = [];
-
-		while ( ( $stackPtr = $phpcsFile->findNext( \T_NAMESPACE, ( $stackPtr + 1 ) ) ) !== false ) {
-
-			$next_non_empty = $phpcsFile->findNext( Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true );
-			if ( $next_non_empty === false ) {
-				// Live coding or parse error.
-				break;
-			}
-
-			if ( $tokens[ $next_non_empty ]['code'] === \T_NS_SEPARATOR ) {
-				// Not a namespace declaration, but the use of the namespace keyword as operator.
-				continue;
-			}
-
-			// OK, found a namespace declaration.
-			$statements[] = $stackPtr;
-
-			if ( isset( $tokens[ $stackPtr ]['scope_condition'] )
-				&& $tokens[ $stackPtr ]['scope_condition'] === $stackPtr
-			) {
-				// Scoped namespace declaration.
-				$phpcsFile->addError(
-					'Scoped namespace declarations are not allowed.',
-					$stackPtr,
-					'ScopedForbidden'
-				);
-			}
-
-			if ( $tokens[ $next_non_empty ]['code'] === \T_SEMICOLON
-				|| $tokens[ $next_non_empty ]['code'] === \T_OPEN_CURLY_BRACKET
-			) {
-				// Namespace declaration without namespace name (= global namespace).
-				$phpcsFile->addError(
-					'Namespace declarations without a namespace name are not allowed.',
-					$stackPtr,
-					'NoNameForbidden'
-				);
-			}
-		}
-
-		$count = \count( $statements );
-		if ( $count > 1 ) {
-			$data = [
-				$count,
-				$tokens[ $statements[0] ]['line'],
-			];
-
-			for ( $i = 1; $i < $count; $i++ ) {
-				$phpcsFile->addError(
-					'There should be only one namespace declaration per file. Found %d namespace declarations. The first declaration was found on line %d',
-					$statements[ $i ],
-					'MultipleFound',
-					$data
-				);
-			}
-		}
-
-		return ( $phpcsFile->numTokens + 1 );
-	}
-}
diff --git a/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.1.inc b/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.1.inc
deleted file mode 100644
index 0127313d..00000000
--- a/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.1.inc
+++ /dev/null
@@ -1,8 +0,0 @@
-<?php
-
-namespace Yoast\ValidDeclaration;
-
-echo namespace\ClassName::$property; // Ok, not namespace declaration.
-
-// Intentional parse error. This has to be the last test in the file.
-namespace
diff --git a/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.2.inc b/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.2.inc
deleted file mode 100644
index 7c5180d7..00000000
--- a/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.2.inc
+++ /dev/null
@@ -1,11 +0,0 @@
-<?php
-
-namespace; // Error - no name. (Intentional parse error)
-
-namespace {} // Error x 3 - no name + scoped namespace declaration + not the only namespace declaration in the file.
-
-namespace Yoast\SecondScopedNamespace {} // Error x 2 - scoped namespace declaration + not the only namespace declaration in the file.
-
-namespace /* some comment */ {} // Error x 3 - no name + scoped namespace declaration + not the only namespace declaration in the file.
-
-namespace /* some comment */; // Error x 2 - no name + not the only namespace declaration in the file. (Intentional parse error)
diff --git a/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.php b/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.php
deleted file mode 100644
index 59fa79e8..00000000
--- a/Yoast/Tests/Namespaces/NamespaceDeclarationUnitTest.php
+++ /dev/null
@@ -1,49 +0,0 @@
-<?php
-
-namespace YoastCS\Yoast\Tests\Namespaces;
-
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
-
-/**
- * Unit test class for the NamespaceDeclaration sniff.
- *
- * @package Yoast\YoastCS
- *
- * @since   1.2.0
- *
- * @covers  YoastCS\Yoast\Sniffs\Namespaces\NamespaceDeclarationSniff
- */
-class NamespaceDeclarationUnitTest extends AbstractSniffUnitTest {
-
-	/**
-	 * Returns the lines where errors should occur.
-	 *
-	 * @param string $testFile The name of the file being tested.
-	 *
-	 * @return array <int line number> => <int number of errors>
-	 */
-	public function getErrorList( $testFile = '' ) {
-		switch ( $testFile ) {
-			case 'NamespaceDeclarationUnitTest.2.inc':
-				return [
-					3  => 1,
-					5  => 3,
-					7  => 2,
-					9  => 3,
-					11 => 2,
-				];
-
-			default:
-				return [];
-		}
-	}
-
-	/**
-	 * Returns the lines where warnings should occur.
-	 *
-	 * @return array <int line number> => <int number of warnings>
-	 */
-	public function getWarningList() {
-		return [];
-	}
-}
diff --git a/Yoast/ruleset.xml b/Yoast/ruleset.xml
index 72acbfb9..82a53fc3 100644
--- a/Yoast/ruleset.xml
+++ b/Yoast/ruleset.xml
@@ -142,6 +142,15 @@
 	<!-- Demand that "else(if)" is on a new line after the scope closer of the preceding if. -->
 	<rule ref="Universal.ControlStructures.IfElseDeclaration"/>
 
+	<!-- Disallow namespace declarations without a namespace name. -->
+	<rule ref="Universal.Namespaces.DisallowDeclarationWithoutName"/>
+
+	<!-- Disallow namespace declarations using the curly brace syntax. -->
+	<rule ref="Universal.Namespaces.DisallowCurlyBraceSyntax"/>
+
+	<!-- Disallow declaring multiple namespaces within one file. -->
+	<rule ref="Universal.Namespaces.OneDeclarationPerFile"/>
+
 	<!-- Error prevention: Make sure the condition in a inline if declaration is bracketed. -->
 	<rule ref="Squiz.ControlStructures.InlineIfDeclaration"/>