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.

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

Dropping usage of Request->get #341

Merged
merged 4 commits into from
Oct 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 src/Bundle/Controller/ParametersParser.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace Sylius\Bundle\ResourceBundle\Controller;

use Sylius\Bundle\ResourceBundle\Provider\RequestParameterProvider;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\HttpFoundation\Request;
Expand Down Expand Up @@ -61,7 +62,7 @@ private function parseRequestValue($parameter, Request $request)
}

if (0 === strpos($parameter, '$')) {
return $request->get(substr($parameter, 1));
return RequestParameterProvider::provide($request, substr($parameter, 1));
}

if (0 === strpos($parameter, 'expr:')) {
Expand Down
3 changes: 2 additions & 1 deletion src/Bundle/Controller/RequestConfiguration.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace Sylius\Bundle\ResourceBundle\Controller;

use Sylius\Bundle\ResourceBundle\Provider\RequestParameterProvider;
use Sylius\Component\Resource\Metadata\MetadataInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\PropertyAccess\PropertyAccess;
Expand Down Expand Up @@ -358,7 +359,7 @@ public function getRequestParameter($parameter, $defaults = [])
{
return array_replace_recursive(
$defaults,
$this->request->get($parameter, []),
RequestParameterProvider::provide($this->request, $parameter, []),
);
}

Expand Down
36 changes: 36 additions & 0 deletions src/Bundle/Provider/RequestParameterProvider.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

/*
* This file is part of the Sylius package.
*
* (c) Paweł Jędrzejewski
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Sylius\Bundle\ResourceBundle\Provider;

use Symfony\Component\HttpFoundation\Request;

final class RequestParameterProvider
{
public static function provide(Request $request, string $key, mixed $default = null): mixed
{
if ($request !== $result = $request->attributes->get($key, $request)) {
return $result;
}

if ($request->query->has($key)) {
return $request->query->all()[$key];
}

if ($request->request->has($key)) {
return $request->request->all()[$key];
}

return $default;
}
}
54 changes: 54 additions & 0 deletions src/Bundle/Tests/Provider/RequestParameterProviderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?php

/*
* This file is part of the Sylius package.
*
* (c) Paweł Jędrzejewski
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Sylius\Bundle\ResourceBundle\Tests\Provider;

use PHPUnit\Framework\TestCase;
use Sylius\Bundle\ResourceBundle\Provider\RequestParameterProvider;
use Symfony\Component\HttpFoundation\Request;

final class RequestParameterProviderTest extends TestCase
{
/** @test */
public function it_returns_request_attribute_parameter_value(): void
{
$request = new Request(['foo' => 'bar_query'], ['foo' => 'bar_request'], ['foo' => 'bar_attribute']);

$this->assertSame(RequestParameterProvider::provide($request, 'foo'), 'bar_attribute');
}

/** @test */
public function it_returns_request_query_parameter_value(): void
{
$request = new Request(['foo' => 'bar_query'], ['foo' => 'bar_request'], ['foo_attribute' => 'bar_attribute']);

$this->assertSame(RequestParameterProvider::provide($request, 'foo'), 'bar_query');
}

/** @test */
public function it_returns_request_request_parameter_value(): void
{
$request = new Request(['foo_query' => 'bar_query'], ['foo' => 'bar_request'], ['foo_attribute' => 'bar_attribute']);

$this->assertSame(RequestParameterProvider::provide($request, 'foo'), 'bar_request');
}

/** @test */
public function it_returns_null_or_default_value_if_parameter_is_not_set(): void
{
$request = new Request(['foo_query' => 'bar_query'], ['foo_request' => 'bar_request'], ['foo_attribute' => 'bar_attribute']);

$this->assertSame(RequestParameterProvider::provide($request, 'foo'), null);
$this->assertSame(RequestParameterProvider::provide($request, 'foo', 'default'), 'default');
}
}
113 changes: 97 additions & 16 deletions src/Bundle/spec/Controller/RequestConfigurationSpec.php
Original file line number Diff line number Diff line change
Expand Up @@ -271,25 +271,72 @@ function it_has_no_filterable_parameter(Parameters $parameters): void
$this->getCriteria($defaultCriteria)->shouldHaveCount(1);
}

function it_has_criteria_parameter(Parameters $parameters, Request $request): void
{
function it_has_criteria_parameter(
Parameters $parameters,
Request $request,
ParameterBag $attributesBag,
ParameterBag $queryBag,
ParameterBag $requestBag,
): void {
$criteria = ['property' => 'myNewValue'];
$request->attributes = $attributesBag;
$request->query = $queryBag;
$request->request = $requestBag;

$parameters->get('filterable', false)->willReturn(true);
$parameters->get('criteria', Argument::any())->willReturn([]);
$request->get('criteria', [])->willReturn($criteria);

$attributesBag->get('criteria', $request)->willReturn($request);
$queryBag->has('criteria')->willReturn(true);
$queryBag->all()->willReturn(['criteria' => $criteria]);
$requestBag->all()->willReturn(['criteria' => []]);

$this->getCriteria()->shouldReturn($criteria);
}

function it_allows_to_override_criteria_parameter_in_route(Parameters $parameters, Request $request): void
{
function it_has_criteria_parameter_in_request(
Parameters $parameters,
Request $request,
ParameterBag $attributesBag,
ParameterBag $queryBag,
ParameterBag $requestBag,
): void {
$criteria = ['property' => 'myNewValue'];
$request->attributes = $attributesBag;
$request->query = $queryBag;
$request->request = $requestBag;

$parameters->get('filterable', false)->willReturn(true);
$parameters->get('criteria', Argument::any())->willReturn([]);

$attributesBag->get('criteria', $request)->willReturn($request);
$queryBag->has('criteria')->willReturn(false);
$requestBag->has('criteria')->willReturn(true);
$requestBag->all()->willReturn(['criteria' => $criteria]);

$this->getCriteria()->shouldReturn($criteria);
}

function it_allows_to_override_criteria_parameter_in_route(
Parameters $parameters,
Request $request,
ParameterBag $attributesBag,
ParameterBag $queryBag,
ParameterBag $requestBag,
): void {
$criteria = ['property' => 'myValue'];
$overriddenCriteria = ['other_property' => 'myNewValue'];
$combinedCriteria = ['property' => 'myValue', 'other_property' => 'myNewValue'];
$request->attributes = $attributesBag;
$request->query = $queryBag;
$request->request = $requestBag;

$parameters->get('filterable', false)->willReturn(true);
$parameters->get('criteria', [])->willReturn($criteria);
$request->get('criteria', [])->willReturn($overriddenCriteria);
$attributesBag->get('criteria', $request)->willReturn($request);
$queryBag->has('criteria')->willReturn(true);
$queryBag->all()->willReturn(['criteria' => $overriddenCriteria]);
$requestBag->all()->willReturn(['criteria' => []]);

$this->getCriteria()->shouldReturn($combinedCriteria);

Expand All @@ -298,13 +345,19 @@ function it_allows_to_override_criteria_parameter_in_route(Parameters $parameter

$parameters->get('filterable', false)->willReturn(true);
$parameters->get('criteria', Argument::any())->willReturn($criteria);
$request->get('criteria', [])->willReturn($overriddenCriteria);
$attributesBag->get('criteria', $request)->willReturn($request);
$queryBag->has('criteria')->willReturn(true);
$queryBag->all()->willReturn(['criteria' => $overriddenCriteria]);
$requestBag->all()->willReturn(['criteria' => []]);

$this->getCriteria($defaultCriteria)->shouldReturn($combinedDefaultCriteria);

$parameters->get('filterable', false)->willReturn(true);
$parameters->get('criteria', [])->willReturn(['filter' => 'route']);
$request->get('criteria', [])->willReturn(['filter' => 'request']);
$attributesBag->get('criteria', $request)->willReturn($request);
$queryBag->has('criteria')->willReturn(true);
$queryBag->all()->willReturn(['criteria' => ['filter' => 'request']]);
$requestBag->all()->willReturn(['criteria' => []]);

$this->getCriteria(['filter' => 'default'])->shouldReturn(['filter' => 'request']);
}
Expand All @@ -318,13 +371,24 @@ function it_checks_if_the_resource_is_sortable(Parameters $parameters): void
$this->isSortable()->shouldReturn(false);
}

function it_has_sorting_parameter(Parameters $parameters, Request $request): void
{
function it_has_sorting_parameter(
Parameters $parameters,
Request $request,
ParameterBag $attributesBag,
ParameterBag $queryBag,
ParameterBag $requestBag,
): void {
$sorting = ['property' => 'asc'];
$request->attributes = $attributesBag;
$request->query = $queryBag;
$request->request = $requestBag;

$parameters->get('sortable', false)->willReturn(true);
$parameters->get('sorting', Argument::any())->willReturn($sorting);
$request->get('sorting', [])->willReturn($sorting);
$attributesBag->get('sorting', $request)->willReturn($request);
$queryBag->has('sorting')->willReturn(true);
$queryBag->all()->willReturn(['sorting' => $sorting]);
$requestBag->get('sorting', [])->willReturn([]);

$this->getSorting()->shouldReturn($sorting);
}
Expand All @@ -340,15 +404,26 @@ function it_has_no_sortable_parameter(Parameters $parameters): void
$this->getSorting($defaultSorting)->shouldHaveCount(1);
}

function it_allows_to_override_sorting_parameter_in_route(Parameters $parameters, Request $request): void
{
function it_allows_to_override_sorting_parameter_in_route(
Parameters $parameters,
Request $request,
ParameterBag $attributesBag,
ParameterBag $queryBag,
ParameterBag $requestBag,
): void {
$sorting = ['property' => 'desc'];
$overriddenSorting = ['other_property' => 'asc'];
$combinedSorting = ['other_property' => 'asc', 'property' => 'desc'];
$request->attributes = $attributesBag;
$request->query = $queryBag;
$request->request = $requestBag;

$parameters->get('sortable', false)->willReturn(true);
$parameters->get('sorting', [])->willReturn($sorting);
$request->get('sorting', [])->willReturn($overriddenSorting);
$attributesBag->get('sorting', $request)->willReturn($request);
$queryBag->has('sorting')->willReturn(true);
$queryBag->all()->willReturn(['sorting' => $overriddenSorting]);
$requestBag->get('sorting', [])->willReturn([]);

$this->getSorting()->shouldReturn($combinedSorting);

Expand All @@ -357,13 +432,19 @@ function it_allows_to_override_sorting_parameter_in_route(Parameters $parameters

$parameters->get('sortable', false)->willReturn(true);
$parameters->get('sorting', Argument::any())->willReturn($sorting);
$request->get('sorting', [])->willReturn($overriddenSorting);
$attributesBag->get('sorting', $request)->willReturn($request);
$queryBag->has('sorting')->willReturn(true);
$queryBag->all()->willReturn(['sorting' => $overriddenSorting]);
$requestBag->get('sorting', [])->willReturn([]);

$this->getSorting($defaultSorting)->shouldReturn($combinedDefaultSorting);

$parameters->get('sortable', false)->willReturn(true);
$parameters->get('sorting', [])->willReturn(['sort' => 'route']);
$request->get('sorting', [])->willReturn(['sort' => 'request']);
$attributesBag->get('sorting', $request)->willReturn($request);
$queryBag->has('sorting')->willReturn(true);
$queryBag->all()->willReturn(['sorting' => ['sort' => 'request']]);
$requestBag->get('sorting', [])->willReturn([]);

$this->getSorting(['sort' => 'default'])->shouldReturn(['sort' => 'request']);
}
Expand Down