AddReviewHandler::__construct() - Code Metrics - Inspection of "[Product] Add review" - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#146)

by Łukasz

created 2017-06-02 14:21 UTC

AddReviewHandler::__construct() A

↳ Parent: AddReviewHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	11
nc	1
nop	5

<?php

declare(strict_types = 1);

namespace Sylius\ShopApiPlugin\Handler;

use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Core\Repository\ProductRepositoryInterface;
use Sylius\Component\Core\Repository\ProductReviewRepositoryInterface;
use Sylius\Component\Review\Factory\ReviewFactoryInterface;
use Sylius\Component\Review\Model\ReviewInterface;
use Sylius\ShopApiPlugin\Command\AddReview;
use Sylius\ShopApiPlugin\Provider\ProductReviewerProviderInterface;
use Webmozart\Assert\Assert;

final class AddReviewHandler
{
    /**
     * @var ProductReviewRepositoryInterface
     */
    private $productReviewRepository;

    /**
     * @var ChannelRepositoryInterface
     */
    private $channelRepository;

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

    /**
     * @var ProductReviewerProviderInterface
     */
    private $productReviewerProvider;

    /**
     * @var ReviewFactoryInterface
     */
    private $reviewFactory;

    public function __construct(
        ProductReviewRepositoryInterface $productReviewRepository,
        ChannelRepositoryInterface $channelRepository,
        ProductRepositoryInterface $productRepository,
        ProductReviewerProviderInterface $productReviewerProvider,
        ReviewFactoryInterface $reviewFactory
    ) {
        $this->productReviewRepository = $productReviewRepository;
        $this->channelRepository = $channelRepository;
        $this->productRepository = $productRepository;
        $this->productReviewerProvider = $productReviewerProvider;
        $this->reviewFactory = $reviewFactory;
    }

    public function handle(AddReview $addReview)
    {
        /** @var ChannelInterface $channel */
        $channel = $this->channelRepository->findOneByCode($addReview->channelCode());

        Assert::notNull($channel, 'Channel not found.');

        $product = $this->productRepository->findOneByChannelAndSlug(
            $channel,
            $channel->getDefaultLocale()->getCode(),
            $addReview->productSlug()
        );

        Assert::notNull($product, 'Product not found.');

        $productReviewer = $this->productReviewerProvider->provide($addReview->email());

        $productReview = $this->reviewFactory->createForSubjectWithReviewer($product, $productReviewer);
/** @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);
    }
}

        $productReview->setComment($addReview->comment());
        $productReview->setRating($addReview->rating());
        $productReview->setTitle($addReview->title());

        $this->productReviewRepository->add($productReview);
    }
}


1			<?php
2
3			declare(strict_types = 1);
4
5			namespace Sylius\ShopApiPlugin\Handler;
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\Core\Repository\ProductReviewRepositoryInterface;
11			use Sylius\Component\Review\Factory\ReviewFactoryInterface;
12			use Sylius\Component\Review\Model\ReviewInterface;
13			use Sylius\ShopApiPlugin\Command\AddReview;
14			use Sylius\ShopApiPlugin\Provider\ProductReviewerProviderInterface;
15			use Webmozart\Assert\Assert;
16
17			final class AddReviewHandler
18			{
19			/**
20			* @var ProductReviewRepositoryInterface
21			*/
22			private $productReviewRepository;
23
24			/**
25			* @var ChannelRepositoryInterface
26			*/
27			private $channelRepository;
28
29			/**
30			* @var ProductRepositoryInterface
31			*/
32			private $productRepository;
33
34			/**
35			* @var ProductReviewerProviderInterface
36			*/
37			private $productReviewerProvider;
38
39			/**
40			* @var ReviewFactoryInterface
41			*/
42			private $reviewFactory;
43
44			public function __construct(
45			ProductReviewRepositoryInterface $productReviewRepository,
46			ChannelRepositoryInterface $channelRepository,
47			ProductRepositoryInterface $productRepository,
48			ProductReviewerProviderInterface $productReviewerProvider,
49			ReviewFactoryInterface $reviewFactory
50			) {
51			$this->productReviewRepository = $productReviewRepository;
52			$this->channelRepository = $channelRepository;
53			$this->productRepository = $productRepository;
54			$this->productReviewerProvider = $productReviewerProvider;
55			$this->reviewFactory = $reviewFactory;
56			}
57
58			public function handle(AddReview $addReview)
59			{
60			/** @var ChannelInterface $channel */
61			$channel = $this->channelRepository->findOneByCode($addReview->channelCode());
62
63			Assert::notNull($channel, 'Channel not found.');
64
65			$product = $this->productRepository->findOneByChannelAndSlug(
66			$channel,
67			$channel->getDefaultLocale()->getCode(),
68			$addReview->productSlug()
69			);
70
71			Assert::notNull($product, 'Product not found.');
72
73			$productReviewer = $this->productReviewerProvider->provide($addReview->email());
74
75			$productReview = $this->reviewFactory->createForSubjectWithReviewer($product, $productReviewer);
			0 ignored issues – show Bug introduced 2017-06-01 10:12 UTC by Report Bug Copy Issue Report It seems like `$product` defined by `$this->productRepository...dReview->productSlug())` on line `65` can be `null`; however, `Sylius\Component\Review\...orSubjectWithReviewer()` 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...
76
77			$productReview->setComment($addReview->comment());
78			$productReview->setRating($addReview->rating());
79			$productReview->setTitle($addReview->title());
80
81			$this->productReviewRepository->add($productReview);
82			}
83			}
84

Sylius / SyliusShopApiPlugin

Pull Request — master (#146)

AddReviewHandler::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like