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.

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

[EasyTest] Created InvalidDataMaker #471

Merged
merged 9 commits into from
Jan 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions packages/EasyTest/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
"require": {
"php": "^7.2",
"symfony/console": "^4.4 || ^5.1.5",
"nesbot/carbon": "^2.22",
"nette/utils": "^3.1",
"symfony/intl": "^4.4 || ^5.1.5",
"symfony/http-kernel": "^4.4 || ^5.1.5",
"symfony/validator": "^4.4 || ^5.1.5",
"symplify/autowire-array-parameter": "^8.3.41"
},
"require-dev": {
Expand Down
1 change: 1 addition & 0 deletions packages/EasyTest/config/services.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ services:
resource: '../src'
exclude:
- '../src/HttpKernel/*'
- '../src/InvalidDataMaker/*'
246 changes: 246 additions & 0 deletions packages/EasyTest/src/InvalidDataMaker/AbstractInvalidDataMaker.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,246 @@
<?php

declare(strict_types=1);

namespace EonX\EasyTest\InvalidDataMaker;

use LogicException;
use Symfony\Component\Translation\Loader\LoaderInterface;
use Symfony\Component\Translation\Loader\XliffFileLoader;
use Symfony\Component\Translation\Loader\YamlFileLoader;
use Symfony\Component\Translation\Translator;

/**
* @codeCoverageIgnore
*/
abstract class AbstractInvalidDataMaker
{
/**
* @var string
*/
private const PLURAL_PARAM = '%count%';

/**
* @var string
*/
protected $property;

/**
* @var string[]
*/
protected static $translations = ['vendor/symfony/validator/Resources/translations/validators.en.xlf'];

/**
* @var \Symfony\Contracts\Translation\TranslatorInterface
*/
private static $translator;

/**
* @var bool
*/
private $asArrayElement = false;

/**
* @var bool
*/
private $asString = false;

/**
* @var string
*/
private $message;

/**
* @var string
*/
private $propertyPath;

/**
* @var string
*/
private $wrapWith;

final public function __construct(string $property)
{
self::initTranslator();

$this->property = $property;
}

final public static function addTranslations(string $translations): void
{
self::$translations[] = $translations;
}

final public static function make(string $property): self
{
return new static($property);
}

/**
* @param mixed $value
*
* @return mixed[]
*/
final protected function create(string $caseName, $value, ?string $message = null): array
{
if ($this->asString === true) {
$value = (string)$value;
}

if ($this->asArrayElement === true) {
$value = [$value];
}

$invalidData = [
$this->property => $value,
];

$data = [
$caseName => [
'data' => $invalidData,
'message' => (string)($this->message ?? $message),
'propertyPath' => $this->resolvePropertyPath($invalidData),
],
];

if ($this->wrapWith !== null) {
$data = $this->applyWrapWith($data);
}

return $data;
}

/**
* @param mixed[]|null $params
*/
final protected function translateMessage(string $messageKey, ?array $params = null, ?int $plural = null): string
{
$params[self::PLURAL_PARAM] = $plural;

return self::$translator->trans($messageKey, $params);
}

private static function createTranslationLoader(string $extension): LoaderInterface
{
if (\in_array($extension, ['yaml', 'yml'], true)) {
return new YamlFileLoader();
}

if ($extension === 'xlf') {
return new XliffFileLoader();
}

throw new LogicException('Only YAML and XLF translation formats are supported.');
}

private static function initTranslator(): void
{
if (self::$translator !== null) {
return;
}

$locale = 'en';
$translator = new Translator($locale);

foreach (self::$translations as $translation) {
$extension = \strtolower(\pathinfo($translation, \PATHINFO_EXTENSION));
$translator->addLoader($extension, self::createTranslationLoader($extension));
$translator->addResource($extension, $translation, $locale);
}

self::$translator = $translator;
}

/**
* @param mixed[] $data
*
* @return mixed[]
*/
private function applyWrapWith(array $data): array
{
/** @var string $caseName */
$caseName = \current(\array_keys($data));
$caseData = $data[$caseName]['data'];

$wrappedPropertyPath = "{$this->wrapWith}.{$this->property}";
/** @var string $newCaseName */
$newCaseName = \str_replace($this->property, $wrappedPropertyPath, $caseName);

return [
$newCaseName => [
'data' => [
$this->wrapWith => $caseData,
],
'message' => $data[$caseName]['message'],
'propertyPath' => $wrappedPropertyPath,
],
];
}

/**
* @param mixed[] $invalidData
*
* @noinspection MultipleReturnStatementsInspection
*/
private function resolvePropertyPath(array $invalidData): string
{
if ($this->propertyPath !== null) {
return $this->propertyPath;
}

$propertyName = (string)\array_key_first($invalidData);

if (\is_array($invalidData[$propertyName]) && \count($invalidData[$propertyName]) > 0) {
// The case of stubs collection ('prop' => [ [], [], [], [] ])
if (($invalidData[$propertyName][0] ?? null) === []) {
return $propertyName;
}

$currentProperty = \current(\array_keys($invalidData[$propertyName]));

if ($currentProperty === 0) {
return $propertyName . '[0]';
}

return $propertyName . '.' . $this->resolvePropertyPath($invalidData[$propertyName]);
}

return $propertyName;
}

final public function asArrayElement(): self
{
$this->asArrayElement = true;

return $this;
}

final public function asString(): self
{
$this->asString = true;

return $this;
}

final public function message(string $message): self
{
$this->message = $message;

return $this;
}

final public function propertyPath(string $propertyPath): self
{
$this->propertyPath = $propertyPath;

return $this;
}

final public function wrapWith(string $wrapWith): self
{
$this->wrapWith = $wrapWith;

return $this;
}
}
Loading