From 42279b7bb973c20f30f71c21a20cff53cfdc2889 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= <jerome@tamarelle.net>
Date: Thu, 7 Mar 2024 23:12:41 +0100
Subject: [PATCH] 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
---
 src/PhpGenerator/ClassLike.php               | 22 +++++++++++----
 tests/PhpGenerator/ClassLike.typecheck.phpt  | 28 ++++++++++++++++++++
 tests/PhpGenerator/ClassType.from.82.phpt    |  3 ++-
 tests/PhpGenerator/ClassType.from.phpt       |  9 ++++---
 tests/PhpGenerator/ClassType.from.trait.phpt |  6 ++---
 5 files changed, 55 insertions(+), 13 deletions(-)
 create mode 100644 tests/PhpGenerator/ClassLike.typecheck.phpt

diff --git a/src/PhpGenerator/ClassLike.php b/src/PhpGenerator/ClassLike.php
index ce49782d..a459d05f 100644
--- a/src/PhpGenerator/ClassLike.php
+++ b/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;
 	}
 
 
diff --git a/tests/PhpGenerator/ClassLike.typecheck.phpt b/tests/PhpGenerator/ClassLike.typecheck.phpt
new file mode 100644
index 00000000..7085540c
--- /dev/null
+++ b/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.");
diff --git a/tests/PhpGenerator/ClassType.from.82.phpt b/tests/PhpGenerator/ClassType.from.82.phpt
index eb171d5d..cdb1f850 100644
--- a/tests/PhpGenerator/ClassType.from.82.phpt
+++ b/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));
diff --git a/tests/PhpGenerator/ClassType.from.phpt b/tests/PhpGenerator/ClassType.from.phpt
index 43734a5e..583faf19 100644
--- a/tests/PhpGenerator/ClassType.from.phpt
+++ b/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;
diff --git a/tests/PhpGenerator/ClassType.from.trait.phpt b/tests/PhpGenerator/ClassType.from.trait.phpt
index 3fdf8b24..1f62a4b0 100644
--- a/tests/PhpGenerator/ClassType.from.trait.phpt
+++ b/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));