ClassFilterTest::testFilter() - Code Metrics - Inspection of "Allow to override Operator option" - sonata-project/SonataDoctrineORMAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#955)

by Vincent

created 2019-11-27 19:17 UTC

ClassFilterTest::testFilter() A

↳ Parent: ClassFilterTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.6
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\DoctrineORMAdminBundle\Tests\Filter;

use PHPUnit\Framework\TestCase;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
use Sonata\DoctrineORMAdminBundle\Filter\ClassFilter;
use Sonata\Form\Type\EqualType;

class ClassFilterTest extends TestCase
{
    public function testRenderSettings(): void
    {
        $filter = new ClassFilter();
        $options = $filter->getRenderSettings()[1];

        $this->assertSame(EqualType::class, $options['operator_type']);
        $this->assertSame([], $options['operator_options']);
    }

    public function testFilterEmpty(): void
    {
        $filter = new ClassFilter();
        $filter->initialize('field_name', ['field_options' => ['class' => 'FooBar']]);

        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter->filter($builder, 'alias', 'field', null);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $filter->filter($builder, 'alias', 'field', 'asds');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $filter->filter($builder, 'alias', 'field', ['value' => '']);

        $this->assertSame([], $builder->query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertFalse($filter->isActive());
    }

    public function testFilterInvalidOperator(): void
    {
        $filter = new ClassFilter();
        $filter->initialize('field_name', ['field_options' => ['class' => 'FooBar']]);

        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter->filter($builder, 'alias', 'field', ['type' => 'foo']);

        $this->assertSame([], $builder->query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertFalse($filter->isActive());
    }

    public function testFilter(): void
    {
        $filter = new ClassFilter();
        $filter->initialize('field_name', ['field_options' => ['class' => 'FooBar']]);

        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter->filter($builder, 'alias', 'field', ['type' => EqualType::TYPE_IS_EQUAL, 'value' => 'type']);
        $filter->filter($builder, 'alias', 'field', ['type' => EqualType::TYPE_IS_NOT_EQUAL, 'value' => 'type']);
        $filter->filter($builder, 'alias', 'field', ['value' => 'type']);

        $expected = [
            'alias INSTANCE OF type',
            'alias NOT INSTANCE OF type',
            'alias INSTANCE OF type',
        ];

        $this->assertSame($expected, $builder->query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertTrue($filter->isActive());
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\DoctrineORMAdminBundle\Tests\Filter;
15
16			use PHPUnit\Framework\TestCase;
17			use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
18			use Sonata\DoctrineORMAdminBundle\Filter\ClassFilter;
19			use Sonata\Form\Type\EqualType;
20
21			class ClassFilterTest extends TestCase
22			{
23			public function testRenderSettings(): void
24			{
25			$filter = new ClassFilter();
26			$options = $filter->getRenderSettings()[1];
27
28			$this->assertSame(EqualType::class, $options['operator_type']);
29			$this->assertSame([], $options['operator_options']);
30			}
31
32			public function testFilterEmpty(): void
33			{
34			$filter = new ClassFilter();
35			$filter->initialize('field_name', ['field_options' => ['class' => 'FooBar']]);
36
37			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
38
39			$filter->filter($builder, 'alias', 'field', null);
			0 ignored issues – show Documentation introduced 2017-11-22 12:27 UTC by Report Bug Copy Issue Report `null` is of type `null`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
40			$filter->filter($builder, 'alias', 'field', 'asds');
			0 ignored issues – show Documentation introduced 2017-11-22 12:27 UTC by Report Bug Copy Issue Report `'asds'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
41			$filter->filter($builder, 'alias', 'field', ['value' => '']);
42
43			$this->assertSame([], $builder->query);
			0 ignored issues – show Documentation introduced 2017-10-08 00:17 UTC by Report Bug Copy Issue Report The property `query` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
44			$this->assertFalse($filter->isActive());
45			}
46
47			public function testFilterInvalidOperator(): void
48			{
49			$filter = new ClassFilter();
50			$filter->initialize('field_name', ['field_options' => ['class' => 'FooBar']]);
51
52			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
53
54			$filter->filter($builder, 'alias', 'field', ['type' => 'foo']);
55
56			$this->assertSame([], $builder->query);
			0 ignored issues – show Documentation introduced 2017-10-08 00:17 UTC by Report Bug Copy Issue Report The property `query` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
57			$this->assertFalse($filter->isActive());
58			}
59
60			public function testFilter(): void
61			{
62			$filter = new ClassFilter();
63			$filter->initialize('field_name', ['field_options' => ['class' => 'FooBar']]);
64
65			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
66
67			$filter->filter($builder, 'alias', 'field', ['type' => EqualType::TYPE_IS_EQUAL, 'value' => 'type']);
68			$filter->filter($builder, 'alias', 'field', ['type' => EqualType::TYPE_IS_NOT_EQUAL, 'value' => 'type']);
69			$filter->filter($builder, 'alias', 'field', ['value' => 'type']);
70
71			$expected = [
72			'alias INSTANCE OF type',
73			'alias NOT INSTANCE OF type',
74			'alias INSTANCE OF type',
75			];
76
77			$this->assertSame($expected, $builder->query);
			0 ignored issues – show Documentation introduced 2015-11-23 21:03 UTC by Report Bug Copy Issue Report The property `query` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
78			$this->assertTrue($filter->isActive());
79			}
80			}
81

sonata-project / SonataDoctrineORMAdminBundle

Pull Request — 3.x (#955)

ClassFilterTest::testFilter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like