Merge pull request #92 from magento-commerce/develop

Develop to Master Version 13

Author: jcuerdo

.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();
+    }
+}