Add runtime exceptions for invalid data.

Author: johnbillion

src/Doc.php

@@ -55,6 +55,19 @@ public function getParams(): array {
 	 * @phpstan-param DocArray $data
 	 */
 	private function setData( array $data ): self {
+		$required = [ 'description', 'long_description', 'long_description_html', 'tags' ];
+
+		foreach ( $required as $key ) {
+			if ( ! array_key_exists( $key, $data ) ) {
+				throw new \InvalidArgumentException(
+					sprintf(
+						'Missing required key "%s" in data array',
+						$key,
+					)
+				);
+			}
+		}
+
 		$this->description = $data['description'];
 		$this->long_description = $data['long_description'];
 		$this->long_description_html = $data['long_description_html'];

src/Hook.php

@@ -83,6 +83,19 @@ public function getParams(): array {
 	 * @phpstan-param HookArray $data
 	 */
 	private function setData( array $data ): self {
+		$required = [ 'name', 'file', 'type', 'doc', 'args' ];
+
+		foreach ( $required as $key ) {
+			if ( ! array_key_exists( $key, $data ) ) {
+				throw new \InvalidArgumentException(
+					sprintf(
+						'Missing required key "%s" in data array',
+						$key,
+					)
+				);
+			}
+		}
+
 		$this->name = $data['name'];
 		$this->aliases = $data['aliases'] ?? null;
 		$this->file = $data['file'];

src/Hooks.php

@@ -19,11 +19,11 @@ public static function fromVendor( string $directory, string $file ): self {
 	}
 
 	/**
-	 * @throws \Exception
+	 * @throws \InvalidArgumentException
 	 */
 	public static function fromFile( string $file ): self {
 		if ( ! file_exists( $file ) ) {
-			throw new \Exception( sprintf(
+			throw new \InvalidArgumentException( sprintf(
 				'File does not exist: %s',
 				$file
 			) );
@@ -99,13 +99,13 @@ public function includes( string $name ): bool {
 	}
 
 	/**
-	 * @throws \Exception
+	 * @throws \ErrorException
 	 */
 	private static function fromKnownFile( string $file ): self {
 		$contents = file_get_contents( $file );
 
 		if ( $contents === false ) {
-			throw new \Exception( sprintf(
+			throw new \ErrorException( sprintf(
 				'Could not open hook file: %s',
 				$file
 			) );
@@ -114,7 +114,7 @@ private static function fromKnownFile( string $file ): self {
 		$decoded = json_decode( $contents, true );
 
 		if ( ! is_array( $decoded ) || ! isset( $decoded['hooks'] ) || ! is_array( $decoded['hooks'] ) ) {
-			throw new \Exception( sprintf(
+			throw new \ErrorException( sprintf(
 				'Unexpected data format in file: %s',
 				$file
 			) );
@@ -126,7 +126,7 @@ private static function fromKnownFile( string $file ): self {
 	}
 
 	/**
-	 * @throws \Exception
+	 * @throws \InvalidArgumentException
 	 */
 	private static function findFileFromVendor( string $directory, string $path ): string {
 		$library_dependency = $directory . '/vendor/' . $path;
@@ -141,7 +141,7 @@ private static function findFileFromVendor( string $directory, string $path ): s
 			return $project_dependency;
 		}
 
-		throw new \Exception( sprintf(
+		throw new \InvalidArgumentException( sprintf(
 			'Vendor directory not found for file: %s',
 			$path
 		) );

src/Tag.php

@@ -74,6 +74,18 @@ public function getDescription(): ?string {
 	 * @phpstan-param TagArray $data
 	 */
 	private function setData( array $data ): self {
+		$required = [ 'name', 'content' ];
+		foreach ( $required as $key ) {
+			if ( ! array_key_exists( $key, $data ) ) {
+				throw new \InvalidArgumentException(
+					sprintf(
+						'Missing required key "%s" in data array',
+						$key,
+					)
+				);
+			}
+		}
+
 		$this->name = $data['name'];
 		$this->content = $data['content'];
 		$this->types = $data['types'] ?? null;

tests/phpunit/HooksTest.php

@@ -25,7 +25,7 @@ public function testCanBeCreatedFromFile( string $file ): void {
 	}
 
 	public function testErrorThrownWhenFileDoesNotExist(): void {
-		self::expectException( \Exception::class );
+		self::expectException( \InvalidArgumentException::class );
 		Hooks::fromFile( __DIR__ . '/missing.json' );
 	}