Develop to Master Version 13

.github/workflows/php.yml

@@ -42,7 +42,9 @@ jobs:
     - name: Install dependencies
       run: npm install
     - name: Run ESLint
-      run: npm run eslint -- eslint/rules
+      run: npm run eslint -- eslint/rules Magento2 --ignore-pattern 'Magento2/Tests/Eslint/*Test.js'
+    - name: Run JSCS
+      run: npm run jscs eslint/rules Magento2
 
     - name: Validate composer
       run: composer validate

Magento2/Sniffs/Legacy/ObsoleteAclSniff.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\Legacy;
+
+use DOMDocument;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Test to find obsolete acl declaration
+ */
+class ObsoleteAclSniff implements Sniff
+{
+    private const WARNING_OBSOLETE_ACL_STRUCTURE = 'ObsoleteAclStructure';
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr > 0) {
+            return;
+        }
+
+        $xml = simplexml_load_string($this->getFormattedXML($phpcsFile));
+        $foundElements = $xml->xpath('/config/acl/*[boolean(./children) or boolean(./title)]');
+        foreach ($foundElements as $element) {
+            $phpcsFile->addWarning(
+                'Obsolete acl structure detected in line ' . dom_import_simplexml($element)->getLineNo(),
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::WARNING_OBSOLETE_ACL_STRUCTURE
+            );
+        }
+    }
+
+    /**
+     * Format the incoming XML to avoid tags split into several lines.
+     *
+     * @param File $phpcsFile
+     * @return false|string
+     */
+    private function getFormattedXML(File $phpcsFile)
+    {
+        $doc = new DomDocument('1.0');
+        $doc->formatOutput = true;
+        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
+        return $doc->saveXML();
+    }
+}

Magento2/Sniffs/Legacy/ObsoleteMenuSniff.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\Legacy;
+
+use DOMDocument;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Test to find obsolete acl declaration
+ */
+class ObsoleteMenuSniff implements Sniff
+{
+    private const WARNING_OBSOLETE_MENU_STRUCTURE = 'ObsoleteMenuStructure';
+
+    /**
+     * @var string
+     */
+    private $xpath = '/config/menu/*[boolean(./children) or boolean(./title) or boolean(./action)]';
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr > 0) {
+            return;
+        }
+
+        $xml = simplexml_load_string($this->getFormattedXML($phpcsFile));
+        $foundElements = $xml->xpath($this->xpath);
+        foreach ($foundElements as $element) {
+            $phpcsFile->addWarning(
+                'Obsolete menu structure detected in line ' . dom_import_simplexml($element)->getLineNo(),
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::WARNING_OBSOLETE_MENU_STRUCTURE
+            );
+        }
+    }
+
+    /**
+     * Format the incoming XML to avoid tags split into several lines.
+     *
+     * @param File $phpcsFile
+     * @return false|string
+     */
+    private function getFormattedXML(File $phpcsFile)
+    {
+        $doc = new DomDocument('1.0');
+        $doc->formatOutput = true;
+        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
+        return $doc->saveXML();
+    }
+}

Magento2/Sniffs/Legacy/ObsoleteSystemConfigurationSniff.php

@@ -0,0 +1,91 @@
+<?php
+
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento2\Sniffs\Legacy;
+
+use DOMDocument;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ObsoleteSystemConfigurationSniff implements Sniff
+{
+    private const ERROR_CODE_XML = 'WrongXML';
+    private const WARNING_CODE_OBSOLETE = 'FoundObsoleteSystemConfiguration';
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr > 0) {
+            return;
+        }
+
+        $xml = simplexml_load_string($this->getFormattedXML($phpcsFile));
+
+        if ($xml === false) {
+            $this->invalidXML($phpcsFile, $stackPtr);
+            return;
+        }
+
+        $foundElements = $xml->xpath('/config/tabs|/config/sections');
+
+        if ($foundElements === false) {
+            return;
+        }
+
+        foreach ($foundElements as $element) {
+            $phpcsFile->addWarning(
+                "Obsolete system configuration structure detected in file.",
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::WARNING_CODE_OBSOLETE
+            );
+        }
+    }
+
+    /**
+     * Adds an invalid XML error
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     */
+    private function invalidXML(File $phpcsFile, int $stackPtr): void
+    {
+        $phpcsFile->addError(
+            sprintf(
+                "Couldn't parse contents of '%s', check that they are in valid XML format.",
+                $phpcsFile->getFilename(),
+            ),
+            $stackPtr,
+            self::ERROR_CODE_XML
+        );
+    }
+
+    /**
+     * Format the incoming XML to avoid tags split into several lines.
+     *
+     * @param File $phpcsFile
+     * @return false|string
+     */
+    private function getFormattedXML(File $phpcsFile)
+    {
+        $doc = new DomDocument('1.0');
+        $doc->formatOutput = true;
+        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
+        return $doc->saveXML();
+    }
+}

Magento2/Sniffs/Legacy/RestrictedCodeSniff.php

@@ -0,0 +1,134 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace Magento2\Sniffs\Legacy;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Tests to find usage of restricted code
+ */
+class RestrictedCodeSniff implements Sniff
+{
+    private const ERROR_MESSAGE = "Class '%s' is restricted in %s. Suggested replacement: %s";
+    private const ERROR_CODE = "restrictedClass";
+
+    /**
+     * List of fixtures that contain restricted classes and should not be tested
+     *
+     * @var array
+     */
+    private $fixtureFiles = [];
+
+    /**
+     * Restricted classes
+     *
+     * @var array
+     */
+    private $classes = [];
+
+    /**
+     * RestrictedCodeSniff constructor.
+     */
+    public function __construct()
+    {
+        $this->loadData('restricted_classes*.php');
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [
+            T_STRING,
+            T_CONSTANT_ENCAPSED_STRING
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // phpcs:ignore
+        if (array_key_exists(basename($phpcsFile->getFilename()), $this->fixtureFiles)) {
+            return;
+        }
+
+        $tokens = $phpcsFile->getTokens();
+        $token = $tokens[$stackPtr]['content'];
+        if (array_key_exists($token, $this->classes)) {
+            if ($this->isExcluded($token, $phpcsFile)) {
+                return;
+            }
+            $phpcsFile->addError(
+                sprintf(
+                    self::ERROR_MESSAGE,
+                    $token,
+                    $phpcsFile->getFilename(),
+                    $this->classes[$token]['replacement']
+                ),
+                $stackPtr,
+                self::ERROR_CODE,
+            );
+        }
+    }
+
+    /**
+     * Checks if currently parsed file should be excluded from analysis
+     *
+     * @param string $token
+     * @param File $phpcsFile
+     * @return bool
+     */
+    private function isExcluded(string $token, File $phpcsFile): bool
+    {
+        if (in_array($phpcsFile->getFilename(), $this->fixtureFiles)) {
+            return true;
+        }
+        foreach ($this->classes[$token]['exclude'] as $exclude) {
+            if (strpos($phpcsFile->getFilename(), $exclude) !== false) {
+                return true;
+            }
+        }
+        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;
+    }
+}