danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Code Issues Projects Releases Wiki Activity

Fix #1622 - add allow-backwards-incompatible-changes flag to psalter

Browse Source 
The flag prevents psalter from adding native return types
This commit is contained in:
Ilija Tovilo 2019-05-13 20:38:18 +02:00 committed by Matthew Brown
parent f33745ad25
commit 2c36a10ac8
5 changed files with 122 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/Psalm/Codebase.php
View File

@ -175,6 +175,11 @@ class Codebase
*/
public $diff_methods = false;
/**
* @var bool
*/
public $allow_backwards_incompatible_changes = true;
/**
* @var int
*/

23
src/Psalm/Internal/Analyzer/FunctionLike/ReturnTypeAnalyzer.php
View File

@ -721,14 +721,31 @@ class ReturnTypeAnalyzer
$function_like_analyzer->getMethodId(),
$function
);
$codebase = $project_analyzer->getCodebase();
$is_final = true;
$fqcln = $source->getFQCLN();
if ($fqcln !== null) {
$class_storage = $codebase->classlike_storage_provider->get($fqcln);
assert($function instanceof ClassMethod);
$is_final = $function->isFinal() || $class_storage->final;
}
$allow_native_type = !$docblock_only
&& $codebase->php_major_version >= 7
&& (
$codebase->allow_backwards_incompatible_changes
|| $is_final
);
$manipulator->setReturnType(
!$docblock_only && $project_analyzer->getCodebase()->php_major_version >= 7
$allow_native_type
? $inferred_return_type->toPhpString(
$source->getNamespace(),
$source->getAliasedClassesFlipped(),
$source->getFQCLN(),
$project_analyzer->getCodebase()->php_major_version,
$project_analyzer->getCodebase()->php_minor_version
$codebase->php_major_version,
$codebase->php_minor_version
) : null,
$inferred_return_type->toNamespacedString(
$source->getNamespace(),

18
src/psalter.php
View File

@ -21,6 +21,7 @@ $valid_long_options = [
'help', 'debug', 'debug-by-line', 'config:', 'file:', 'root:',
'plugin:', 'issues:', 'php-version:', 'dry-run', 'safe-types',
'find-unused-code', 'threads:', 'codeowner:',
'allow-backwards-incompatible-changes:',
];
// get options from command line
@ -117,6 +118,9 @@ Options:
--codeowner=[codeowner]
You can specify a GitHub code ownership group, and only that owner's code will be updated.
--allow-backwards-incompatible-changes=BOOL
Allow Psalm modify method signatures that could break code outside the project. Defaults to true.
HELP;
exit;
@ -302,6 +306,20 @@ if (isset($options['codeowner'])) {
}
}
if (isset($options['allow-backwards-incompatible-changes'])) {
$allow_backwards_incompatible_changes = filter_var(
$options['allow-backwards-incompatible-changes'],
FILTER_VALIDATE_BOOLEAN,
['flags' => FILTER_NULL_ON_FAILURE]
);
if ($allow_backwards_incompatible_changes === null) {
die('--allow-backwards-incompatible-changes expectes a boolean value [true|false|1|0]' . PHP_EOL);
}
$project_analyzer->getCodebase()->allow_backwards_incompatible_changes = $allow_backwards_incompatible_changes;
}
$plugins = [];
if (isset($options['plugin'])) {

4
tests/FileManipulation/FileManipulationTest.php
View File

@ -30,10 +30,11 @@ abstract class FileManipulationTest extends \Psalm\Tests\TestCase
* @param string $php_version
* @param string[] $issues_to_fix
* @param bool $safe_types
* @param bool $allow_backwards_incompatible_changes
*
* @return void
*/
public function testValidCode($input_code, $output_code, $php_version, array $issues_to_fix, $safe_types)
public function testValidCode($input_code, $output_code, $php_version, array $issues_to_fix, $safe_types, bool $allow_backwards_incompatible_changes = true)
{
$test_name = $this->getTestName();
if (strpos($test_name, 'SKIPPED-') !== false) {
@ -77,6 +78,7 @@ abstract class FileManipulationTest extends \Psalm\Tests\TestCase
false,
$safe_types
);
$this->project_analyzer->getCodebase()->allow_backwards_incompatible_changes = $allow_backwards_incompatible_changes;
$this->project_analyzer->getCodebase()->reportUnusedCode();

76
tests/FileManipulation/ReturnTypeManipulationTest.php
View File

@ -1132,6 +1132,82 @@ class ReturnTypeManipulationTest extends FileManipulationTest
['InvalidReturnType'],
false,
],
'fixInvalidIntReturnTypeJustInPhpDocWhenDisallowingBackwardsIncompatibleChanges' => [
'<?php
class A {
/**
* @return int
*/
protected function foo() {}
}',
'<?php
class A {
/**
* @return void
*/
protected function foo() {}
}',
'7.3',
['InvalidReturnType'],
false,
false,
],
'fixInvalidIntReturnTypeInFinalMethodWhenDisallowingBackwardsIncompatibleChanges' => [
'<?php
class A {
/**
* @return int
*/
protected final function foo() {}
}',
'<?php
class A {
/**
* @return void
*/
protected final function foo(): void {}
}',
'7.3',
['InvalidReturnType'],
false,
false,
],
'fixInvalidIntReturnTypeInFinalClassWhenDisallowingBackwardsIncompatibleChanges' => [
'<?php
final class A {
/**
* @return int
*/
protected function foo() {}
}',
'<?php
final class A {
/**
* @return void
*/
protected function foo(): void {}
}',
'7.3',
['InvalidReturnType'],
false,
false,
],
'fixInvalidIntReturnTypeInFunctionWhenDisallowingBackwardsIncompatibleChanges' => [
'<?php
/**
* @return int
*/
function foo() {}',
'<?php
/**
* @return void
*/
function foo(): void {}',
'7.3',
['InvalidReturnType'],
false,
false,
],
];
}
}