Skip to content

Commit

Permalink
Don't move file-level text to class-level if it already exists.
Browse files Browse the repository at this point in the history
  • Loading branch information
@yunosh
yunosh committed Mar 23, 2017
1 parent 62ce78f commit b479b09
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 8 deletions.
18 changes: 10 additions & 8 deletions framework/Refactor/lib/Horde/Refactor/Rule/FileLevelDocBlock.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,14 +290,16 @@ protected function _checkDocBlock($which)
if (strlen($docblock->getShortDescription()) &&
$which == 'file') {
// Move the file-level descriptions to the class level.
$otherBlock = $this->_getDocBlock(
$docblock->getText() . "\n\n" . $otherBlock->getText(),
$otherBlock->getTags()
);
$this->_tokens = $this->_tokens->splice(
$otherPos, 1, array($serializer->getDocComment($otherBlock))
);
$this->_secondBlock = $otherBlock;
if (strpos($otherBlock->getText(), $docblock->getText()) === false) {
$otherBlock = $this->_getDocBlock(
$docblock->getText() . "\n\n" . $otherBlock->getText(),
$otherBlock->getTags()
);
$this->_tokens = $this->_tokens->splice(
$otherPos, 1, array($serializer->getDocComment($otherBlock))
);
$this->_secondBlock = $otherBlock;
}
$docblock = $this->_getDocBlock('', $docblock->getTags());
}
if (!strlen($docblock->getShortDescription()) &&
Expand Down
4 changes: 4 additions & 0 deletions framework/Refactor/package.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@
<file name="ClassLevelDocBlock.php" role="test" />
<file name="ClassLevelDocBlockWithFileLevelDocs.php" role="test" />
<file name="ClassLevelDocsInFileLevel.php" role="test" />
<file name="ClassLevelDocsInFileLevelDuplicate.php" role="test" />
<file name="ConfiguredNoFileLevelDocBlock.php" role="test" />
<file name="ExtractYearFixTagOrder.php" role="test" />
<file name="FileLevelDocsInClassLevel.php" role="test" />
Expand All @@ -185,6 +186,7 @@
<file name="ClassLevelDocBlock.php" role="test" />
<file name="ClassLevelDocBlockWithFileLevelDocs.php" role="test" />
<file name="ClassLevelDocsInFileLevel.php" role="test" />
<file name="ClassLevelDocsInFileLevelDuplicate.php" role="test" />
<file name="CorrectDocBlocks.php" role="test" />
<file name="DifferentCopyrightNames.php" role="test" />
<file name="DifferentCopyrightYears.php" role="test" />
Expand Down Expand Up @@ -348,6 +350,7 @@
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocBlock.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocBlockWithFileLevelDocs.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocBlockWithFileLevelDocs.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocsInFileLevel.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocsInFileLevel.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocsInFileLevelDuplicate.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocsInFileLevelDuplicate.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/CorrectDocBlocks.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/CorrectDocBlocks.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/DifferentCopyrightNames.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/DifferentCopyrightNames.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/DifferentCopyrightYears.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/DifferentCopyrightYears.php" />
Expand All @@ -362,6 +365,7 @@
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlock.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlockWithFileLevelDocs.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlockWithFileLevelDocs.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevel.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevel.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevelDuplicate.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevelDuplicate.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ConfiguredNoFileLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ConfiguredNoFileLevelDocBlock.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ExtractYearFixTagOrder.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ExtractYearFixTagOrder.php" />
<install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/FileLevelDocsInClassLevel.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/FileLevelDocsInClassLevel.php" />
Expand Down
1 change: 1 addition & 0 deletions framework/Refactor/test/Horde/Refactor/FileLevelDocBlockTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ public function getFileNames()
array('ExtractYearFixTagOrder.php', false),
array('OtherCopyright.php', false),
array('ClassLevelDocsInFileLevel.php', false),
array('ClassLevelDocsInFileLevelDuplicate.php', false),
array('FileLevelDocsInClassLevel.php', false),
array('RemoveForbiddenTags.php', false),
array('RemoveStripText.php', false),
Expand Down
27 changes: 27 additions & 0 deletions ...tor/test/Horde/Refactor/fixtures/FileLevelDocBlock/ClassLevelDocsInFileLevelDuplicate.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php
/**
* Summary
*
* Copyright 2011 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (ASL). If you
* did not receive this file, see http://www.horde.org/licenses/apache.
*
* @author
* @category Horde
* @license http://www.horde.org/licenses/... ...
* @package
*/

/**
* Summary
*
* @author
* @category Horde
* @copyright 2011 Horde LLC
* @license http://www.horde.org/licenses/... ...
* @package
*/
class Foo
{
}
25 changes: 25 additions & 0 deletions ...rde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevelDuplicate.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php
/**
* Copyright 2011 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (ASL). If you
* did not receive this file, see http://www.horde.org/licenses/apache.
*
* @author
* @category Horde
* @license http://www.horde.org/licenses/... ...
* @package
*/

/**
* Summary
*
* @author
* @category Horde
* @copyright 2011 Horde LLC
* @license http://www.horde.org/licenses/... ...
* @package
*/
class Foo
{
}

0 comments on commit b479b09

Please sign in to comment.