Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add MigrateRequiredFlagFlexFormFractor #158

Merged
merged 1 commit into from
Jun 15, 2024
Merged

[FEATURE] Add MigrateRequiredFlagFlexFormFractor #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/typo3-fractor/config/typo3-12.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateNullFlagFlexFormFractor;
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormFractor;
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRenderTypeColorpickerToTypeColorFlexFormFractor;
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor;
use a9f\Typo3Fractor\TYPO3v12\Fluid\AbstractMessageGetSeverityFluidRector;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

Expand All @@ -24,4 +25,5 @@
$services->set(MigrateNullFlagFlexFormFractor::class);
$services->set(MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormFractor::class);
$services->set(MigrateRenderTypeColorpickerToTypeColorFlexFormFractor::class);
$services->set(MigrateRequiredFlagFlexFormFractor::class);
};
74 changes: 74 additions & 0 deletions ...tor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/Fixtures/Fixture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?xml version="1.0" encoding="UTF-8"?>
<T3DataStructure>
<sheets>
<sDEF>
<ROOT>
<sheetTitle>sheetTitle</sheetTitle>
<type>array</type>
<el>
<settings.fieldContainsEvalRequired>
<config>
<type>input</type>
<eval>required</eval>
</config>
</settings.fieldContainsEvalRequired>
<settings.fieldContainsEvalTrimRequired>
<config>
<type>input</type>
<eval>trim,required</eval>
</config>
</settings.fieldContainsEvalTrimRequired>
<settings.fieldDoesNotContainEvalWithRequire>
<config>
<type>input</type>
<eval>trim</eval>
</config>
</settings.fieldDoesNotContainEvalWithRequire>
<settings.fieldDoesNotContainEval>
<config>
<type>input</type>
</config>
</settings.fieldDoesNotContainEval>
</el>
</ROOT>
</sDEF>
</sheets>
</T3DataStructure>
-----
<?xml version="1.0" encoding="UTF-8"?>
<T3DataStructure>
<sheets>
<sDEF>
<ROOT>
<sheetTitle>sheetTitle</sheetTitle>
<type>array</type>
<el>
<settings.fieldContainsEvalRequired>
<config>
<type>input</type>
<required>1</required>
</config>
</settings.fieldContainsEvalRequired>
<settings.fieldContainsEvalTrimRequired>
<config>
<type>input</type>
<eval>trim</eval>
<required>1</required>
</config>
</settings.fieldContainsEvalTrimRequired>
<settings.fieldDoesNotContainEvalWithRequire>
<config>
<type>input</type>
<eval>trim</eval>
</config>
</settings.fieldDoesNotContainEvalWithRequire>
<settings.fieldDoesNotContainEval>
<config>
<type>input</type>
</config>
</settings.fieldDoesNotContainEval>
</el>
</ROOT>
</sDEF>
</sheets>
</T3DataStructure>
27 changes: 27 additions & 0 deletions ...12/FlexForm/MigrateRequiredFlagFlexFormFractor/MigrateRequiredFlagFlexFormFractorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

declare(strict_types=1);

namespace a9f\Typo3Fractor\Tests\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor;

use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
use PHPUnit\Framework\Attributes\DataProvider;

final class MigrateRequiredFlagFlexFormFractorTest extends AbstractFractorTestCase
{
#[DataProvider('provideData')]
public function test(string $filePath): void
{
$this->doTestFile($filePath);
}

public static function provideData(): \Iterator
{
return self::yieldFilesFromDirectory(__DIR__ . '/Fixtures', '*.xml');
}

public function provideConfigFilePath(): ?string
{
return __DIR__ . '/config/fractor.php';
}
}
15 changes: 15 additions & 0 deletions ...actor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/config/fractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

use a9f\Fractor\Configuration\FractorConfiguration;
use a9f\Fractor\ValueObject\Indent;
use a9f\FractorXml\Configuration\XmlProcessorOption;
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor;

return FractorConfiguration::configure()
->withOptions([
XmlProcessorOption::INDENT_CHARACTER => Indent::STYLE_TAB,
XmlProcessorOption::INDENT_SIZE => 1,
])
->withRules([MigrateRequiredFlagFlexFormFractor::class]);
122 changes: 122 additions & 0 deletions packages/typo3-fractor/rules/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<?php

declare(strict_types=1);

namespace a9f\Typo3Fractor\TYPO3v12\FlexForm;

use a9f\Fractor\Application\ValueObject\File;
use a9f\Fractor\Helper\ArrayUtility;
use a9f\Fractor\Helper\StringUtility;
use a9f\Typo3Fractor\AbstractFlexformFractor;
use a9f\Typo3Fractor\Helper\FlexFormHelperTrait;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Deprecation-97035-RequiredOptionInEvalKeyword.html
* @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Feature-97035-UtilizeRequiredDirectlyInTCAFieldConfiguration.html
* @see \a9f\Typo3Fractor\Tests\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor\MigrateRequiredFlagFlexFormFractorTest
*/
final class MigrateRequiredFlagFlexFormFractor extends AbstractFlexformFractor
{
use FlexFormHelperTrait;

private \DOMDocument $domDocument;

public function canHandle(\DOMNode $node): bool
{
return parent::canHandle($node) && $node->nodeName === 'config';
}

public function beforeTraversal(File $file, \DOMDocument $rootNode): void
{
$this->file = $file;
$this->domDocument = $rootNode;
}

public function refactor(\DOMNode $node): \DOMNode|int|null
{
if (! $node instanceof \DOMElement) {
return null;
}

if (! $this->hasKey($node, 'eval')) {
return null;
}

$evalDomElement = $this->extractDomElementByKey($node, 'eval');
if (! $evalDomElement instanceof \DOMElement) {
return null;
}

$evalListValue = $evalDomElement->nodeValue;
if (! is_string($evalListValue)) {
return null;
}

if (! StringUtility::inList($evalListValue, 'required')) {
return null;
}

$evalList = ArrayUtility::trimExplode(',', $evalListValue, true);

// Remove "required" from $evalList
$evalList = array_filter($evalList, static fn (string $eval): bool => $eval !== 'required');

if ($evalList !== []) {
// Write back filtered 'eval'
$evalDomElement->nodeValue = '';
$evalDomElement->appendChild($this->domDocument->createTextNode(implode(',', $evalList)));
} elseif ($evalDomElement->parentNode instanceof \DOMElement) {
// 'eval' is empty, remove whole configuration
$evalDomElement->parentNode->removeChild($evalDomElement);
}

$requiredDomElement = $this->extractDomElementByKey($node, 'required');
if (! $requiredDomElement instanceof \DOMElement) {
$node->appendChild($this->domDocument->createElement('required', '1'));
}

return $node;
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Migrate required flag', [new CodeSample(
<<<'CODE_SAMPLE'
<T3DataStructure>
<ROOT>
<sheetTitle>aTitle</sheetTitle>
<type>array</type>
<el>
<some_column>
<title>foo</title>
<config>
<eval>trim,required</eval>
</config>
</some_column>
</el>
</ROOT>
</T3DataStructure>
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
<T3DataStructure>
<ROOT>
<sheetTitle>aTitle</sheetTitle>
<type>array</type>
<el>
<some_column>
<title>foo</title>
<config>
<eval>trim</eval>
<required>1</required>
</config>
</some_column>
</el>
</ROOT>
</T3DataStructure>
CODE_SAMPLE
)]);
}
}