Merge pull request magento#139 from magento-commerce/fix-phpcs-issues

Fix phpcs issues

Author: loginesta

.github/workflows/php.yml

@@ -54,10 +54,10 @@ jobs:
       run: vendor/bin/phpunit
 
     - name: Run code style suite
-      run: vendor/bin/phpcs --standard=Magento2 Magento2/Helpers Magento2/Sniffs Magento2Framework/Sniffs
+      run: vendor/bin/phpcs --standard=Magento2 Magento2/Helpers Magento2/Sniffs Magento2/Rector Magento2Framework/Sniffs
 
     - name: Run framework suite
-      run: vendor/bin/phpcs --standard=Magento2Framework Magento2/Helpers Magento2/Sniffs Magento2Framework/Sniffs
+      run: vendor/bin/phpcs --standard=Magento2Framework Magento2/Helpers Magento2/Sniffs Magento2/Rector Magento2Framework/Sniffs
   js:
     runs-on: ubuntu-latest
     name: Javascript tests

Magento2/Rector/Src/AddArrayAccessInterfaceReturnTypes.php

@@ -10,22 +10,21 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use Rector\Core\Rector\AbstractRector;
-use Symplify\RuleDocGenerator\Exception\PoorDocumentationException;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
-final class AddArrayAccessInterfaceReturnTypes extends AbstractRector
+class AddArrayAccessInterfaceReturnTypes extends AbstractRector
 {
     /**
-     * @return array<class-string<Node>>
+     * @inheritDoc
      */
     public function getNodeTypes(): array
     {
         return [Class_::class];
     }
 
     /**
-     * @param Class_ $node
+     * @inheritDoc
      */
     public function refactor(Node $node): ?Node
     {
@@ -52,13 +51,13 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @return RuleDefinition
-     * @throws PoorDocumentationException
+     * @inheritDoc
      */
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Add return types specified by ArrayAccess interface', [
+            'Add return types specified by ArrayAccess interface',
+            [
                 new CodeSample(
                     'public function offsetSet($offset, $value)',
                     'public function offsetSet($offset, $value): void'

Magento2/Rector/Src/ReplaceMbStrposNullLimit.php

@@ -11,22 +11,21 @@
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Scalar\LNumber;
 use Rector\Core\Rector\AbstractRector;
-use Symplify\RuleDocGenerator\Exception\PoorDocumentationException;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
-final class ReplaceMbStrposNullLimit extends AbstractRector
+class ReplaceMbStrposNullLimit extends AbstractRector
 {
     /**
-     * @return array<class-string<Node>>
+     * @inheritDoc
      */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];
     }
 
     /**
-     * @param FuncCall $node
+     * @inheritDoc
      */
     public function refactor(Node $node): ?Node
     {
@@ -43,13 +42,13 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @return RuleDefinition
-     * @throws PoorDocumentationException
+     * @inheritDoc
      */
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change mb_strpos offset from null to 0', [
+            'Change mb_strpos offset from null to 0',
+            [
                 new CodeSample(
                     'mb_strpos("pattern", "subject", null, "encoding");',
                     'mb_strpos("pattern", "subject", 0, "encoding");'

Magento2/Rector/Src/ReplaceNewDateTimeNull.php

@@ -11,22 +11,21 @@
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Scalar\String_;
 use Rector\Core\Rector\AbstractRector;
-use Symplify\RuleDocGenerator\Exception\PoorDocumentationException;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
-final class ReplaceNewDateTimeNull extends AbstractRector
+class ReplaceNewDateTimeNull extends AbstractRector
 {
     /**
-     * @return array<class-string<Node>>
+     * @inheritDoc
      */
     public function getNodeTypes(): array
     {
         return [New_::class];
     }
 
     /**
-     * @param New_ $node
+     * @inheritDoc
      */
     public function refactor(Node $node): ?Node
     {
@@ -43,13 +42,13 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @return RuleDefinition
-     * @throws PoorDocumentationException
+     * @inheritDoc
      */
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change DateTime datetime input from null to "now"', [
+            'Change DateTime datetime input from null to "now"',
+            [
                 new CodeSample(
                     'new DateTime(null, new DateTimeZone("GMT"));',
                     'new DateTime("now", new DateTimeZone("GMT"));'

Magento2/Rector/Src/ReplacePregSplitNullLimit.php

@@ -11,22 +11,21 @@
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Scalar\LNumber;
 use Rector\Core\Rector\AbstractRector;
-use Symplify\RuleDocGenerator\Exception\PoorDocumentationException;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
-final class ReplacePregSplitNullLimit extends AbstractRector
+class ReplacePregSplitNullLimit extends AbstractRector
 {
     /**
-     * @return array<class-string<Node>>
+     * @inheritDoc
      */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];
     }
 
     /**
-     * @param FuncCall $node
+     * @inheritDoc
      */
     public function refactor(Node $node): ?Node
     {
@@ -43,13 +42,13 @@ public function refactor(Node $node): ?Node
     }
 
     /**
-     * @return RuleDefinition
-     * @throws PoorDocumentationException
+     * @inheritDoc
      */
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change preg_split limit from null to -1', [
+            'Change preg_split limit from null to -1',
+            [
                 new CodeSample(
                     'preg_split("pattern", "subject", null, 0);',
                     'preg_split("pattern", "subject", -1, 0);'

Magento2/Rector/Tests/AddArrayAccessInterfaceReturnTypes/AddArrayAccessInterfaceReturnTypesTest.php

@@ -11,7 +11,7 @@
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
-final class AddArrayAccessInterfaceReturnTypesTest extends AbstractRectorTestCase
+class AddArrayAccessInterfaceReturnTypesTest extends AbstractRectorTestCase
 {
     /**
      * @dataProvider provideData()

Magento2/Rector/Tests/ReplaceMbStrposNullLimit/ReplaceMbStrposNullLimitTest.php

@@ -11,7 +11,7 @@
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
-final class ReplaceMbStrposNullLimitTest extends AbstractRectorTestCase
+class ReplaceMbStrposNullLimitTest extends AbstractRectorTestCase
 {
     /**
      * @dataProvider provideData()
@@ -29,6 +29,9 @@ public function provideData(): Iterator
         return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
     }
 
+    /**
+     * @return string
+     */
     public function provideConfigFilePath(): string
     {
         return __DIR__ . '/config/configured_rule.php';

Magento2/Rector/Tests/ReplaceNewDateTimeNull/ReplaceNewDateTimeNullTest.php

@@ -11,7 +11,7 @@
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
-final class ReplaceNewDateTimeNullTest extends AbstractRectorTestCase
+class ReplaceNewDateTimeNullTest extends AbstractRectorTestCase
 {
     /**
      * @dataProvider provideData()

Magento2/Rector/Tests/ReplacePregSplitNullLimit/ReplacePregSplitNullLimitTest.php

@@ -11,7 +11,7 @@
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
-final class ReplacePregSplitNullLimitTest extends AbstractRectorTestCase
+class ReplacePregSplitNullLimitTest extends AbstractRectorTestCase
 {
     /**
      * @dataProvider provideData()

Magento2/Tests/Eslint/AbstractEslintTestCase.php

@@ -17,18 +17,21 @@
 abstract class AbstractEslintTestCase extends TestCase
 {
     /**
+     * Assert that file contains a specific error.
+     *
      * @param string $testFile
      * @param array $expectedMessages
      */
     protected function assertFileContainsError(string $testFile, array $expectedMessages): void
     {
+        // phpcs:disable
         exec(
             'npm run eslint -- Magento2/Tests/Eslint/' . $testFile,
             $output
         );
 
         foreach ($expectedMessages as $message) {
-            $this->assertStringContainsString($message, implode(' ',$output));
+            $this->assertStringContainsString($message, implode(' ', $output));
         }
     }
 }