Merge pull request #146 from VincentLanglet/newSniff

Add ImportInternalFunctionSniff and OperatorPlacementSniff

Author: VincentLanglet

SymfonyCustom/Helpers/FixerHelper.php

@@ -6,6 +6,8 @@
 
 use PHP_CodeSniffer\Files\File;
 
+use function str_repeat;
+
 /**
  * Class FixerHelper
  */

SymfonyCustom/Helpers/SniffHelper.php

@@ -7,6 +7,10 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Tokens;
 
+use function mb_strtolower;
+use function preg_match;
+use function trim;
+
 /**
  * Class SniffHelper
  */
@@ -187,6 +191,67 @@ public static function isGlobalUse(File $phpcsFile, int $stackPtr): bool
         return true;
     }
 
+    /**
+     * @param File $phpcsFile
+     * @param int  $scopePtr
+     *
+     * @return array
+     */
+    public static function getUseStatements(File $phpcsFile, int $scopePtr): array
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        $uses = [];
+
+        if (isset($tokens[$scopePtr]['scope_opener'])) {
+            $start = $tokens[$scopePtr]['scope_opener'];
+            $end = $tokens[$scopePtr]['scope_closer'];
+        } else {
+            $start = $scopePtr;
+            $end = null;
+        }
+
+        $use = $phpcsFile->findNext(T_USE, $start + 1, $end);
+        while (false !== $use && T_USE === $tokens[$use]['code']) {
+            if (
+                !self::isGlobalUse($phpcsFile, $use)
+                || (null !== $end
+                    && (!isset($tokens[$use]['conditions'][$scopePtr])
+                        || $tokens[$use]['level'] !== $tokens[$scopePtr]['level'] + 1))
+            ) {
+                $use = $phpcsFile->findNext(Tokens::$emptyTokens, $use + 1, $end, true);
+                continue;
+            }
+
+            // find semicolon as the end of the global use scope
+            $endOfScope = $phpcsFile->findNext(T_SEMICOLON, $use + 1);
+
+            $startOfName = $phpcsFile->findNext([T_STRING, T_NS_SEPARATOR], $use + 1, $endOfScope);
+
+            $type = 'class';
+            if (T_STRING === $tokens[$startOfName]['code']) {
+                $lowerContent = mb_strtolower($tokens[$startOfName]['content']);
+                if ('function' === $lowerContent || 'const' === $lowerContent) {
+                    $type = $lowerContent;
+
+                    $startOfName = $phpcsFile->findNext([T_STRING, T_NS_SEPARATOR], $startOfName + 1, $endOfScope);
+                }
+            }
+
+            $uses[] = [
+                'ptrUse' => $use,
+                'name'   => trim($phpcsFile->getTokensAsString($startOfName, $endOfScope - $startOfName)),
+                'ptrEnd' => $endOfScope,
+                'string' => trim($phpcsFile->getTokensAsString($use, $endOfScope - $use + 1)),
+                'type'   => $type,
+            ];
+
+            $use = $phpcsFile->findNext(Tokens::$emptyTokens, $endOfScope + 1, $end, true);
+        }
+
+        return $uses;
+    }
+
     /**
      * @param string $content
      *

SymfonyCustom/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -9,6 +9,10 @@
 use PHP_CodeSniffer\Util\Tokens;
 use SymfonyCustom\Helpers\FixerHelper;
 
+use function count;
+use function in_array;
+use function mb_strlen;
+
 /**
  * A test to ensure that arrays conform to the array coding standard.
  */

SymfonyCustom/Sniffs/Commenting/DocCommentForbiddenTagsSniff.php

@@ -7,6 +7,8 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 
+use function in_array;
+
 /**
  * Throws errors if forbidden tags are met.
  */

SymfonyCustom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php

@@ -10,6 +10,9 @@
 use SymfonyCustom\Helpers\FixerHelper;
 use SymfonyCustom\Helpers\SniffHelper;
 
+use function array_merge;
+use function in_array;
+
 /**
  * Throws errors if comments are not grouped by type with one blank line between them.
  */

SymfonyCustom/Sniffs/Commenting/DocCommentSniff.php

@@ -8,6 +8,10 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 use SymfonyCustom\Helpers\FixerHelper;
 
+use function ltrim;
+use function rtrim;
+use function str_repeat;
+
 /**
  * Ensures doc blocks follow basic formatting.
  */

SymfonyCustom/Sniffs/Commenting/FunctionCommentSniff.php

@@ -9,6 +9,10 @@
 use PHP_CodeSniffer\Util\Tokens;
 use SymfonyCustom\Helpers\SniffHelper;
 
+use function count;
+use function preg_match;
+use function preg_replace;
+
 /**
  * SymfonyCustom standard customization to PEARs FunctionCommentSniff.
  */

SymfonyCustom/Sniffs/Commenting/VariableCommentSniff.php

@@ -8,6 +8,9 @@
 use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
 use SymfonyCustom\Helpers\SniffHelper;
 
+use function preg_match;
+use function preg_replace;
+
 /**
  * Parses and verifies the variable doc comment.
  */

SymfonyCustom/Sniffs/Formatting/BlankLineBeforeReturnSniff.php

@@ -8,6 +8,8 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
 
+use function in_array;
+
 /**
  * Throws errors if there's no blank line before return statements.
  */

SymfonyCustom/Sniffs/Formatting/YodaConditionSniff.php

@@ -8,6 +8,9 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
 
+use function array_merge;
+use function in_array;
+
 /**
  * Enforces Yoda conditional statements.
  */