From f4e27d5cdc73799ebb434a04bf11eefbb274804f Mon Sep 17 00:00:00 2001
From: Greg Bowler <greg.bowler@g105b.com>
Date: Wed, 14 Sep 2022 16:34:54 +0100
Subject: [PATCH] feature: throw correct exceptions closes #5

---
 src/JsonDecodeException.php            | 10 ++++++++++
 src/JsonException.php                  |  6 ++++++
 src/JsonObjectBuilder.php              | 10 +++++++++-
 test/phpunit/JsonObjectBuilderTest.php | 19 ++++++++++++++++++-
 4 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 src/JsonDecodeException.php
 create mode 100644 src/JsonException.php

diff --git a/src/JsonDecodeException.php b/src/JsonDecodeException.php
new file mode 100644
index 0000000..52cd868
--- /dev/null
+++ b/src/JsonDecodeException.php
@@ -0,0 +1,10 @@
+<?php
+namespace Gt\Json;
+
+use Throwable;
+
+class JsonDecodeException extends JsonException {
+	public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null) {
+		parent::__construct("Error decoding JSON: $message", $code, $previous);
+	}
+}
diff --git a/src/JsonException.php b/src/JsonException.php
new file mode 100644
index 0000000..8ecf56a
--- /dev/null
+++ b/src/JsonException.php
@@ -0,0 +1,6 @@
+<?php
+namespace Gt\Json;
+
+use RuntimeException;
+
+class JsonException extends RuntimeException {}
diff --git a/src/JsonObjectBuilder.php b/src/JsonObjectBuilder.php
index ff07cfd..90a2b96 100644
--- a/src/JsonObjectBuilder.php
+++ b/src/JsonObjectBuilder.php
@@ -14,11 +14,19 @@
 class JsonObjectBuilder extends DataObjectBuilder {
 	public function fromJsonString(string $jsonString):JsonObject {
 		$json = json_decode($jsonString);
+		if(is_null($json)) {
+// It's completely reasonable to have a null value here, so we need to check the
+// error code before throwing an exception.
+			if(json_last_error() !== JSON_ERROR_NONE) {
+				throw new JsonDecodeException(json_last_error_msg());
+			}
+		}
+
 		return $this->fromJsonDecoded($json);
 	}
 
 	/**
-	 * @param object|array<mixed>|string|int|float|bool|null $jsonDecoded
+	 * @param object|array|string|int|float|bool|null $jsonDecoded
 	 */
 	public function fromJsonDecoded(
 		object|array|string|int|float|bool|null $jsonDecoded
diff --git a/test/phpunit/JsonObjectBuilderTest.php b/test/phpunit/JsonObjectBuilderTest.php
index fa22a47..41027a8 100644
--- a/test/phpunit/JsonObjectBuilderTest.php
+++ b/test/phpunit/JsonObjectBuilderTest.php
@@ -1,6 +1,7 @@
 <?php
 namespace Gt\Json\Test;
 
+use Gt\Json\JsonDecodeException;
 use Gt\Json\JsonKvpObject;
 use Gt\Json\JsonObjectBuilder;
 use Gt\Json\JsonPrimitive\JsonArrayPrimitive;
@@ -177,4 +178,20 @@ public function testFromJsonStringArrayContainingSimpleKVP() {
 		self::assertEquals(123, $object->getInt("id"));
 		self::assertEquals("Example", $object->getString("name"));
 	}
-}
\ No newline at end of file
+
+	public function testFromJson_syntaxError() {
+		$jsonString = '{ "name": "Greg", "title: "Clumsy programmer!" }';
+		$sut = new JsonObjectBuilder();
+		self::expectException(JsonDecodeException::class);
+		self::expectExceptionMessage("Error decoding JSON: Syntax error");
+		$sut->fromJsonString($jsonString);
+	}
+
+	public function testFromJson_illegalCharacters() {
+		$jsonString = "{ \"name\": \"Greg\", \"favourite_characters\": \"\xB1\x31\" }";
+		$sut = new JsonObjectBuilder();
+		self::expectException(JsonDecodeException::class);
+		self::expectExceptionMessage("Error decoding JSON: Malformed UTF-8 characters, possibly incorrectly encoded");
+		$sut->fromJsonString($jsonString);
+	}
+}