From 8fd73ba860f7204bfdb6d9f90e3e1aa2fe3fe5d4 Mon Sep 17 00:00:00 2001
From: dpi <pro@danielph.in>
Date: Tue, 21 Nov 2023 13:37:42 +0800
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Require=20multiline=20constructor?=
 =?UTF-8?q?=20parameters=20and=20trailing=20comma=20(#75)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 PreviousNextDrupal/ruleset.xml                | 10 ++++++
 README.md                                     |  2 ++
 .../RequireMultiLineMethodSignatureTest.php   | 27 ++++++++++++++++
 .../RequireTrailingCommaInDeclarationTest.php | 32 +++++++++++++++++++
 .../RequireMultiLineMethodSignatureError.php  | 18 +++++++++++
 ...RequireMultiLineMethodSignatureNoError.php | 21 ++++++++++++
 ...RequireTrailingCommaInDeclarationError.php | 21 ++++++++++++
 ...quireTrailingCommaInDeclarationNoError.php | 21 ++++++++++++
 ...ingCommaInDeclarationSingleLineNoError.php | 18 +++++++++++
 9 files changed, 170 insertions(+)
 create mode 100644 tests/Sniffs/RequireMultiLineMethodSignatureTest.php
 create mode 100644 tests/Sniffs/RequireTrailingCommaInDeclarationTest.php
 create mode 100644 tests/Sniffs/fixtures/RequireMultiLineMethodSignatureError.php
 create mode 100644 tests/Sniffs/fixtures/RequireMultiLineMethodSignatureNoError.php
 create mode 100644 tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationError.php
 create mode 100644 tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationNoError.php
 create mode 100644 tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationSingleLineNoError.php

diff --git a/PreviousNextDrupal/ruleset.xml b/PreviousNextDrupal/ruleset.xml
index 09b1e7a..ebf7666 100644
--- a/PreviousNextDrupal/ruleset.xml
+++ b/PreviousNextDrupal/ruleset.xml
@@ -24,8 +24,18 @@
         </properties>
     </rule>
 
+    <rule ref="SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature">
+        <properties>
+            <property name="minLineLength" value="80"/>
+            <property name="includedMethodPatterns" type="array">
+                <element value="/__construct/" />
+            </property>
+        </properties>
+    </rule>
+
     <!-- SlevomatCodingStandard.Functions -->
     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall" />
+    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration" />
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
 
     <!-- SlevomatCodingStandard.Namespaces -->
diff --git a/README.md b/README.md
index dea2c81..e1d6ee8 100644
--- a/README.md
+++ b/README.md
@@ -130,7 +130,9 @@ function doesAThing(array $data): int {
 
 #### PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose
 #### SlevomatCodingStandard.Classes.ClassStructure
+#### SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature
 #### SlevomatCodingStandard.Functions.RequireTrailingCommaInCall
+#### SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration
 #### SlevomatCodingStandard.Functions.StaticClosure
 #### SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure
 #### SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses
diff --git a/tests/Sniffs/RequireMultiLineMethodSignatureTest.php b/tests/Sniffs/RequireMultiLineMethodSignatureTest.php
new file mode 100644
index 0000000..533975e
--- /dev/null
+++ b/tests/Sniffs/RequireMultiLineMethodSignatureTest.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs;
+
+/**
+ * @covers \SlevomatCodingStandard\Sniffs\Classes\RequireMultiLineMethodSignatureSniff
+ */
+final class RequireMultiLineMethodSignatureTest extends Base {
+
+  public function testNoError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/RequireMultiLineMethodSignatureNoError.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+  public function testError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/RequireMultiLineMethodSignatureError.php');
+    self::assertSame(1, $report->getErrorCount());
+    self::assertSniffError($report, 15, sniffName: 'SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature', code: 'RequiredMultiLineSignature');
+  }
+
+  protected static function getSniffName(): string {
+    return 'SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature';
+  }
+
+}
diff --git a/tests/Sniffs/RequireTrailingCommaInDeclarationTest.php b/tests/Sniffs/RequireTrailingCommaInDeclarationTest.php
new file mode 100644
index 0000000..329efd1
--- /dev/null
+++ b/tests/Sniffs/RequireTrailingCommaInDeclarationTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs;
+
+/**
+ * @covers \SlevomatCodingStandard\Sniffs\Classes\RequireMultiLineMethodSignatureSniff
+ */
+final class RequireTrailingCommaInDeclarationTest extends Base {
+
+  public function testNoError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/RequireTrailingCommaInDeclarationNoError.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+  public function testNoErrorSingleLine(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/RequireTrailingCommaInDeclarationSingleLineNoError.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+  public function testError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/RequireTrailingCommaInDeclarationError.php');
+    self::assertSame(1, $report->getErrorCount());
+    self::assertSniffError($report, 17, sniffName: 'SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration', code: 'MissingTrailingComma');
+  }
+
+  protected static function getSniffName(): string {
+    return 'SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration';
+  }
+
+}
diff --git a/tests/Sniffs/fixtures/RequireMultiLineMethodSignatureError.php b/tests/Sniffs/fixtures/RequireMultiLineMethodSignatureError.php
new file mode 100644
index 0000000..c4ca6b6
--- /dev/null
+++ b/tests/Sniffs/fixtures/RequireMultiLineMethodSignatureError.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class RequireMultiLineMethodSignatureError {
+
+  /**
+   * Constructor.
+   */
+  public function __construct(protected string $fooBar, protected string $helloWorld) {
+  }
+
+}
diff --git a/tests/Sniffs/fixtures/RequireMultiLineMethodSignatureNoError.php b/tests/Sniffs/fixtures/RequireMultiLineMethodSignatureNoError.php
new file mode 100644
index 0000000..86e961c
--- /dev/null
+++ b/tests/Sniffs/fixtures/RequireMultiLineMethodSignatureNoError.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class RequireMultiLineMethodSignatureNoError {
+
+  /**
+   * Constructor.
+   */
+  public function __construct(
+    protected string $fooBar,
+    protected string $helloWorld,
+  ) {
+  }
+
+}
diff --git a/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationError.php b/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationError.php
new file mode 100644
index 0000000..33f838c
--- /dev/null
+++ b/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationError.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class RequireTrailingCommaInDeclarationError {
+
+  /**
+   * Constructor.
+   */
+  public function __construct(
+    protected string $fooBar,
+    protected string $helloWorld
+  ) {
+  }
+
+}
diff --git a/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationNoError.php b/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationNoError.php
new file mode 100644
index 0000000..5c90e2c
--- /dev/null
+++ b/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationNoError.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class RequireTrailingCommaInDeclarationNoError {
+
+  /**
+   * Constructor.
+   */
+  public function __construct(
+    protected string $fooBar,
+    protected string $helloWorld,
+  ) {
+  }
+
+}
diff --git a/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationSingleLineNoError.php b/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationSingleLineNoError.php
new file mode 100644
index 0000000..e971130
--- /dev/null
+++ b/tests/Sniffs/fixtures/RequireTrailingCommaInDeclarationSingleLineNoError.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class RequireTrailingCommaInDeclarationSingleLineNoError {
+
+  /**
+   * Constructor.
+   */
+  public function __construct(protected string $fooBar) {
+  }
+
+}