Merge branch 'develop' into 21-system-resources

Author: Lars Roettig

Magento2/Sniffs/Classes/AbstractApiSniff.php

@@ -48,6 +48,9 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $commentStartPtr = $phpcsFile->findPrevious(T_DOC_COMMENT_OPEN_TAG, $stackPtr - 1, 0);
+        if ($commentStartPtr === false) {
+            return;
+        }
         $commentCloserPtr = $tokens[$commentStartPtr]['comment_closer'];
 
         for ($i = $commentStartPtr; $i <= $commentCloserPtr; $i++) {

Magento2/Sniffs/Functions/DiscouragedFunctionSniff.php

@@ -218,5 +218,6 @@ class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
         '^is_null$' => 'strict comparison "=== null"',
         '^intval$' => '(int) construction',
         '^strval$' => '(string) construction',
+        '^htmlspecialchars$' => '\Magento\Framework\Escaper->escapeHtml',
     ];
 }

Magento2/Sniffs/PHP/LiteralNamespacesSniff.php

@@ -52,28 +52,12 @@ public function process(File $sourceFile, $stackPtr)
             $content = preg_replace('|\\\{2,}|', '\\', $content);
         }
 
-        if (preg_match($this->literalNamespacePattern, $content) === 1 && $this->classExists($content)) {
+        if (preg_match($this->literalNamespacePattern, $content) === 1) {
             $sourceFile->addWarning(
                 "Use ::class notation instead.",
                 $stackPtr,
                 'LiteralClassUsage'
             );
         }
     }
-
-    /**
-     * Checks if class or interface exists.
-     *
-     * ToDo: get rig of this check https://github.com/magento/magento-coding-standard/issues/9
-     *
-     * @param string $className
-     * @return bool
-     */
-    private function classExists($className)
-    {
-        if (!isset($this->classNames[$className])) {
-            $this->classNames[$className] = class_exists($className) || interface_exists($className);
-        }
-        return $this->classNames[$className];
-    }
 }

Magento2/Sniffs/Performance/ForeachArrayMergeSniff.md

@@ -0,0 +1,26 @@
+# Rule: array_merge(...) is used in a loop and is a resources greedy construction
+
+## Reason
+Merging arrays in a loop is slow and causes high CPU usage.
+
+## How to Fix
+Typical example when `array_merge` is being used in the loop:
+``` php
+    $options = [];
+    foreach ($configurationSources as $source) {
+        // code here
+        $options = array_merge($options, $source->getOptions());
+    }
+```
+
+In order to reduce execution time `array_merge` can be called only once:
+``` php
+    $options = [[]];
+    foreach ($configurationSources as $source) {
+        // code here
+        $options[] = $source->getOptions();
+    }
+
+    // PHP 5.6+
+    $options = array_merge(...$options);
+```

Magento2/Sniffs/Performance/ForeachArrayMergeSniff.php

@@ -47,6 +47,10 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
+        // If it's inline control structure we do nothing. PSR2 issue will be raised.
+        if (!array_key_exists('scope_opener', $tokens[$stackPtr])) {
+            return;
+        }
         $scopeOpener = $tokens[$stackPtr]['scope_opener'];
         $scopeCloser = $tokens[$stackPtr]['scope_closer'];
 

Magento2/Sniffs/Security/InsecureFunctionSniff.php

@@ -12,13 +12,6 @@
  */
 class InsecureFunctionSniff extends ForbiddenFunctionsSniff
 {
-    /**
-     * If true, an error will be thrown; otherwise a warning.
-     *
-     * @var boolean
-     */
-    public $error = false;
-
     /**
      * List of patterns for forbidden functions.
      *
@@ -38,6 +31,7 @@ class InsecureFunctionSniff extends ForbiddenFunctionsSniff
         'system' => null,
         'unserialize' => '\Magento\Framework\Serialize\SerializerInterface::unserialize',
         'srand' => null,
-        'mt_srand'=> null,
+        'mt_srand' => null,
+        'mt_rand' => 'random_int',
     ];
 }

Magento2/Tests/Classes/AbstractApiUnitTest.inc renamed to Magento2/Tests/Classes/AbstractApiUnitTest.1.inc

@@ -28,7 +28,6 @@ class FooBar implements FooInterface
 
 }
 
-
 /**
  * Class Bar
  */

Magento2/Tests/Classes/AbstractApiUnitTest.2.inc

@@ -0,0 +1,6 @@
+<?php
+
+abstract class FooNoComment implements FooInterface
+{
+
+}

Magento2/Tests/Classes/AbstractApiUnitTest.php

@@ -23,11 +23,15 @@ public function getErrorList()
     /**
      * @inheritdoc
      */
-    public function getWarningList()
+    public function getWarningList($testFile = '')
     {
-        return [
-            14 => 1,
-            23 => 1
-        ];
+        if ($testFile === 'AbstractApiUnitTest.1.inc') {
+            return [
+                14 => 1,
+                23 => 1
+            ];
+        }
+
+        return [];
     }
 }

Magento2/Tests/Functions/DiscouragedFunctionUnitTest.inc

@@ -462,3 +462,5 @@ $int = intval($int);
 $str = chop($text, 'ttt');
 
 md5($text);
+
+htmlspecialchars('text');