SlevomatCodingStandard.Classes.ClassStructure: Support for "invoke method" group

Author: kukulich

SlevomatCodingStandard/Sniffs/Classes/ClassStructureSniff.php

@@ -60,6 +60,7 @@ class ClassStructureSniff implements Sniff
 	private const GROUP_CONSTRUCTOR = 'constructor';
 	private const GROUP_STATIC_CONSTRUCTORS = 'static constructors';
 	private const GROUP_DESTRUCTOR = 'destructor';
+	private const GROUP_INVOKE_METHOD = 'invoke method';
 	private const GROUP_MAGIC_METHODS = 'magic methods';
 	private const GROUP_PUBLIC_METHODS = 'public methods';
 	private const GROUP_PUBLIC_ABSTRACT_METHODS = 'public abstract methods';
@@ -174,7 +175,7 @@ class ClassStructureSniff implements Sniff
 		'__serialize' => self::GROUP_MAGIC_METHODS,
 		'__unserialize' => self::GROUP_MAGIC_METHODS,
 		'__tostring' => self::GROUP_MAGIC_METHODS,
-		'__invoke' => self::GROUP_MAGIC_METHODS,
+		'__invoke' => self::GROUP_INVOKE_METHOD,
 		'__set_state' => self::GROUP_MAGIC_METHODS,
 		'__clone' => self::GROUP_MAGIC_METHODS,
 		'__debuginfo' => self::GROUP_MAGIC_METHODS,
@@ -217,6 +218,11 @@ public function process(File $phpcsFile, $pointer): int
 
 			[$groupFirstMemberPointer, $groupLastMemberPointer, $group] = $nextGroup;
 
+			// Use "magic methods" group for __invoke() when "invoke" group is not explicitly defined
+			if ($group === self::GROUP_INVOKE_METHOD && !array_key_exists($group, $groupsOrder)) {
+				$group = self::GROUP_MAGIC_METHODS;
+			}
+
 			if ($groupsOrder[$group] >= ($groupsOrder[$expectedGroup] ?? 0)) {
 				$groupsFirstMembers[$group] = $groupFirstMemberPointer;
 				$expectedGroup = $group;
@@ -594,6 +600,7 @@ private function getNormalizedGroups(): array
 					if (
 						!in_array($groupOrShortcut, $supportedGroups, true)
 						&& !array_key_exists($groupOrShortcut, self::SHORTCUTS)
+						&& $groupOrShortcut !== self::GROUP_INVOKE_METHOD
 					) {
 						throw new UnsupportedClassGroupException($groupOrShortcut);
 					}
@@ -606,7 +613,7 @@ private function getNormalizedGroups(): array
 
 			$normalizedGroups = [];
 			foreach ($normalizedGroupsWithShortcuts as $groupOrShortcut => $groupOrder) {
-				if (in_array($groupOrShortcut, $supportedGroups, true)) {
+				if (in_array($groupOrShortcut, $supportedGroups, true) || $groupOrShortcut === self::GROUP_INVOKE_METHOD) {
 					$normalizedGroups[$groupOrShortcut] = $groupOrder;
 				} else {
 					foreach ($this->unpackShortcut($groupOrShortcut, $supportedGroups) as $group) {

doc/classes.md

@@ -51,7 +51,7 @@ uses,
 enum cases,
 public constants, protected constants, private constants,
 public properties, public static properties, protected properties, protected static properties, private properties, private static properties,
-constructor, static constructors, destructor, magic methods,
+constructor, static constructors, destructor, magic methods, invoke method
 public methods, protected methods, private methods,
 public final methods, public static final methods, protected final methods, protected static final methods,
 public abstract methods, public static abstract methods, protected abstract methods, protected static abstract methods,

tests/Sniffs/Classes/ClassStructureSniffTest.php

@@ -18,6 +18,7 @@ class ClassStructureSniffTest extends TestCase
 		'public abstract methods, public methods, protected abstract methods, protected methods, private methods',
 		'constructor, destructor',
 		'static constructors',
+		'invoke method',
 		'methods',
 		'public final methods',
 		'public static final methods',
@@ -92,7 +93,7 @@ public function testErrorsWithDifferentRules(): void
 			['groups' => self::DIFFERENT_RULES],
 		);
 
-		self::assertSame(16, $report->getErrorCount());
+		self::assertSame(17, $report->getErrorCount());
 
 		self::assertSniffError($report, 6, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
 		self::assertSniffError($report, 12, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
@@ -111,6 +112,7 @@ public function testErrorsWithDifferentRules(): void
 		self::assertSniffError($report, 114, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
 		self::assertSniffError($report, 118, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
 		self::assertSniffError($report, 122, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+		self::assertSniffError($report, 126, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
 
 		self::assertAllFixedInFile($report);
 	}

tests/Sniffs/Classes/data/classStructureSniffErrorsWithDifferentRules.fixed.php

@@ -107,6 +107,10 @@ public static function staticConstructor() : self
 	{
 	}
 
+	public function __invoke()
+	{
+	}
+
 	public final function publicFinal()
 	{
 	}

tests/Sniffs/Classes/data/classStructureSniffErrorsWithDifferentRules.php

@@ -123,4 +123,8 @@ public final function publicFinal()
 	{
 	}
 
+	public function __invoke()
+	{
+	}
+
 }

tests/Sniffs/Classes/data/classStructureSniffNoErrors.php

@@ -158,6 +158,10 @@ private function __call($name, $arguments)
 	{
 	}
 
+	public function __invoke()
+	{
+	}
+
 	public function __get($name)
 	{
 	}