Skip to content
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.

Sign up for GitHub

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

add php baseline support #112

Merged
merged 1 commit into from
Apr 6, 2023
Merged

add php baseline support #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions lib/Baseline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,14 @@ final class Baseline {
* @throws FilesystemException
*/
static public function forFile(string $filePath):self {
$content = file_get_contents($filePath);
$decoded = Neon::decode($content);
$baselineExtension = pathinfo($filePath, PATHINFO_EXTENSION);

if ($baselineExtension === 'php') {
$decoded = require $filePath;
} else {
$content = file_get_contents($filePath);
$decoded = Neon::decode($content);
}

if (!is_array($decoded)) {
throw new RuntimeException(sprintf('expecting baseline %s to be non-empty', $filePath));
Expand Down
4 changes: 2 additions & 2 deletions lib/BaselineFinder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ static public function forGlob(string $glob): array
continue;
}

if (!str_ends_with($baseline, '.neon')) {
if (!str_ends_with($baseline, '.neon') && !str_ends_with($baseline, '.php')) {
continue;
}

Expand Down Expand Up @@ -50,4 +50,4 @@ static private function rglob(string $pattern,int $flags = 0):array
}
return $files;
}
}
}
32 changes: 23 additions & 9 deletions tests/BaselineAnalyzerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace staabm\PHPStanBaselineAnalysis\Tests;

use PHPUnit\Framework\TestCase;
use staabm\PHPStanBaselineAnalysis\AnalyzerResult;
use staabm\PHPStanBaselineAnalysis\Baseline;
use staabm\PHPStanBaselineAnalysis\BaselineAnalyzer;
use TomasVotruba\CognitiveComplexity\Rules\ClassLikeCognitiveComplexityRule;
Expand All @@ -17,15 +18,15 @@ function testAllInComplexity():void
$analyzer = new BaselineAnalyzer(Baseline::forFile(__DIR__ . '/fixtures/all-in.neon'));
$result = $analyzer->analyze();

$this->assertSame(38, $result->overallErrors);
$this->assertSame(70, $result->classesComplexity);
$this->assertSame(2, $result->deprecations);
$this->assertSame(5, $result->invalidPhpdocs);
$this->assertSame(1, $result->unknownTypes);
$this->assertSame(4, $result->anonymousVariables);
$this->assertSame(1, $result->propertyTypeCoverage);
$this->assertSame(27, $result->paramTypeCoverage);
$this->assertSame(4, $result->returnTypeCoverage);
$this->allInAssertions($result);
}

function testAllInComplexityPhp():void
{
$analyzer = new BaselineAnalyzer(Baseline::forFile(__DIR__ . '/fixtures/all-in.php'));
$result = $analyzer->analyze();

$this->allInAssertions($result);
}

function testClassComplexity():void
Expand Down Expand Up @@ -159,4 +160,17 @@ public function testSymplifyCompat() {
);
}

private function allInAssertions(AnalyzerResult $result): void
{
$this->assertSame(38, $result->overallErrors);
$this->assertSame(70, $result->classesComplexity);
$this->assertSame(2, $result->deprecations);
$this->assertSame(5, $result->invalidPhpdocs);
$this->assertSame(1, $result->unknownTypes);
$this->assertSame(4, $result->anonymousVariables);
$this->assertSame(1, $result->propertyTypeCoverage);
$this->assertSame(27, $result->paramTypeCoverage);
$this->assertSame(4, $result->returnTypeCoverage);
}

}
110 changes: 110 additions & 0 deletions tests/fixtures/all-in.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
<?php declare(strict_types=1);

$ignoreErrors = [];
$ignoreErrors[] = [
'message' => '#^Access to an undefined property AccountController\\:\\:\\$anredekurz\\.$#',
'count' => 2,
'path' => '/controllers/AccountController.php',
];
$ignoreErrors[] = [
'message' => '#^Class cognitive complexity is 48, keep it under 30$#',
'count' => 1,
'path' => '/controllers/ApplicationController.php',
];
$ignoreErrors[] = [
'message' => '#^Cognitive complexity for "ApplicationController\\:\\:app_init\\(\\)" is 12, keep it under 10$#',
'count' => 1,
'path' => '/controllers/ApplicationController.php',
];
$ignoreErrors[] = [
'message' => '#^Cognitive complexity for "ApplicationController\\:\\:check_breadrumbs\\(\\)" is 16, keep it under 10$#',
'count' => 1,
'path' => '/controllers/ApplicationController.php',
];
$ignoreErrors[] = [
'message' => '#^Class cognitive complexity is 22, keep it under 30$#',
'count' => 1,
'path' => '/controllers/ApplicationController.php',
];
$ignoreErrors[] = [
'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
'count' => 10,
'path' => '/controllers/ApplicationController.php',
];
$ignoreErrors[] = [
'message' => '#^Cognitive complexity for "TablePdf\\:\\:NbLines\\(\\)" is 17, keep it under 10$#',
'count' => 1,
'path' => '/models/TablePdf.php',
];
$ignoreErrors[] = [
'message' => '#^Use explicit return value over magic &reference$#',
'count' => 1,
'path' => '/models/TablePdf.php',
];
$ignoreErrors[] = [
'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
'count' => 1,
'path' => '/models/Tarif.php',
];
$ignoreErrors[] = [
'message' => '#^Use explicit names over dynamic ones$#',
'count' => 1,
'path' => '/models/Zubehoer.php',
];
$ignoreErrors[] = [
'message' => '#^Access to an undefined property Zugabe\\:\\:\\$feat\\.$#',
'count' => 1,
'path' => '/models/Zugabe.php',
];
$ignoreErrors[] = [
'message' => '#^Access to an undefined property Zugabe\\:\\:\\$hersteller\\.$#',
'count' => 1,
'path' => '/models/Zugabe.php',
];
$ignoreErrors[] = [
'message' => '#^Use explicit names over dynamic ones$#',
'count' => 1,
'path' => '/models/Zugabe.php',
];
$ignoreErrors[] = [
'message' => '#^Instantiation of deprecated class Zend_Db_Expr\\.$#',
'count' => 2,
'path' => '/controllers/AccountWatchlistController.php',
];
$ignoreErrors[] = [
'message' => '#^PHPDoc tag @throws with type Throws is not subtype of Throwable$#',
'count' => 5,
'path' => '/lib/rest/RestClient.php',
];
$ignoreErrors[] = [
'message' => '#^Property ActionMailer\\:\\:\\$template_root has unknown class unknown_type as its type\\.$#',
'count' => 1,
'path' => '/lib/ActionMailer.php',
];
$ignoreErrors[] = [
'message' => '#^Anonymous variable in a `\\$lang\\-\\>\\.\\.\\.\\(\\)` method call can lead to false dead methods\\. Make sure the variable type is known$#',
'count' => 1,
'path' => '/application/Rocket/lib/Prospect/Service/ProspectDetailService.php',
];
$ignoreErrors[] = [
'message' => '#^Anonymous variables in a "\\$element\\-\\>value\\[0\\]\\-\\>\\.\\.\\." property fetch can lead to false dead property\\. Make sure the variable type is known$#',
'count' => 3,
'path' => '/application/Rocket/lib/bulkConsumerCheckout/integration/VatValidationClient.php',
];
$ignoreErrors[] = [
'message' => '#^Out of 1 possible property types, only 1 %% actually have it\\. Add more property types to get over 99 %%$#',
'count' => 1,
'path' => '/N/A',
];
$ignoreErrors[] = [
'message' => '#^Out of 22 possible return types, only 4 %% actually have it\\. Add more return types to get over 99 %%$#',
'count' => 1,
'path' => '/N/A',
];
$ignoreErrors[] = [
'message' => '#^Out of 33 possible param types, only 27 %% actually have it\\. Add more param types to get over 99 %%$#',
'count' => 1,
'path' => '/N/A',
];

return ['parameters' => ['ignoreErrors' => $ignoreErrors]];