Merge pull request #25 from assemblie/refactor-format-error-handling

Json format: refactor error handling + add JSON_UNESCAPED_UNICODE

Author: timothymarois

README.md

@@ -45,7 +45,8 @@ $database = new \Filebase\Database([
 ]);
 
 // in this example, you would search an exact user name
-// It would technically be stored as user_name.json in the directories
+// it would technically be stored as user_name.json in the directories
+// if user_name.json doesn't exists get will return new empty Document
 $item = $database->get('kingslayer');
 
 // display property values

src/Database.php

@@ -1,11 +1,10 @@
 <?php  namespace Filebase;
 
 use Exception;
-use Filebase\Config;
-use Filebase\Cache;
-use Filebase\Filesystem;
-use Filebase\Document;
-use Filebase\Backup;
+use Filebase\Format\EncodingException;
+use Filebase\Filesystem\SavingException;
+use Filebase\Filesystem\ReadingException;
+use Filebase\Filesystem\FilesystemException;
 
 class Database
 {
@@ -31,9 +30,12 @@ class Database
 
 
     /**
-    * __construct
-    *
-    */
+     * Database constructor.
+     *
+     * @param array $config
+     *
+     * @throws FilesystemException
+     */
     public function __construct(array $config = [])
     {
         $this->config = new Config($config);
@@ -46,12 +48,12 @@ public function __construct(array $config = [])
         {
             if (!@mkdir($this->config->dir, 0777, true))
             {
-                throw new Exception(sprintf('`%s` doesn\'t exist and can\'t be created.', $this->config->dir));
+                throw new FilesystemException(sprintf('`%s` doesn\'t exist and can\'t be created.', $this->config->dir));
             }
         }
         else if (!is_writable($this->config->dir))
         {
-            throw new Exception(sprintf('`%s` is not writable.', $this->config->dir));
+            throw new FilesystemException(sprintf('`%s` is not writable.', $this->config->dir));
         }
     }
 
@@ -235,18 +237,16 @@ public function count()
 
 
     /**
-    * save
-    *
-    * @param $document \Filebase\Document object
-    * @param mixed $data should be an array, new data to replace all existing data within
-    *
-    * @return (bool) true or false if file was saved
-    */
+     * @param Document $document
+     * @param string $wdata
+     * @return bool|Document
+     * @throws SavingException
+     */
     public function save(Document $document, $wdata = '')
     {
         if ($this->config->read_only === true)
         {
-            throw new Exception("This database is set to be read-only. No modifications can be made.");
+            throw new SavingException("This database is set to be read-only. No modifications can be made.");
         }
 
         $format         = $this->config->format;
@@ -270,7 +270,12 @@ public function save(Document $document, $wdata = '')
 
         $document->setUpdatedAt(time());
 
-        $data = $format::encode( $document->saveAs(), $this->config->pretty );
+        try {
+            $data = $format::encode( $document->saveAs(), $this->config->pretty );
+        } catch (EncodingException $e) {
+            // TODO: add logging
+            throw new SavingException("Can not encode document.", 0, $e);
+        }
 
         if (Filesystem::write($file_location, $data))
         {
@@ -302,17 +307,30 @@ public function query()
     //--------------------------------------------------------------------
 
 
-
     /**
-    * read
-    *
-    * @param string $name
-    * @return decoded file data
-    */
+     * Read and return Document from filesystem by name.
+     * If doesn't exists return new empty Document.
+     *
+     * @param $name
+     *
+     * @throws Exception|ReadingException
+     * @return array|null
+     */
     protected function read($name)
     {
         $format = $this->config->format;
-        return $format::decode( Filesystem::read( $this->config->dir.'/'.Filesystem::validateName($name, $this->config->safe_filename).'.'.$format::getFileExtension() ) );
+
+        $file = Filesystem::read(
+            $this->config->dir . '/'
+            . Filesystem::validateName($name, $this->config->safe_filename) 
+            . '.' . $format::getFileExtension()
+        );
+
+        if ($file !== false) {
+            return $format::decode($file);
+        }
+
+        return null;
     }
 
 

src/Filesystem/FilesystemException.php

@@ -0,0 +1,6 @@
+<?php namespace Filebase\Filesystem;
+
+class FilesystemException extends \Exception
+{
+
+}

src/Filesystem/ReadingException.php

@@ -0,0 +1,6 @@
+<?php namespace Filebase\Filesystem;
+
+class ReadingException extends FilesystemException
+{
+
+}

src/Filesystem/SavingException.php

@@ -0,0 +1,6 @@
+<?php namespace Filebase\Filesystem;
+
+class SavingException extends FilesystemException
+{
+
+}

src/Format/DecodingException.php

@@ -0,0 +1,6 @@
+<?php namespace Filebase\Format;
+
+class DecodingException extends FormatException
+{
+
+}

src/Format/EncodingException.php

@@ -0,0 +1,6 @@
+<?php namespace Filebase\Format;
+
+class EncodingException extends FormatException
+{
+
+}

src/Format/FormatException.php

@@ -0,0 +1,18 @@
+<?php namespace Filebase\Format;
+
+class FormatException extends \Exception
+{
+    private $inputData;
+
+    public function __construct($message, $code = 0, \Exception $previous = null, $inputData = null)
+    {
+        parent::__construct($message, $code, $previous);
+        $this->inputData = $inputData;
+    }
+
+    public function getInputData()
+    {
+        return $this->inputData;
+    }
+}
+

src/Format/Json.php

@@ -3,11 +3,9 @@
 
 class Json implements FormatInterface
 {
-
     /**
-    * getFileExtension
-    *
-    */
+     * @return string
+     */
     public static function getFileExtension()
     {
         return 'json';
@@ -18,28 +16,54 @@ public static function getFileExtension()
 
 
     /**
-    * encode
-    *
-    */
+     * @param array $data
+     * @param bool $pretty
+     * @return string
+     * @throws FormatException
+     */
     public static function encode($data = [], $pretty = true)
     {
-        $p = 1;
-        if ($pretty==true) $p = JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES;
-
-        return json_encode($data, $p);
+        $options = 0;
+        if ($pretty == true) {
+            $options = JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE;
+        }
+
+        $encoded = json_encode($data, $options);
+        if ($encoded === false) {
+            throw new EncodingException(
+                "json_encode: '" . json_last_error_msg() . "'",
+                0,
+                null,
+                $data
+            );
+        }
+
+        return $encoded;
     }
 
 
     //--------------------------------------------------------------------
 
 
     /**
-    * decode
-    *
-    */
+     * @param $data
+     * @return mixed
+     * @throws FormatException
+     */
     public static function decode($data)
     {
-        return json_decode($data, 1);
+        $decoded = json_decode($data, true);
+
+        if ($data !== false && $decoded === null) {
+            throw new DecodingException(
+                "json_decode: '" . json_last_error_msg() . "'",
+                0,
+                null,
+                $data
+            );
+        }
+
+        return $decoded;
     }
 
 

tests/DatabaseTest.php

@@ -1,6 +1,8 @@
 <?php  namespace Filebase;
 
 
+use Filebase\Filesystem\SavingException;
+
 class badformat {
 
 }
@@ -241,4 +243,19 @@ public function testDatabaseFindAllDataOnly()
         $db->flush(true);
     }
 
+    public function testDatabaseSavingNotEncodableDocument()
+    {
+        $this->expectException(SavingException::class);
+
+        $db = new \Filebase\Database([
+            'dir' => __DIR__.'/databases'
+        ]);
+
+        $doc = $db->get("testDatabaseSavingNotEncodableDocument");
+
+        // insert invalid utf-8 characters
+        $doc->testProp = "\xB1\x31";
+
+        $doc->save();
+    }
 }