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

Jump to bottom

Refined types as per laminas/laminas-coding-standard:2.3.x upgrades #106

Merged
merged 2 commits into from Jul 7, 2022
Merged

Refined types as per laminas/laminas-coding-standard:2.3.x upgrades #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2539f32
Refined types as per `laminas/laminas-coding-standard:2.3.x` upgrades
Ocramius Jul 6, 2022
7880719
Improved type signature for `parse_cookie_header()` return type
Ocramius Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions composer.json
View file
Open in desktop
Expand Up @@ -19,6 +19,9 @@
"forum": "https://discourse.laminas.dev"
},
"config": {
"allow-plugins": {
"dealerdirect/phpcodesniffer-composer-installer": true
},
"sort-packages": true,
"platform": {
"php": "7.3.99"
Expand Down
43 changes: 17 additions & 26 deletions psalm-baseline.xml
View file
Open in desktop
Expand Up @@ -329,18 +329,9 @@
</RedundantConditionGivenDocblockType>
</file>
<file src="src/functions/create_uploaded_file.legacy.php">
<InvalidReturnStatement occurrences="1">
<code>laminas_createUploadedFile(...func_get_args())</code>
</InvalidReturnStatement>
<InvalidReturnType occurrences="1">
<code>UploadedFile</code>
</InvalidReturnType>
<MixedArgument occurrences="1">
<code>func_get_args()</code>
</MixedArgument>
<UndefinedClass occurrences="1">
<code>UploadedFile</code>
</UndefinedClass>
</file>
<file src="src/functions/create_uploaded_file.php">
<MixedArgument occurrences="4">
Expand Down Expand Up @@ -386,18 +377,9 @@
</MixedArgument>
</file>
<file src="src/functions/marshal_uri_from_sapi.legacy.php">
<InvalidReturnStatement occurrences="1">
<code>laminas_marshalUriFromSapi(...func_get_args())</code>
</InvalidReturnStatement>
<InvalidReturnType occurrences="1">
<code>Uri</code>
</InvalidReturnType>
<MixedArgument occurrences="1">
<code>func_get_args()</code>
</MixedArgument>
<UndefinedClass occurrences="1">
<code>Uri</code>
</UndefinedClass>
</file>
<file src="src/functions/marshal_uri_from_sapi.php">
<MissingClosureParamType occurrences="3">
Expand Down Expand Up @@ -489,6 +471,14 @@
<code>func_get_args()</code>
</MixedArgument>
</file>
<file src="src/functions/parse_cookie_header.php">
<LessSpecificReturnStatement occurrences="1">
<code>$cookies</code>
</LessSpecificReturnStatement>
<MoreSpecificReturnType occurrences="1">
<code>array&lt;non-empty-string, string&gt;</code>
</MoreSpecificReturnType>
</file>
<file src="test/CallbackStreamTest.php">
<MissingClosureReturnType occurrences="1">
<code>function () {</code>
Expand Down Expand Up @@ -529,19 +519,20 @@
</MixedOperand>
</file>
<file src="test/RequestTest.php">
<DuplicateArrayKey occurrences="1">
<code>'UNLOCK' =&gt; ['UNLOCK']</code>
</DuplicateArrayKey>
</file>
<file src="test/Response/XmlResponseTest.php">
<MissingReturnType occurrences="1">
<code>testRaisesExceptionforNonStringNonStreamBodyContent</code>
</MissingReturnType>
<MixedArgument occurrences="1">
<code>$headers</code>
</MixedArgument>
</file>
<file src="test/ResponseTest.php">
<LessSpecificReturnStatement occurrences="1">
<code>$ianaCodesReasonPhrases</code>
</LessSpecificReturnStatement>
<MixedAssignment occurrences="1">
<code>$responseCode</code>
</MixedAssignment>
<MoreSpecificReturnType occurrences="1">
<code>list&lt;array{numeric-string, non-empty-string}&gt;</code>
</MoreSpecificReturnType>
<RedundantConditionGivenDocblockType occurrences="1">
<code>assertIsInt</code>
</RedundantConditionGivenDocblockType>
Expand Down
4 changes: 2 additions & 2 deletions src/Exception/InvalidStreamPointerPositionException.php
View file
Open in desktop
Expand Up @@ -9,10 +9,10 @@

class InvalidStreamPointerPositionException extends RuntimeException implements ExceptionInterface
{
/** @param int $code */
/** {@inheritDoc} */
public function __construct(
string $message = 'Invalid pointer position',
$code = 0,
int $code = 0,
Ocramius marked this conversation as resolved.
Show resolved Hide resolved
?Throwable $previous = null
) {
parent::__construct($message, $code, $previous);
Expand Down
4 changes: 2 additions & 2 deletions src/Exception/UploadedFileAlreadyMovedException.php
View file
Open in desktop
Expand Up @@ -9,10 +9,10 @@

class UploadedFileAlreadyMovedException extends RuntimeException implements ExceptionInterface
{
/** @param int $code */
/** {@inheritDoc} */
public function __construct(
string $message = 'Cannot retrieve stream after it has already moved',
$code = 0,
int $code = 0,
Ocramius marked this conversation as resolved.
Show resolved Hide resolved
?Throwable $previous = null
) {
parent::__construct($message, $code, $previous);
Expand Down
4 changes: 1 addition & 3 deletions src/MessageTrait.php
View file
Open in desktop
Expand Up @@ -303,9 +303,7 @@ public function withBody(StreamInterface $body): MessageInterface
return $new;
}

/**
* @param StreamInterface|string|resource $stream
*/
/** @param StreamInterface|string|resource $stream */
private function getStream($stream, string $modeIfNotInstance): StreamInterface
{
if ($stream instanceof StreamInterface) {
Expand Down
9 changes: 9 additions & 0 deletions src/Request/ArraySerializer.php
View file
Open in desktop
Expand Up @@ -23,6 +23,15 @@ final class ArraySerializer
{
/**
* Serialize a request message to an array.
*
* @return array{
Ocramius marked this conversation as resolved.
Show resolved Hide resolved
* method: string,
* request_target: string,
* uri: string,
* protocol_version: string,
* headers: array<array<string>>,
* body: string
* }
*/
public static function toArray(RequestInterface $request): array
{
Expand Down
8 changes: 8 additions & 0 deletions src/Response/ArraySerializer.php
View file
Open in desktop
Expand Up @@ -23,6 +23,14 @@ final class ArraySerializer
{
/**
* Serialize a response message to an array.
*
* @return array{
Ocramius marked this conversation as resolved.
Show resolved Hide resolved
* status_code: int,
* reason_phrase: string,
* protocol_version: string,
* headers: array<array<string>>,
* body: string
* }
*/
public static function toArray(ResponseInterface $response): array
{
Expand Down
2 changes: 2 additions & 0 deletions src/functions/create_uploaded_file.legacy.php
View file
Open in desktop
Expand Up @@ -4,6 +4,8 @@

namespace Zend\Diactoros;

use Laminas\Diactoros\UploadedFile;

use function func_get_args;
use function Laminas\Diactoros\createUploadedFile as laminas_createUploadedFile;

Expand Down
2 changes: 2 additions & 0 deletions src/functions/marshal_uri_from_sapi.legacy.php
View file
Open in desktop
Expand Up @@ -4,6 +4,8 @@

namespace Zend\Diactoros;

use Laminas\Diactoros\Uri;

use function func_get_args;
use function Laminas\Diactoros\marshalUriFromSapi as laminas_marshalUriFromSapi;

Expand Down
3 changes: 2 additions & 1 deletion src/functions/parse_cookie_header.legacy.php
View file
Open in desktop
Expand Up @@ -8,9 +8,10 @@
use function Laminas\Diactoros\parseCookieHeader as laminas_parseCookieHeader;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we just drop this as we already removed support for the old zendframework implementation by adding conflict to composer.json?

Copy link
Member Author

@Ocramius Ocramius Jul 7, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do declare these symbols: we can drop them, but not in this patch 🤔


/**
* @deprecated Use \Laminas\Diactoros\parseCookieHeader instead
* @deprecated Use {@see \Laminas\Diactoros\parseCookieHeader} instead
*
* @param string $cookieHeader A string cookie header value.
* @return array<non-empty-string, string> key/value cookie pairs.
*/
function parseCookieHeader($cookieHeader): array
{
Expand Down
2 changes: 1 addition & 1 deletion src/functions/parse_cookie_header.php
View file
Open in desktop
Expand Up @@ -16,7 +16,7 @@
* overwriting. Thus, the server request should take the cookies from the request header instead.
*
* @param string $cookieHeader A string cookie header value.
* @return array key/value cookie pairs.
* @return array<non-empty-string, string> key/value cookie pairs.
*/
function parseCookieHeader($cookieHeader): array
{
Expand Down
6 changes: 4 additions & 2 deletions test/CallbackStreamTest.php
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@
/**
* @covers \Laminas\Diactoros\CallbackStream
*/
class CallbackStreamTest extends TestCase
final class CallbackStreamTest extends TestCase
{
public function testToString(): void
{
Expand Down Expand Up @@ -173,7 +173,7 @@ public function testGetMetadata(): void
$this->assertNull($notExists);
}

/** @return array<string, array{0: callable, 1: string}> */
/** @return non-empty-array<non-empty-string, array{callable(): string, non-empty-string}> */
public function phpCallbacksForStreams(): array
{
$class = TestAsset\CallbacksForCallbackStreamTest::class;
Expand All @@ -190,6 +190,8 @@ public function phpCallbacksForStreams(): array

/**
* @dataProvider phpCallbacksForStreams
* @param callable(): string $callback
* @param non-empty-string $expected
*/
public function testAllowsArbitraryPhpCallbacks(callable $callback, string $expected): void
{
Expand Down
47 changes: 27 additions & 20 deletions test/HeaderSecurityTest.php
View file
Open in desktop
Expand Up @@ -8,12 +8,12 @@
use Laminas\Diactoros\HeaderSecurity;
use PHPUnit\Framework\TestCase;

class HeaderSecurityTest extends TestCase
final class HeaderSecurityTest extends TestCase
{
/**
* Data for filter value
*
* @return array<int, array{0: string, 1: string}>
* @return non-empty-list<array{non-empty-string, non-empty-string}>
*/
public function getFilterValues(): array
{
Expand All @@ -34,42 +34,47 @@ public function getFilterValues(): array

/**
* @dataProvider getFilterValues
* @group ZF2015-04
* @param non-empty-string $value
* @param non-empty-string $expected
*/
public function testFiltersValuesPerRfc7230(string $value, string $expected): void
{
$this->assertSame($expected, HeaderSecurity::filter($value));
}

/** @return array<int, array{0: string, 1: string}> */
/** @return non-empty-list<array{non-empty-string, bool}> */
public function validateValues(): array
{
return [
["This is a\n test", 'assertFalse'],
["This is a\r test", 'assertFalse'],
["This is a\n\r test", 'assertFalse'],
["This is a\r\n test", 'assertTrue'],
["This is a \r\ntest", 'assertFalse'],
["This is a \r\n\n test", 'assertFalse'],
["This is a\n\n test", 'assertFalse'],
["This is a\r\r test", 'assertFalse'],
["This is a \r\r\n test", 'assertFalse'],
["This is a \r\n\r\ntest", 'assertFalse'],
["This is a \r\n\n\r\n test", 'assertFalse'],
["This is a \xFF test", 'assertFalse'],
["This is a \x7F test", 'assertFalse'],
["This is a \x7E test", 'assertTrue'],
["This is a\n test", false],
["This is a\r test", false],
["This is a\n\r test", false],
["This is a\r\n test", true],
["This is a \r\ntest", false],
["This is a \r\n\n test", false],
["This is a\n\n test", false],
["This is a\r\r test", false],
["This is a \r\r\n test", false],
["This is a \r\n\r\ntest", false],
["This is a \r\n\n\r\n test", false],
["This is a \xFF test", false],
["This is a \x7F test", false],
["This is a \x7E test", true],
];
}

/**
* @dataProvider validateValues
* @group ZF2015-04
Ocramius marked this conversation as resolved.
Show resolved Hide resolved
* @param non-empty-string $value
*/
public function testValidatesValuesPerRfc7230(string $value, string $assertion): void
public function testValidatesValuesPerRfc7230(string $value, bool $expected): void
{
$this->{$assertion}(HeaderSecurity::isValid($value));
self::assertSame($expected, HeaderSecurity::isValid($value));
}

/** @return array<int, array{0: string}> */
/** @return non-empty-list<array{non-empty-string}> */
public function assertValues(): array
{
return [
Expand All @@ -88,6 +93,8 @@ public function assertValues(): array

/**
* @dataProvider assertValues
* @group ZF2015-04
* @param non-empty-string $value
*/
public function testAssertValidRaisesExceptionForInvalidValue(string $value): void
{
Expand Down
2 changes: 1 addition & 1 deletion test/Integration/RequestTest.php
View file
Open in desktop
Expand Up @@ -7,7 +7,7 @@
use Http\Psr7Test\RequestIntegrationTest;
use Laminas\Diactoros\Request;

class RequestTest extends RequestIntegrationTest
final class RequestTest extends RequestIntegrationTest
{
public function createSubject(): Request
{
Expand Down
2 changes: 1 addition & 1 deletion test/Integration/ResponseTest.php
View file
Open in desktop
Expand Up @@ -7,7 +7,7 @@
use Http\Psr7Test\ResponseIntegrationTest;
use Laminas\Diactoros\Response;

class ResponseTest extends ResponseIntegrationTest
final class ResponseTest extends ResponseIntegrationTest
{
public function createSubject(): Response
{
Expand Down
2 changes: 1 addition & 1 deletion test/Integration/ServerRequestFactoryTest.php
View file
Open in desktop
Expand Up @@ -8,7 +8,7 @@
use Laminas\Diactoros\ServerRequestFactory;
use Psr\Http\Message\ServerRequestInterface;

class ServerRequestFactoryTest extends ServerRequestIntegrationTest
final class ServerRequestFactoryTest extends ServerRequestIntegrationTest
{
public function createSubject(): ServerRequestInterface
{
Expand Down
2 changes: 1 addition & 1 deletion test/Integration/ServerRequestTest.php
View file
Open in desktop
Expand Up @@ -7,7 +7,7 @@
use Http\Psr7Test\ServerRequestIntegrationTest;
use Laminas\Diactoros\ServerRequest;

class ServerRequestTest extends ServerRequestIntegrationTest
final class ServerRequestTest extends ServerRequestIntegrationTest
{
public function createSubject(): ServerRequest
{
Expand Down
6 changes: 2 additions & 4 deletions test/Integration/StreamTest.php
View file
Open in desktop
Expand Up @@ -8,11 +8,9 @@
use Laminas\Diactoros\Stream;
use Psr\Http\Message\StreamInterface;

class StreamTest extends StreamIntegrationTest
final class StreamTest extends StreamIntegrationTest
{
/**
* @param string|resource|StreamInterface $data
*/
/** {@inheritDoc} */
public function createStream($data): StreamInterface
{
if ($data instanceof StreamInterface) {
Expand Down
2 changes: 1 addition & 1 deletion test/Integration/UploadedFileTest.php
View file
Open in desktop
Expand Up @@ -10,7 +10,7 @@

use const UPLOAD_ERR_OK;

class UploadedFileTest extends UploadedFileIntegrationTest
final class UploadedFileTest extends UploadedFileIntegrationTest
{
public function createSubject(): UploadedFile
{
Expand Down
6 changes: 2 additions & 4 deletions test/Integration/UriTest.php
View file
Open in desktop
Expand Up @@ -7,11 +7,9 @@
use Http\Psr7Test\UriIntegrationTest;
use Laminas\Diactoros\Uri;

class UriTest extends UriIntegrationTest
final class UriTest extends UriIntegrationTest
{
/**
* @param string $uri
*/
/** {@inheritDoc} */
public function createUri($uri): Uri
{
return new Uri($uri);
Expand Down