IdExistConstraintValidator::__construct() - Code Metrics - Inspection of "Merge pull request #3 from Samffy/input" - Samffy/graphql-poc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 91e961...79ac70 )

by Samuel

created 2018-09-15 16:45 UTC

IdExistConstraintValidator::__construct() A

↳ Parent: IdExistConstraintValidator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	4
Ratio	100 %

Importance

Changes

Metric	Value
dl	4
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace App\Common\Infra\Validator;

use App\Common\App\Transformer\AppGlobalId;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\ORM\EntityRepository;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

class IdExistConstraintValidator extends ConstraintValidator

{
    /**
     * @var ObjectManager
     */
    private $em;

    /**
     * @param ObjectManager $em
     */
    public function __construct(ObjectManager $em)
    {
        $this->em = $em;
    }

    /**
     * @param mixed $identifier
     * @param Constraint $constraint
     * @throws \ReflectionException
     */
    public function validate($identifier, Constraint $constraint)
    {
        if ($identifier === null || !is_string($identifier)) {
            return;
        }

        if (!class_exists($constraint->getFqcn())) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            throw new \InvalidArgumentException(sprintf(
                'Constraint FQCN [%s] does not exist',
                $constraint->getFqcn()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            ));
        }

        if ($this->getRepository($constraint->getFqcn())->find($identifier) === null) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->context->buildViolation($constraint->getMessage())
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
                ->setParameters([
                    '%className%' => (new \ReflectionClass($constraint->getFqcn()))->getShortName(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
                    '%id%' => AppGlobalId::toGlobalId((new \ReflectionClass($constraint->getFqcn()))->getShortName(), $identifier),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
                ])
                ->addViolation();
        }
    }

    /**
     * @param string $fqcn
     * @return EntityRepository
     */
    protected function getRepository(string $fqcn): EntityRepository
    {
        return $this->em->getRepository($fqcn);
    }
}


1		<?php
2
3		namespace App\Common\Infra\Validator;
4
5		use App\Common\App\Transformer\AppGlobalId;
6		use Doctrine\Common\Persistence\ObjectManager;
7		use Doctrine\ORM\EntityRepository;
8		use Symfony\Component\Validator\Constraint;
9		use Symfony\Component\Validator\ConstraintValidator;
10
11	View Code Duplication	class IdExistConstraintValidator extends ConstraintValidator
		0 ignored issues – show Duplication introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
12		{
13		/**
14		* @var ObjectManager
15		*/
16		private $em;
17
18		/**
19		* @param ObjectManager $em
20		*/
21		public function __construct(ObjectManager $em)
22		{
23		$this->em = $em;
24		}
25
26		/**
27		* @param mixed $identifier
28		* @param Constraint $constraint
29		* @throws \ReflectionException
30		*/
31		public function validate($identifier, Constraint $constraint)
32		{
33		if ($identifier === null \|\| !is_string($identifier)) {
34		return;
35		}
36
37		if (!class_exists($constraint->getFqcn())) {
		0 ignored issues – show Bug introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Validator\Constraint` as the method `getFqcn()` does only exist in the following sub-classes of `Symfony\Component\Validator\Constraint`: `App\Common\Infra\Validat...dDoesNotExistConstraint`, `App\Common\Infra\Validator\IdExistConstraint`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
38		throw new \InvalidArgumentException(sprintf(
39		'Constraint FQCN [%s] does not exist',
40		$constraint->getFqcn()
		0 ignored issues – show Bug introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Validator\Constraint` as the method `getFqcn()` does only exist in the following sub-classes of `Symfony\Component\Validator\Constraint`: `App\Common\Infra\Validat...dDoesNotExistConstraint`, `App\Common\Infra\Validator\IdExistConstraint`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
41		));
42		}
43
44		if ($this->getRepository($constraint->getFqcn())->find($identifier) === null) {
		0 ignored issues – show Bug introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Validator\Constraint` as the method `getFqcn()` does only exist in the following sub-classes of `Symfony\Component\Validator\Constraint`: `App\Common\Infra\Validat...dDoesNotExistConstraint`, `App\Common\Infra\Validator\IdExistConstraint`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
45		$this->context->buildViolation($constraint->getMessage())
		0 ignored issues – show Bug introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Validator\Constraint` as the method `getMessage()` does only exist in the following sub-classes of `Symfony\Component\Validator\Constraint`: `App\Common\Infra\Validat...dDoesNotExistConstraint`, `App\Common\Infra\Validator\IdExistConstraint`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
46		->setParameters([
47		'%className%' => (new \ReflectionClass($constraint->getFqcn()))->getShortName(),
		0 ignored issues – show Bug introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Validator\Constraint` as the method `getFqcn()` does only exist in the following sub-classes of `Symfony\Component\Validator\Constraint`: `App\Common\Infra\Validat...dDoesNotExistConstraint`, `App\Common\Infra\Validator\IdExistConstraint`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
48		'%id%' => AppGlobalId::toGlobalId((new \ReflectionClass($constraint->getFqcn()))->getShortName(), $identifier),
		0 ignored issues – show Bug introduced 2018-09-15 16:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Validator\Constraint` as the method `getFqcn()` does only exist in the following sub-classes of `Symfony\Component\Validator\Constraint`: `App\Common\Infra\Validat...dDoesNotExistConstraint`, `App\Common\Infra\Validator\IdExistConstraint`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
49		])
50		->addViolation();
51		}
52		}
53
54		/**
55		* @param string $fqcn
56		* @return EntityRepository
57		*/
58		protected function getRepository(string $fqcn): EntityRepository
59		{
60		return $this->em->getRepository($fqcn);
61		}
62		}
63

Samffy / graphql-poc

Push — master ( 91e961...79ac70 )

IdExistConstraintValidator::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like