NumberFilter::getChoices() - Code Metrics - Inspection of "Date filter" - psiphp/grid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#68)

by Daniel

created 2016-12-16 14:48 UTC

NumberFilter::getChoices() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	2

<?php

declare(strict_types=1);

namespace Psi\Component\Grid\Filter;

use Psi\Component\Grid\FilterDataInterface;
use Psi\Component\Grid\FilterInterface;
use Psi\Component\ObjectAgent\Capabilities;
use Psi\Component\ObjectAgent\Query\Comparison;
use Psi\Component\ObjectAgent\Query\Expression;
use Psi\Component\ObjectAgent\Query\Query;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class NumberFilter extends AbstractComparatorFilter
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $this->addComparatorChoice($builder, $options);

        $builder->add('value', NumberType::class, [
            'required' => false,
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function getExpression(string $fieldName, FilterDataInterface $data): Expression
    {
        $comparator = $data->getComparator() ?: Comparison::EQUALS;
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.
    }
}

        return Query::comparison(
            $comparator,
            $fieldName,
            $data->getValue()
        );
    }

    /**
     * {@inheritdoc}
     */
    public function configureOptions(OptionsResolver $options)

    {
        $options->setDefault('comparators', $this->getComparatorMap());
        $options->setDefault('data_class', NumberFilterData::class);
        $options->setDefault('empty_data', function (FormInterface $form) {
            return new NumberFilterData(
                $form->get('comparator')->getData(),
                $form->get('value')->getData()
            );
        });
    }

    protected function getComparatorMap(): array

    {
        $supported = [
            Comparison::EQUALS,
            Comparison::NOT_EQUALS,
            Comparison::GREATER_THAN,
            Comparison::GREATER_THAN_EQUAL,
            Comparison::LESS_THAN_EQUAL,
            Comparison::LESS_THAN,
        ];

        return array_combine($supported, $supported);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Psi\Component\Grid\Filter;
6
7		use Psi\Component\Grid\FilterDataInterface;
8		use Psi\Component\Grid\FilterInterface;
9		use Psi\Component\ObjectAgent\Capabilities;
10		use Psi\Component\ObjectAgent\Query\Comparison;
11		use Psi\Component\ObjectAgent\Query\Expression;
12		use Psi\Component\ObjectAgent\Query\Query;
13		use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
14		use Symfony\Component\Form\Extension\Core\Type\HiddenType;
15		use Symfony\Component\Form\Extension\Core\Type\NumberType;
16		use Symfony\Component\Form\FormBuilderInterface;
17		use Symfony\Component\Form\FormInterface;
18		use Symfony\Component\OptionsResolver\OptionsResolver;
19
20		class NumberFilter extends AbstractComparatorFilter
21		{
22		/**
23		* {@inheritdoc}
24		*/
25		public function buildForm(FormBuilderInterface $builder, array $options)
26		{
27		$this->addComparatorChoice($builder, $options);
28
29		$builder->add('value', NumberType::class, [
30		'required' => false,
31		]);
32		}
33
34		/**
35		* {@inheritdoc}
36		*/
37		public function getExpression(string $fieldName, FilterDataInterface $data): Expression
38		{
39		$comparator = $data->getComparator() ?: Comparison::EQUALS;
		0 ignored issues – show Bug introduced 2016-12-16 14:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psi\Component\Grid\FilterDataInterface` as the method `getComparator()` does only exist in the following implementations of said interface: `Psi\Component\Grid\Filter\DateFilterData`, `Psi\Component\Grid\Filter\NumberFilterData`, `Psi\Component\Grid\Filter\StringFilterData`. 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...
40
41		return Query::comparison(
42		$comparator,
43		$fieldName,
44		$data->getValue()
45		);
46		}
47
48		/**
49		* {@inheritdoc}
50		*/
51	View Code Duplication	public function configureOptions(OptionsResolver $options)
		0 ignored issues – show Duplication introduced 2016-11-08 13:18 UTC by Report Bug Copy Issue Report This method 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...
52		{
53		$options->setDefault('comparators', $this->getComparatorMap());
54		$options->setDefault('data_class', NumberFilterData::class);
55		$options->setDefault('empty_data', function (FormInterface $form) {
56		return new NumberFilterData(
57		$form->get('comparator')->getData(),
58		$form->get('value')->getData()
59		);
60		});
61		}
62
63	View Code Duplication	protected function getComparatorMap(): array
		0 ignored issues – show Duplication introduced 2016-12-16 14:50 UTC by Report Bug Copy Issue Report This method 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...
64		{
65		$supported = [
66		Comparison::EQUALS,
67		Comparison::NOT_EQUALS,
68		Comparison::GREATER_THAN,
69		Comparison::GREATER_THAN_EQUAL,
70		Comparison::LESS_THAN_EQUAL,
71		Comparison::LESS_THAN,
72		];
73
74		return array_combine($supported, $supported);
75		}
76		}
77

psiphp / grid

Pull Request — master (#68)

NumberFilter::getChoices() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like