Updated coding standards

slevomat · Feb 10, 2023 · 920d249 · 920d249
1 parent 7ef3f24
commit 920d249
Show file tree

Hide file tree

Showing 11 changed files with 64 additions and 41 deletions.
diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
 		"phpstan/phpstan-phpunit": "^1.3.3",
 		"phpstan/phpstan-strict-rules": "^1.4.5",
 		"phpunit/phpunit": "^9.5.28",
-		"slevomat/coding-standard": "^7.2.0",
+		"slevomat/coding-standard": "^8.8",
 		"spell-checker/spell-checker": "^0.3.22",
 		"spell-checker/dictionary-en": "^0.1.1",
 		"squizlabs/php_codesniffer": "^3.7.1"

diff --git a/phpcs.xml b/phpcs.xml
@@ -104,13 +104,29 @@
 		</properties>
 	</rule>
 	<rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
+	<rule ref="SlevomatCodingStandard.Attributes.AttributeAndTargetSpacing"/>
+	<rule ref="SlevomatCodingStandard.Attributes.AttributesOrder">
+		<properties>
+			<property name="order" type="array">
+				<element value="Get"/>
+				<element value="Set"/>
+			</property>
+		</properties>
+	</rule>
+	<rule ref="SlevomatCodingStandard.Attributes.DisallowAttributesJoining"/>
+	<rule ref="SlevomatCodingStandard.Attributes.DisallowMultipleAttributesPerLine"/>
+	<rule ref="SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment"/>
+	<rule ref="SlevomatCodingStandard.Classes.BackedEnumTypeSpacing"/>
 	<rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility"/>
 	<rule ref="SlevomatCodingStandard.Classes.ClassMemberSpacing"/>
 	<rule ref="SlevomatCodingStandard.Classes.ClassStructure">
 		<properties>
 			<property name="groups" type="array">
 				<element value="uses"/>
-				<element value="constants"/>
+				<element value="enum cases"/>
+				<element value="public constants"/>
+				<element value="protected constants"/>
+				<element value="private constants"/>
 				<element value="properties"/>
 				<element value="constructor"/>
 				<element value="static constructors"/>
@@ -132,11 +148,13 @@
 	<rule ref="SlevomatCodingStandard.Classes.MethodSpacing"/>
 	<rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
 	<rule ref="SlevomatCodingStandard.Classes.ParentCallSpacing"/>
-	<rule ref="SlevomatCodingStandard.Classes.PropertySpacing">
+	<rule ref="SlevomatCodingStandard.Classes.PropertyDeclaration">
 		<properties>
-			<property name="minLinesCountBeforeWithComment" value="0"/>
+			<property name="checkPromoted" value="true"/>
+			<property name="enableMultipleSpacesBetweenModifiersCheck" value="true"/>
 		</properties>
 	</rule>
+	<rule ref="SlevomatCodingStandard.Classes.PropertySpacing"/>
 	<rule ref="SlevomatCodingStandard.Classes.RequireConstructorPropertyPromotion"/>
 	<rule ref="SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature">
 		<properties>
@@ -153,6 +171,7 @@
 	</rule>
 	<rule ref="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming">
 		<exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming.SuperfluousSuffix"/>
+		<rule ref="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>
 	</rule>
 	<rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration"/>
 	<rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing"/>
@@ -172,8 +191,7 @@
 					@see,
 				"/>
 				<element value="
-					@get,
-					@set,
+					@var,
 				"/>
 				<element value="
 					@param,
@@ -201,8 +219,9 @@
 				<element value="@copyright"/>
 				<element value="@license"/>
 				<element value="@package"/>
-				<element value="@throws"/>
 				<element value="@version"/>
+				<element value="@get"/>
+				<element value="@set"/>
 			</property>
 		</properties>
 	</rule>
@@ -305,9 +324,24 @@
 			<property name="allowMultiLine" value="true"/>
 		</properties>
 	</rule>
-	<rule ref="SlevomatCodingStandard.Functions.DisallowNamedArguments"/>
+	<rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall">
+		<properties>
+			<property name="onlySingleLine" value="true"/>
+		</properties>
+	</rule>
+	<rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse">
+		<properties>
+			<property name="onlySingleLine" value="true"/>
+		</properties>
+	</rule>
+	<rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration">
+		<properties>
+			<property name="onlySingleLine" value="true"/>
+		</properties>
+	</rule>
 	<rule ref="SlevomatCodingStandard.Functions.RequireArrowFunction"/>
 	<rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall"/>
+	<rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse"/>
 	<rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
 	<rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>
 	<rule ref="SlevomatCodingStandard.Functions.StrictCall"/>
@@ -321,7 +355,6 @@
 	<rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly">
 		<properties>
 			<property name="searchAnnotations" value="true"/>
-			<property name="fullyQualifiedKeywords" type="array" value=""/>
 			<property name="allowFallbackGlobalFunctions" value="false"/>
 			<property name="allowFallbackGlobalConstants" value="false"/>
 			<property name="allowFullyQualifiedExceptions" value="false"/>
@@ -362,6 +395,7 @@
 			<property name="declareOnFirstLine" value="true"/>
 		</properties>
 	</rule>
+	<rule ref="SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntax"/>
 	<rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
 	<rule ref="SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition"/>
 	<rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
@@ -381,7 +415,6 @@
 			</property>
 		</properties>
 	</rule>
-	<rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHintSpacing"/>
 	<rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
 		<properties>
 			<property name="traversableTypeHints" type="array">
@@ -401,7 +434,7 @@
 		</properties>
 	</rule>
 	<rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint"/>
-	<!--<rule ref="SlevomatCodingStandard.Variables.DisallowSuperGlobalVariable"/>-->
+	<rule ref="SlevomatCodingStandard.Variables.DisallowSuperGlobalVariable" />
 	<rule ref="SlevomatCodingStandard.Variables.DuplicateAssignmentToVariable"/>
 	<rule ref="SlevomatCodingStandard.Variables.UnusedVariable"/>
 	<rule ref="SlevomatCodingStandard.Variables.UselessVariable"/>
@@ -458,7 +491,6 @@
 	</rule>
 	<rule ref="Squiz.PHP.DisallowMultipleAssignments"/>
 	<rule ref="Squiz.PHP.GlobalKeyword"/>
-	<rule ref="Squiz.PHP.Heredoc"/>
 	<rule ref="Squiz.PHP.InnerFunctions"/>
 	<rule ref="Squiz.PHP.LowercasePHPFunctions"/>
 	<rule ref="Squiz.PHP.NonExecutableCode"/>

diff --git a/src/AsyncMessageQueueManager.php b/src/AsyncMessageQueueManager.php
@@ -32,10 +32,10 @@ class AsyncMessageQueueManager
 
 	private PromiseTimer $promiseTimer;
 
-	/** @var mixed[] */
+	/** @var array<int, AsyncMessage> */
 	private array $messageQueue = [];
 
-	/** @var Deferred[] */
+	/** @var array<Deferred> */
 	private array $processingRequests = [];
 
 	private float $maxIntervalBetweenMessages;
@@ -161,7 +161,7 @@ public function getQueuedMessagesCount(): int
 	}
 
 	/**
-	 * @return mixed[]
+	 * @return array<mixed>
 	 */
 	public function getQueuedMessages(): array
 	{

diff --git a/src/Connector/ConnectorFactory.php b/src/Connector/ConnectorFactory.php
@@ -16,13 +16,13 @@ class ConnectorFactory
 
 	private bool $useSecureConnector;
 
-	/** @var mixed[][] */
+	/** @var array<array<mixed>> */
 	private array $context;
 
 	private int $timeoutInSeconds;
 
 	/**
-	 * @param mixed[][] $context
+	 * @param array<array<mixed>> $context
 	 */
 	public function __construct(
 		LoopInterface $loop,

diff --git a/src/Connector/TcpConnector.php b/src/Connector/TcpConnector.php
@@ -23,11 +23,11 @@ class TcpConnector implements ConnectorInterface
 
 	private LoopInterface $loop;
 
-	/** @var mixed[] */
+	/** @var array<mixed> */
 	private array $context;
 
 	/**
-	 * @param mixed[] $context
+	 * @param array<mixed> $context
 	 */
 	public function __construct(LoopInterface $loop, array $context = [])
 	{

diff --git a/src/Smtp/AsyncDoubleResponseMessage.php b/src/Smtp/AsyncDoubleResponseMessage.php
@@ -9,17 +9,17 @@ class AsyncDoubleResponseMessage implements AsyncMessage
 
 	private string $text;
 
-	/** @var int[] */
+	/** @var array<int> */
 	private array $expectedFirstResponseCodes = [];
 
-	/** @var int[] */
+	/** @var array<int> */
 	private array $expectedSecondResponseCodes = [];
 
 	private ?string $textReplacement = null;
 
 	/**
-	 * @param int[] $expectedFirstResponseCodes
-	 * @param int[] $expectedSecondResponseCodes
+	 * @param array<int> $expectedFirstResponseCodes
+	 * @param array<int> $expectedSecondResponseCodes
 	 */
 	public function __construct(
 		string $text,
@@ -40,15 +40,15 @@ public function getText(): string
 	}
 
 	/**
-	 * @return int[]
+	 * @return array<int>
 	 */
 	public function getExpectedFirstResponseCodes(): array
 	{
 		return $this->expectedFirstResponseCodes;
 	}
 
 	/**
-	 * @return int[]
+	 * @return array<int>
 	 */
 	public function getExpectedSecondResponseCodes(): array
 	{

diff --git a/src/Smtp/AsyncSingleResponseMessage.php b/src/Smtp/AsyncSingleResponseMessage.php
@@ -9,13 +9,13 @@ class AsyncSingleResponseMessage implements AsyncMessage
 
 	private string $text;
 
-	/** @var int[] */
+	/** @var array<int> */
 	private array $expectedResponseCodes = [];
 
 	private ?string $textReplacement = null;
 
 	/**
-	 * @param int[] $expectedResponseCodes
+	 * @param array<int> $expectedResponseCodes
 	 */
 	public function __construct(
 		string $text,
@@ -34,7 +34,7 @@ public function getText(): string
 	}
 
 	/**
-	 * @return int[]
+	 * @return array<int>
 	 */
 	public function getExpectedResponseCodes(): array
 	{

diff --git a/src/Smtp/AsyncSmtpConnectionWriter.php b/src/Smtp/AsyncSmtpConnectionWriter.php
@@ -23,7 +23,7 @@
 class AsyncSmtpConnectionWriter implements AsyncConnectionWriter
 {
 
-	/** @var mixed[][] */
+	/** @var array<array<mixed>> */
 	private array $expectedResponses = [];
 
 	private ConnectionInterface $connection;

diff --git a/tests/AsyncMessageQueueManagerTest.php b/tests/AsyncMessageQueueManagerTest.php
@@ -36,7 +36,7 @@ class AsyncMessageQueueManagerTest extends TestCase
 
 	private LoopInterface $loop;
 
-	/** @var mixed[] */
+	/** @var array<string, bool|string> */
 	private array $exceptions = [];
 
 	private int $disconnectsCount = 0;

diff --git a/tests/Smtp/AsyncSmtpConnectionWriterTest.php b/tests/Smtp/AsyncSmtpConnectionWriterTest.php
@@ -40,7 +40,7 @@ class AsyncSmtpConnectionWriterTest extends TestCase
 
 	private ?Closure $doOnError = null;
 
-	/** @var string[] */
+	/** @var array<string> */
 	private array $serverResponses;
 
 	private LoggerInterface $logger;
@@ -124,9 +124,6 @@ function (Throwable $exception): void {
 		);
 	}
 
-	/**
-	 * @return mixed[][]
-	 */
 	public function dataSuccessfulWrites(): array
 	{
 		return [
@@ -196,9 +193,6 @@ function (Throwable $exception): void {
 		);
 	}
 
-	/**
-	 * @return mixed[][]
-	 */
 	public function dataFailedWrites(): array
 	{
 		return [

diff --git a/tests/Smtp/AsyncSmtpMessageSenderTest.php b/tests/Smtp/AsyncSmtpMessageSenderTest.php
@@ -25,7 +25,7 @@ class AsyncSmtpMessageSenderTest extends TestCase
 
 	private LoopInterface $loop;
 
-	/** @var string[] */
+	/** @var array<string> */
 	private array $recipients = [];
 
 	protected function setUp(): void
@@ -45,9 +45,6 @@ public function testSuccessfulSendingReturnsPromise(): void
 		$this->runSuccessfulSendingTest($this->createMessage());
 	}
 
-	/**
-	 * @return mixed[][]
-	 */
 	public function dataFailedSendingThrowsException(): array
 	{
 		return [