✨ Add SlevomatCodingStandard.Classes.ClassStructure (#5)

Author: dpi

PreviousNextDrupal/ruleset.xml

@@ -6,6 +6,24 @@
     <!-- PSR2.Methods -->
     <rule ref="PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose"/>
 
+    <!-- SlevomatCodingStandard.Classes -->
+    <rule ref="SlevomatCodingStandard.Classes.ClassStructure">
+        <properties>
+            <property name="groups" type="array">
+                <element value="uses"/>
+                <element value="enum cases"/>
+                <element value="public constants"/>
+                <element value="constants"/>
+                <element value="properties"/>
+                <element value="constructor"/>
+                <!-- We cant order by public/protected methods yet as it would
+                     make PHPUnit setup() drift to bottom. Wait until resolved:
+                     https://github.com/slevomat/coding-standard/issues/1098 -->
+                <element value="methods"/>
+            </property>
+        </properties>
+    </rule>
+
     <!-- Drupal -->
     <rule ref="Drupal" />
 

tests/Sniffs/ClassStructureTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs;
+
+use SlevomatCodingStandard\Sniffs\Classes\ClassStructureSniff;
+
+/**
+ * @covers \SlevomatCodingStandard\Sniffs\Classes\ClassStructureSniff
+ */
+final class ClassStructureTest extends Base {
+
+  public function testNoError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/ClassStructureNoError.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+  public function testError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/ClassStructureError.php');
+    self::assertSame(8, $report->getErrorCount());
+    self::assertSniffError($report, 33, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 36, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 38, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 41, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 43, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 45, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 47, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+    self::assertSniffError($report, 49, ClassStructureSniff::CODE_INCORRECT_GROUP_ORDER);
+  }
+
+  protected static function getSniffName(): string {
+    return 'SlevomatCodingStandard.Classes.ClassStructure';
+  }
+
+}

tests/Sniffs/fixtures/ClassStructureError.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class ClassStructureError {
+
+  /**
+   * A method.
+   */
+  protected function baz(): void {
+  }
+
+  /**
+   * A method.
+   */
+  private function bar(): void {
+  }
+
+  /**
+   * A method.
+   */
+  public function foo(): void {
+  }
+
+  /**
+   * A method.
+   */
+  public function __construct() {
+  }
+
+  protected $golf = NULL;
+
+  private $foxtrot = NULL;
+
+
+  public $delta = NULL;
+
+  protected const CHARLIE = 'charlie';
+
+  private const BRAVO = 'bravo';
+
+  public const ALPHA = 'alpha';
+
+  use Foo;
+
+}

tests/Sniffs/fixtures/ClassStructureNoError.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class ClassStructureNoError {
+
+  use Foo;
+
+  public const ALPHA = 'alpha';
+  private const BRAVO = 'bravo';
+  protected const CHARLIE = 'charlie';
+
+  public $delta = NULL;
+  private $foxtrot = NULL;
+  protected $golf = NULL;
+
+  /**
+   * A method.
+   */
+  public function __construct() {
+  }
+
+  /**
+   * A method.
+   */
+  public function foo(): void {
+  }
+
+  /**
+   * A method.
+   */
+  private function bar(): void {
+  }
+
+  /**
+   * A method.
+   */
+  protected function baz(): void {
+  }
+
+}