ClassType, Method: added validate(), prevents classes and methods from declared both final and abstract [BC break] (#36)

Author: pierredup

readme.md

@@ -42,7 +42,6 @@ Usage is very easy. Let's start with a straightforward example of generating cla
 $class = new Nette\PhpGenerator\ClassType('Demo');
 
 $class
-	->setAbstract()
 	->setFinal()
 	->setExtends('ParentClass')
 	->addImplement('Countable')
@@ -63,7 +62,7 @@ It will render this result:
  *
  * @property-read Nette\Forms\Form $form
  */
-abstract final class Demo extends ParentClass implements Countable
+final class Demo extends ParentClass implements Countable
 {
 	use Nette\SmartObject;
 }

src/PhpGenerator/ClassType.php

@@ -183,7 +183,7 @@ public function setExtends($names): self
 		if (!is_string($names) && !is_array($names)) {
 			throw new Nette\InvalidArgumentException('Argument must be string or string[].');
 		}
-		$this->validate((array) $names);
+		$this->validateNames((array) $names);
 		$this->extends = $names;
 		return $this;
 	}
@@ -203,7 +203,7 @@ public function getExtends()
 	 */
 	public function addExtend(string $name): self
 	{
-		$this->validate([$name]);
+		$this->validateNames([$name]);
 		$this->extends = (array) $this->extends;
 		$this->extends[] = $name;
 		return $this;
@@ -216,7 +216,7 @@ public function addExtend(string $name): self
 	 */
 	public function setImplements(array $names): self
 	{
-		$this->validate($names);
+		$this->validateNames($names);
 		$this->implements = $names;
 		return $this;
 	}
@@ -236,7 +236,7 @@ public function getImplements(): array
 	 */
 	public function addImplement(string $name): self
 	{
-		$this->validate([$name]);
+		$this->validateNames([$name]);
 		$this->implements[] = $name;
 		return $this;
 	}
@@ -248,7 +248,7 @@ public function addImplement(string $name): self
 	 */
 	public function setTraits(array $names): self
 	{
-		$this->validate($names);
+		$this->validateNames($names);
 		$this->traits = array_fill_keys($names, []);
 		return $this;
 	}
@@ -277,7 +277,7 @@ public function getTraitResolutions(): array
 	 */
 	public function addTrait(string $name, array $resolutions = []): self
 	{
-		$this->validate([$name]);
+		$this->validateNames([$name]);
 		$this->traits[$name] = $resolutions;
 		return $this;
 	}
@@ -461,7 +461,21 @@ public function removeMethod(string $name): self
 	}
 
 
-	private function validate(array $names): void
+	/**
+	 * @throws Nette\InvalidStateException
+	 */
+	public function validate(): void
+	{
+		if ($this->abstract && $this->final) {
+			throw new Nette\InvalidStateException('Class cannot be abstract and final.');
+
+		} elseif (!$this->name && ($this->abstract || $this->final)) {
+			throw new Nette\InvalidStateException('Anonymous class cannot be abstract or final.');
+		}
+	}
+
+
+	private function validateNames(array $names): void
 	{
 		foreach ($names as $name) {
 			if (!Helpers::isNamespaceIdentifier($name, true)) {

src/PhpGenerator/Method.php

@@ -120,4 +120,15 @@ public function isAbstract(): bool
 	{
 		return $this->abstract;
 	}
+
+
+	/**
+	 * @throws Nette\InvalidStateException
+	 */
+	public function validate(): void
+	{
+		if ($this->abstract && ($this->final || $this->visibility === ClassType::VISIBILITY_PRIVATE)) {
+			throw new Nette\InvalidStateException('Method cannot be abstract and final or private.');
+		}
+	}
 }

src/PhpGenerator/Printer.php

@@ -60,6 +60,7 @@ public function printClosure(Closure $closure): string
 
 	public function printMethod(Method $method, PhpNamespace $namespace = null): string
 	{
+		$method->validate();
 		return Helpers::formatDocComment($method->getComment() . "\n")
 			. ($method->isAbstract() ? 'abstract ' : '')
 			. ($method->isFinal() ? 'final ' : '')
@@ -81,6 +82,7 @@ public function printMethod(Method $method, PhpNamespace $namespace = null): str
 
 	public function printClass(ClassType $class, PhpNamespace $namespace = null): string
 	{
+		$class->validate();
 		$resolver = $namespace ? [$namespace, 'unresolveName'] : function ($s) { return $s; };
 
 		$traits = [];

tests/PhpGenerator/ClassType.phpt

@@ -24,7 +24,6 @@ Assert::same([], $class->getTraitResolutions());
 
 $class
 	->setAbstract(true)
-	->setFinal(true)
 	->setExtends('ParentClass')
 	->addImplement('IExample')
 	->addImplement('IOne')
@@ -35,7 +34,7 @@ $class
 	->setConstants(['ROLE' => 'admin'])
 	->addConstant('ACTIVE', false);
 
-Assert::true($class->isFinal());
+Assert::false($class->isFinal());
 Assert::true($class->isAbstract());
 Assert::same('ParentClass', $class->getExtends());
 Assert::same(['ObjectTrait', 'AnotherTrait'], $class->getTraits());

tests/PhpGenerator/ClassType.validate.phpt

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\ClassType;
+use Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+Assert::exception(function () {
+	$class = new ClassType('A');
+	$class->setFinal(true)->setAbstract(true);
+	$class->validate();
+}, Nette\InvalidStateException::class, 'Class cannot be abstract and final.');
+
+Assert::exception(function () {
+	$class = new ClassType('A');
+	$class->setAbstract(true)->setFinal(true);
+	$class->validate();
+}, Nette\InvalidStateException::class, 'Class cannot be abstract and final.');
+
+Assert::exception(function () {
+	$class = new ClassType;
+	$class->setAbstract(true);
+	$class->validate();
+}, Nette\InvalidStateException::class, 'Anonymous class cannot be abstract or final.');

tests/PhpGenerator/Method.validate.phpt

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\Method;
+use Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+Assert::exception(function () {
+	$method = new Method('foo');
+	$method->setFinal(true)->setAbstract(true);
+	$method->validate();
+}, Nette\InvalidStateException::class, 'Method cannot be abstract and final or private.');
+
+Assert::exception(function () {
+	$method = new Method('foo');
+	$method->setAbstract(true)->setFinal(true);
+	$method->validate();
+}, Nette\InvalidStateException::class, 'Method cannot be abstract and final or private.');
+
+Assert::exception(function () {
+	$method = new Method('foo');
+	$method->setAbstract(true)->setVisibility('private');
+	$method->validate();
+}, Nette\InvalidStateException::class, 'Method cannot be abstract and final or private.');

tests/PhpGenerator/Printer.phpt

@@ -5,6 +5,7 @@ declare(strict_types=1);
 use Nette\PhpGenerator\ClassType;
 use Nette\PhpGenerator\PhpLiteral;
 use Nette\PhpGenerator\Printer;
+use Tester\Assert;
 
 
 require __DIR__ . '/../bootstrap.php';
@@ -65,3 +66,11 @@ $closure
 		->setTypeHint('stdClass');
 
 sameFile(__DIR__ . '/expected/Printer.closure.expect', $printer->printClosure($closure));
+
+
+// printer validates class
+Assert::exception(function () {
+	$class = new ClassType;
+	$class->setFinal(true)->setAbstract(true);
+	(new Printer)->printClass($class);
+}, Nette\InvalidStateException::class, 'Class cannot be abstract and final.');

tests/PhpGenerator/expected/ClassType.expect

@@ -4,7 +4,7 @@
  *
  * @property-read Nette\Forms\Form $form
  */
-abstract final class Example extends ParentClass implements IExample, IOne
+abstract class Example extends ParentClass implements IExample, IOne
 {
 	use ObjectTrait;
 	use AnotherTrait {