FormMacros: added {formPrint $form}

Author: dg

composer.json

@@ -23,7 +23,7 @@
 	"require-dev": {
 		"nette/di": "^3.0",
 		"nette/tester": "^2.0",
-		"latte/latte": "^2.4.1",
+		"latte/latte": "^2.7",
 		"tracy/tracy": "^2.4",
 		"phpstan/phpstan-nette": "^0.12"
 	},

src/Bridges/FormsLatte/FormMacros.php

@@ -36,6 +36,7 @@ public static function install(Latte\Compiler $compiler): void
 		$me->addMacro('input', [$me, 'macroInput']);
 		$me->addMacro('name', [$me, 'macroName'], [$me, 'macroNameEnd'], [$me, 'macroNameAttr']);
 		$me->addMacro('inputError', [$me, 'macroInputError']);
+		$me->addMacro('formPrint', [$me, 'macroFormPrint']);
 	}
 
 
@@ -240,4 +241,22 @@ public function macroInputError(MacroNode $node, PhpWriter $writer)
 			return $writer->write('echo %escape(end($this->global->formsStack)[%0.word]->getError());', $name);
 		}
 	}
+
+
+	/**
+	 * {formPrint [ClassName]}
+	 */
+	public function macroFormPrint(MacroNode $node, PhpWriter $writer)
+	{
+		$name = $node->tokenizer->fetchWord();
+		if ($name == null) { // null or false
+			throw new CompileException('Missing form name in ' . $node->getNotation());
+		}
+		$node->tokenizer->reset();
+		return $writer->write(
+			'Nette\Bridges\FormsLatte\Runtime::renderBlueprint('
+			. ($name[0] === '$' ? 'is_object(%node.word) ? %node.word : ' : '')
+			. '$this->global->uiControl[%node.word]); exit;'
+		);
+	}
 }

src/Bridges/FormsLatte/Runtime.php

@@ -9,6 +9,7 @@
 
 namespace Nette\Bridges\FormsLatte;
 
+use Latte;
 use Nette;
 use Nette\Forms\Form;
 use Nette\Utils\Html;
@@ -71,4 +72,68 @@ public static function renderFormEnd(Form $form, bool $withTags = true): string
 
 		return $s . ($withTags ? $form->getElementPrototype()->endTag() . "\n" : '');
 	}
+
+
+	/**
+	 * Generates blueprint of form.
+	 */
+	public static function renderBlueprint($form): void
+	{
+		$dummyForm = new Form;
+		$dict = new \SplObjectStorage;
+		foreach ($form->getControls() as $name => $input) {
+			$dict[$input] = $dummyControl = new class extends Nette\Forms\Controls\BaseControl {
+				public $inner;
+
+
+				public function getLabel($name = null)
+				{
+					return $this->inner->getLabel() ? '{label ' . $this->inner->lookupPath(null) . '}' : null;
+				}
+
+
+				public function getControl()
+				{
+					return '{input ' . $this->inner->lookupPath(null) . '}';
+				}
+
+
+				public function isRequired(): bool
+				{
+					return $this->inner->isRequired();
+				}
+
+
+				public function getOption($key, $default = null)
+				{
+					return $key === 'rendered' ? parent::getOption($key) : $this->inner->getOption($key, $default);
+				}
+			};
+			$dummyControl->inner = $input;
+			$dummyForm->addComponent($dummyControl, (string) $dict->count());
+		}
+
+		foreach ($form->getGroups() as $group) {
+			$dummyGroup = $dummyForm->addGroup();
+			foreach ($group->getOptions() as $k => $v) {
+				$dummyGroup->setOption($k, $v);
+			}
+			foreach ($group->getControls() as $control) {
+				if ($dict[$control]) {
+					$dummyGroup->add($dict[$control]);
+				}
+			}
+		}
+
+		$dummyForm->setRenderer($form->getRenderer());
+		ob_start();
+		$dummyForm->render('body');
+		$body = ob_get_clean();
+
+		$blueprint = new Latte\Runtime\Blueprint;
+		$end = $blueprint->printCanvas();
+		$blueprint->printHeader('Form ' . $form->getName());
+		$blueprint->printCode('<form n:name="' . $form->getName() . '">' . $body . '</form>');
+		echo $end;
+	}
 }

tests/Forms.Latte/Runtime.renderBlueprint.phpt

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\Forms\Form;
+use Nette\Utils\Html;
+use Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$form = new Form('signForm');
+$form->addGroup('Personal data');
+$form->addText('name')->setRequired('Enter your name');
+$form->addContainer('cont')
+	->addText('name');
+$form->addHidden('id');
+$form->addCheckbox('agree');
+$form->addGroup();
+$form->addSubmit('submit', 'Send');
+
+$renderer = $form->getRenderer();
+$renderer->wrappers['form']['container'] = Html::el('div')->id('form');
+$renderer->wrappers['group']['container'] = null;
+$renderer->wrappers['group']['label'] = 'h3';
+$renderer->wrappers['pair']['container'] = null;
+$renderer->wrappers['controls']['container'] = 'dl';
+$renderer->wrappers['control']['container'] = 'dd';
+$renderer->wrappers['control']['.odd'] = 'odd';
+$renderer->wrappers['label']['container'] = 'dt';
+$renderer->wrappers['label']['suffix'] = ':';
+
+
+ob_start();
+Nette\Bridges\FormsLatte\Runtime::renderBlueprint($form);
+$res = ob_get_clean();
+
+Assert::match(
+'%A%<form n:name="signForm">
+<div id="form">
+
+<h3>Personal data</h3>
+
+<dl>
+
+	<dt>{label name}:</dt>
+
+	<dd>{input name}</dd>
+
+
+
+	<dt>{label cont-name}:</dt>
+
+	<dd class="odd">{input cont-name}</dd>
+
+
+
+	<dt></dt>
+
+	<dd>{input agree}</dd>
+
+</dl>
+
+
+
+<dl>
+
+	<dt></dt>
+
+	<dd>{input submit}</dd>
+
+</dl>
+
+</div>
+</form>%A%',
+	$res
+);