Showing 76 of 76 total issues
DevicesControllerTest
has 32 functions (exceeds 20 allowed). Consider refactoring. Open
class DevicesControllerTest extends DevicesControllerTestCase
{
public function testDevices_GivenUserNotLoggedIn_RedirectToLogin(): void
{
$response = $this->get('/devices');
The class DevicesControllerTest has 32 non-getter- and setter-methods. Consider refactoring DevicesControllerTest to keep number of methods under 25. Open
class DevicesControllerTest extends DevicesControllerTestCase
{
public function testDevices_GivenUserNotLoggedIn_RedirectToLogin(): void
{
$response = $this->get('/devices');
- Read upRead up
- Exclude checks
TooManyMethods
Since: 0.1
A class with too many 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'.
The default was changed from 10 to 25 in PHPMD 2.3.
Example
Source https://phpmd.org/rules/codesize.html#toomanymethods
The class DevicesControllerTest has 20 public methods. Consider refactoring DevicesControllerTest to keep number of public methods under 10. Open
class DevicesControllerTest extends DevicesControllerTestCase
{
public function testDevices_GivenUserNotLoggedIn_RedirectToLogin(): void
{
$response = $this->get('/devices');
- 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
The class DevicesTest has 13 public methods. Consider refactoring DevicesTest to keep number of public methods under 10. Open
class DevicesTest extends DuskTestCase
{
private $user;
public function setUp(): void
- 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
The class DeviceRepositoryTest has 12 public methods. Consider refactoring DeviceRepositoryTest to keep number of public methods under 10. Open
class DeviceRepositoryTest extends RepositoryTestCaseWithRealDatabase
{
private $deviceRepository;
public function setUp(): void
- 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
File DevicesControllerTest.php
has 291 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
namespace Tests\Unit\Controller\Web;
use App\Device;
DevicesControllerTest
has 22 functions (exceeds 20 allowed). Consider refactoring. Open
class DevicesControllerTest extends DevicesControllerTestCase
{
private $mockDeviceRepository;
private $mockUser;
private $messageId;
Avoid excessively long variable names like $htmlDataAttributesForSpecificDeviceProperties. Keep variable name length under 35. Open
$htmlDataAttributesForSpecificDeviceProperties = [];
- 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
Method testDevices_GivenUserLoggedIn_EditsDevice_DevicesUpdatedOnPage
has 30 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function testDevices_GivenUserLoggedIn_EditsDevice_DevicesUpdatedOnPage(): void
{
$this->browse(function (Browser $browser) {
$deviceName = self::$faker->word();
$deviceDescription = self::$faker->sentence();
Method testDevices_GivenUserLoggedIn_ClicksEditDeviceButton_OpensEditDeviceModal
has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function testDevices_GivenUserLoggedIn_ClicksEditDeviceButton_OpensEditDeviceModal(): void
{
$this->browse(function (Browser $browser) {
$deviceName = self::$faker->word();
$deviceDescription = self::$faker->sentence();
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class DatabaseSeeder extends Seeder
- Exclude checks
A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 10 and the first side effect is on line 24. Open
<?php
- Exclude checks
Similar blocks of code found in 2 locations. Consider refactoring. Open
$mockDeviceRepository
->shouldReceive('name')->once()->with($deviceId)
->shouldReceive('getForPublicId')->with(Mockery::on(function (Uuid $argument) use ($publicDeviceId) {
return $argument instanceof Uuid && $argument == Uuid::import($publicDeviceId);
}))->once()->andReturn($device)
- 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 96.
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
$mockDeviceRepository
->shouldReceive('name')->never()->with($deviceId)
->shouldReceive('getForPublicId')->with(Mockery::on(function (Uuid $argument) use ($publicDeviceId) {
return $argument instanceof Uuid && $argument == Uuid::import($publicDeviceId);
}))->once()->andReturn($device)
- 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 96.
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
Method loginAndAddDevice
has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
private function loginAndAddDevice(Browser $browser, string $deviceName, string $deviceDescription, int $onCode, int $offCode, int $pulseLength) : Browser
Each class must be in a file by itself Open
class FakeDeviceModel extends Model
- Exclude checks
The method createDevice has a boolean flag argument $isOwnedByUser, which is a certain sign of a Single Responsibility Principle violation. Open
private function createDevice(bool $isOwnedByUser = true): Device
- Read upRead up
- Exclude checks
BooleanArgumentFlag
Since: 1.4.0
A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.
Example
class Foo {
public function bar($flag = true) {
}
}
Source https://phpmd.org/rules/cleancode.html#booleanargumentflag
The method mockMessagePublisher has a boolean flag argument $messagePublishedSuccessfully, which is a certain sign of a Single Responsibility Principle violation. Open
protected function mockMessagePublisher(int $timesPublishIsCalled, bool $messagePublishedSuccessfully = true): void
- Read upRead up
- Exclude checks
BooleanArgumentFlag
Since: 1.4.0
A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.
Example
class Foo {
public function bar($flag = true) {
}
}
Source https://phpmd.org/rules/cleancode.html#booleanargumentflag
Missing class import via use statement (line '86', column '33'). Open
$deviceTypesClass = new \ReflectionClass(DeviceTypes::class);
- 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 callDeleteOnDeviceUserOwns has a boolean flag argument $wasDeleteSuccessful, which is a certain sign of a Single Responsibility Principle violation. Open
private function callDeleteOnDeviceUserOwns(bool $wasDeleteSuccessful = true): TestResponse
- Read upRead up
- Exclude checks
BooleanArgumentFlag
Since: 1.4.0
A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.
Example
class Foo {
public function bar($flag = true) {
}
}