Merge pull request #2 from DanielSiepmann/feature/extend-legacy-class-name-migration
FEATURE: Also migrate PHPDoc annotations
This commit is contained in:
commit
2d57fef6f1
4 changed files with 197 additions and 57 deletions
|
@ -4,7 +4,7 @@
|
||||||
"type": "project",
|
"type": "project",
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"Typo3Update\\": "src/Classes/"
|
"Typo3Update\\": "src/Standards/Typo3Update/"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
<?php
|
<?php
|
||||||
|
namespace Typo3Update\Sniffs\LegacyClassnames;
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||||
|
@ -19,11 +20,12 @@
|
||||||
* 02110-1301, USA.
|
* 02110-1301, USA.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
use PHP_CodeSniffer_File as PhpcsFile;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This sniff detects old, legacy class names like t3lib_div.
|
* Provide common uses for all sniffs.
|
||||||
* Also it will make them fixable and migrate them to new ones.
|
|
||||||
*/
|
*/
|
||||||
class Typo3Update_Sniffs_Legacy_ClassnamesSniff implements PHP_CodeSniffer_Sniff
|
trait ClassnameCheckerTrait
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Contains mapping from old -> new class names.
|
* Contains mapping from old -> new class names.
|
||||||
|
@ -34,49 +36,45 @@ class Typo3Update_Sniffs_Legacy_ClassnamesSniff implements PHP_CodeSniffer_Sniff
|
||||||
/**
|
/**
|
||||||
* @param string $mappingFile File containing php array for mapping.
|
* @param string $mappingFile File containing php array for mapping.
|
||||||
*/
|
*/
|
||||||
public function __construct($mappingFile = __DIR__ . '/../../../../../LegacyClassnames.php')
|
public function initialize($mappingFile = __DIR__ . '/../../../../../LegacyClassnames.php')
|
||||||
{
|
{
|
||||||
|
if ($this->legacyClassnames !== []) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
$legacyClassnames = require $mappingFile;
|
$legacyClassnames = require $mappingFile;
|
||||||
$this->legacyClassnames = $legacyClassnames['aliasToClassNameMapping'];
|
$this->legacyClassnames = $legacyClassnames['aliasToClassNameMapping'];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the token types that this sniff is interested in.
|
* @param string $classname
|
||||||
*
|
* @return bool
|
||||||
* @see http://php.net/manual/en/tokens.php
|
|
||||||
*
|
|
||||||
* @return array<int>
|
|
||||||
*/
|
*/
|
||||||
public function register()
|
public function isLegacyClassname($classname)
|
||||||
{
|
{
|
||||||
return [
|
$this->initialize();
|
||||||
T_EXTENDS,
|
return isset($this->legacyClassnames[strtolower($classname)]);
|
||||||
T_IMPLEMENTS,
|
|
||||||
// T_INSTANCEOF,
|
|
||||||
// T_NEW,
|
|
||||||
// T_STRING,
|
|
||||||
// T_USE,
|
|
||||||
];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Processes the tokens that this sniff is interested in.
|
* @param string $classname
|
||||||
*
|
* @return string
|
||||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
|
||||||
* @param int $stackPtr The position in the stack where
|
|
||||||
* the token was found.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
public function getNewClassname($classname)
|
||||||
{
|
{
|
||||||
$tokens = $phpcsFile->getTokens();
|
$this->initialize();
|
||||||
$classnamePosition = $phpcsFile->findNext(T_STRING, $stackPtr);
|
return $this->legacyClassnames[strtolower($classname)];
|
||||||
if ($classnamePosition === false) {
|
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
$classname = $tokens[$classnamePosition]['content'];
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an fixable error if given $classname is legacy.
|
||||||
|
*
|
||||||
|
* @param PhpcsFile $phpcsFile
|
||||||
|
* @param int $classnamePosition
|
||||||
|
* @param string $classname
|
||||||
|
*/
|
||||||
|
public function addFixableError(PhpcsFile $phpcsFile, $classnamePosition, $classname)
|
||||||
|
{
|
||||||
if ($this->isLegacyClassname($classname) === false) {
|
if ($this->isLegacyClassname($classname) === false) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
@ -88,37 +86,23 @@ class Typo3Update_Sniffs_Legacy_ClassnamesSniff implements PHP_CodeSniffer_Sniff
|
||||||
[$classname]
|
[$classname]
|
||||||
);
|
);
|
||||||
|
|
||||||
if ($fix === false) {
|
if ($fix === true) {
|
||||||
return;
|
$phpcsFile->fixer->replaceToken(
|
||||||
}
|
$classnamePosition,
|
||||||
|
$this->getTokenForReplacement('\\' . $this->getNewClassname($classname))
|
||||||
switch ($tokens[$stackPtr]['code']) {
|
);
|
||||||
case T_EXTENDS:
|
|
||||||
case T_IMPLEMENTS:
|
|
||||||
$phpcsFile->fixer->replaceToken($classnamePosition, '\\' . $this->getNewClassname($classname));
|
|
||||||
break;
|
|
||||||
|
|
||||||
default:
|
|
||||||
throw new \RuntimeException('Could not fix type "' . $tokens[$stackPtr]['type'] . '"', 1488891438);
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $classname
|
* String to use for replacing / fixing the token.
|
||||||
* @return bool
|
* Default is class name itself, can be overwritten in sniff for special behaviour.
|
||||||
*/
|
*
|
||||||
protected function isLegacyClassname($classname)
|
|
||||||
{
|
|
||||||
return isset($this->legacyClassnames[strtolower($classname)]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $classname
|
* @param string $classname
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function getNewClassname($classname)
|
public function getTokenForReplacement($classname)
|
||||||
{
|
{
|
||||||
return $this->legacyClassnames[strtolower($classname)];
|
return $classname;
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -0,0 +1,94 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or
|
||||||
|
* modify it under the terms of the GNU General Public License
|
||||||
|
* as published by the Free Software Foundation; either version 2
|
||||||
|
* of the License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program; if not, write to the Free Software
|
||||||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||||
|
* 02110-1301, USA.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Migrate PHP Doc comments.
|
||||||
|
*
|
||||||
|
* E.g. annotations like @param or @return, see $allowedTags.
|
||||||
|
*/
|
||||||
|
class Typo3Update_Sniffs_LegacyClassnames_DocCommentSniff implements PHP_CodeSniffer_Sniff
|
||||||
|
{
|
||||||
|
use \Typo3Update\Sniffs\LegacyClassnames\ClassnameCheckerTrait;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The configured tags will be processed.
|
||||||
|
* @var array<string>
|
||||||
|
*/
|
||||||
|
protected $allowedTags = ['@param', '@return', '@var'];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Original token for reuse accross methods.
|
||||||
|
* @var array
|
||||||
|
*/
|
||||||
|
protected $originalToken = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the token types that this sniff is interested in.
|
||||||
|
*
|
||||||
|
* @return array<int>
|
||||||
|
*/
|
||||||
|
public function register()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
T_DOC_COMMENT_TAG,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Processes the tokens that this sniff is interested in.
|
||||||
|
*
|
||||||
|
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||||
|
* @param int $stackPtr The position in the stack where
|
||||||
|
* the token was found.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||||
|
{
|
||||||
|
$tokens = $phpcsFile->getTokens();
|
||||||
|
if (!in_array($tokens[$stackPtr]['content'], $this->allowedTags)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
$classnamePosition = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $stackPtr);
|
||||||
|
if ($classnamePosition === false) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
$classname = explode(' ', $tokens[$classnamePosition]['content'])[0];
|
||||||
|
|
||||||
|
$this->originalToken = $tokens[$classnamePosition]['content'];
|
||||||
|
$this->addFixableError($phpcsFile, $classnamePosition, $classname);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* As token contains more then just class name, we have to build new content ourself.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @param string $classname
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getTokenForReplacement($classname)
|
||||||
|
{
|
||||||
|
$token = explode(' ', $this->originalToken);
|
||||||
|
$token[0] = $classname;
|
||||||
|
|
||||||
|
return implode(' ', $token);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,62 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or
|
||||||
|
* modify it under the terms of the GNU General Public License
|
||||||
|
* as published by the Free Software Foundation; either version 2
|
||||||
|
* of the License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program; if not, write to the Free Software
|
||||||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||||
|
* 02110-1301, USA.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detect and migrate extend and implement of old legacy classnames.
|
||||||
|
*/
|
||||||
|
class Typo3Update_Sniffs_LegacyClassnames_InheritanceSniff implements PHP_CodeSniffer_Sniff
|
||||||
|
{
|
||||||
|
use \Typo3Update\Sniffs\LegacyClassnames\ClassnameCheckerTrait;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the token types that this sniff is interested in.
|
||||||
|
*
|
||||||
|
* @return array<int>
|
||||||
|
*/
|
||||||
|
public function register()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
T_EXTENDS,
|
||||||
|
T_IMPLEMENTS,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Processes the tokens that this sniff is interested in.
|
||||||
|
*
|
||||||
|
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||||
|
* @param int $stackPtr The position in the stack where
|
||||||
|
* the token was found.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||||
|
{
|
||||||
|
$tokens = $phpcsFile->getTokens();
|
||||||
|
$classnamePosition = $phpcsFile->findNext(T_STRING, $stackPtr);
|
||||||
|
if ($classnamePosition === false) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
$classname = $tokens[$classnamePosition]['content'];
|
||||||
|
|
||||||
|
$this->addFixableError($phpcsFile, $classnamePosition, $classname);
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue