AbstractFinisherTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Form\Tests\Unit\Domain\Finishers;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use Prophecy\Argument;
use Prophecy\Prophecy\ObjectProphecy;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher;
use TYPO3\CMS\Form\Domain\Finishers\Exception\FinisherException;
use TYPO3\CMS\Form\Domain\Finishers\FinisherContext;
use TYPO3\CMS\Form\Domain\Finishers\FinisherVariableProvider;
use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;

class AbstractFinisherTest extends UnitTestCase
{
    protected $singletonInstances = [];

    public function setUp()
    {
        $this->singletonInstances = GeneralUtility::getSingletonInstances();
    }

    public function tearDown()
    {
        GeneralUtility::resetSingletonInstances($this->singletonInstances);
        parent::tearDown();
    }

    public function parseOptionReturnsNullIfOptionNameIsTranslation()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $this->assertNull($mockAbstractFinisher->_call('parseOption', 'translation'));
    }

    public function parseOptionReturnsNullIfOptionNameNotExistsWithinOptions()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $mockAbstractFinisher->_set('options', []);

        $this->assertNull($mockAbstractFinisher->_call('parseOption', 'foo'));
    }

    public function parseOptionReturnsNullIfOptionNameNotExistsWithinDefaultOptions()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $mockAbstractFinisher->_set('options', []);

        $this->assertNull($mockAbstractFinisher->_call('parseOption', 'foo'));
    }

    public function parseOptionReturnsBoolOptionValuesAsBool()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $mockAbstractFinisher->_set('options', [
            'foo1' => false,
        ]);

        $expected = false;

        $this->assertSame($expected, $mockAbstractFinisher->_call('parseOption', 'foo1'));
    }

    public function parseOptionReturnsDefaultOptionValueIfOptionNameNotExistsWithinOptionsButWithinDefaultOptions()
    {
        $expected = 'defaultValue';

        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false,
            false,
            true,
            [
                'translateFinisherOption'
            ]
        );

        $mockAbstractFinisher
            ->expects($this->any())
            ->method('translateFinisherOption')
            ->willReturnArgument(0);

        $mockAbstractFinisher->_set('options', []);
        $mockAbstractFinisher->_set('defaultOptions', [
            'subject' => $expected
        ]);

        $finisherContextProphecy = $this->prophesize(FinisherContext::class);

        $formRuntimeProphecy = $this->prophesize(FormRuntime::class);
        $formRuntimeProphecy->offsetExists(Argument::cetera())->willReturn(true);
        $formRuntimeProphecy->offsetGet(Argument::cetera())->willReturn(null);

        $finisherContextProphecy->getFormRuntime(Argument::cetera())
            ->willReturn($formRuntimeProphecy->reveal());
        $finisherContextProphecy->getFinisherVariableProvider(Argument::cetera())
            ->willReturn(new FinisherVariableProvider);

        $mockAbstractFinisher->_set('finisherContext', $finisherContextProphecy->reveal());

        $this->assertSame($expected, $mockAbstractFinisher->_call('parseOption', 'subject'));
    }

    public function parseOptionReturnsDefaultOptionValueIfOptionValueIsAFormElementReferenceAndTheFormElementValueIsEmpty()
    {
        $elementIdentifier = 'element-identifier-1';
        $expected = 'defaultValue';

        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false,
            false,
            true,
            [
                'translateFinisherOption'
            ]
        );

        $mockAbstractFinisher
            ->expects($this->any())
            ->method('translateFinisherOption')
            ->willReturnArgument(0);

        $mockAbstractFinisher->_set('options', [
            'subject' => '{' . $elementIdentifier . '}'
        ]);
        $mockAbstractFinisher->_set('defaultOptions', [
            'subject' => $expected
        ]);

        $finisherContextProphecy = $this->prophesize(FinisherContext::class);

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier => ''
        ]);

        $finisherContextProphecy->getFormRuntime(Argument::cetera())
            ->willReturn($formRuntimeProphecy->reveal());

        $mockAbstractFinisher->_set('finisherContext', $finisherContextProphecy->reveal());

        $this->assertSame($expected, $mockAbstractFinisher->_call('parseOption', 'subject'));
    }

    public function parseOptionResolvesFormElementReferenceFromTranslation()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false,
            false,
            true,
            [
                'translateFinisherOption'
            ]
        );

        $elementIdentifier = 'element-identifier-1';
        $elementValue = 'element-value-1';
        $elementReferenceName = '{' . $elementIdentifier . '}';

        $translationValue = 'subject: ' . $elementReferenceName;
        $expected = 'subject: ' . $elementValue;

        $mockAbstractFinisher
            ->expects($this->any())
            ->method('translateFinisherOption')
            ->willReturn($translationValue);

        $mockAbstractFinisher->_set('options', [
            'subject' => ''
        ]);

        $finisherContextProphecy = $this->prophesize(FinisherContext::class);

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier => $elementValue
        ]);

        $finisherContextProphecy->getFormRuntime(Argument::cetera())
            ->willReturn($formRuntimeProphecy->reveal());

        $mockAbstractFinisher->_set('finisherContext', $finisherContextProphecy->reveal());

        $this->assertSame($expected, $mockAbstractFinisher->_call('parseOption', 'subject'));
    }

    public function substituteRuntimeReferencesReturnsArrayIfInputIsArray()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $formRuntimeProphecy = $this->prophesize(FormRuntime::class);

        $input = ['bar', 'foobar', ['x', 'y']];
        $expected = ['bar', 'foobar', ['x', 'y']];

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsStringIfInputIsString()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $formRuntimeProphecy = $this->prophesize(FormRuntime::class);

        $input = 'foobar';
        $expected = 'foobar';

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsValueFromFormRuntimeIfInputReferenceAFormElementIdentifierWhoseValueIsAString()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $elementIdentifier = 'element-identifier-1';
        $input = '{' . $elementIdentifier . '}';
        $expected = 'element-value';

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier => $expected
        ]);

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsValueFromFormRuntimeIfInputReferenceMultipleFormElementIdentifierWhoseValueIsAString()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $elementIdentifier1 = 'element-identifier-1';
        $elementValue1 = 'element-value-1';
        $elementIdentifier2 = 'element-identifier-2';
        $elementValue2 = 'element-value-2';

        $input = '{' . $elementIdentifier1 . '},{' . $elementIdentifier2 . '}';
        $expected = $elementValue1 . ',' . $elementValue2;

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier1 => $elementValue1,
            $elementIdentifier2 => $elementValue2
        ]);

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsValueFromFormRuntimeIfInputReferenceAFormElementIdentifierWhoseValueIsAnArray()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $elementIdentifier = 'element-identifier-1';
        $input = '{' . $elementIdentifier . '}';
        $expected = ['bar', 'foobar'];

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier => $expected
        ]);

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsValueFromFormRuntimeIfInputIsArrayAndSomeItemsReferenceAFormElementIdentifierWhoseValueIsAnArray()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $elementIdentifier1 = 'element-identifier-1';
        $elementValue1 = ['klaus', 'fritz'];
        $elementIdentifier2 = 'element-identifier-2';
        $elementValue2 = ['stan', 'steve'];

        $input = [
            '{' . $elementIdentifier1 . '}',
            'static value',
            'norbert' => [
                'lisa',
                '{' . $elementIdentifier1 . '}',
                '{' . $elementIdentifier2 . '}',
            ],
        ];
        $expected = [
            ['klaus', 'fritz'],
            'static value',
            'norbert' => [
                'lisa',
                ['klaus', 'fritz'],
                ['stan', 'steve'],
            ]
        ];

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier1 => $elementValue1,
            $elementIdentifier2 => $elementValue2
        ]);

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsNoReplacedValueIfInputReferenceANonExistingFormElement()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $elementIdentifier = 'element-identifier-1';
        $input = '{' . $elementIdentifier . '}';
        $expected = '{' . $elementIdentifier . '}';

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier => $expected
        ]);

        $finisherContextProphecy = $this->prophesize(FinisherContext::class);
        $finisherContextProphecy->getFinisherVariableProvider(Argument::cetera())->willReturn(new FinisherVariableProvider);
        $mockAbstractFinisher->_set('finisherContext', $finisherContextProphecy->reveal());

        $this->assertSame($expected, $mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal()));
    }

    public function substituteRuntimeReferencesReturnsTimestampIfInputIsATimestampRequestTrigger()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $input = '{__currentTimestamp}';
        $expected = '#^([0-9]{10})$#';

        $formRuntimeProphecy = $this->prophesize(FormRuntime::class);

        $this->assertEquals(1, preg_match($expected, (string)$mockAbstractFinisher->_call('substituteRuntimeReferences', $input, $formRuntimeProphecy->reveal())));
    }

    public function substituteRuntimeReferencesThrowsExceptionOnMultipleVariablesResolvedAsArray()
    {
        $mockAbstractFinisher = $this->getAccessibleMockForAbstractClass(
            AbstractFinisher::class,
            [],
            '',
            false
        );

        $elementIdentifier = 'element-identifier-1';
        $input = 'BEFORE {' . $elementIdentifier . '} AFTER';

        $formRuntimeProphecy = $this->createFormRuntimeProphecy([
            $elementIdentifier => ['value-1', 'value-2']
        ]);

        $finisherContextProphecy = $this->prophesize(FinisherContext::class);
        $finisherContextProphecy->getFinisherVariableProvider(Argument::cetera())->willReturn(new FinisherVariableProvider);
        $mockAbstractFinisher->_set('finisherContext', $finisherContextProphecy->reveal());

        $this->expectException(FinisherException::class);
        $this->expectExceptionCode(1519239265);

        $mockAbstractFinisher->_call(
            'substituteRuntimeReferences',
            $input,
            $formRuntimeProphecy->reveal()
        );
    }

    protected function createFormRuntimeProphecy(array $values)
    {
        $formRuntimeProphecy = $this->prophesize(FormRuntime::class);
        foreach ($values as $key => $value) {
            $formRuntimeProphecy->offsetExists(Argument::exact($key))->willReturn(true);
            $formRuntimeProphecy->offsetGet(Argument::exact($key))->willReturn($value);
        }
        return $formRuntimeProphecy;
    }
}