Make ClassLike::from return type assert the subclass type (#154)

* Make ClassLike::from return type more strict

* Throw exception instead of relying on PHP type error

* Improve exception message and add test

Author: GromNaN

src/PhpGenerator/ClassLike.php

@@ -37,18 +37,30 @@ abstract class ClassLike
 	private ?PhpNamespace $namespace;
 	private ?string $name;
 
-
-	public static function from(string|object $class, bool $withBodies = false): self
+	public static function from(string|object $class, bool $withBodies = false): static
 	{
-		return (new Factory)
+		$instance = (new Factory)
 			->fromClassReflection(new \ReflectionClass($class), $withBodies);
+
+        if (!$instance instanceof static) {
+            $class = is_object($class) ? get_class($class) : $class;
+            throw new Nette\InvalidArgumentException("'$class' cannot be represented with " . static::class . ". Call " . get_class($instance) . "::" . __FUNCTION__ . "() or " . __METHOD__ . "() instead.");
+        }
+
+        return $instance;
 	}
 
 
-	public static function fromCode(string $code): self
+	public static function fromCode(string $code): static
 	{
-		return (new Factory)
+		$instance = (new Factory)
 			->fromClassCode($code);
+
+        if (!$instance instanceof static) {
+            throw new Nette\InvalidArgumentException("Provided code cannot be represented with " . static::class . ". Call " . get_class($instance) . "::" . __FUNCTION__ . "() or " . __METHOD__ . "() instead.");
+        }
+
+        return $instance;
 	}
 
 

tests/PhpGenerator/ClassLike.typecheck.phpt

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\ClassType;
+use Nette\PhpGenerator\EnumType;
+use Nette\PhpGenerator\InterfaceType;
+use Nette\PhpGenerator\TraitType;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+require __DIR__ . '/fixtures/classes.php';
+
+Assert::exception(function () {
+	ClassType::from(Abc\Interface1::class);
+}, Nette\InvalidArgumentException::class, "'Abc\\Interface1' cannot be represented with Nette\\PhpGenerator\\ClassType. Call Nette\\PhpGenerator\\InterfaceType::from() or Nette\\PhpGenerator\\ClassLike::from() instead.");
+
+Assert::exception(function () {
+    TraitType::from(Abc\Class1::class);
+}, Nette\InvalidArgumentException::class, "'Abc\\Class1' cannot be represented with Nette\\PhpGenerator\\TraitType. Call Nette\\PhpGenerator\\ClassType::from() or Nette\\PhpGenerator\\ClassLike::from() instead.");
+
+Assert::exception(function () {
+    ClassType::fromCode("<?php interface I {}");
+}, Nette\InvalidArgumentException::class, "Provided code cannot be represented with Nette\\PhpGenerator\\ClassType. Call Nette\\PhpGenerator\\InterfaceType::fromCode() or Nette\\PhpGenerator\\ClassLike::fromCode() instead.");
+
+Assert::exception(function () {
+    InterfaceType::fromCode("<?php trait T {}");
+}, Nette\InvalidArgumentException::class, "Provided code cannot be represented with Nette\\PhpGenerator\\InterfaceType. Call Nette\\PhpGenerator\\TraitType::fromCode() or Nette\\PhpGenerator\\ClassLike::fromCode() instead.");

tests/PhpGenerator/ClassType.from.82.phpt

@@ -7,11 +7,12 @@
 declare(strict_types=1);
 
 use Nette\PhpGenerator\ClassType;
+use Nette\PhpGenerator\TraitType;
 
 require __DIR__ . '/../bootstrap.php';
 require __DIR__ . '/fixtures/classes.82.php';
 
 $res[] = ClassType::from(new Abc\Class13);
-$res[] = ClassType::from(Abc\Trait13::class);
+$res[] = TraitType::from(Abc\Trait13::class);
 
 sameFile(__DIR__ . '/expected/ClassType.from.82.expect', implode("\n", $res));

tests/PhpGenerator/ClassType.from.phpt

@@ -7,15 +7,16 @@
 declare(strict_types=1);
 
 use Nette\PhpGenerator\ClassType;
+use Nette\PhpGenerator\InterfaceType;
 use Nette\PhpGenerator\Factory;
 
 require __DIR__ . '/../bootstrap.php';
 require __DIR__ . '/fixtures/classes.php';
 
-$res[] = ClassType::from(Abc\Interface1::class);
-$res[] = ClassType::from(Abc\Interface2::class);
-$res[] = ClassType::from(Abc\Interface3::class);
-$res[] = ClassType::from(Abc\Interface4::class);
+$res[] = InterfaceType::from(Abc\Interface1::class);
+$res[] = InterfaceType::from(Abc\Interface2::class);
+$res[] = InterfaceType::from(Abc\Interface3::class);
+$res[] = InterfaceType::from(Abc\Interface4::class);
 $res[] = ClassType::from(Abc\Class1::class);
 $res[] = ClassType::from(new Abc\Class2);
 $obj = new Abc\Class3;

tests/PhpGenerator/ClassType.from.trait.phpt

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Nette\PhpGenerator\ClassType;
+use Nette\PhpGenerator\ClassLike;
 
 require __DIR__ . '/../bootstrap.php';
 require __DIR__ . '/fixtures/traits.php';
@@ -19,11 +19,11 @@ $classes = [
 	Class5::class,
 ];
 
-$res = array_map(fn($class) => ClassType::from($class), $classes);
+$res = array_map(fn($class) => ClassLike::from($class), $classes);
 
 sameFile(__DIR__ . '/expected/ClassType.from.trait-use.expect', implode("\n", $res));
 
 
-$res = array_map(fn($class) => ClassType::from($class, withBodies: true), $classes);
+$res = array_map(fn($class) => ClassLike::from($class, withBodies: true), $classes);
 
 sameFile(__DIR__ . '/expected/ClassType.from.trait-use.bodies.expect', implode("\n", $res));