MC-19921: Create static tests for object variables inside E-mail templates

Author: nathanjosiah

dev/tests/static/framework/Magento/Sniffs/Html/HtmlDirectiveSniff.php

@@ -49,8 +49,23 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $this->usedVariables = [];
+        $html = $this->processIfDirectives($html, $phpcsFile);
+        $html = $this->processDependDirectives($html, $phpcsFile);
+        $html = $this->processForDirectives($html, $phpcsFile);
+        $html = $this->processVarDirectivesAndParams($html, $phpcsFile);
 
+        $this->validateDefinedVariables($phpcsFile, $html);
+    }
+
+    /**
+     * Process the {{if}} directives in the file
+     *
+     * @param string $html
+     * @param File $phpcsFile
+     * @return string The processed template
+     */
+    private function processIfDirectives(string $html, File $phpcsFile): string
+    {
         if (preg_match_all(Template::CONSTRUCTION_IF_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
             foreach ($constructions as $construction) {
                 // validate {{if <var>}}
@@ -59,6 +74,18 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
 
+        return $html;
+    }
+
+    /**
+     * Process the {{depend}} directives in the file
+     *
+     * @param string $html
+     * @param File $phpcsFile
+     * @return string The processed template
+     */
+    private function processDependDirectives(string $html, File $phpcsFile): string
+    {
         if (preg_match_all(Template::CONSTRUCTION_DEPEND_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
             foreach ($constructions as $construction) {
                 // validate {{depend <var>}}
@@ -67,6 +94,18 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
 
+        return $html;
+    }
+
+    /**
+     * Process the {{for}} directives in the file
+     *
+     * @param string $html
+     * @param File $phpcsFile
+     * @return string The processed template
+     */
+    private function processForDirectives(string $html, File $phpcsFile): string
+    {
         if (preg_match_all(Template::LOOP_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
             foreach ($constructions as $construction) {
                 // validate {{for in <var>}}
@@ -75,6 +114,18 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
 
+        return $html;
+    }
+
+    /**
+     * Process the all var directives and var directive params in the file
+     *
+     * @param string $html
+     * @param File $phpcsFile
+     * @return string The processed template
+     */
+    private function processVarDirectivesAndParams(string $html, File $phpcsFile): string
+    {
         if (preg_match_all(Template::CONSTRUCTION_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
             foreach ($constructions as $construction) {
                 if (empty($construction[2])) {
@@ -89,7 +140,7 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
 
-        $this->validateDefinedVariables($phpcsFile, $html);
+        return $html;
     }
 
     /**
@@ -187,18 +238,5 @@ private function validateDefinedVariables(File $phpcsFile, string $templateText)
                 'HtmlTemplates.DirectiveUsage.UndefinedVariable'
             );
         }
-
-        $extraDefinedVariables = array_diff($definedVariables, $this->usedVariables);
-        foreach ($extraDefinedVariables as $extraDefinedVariable) {
-            if (substr($extraDefinedVariable, 0, 4) !== 'var ') {
-                continue;
-            }
-            $phpcsFile->addError(
-                'Template @vars comment block contains a variable not used in the template.' . PHP_EOL
-                 . 'Extra variable: ' . $extraDefinedVariable,
-                null,
-                'HtmlTemplates.DirectiveUsage.ExtraVariable'
-            );
-        }
     }
 }

dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Html/_files/test-html-directive-errors.txt

@@ -1,5 +1,5 @@
 ------------------------------------------------------------------------------------------------------------------------------------
-FOUND 21 ERRORS AFFECTING 1 LINE
+FOUND 20 ERRORS AFFECTING 1 LINE
 ------------------------------------------------------------------------------------------------------------------------------------
  1 | ERROR | Template directives may not invoke methods. Only scalar array access is allowed.
    |       | Found "foo.badif().bad"
@@ -41,8 +41,6 @@ FOUND 21 ERRORS AFFECTING 1 LINE
    |       | Missing variable: var foo.undeclared.baz
  1 | ERROR | Template @vars comment block is missing a variable used in the template.
    |       | Missing variable: var undeclared.var.error
- 1 | ERROR | Template @vars comment block contains a variable not used in the template.
-   |       | Extra variable: var extra.var.getOhNo()
 ------------------------------------------------------------------------------------------------------------------------------------