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

Jump to bottom

rule value formatter #56

Merged
merged 7 commits into from
Sep 5, 2019
Merged

rule value formatter #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
46646b4
formatRule method
buzzclue Aug 24, 2019
0e0af0e
Merge pull request #54 from buzzclue/master
Gummibeer Aug 27, 2019
554d301
fix phpunit whitelist
Gummibeer Aug 27, 2019
c1859ab
refactor rule factory
Gummibeer Aug 27, 2019
d989a78
add unittests for rule factory rule formatter
Gummibeer Aug 27, 2019
fee4be3
fix php cs
Gummibeer Aug 27, 2019
d0d86fa
Merge remote-tracking branch 'remotes/origin/master' into ft-rule-val…
Gummibeer Sep 5, 2019
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ vendor/
composer.lock
coverage/
.phpunit.result.cache
build/
2 changes: 1 addition & 1 deletion phpunit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</testsuites>
<filter>
<whitelist processUncoveredFilesFromWhitelist="false">
<file>./src/Translatable/Translatable.php</file>
<directory suffix=".php">src/Translatable</directory>
</whitelist>
</filter>
</phpunit>
47 changes: 42 additions & 5 deletions src/Translatable/Validation/RuleFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ public function __construct(Repository $config, ?int $format = null, ?string $pr

public static function make(array $rules, ?int $format = null, ?string $prefix = null, ?string $suffix = null, ?array $locales = null): array
{
$factory = app()->make(static::class, compact('format', 'prefix', 'suffix'));
/** @var RuleFactory $factory */
$factory = app(static::class, compact('format', 'prefix', 'suffix'));

$factory->setLocales($locales);

Expand Down Expand Up @@ -80,20 +81,56 @@ public function parse(array $input): array
}

foreach ($this->locales as $locale) {
$rules[$this->formatKey($locale, $key)] = $value;
$rules[$this->formatKey($locale, $key)] = $this->formatRule($locale, $value);
}
}

return $rules;
}

protected function formatKey(string $locale, string $key): string
{
return $this->replacePlaceholder($locale, $key);
}

/**
* @param string $locale
* @param string|string[]|mixed $rule
*
* @return string|string[]|mixed
*/
protected function formatRule(string $locale, $rule)
{
if (is_string($rule)) {
if (strpos($rule, '|')) {
return implode('|', array_map(function (string $rule) use ($locale) {
return $this->replacePlaceholder($locale, $rule);
}, explode('|', $rule)));
}

return $this->replacePlaceholder($locale, $rule);
} elseif (is_array($rule)) {
return array_map(function ($rule) use ($locale) {
return $this->formatRule($locale, $rule);
}, $rule);
}

return $rule;
}

protected function replacePlaceholder(string $locale, string $value): string
{
return preg_replace($this->getPattern(), $this->getReplacement($locale), $value);
}

protected function getReplacement(string $locale): string
{
switch ($this->format) {
case self::FORMAT_ARRAY:
return preg_replace($this->getPattern(), $locale.'.$1', $key);
case self::FORMAT_KEY:
return preg_replace($this->getPattern(), '$1:'.$locale, $key);
return '$1:'.$locale;
default:
case self::FORMAT_ARRAY:
return $locale.'.$1';
}
}

Expand Down
208 changes: 208 additions & 0 deletions tests/ValidationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<?php

use Illuminate\Validation\Rule;
use Astrotomic\Translatable\Locales;
use Illuminate\Validation\Rules\RequiredIf;
use Astrotomic\Translatable\Validation\RuleFactory;

final class ValidationTest extends TestsBase
Expand Down Expand Up @@ -259,6 +261,212 @@ public function test_it_throws_exception_with_undefined_locales()
]);
}

public function test_format_array_it_replaces_single_rule()
{
$rules = [
'%title%' => 'sometimes|string',
'%content%' => 'required_with:%title%',
];

$this->assertEquals([
'en.title' => 'sometimes|string',
'de.title' => 'sometimes|string',
'de-DE.title' => 'sometimes|string',
'de-AT.title' => 'sometimes|string',

'en.content' => 'required_with:en.title',
'de.content' => 'required_with:de.title',
'de-DE.content' => 'required_with:de-DE.title',
'de-AT.content' => 'required_with:de-AT.title',
], RuleFactory::make($rules, RuleFactory::FORMAT_ARRAY));
}

public function test_format_array_it_replaces_imploded_rules()
{
$rules = [
'%title%' => 'sometimes|string',
'%content%' => 'required_with:%title%|string',
];

$this->assertEquals([
'en.title' => 'sometimes|string',
'de.title' => 'sometimes|string',
'de-DE.title' => 'sometimes|string',
'de-AT.title' => 'sometimes|string',

'en.content' => 'required_with:en.title|string',
'de.content' => 'required_with:de.title|string',
'de-DE.content' => 'required_with:de-DE.title|string',
'de-AT.content' => 'required_with:de-AT.title|string',
], RuleFactory::make($rules, RuleFactory::FORMAT_ARRAY));
}

public function test_format_array_it_replaces_array_of_rules()
{
$rules = [
'%title%' => 'sometimes|string',
'%content%' => ['required_with:%title%', 'string'],
];

$this->assertEquals([
'en.title' => 'sometimes|string',
'de.title' => 'sometimes|string',
'de-DE.title' => 'sometimes|string',
'de-AT.title' => 'sometimes|string',

'en.content' => ['required_with:en.title', 'string'],
'de.content' => ['required_with:de.title', 'string'],
'de-DE.content' => ['required_with:de-DE.title', 'string'],
'de-AT.content' => ['required_with:de-AT.title', 'string'],
], RuleFactory::make($rules, RuleFactory::FORMAT_ARRAY));
}

public function test_format_array_it_does_not_touch_non_string_rule()
{
$rules = [
'title' => 'required',
'%content%' => Rule::requiredIf(function () {
return true;
}),
];

$formattedRules = RuleFactory::make($rules, RuleFactory::FORMAT_ARRAY);

$this->assertEquals('required', $formattedRules['title']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['en.content']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['de.content']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['de-DE.content']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['de-AT.content']);
}

public function test_format_array_it_does_not_touch_non_string_rule_in_array()
{
$rules = [
'title' => 'required',
'%content%' => [
'required_with:%title%',
Rule::requiredIf(function () {
return true;
}),
],
];

$formattedRules = RuleFactory::make($rules, RuleFactory::FORMAT_ARRAY);

$this->assertEquals('required', $formattedRules['title']);
$this->assertEquals('required_with:en.title', $formattedRules['en.content'][0]);
$this->assertEquals('required_with:de.title', $formattedRules['de.content'][0]);
$this->assertEquals('required_with:de-DE.title', $formattedRules['de-DE.content'][0]);
$this->assertEquals('required_with:de-AT.title', $formattedRules['de-AT.content'][0]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['en.content'][1]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['de.content'][1]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['de-DE.content'][1]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['de-AT.content'][1]);
}

public function test_format_key_it_replaces_single_rule()
{
$rules = [
'%title%' => 'sometimes|string',
'%content%' => 'required_with:"%title%"',
];

$this->assertEquals([
'title:en' => 'sometimes|string',
'title:de' => 'sometimes|string',
'title:de-DE' => 'sometimes|string',
'title:de-AT' => 'sometimes|string',

'content:en' => 'required_with:"title:en"',
'content:de' => 'required_with:"title:de"',
'content:de-DE' => 'required_with:"title:de-DE"',
'content:de-AT' => 'required_with:"title:de-AT"',
], RuleFactory::make($rules, RuleFactory::FORMAT_KEY));
}

public function test_format_key_it_replaces_imploded_rules()
{
$rules = [
'%title%' => 'sometimes|string',
'%content%' => 'required_with:"%title%"|string',
];

$this->assertEquals([
'title:en' => 'sometimes|string',
'title:de' => 'sometimes|string',
'title:de-DE' => 'sometimes|string',
'title:de-AT' => 'sometimes|string',

'content:en' => 'required_with:"title:en"|string',
'content:de' => 'required_with:"title:de"|string',
'content:de-DE' => 'required_with:"title:de-DE"|string',
'content:de-AT' => 'required_with:"title:de-AT"|string',
], RuleFactory::make($rules, RuleFactory::FORMAT_KEY));
}

public function test_format_key_it_replaces_array_of_rules()
{
$rules = [
'%title%' => 'sometimes|string',
'%content%' => ['required_with:"%title%"', 'string'],
];

$this->assertEquals([
'title:en' => 'sometimes|string',
'title:de' => 'sometimes|string',
'title:de-DE' => 'sometimes|string',
'title:de-AT' => 'sometimes|string',

'content:en' => ['required_with:"title:en"', 'string'],
'content:de' => ['required_with:"title:de"', 'string'],
'content:de-DE' => ['required_with:"title:de-DE"', 'string'],
'content:de-AT' => ['required_with:"title:de-AT"', 'string'],
], RuleFactory::make($rules, RuleFactory::FORMAT_KEY));
}

public function test_format_key_it_does_not_touch_non_string_rule()
{
$rules = [
'title' => 'required',
'%content%' => Rule::requiredIf(function () {
return true;
}),
];

$formattedRules = RuleFactory::make($rules, RuleFactory::FORMAT_KEY);

$this->assertEquals('required', $formattedRules['title']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:en']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:de']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:de-DE']);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:de-AT']);
}

public function test_format_key_it_does_not_touch_non_string_rule_in_array()
{
$rules = [
'title' => 'required',
'%content%' => [
'required_with:"%title%"',
Rule::requiredIf(function () {
return true;
}),
],
];

$formattedRules = RuleFactory::make($rules, RuleFactory::FORMAT_KEY);

$this->assertEquals('required', $formattedRules['title']);
$this->assertEquals('required_with:"title:en"', $formattedRules['content:en'][0]);
$this->assertEquals('required_with:"title:de"', $formattedRules['content:de'][0]);
$this->assertEquals('required_with:"title:de-DE"', $formattedRules['content:de-DE'][0]);
$this->assertEquals('required_with:"title:de-AT"', $formattedRules['content:de-AT'][0]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:en'][1]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:de'][1]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:de-DE'][1]);
$this->assertInstanceOf(RequiredIf::class, $formattedRules['content:de-AT'][1]);
}

protected function setUp(): void
{
$this->setUpTheTestEnvironment();
Expand Down