Sonata\AdminBundle\Tests\Form\DataTransformerResolverTest

Complexity

Total Complexity

12

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	6	1
A	testFailedResolve()	0	4	1
A	provideFieldTypes()	0	10	1
A	testResolveCustomDataTransformer()	0	15	1
A	getTimeZones()	0	14	1
A	testResolveDateDataTransformer()	0	26	1
A	testResolveChoiceWithoutClassName()	0	8	1
A	testResolveChoiceBadClassName()	0	10	1
A	testResolveChoice()	0	18	1
A	testCustomGlobalTransformers()	0	20	1
A	testAddCustomGlobalTransformer()	0	18	1
A	resolve()	0	4	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Tests\Form;

use PHPUnit\Framework\TestCase;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Form\DataTransformer\ModelToIdTransformer;
use Sonata\AdminBundle\Form\DataTransformerResolver;
use Sonata\AdminBundle\Model\ModelManagerInterface;
use Symfony\Component\Form\CallbackTransformer;
use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToStringTransformer;

/**
 * @author Peter Gribanov <info@peter-gribanov.ru>
 */
final class DataTransformerResolverTest extends TestCase
{
    /**
     * @var DataTransformerResolver
     */
    private $resolver;

    /**
     * @var FieldDescriptionInterface
     */
    private $fieldDescription;

    /**
     * @var FieldDescriptionInterface
     */
    private $modelManager;

    protected function setUp(): void
    {
        $this->fieldDescription = $this->prophesize(FieldDescriptionInterface::class);
        $this->modelManager = $this->prophesize(ModelManagerInterface::class);
        $this->resolver = new DataTransformerResolver();
    }

    public function testFailedResolve(): void
    {
        $this->assertNull($this->resolve());
    }

    public function provideFieldTypes(): array
    {
        return [
            ['foo'],
            // override predefined transformers
            ['date'],
            ['boolean'],
            ['choice'],
        ];
    }

    /**
     * @dataProvider provideFieldTypes
     */
    public function testResolveCustomDataTransformer(string $fieldType): void
    {
        $customDataTransformer = new CallbackTransformer(static function ($value): string {
            return (string) (int) $value;
        }, static function ($value): bool {
            return filter_var($value, FILTER_VALIDATE_BOOLEAN);
        });
        $this->fieldDescription->getOption('data_transformer')->willReturn($customDataTransformer);
        $this->fieldDescription->getType()->willReturn($fieldType);

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $dataTransformer = $this->resolve();

        $this->assertInstanceOf(DataTransformerInterface::class, $dataTransformer);
        $this->assertSame($customDataTransformer, $dataTransformer);
    }

    public function getTimeZones(): iterable
    {
        $default = new \DateTimeZone(date_default_timezone_get());
        $custom = new \DateTimeZone('Europe/Rome');

        return [
            'empty timezone' => [null, $default],
            'disabled timezone' => [false, $default],
            'default timezone by name' => [$default->getName(), $default],
            'default timezone by object' => [$default, $default],
            'custom timezone by name' => [$custom->getName(), $custom],
            'custom timezone by object' => [$custom, $custom],
        ];
    }

    /**
     * @dataProvider getTimeZones
     */
    public function testResolveDateDataTransformer($timezone, \DateTimeZone $expectedTimezone): void
    {
        $this->fieldDescription->getOption('data_transformer')->willReturn(null);
        $this->fieldDescription->getOption('timezone')->willReturn($timezone);
        $this->fieldDescription->getType()->willReturn('date');

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $dataTransformer = $this->resolve();

        $this->assertInstanceOf(DateTimeToStringTransformer::class, $dataTransformer);

        $value = '2020-12-12';
        $defaultTimezone = new \DateTimeZone(date_default_timezone_get());
        $expectedDate = new \DateTime($value, $expectedTimezone);
        $expectedDate->setTimezone($defaultTimezone);

        $resultDate = $dataTransformer->reverseTransform($value);

        $this->assertInstanceOf(\DateTime::class, $resultDate);
        $this->assertSame($expectedDate->format('Y-m-d'), $resultDate->format('Y-m-d'));
        $this->assertSame($defaultTimezone->getName(), $resultDate->getTimezone()->getName());

        // test laze-load
        $secondDataTransformer = $this->resolve();

        $this->assertSame($dataTransformer, $secondDataTransformer);
    }

    public function testResolveChoiceWithoutClassName(): void
    {
        $this->fieldDescription->getOption('data_transformer')->willReturn(null);
        $this->fieldDescription->getType()->willReturn('choice');

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $this->fieldDescription->getOption('class')->willReturn(null);

        $this->assertNull($this->resolve());
    }

    public function testResolveChoiceBadClassName(): void
    {
        $this->fieldDescription->getOption('data_transformer')->willReturn(null);
        $this->fieldDescription->getType()->willReturn('choice');

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $this->fieldDescription->getOption('class')->willReturn(\stdClass::class);
        $this->fieldDescription->getTargetModel()->willReturn(\DateTime::class);

It seems like you code against a concrete implementation and not the interface Sonata\AdminBundle\Admin\FieldDescriptionInterface as the method getTargetModel() does only exist in the following implementations of said interface: Sonata\AdminBundle\Tests\App\Admin\FieldDescription, Sonata\AdminBundle\Tests\Fixtures\Admin\FieldDescription.

        $this->fieldDescription->getTargetEntity()->willReturn(\DateTime::class);

The method willReturn cannot be called on $this->fieldDescription->getTargetEntity() (of type string|null).

The method Sonata\AdminBundle\Admin\FieldDescriptionInterface::getTargetEntity() has been deprecated with message: since sonata-project/admin-bundle 3.69. Use `getTargetModel()` instead.

        $this->assertNull($this->resolve());
    }

    public function testResolveChoice(): void
    {
        $newId = 1;
        $className = \stdClass::class;
        $object = new \stdClass();

        $this->fieldDescription->getOption('data_transformer')->willReturn(null);
        $this->fieldDescription->getType()->willReturn('choice');

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $this->fieldDescription->getOption('class')->willReturn($className);
        $this->fieldDescription->getTargetModel()->willReturn($className);

It seems like you code against a concrete implementation and not the interface Sonata\AdminBundle\Admin\FieldDescriptionInterface as the method getTargetModel() does only exist in the following implementations of said interface: Sonata\AdminBundle\Tests\App\Admin\FieldDescription, Sonata\AdminBundle\Tests\Fixtures\Admin\FieldDescription.

        $this->modelManager->find($className, $newId)->willReturn($object);

The method find() does not seem to exist on object<Sonata\AdminBundle\Admin\FieldDescriptionInterface>.

        $dataTransformer = $this->resolve();

        $this->assertInstanceOf(ModelToIdTransformer::class, $dataTransformer);
        $this->assertSame($object, $dataTransformer->reverseTransform($newId));
    }

    /**
     * @dataProvider provideFieldTypes
     */
    public function testCustomGlobalTransformers(string $fieldType): void
    {
        $customDataTransformer = new CallbackTransformer(static function ($value): string {
            return (string) (int) $value;
        }, static function ($value): bool {
            return filter_var($value, FILTER_VALIDATE_BOOLEAN);
        });

        $this->fieldDescription->getOption('data_transformer')->willReturn(null);
        $this->fieldDescription->getType()->willReturn($fieldType);

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $this->resolver = new DataTransformerResolver([
            $fieldType => $customDataTransformer, // override predefined transformer
        ]);

        $dataTransformer = $this->resolve();

        $this->assertInstanceOf(DataTransformerInterface::class, $dataTransformer);
        $this->assertSame($customDataTransformer, $dataTransformer);
    }

    /**
     * @dataProvider provideFieldTypes
     */
    public function testAddCustomGlobalTransformer(string $fieldType): void
    {
        $customDataTransformer = new CallbackTransformer(static function ($value): string {
            return (string) (int) $value;
        }, static function ($value): bool {
            return filter_var($value, FILTER_VALIDATE_BOOLEAN);
        });

        $this->fieldDescription->getOption('data_transformer')->willReturn(null);
        $this->fieldDescription->getType()->willReturn($fieldType);

The method willReturn cannot be called on $this->fieldDescription->getType() (of type integer|string).

        $this->resolver->addCustomGlobalTransformer($fieldType, $customDataTransformer);

        $dataTransformer = $this->resolve();

        $this->assertInstanceOf(DataTransformerInterface::class, $dataTransformer);
        $this->assertSame($customDataTransformer, $dataTransformer);
    }

    protected function resolve(): ?DataTransformerInterface
    {
        return $this->resolver->resolve($this->fieldDescription->reveal(), $this->modelManager->reveal());

The method reveal() does not seem to exist on object<Sonata\AdminBundle\Admin\FieldDescriptionInterface>.

    }
}