Skip to content

Be strict about deprecations #185

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

Merged
merged 1 commit into from
Mar 12, 2023
Merged

Be strict about deprecations #185

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
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"require": {
"php": "^7.4 || ^8.0",
"phpdocumentor/reflection-common": "^2.0",
"phpstan/phpdoc-parser": "^1.13"
"phpstan/phpdoc-parser": "^1.13",
"doctrine/deprecations": "^1.0"
},
"require-dev": {
"ext-tokenizer": "*",
Expand Down
45 changes: 44 additions & 1 deletion composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 13 additions & 8 deletions src/TypeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace phpDocumentor\Reflection;

use Doctrine\Deprecations\Deprecation;
use InvalidArgumentException;
use phpDocumentor\Reflection\PseudoTypes\ArrayShape;
use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
Expand Down Expand Up @@ -103,11 +104,8 @@
use function sprintf;
use function strpos;
use function strtolower;
use function trigger_error;
use function trim;

use const E_USER_DEPRECATED;

final class TypeResolver
{
/** @var string Definition of the NAMESPACE operator in PHP */
Expand Down Expand Up @@ -579,11 +577,18 @@ private function parse(TokenIterator $tokenIterator): TypeNode
*/
private function tryParseRemainingCompoundTypes(TokenIterator $tokenIterator, Context $context, Type $type): Type
{
trigger_error(
'Legacy nullable type detected, please update your code as
you are using nullable types in a docblock. support will be removed in v2.0.0',
E_USER_DEPRECATED
);
if (
$tokenIterator->isCurrentTokenType(Lexer::TOKEN_UNION) ||
$tokenIterator->isCurrentTokenType(Lexer::TOKEN_INTERSECTION)
) {
Deprecation::trigger(
'phpdocumentor/type-resolver',
'https://github.com/phpDocumentor/TypeResolver/issues/184',
'Legacy nullable type detected, please update your code as
you are using nullable types in a docblock. support will be removed in v2.0.0',
);
}

$continue = true;
while ($continue) {
$continue = false;
Expand Down
20 changes: 18 additions & 2 deletions tests/unit/TypeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace phpDocumentor\Reflection;

use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
use InvalidArgumentException;
use phpDocumentor\Reflection\PseudoTypes\CallableString;
use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
Expand Down Expand Up @@ -73,6 +74,8 @@
*/
class TypeResolverTest extends TestCase
{
use VerifyDeprecations;

/**
* @uses \phpDocumentor\Reflection\Types\Context
* @uses \phpDocumentor\Reflection\Types\Array_
Expand Down Expand Up @@ -855,8 +858,14 @@ public function testArrayKeyValueSpecification(): void
* @dataProvider illegalLegacyFormatProvider
* @testdox create type from $type
*/
public function testTypeBuilding(string $type, Type $expected): void
public function testTypeBuilding(string $type, Type $expected, bool $deprecation = false): void
{
if ($deprecation) {
$this->expectDeprecationWithIdentifier('https://github.com/phpDocumentor/TypeResolver/issues/184');
} else {
$this->expectNoDeprecationWithIdentifier('https://github.com/phpDocumentor/TypeResolver/issues/184');
}

$fixture = new TypeResolver();
$actual = $fixture->resolve($type, new Context('phpDocumentor'));

Expand Down Expand Up @@ -1090,16 +1099,19 @@ public function illegalLegacyFormatProvider(): array
{
return [
[
'?string|bool',
'?string |bool',
new Compound([new Nullable(new String_()), new Boolean()]),
true,
],
[
'?string|?bool',
new Compound([new Nullable(new String_()), new Nullable(new Boolean())]),
true,
],
[
'?string|?bool|null',
new Compound([new Nullable(new String_()), new Nullable(new Boolean()), new Null_()]),
true,
],
[
'?string|bool|Foo',
Expand All @@ -1108,10 +1120,12 @@ public function illegalLegacyFormatProvider(): array
new Boolean(),
new Object_(new Fqsen('\\phpDocumentor\\Foo')),
]),
true,
],
[
'?string&bool',
new Intersection([new Nullable(new String_()), new Boolean()]),
true,
],
[
'?string&bool|Foo',
Expand All @@ -1121,6 +1135,7 @@ public function illegalLegacyFormatProvider(): array
new Compound([new Boolean(), new Object_(new Fqsen('\\phpDocumentor\\Foo'))]),
]
),
true,
],
[
'?string&?bool|null',
Expand All @@ -1130,6 +1145,7 @@ public function illegalLegacyFormatProvider(): array
new Null_(),
]
),
true,
],
];
}
Expand Down