From 72657e1bf419f7d75c1bff325366a7bfb6b698fa Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Fri, 22 Jul 2022 22:42:52 +0200
Subject: [PATCH] :sparkles: New `Universal.WhiteSpace.AnonClassKeywordSpacing`
 sniff

Checks the amount of spacing between the `class` keyword and the open parenthesis (if any) for anonymous class declarations.

The expected amount of spacing is configurable and defaults to `0`.

The default value of `0` has been decided upon based on scanning a not insignificant number of codebases and determining the prevailing style used for anonymous classes.
It is also in line with the previously proposed [errata for PSR12](https://github.com/php-fig/fig-standards/pull/1206).

Includes fixer.
Includes unit tests.
Includes documentation.
Includes metrics.
---
 .../AnonClassKeywordSpacingStandard.xml       |  28 +++++
 .../AnonClassKeywordSpacingSniff.php          |  83 ++++++++++++++
 .../AnonClassKeywordSpacingUnitTest.inc       | 103 ++++++++++++++++++
 .../AnonClassKeywordSpacingUnitTest.inc.fixed | 100 +++++++++++++++++
 .../AnonClassKeywordSpacingUnitTest.php       |  63 +++++++++++
 5 files changed, 377 insertions(+)
 create mode 100644 Universal/Docs/WhiteSpace/AnonClassKeywordSpacingStandard.xml
 create mode 100644 Universal/Sniffs/WhiteSpace/AnonClassKeywordSpacingSniff.php
 create mode 100644 Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc
 create mode 100644 Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc.fixed
 create mode 100644 Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.php

diff --git a/Universal/Docs/WhiteSpace/AnonClassKeywordSpacingStandard.xml b/Universal/Docs/WhiteSpace/AnonClassKeywordSpacingStandard.xml
new file mode 100644
index 00000000..4eff64c3
--- /dev/null
+++ b/Universal/Docs/WhiteSpace/AnonClassKeywordSpacingStandard.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<documentation title="Anonymous Class Keyword Spacing">
+    <standard>
+    <![CDATA[
+    Checks the spacing between the "class" keyword and the open parenthesis for anonymous classes with parentheses.
+
+    The desired amount of spacing is configurable and defaults to no space.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: No space between the class keyword and the open parenthesis.">
+        <![CDATA[
+$foo = new <em>class(</em>$param)
+{
+    public function __construct($p) {}
+};
+        ]]>
+        </code>
+        <code title="Invalid: Space between the class keyword and the open parenthesis.">
+        <![CDATA[
+$foo = new <em>class (</em>$param)
+{
+    public function __construct($p) {}
+};
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>
diff --git a/Universal/Sniffs/WhiteSpace/AnonClassKeywordSpacingSniff.php b/Universal/Sniffs/WhiteSpace/AnonClassKeywordSpacingSniff.php
new file mode 100644
index 00000000..f823fc28
--- /dev/null
+++ b/Universal/Sniffs/WhiteSpace/AnonClassKeywordSpacingSniff.php
@@ -0,0 +1,83 @@
+<?php
+/**
+ * PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
+ *
+ * @package   PHPCSExtra
+ * @copyright 2020 PHPCSExtra Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSExtra
+ */
+
+namespace PHPCSExtra\Universal\Sniffs\WhiteSpace;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\Fixers\SpacesFixer;
+
+/**
+ * Checks the spacing between the "class" keyword and the open parenthesis for anonymous classes with parentheses.
+ *
+ * @since 1.0.0
+ */
+final class AnonClassKeywordSpacingSniff implements Sniff
+{
+
+    /**
+     * The amount of spacing to demand between the class keyword and the open parenthesis.
+     *
+     * @var int
+     */
+    public $spacing = 0;
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @since 1.0.0
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return [\T_ANON_CLASS];
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @since 1.0.0
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+     * @param int                         $stackPtr  The position of the current token
+     *                                               in the stack passed in $tokens.
+     *
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Check if there are parentheses.
+        $tokens = $phpcsFile->getTokens();
+
+        $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
+        if ($nextNonEmpty === false || $tokens[$nextNonEmpty]['code'] !== \T_OPEN_PARENTHESIS) {
+            return;
+        }
+
+        // Check spacing
+        // Auto-fix when not a comment bteween.
+        SpacesFixer::checkAndFix(
+            $phpcsFile,
+            $stackPtr,
+            $nextNonEmpty,
+            (int) $this->spacing,
+            'There must be %1$s between the class keyword and the open parenthesis for an anonymous class. Found: %2$s',
+            'Incorrect',
+            'error',
+            0,
+            'Anon class: space between keyword and open parenthesis'
+        );
+
+        // $phpcsFile->recordMetric($reportPtr, self::METRIC_NAME_SRC, 'same namespace');
+        // $phpcsFile->addError($error, $reportPtr, $errorCode, $data);
+    }
+}
diff --git a/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc b/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc
new file mode 100644
index 00000000..fc238705
--- /dev/null
+++ b/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc
@@ -0,0 +1,103 @@
+<?php
+
+/*
+ * OK.
+ */
+$anon = new class; // Parse error, not our concern.
+
+// No parentheses, not our concern.
+$anon = new class {};
+$anon = new class
+{
+	function foo();
+};
+
+$anonWithAttribute = new #[SomeAttribute('summary')] class {
+    public const SOME_STUFF = 'foo';
+};
+
+/*
+ * Default setting of 0 spaces.
+ */
+
+// Correct spacing between keyword and parentheses.
+$anon = new class() {};
+$anon = new class($paramA, $paramB) {};
+
+// Incorrect spacing - too much space.
+$anon = new class () {};
+$anon = new class      ($foo) {};
+$anon = new class
+	($foo)
+{
+	function foo();
+};
+
+// Incorrect spacing - comment between keyword and parentheses, not auto-fixable.
+$anon = new class/*comment*/() {};
+$anon = new class   /*comment*/   ($foo) {};
+$anon = new class // comment.
+	($foo)
+{
+	function foo();
+};
+
+/*
+ * Custom setting of 1 space.
+ */
+
+// phpcs:set Universal.WhiteSpace.AnonClassKeywordSpacing spacing 1
+
+// Correct spacing between keyword and parentheses.
+$anon = new class () {};
+$anon = new class ($paramA, $paramB) {};
+
+// Incorrect spacing - too little space.
+$anon = new class() {};
+$anon = new class($paramA, $paramB) {};
+
+// Incorrect spacing - too much space.
+$anon = new class      ($foo) {};
+$anon = new class
+	($foo)
+{
+	function foo();
+};
+
+// Incorrect spacing - comment between keyword and parentheses, not auto-fixable.
+$anon = new class/*comment*/() {};
+$anon = new class   /*comment*/   ($foo) {};
+$anon = new class // comment.
+	($foo)
+{
+	function foo();
+};
+
+/*
+ * Custom setting of 4 spaces.
+ */
+
+// phpcs:set Universal.WhiteSpace.AnonClassKeywordSpacing spacing 4
+
+// Correct spacing between keyword and parentheses.
+$anon = new class    () {};
+$anon = new class    ($paramA, $paramB) {};
+
+// Incorrect spacing - too little space.
+$anon = new class() {};
+$anon = new class  ($paramA, $paramB) {};
+
+// Incorrect spacing - too much space.
+$anon = new class       () {};
+$anon = new class       ($foo) {};
+$anon = new class
+	($foo)
+{
+	function foo();
+};
+
+// Reset property.
+// phpcs:set Universal.WhiteSpace.AnonClassKeywordSpacing spacing 0
+
+// Live coding - this has to be the last test in the file without a new line after it.
+$anon = new class
\ No newline at end of file
diff --git a/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc.fixed b/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc.fixed
new file mode 100644
index 00000000..6a6f4c0a
--- /dev/null
+++ b/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.inc.fixed
@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * OK.
+ */
+$anon = new class; // Parse error, not our concern.
+
+// No parentheses, not our concern.
+$anon = new class {};
+$anon = new class
+{
+	function foo();
+};
+
+$anonWithAttribute = new #[SomeAttribute('summary')] class {
+    public const SOME_STUFF = 'foo';
+};
+
+/*
+ * Default setting of 0 spaces.
+ */
+
+// Correct spacing between keyword and parentheses.
+$anon = new class() {};
+$anon = new class($paramA, $paramB) {};
+
+// Incorrect spacing - too much space.
+$anon = new class() {};
+$anon = new class($foo) {};
+$anon = new class($foo)
+{
+	function foo();
+};
+
+// Incorrect spacing - comment between keyword and parentheses, not auto-fixable.
+$anon = new class/*comment*/() {};
+$anon = new class   /*comment*/   ($foo) {};
+$anon = new class // comment.
+	($foo)
+{
+	function foo();
+};
+
+/*
+ * Custom setting of 1 space.
+ */
+
+// phpcs:set Universal.WhiteSpace.AnonClassKeywordSpacing spacing 1
+
+// Correct spacing between keyword and parentheses.
+$anon = new class () {};
+$anon = new class ($paramA, $paramB) {};
+
+// Incorrect spacing - too little space.
+$anon = new class () {};
+$anon = new class ($paramA, $paramB) {};
+
+// Incorrect spacing - too much space.
+$anon = new class ($foo) {};
+$anon = new class ($foo)
+{
+	function foo();
+};
+
+// Incorrect spacing - comment between keyword and parentheses, not auto-fixable.
+$anon = new class/*comment*/() {};
+$anon = new class   /*comment*/   ($foo) {};
+$anon = new class // comment.
+	($foo)
+{
+	function foo();
+};
+
+/*
+ * Custom setting of 4 spaces.
+ */
+
+// phpcs:set Universal.WhiteSpace.AnonClassKeywordSpacing spacing 4
+
+// Correct spacing between keyword and parentheses.
+$anon = new class    () {};
+$anon = new class    ($paramA, $paramB) {};
+
+// Incorrect spacing - too little space.
+$anon = new class    () {};
+$anon = new class    ($paramA, $paramB) {};
+
+// Incorrect spacing - too much space.
+$anon = new class    () {};
+$anon = new class    ($foo) {};
+$anon = new class    ($foo)
+{
+	function foo();
+};
+
+// Reset property.
+// phpcs:set Universal.WhiteSpace.AnonClassKeywordSpacing spacing 0
+
+// Live coding - this has to be the last test in the file without a new line after it.
+$anon = new class
\ No newline at end of file
diff --git a/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.php b/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.php
new file mode 100644
index 00000000..f5a9ce76
--- /dev/null
+++ b/Universal/Tests/WhiteSpace/AnonClassKeywordSpacingUnitTest.php
@@ -0,0 +1,63 @@
+<?php
+/**
+ * PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
+ *
+ * @package   PHPCSExtra
+ * @copyright 2020 PHPCSExtra Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSExtra
+ */
+
+namespace PHPCSExtra\Universal\Tests\WhiteSpace;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the AnonClassKeywordSpacing sniff.
+ *
+ * @covers PHPCSExtra\Universal\Sniffs\WhiteSpace\AnonClassKeywordSpacingSniff
+ *
+ * @since 1.0.0
+ */
+final class AnonClassKeywordSpacingUnitTest extends AbstractSniffUnitTest
+{
+
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * @return array<int, int>
+     */
+    public function getErrorList()
+    {
+        return [
+            28 => 1,
+            29 => 1,
+            30 => 1,
+            37 => 1,
+            38 => 1,
+            39 => 1,
+            56 => 1,
+            57 => 1,
+            60 => 1,
+            61 => 1,
+            68 => 1,
+            69 => 1,
+            70 => 1,
+            87 => 1,
+            88 => 1,
+            91 => 1,
+            92 => 1,
+            93 => 1,
+        ];
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * @return array<int, int>
+     */
+    public function getWarningList()
+    {
+        return [];
+    }
+}