ExtractCSRFParameterTest::requestBodyProvider() - Code Metrics - Ocramius/PSR7Csrf - Measure and Improve Code Quality continuously with Scrutinizer

ExtractCSRFParameterTest::requestBodyProvider() B
last analyzed 2018-08-11 09:42 UTC

↳ Parent: ExtractCSRFParameterTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	69
rs	8.6763
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace PSR7CsrfTest\RequestParameter;

use PHPUnit\Framework\TestCase;
use Psr\Http\Message\ServerRequestInterface;
use PSR7Csrf\Exception\InvalidRequestParameterNameException;
use PSR7Csrf\RequestParameter\ExtractCSRFParameter;

/**
 * @covers \PSR7Csrf\RequestParameter\ExtractCSRFParameter
 */
final class ExtractCSRFParameterTest extends TestCase
{
    public function testRejectsEmptyRequestParameterName()
    {
        $this->expectException(InvalidRequestParameterNameException::class);

        new ExtractCSRFParameter('');
    }

    /**
     * @dataProvider requestBodyProvider
     *
     * @param string            $requestParameter
     * @param null|object|array $body
     * @param string            $expectedExtractedValue
     *
     * @return void
     */
    public function testExtraction(string $requestParameter, $body, string $expectedExtractedValue)
    {
        /* @var $request ServerRequestInterface|\PHPUnit_Framework_MockObject_MockObject */
        $request = $this->createMock(ServerRequestInterface::class);

        $request->expects(self::any())->method('getParsedBody')->willReturn($body);

        self::assertSame($expectedExtractedValue, (new ExtractCSRFParameter($requestParameter))->__invoke($request));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    public function requestBodyProvider()
    {
        /** @noinspection PhpUnusedPrivateFieldInspection */
        return [
            'null body' => [
                'request parameter name',
                null,
                '',
            ],
            'empty array' => [
                'request parameter name',
                [],
                '',
            ],
            'empty object' => [
                'request parameter name',
                (object) [],
                '',
            ],
            'array with matching parameter' => [
                'request parameter name',
                ['request parameter name' => 'foo'],
                'foo',
            ],
            'array with matching non-string parameter' => [
                'request parameter name',
                ['request parameter name' => 123],
                '',
            ],
            'object with matching parameter' => [
                'request parameter name',
                (object) ['request parameter name' => 'foo'],
                'foo',
            ],
            'object with matching non-string parameter' => [
                'request parameter name',
                (object) ['request parameter name' => 123],
                '',
            ],
            'class with private matching property' => [
                'field',
                new class {
                    private $field = 'bar';
                },
                '',
            ],
            'class with protected matching property' => [
                'field',
                new class {
                    protected $field = 'bar';
                },
                '',
            ],
            'class with public matching property' => [
                'field',
                new class {
                    public $field = 'bar';
                },
                'bar',
            ],
            'class with public matching non-string property' => [
                'field',
                new class {
                    public $field = 123;
                },
                '',
            ],
        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace PSR7CsrfTest\RequestParameter;
6
7			use PHPUnit\Framework\TestCase;
8			use Psr\Http\Message\ServerRequestInterface;
9			use PSR7Csrf\Exception\InvalidRequestParameterNameException;
10			use PSR7Csrf\RequestParameter\ExtractCSRFParameter;
11
12			/**
13			* @covers \PSR7Csrf\RequestParameter\ExtractCSRFParameter
14			*/
15			final class ExtractCSRFParameterTest extends TestCase
16			{
17			public function testRejectsEmptyRequestParameterName()
18			{
19			$this->expectException(InvalidRequestParameterNameException::class);
20
21			new ExtractCSRFParameter('');
22			}
23
24			/**
25			* @dataProvider requestBodyProvider
26			*
27			* @param string $requestParameter
28			* @param null\|object\|array $body
29			* @param string $expectedExtractedValue
30			*
31			* @return void
32			*/
33			public function testExtraction(string $requestParameter, $body, string $expectedExtractedValue)
34			{
35			/* @var $request ServerRequestInterface\|\PHPUnit_Framework_MockObject_MockObject */
36			$request = $this->createMock(ServerRequestInterface::class);
37
38			$request->expects(self::any())->method('getParsedBody')->willReturn($body);
39
40			self::assertSame($expectedExtractedValue, (new ExtractCSRFParameter($requestParameter))->__invoke($request));
			0 ignored issues – show Bug introduced 2018-01-28 08:51 UTC by Report Bug Copy Issue Report It seems like `$request` defined by `$this->createMock(\Psr\H...equestInterface::class)` on line `36` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `PSR7Csrf\RequestParamete...RFParameter::__invoke()` does only seem to accept `object<Psr\Http\Message\ServerRequestInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
41			}
42
43			public function requestBodyProvider()
44			{
45			/** @noinspection PhpUnusedPrivateFieldInspection */
46			return [
47			'null body' => [
48			'request parameter name',
49			null,
50			'',
51			],
52			'empty array' => [
53			'request parameter name',
54			[],
55			'',
56			],
57			'empty object' => [
58			'request parameter name',
59			(object) [],
60			'',
61			],
62			'array with matching parameter' => [
63			'request parameter name',
64			['request parameter name' => 'foo'],
65			'foo',
66			],
67			'array with matching non-string parameter' => [
68			'request parameter name',
69			['request parameter name' => 123],
70			'',
71			],
72			'object with matching parameter' => [
73			'request parameter name',
74			(object) ['request parameter name' => 'foo'],
75			'foo',
76			],
77			'object with matching non-string parameter' => [
78			'request parameter name',
79			(object) ['request parameter name' => 123],
80			'',
81			],
82			'class with private matching property' => [
83			'field',
84			new class {
85			private $field = 'bar';
86			},
87			'',
88			],
89			'class with protected matching property' => [
90			'field',
91			new class {
92			protected $field = 'bar';
93			},
94			'',
95			],
96			'class with public matching property' => [
97			'field',
98			new class {
99			public $field = 'bar';
100			},
101			'bar',
102			],
103			'class with public matching non-string property' => [
104			'field',
105			new class {
106			public $field = 123;
107			},
108			'',
109			],
110			];
111			}
112			}
113

Ocramius / PSR7Csrf

ExtractCSRFParameterTest::requestBodyProvider() B last analyzed 2018-08-11 09:42 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ExtractCSRFParameterTest::requestBodyProvider() B
last analyzed 2018-08-11 09:42 UTC