[#10] Added Message::jsonSerialize() and updated tests to reflect enc…

…oding (#11)
zibings · Apr 25, 2020 · ab98435 · ab98435
1 parent 7c17fb8
commit ab98435
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 14 deletions.
diff --git a/Log/Message.php b/Log/Message.php
@@ -11,7 +11,7 @@
 	 * @package Stoic\Log
 	 * @version 1.0.0
 	 */
-	class Message {
+	class Message implements \JsonSerializable {
 		/**
 		 * String value of message level.
 		 * 
@@ -102,11 +102,21 @@ public function __toArray() {
 		 * @return string
 		 */
 		public function __toJson() {
-			return sprintf("{ \"level\": \"%s\", \"message\": \"%s\", \"timestamp\": \"%s\" }",
-				strtoupper($this->level),
-				$this->message,
-				$this->timestamp->format('Y-m-d G:i:s.u')
-			);
+			return json_encode($this);
+		}
+
+		/**
+		 * Returns an array of the message data ready to run through
+		 * json_encode().
+		 *
+		 * @return string[]
+		 */
+		public function jsonSerialize() {
+			return [
+				'level' => strtoupper($this->level),
+				'message' => $this->message,
+				'timestamp' => $this->timestamp->format('Y-m-d G:i:s.u')
+			];
 		}
 
 		/**

diff --git a/Tests/Log/LoggerTest.php b/Tests/Log/LoggerTest.php
@@ -59,7 +59,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"ALERT\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"ALERT\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'ALERT', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -73,7 +73,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"CRITICAL\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"CRITICAL\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'CRITICAL', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -87,7 +87,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"DEBUG\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"DEBUG\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'DEBUG', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -102,7 +102,7 @@ public function test_LogLevels() {
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
 			self::assertEquals(3, count($app->messages[0]->__toArray()));
-			self::assertEquals("{ \"level\": \"EMERGENCY\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"EMERGENCY\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'EMERGENCY', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -116,7 +116,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"ERROR\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"ERROR\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'ERROR', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -130,7 +130,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"INFO\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"INFO\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'INFO', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -144,7 +144,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"NOTICE\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"NOTICE\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'NOTICE', 'Testing'), $app->messages[0]->__toString());
 
 			$app = new MemoryAppender();
@@ -158,7 +158,7 @@ public function test_LogLevels() {
 			self::assertEquals('Testing', $app->messages[0]->message);
 
 			$ts = $app->messages[0]->getTimestamp()->format('Y-m-d G:i:s.u');
-			self::assertEquals("{ \"level\": \"WARNING\", \"message\": \"Testing\", \"timestamp\": \"{$ts}\" }", $app->messages[0]->__toJson());
+			self::assertEquals("{\"level\":\"WARNING\",\"message\":\"Testing\",\"timestamp\":\"{$ts}\"}", $app->messages[0]->__toJson());
 			self::assertEquals(sprintf("%s %' -9s %s", $ts, 'WARNING', 'Testing'), $app->messages[0]->__toString());
 
 			return;