BlockMacros: {define} accepts named parameters [Closes #184][Closes #198

]
nette · Nov 23, 2020 · ce2b118 · ce2b118
1 parent 84af218
commit ce2b118
Show file tree

Hide file tree

Showing 29 changed files with 318 additions and 44 deletions.
diff --git a/src/Latte/Macros/BlockMacros.php b/src/Latte/Macros/BlockMacros.php
@@ -84,9 +84,9 @@ public function finalize()
 		$compiler = $this->getCompiler();
 		foreach ($this->placeholders as $key => [$index, $blockName]) {
 			$block = $this->blocks[$index][$blockName] ?? $this->blocks[Template::LAYER_LOCAL][$blockName] ?? null;
-			$compiler->placeholders[$key] = $block
+			$compiler->placeholders[$key] = $block && !$block->hasParameters
 				? 'get_defined_vars()'
-				: '$this->params';
+				: '[]';
 		}
 
 		$meta = [];
@@ -328,25 +328,30 @@ public function macroDefine(MacroNode $node, PhpWriter $writer): string
 		}
 
 		$tokens = $node->tokenizer;
-		$args = [];
+		$params = [];
 		while ($tokens->isNext()) {
 			if ($tokens->nextToken($tokens::T_SYMBOL, '?', 'null', '\\')) { // type
 				$tokens->nextAll($tokens::T_SYMBOL, '\\', '|', '[', ']', 'null');
 			}
-			$args[] = $tokens->consumeValue($tokens::T_VARIABLE);
+			$param = $tokens->consumeValue($tokens::T_VARIABLE);
+			$params[] = $writer->write(
+				'%raw = $__args[%var] ?? $__args[%var] ?? null;',
+				$param,
+				count($params),
+				substr($param, 1)
+			);
 			if ($tokens->isNext()) {
 				$tokens->consumeValue(',');
 			}
 		}
 
 		$extendsCheck = $this->blocks[Template::LAYER_TOP] || count($this->blocks) > 1 || $node->parentNode;
 		$block = $this->addBlock($node, $layer);
+		$block->hasParameters = (bool) $params;
 
-		$data->after = function () use ($node, $block, $args) {
-			$args = $args
-				? ('[' . implode(', ', $args) . '] = $__args + [' . str_repeat('null, ', count($args)) . '];')
-				: null;
-			$this->extractMethod($node, $block, $args);
+		$data->after = function () use ($node, $block, $params) {
+			$params = $params ? implode('', $params) : null;
+			$this->extractMethod($node, $block, $params);
 		};
 
 		return $extendsCheck
@@ -433,12 +438,12 @@ public function macroSnippet(MacroNode $node, PhpWriter $writer): string
 				"<?php echo ' {$this->snippetAttribute}=\"' . htmlspecialchars(\$this->global->snippetDriver->getHtmlId(%var)) . '\"' ?>",
 				$data->name
 			);
-			return $writer->write('$this->renderBlock(%var, $this->params, null, %var)', $data->name, Template::LAYER_SNIPPET);
+			return $writer->write('$this->renderBlock(%var, [], null, %var)', $data->name, Template::LAYER_SNIPPET);
 		}
 
 		return $writer->write(
 			"?>\n<div {$this->snippetAttribute}=\"<?php echo htmlspecialchars(\$this->global->snippetDriver->getHtmlId(%var)) ?>\">"
-			. '<?php $this->renderBlock(%var, $this->params, null, %var) ?>'
+			. '<?php $this->renderBlock(%var, [], null, %var) ?>'
 			. "\n</div><?php ",
 			$data->name,
 			$data->name,
@@ -499,7 +504,7 @@ public function macroSnippetArea(MacroNode $node, PhpWriter $writer): string
 			);
 			$this->extractMethod($node, $block);
 		};
-		return $writer->write('$this->renderBlock(%var, $this->params, null, %var)', $data->name, Template::LAYER_SNIPPET);
+		return $writer->write('$this->renderBlock(%var, [], null, %var)', $data->name, Template::LAYER_SNIPPET);
 	}
 
 
@@ -533,12 +538,10 @@ private function addBlock(MacroNode $node, string $layer = null): Block
 	}
 
 
-	private function extractMethod(MacroNode $node, Block $block, string $args = null): void
+	private function extractMethod(MacroNode $node, Block $block, string $params = null): void
 	{
 		if (preg_match('#\$|n:#', $node->content)) {
-			$node->content = '<?php '
-				. ($args === null ? 'extract($__args);' : 'extract($this->params); ' . $args)
-				. ' ?>' . $node->content;
+			$node->content = '<?php extract($this->params);' . ($params ?? 'extract($__args);') . '?>' . $node->content;
 		}
 		$block->code = preg_replace('#^\n+|(?<=\n)[ \t]+$#D', '', $node->content);
 		$node->content = substr_replace($node->content, $node->openingCode . "\n", strspn($node->content, "\n"), strlen($block->code));

diff --git a/src/Latte/Runtime/Block.php b/src/Latte/Runtime/Block.php
@@ -21,4 +21,7 @@ final class Block
 
 	/** @var callable[]  used by Template */
 	public $functions = [];
+
+	/** @var bool  used by BlockMacros */
+	public $hasParameters = false;
 }
diff --git a/tests/Latte/BlockMacros.define.args.phpt b/tests/Latte/BlockMacros.define.args.phpt
@@ -44,6 +44,7 @@ Assert::matchFile(
 );
 
 
+//typehints
 $template = <<<'XX'
 {define test $var1, ?stdClass $var2, \C\B|null $var3}
 {/define}
@@ -55,3 +56,80 @@ Assert::matchFile(
 	__DIR__ . '/expected/BlockMacros.define.typehints.phtml',
 	$latte->compile($template)
 );
+
+
+// named arguments
+$template = <<<'XX'
+named arguments
+
+{define test $var1, $var2, $var3}
+	Variables {$var1}, {$var2}, {$var3}
+{/define}
+
+a) {include test, 1, var1 => 2}
+
+b) {include test, var2 => 1}
+
+c) {include test, hello => 1}
+
+d) {include test, var2 => 1, 2} // invalid
+XX;
+
+Assert::matchFile(
+	__DIR__ . '/expected/BlockMacros.define.args2.phtml',
+	$latte->compile($template)
+);
+Assert::matchFile(
+	__DIR__ . '/expected/BlockMacros.define.args2.html',
+	$latte->renderToString($template, ['var3' => 'outer'])
+);
+
+
+// named arguments (order dependent)
+$template = <<<'XX'
+named arguments order
+
+a) {include test, 1, var1 => 2}
+
+b) {include test, var2 => 1}
+
+c) {include test, hello => 1}
+
+{define test $var1, $var2, $var3}
+	Variables {$var1}, {$var2}, {$var3}
+{/define}
+XX;
+
+Assert::matchFile(
+	__DIR__ . '/expected/BlockMacros.define.args3.phtml',
+	$latte->compile($template)
+);
+
+
+// named arguments (file dependent)
+$latte->setLoader(new Latte\Loaders\StringLoader([
+	'main' => '
+named arguments import
+
+{import import.latte}
+
+a) {include test, 1, var1 => 2}
+
+b) {include test, var2 => 1}
+
+c) {include test, hello => 1}',
+
+	'import.latte' => '
+{define test $var1, $var2, $var3}
+	Variables {$var1}, {$var2}, {$var3}
+{/define}',
+]));
+
+Assert::matchFile(
+	__DIR__ . '/expected/BlockMacros.define.args4.phtml',
+	$latte->compile('main')
+);
+Assert::matchFile(
+	__DIR__ . '/expected/BlockMacros.define.args4.html',
+	$latte->renderToString('main', ['var3' => 'outer'])
+);
diff --git a/tests/Latte/expected/BlockMacros.define.args1.phtml b/tests/Latte/expected/BlockMacros.define.args1.phtml
@@ -16,7 +16,7 @@ final class Template%a% extends Latte\Runtime\Template
 		}
 		echo '
 a) ';
-		$this->renderBlock($__nm = 'test', [1] + get_defined_vars(), 'html');
+		$this->renderBlock($__nm = 'test', [1] + [], 'html');
 		echo '
 
 
@@ -27,19 +27,21 @@ b) ';
 ';
 		$var1 = 'outer';
 		echo 'c) ';
-		$this->renderBlock($__nm = 'test', get_defined_vars(), 'html');
+		$this->renderBlock($__nm = 'test', [], 'html');
 		echo '
 
 d) ';
-		$this->renderBlock($__nm = 'test', [null] + get_defined_vars(), 'html');
+		$this->renderBlock($__nm = 'test', [null] + [], 'html');
 		return get_defined_vars();
 	}
 
 
 	public function blockTest(array $__args): void
 	{
 		extract($this->params);
-		[$var1, $var2, $var3] = $__args + [null, null, null, ];
+		$var1 = $__args[0] ?? $__args['var1'] ?? null;
+		$var2 = $__args[1] ?? $__args['var2'] ?? null;
+		$var3 = $__args[2] ?? $__args['var3'] ?? null;
 		echo '	Variables ';
 		echo LR\Filters::escapeHtmlText($var1) /* line 2 */;
 		echo ', ';
@@ -52,8 +54,9 @@ d) ';
 
 	public function blockOuter(array $__args): void
 	{
+		extract($this->params);
 		extract($__args);
-		$this->renderBlock($__nm = 'test', ['hello'] + get_defined_vars(), 'html');
+		$this->renderBlock($__nm = 'test', ['hello'] + [], 'html');
 
 	}
 

diff --git a/tests/Latte/expected/BlockMacros.define.args2.html b/tests/Latte/expected/BlockMacros.define.args2.html
@@ -0,0 +1,14 @@
+named arguments
+
+
+a) 	Variables 1, ,
+
+
+b) 	Variables , 1,
+
+
+c) 	Variables , ,
+
+
+d) 	Variables 2, 1,
+ // invalid
diff --git a/tests/Latte/expected/BlockMacros.define.args2.phtml b/tests/Latte/expected/BlockMacros.define.args2.phtml
@@ -0,0 +1,55 @@
+<?php
+%A%
+
+final class Template%a% extends Latte\Runtime\Template
+{
+	protected const BLOCKS = [
+		['test' => 'blockTest'],
+	];
+
+
+	public function main(): array
+	{
+		extract($this->params);
+		echo 'named arguments
+
+';
+		if ($this->getParentName()) {
+			return get_defined_vars();
+		}
+		echo '
+a) ';
+		$this->renderBlock($__nm = 'test', [1, 'var1' => 2] + [], 'html');
+		echo '
+
+b) ';
+		$this->renderBlock($__nm = 'test', ['var2' => 1] + [], 'html');
+		echo '
+
+c) ';
+		$this->renderBlock($__nm = 'test', ['hello' => 1] + [], 'html');
+		echo '
+
+d) ';
+		$this->renderBlock($__nm = 'test', ['var2' => 1, 2] + [], 'html');
+		echo ' // invalid';
+		return get_defined_vars();
+	}
+
+
+	public function blockTest(array $__args): void
+	{
+		extract($this->params);
+		$var1 = $__args[0] ?? $__args['var1'] ?? null;
+		$var2 = $__args[1] ?? $__args['var2'] ?? null;
+		$var3 = $__args[2] ?? $__args['var3'] ?? null;
+		echo '	Variables ';
+		echo LR\Filters::escapeHtmlText($var1) /* line 4 */;
+		echo ', ';
+		echo LR\Filters::escapeHtmlText($var2) /* line 4 */;
+		echo ', ';
+		echo LR\Filters::escapeHtmlText($var3) /* line 4 */;
+		echo "\n";
+	}
+
+}
diff --git a/tests/Latte/expected/BlockMacros.define.args3.phtml b/tests/Latte/expected/BlockMacros.define.args3.phtml
@@ -0,0 +1,51 @@
+<?php
+%A%
+
+final class Template%a% extends Latte\Runtime\Template
+{
+	protected const BLOCKS = [
+		['test' => 'blockTest'],
+	];
+
+
+	public function main(): array
+	{
+		extract($this->params);
+		echo 'named arguments order
+
+a) ';
+		$this->renderBlock($__nm = 'test', [1, 'var1' => 2] + [], 'html');
+		echo '
+
+b) ';
+		$this->renderBlock($__nm = 'test', ['var2' => 1] + [], 'html');
+		echo '
+
+c) ';
+		$this->renderBlock($__nm = 'test', ['hello' => 1] + [], 'html');
+		echo '
+
+';
+		if ($this->getParentName()) {
+			return get_defined_vars();
+		}
+		return get_defined_vars();
+	}
+
+
+	public function blockTest(array $__args): void
+	{
+		extract($this->params);
+		$var1 = $__args[0] ?? $__args['var1'] ?? null;
+		$var2 = $__args[1] ?? $__args['var2'] ?? null;
+		$var3 = $__args[2] ?? $__args['var3'] ?? null;
+		echo '	Variables ';
+		echo LR\Filters::escapeHtmlText($var1) /* line 10 */;
+		echo ', ';
+		echo LR\Filters::escapeHtmlText($var2) /* line 10 */;
+		echo ', ';
+		echo LR\Filters::escapeHtmlText($var3) /* line 10 */;
+		echo "\n";
+	}
+
+}
diff --git a/tests/Latte/expected/BlockMacros.define.args4.html b/tests/Latte/expected/BlockMacros.define.args4.html
@@ -0,0 +1,11 @@
+
+named arguments import
+
+
+a) 	Variables 1, ,
+
+
+b) 	Variables , 1,
+
+
+c) 	Variables , ,
diff --git a/tests/Latte/expected/BlockMacros.define.args4.phtml b/tests/Latte/expected/BlockMacros.define.args4.phtml
@@ -0,0 +1,29 @@
+<?php
+%A%
+
+final class Template%a% extends Latte\Runtime\Template
+{
+
+	public function main(): array
+	{
+		extract($this->params);
+		echo '
+named arguments import
+
+';
+		$this->createTemplate("import.latte", $this->params, "import")->render();
+		echo '
+a) ';
+		$this->renderBlock($__nm = 'test', [1, 'var1' => 2] + [], 'html');
+		echo '
+
+b) ';
+		$this->renderBlock($__nm = 'test', ['var2' => 1] + [], 'html');
+		echo '
+
+c) ';
+		$this->renderBlock($__nm = 'test', ['hello' => 1] + [], 'html');
+		return get_defined_vars();
+	}
+
+}