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

[request] fix request and inputbag stub (#218)

Browse Source 
* add phpstan stub compatibility

* cs fix

Co-authored-by: Farhad Safarov <farhad.safarov@gmail.com>
This commit is contained in:
rgrassian 2021-09-06 17:39:00 +02:00 committed by GitHub
parent ecbfc60a7c
commit 7b19393d11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 60 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Handler/ContainerHandler.php
View File

@ -118,7 +118,12 @@ class ContainerHandler implements AfterMethodCallAnalysisInterface, AfterClassLi
}
if (!$service->isPublic()) {
$isTestContainer = $context->parent && ('Symfony\Bundle\FrameworkBundle\Test\KernelTestCase' === $context->parent || is_subclass_of($context->parent, 'Symfony\Bundle\FrameworkBundle\Test\KernelTestCase'));
/** @var class-string $kernelTestCaseClass */
$kernelTestCaseClass = 'Symfony\Bundle\FrameworkBundle\Test\KernelTestCase';
$isTestContainer = $context->parent &&
($kernelTestCaseClass === $context->parent
|| is_subclass_of($context->parent, $kernelTestCaseClass)
);
if (!$isTestContainer) {
IssueBuffer::accepts(
new PrivateService($serviceId, new CodeLocation($statements_source, $expr->args[0]->value)),

7
src/Stubs/5/Component/HttpFoundation/InputBag.stubphp
View File

@ -2,14 +2,17 @@
namespace Symfony\Component\HttpFoundation;
/**
* @template T of string|int|float|bool
*/
final class InputBag extends ParameterBag
{
/**
* Returns a string input value by name.
*
* @template D of string|int|float|bool|null
* @template D of T|null
* @psalm-param D $default
* @psalm-return string|int|float|bool|D
* @psalm-return D|T
* @psalm-taint-source input
*/
public function get(string $key, $default = null) {}

10
src/Stubs/5/Component/HttpFoundation/Request.stubphp
View File

@ -8,4 +8,14 @@ class Request
* @psalm-var InputBag
*/
public $request;
/**
* @psalm-var InputBag<string>
*/
public $query;
/**
* @psalm-var InputBag<string>
*/
public $cookies;
}

47
tests/acceptance/acceptance/InputBag.feature
View File

@ -11,7 +11,24 @@ Feature: InputBag get return type
use Symfony\Component\HttpFoundation\Request;
"""
Scenario Outline: Return type is not null if default argument is string.
Scenario: Return type is scalar for request property if default argument is string.
Given I have the following code
"""
class App
{
public function __invoke(Request $request): void
{
$string = $request->request->get('foo', 'bar');
trim($string);
}
}
"""
When I run Psalm
Then I see these errors
| Type | Message |
| InvalidScalarArgument | Argument 1 of trim expects string, scalar provided |
Scenario Outline: Return type is string if default argument is string.
Given I have the following code
"""
class App
@ -24,14 +41,29 @@ Feature: InputBag get return type
}
"""
When I run Psalm
Then I see these errors
| Type | Message |
| InvalidScalarArgument | Argument 1 of trim expects string, scalar provided |
Then I see no errors
Examples:
| property |
| query |
| cookies |
| request |
Scenario: Return type is nullable for request property if default argument is not provided.
Given I have the following code
"""
class App
{
public function __invoke(Request $request): void
{
$nullableString = $request->request->get('foo');
trim($nullableString);
}
}
"""
When I run Psalm
Then I see these errors
| Type | Message |
| InvalidScalarArgument | Argument 1 of trim expects string, null\|scalar provided |
And I see no other errors
Scenario Outline: Return type is nullable if default argument is not provided.
Given I have the following code
@ -47,11 +79,10 @@ Feature: InputBag get return type
"""
When I run Psalm
Then I see these errors
| Type | Message |
| InvalidScalarArgument | Argument 1 of trim expects string, null\|scalar provided |
| Type | Message |
| PossiblyNullArgument | Argument 1 of trim cannot be null, possibly null value provided |
And I see no other errors
Examples:
| property |
| query |
| cookies |
| request |