Merge pull request #103 from magento-commerce/AC-206

AC-206: Create UCT phpcs ruleset for customizations only

Author: sivaschenko

.github/workflows/php.yml

@@ -42,7 +42,7 @@ jobs:
     - name: Install dependencies
       run: npm install
     - name: Run ESLint
-      run: npm run eslint -- eslint/rules Magento2 --ignore-pattern 'Magento2/Tests/Eslint/*Test.js'
+      run: npm run eslint -- eslint/rules
     - name: Run JSCS
       run: npm run jscs eslint/rules Magento2
 
@@ -59,4 +59,7 @@ jobs:
       run: vendor/bin/phpunit
 
     - name: Run code style suite
-      run: vendor/bin/phpcs --standard=Magento2 Magento2/Helpers/ Magento2/Sniffs
+      run: vendor/bin/phpcs --standard=Magento2 Magento2/Helpers Magento2/Sniffs Magento2Framework/Sniffs
+
+    - name: Run framework suite
+      run: vendor/bin/phpcs --standard=Magento2Framework Magento2/Helpers Magento2/Sniffs Magento2Framework/Sniffs

Magento2/Sniffs/Legacy/RestrictedCodeSniff.php

@@ -37,7 +37,8 @@ class RestrictedCodeSniff implements Sniff
      */
     public function __construct()
     {
-        $this->loadData('restricted_classes*.php');
+        // phpcs:ignore Magento2.Security.IncludeFile.FoundIncludeFile
+        $this->classes = include __DIR__ . '/_files/restricted_classes.php';
     }
 
     /**
@@ -56,7 +57,7 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        // phpcs:ignore
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         if (array_key_exists(basename($phpcsFile->getFilename()), $this->fixtureFiles)) {
             return;
         }
@@ -99,36 +100,4 @@ private function isExcluded(string $token, File $phpcsFile): bool
         }
         return false;
     }
-
-    /**
-     * Loads and merges data from fixtures
-     *
-     * @param string $filePattern
-     * @return void
-     */
-    private function loadData(string $filePattern)
-    {
-        // phpcs:ignore
-        foreach (glob(__DIR__ . '/_files/' . $filePattern) as $file) {
-            $relativePath = str_replace(
-                '\\',
-                '/',
-                str_replace(__DIR__ . DIRECTORY_SEPARATOR, '', $file)
-            );
-            array_push($this->fixtureFiles, $relativePath);
-            $this->classes = array_merge_recursive($this->classes, $this->readList($file));
-        }
-    }
-
-    /**
-     * Isolate including a file into a method to reduce scope
-     *
-     * @param string $file
-     * @return array
-     */
-    private function readList($file)
-    {
-        // phpcs:ignore
-        return include $file;
-    }
 }

Magento2/Sniffs/Legacy/_files/restricted_classes.php

@@ -17,7 +17,8 @@
         'exclude' => [
             'Magento/Framework/DB/Select.php',
             'Magento/Framework/DB/Adapter/Pdo/Mysql.php',
-            'Magento/Framework/Model/ResourceModel/Iterator.php'
+            'Magento/Framework/Model/ResourceModel/Iterator.php',
+            'Magento/ResourceConnections/DB/Adapter/Pdo/MysqlProxy.php'
         ]
     ],
     'Zend_Db_Adapter_Pdo_Mysql' => [
@@ -48,7 +49,10 @@
             'Magento/Framework/Flag.php',
             'Magento/Widget/Setup/LayoutUpdateConverter.php',
             'Magento/Cms/Setup/ContentConverter.php',
-            'Magento/Framework/Unserialize/Test/Unit/UnserializeTest.php'
+            'Magento/Framework/Unserialize/Test/Unit/UnserializeTest.php',
+            'Magento/Framework/Test/Unit/FlagTest.php',
+            'Magento/Staging/Test/Unit/Model/Update/FlagTest.php',
+            'Magento/Logging/Test/Unit/Setup/ObjectConverterTest.php'
         ]
     ],
     'ArrayObject' => [
@@ -67,7 +71,10 @@
                 'Magento/Framework/Indexer/Test/Unit/BatchTest.php',
                 'Magento/Framework/View/Element/UiComponent/ArrayObjectFactory.php',
                 'Magento/Framework/View/Element/UiComponent/Config/Provider/Component/Definition.php',
-                'Magento/Framework/Indexer/Action/Base.php'
+                'Magento/Framework/Indexer/Action/Base.php',
+                'Magento/MultipleWishlist/Test/Unit/Model/Search/Strategy/EmailTest.php',
+                'Magento/Rma/Test/Unit/Model/RmaRepositoryTest.php',
+                'Magento/Rma/Test/Unit/Model/Status/HistoryRepositoryTest.php'
             ]
     ],
     'Magento\Framework\View\Element\UiComponent\ArrayObjectFactory' => [

Magento2/Sniffs/Legacy/_files/restricted_classes_ee.php

@@ -334,10 +334,6 @@
         <severity>8</severity>
         <type>warning</type>
     </rule>
-    <rule ref="Magento2.Legacy.License">
-        <severity>8</severity>
-        <type>warning</type>
-    </rule>
 
     <!-- Severity 7 warnings: General code issues. -->
     <rule ref="Generic.Arrays.DisallowLongArraySyntax">
@@ -726,24 +722,7 @@
         <exclude-pattern>*/Test/*</exclude-pattern>
         <exclude-pattern>*Test.php</exclude-pattern>
     </rule>
-    <rule ref="Magento2.Legacy.CopyrightAnotherExtensionsFiles">
-        <severity>5</severity>
-        <type>warning</type>
-        <exclude-pattern>*\.php$</exclude-pattern>
-        <exclude-pattern>*\.phtml$</exclude-pattern>
-    </rule>
-    <rule ref="Magento2.Legacy.Copyright">
-        <severity>5</severity>
-        <type>warning</type>
-        <include-pattern>*\.php$</include-pattern>
-        <include-pattern>*\.phtml$</include-pattern>
-    </rule>
     <rule ref="Internal.NoCodeFound">
         <severity>0</severity>
     </rule>
-    <!-- TODO: AC-1314 -->
-    <rule ref="Magento2.Legacy">
-        <exclude name="Magento2.Legacy.Copyright"/>
-        <exclude name="Magento2.Legacy.CopyrightAnotherExtensionsFiles"/>
-    </rule>
 </ruleset>

Magento2/Tests/Legacy/AbstractJsSniffUnitTestCase.php

@@ -5,7 +5,7 @@
  */
 declare(strict_types = 1);
 
-namespace Magento2\Sniffs\Legacy;
+namespace Magento2Framework\Sniffs\Header;
 
 use Magento2\Sniffs\Less\TokenizerSymbolsInterface;
 use PHP_CodeSniffer\Files\File;
@@ -24,7 +24,7 @@ class CopyrightAnotherExtensionsFilesSniff implements Sniff
      * @var array
      */
     public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS, 'PHP'];
-    
+
     /**
      * @inheritDoc
      */
@@ -44,7 +44,7 @@ public function process(File $phpcsFile, $stackPtr)
         if ($stackPtr > 0) {
             return;
         }
-        
+
         $fileText = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
         $adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $fileText);
 

Magento2/ruleset.xml

@@ -5,26 +5,26 @@
  */
 declare(strict_types = 1);
 
-namespace Magento2\Sniffs\Legacy;
+namespace Magento2Framework\Sniffs\Header;
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 
 class CopyrightSniff implements Sniff
 {
     private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';
-    
+
     private const COPYRIGHT_MAGENTO_TEXT = 'Copyright © Magento, Inc. All rights reserved.';
     private const COPYRIGHT_ADOBE = '/Copyright \d+ Adobe/';
-    
+
     /**
      * @inheritdoc
      */
     public function register()
     {
         return [T_OPEN_TAG];
     }
-    
+
     /**
      * @inheritDoc
      */

Magento2/Sniffs/Legacy/CopyrightAnotherExtensionsFilesSniff.php renamed to Magento2Framework/Sniffs/Header/CopyrightAnotherExtensionsFilesSniff.php

@@ -5,7 +5,7 @@
  */
 declare(strict_types = 1);
 
-namespace Magento2\Sniffs\Legacy;
+namespace Magento2Framework\Sniffs\Header;
 
 use Magento2\Sniffs\Less\TokenizerSymbolsInterface;
 use PHP_CodeSniffer\Files\File;
@@ -21,9 +21,9 @@ class LicenseSniff implements Sniff
     public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS, 'PHP'];
 
     private const WARNING_CODE = 'FoundLegacyTextInCopyright';
-    
+
     private const LEGACY_TEXTS = ['Irubin Consulting Inc', 'DBA Varien', 'Magento Inc'];
-    
+
     /**
      * @inheritdoc
      */
@@ -34,15 +34,15 @@ public function register()
             T_INLINE_HTML
         ];
     }
-    
+
     /**
      * @inheritDoc
      */
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
         $content = null;
-        
+
         if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_STRING) {
             $content = $tokens[$stackPtr]['content'];
         }