-
-
Notifications
You must be signed in to change notification settings - Fork 344
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/duplicated array keys #484
Changes from 7 commits
44f20a9
5570e3e
dc87a6d
48e6db8
b1ea2ef
103930e
ddb8c51
3c5a822
a040a41
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
<?php | ||
/** | ||
* This file is part of PHP Mess Detector. | ||
* | ||
* Copyright (c) Manuel Pichler <mapi@phpmd.org>. | ||
* All rights reserved. | ||
* | ||
* Licensed under BSD License | ||
* For full copyright and license information, please see the LICENSE file. | ||
* Redistributions of files must retain the above copyright notice. | ||
* | ||
* @author Manuel Pichler <mapi@phpmd.org> | ||
* @copyright Manuel Pichler. All rights reserved. | ||
* @license https://opensource.org/licenses/bsd-license.php BSD License | ||
* @link http://phpmd.org/ | ||
*/ | ||
|
||
namespace PHPMD\Rule\CleanCode; | ||
|
||
use PDepend\Source\AST\AbstractASTNode; | ||
use PDepend\Source\AST\ASTArrayElement; | ||
use PDepend\Source\AST\ASTLiteral; | ||
use PDepend\Source\AST\ASTNode as PDependASTNode; | ||
use PHPMD\AbstractNode; | ||
use PHPMD\AbstractRule; | ||
use PHPMD\Node\ASTNode; | ||
use PHPMD\Rule\FunctionAware; | ||
use PHPMD\Rule\MethodAware; | ||
|
||
/** | ||
* Duplicated Array Key Rule | ||
* | ||
* This rule detects duplicated array keys. | ||
* | ||
* @author Rafał Wrzeszcz <rafal.wrzeszcz@wrzasq.pl> | ||
* @author Kamil Szymanaski <kamil.szymanski@gmail.com> | ||
*/ | ||
class DuplicatedArrayKey extends AbstractRule implements MethodAware, FunctionAware | ||
{ | ||
/** | ||
* Retrieves all arrays from single node and performs comparison logic on it | ||
* | ||
* @param AbstractNode $node | ||
* @return void | ||
*/ | ||
public function apply(AbstractNode $node) | ||
{ | ||
foreach ($node->findChildrenOfType('Array') as $arrayNode) { | ||
/** @var ASTNode $arrayNode */ | ||
$this->checkForDuplicatedArrayKeys($arrayNode); | ||
} | ||
} | ||
|
||
/** | ||
* This method checks if a given function or method contains an array literal | ||
* with duplicated entries for any key and emits a rule violation if so. | ||
* | ||
* @param ASTNode $node Array node. | ||
* @return void | ||
*/ | ||
private function checkForDuplicatedArrayKeys(ASTNode $node) | ||
{ | ||
$keys = array(); | ||
/** @var ASTArrayElement $arrayElement */ | ||
foreach ($node->getChildren() as $index => $arrayElement) { | ||
$arrayElement = $this->normalizeKey($arrayElement, $index); | ||
if (null === $arrayElement) { | ||
// skip everything that can't be resolved easily | ||
continue; | ||
} | ||
|
||
$key = $arrayElement->getImage(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. One white line before |
||
if (isset($keys[$key])) { | ||
$this->addViolation($node, array($key, $arrayElement->getStartLine())); | ||
continue; | ||
} | ||
$keys[$key] = $arrayElement; | ||
} | ||
} | ||
|
||
/** | ||
* To compare keys, we have to cast them to string. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no short description. It should always have a short description and if necessary a long description. https://www.phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html#example |
||
* Non-associative keys have to use index as its key, | ||
* while boolean and nulls have to be casted respectively. | ||
* As current logic doesn't evaluate expressions nor constants, | ||
* statics, globals, etc. we simply skip them. | ||
* | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This method could benefit from a longer description, telling the what & why. |
||
* @param AbstractASTNode $node Array key to evaluate. | ||
* @param int $index Fallback in case of non-associative arrays | ||
* @return AbstractASTNode Key name | ||
*/ | ||
private function normalizeKey(AbstractASTNode $node, $index) | ||
{ | ||
// non-associative - key name equals to its index | ||
if (count($node->getChildren()) === 0) { | ||
$node->setImage((string) $index); | ||
return $node; | ||
} | ||
|
||
$node = $node->getChild(0); | ||
if (!($node instanceof ASTLiteral)) { | ||
// skip expressions, method calls, globals and constants | ||
return null; | ||
} | ||
$node->setImage($this->castStringFromLiteral($node)); | ||
|
||
return $node; | ||
} | ||
|
||
/** | ||
* Cleans string literals and casts boolean and null values as PHP engine does | ||
* | ||
* @param PDependASTNode $key | ||
* @return string | ||
*/ | ||
private function castStringFromLiteral(PDependASTNode $key) | ||
{ | ||
$value = $key->getImage(); | ||
switch ($value) { | ||
case 'false': | ||
return '0'; | ||
case 'true': | ||
return '1'; | ||
case 'null': | ||
return ''; | ||
default: | ||
return trim($value, '\'""'); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -126,6 +126,33 @@ class Foo | |
{ | ||
Bar::baz(); | ||
} | ||
} | ||
]]> | ||
</example> | ||
</rule> | ||
|
||
<rule name="DuplicatedArrayKey" | ||
message="Duplicated array key {0}, first declared at line {1}." | ||
class="PHPMD\Rule\CleanCode\DuplicatedArrayKey" | ||
externalInfoUrl="http://phpmd.org/rules/cleancode.html#duplicatedarraykey"> | ||
<description> | ||
<![CDATA[ | ||
Defining another value for the same key in an array literal overrides the previous key/value, | ||
which makes it effectively an unused code. If it's known from the beginning that the key | ||
will have different value, there is usually no point in defining first one. | ||
]]> | ||
</description> | ||
<priority>2</priority> | ||
<example> | ||
<![CDATA[ | ||
function createArray() { | ||
return [ | ||
'non-associative 0element', // not applied | ||
0 => 'associative 0-element', // applied | ||
false => 'associative 0-element', // applied | ||
'foo' => 'bar', // not applied | ||
"foo" => 'baz', // applied | ||
]; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd like to see a boolean cast example, e.g. |
||
} | ||
]]> | ||
</example> | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -68,7 +68,7 @@ This rule has the following properties: | |
=================================== =============== =============================================== | ||
|
||
IfStatementAssignment | ||
============= | ||
===================== | ||
|
||
Since: PHPMD 2.7.0 | ||
|
||
|
@@ -91,10 +91,30 @@ Example: :: | |
} | ||
|
||
|
||
DuplicateArrayKey | ||
================= | ||
|
||
Since: PHPMD 2.7.0 | ||
|
||
Defining another value for the same key in an array literal overrides the previous key/value, which makes it effectively an unused code. If it's known from the beginning that the key will have different value, there is usually no point in defining first one. | ||
|
||
|
||
Example: :: | ||
|
||
function createArray() { | ||
return [ | ||
'non-associative 0-element', // not applied | ||
0 => 'associative 0-element', // applied | ||
false => 'associative 0-element', // applied | ||
'foo' => 'bar', // not applied | ||
"foo" => 'baz', // applied | ||
]; | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Boolean cast example. |
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Superfluous line |
||
|
||
Remark | ||
====== | ||
|
||
This document is based on a ruleset xml-file, that was taken from the original source of the `PMD`__ project. This means that most parts of the content on this page are the intellectual work of the PMD community and its contributors and not of the PHPMD project. | ||
|
||
__ http://pmd.sourceforge.net/ | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why was this removed? We might add the following to our
Should not be part of the PR, though. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in d40a0f1 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -211,4 +211,3 @@ Remark | |
This document is based on a ruleset xml-file, that was taken from the original source of the `PMD`__ project. This means that most parts of the content on this page are the intellectual work of the PMD community and its contributors and not of the PHPMD project. | ||
|
||
__ http://pmd.sourceforge.net/ | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why was this removed? We might add the following to our
Should not be part of the PR, though. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Superfluous line