AbstractCronTimeFormatValidator::validate() - Code Metrics - Inspection of "Improved CRON segments validation" - FriendsOfAkeneo/FOACronBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#17)

by Alexandr

created 2017-03-13 22:48 UTC

AbstractCronTimeFormatValidator::validate() A

↳ Parent: AbstractCronTimeFormatValidator

Complexity

Conditions	3
Paths	4

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	3
eloc	9
nc	4
nop	2

<?php

namespace FOA\CronBundle\Validator\Constraints;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

/**
 * @author JM Leroux <[email protected]>
 */
abstract class AbstractCronTimeFormatValidator extends ConstraintValidator
{
    /**
     * @param string|int $value
     * @param Constraint $constraint
     */
    public function validate($value, Constraint $constraint)
    {
        if (false !== strpos($value, ',')) {
            $isValid = $this->validateList(explode(',', $value));
        } else {
            $isValid = $this->validateItem($value);
        }

        if (!$isValid) {
            $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.
    }
}
                ->setParameter('%string%', $value)
                ->addViolation();
        }
    }

    /**
     * @param array $list
     *
     * @return bool
     */
    private function validateList($list)
    {
        foreach ($list as $item) {
            if (!$this->validateItem($item)) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param int|string $item
     *
     * @return bool
     */
    private function validateItem($item)
    {
        if (false !== strpos($item, '-')) {
            return $this->validateRange($item);
        }

        return $this->validateTimeEntry($item);
    }

    /**
     * @param int|string $range
     *
     * @return bool
     */
    private function validateRange($range)
    {
        $items = explode('-', $range);

        if (count($items) !== 2) {
            return false;
        }

        foreach ($items as $item) {
            if (!$this->validateTimeEntry($item)) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param int|string $item
     *
     * @return bool
     */
    abstract function validateTimeEntry($item);

}


1			<?php
2
3			namespace FOA\CronBundle\Validator\Constraints;
4
5			use Symfony\Component\Validator\Constraint;
6			use Symfony\Component\Validator\ConstraintValidator;
7
8			/**
9			* @author JM Leroux <[email protected]>
10			*/
11			abstract class AbstractCronTimeFormatValidator extends ConstraintValidator
12			{
13			/**
14			* @param string\|int $value
15			* @param Constraint $constraint
16			*/
17			public function validate($value, Constraint $constraint)
18			{
19			if (false !== strpos($value, ',')) {
20			$isValid = $this->validateList(explode(',', $value));
21			} else {
22			$isValid = $this->validateItem($value);
23			}
24
25			if (!$isValid) {
26			$this->context->buildViolation($constraint->message)
			0 ignored issues – show Bug introduced 2017-02-28 23:06 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...
27			->setParameter('%string%', $value)
28			->addViolation();
29			}
30			}
31
32			/**
33			* @param array $list
34			*
35			* @return bool
36			*/
37			private function validateList($list)
38			{
39			foreach ($list as $item) {
40			if (!$this->validateItem($item)) {
41			return false;
42			}
43			}
44
45			return true;
46			}
47
48			/**
49			* @param int\|string $item
50			*
51			* @return bool
52			*/
53			private function validateItem($item)
54			{
55			if (false !== strpos($item, '-')) {
56			return $this->validateRange($item);
57			}
58
59			return $this->validateTimeEntry($item);
60			}
61
62			/**
63			* @param int\|string $range
64			*
65			* @return bool
66			*/
67			private function validateRange($range)
68			{
69			$items = explode('-', $range);
70
71			if (count($items) !== 2) {
72			return false;
73			}
74
75			foreach ($items as $item) {
76			if (!$this->validateTimeEntry($item)) {
77			return false;
78			}
79			}
80
81			return true;
82			}
83
84			/**
85			* @param int\|string $item
86			*
87			* @return bool
88			*/
89			abstract function validateTimeEntry($item);
			0 ignored issues – show Best Practice introduced 2017-03-13 22:50 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
90			}
91

FriendsOfAkeneo / FOACronBundle

Pull Request — develop (#17)

AbstractCronTimeFormatValidator::validate() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like