ProductDetailsQuery - Code Metrics - Inspection of "[Products] Product endpoints by code" - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#179)

by Łukasz

created 2017-07-06 16:26 UTC

ProductDetailsQuery A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	7
lcom	1
cbo	6
dl	0
loc	78
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
A	findOneBySlug()	11	1
A	findOneByCode()	12	1
A	assertLocaleSupport()	9	2
A	getChannel()	9	1
A	getLocaleCode()	7	1

<?php

declare(strict_types = 1);

namespace Sylius\ShopApiPlugin\Query;

use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Core\Repository\ProductRepositoryInterface;
use Sylius\Component\Locale\Model\Locale;
use Sylius\ShopApiPlugin\Factory\ProductViewFactoryInterface;
use Sylius\ShopApiPlugin\View\ProductView;
use Webmozart\Assert\Assert;

final class ProductDetailsQuery implements ProductDetailsQueryInterface
{
    /** @var ChannelRepositoryInterface */
    private $channelRepository;

    /** @var ProductRepositoryInterface */
    private $productRepository;

    /** @var ProductViewFactoryInterface */
    private $productViewFactory;

    public function __construct(
        ChannelRepositoryInterface $channelRepository,
        ProductRepositoryInterface $productRepository,
        ProductViewFactoryInterface $productViewFactory
    ) {
        $this->channelRepository = $channelRepository;
        $this->productRepository = $productRepository;
        $this->productViewFactory = $productViewFactory;
    }

    public function findOneBySlug(string $channelCode, string $productSlug, ?string $localeCode): ProductView
    {
        $channel = $this->getChannel($channelCode);
        $localeCode = $this->getLocaleCode($localeCode, $channel);

        $product = $this->productRepository->findOneByChannelAndSlug($channel, $localeCode, $productSlug);

        Assert::notNull($product, sprintf('Product with slug %s has not been found in %s locale.', $productSlug, $localeCode));

        return $this->productViewFactory->create($product, $channel, $localeCode);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    public function findOneByCode(string $channelCode, string $productCode, ?string $localeCode): ProductView
    {
        $channel = $this->getChannel($channelCode);
        $localeCode = $this->getLocaleCode($localeCode, $channel);

        $product = $this->productRepository->findOneByCode($productCode);

        Assert::notNull($product, sprintf('Product with code %s has not been found.', $productCode));
        Assert::true($product->hasChannel($channel), sprintf('Channel with code %s has not been found.', $channelCode));

        return $this->productViewFactory->create($product, $channel, $localeCode);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @param string $localeCode
     * @param iterable|Locale[] $supportedLocales
     */
    private function assertLocaleSupport(string $localeCode, iterable $supportedLocales)
    {
        $supportedLocaleCodes = [];
        foreach ($supportedLocales as $locale) {
            $supportedLocaleCodes[] = $locale->getCode();
        }

        Assert::oneOf($localeCode, $supportedLocaleCodes);
    }

    private function getChannel(?string $channelCode): ChannelInterface
    {
        /** @var ChannelInterface $channel */
        $channel = $this->channelRepository->findOneByCode($channelCode);

        Assert::notNull($channel, sprintf('Channel with code %s has not been found.', $channelCode));

        return $channel;
    }

    private function getLocaleCode(?string $localeCode, ChannelInterface $channel): string
    {
        $localeCode = $localeCode ?? $channel->getDefaultLocale()->getCode();
        $this->assertLocaleSupport($localeCode, $channel->getLocales());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $localeCode;
    }
}


1			<?php
2
3			declare(strict_types = 1);
4
5			namespace Sylius\ShopApiPlugin\Query;
6
7			use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
8			use Sylius\Component\Core\Model\ChannelInterface;
9			use Sylius\Component\Core\Repository\ProductRepositoryInterface;
10			use Sylius\Component\Locale\Model\Locale;
11			use Sylius\ShopApiPlugin\Factory\ProductViewFactoryInterface;
12			use Sylius\ShopApiPlugin\View\ProductView;
13			use Webmozart\Assert\Assert;
14
15			final class ProductDetailsQuery implements ProductDetailsQueryInterface
16			{
17			/** @var ChannelRepositoryInterface */
18			private $channelRepository;
19
20			/** @var ProductRepositoryInterface */
21			private $productRepository;
22
23			/** @var ProductViewFactoryInterface */
24			private $productViewFactory;
25
26			public function __construct(
27			ChannelRepositoryInterface $channelRepository,
28			ProductRepositoryInterface $productRepository,
29			ProductViewFactoryInterface $productViewFactory
30			) {
31			$this->channelRepository = $channelRepository;
32			$this->productRepository = $productRepository;
33			$this->productViewFactory = $productViewFactory;
34			}
35
36			public function findOneBySlug(string $channelCode, string $productSlug, ?string $localeCode): ProductView
37			{
38			$channel = $this->getChannel($channelCode);
39			$localeCode = $this->getLocaleCode($localeCode, $channel);
40
41			$product = $this->productRepository->findOneByChannelAndSlug($channel, $localeCode, $productSlug);
42
43			Assert::notNull($product, sprintf('Product with slug %s has not been found in %s locale.', $productSlug, $localeCode));
44
45			return $this->productViewFactory->create($product, $channel, $localeCode);
			0 ignored issues – show Bug introduced 2017-07-06 10:04 UTC by Report Bug Copy Issue Report It seems like `$product` defined by `$this->productRepository...caleCode, $productSlug)` on line `41` can be `null`; however, `Sylius\ShopApiPlugin\Fac...toryInterface::create()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
46			}
47
48			public function findOneByCode(string $channelCode, string $productCode, ?string $localeCode): ProductView
49			{
50			$channel = $this->getChannel($channelCode);
51			$localeCode = $this->getLocaleCode($localeCode, $channel);
52
53			$product = $this->productRepository->findOneByCode($productCode);
54
55			Assert::notNull($product, sprintf('Product with code %s has not been found.', $productCode));
56			Assert::true($product->hasChannel($channel), sprintf('Channel with code %s has not been found.', $channelCode));
57
58			return $this->productViewFactory->create($product, $channel, $localeCode);
			0 ignored issues – show Bug introduced 2017-07-06 10:04 UTC by Report Bug Copy Issue Report It seems like `$product` defined by `$this->productRepository...OneByCode($productCode)` on line `53` can be `null`; however, `Sylius\ShopApiPlugin\Fac...toryInterface::create()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
59			}
60
61			/**
62			* @param string $localeCode
63			* @param iterable\|Locale[] $supportedLocales
64			*/
65			private function assertLocaleSupport(string $localeCode, iterable $supportedLocales)
66			{
67			$supportedLocaleCodes = [];
68			foreach ($supportedLocales as $locale) {
69			$supportedLocaleCodes[] = $locale->getCode();
70			}
71
72			Assert::oneOf($localeCode, $supportedLocaleCodes);
73			}
74
75			private function getChannel(?string $channelCode): ChannelInterface
76			{
77			/** @var ChannelInterface $channel */
78			$channel = $this->channelRepository->findOneByCode($channelCode);
79
80			Assert::notNull($channel, sprintf('Channel with code %s has not been found.', $channelCode));
81
82			return $channel;
83			}
84
85			private function getLocaleCode(?string $localeCode, ChannelInterface $channel): string
86			{
87			$localeCode = $localeCode ?? $channel->getDefaultLocale()->getCode();
88			$this->assertLocaleSupport($localeCode, $channel->getLocales());
			0 ignored issues – show Documentation introduced 2017-07-06 16:16 UTC by Report Bug Copy Issue Report `$channel->getLocales()` is of type `object<Doctrine\Common\C...Model\LocaleInterface>>`, but the function expects a `object<Sylius\ShopApiPlu...t\Locale\Model\Locale>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
89
90			return $localeCode;
91			}
92			}
93

Sylius / SyliusShopApiPlugin

Pull Request — master (#179)

ProductDetailsQuery A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like