The class AllCodesTest has 11 public methods. Consider refactoring AllCodesTest to keep number of public methods under 10. Open
class AllCodesTest extends TestWithMockery
{
use GetCodeClassesTrait;
/**
- Read upRead up
- Exclude checks
TooManyPublicMethods
Since: 0.1
A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
By default it ignores methods starting with 'get' or 'set'.
Example
Source https://phpmd.org/rules/codesize.html#toomanypublicmethods
Method I_get_whispered_current_code_as_return_value_of_factory_method
has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function I_get_whispered_current_code_as_return_value_of_factory_method()
{
foreach ($this->getCodeClasses() as $codeClass) {
$reflectionClass = new \ReflectionClass($codeClass);
$classBaseName = preg_replace('~^.*[\\\](\w+)$~', '$1', $codeClass);
Function I_get_whispered_current_code_as_return_value_of_factory_method
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function I_get_whispered_current_code_as_return_value_of_factory_method()
{
foreach ($this->getCodeClasses() as $codeClass) {
$reflectionClass = new \ReflectionClass($codeClass);
$classBaseName = preg_replace('~^.*[\\\](\w+)$~', '$1', $codeClass);
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Missing class import via use statement (line '58', column '36'). Open
$constantValues = (new \ReflectionClass($codeClass))->getConstants();
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '88', column '27'). Open
foreach ((new \ReflectionClass($codeClass))->getConstants() as $constant) {
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '221', column '40'). Open
$codeClassReflection = new \ReflectionClass($codeClass);
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '37', column '31'). Open
$reflection = new \ReflectionClass($codeClass);
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '137', column '31'). Open
$codeClass::getIt(new \DateTime());
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '164', column '36'). Open
$reflectionClass = new \ReflectionClass($codeClass);
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
The method I_get_whispered_current_code_as_return_value_of_factory_method uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
self::assertStringContainsString(<<<PHPDOC
* @return {$classBaseName}|AbstractCode
PHPDOC
, preg_replace('~ +~', ' ', $reflectionClass->getMethod('findIt')->getDocComment()),
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
The method I_get_whispered_current_code_as_return_value_of_factory_method uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
self::assertStringContainsString(<<<PHPDOC
* @return {$classBaseName}|AbstractCode
PHPDOC
, preg_replace('~ +~', ' ', $reflectionClass->getMethod('getIt')->getDocComment()),
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
The method Every_code_has_own_optimized_get_possible_values_method uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
self::assertSame(
$codeClass,
$getPossibleValuesReflection->getDeclaringClass()->getName(),
"$codeClass should have own getPossibleValues() method with direct list of its constants for readability"
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
Avoid unused local variables such as '$value'. Open
foreach ($givenValues as $index => $value) {
- Read upRead up
- Exclude checks
UnusedLocalVariable
Since: 0.2
Detects when a local variable is declared and/or assigned, but not used.
Example
class Foo {
public function doSomething()
{
$i = 5; // Unused
}
}
Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable
Similar blocks of code found in 2 locations. Consider refactoring. Open
foreach ((new \ReflectionClass($codeClass))->getConstants() as $constant) {
self::assertTrue($codeClass::hasIt($constant));
$code = $codeClass::getIt($constant);
self::assertInstanceOf($codeClass, $code);
self::assertSame($constant, $code->getValue());
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 100.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Open
if (strpos($reflectionClass->getDocComment(), 'findIt') !== false) {
self::assertStringContainsString(<<<PHPDOC
* @method static {$classBaseName} findIt(\$codeValue)
PHPDOC
, $reflectionClass->getDocComment(),
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 99.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Open
if (strpos($reflectionClass->getDocComment(), 'getIt') !== false) {
self::assertStringContainsString(<<<PHPDOC
* @method static {$classBaseName} getIt(\$codeValue)
PHPDOC
, $reflectionClass->getDocComment(),
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 99.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Avoid excessively long variable names like $getPossibleValuesReflection. Keep variable name length under 20. Open
$getPossibleValuesReflection = $codeClassReflection->getMethod('getPossibleValues');
- Read upRead up
- Exclude checks
LongVariable
Since: 0.2
Detects when a field, formal or local variable is declared with a long name.
Example
class Something {
protected $reallyLongIntName = -3; // VIOLATION - Field
public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
$otherReallyLongName = -5; // VIOLATION - Local
for ($interestingIntIndex = 0; // VIOLATION - For
$interestingIntIndex < 10;
$interestingIntIndex++ ) {
}
}
}
Source https://phpmd.org/rules/naming.html#longvariable
Avoid excessively long variable names like $getDefaultValuesReflection. Keep variable name length under 20. Open
$getDefaultValuesReflection = $codeClassReflection->getMethod('getDefaultValues');
- Read upRead up
- Exclude checks
LongVariable
Since: 0.2
Detects when a field, formal or local variable is declared with a long name.
Example
class Something {
protected $reallyLongIntName = -3; // VIOLATION - Field
public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
$otherReallyLongName = -5; // VIOLATION - Local
for ($interestingIntIndex = 0; // VIOLATION - For
$interestingIntIndex < 10;
$interestingIntIndex++ ) {
}
}
}
Source https://phpmd.org/rules/naming.html#longvariable
The method I_can_use_code_object_as_its_string_value is not named in camelCase. Open
public function I_can_use_code_object_as_its_string_value()
{
foreach ($this->getCodeClasses() as $codeClass) {
/** @var string[] $givenValues */
$givenValues = $codeClass::getPossibleValues();
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method Every_code_is_tested is not named in camelCase. Open
public function Every_code_is_tested()
{
foreach ($this->getCodeClasses() as $codeClass) {
$expectedTestClass = str_replace('DrdPlus\\Codes', 'DrdPlus\\Tests\\Codes', $codeClass) . 'Test';
self::assertTrue(
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method I_get_whispered_current_code_as_return_value_of_factory_method is not named in camelCase. Open
public function I_get_whispered_current_code_as_return_value_of_factory_method()
{
foreach ($this->getCodeClasses() as $codeClass) {
$reflectionClass = new \ReflectionClass($codeClass);
$classBaseName = preg_replace('~^.*[\\\](\w+)$~', '$1', $codeClass);
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method Every_code_has_own_optimized_get_possible_values_method is not named in camelCase. Open
public function Every_code_has_own_optimized_get_possible_values_method()
{
foreach ($this->getCodeClasses() as $codeClass) {
$codeClassReflection = new \ReflectionClass($codeClass);
self::assertTrue($codeClassReflection->hasMethod('getPossibleValues'), "Why $codeClass does not have getPossibleValues() method?");
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method I_can_create_code_instance_from_every_constant is not named in camelCase. Open
public function I_can_create_code_instance_from_every_constant()
{
/** @var AbstractCode $codeClass */
foreach ($this->getCodeClasses() as $codeClass) {
foreach ((new \ReflectionClass($codeClass))->getConstants() as $constant) {
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method All_of_them_are_code is not named in camelCase. Open
public function All_of_them_are_code()
{
foreach ($this->getCodeClasses() as $codeClass) {
self::assertTrue(
class_exists($codeClass),
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method All_constants_can_be_given_by_getter is not named in camelCase. Open
public function All_constants_can_be_given_by_getter()
{
foreach ($this->getCodeClasses() as $codeClass) {
$constantValues = (new \ReflectionClass($codeClass))->getConstants();
sort($constantValues); // re-index by numbers
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method I_can_not_create_code_from_invalid_value_format is not named in camelCase. Open
public function I_can_not_create_code_from_invalid_value_format(string $codeClass)
{
$this->expectException(\Granam\ScalarEnum\Exceptions\WrongValueForScalarEnum::class);
$this->expectExceptionMessageMatches('~\DateTime~');
/** @var AbstractCode $codeClass */
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method I_can_not_create_code_from_unknown_value is not named in camelCase. Open
public function I_can_not_create_code_from_unknown_value(string $codeClass)
{
$this->expectException(\DrdPlus\Codes\Partials\Exceptions\UnknownValueForCode::class);
$this->expectExceptionMessageMatches('~da Vinci~');
/** @var AbstractCode $codeClass */
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}
Source
The method I_can_get_all_codes_at_once_or_by_same_named_constant is not named in camelCase. Open
public function I_can_get_all_codes_at_once_or_by_same_named_constant()
{
/** @var AbstractCode $codeClass */
foreach ($this->getCodeClasses() as $codeClass) {
$reflection = new \ReflectionClass($codeClass);
- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}