UniqueCurrencyPairValidator::isCurrencyPairUnique() - Code Metrics - Inspection of "Make all the form types up and running again" - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — symfony3-fqcn ( 04e8c2...ea8d6b )

by Kamil

created 2016-11-23 11:58 UTC

isCurrencyPairUnique() A

↳ Parent: UniqueCurrencyPairValidator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
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\CurrencyBundle\Validator\Constraints;

use Sylius\Component\Currency\Model\CurrencyInterface;
use Sylius\Component\Currency\Model\ExchangeRateInterface;
use Sylius\Component\Currency\Repository\ExchangeRateRepositoryInterface;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;

/**
 * @author Jan Góralski <[email protected]>
 */
class UniqueCurrencyPairValidator extends ConstraintValidator
{
    /**
     * @var ExchangeRateRepositoryInterface
     */
    private $exchangeRateRepository;

    /**
     * @param ExchangeRateRepositoryInterface $exchangeRateRepository
     */
    public function __construct(ExchangeRateRepositoryInterface $exchangeRateRepository)

    {
        $this->exchangeRateRepository = $exchangeRateRepository;
    }

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

        if (null !== $value->getId()) {
            return;
        }

        if (!$this->isCurrencyPairUnique($value->getSourceCurrency(), $value->getTargetCurrency())) {
            $this->context->buildViolation($constraint->message)->addViolation();
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.
    }
}
        }
    }

    /**
     * @param CurrencyInterface $baseCurrency
     * @param CurrencyInterface $targetCurrency
     *
     * @return bool
     */
    private function isCurrencyPairUnique(CurrencyInterface $baseCurrency, CurrencyInterface $targetCurrency)
    {
        $exchangeRate = $this->exchangeRateRepository->findOneWithCurrencyPair($baseCurrency, $targetCurrency);

        return null === $exchangeRate;
    }
}


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\CurrencyBundle\Validator\Constraints;
13
14			use Sylius\Component\Currency\Model\CurrencyInterface;
15			use Sylius\Component\Currency\Model\ExchangeRateInterface;
16			use Sylius\Component\Currency\Repository\ExchangeRateRepositoryInterface;
17			use Symfony\Component\Validator\Constraint;
18			use Symfony\Component\Validator\ConstraintValidator;
19			use Symfony\Component\Validator\Exception\UnexpectedTypeException;
20
21			/**
22			* @author Jan Góralski <[email protected]>
23			*/
24			class UniqueCurrencyPairValidator extends ConstraintValidator
25			{
26			/**
27			* @var ExchangeRateRepositoryInterface
28			*/
29			private $exchangeRateRepository;
30
31			/**
32			* @param ExchangeRateRepositoryInterface $exchangeRateRepository
33			*/
34			public function __construct(ExchangeRateRepositoryInterface $exchangeRateRepository)
			0 ignored issues – show Comprehensibility Naming introduced 2016-11-23 12:16 UTC by Report Bug Copy Issue Report The variable name `$exchangeRateRepository` 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...
35			{
36			$this->exchangeRateRepository = $exchangeRateRepository;
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function validate($value, Constraint $constraint)
43			{
44			if (!$value instanceof ExchangeRateInterface) {
45			throw new UnexpectedTypeException($value, ExchangeRateInterface::class);
46			}
47
48			if (null !== $value->getId()) {
49			return;
50			}
51
52			if (!$this->isCurrencyPairUnique($value->getSourceCurrency(), $value->getTargetCurrency())) {
53			$this->context->buildViolation($constraint->message)->addViolation();
			0 ignored issues – show Bug introduced 2016-11-23 12:16 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...
54			}
55			}
56
57			/**
58			* @param CurrencyInterface $baseCurrency
59			* @param CurrencyInterface $targetCurrency
60			*
61			* @return bool
62			*/
63			private function isCurrencyPairUnique(CurrencyInterface $baseCurrency, CurrencyInterface $targetCurrency)
64			{
65			$exchangeRate = $this->exchangeRateRepository->findOneWithCurrencyPair($baseCurrency, $targetCurrency);
66
67			return null === $exchangeRate;
68			}
69			}
70

pamil / Sylius

Push — symfony3-fqcn ( 04e8c2...ea8d6b )

isCurrencyPairUnique() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like