Work-Related/automated-typo3-update
Work-Related/automated-typo3-update
1
0
Code Issues Activity

BUGFIX: Allow PhpDocCommentSniff to work find all classnames in comment

Browse source 
* Before only the first classname was returned.
* All class names are returned now.
* This allows to fix Extbase type annotations for relations.
This commit is contained in:
Daniel Siepmann 2017-05-11 11:17:46 +02:00
parent 413d8e45f5
commit f2910b02b2
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
4 changed files with 44 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Standards/Typo3Update/Sniffs/Classname/PhpDocCommentSniff.php
View file

@ -69,7 +69,7 @@ class Typo3Update_Sniffs_Classname_PhpDocCommentSniff implements PhpCsSniff
if ($classnamePosition === false) { if ($classnamePosition === false) {
return; return;
} }
$classnames = explode('|', explode(' ', $tokens[$classnamePosition]['content'])[0]); $classnames = array_filter(preg_split('/\||\s|\<|\>/', $tokens[$classnamePosition]['content']));
foreach ($classnames as $classname) { foreach ($classnames as $classname) {
$this->processFeatures($phpcsFile, $classnamePosition, $classname); $this->processFeatures($phpcsFile, $classnamePosition, $classname);

15
tests/Fixtures/Standards/Typo3Update/Sniffs/Classname/PhpDocCommentSniff/Expected.diff
View file

@ -1,6 +1,6 @@
--- tests/Fixtures/Standards/Typo3Update/Sniffs/Classname/PhpDocCommentSniff/InputFileForIssues.php --- tests/Fixtures/Standards/Typo3Update/Sniffs/Classname/PhpDocCommentSniff/InputFileForIssues.php
+++ PHP_CodeSniffer +++ PHP_CodeSniffer
@@ -22,20 +22,20 @@ @@ -22,25 +22,25 @@
class InputFileForIssues class InputFileForIssues
{ {
/** /**
@ -10,6 +10,12 @@
*/ */
protected $someVar; protected $someVar;
/**
- * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<Tx_Extbase_Domain_Model_Category>
+ * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\TYPO3\CMS\Extbase\Domain\Model\Category>
*/
protected $someRelation;
/** /**
- * @param t3lib_div - * @param t3lib_div
+ * @param \TYPO3\CMS\Core\Utility\GeneralUtility + * @param \TYPO3\CMS\Core\Utility\GeneralUtility
@ -20,8 +26,9 @@
*/ */
public function doSomething($something) public function doSomething($something)
{ {
- /** @var t3lib_div $variable */ // This is supported as this is a phpdoc. - /** @var t3lib_div $variable */
+ /** @var \TYPO3\CMS\Core\Utility\GeneralUtility $variable */ // This is supported as this is a phpdoc. - /** @var $variable t3lib_div */
/** @var $variable t3lib_div */ // This is not supported! Use inline comments instead. + /** @var \TYPO3\CMS\Core\Utility\GeneralUtility $variable */
+ /** @var $variable \TYPO3\CMS\Core\Utility\GeneralUtility */
} }
} }

32
tests/Fixtures/Standards/Typo3Update/Sniffs/Classname/PhpDocCommentSniff/Expected.json
View file

@ -1,7 +1,7 @@
{ {
"files": { "files": {
"InputFileForIssues.php": { "InputFileForIssues.php": {
"errors": 4, "errors": 6,
"messages": [ "messages": [
{ {
"column": 13, "column": 13,
@ -13,9 +13,18 @@
"type": "ERROR" "type": "ERROR"
}, },
{ {
"column": 15, "column": 13,
"fixable": true, "fixable": true,
"line": 31, "line": 31,
"message": "Legacy classes are not allowed; found \"Tx_Extbase_Domain_Model_Category\", use \"TYPO3\\CMS\\Extbase\\Domain\\Model\\Category\" instead",
"severity": 5,
"source": "Typo3Update.Classname.PhpDocComment.legacyClassname",
"type": "ERROR"
},
{
"column": 15,
"fixable": true,
"line": 36,
"message": "Legacy classes are not allowed; found \"t3lib_div\", use \"TYPO3\\CMS\\Core\\Utility\\GeneralUtility\" instead", "message": "Legacy classes are not allowed; found \"t3lib_div\", use \"TYPO3\\CMS\\Core\\Utility\\GeneralUtility\" instead",
"severity": 5, "severity": 5,
"source": "Typo3Update.Classname.PhpDocComment.legacyClassname", "source": "Typo3Update.Classname.PhpDocComment.legacyClassname",
@ -24,7 +33,7 @@
{ {
"column": 15, "column": 15,
"fixable": false, "fixable": false,
"line": 32, "line": 37,
"message": "Calls to removed code are not allowed; found \\TYPO3\\CMS\\Backend\\Template\\MediumDocumentTemplate. Removed in 7.0. Use \\TYPO3\\CMS\\Backend\\Template\\DocumentTemplate instead. See: https://docs.typo3.org/typo3cms/extensions/core/7.6/Changelog/7.0/Breaking-61782-DeprecatedDocumentTemplateClassesRemoved.html", "message": "Calls to removed code are not allowed; found \\TYPO3\\CMS\\Backend\\Template\\MediumDocumentTemplate. Removed in 7.0. Use \\TYPO3\\CMS\\Backend\\Template\\DocumentTemplate instead. See: https://docs.typo3.org/typo3cms/extensions/core/7.6/Changelog/7.0/Breaking-61782-DeprecatedDocumentTemplateClassesRemoved.html",
"severity": 5, "severity": 5,
"source": "Typo3Update.Classname.PhpDocComment.RemovedClass.TYPO3_CMS_Backend_Template_MediumDocumentTemplate", "source": "Typo3Update.Classname.PhpDocComment.RemovedClass.TYPO3_CMS_Backend_Template_MediumDocumentTemplate",
@ -33,7 +42,7 @@
{ {
"column": 16, "column": 16,
"fixable": true, "fixable": true,
"line": 34, "line": 39,
"message": "Legacy classes are not allowed; found \"Tx_Extbase_Configuration_Configurationmanager\", use \"TYPO3\\CMS\\Extbase\\Configuration\\ConfigurationManager\" instead", "message": "Legacy classes are not allowed; found \"Tx_Extbase_Configuration_Configurationmanager\", use \"TYPO3\\CMS\\Extbase\\Configuration\\ConfigurationManager\" instead",
"severity": 5, "severity": 5,
"source": "Typo3Update.Classname.PhpDocComment.legacyClassname", "source": "Typo3Update.Classname.PhpDocComment.legacyClassname",
@ -42,7 +51,16 @@
{ {
"column": 18, "column": 18,
"fixable": true, "fixable": true,
"line": 38, "line": 43,
"message": "Legacy classes are not allowed; found \"t3lib_div\", use \"TYPO3\\CMS\\Core\\Utility\\GeneralUtility\" instead",
"severity": 5,
"source": "Typo3Update.Classname.PhpDocComment.legacyClassname",
"type": "ERROR"
},
{
"column": 18,
"fixable": true,
"line": 44,
"message": "Legacy classes are not allowed; found \"t3lib_div\", use \"TYPO3\\CMS\\Core\\Utility\\GeneralUtility\" instead", "message": "Legacy classes are not allowed; found \"t3lib_div\", use \"TYPO3\\CMS\\Core\\Utility\\GeneralUtility\" instead",
"severity": 5, "severity": 5,
"source": "Typo3Update.Classname.PhpDocComment.legacyClassname", "source": "Typo3Update.Classname.PhpDocComment.legacyClassname",
@ -53,8 +71,8 @@
} }
}, },
"totals": { "totals": {
"errors": 4, "errors": 6,
"fixable": 4, "fixable": 6,
"warnings": 1 "warnings": 1
} }
} }

9
tests/Fixtures/Standards/Typo3Update/Sniffs/Classname/PhpDocCommentSniff/InputFileForIssues.php
View file

@ -27,6 +27,11 @@ class InputFileForIssues
*/ */
protected $someVar; protected $someVar;
/**
* @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<Tx_Extbase_Domain_Model_Category>
*/
protected $someRelation;
/** /**
* @param t3lib_div * @param t3lib_div
* @param \TYPO3\CMS\Backend\Template\MediumDocumentTemplate * @param \TYPO3\CMS\Backend\Template\MediumDocumentTemplate
@ -35,7 +40,7 @@ class InputFileForIssues
*/ */
public function doSomething($something) public function doSomething($something)
{ {
/** @var t3lib_div $variable */ // This is supported as this is a phpdoc. /** @var t3lib_div $variable */
/** @var $variable t3lib_div */ // This is not supported! Use inline comments instead. /** @var $variable t3lib_div */
} }
} }