Merge pull request #171 from magento-commerce/develop

Develop to master v21

Author: loginesta

Magento2/Sniffs/Legacy/ModuleXMLSniff.php

@@ -18,7 +18,7 @@ class ModuleXMLSniff implements Sniff
 {
     private const WARNING_CODE = 'FoundObsoleteAttribute';
     private const ERROR_CODE = 'WrongXML';
-    
+
     /**
      * @inheritdoc
      */
@@ -34,8 +34,7 @@ public function register(): array
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $line = $phpcsFile->getTokens()[$stackPtr]['content'];
-        if (strpos(trim($line), '<module') === false) {
+        if ($stackPtr > 0) {
             return;
         }
 
@@ -52,53 +51,33 @@ public function process(File $phpcsFile, $stackPtr)
                 $stackPtr,
                 self::ERROR_CODE
             );
-        }
-
-        $foundElements = $xml->xpath('/config/module');
-        if ($foundElements === false) {
             return;
         }
-        
-        foreach ($foundElements as $element) {
-            if (!$this->elementIsCurrentlySniffedLine($element, $stackPtr)) {
-                continue;
-            }
-            
-            if (property_exists($element->attributes(), 'version')) {
+
+        $foundElements = $xml->xpath('/config/module[@version]');
+        if ($foundElements !== false) {
+            foreach ($foundElements as $element) {
                 $phpcsFile->addWarning(
                     'The "version" attribute is obsolete. Use "setup_version" instead.',
-                    $stackPtr,
+                    dom_import_simplexml($element)->getLineNo()-1,
                     self::WARNING_CODE
                 );
             }
+        }
 
-            if (property_exists($element->attributes(), 'active')) {
+        $foundElements = $xml->xpath('/config/module[@active]');
+        if ($foundElements !== false) {
+            foreach ($foundElements as $element) {
                 $phpcsFile->addWarning(
                     'The "active" attribute is obsolete. The list of active modules '.
                     'is defined in deployment configuration.',
-                    $stackPtr,
+                    dom_import_simplexml($element)->getLineNo()-1,
                     self::WARNING_CODE
                 );
             }
         }
     }
 
-    /**
-     * Check if the element passed is in the currently sniffed line
-     *
-     * @param SimpleXMLElement $element
-     * @param int $stackPtr
-     * @return bool
-     */
-    private function elementIsCurrentlySniffedLine(SimpleXMLElement $element, int $stackPtr): bool
-    {
-        $node = dom_import_simplexml($element);
-        if ($node->getLineNo() === $stackPtr+1) {
-            return true;
-        }
-        return false;
-    }
-
     /**
      * Format the incoming XML to avoid tags split into several lines.
      *

Magento2/Tests/Legacy/ModuleXMLUnitTest.4.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+    <module name="Training_Backend" active="true" version="1" />
+</config>

Magento2/Tests/Legacy/ModuleXMLUnitTest.php

@@ -35,6 +35,11 @@ public function getWarningList($testFile = '')
         if ($testFile === 'ModuleXMLUnitTest.3.xml') {
             return [];
         }
+        if ($testFile === 'ModuleXMLUnitTest.4.xml') {
+            return [
+                9 => 2,
+            ];
+        }
         return [];
     }
 }

composer.json

@@ -6,7 +6,7 @@
         "AFL-3.0"
     ],
     "type": "phpcodesniffer-standard",
-    "version": "20",
+    "version": "21",
     "require": {
         "php": ">=7.3",
         "webonyx/graphql-php": "^14.9",