💄 Typeint

VincentLanglet · VincentLanglet · commit 15c1c3c0dda2 · 2019-06-02T23:38:24.000+02:00
diff --git a/SymfonyCustom/Sniffs/Commenting/FunctionCommentSniff.php b/SymfonyCustom/Sniffs/Commenting/FunctionCommentSniff.php
@@ -269,7 +269,7 @@ protected function processParams(
      *
      * @return bool True if the return does not return anything
      */
-    protected function isMatchingReturn($tokens, $returnPos)
+    protected function isMatchingReturn(array $tokens, $returnPos)
     {
         do {
             $returnPos++;
diff --git a/TwigCS/Command/TwigCSCommand.php b/TwigCS/Command/TwigCSCommand.php
@@ -34,7 +34,7 @@ protected function configure()
                     'e',
                     InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
                     'Excludes, based on regex, paths of files and folders from parsing',
-                    []
+                    ['vendor/']
                 ),
                 new InputOption(
                     'level',
diff --git a/TwigCS/Config/Config.php b/TwigCS/Config/Config.php
@@ -16,7 +16,7 @@ class Config
      * @var array
      */
     public static $defaultConfig = [
-        'exclude'          => ['vendor/'],
+        'exclude'          => [],
         'pattern'          => '*.twig',
         'paths'            => [],
         'workingDirectory' => '',
@@ -29,14 +29,12 @@ class Config
      */
     protected $config;
 
-    public function __construct()
+    /**
+     * @param array $config
+     */
+    public function __construct(array $config = [])
     {
-        $args = func_get_args();
-
-        $this->config = $this::$defaultConfig;
-        foreach ($args as $arg) {
-            $this->config = array_merge($this->config, $arg);
-        }
+        $this->config = array_merge($this::$defaultConfig, $config);
     }
 
     /**
@@ -67,7 +65,7 @@ public function findFiles()
             $files->exclude($exclude);
         }
 
-        return $files;
+        return iterator_to_array($files, false);
     }
 
     /**
@@ -79,7 +77,7 @@ public function findFiles()
      *
      * @throws Exception
      */
-    public function get($key)
+    public function get(string $key)
     {
         if (!isset($this->config[$key])) {
             throw new Exception(sprintf('Configuration key "%s" does not exist', $key));
diff --git a/TwigCS/Linter.php b/TwigCS/Linter.php
@@ -3,7 +3,6 @@
 namespace TwigCS;
 
 use \Exception;
-use \Traversable;
 use Twig\Environment;
 use Twig\Error\Error;
 use Twig\Source;
@@ -42,19 +41,15 @@ public function __construct(Environment $env, Tokenizer $tokenizer)
     /**
      * Run the linter on the given $files against the given $ruleset.
      *
-     * @param array|string $files   List of files to process.
-     * @param Ruleset      $ruleset Set of rules to check.
+     * @param array   $files   List of files to process.
+     * @param Ruleset $ruleset Set of rules to check.
      *
      * @return Report an object with all violations and stats.
      *
      * @throws Exception
      */
-    public function run($files, Ruleset $ruleset)
+    public function run(array $files, Ruleset $ruleset)
     {
-        if (!is_array($files) && !$files instanceof Traversable) {
-            $files = [$files];
-        }
-
         if (empty($files)) {
             throw new Exception('No files to process, provide at least one file to be linted');
         }
@@ -91,7 +86,7 @@ public function run($files, Ruleset $ruleset)
      *
      * @return bool
      */
-    public function processTemplate($file, $ruleset, $report)
+    public function processTemplate(string $file, Ruleset $ruleset, Report $report)
     {
         $twigSource = new Source(file_get_contents($file), $file, $file);
 
@@ -118,7 +113,7 @@ public function processTemplate($file, $ruleset, $report)
             $sniffViolation = new SniffViolation(
                 SniffInterface::MESSAGE_TYPE_ERROR,
                 sprintf('Unable to tokenize file'),
-                (string) $file
+                $file
             );
 
             $report->addMessage($sniffViolation);
@@ -141,7 +136,7 @@ public function processTemplate($file, $ruleset, $report)
      * @param Report      $report
      * @param string|null $file
      */
-    protected function setErrorHandler(Report $report, $file = null)
+    protected function setErrorHandler(Report $report, string $file = null)
     {
         set_error_handler(function ($type, $message) use ($report, $file) {
             if (E_USER_DEPRECATED === $type) {
diff --git a/TwigCS/Report/Report.php b/TwigCS/Report/Report.php
@@ -75,7 +75,7 @@ public function addMessage(SniffViolation $sniffViolation)
      *
      * @return SniffViolation[]
      */
-    public function getMessages($filters = [])
+    public function getMessages(array $filters = [])
     {
         if (empty($filters)) {
             // Return all messages, without filtering.
@@ -100,7 +100,7 @@ public function getMessages($filters = [])
     /**
      * @param string $file
      */
-    public function addFile($file)
+    public function addFile(string $file)
     {
         $this->files[] = $file;
     }
diff --git a/TwigCS/Report/SniffViolation.php b/TwigCS/Report/SniffViolation.php
@@ -57,7 +57,7 @@ class SniffViolation
      * @param string   $filename
      * @param int|null $line
      */
-    public function __construct($level, $message, $filename, $line = null)
+    public function __construct(int $level, string $message, string $filename, int $line = null)
     {
         $this->level        = $level;
         $this->message      = $message;
@@ -99,11 +99,11 @@ public function getLevelAsString()
     /**
      * Get the integer value for a given string $level.
      *
-     * @param int $level
+     * @param string $level
      *
      * @return int
      */
-    public static function getLevelAsInt($level)
+    public static function getLevelAsInt(string $level)
     {
         switch (strtoupper($level)) {
             case 'NOTICE':
@@ -143,7 +143,7 @@ public function getLine()
      */
     public function getFilename()
     {
-        return (string) $this->filename;
+        return $this->filename;
     }
 
     /**
@@ -153,7 +153,7 @@ public function getFilename()
      *
      * @return self
      */
-    public function setLinePosition($linePosition)
+    public function setLinePosition(int $linePosition)
     {
         $this->linePosition = $linePosition;
 
diff --git a/TwigCS/Report/TextFormatter.php b/TwigCS/Report/TextFormatter.php
@@ -29,7 +29,7 @@ class TextFormatter
      * @param InputInterface  $input
      * @param OutputInterface $output
      */
-    public function __construct($input, $output)
+    public function __construct(InputInterface $input, OutputInterface $output)
     {
         $this->io = new SymfonyStyle($input, $output);
     }
@@ -38,7 +38,7 @@ public function __construct($input, $output)
      * @param Report      $report
      * @param string|null $level
      */
-    public function display(Report $report, $level = null)
+    public function display(Report $report, string $level = null)
     {
         foreach ($report->getFiles() as $file) {
             $fileMessages = $report->getMessages([
@@ -106,7 +106,7 @@ public function display(Report $report, $level = null)
      *
      * @return array
      */
-    protected function getContext($template, $line, $context)
+    protected function getContext(string $template, int $line, int $context)
     {
         $lines = explode("\n", $template);
 
diff --git a/TwigCS/Ruleset/Generic/BlankEOFSniff.php b/TwigCS/Ruleset/Generic/BlankEOFSniff.php
@@ -20,7 +20,7 @@ class BlankEOFSniff extends AbstractSniff
      *
      * @throws Exception
      */
-    public function process(Token $token, $tokenPosition, $tokens)
+    public function process(Token $token, int $tokenPosition, array $tokens)
     {
         if ($this->isTokenMatching($token, Token::EOF_TYPE)) {
             $i = 0;
diff --git a/TwigCS/Ruleset/Generic/DelimiterSpacingSniff.php b/TwigCS/Ruleset/Generic/DelimiterSpacingSniff.php
@@ -20,7 +20,7 @@ class DelimiterSpacingSniff extends AbstractSniff
      *
      * @throws Exception
      */
-    public function process(Token $token, $tokenPosition, $tokens)
+    public function process(Token $token, int $tokenPosition, array $tokens)
     {
         if ($this->isTokenMatching($token, Token::VAR_START_TYPE)
             || $this->isTokenMatching($token, Token::BLOCK_START_TYPE)
diff --git a/TwigCS/Ruleset/Generic/DisallowCommentedCodeSniff.php b/TwigCS/Ruleset/Generic/DisallowCommentedCodeSniff.php
@@ -22,7 +22,7 @@ class DisallowCommentedCodeSniff extends AbstractSniff
      *
      * @throws Exception
      */
-    public function process(Token $token, $tokenPosition, $tokens)
+    public function process(Token $token, int $tokenPosition, array $tokens)
     {
         if ($this->isTokenMatching($token, Token::COMMENT_START_TYPE)) {
             $i = $tokenPosition;
diff --git a/TwigCS/Ruleset/Ruleset.php b/TwigCS/Ruleset/Ruleset.php
@@ -51,7 +51,7 @@ public function addSniff(SniffInterface $sniff)
      *
      * @throws Exception
      */
-    public function addStandard($standardName = 'Generic')
+    public function addStandard(string $standardName = 'Generic')
     {
         try {
             $finder = Finder::create()->in(__DIR__.'/'.$standardName)->files();
diff --git a/TwigCS/Sniff/AbstractSniff.php b/TwigCS/Sniff/AbstractSniff.php
@@ -75,7 +75,7 @@ public function getReport()
      *
      * @return bool
      */
-    public function isTokenMatching(Token $token, $type, $value = null)
+    public function isTokenMatching(Token $token, int $type, string $value = null)
     {
         return $token->getType() === $type && (null === $value || $token->getValue() === $value);
     }
@@ -91,7 +91,7 @@ public function isTokenMatching(Token $token, $type, $value = null)
      *
      * @throws Exception
      */
-    public function addMessage($messageType, $message, Token $token)
+    public function addMessage(int $messageType, string $message, Token $token)
     {
         $sniffViolation = new SniffViolation(
             $messageType,
@@ -111,7 +111,7 @@ public function addMessage($messageType, $message, Token $token)
      *
      * @return string
      */
-    public function stringifyValue($token)
+    public function stringifyValue(Token $token)
     {
         if ($token->getType() === Token::STRING_TYPE) {
             return $token->getValue();
diff --git a/TwigCS/Sniff/SniffInterface.php b/TwigCS/Sniff/SniffInterface.php
@@ -50,5 +50,5 @@ public function getReport();
      * @param int     $tokenPosition
      * @param Token[] $stream
      */
-    public function process(Token $token, $tokenPosition, $stream);
+    public function process(Token $token, int $tokenPosition, array $stream);
 }
diff --git a/TwigCS/Tests/AbstractSniffTest.php b/TwigCS/Tests/AbstractSniffTest.php
@@ -50,7 +50,7 @@ protected function checkGenericSniff(SniffInterface $sniff, array $expects)
             $file = __DIR__.'/Fixtures/'.$class->getShortName().'.twig';
 
             $ruleset->addSniff($sniff);
-            $report = $this->lint->run($file, $ruleset);
+            $report = $this->lint->run([$file], $ruleset);
         } catch (Exception $e) {
             $this->fail($e->getMessage());
 
diff --git a/TwigCS/Token/Token.php b/TwigCS/Token/Token.php
@@ -63,8 +63,13 @@ class Token
      * @param string      $filename
      * @param string|null $value
      */
-    public function __construct($type, $line, $position, $filename, $value = null)
-    {
+    public function __construct(
+        int $type,
+        int $line,
+        int $position,
+        string $filename,
+        string $value = null
+    ) {
         $this->type = $type;
         $this->line = $line;
         $this->position = $position;
diff --git a/TwigCS/Token/TokenParser.php b/TwigCS/Token/TokenParser.php
@@ -21,7 +21,7 @@ class TokenParser extends AbstractTokenParser
     /**
      * @param string $name
      */
-    public function __construct($name)
+    public function __construct(string $name)
     {
         $this->name = $name;
     }
diff --git a/TwigCS/Token/Tokenizer.php b/TwigCS/Token/Tokenizer.php
@@ -190,7 +190,7 @@ protected function getState()
     /**
      * @param int $state
      */
-    protected function pushState($state)
+    protected function pushState(int $state)
     {
         $this->state[] = $state;
     }
@@ -209,7 +209,7 @@ protected function popState()
     /**
      * @param string $code
      */
-    protected function preflightSource($code)
+    protected function preflightSource(string $code)
     {
         $tokenPositions = [];
         preg_match_all($this->regexes['lex_tokens_start'], $code, $tokenPositions, PREG_OFFSET_CAPTURE);
@@ -231,7 +231,7 @@ protected function preflightSource($code)
      *
      * @return array|null
      */
-    protected function getTokenPosition($offset = 0)
+    protected function getTokenPosition(int $offset = 0)
     {
         if (empty($this->tokenPositions)
             || !isset($this->tokenPositions[$this->currentPosition + $offset])
@@ -245,15 +245,15 @@ protected function getTokenPosition($offset = 0)
     /**
      * @param int $value
      */
-    protected function moveCurrentPosition($value = 1)
+    protected function moveCurrentPosition(int $value = 1)
     {
         $this->currentPosition += $value;
     }
 
     /**
      * @param string $value
      */
-    protected function moveCursor($value)
+    protected function moveCursor(string $value)
     {
         $this->cursor += strlen($value);
         $this->line += substr_count($value, "\n");
@@ -263,7 +263,7 @@ protected function moveCursor($value)
      * @param int         $type
      * @param string|null $value
      */
-    protected function pushToken($type, $value = null)
+    protected function pushToken(int $type, string $value = null)
     {
         $tokenPositionInLine = $this->cursor - strrpos(substr($this->code, 0, $this->cursor), PHP_EOL);
         $this->tokens[] = new Token($type, $this->line, $tokenPositionInLine, $this->filename, $value);
@@ -384,7 +384,7 @@ protected function lexComment()
     /**
      * @param int $limit
      */
-    protected function lexData($limit = 0)
+    protected function lexData(int $limit = 0)
     {
         $nextToken = $this->getTokenPosition();
         if (0 === $limit && null !== $nextToken) {

Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,7 @@ protected function processParams(`
`269`	`269`	`*`
`270`	`270`	`* @return bool True if the return does not return anything`
`271`	`271`	`*/`
`272`		`- protected function isMatchingReturn($tokens, $returnPos)`
	`272`	`+ protected function isMatchingReturn(array $tokens, $returnPos)`
`273`	`273`	`{`
`274`	`274`	`do {`
`275`	`275`	`$returnPos++;`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public function addMessage(SniffViolation $sniffViolation)`
`75`	`75`	`*`
`76`	`76`	`* @return SniffViolation[]`
`77`	`77`	`*/`
`78`		`- public function getMessages($filters = [])`
	`78`	`+ public function getMessages(array $filters = [])`
`79`	`79`	`{`
`80`	`80`	`if (empty($filters)) {`
`81`	`81`	`// Return all messages, without filtering.`
`@@ -100,7 +100,7 @@ public function getMessages($filters = [])`
`100`	`100`	`/**`
`101`	`101`	`* @param string $file`
`102`	`102`	`*/`
`103`		`- public function addFile($file)`
	`103`	`+ public function addFile(string $file)`
`104`	`104`	`{`
`105`	`105`	`$this->files[] = $file;`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class SniffViolation`
`57`	`57`	`* @param string $filename`
`58`	`58`	`* @param int\|null $line`
`59`	`59`	`*/`
`60`		`- public function __construct($level, $message, $filename, $line = null)`
	`60`	`+ public function __construct(int $level, string $message, string $filename, int $line = null)`
`61`	`61`	`{`
`62`	`62`	`$this->level = $level;`
`63`	`63`	`$this->message = $message;`
`@@ -99,11 +99,11 @@ public function getLevelAsString()`
`99`	`99`	`/**`
`100`	`100`	`* Get the integer value for a given string $level.`
`101`	`101`	`*`
`102`		`- * @param int $level`
	`102`	`+ * @param string $level`
`103`	`103`	`*`
`104`	`104`	`* @return int`
`105`	`105`	`*/`
`106`		`- public static function getLevelAsInt($level)`
	`106`	`+ public static function getLevelAsInt(string $level)`
`107`	`107`	`{`
`108`	`108`	`switch (strtoupper($level)) {`
`109`	`109`	`case 'NOTICE':`
`@@ -143,7 +143,7 @@ public function getLine()`
`143`	`143`	`*/`
`144`	`144`	`public function getFilename()`
`145`	`145`	`{`
`146`		`- return (string) $this->filename;`
	`146`	`+ return $this->filename;`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`/**`
`@@ -153,7 +153,7 @@ public function getFilename()`
`153`	`153`	`*`
`154`	`154`	`* @return self`
`155`	`155`	`*/`
`156`		`- public function setLinePosition($linePosition)`
	`156`	`+ public function setLinePosition(int $linePosition)`
`157`	`157`	`{`
`158`	`158`	`$this->linePosition = $linePosition;`
`159`	`159`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class TextFormatter`
`29`	`29`	`* @param InputInterface $input`
`30`	`30`	`* @param OutputInterface $output`
`31`	`31`	`*/`
`32`		`- public function __construct($input, $output)`
	`32`	`+ public function __construct(InputInterface $input, OutputInterface $output)`
`33`	`33`	`{`
`34`	`34`	`$this->io = new SymfonyStyle($input, $output);`
`35`	`35`	`}`
`@@ -38,7 +38,7 @@ public function __construct($input, $output)`
`38`	`38`	`* @param Report $report`
`39`	`39`	`* @param string\|null $level`
`40`	`40`	`*/`
`41`		`- public function display(Report $report, $level = null)`
	`41`	`+ public function display(Report $report, string $level = null)`
`42`	`42`	`{`
`43`	`43`	`foreach ($report->getFiles() as $file) {`
`44`	`44`	`$fileMessages = $report->getMessages([`
`@@ -106,7 +106,7 @@ public function display(Report $report, $level = null)`
`106`	`106`	`*`
`107`	`107`	`* @return array`
`108`	`108`	`*/`
`109`		`- protected function getContext($template, $line, $context)`
	`109`	`+ protected function getContext(string $template, int $line, int $context)`
`110`	`110`	`{`
`111`	`111`	`$lines = explode("\n", $template);`
`112`	`112`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class BlankEOFSniff extends AbstractSniff`
`20`	`20`	`*`
`21`	`21`	`* @throws Exception`
`22`	`22`	`*/`
`23`		`- public function process(Token $token, $tokenPosition, $tokens)`
	`23`	`+ public function process(Token $token, int $tokenPosition, array $tokens)`
`24`	`24`	`{`
`25`	`25`	`if ($this->isTokenMatching($token, Token::EOF_TYPE)) {`
`26`	`26`	`$i = 0;`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class DelimiterSpacingSniff extends AbstractSniff`
`20`	`20`	`*`
`21`	`21`	`* @throws Exception`
`22`	`22`	`*/`
`23`		`- public function process(Token $token, $tokenPosition, $tokens)`
	`23`	`+ public function process(Token $token, int $tokenPosition, array $tokens)`
`24`	`24`	`{`
`25`	`25`	`if ($this->isTokenMatching($token, Token::VAR_START_TYPE)`
`26`	`26`	`\|\| $this->isTokenMatching($token, Token::BLOCK_START_TYPE)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class DisallowCommentedCodeSniff extends AbstractSniff`
`22`	`22`	`*`
`23`	`23`	`* @throws Exception`
`24`	`24`	`*/`
`25`		`- public function process(Token $token, $tokenPosition, $tokens)`
	`25`	`+ public function process(Token $token, int $tokenPosition, array $tokens)`
`26`	`26`	`{`
`27`	`27`	`if ($this->isTokenMatching($token, Token::COMMENT_START_TYPE)) {`
`28`	`28`	`$i = $tokenPosition;`