UniqueSimpleProductCodeValidator::validate() - Code Metrics - Inspection of "Merge pull request #6612 from tuka217/sort-product..." - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7c0075...645752 )

by Kamil

created 2016-11-22 08:53 UTC

UniqueSimpleProductCodeValidator::validate() A

↳ Parent: UniqueSimpleProductCodeValidator

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.2
c	0
b	0
f	0
cc	4
eloc	9
nc	4
nop	2

<?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.
 */

namespace Sylius\Bundle\ProductBundle\Validator;

use Sylius\Component\Product\Model\ProductInterface;
use Sylius\Component\Product\Repository\ProductVariantRepositoryInterface;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;

/**
 * @author Łukasz Chruściel <[email protected]>
 */
final class UniqueSimpleProductCodeValidator extends ConstraintValidator
{
    /**
     * @var ProductVariantRepositoryInterface
     */
    private $productVariantRepository;

    /**
     * @param ProductVariantRepositoryInterface $productVariantRepository
     */
    public function __construct(ProductVariantRepositoryInterface $productVariantRepository)

    {
        $this->productVariantRepository = $productVariantRepository;
    }

    /**
     * {@inheritdoc}
     */
    public function validate($value, Constraint $constraint)
    {
        if (!$value instanceof ProductInterface) {
            throw new UnexpectedTypeException($value, ProductInterface::class);
        }

        if (!$value->isSimple()) {
            return;
        }

        if (null !== $this->productVariantRepository->findOneBy(['code' => $value->getCode()])) {
            $this->context->buildViolation($constraint->message)
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ->atPath('code')
                ->addViolation()
            ;
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Bundle\ProductBundle\Validator;
13
14			use Sylius\Component\Product\Model\ProductInterface;
15			use Sylius\Component\Product\Repository\ProductVariantRepositoryInterface;
16			use Symfony\Component\Validator\Constraint;
17			use Symfony\Component\Validator\ConstraintValidator;
18			use Symfony\Component\Validator\Exception\UnexpectedTypeException;
19
20			/**
21			* @author Łukasz Chruściel <[email protected]>
22			*/
23			final class UniqueSimpleProductCodeValidator extends ConstraintValidator
24			{
25			/**
26			* @var ProductVariantRepositoryInterface
27			*/
28			private $productVariantRepository;
29
30			/**
31			* @param ProductVariantRepositoryInterface $productVariantRepository
32			*/
33			public function __construct(ProductVariantRepositoryInterface $productVariantRepository)
			0 ignored issues – show Comprehensibility Naming introduced 2016-11-22 09:11 UTC by Report Bug Copy Issue Report The variable name `$productVariantRepository` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
34			{
35			$this->productVariantRepository = $productVariantRepository;
36			}
37
38			/**
39			* {@inheritdoc}
40			*/
41			public function validate($value, Constraint $constraint)
42			{
43			if (!$value instanceof ProductInterface) {
44			throw new UnexpectedTypeException($value, ProductInterface::class);
45			}
46
47			if (!$value->isSimple()) {
48			return;
49			}
50
51			if (null !== $this->productVariantRepository->findOneBy(['code' => $value->getCode()])) {
52			$this->context->buildViolation($constraint->message)
			0 ignored issues – show Bug introduced 2016-11-22 09:11 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Valida...ecutionContextInterface` as the method `buildViolation()` does only exist in the following implementations of said interface: `Symfony\Component\Valida...ontext\ExecutionContext`, `Symfony\Component\Valida...\LegacyExecutionContext`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
53			->atPath('code')
54			->addViolation()
55			;
56			}
57			}
58			}
59

pamil / Sylius

Push — master ( 7c0075...645752 )

UniqueSimpleProductCodeValidator::validate() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like