Skip to content

Commit 2839040

Browse files
committed
Rename StandardRenderer to InterpolationRenderer
The name `StandardRenderer` is ambiguous because it doesn't describe the class's behavior, only that it is the "standard" or default implementation. This follows the same reasoning as the recent refactoring of `StandardFormatter`. The renderer's primary function is to process a message template by replacing placeholders (like `{{name}}`) with their corresponding values. This process is known as string interpolation. To better reflect this responsibility, the class has been renamed to `InterpolationRenderer`. This new name makes the class's purpose immediately clear, which improves the overall clarity and maintainability of the rendering system. It also helps to establish a clearer naming convention for any future renderers (e.g., `JsonRenderer`, `HtmlRenderer`).
1 parent 4231729 commit 2839040

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
use function preg_replace_callback;
2424
use function print_r;
2525

26-
final class StandardRenderer implements Renderer
26+
final class InterpolationRenderer implements Renderer
2727
{
2828
/** @var array<string, array<Template>> */
2929
private array $templates = [];

library/ValidatorDefaults.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
use Respect\Validation\Message\Formatter\NestedArrayFormatter;
1515
use Respect\Validation\Message\Formatter\NestedListStringFormatter;
1616
use Respect\Validation\Message\Formatter\TemplateResolver;
17+
use Respect\Validation\Message\InterpolationRenderer;
1718
use Respect\Validation\Message\Renderer;
18-
use Respect\Validation\Message\StandardRenderer;
1919
use Respect\Validation\Message\StringFormatter;
2020
use Respect\Validation\Message\Translator;
2121
use Respect\Validation\Message\Translator\DummyTranslator;
@@ -61,7 +61,7 @@ public static function setRenderer(Renderer $renderer): void
6161
public static function getRenderer(): Renderer
6262
{
6363
if (self::$renderer === null) {
64-
self::$renderer = new StandardRenderer();
64+
self::$renderer = new InterpolationRenderer();
6565
}
6666

6767
return self::$renderer;

tests/unit/Message/StandardRendererTest.php renamed to tests/unit/Message/InterpolationRendererTest.php

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919

2020
use function sprintf;
2121

22-
#[CoversClass(StandardRenderer::class)]
23-
final class StandardRendererTest extends TestCase
22+
#[CoversClass(InterpolationRenderer::class)]
23+
final class InterpolationRendererTest extends TestCase
2424
{
2525
#[Test]
2626
public function itShouldRenderResultWithCustomTemplate(): void
2727
{
28-
$renderer = new StandardRenderer(new TestingStringifier());
28+
$renderer = new InterpolationRenderer(new TestingStringifier());
2929

3030
$result = (new ResultBuilder())->template('This is my template')->build();
3131

@@ -37,7 +37,7 @@ public function itShouldRenderResultProcessingParametersInTheTemplate(): void
3737
{
3838
$stringifier = new TestingStringifier();
3939

40-
$renderer = new StandardRenderer($stringifier);
40+
$renderer = new InterpolationRenderer($stringifier);
4141

4242
$key = 'foo';
4343
$value = true;
@@ -58,7 +58,7 @@ public function itShouldRenderResultProcessingRawParametersInTheTemplate(): void
5858
{
5959
$stringifier = new TestingStringifier();
6060

61-
$renderer = new StandardRenderer($stringifier);
61+
$renderer = new InterpolationRenderer($stringifier);
6262

6363
$key = 'foo';
6464
$value = 0.1;
@@ -79,7 +79,7 @@ public function itShouldRenderResultProcessingRawBooleanParametersInTheTemplate(
7979
{
8080
$stringifier = new TestingStringifier();
8181

82-
$renderer = new StandardRenderer($stringifier);
82+
$renderer = new InterpolationRenderer($stringifier);
8383

8484
$key = 'foo';
8585
$value = false;
@@ -100,7 +100,7 @@ public function itShouldRenderResultProcessingTranslatableParametersInTheTemplat
100100
{
101101
$stringifier = new TestingStringifier();
102102

103-
$renderer = new StandardRenderer($stringifier);
103+
$renderer = new InterpolationRenderer($stringifier);
104104

105105
$key = 'foo';
106106
$value = 'original';
@@ -122,7 +122,7 @@ public function itShouldRenderResultProcessingNameParameterWhenItIsInTheTemplate
122122
{
123123
$stringifier = new TestingStringifier();
124124

125-
$renderer = new StandardRenderer($stringifier);
125+
$renderer = new InterpolationRenderer($stringifier);
126126

127127
$value = 'original';
128128

@@ -142,7 +142,7 @@ public function itShouldRenderResultProcessingNameParameterWhenItIsInTheTemplate
142142
{
143143
$stringifier = new TestingStringifier();
144144

145-
$renderer = new StandardRenderer($stringifier);
145+
$renderer = new InterpolationRenderer($stringifier);
146146

147147
$value = true;
148148

@@ -160,7 +160,7 @@ public function itShouldRenderResultProcessingNameParameterWhenItIsInTheTemplate
160160
#[Test]
161161
public function itShouldRenderResultProcessingNameAsSomeParameterInTheTemplate(): void
162162
{
163-
$renderer = new StandardRenderer(new TestingStringifier());
163+
$renderer = new InterpolationRenderer(new TestingStringifier());
164164

165165
$name = 'my name';
166166

@@ -180,7 +180,7 @@ public function itShouldRenderResultProcessingInputAsNameWhenResultHasNoName():
180180
{
181181
$stringifier = new TestingStringifier();
182182

183-
$renderer = new StandardRenderer($stringifier);
183+
$renderer = new InterpolationRenderer($stringifier);
184184

185185
$input = 42;
186186

@@ -200,7 +200,7 @@ public function itShouldRenderResultProcessingInputAsSomeParameterInTheTemplate(
200200
{
201201
$stringifier = new TestingStringifier();
202202

203-
$renderer = new StandardRenderer($stringifier);
203+
$renderer = new InterpolationRenderer($stringifier);
204204

205205
$input = 42;
206206

@@ -222,7 +222,7 @@ public function itShouldRenderResultNotOverwritingNameParameterWithRealName(): v
222222

223223
$stringifier = new TestingStringifier();
224224

225-
$renderer = new StandardRenderer($stringifier);
225+
$renderer = new InterpolationRenderer($stringifier);
226226

227227
$result = (new ResultBuilder())
228228
->template('Will replace {{name}}')
@@ -241,7 +241,7 @@ public function itShouldRenderResultNotOverwritingInputParameterWithRealInput():
241241
{
242242
$stringifier = new TestingStringifier();
243243

244-
$renderer = new StandardRenderer($stringifier);
244+
$renderer = new InterpolationRenderer($stringifier);
245245

246246
$input = 'real input';
247247

@@ -260,7 +260,7 @@ public function itShouldRenderResultNotOverwritingInputParameterWithRealInput():
260260
#[Test]
261261
public function itShouldRenderResultProcessingNonExistingParameters(): void
262262
{
263-
$renderer = new StandardRenderer(new TestingStringifier());
263+
$renderer = new InterpolationRenderer(new TestingStringifier());
264264

265265
$result = (new ResultBuilder())
266266
->template('Will not replace {{unknown}}')
@@ -275,7 +275,7 @@ public function itShouldRenderResultTranslatingTemplate(): void
275275
$template = 'This is my template with {{foo}}';
276276
$translations = [$template => 'This is my translated template with {{foo}}'];
277277

278-
$renderer = new StandardRenderer(new TestingStringifier());
278+
$renderer = new InterpolationRenderer(new TestingStringifier());
279279
$translator = new ArrayTranslator($translations);
280280

281281
$result = (new ResultBuilder())
@@ -289,7 +289,7 @@ public function itShouldRenderResultTranslatingTemplate(): void
289289
public function itShouldRenderResultWithNonCustomTemplate(): void
290290
{
291291
$stringifier = new TestingStringifier();
292-
$renderer = new StandardRenderer($stringifier);
292+
$renderer = new InterpolationRenderer($stringifier);
293293

294294
$result = (new ResultBuilder())->build();
295295

@@ -303,7 +303,7 @@ public function itShouldRenderResultWithNonCustomTemplate(): void
303303
public function itShouldRenderResultWithNonCustomTemplateAndInvertedMode(): void
304304
{
305305
$stringifier = new TestingStringifier();
306-
$renderer = new StandardRenderer($stringifier);
306+
$renderer = new InterpolationRenderer($stringifier);
307307

308308
$result = (new ResultBuilder())->hasInvertedMode()->build();
309309

@@ -316,7 +316,7 @@ public function itShouldRenderResultWithNonCustomTemplateAndInvertedMode(): void
316316
#[Test]
317317
public function itShouldRenderResultWithNonCustomTemplateWhenCannotFindAttachedTemplate(): void
318318
{
319-
$renderer = new StandardRenderer(new TestingStringifier());
319+
$renderer = new InterpolationRenderer(new TestingStringifier());
320320

321321
$result = (new ResultBuilder())->template('__not_standard__')->hasInvertedMode()->build();
322322

@@ -329,7 +329,7 @@ public function itShouldRenderResultWithNonCustomTemplateWhenCannotFindAttachedT
329329
#[Test]
330330
public function itShouldRenderResultWithItsAdjacentsWhenItHasNoCustomTemplate(): void
331331
{
332-
$renderer = new StandardRenderer(new TestingStringifier());
332+
$renderer = new InterpolationRenderer(new TestingStringifier());
333333

334334
$result = (new ResultBuilder())->template('__1st__')
335335
->adjacent(
@@ -355,7 +355,7 @@ public function itShouldRenderResultWithoutItsAdjacentsWhenItHasCustomTemplate()
355355
->adjacent((new ResultBuilder())->template('and this is a adjacent')->build())
356356
->build();
357357

358-
$renderer = new StandardRenderer(new TestingStringifier());
358+
$renderer = new InterpolationRenderer(new TestingStringifier());
359359

360360
self::assertSame($template, $renderer->render($result, new DummyTranslator()));
361361
}

tests/unit/ValidatorDefaultsTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use Respect\Validation\Message\Formatter\FirstResultStringFormatter;
1616
use Respect\Validation\Message\Formatter\NestedArrayFormatter;
1717
use Respect\Validation\Message\Formatter\NestedListStringFormatter;
18-
use Respect\Validation\Message\StandardRenderer;
18+
use Respect\Validation\Message\InterpolationRenderer;
1919
use Respect\Validation\Message\StringFormatter;
2020
use Respect\Validation\Message\Translator;
2121
use Respect\Validation\Message\Translator\DummyTranslator;
@@ -75,7 +75,7 @@ public function defaultRendererIsCreatedOnce(): void
7575
$first = ValidatorDefaults::getRenderer();
7676
$second = ValidatorDefaults::getRenderer();
7777

78-
self::assertInstanceOf(StandardRenderer::class, $first);
78+
self::assertInstanceOf(InterpolationRenderer::class, $first);
7979
self::assertSame($first, $second);
8080
}
8181

0 commit comments

Comments
 (0)