✅ Ignore Drupal Coder rules tests (#14)

Author: dpi

tests/Ignore/IgnoreDocCommentSniffTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore;
+
+/**
+ * @covers \PHP_CodeSniffer\Standards\Generic\Sniffs\Commenting\DocCommentSniff
+ */
+final class IgnoreDocCommentSniffTest extends Base {
+
+  /**
+   * Checks for 'Drupal.Commenting.DocComment.MissingShort'.
+   */
+  public function testIgnored(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDocCommentSniff.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+}

tests/Ignore/IgnoreDrupalArraysArrayLongLineDeclarationTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore;
+
+/**
+ * @covers \Drupal\Sniffs\Arrays\ArraySniff
+ */
+final class IgnoreDrupalArraysArrayLongLineDeclarationTest extends Base {
+
+  /**
+   * Checks for 'Drupal.Arrays.Array.LongLineDeclaration'.
+   */
+  public function testIgnored(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDrupalArraysArrayLongLineDeclaration.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+}

tests/Ignore/IgnoreDrupalCommentingClassCommentShortTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore;
+
+/**
+ * @covers \Drupal\Sniffs\Commenting\ClassCommentSniff
+ */
+final class IgnoreDrupalCommentingClassCommentShortTest extends Base {
+
+  /**
+   * Checks for 'Drupal.Commenting.ClassComment.Short'.
+   */
+  public function testIgnored(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDrupalCommentingClassCommentShort.php');
+    self::assertNoSniffWarningInFile($report);
+  }
+
+}

tests/Ignore/IgnoreDrupalCommentingFunctionCommentTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore;
+
+/**
+ * @covers \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\FunctionCommentSniff
+ */
+final class IgnoreDrupalCommentingFunctionCommentTest extends Base {
+
+  /**
+   * Checks for 'Drupal.Commenting.FunctionComment.IncorrectParamVarName'.
+   */
+  public function testIgnoredIncorrectParamVarName(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDrupalCommentingFunctionComment_IncorrectParamVarName.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+  /**
+   * Checks for 'Drupal.Commenting.FunctionComment.InvalidReturn'.
+   */
+  public function testIgnoredInvalidReturn(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDrupalCommentingFunctionComment_InvalidReturn.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+}

tests/Ignore/IgnoreDrupalCommentingTodoCommentTodoFormatTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore;
+
+/**
+ * @covers \Drupal\Sniffs\Commenting\TodoCommentSniff
+ */
+final class IgnoreDrupalCommentingTodoCommentTodoFormatTest extends Base {
+
+  /**
+   * Checks for 'Drupal.Commenting.TodoComment.TodoFormat'.
+   */
+  public function testIgnored(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDrupalCommentingTodoCommentTodoFormat.php');
+    self::assertNoSniffWarningInFile($report);
+  }
+
+}

tests/Ignore/IgnoreDrupalCommentingVariableCommentMissingTest.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore;
+
+/**
+ * @covers \Drupal\Sniffs\Commenting\VariableCommentSniff
+ */
+final class IgnoreDrupalCommentingVariableCommentMissingTest extends Base {
+
+  public function testIgnored(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/IgnoreDrupalCommentingVariableCommentMissing.php');
+    self::assertNoSniffErrorInFile($report);
+    self::assertNoSniffError($report, 12);
+  }
+
+}

tests/Ignore/fixtures/IgnoreDocCommentSniff.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore\fixtures;
+
+/**
+ * Class IgnoreDrupalCommentingClassCommentShort.
+ */
+final class IgnoreDocCommentSniff {
+
+  /**
+   * @return $this
+   */
+  public function foo() {
+    return $this;
+  }
+
+}

tests/Ignore/fixtures/IgnoreDrupalArraysArrayLongLineDeclaration.php

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types = 1);
+
+$foo = ['Lorem ipsum dolor sit amet, consectetur adipiscing elit', 'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'];

tests/Ignore/fixtures/IgnoreDrupalCommentingClassCommentShort.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore\fixtures;
+
+/**
+ * Class IgnoreDrupalCommentingClassCommentShort.
+ */
+final class IgnoreDrupalCommentingClassCommentShort {
+
+}

tests/Ignore/fixtures/IgnoreDrupalCommentingFunctionComment_IncorrectParamVarName.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * @param class-string $a
+ *   Foo.
+ */
+function foo(string $a): void {
+}

tests/Ignore/fixtures/IgnoreDrupalCommentingFunctionComment_InvalidReturn.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * @return class-string
+ *   Foo.
+ */
+function foo(): string {
+  return '';
+}

tests/Ignore/fixtures/IgnoreDrupalCommentingTodoCommentTodoFormat.php

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types = 1);
+
+// @TODO: fix this or that.

tests/Ignore/fixtures/IgnoreDrupalCommentingVariableCommentMissing.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PreviousNext\CodingStandard\Tests\Ignore\fixtures;
+
+/**
+ * The class.
+ */
+final class IgnoreDrupalCommentingVariableCommentMissing {
+
+  public $foo = NULL;
+
+}