Merge pull request #20 from colinodell/better-exceptions

Implement more-specific exceptions

Author: simensen

src/Data.php

@@ -11,8 +11,9 @@
 
 namespace Dflydev\DotAccessData;
 
-use RuntimeException;
 use ArrayAccess;
+use Dflydev\DotAccessData\Exception\DataException;
+use Dflydev\DotAccessData\Exception\InvalidPathException;
 
 /**
  * @implements ArrayAccess<string, mixed>
@@ -42,7 +43,7 @@ public function __construct(array $data = [])
     public function append(string $key, $value = null): void
     {
         if (0 == strlen($key)) {
-            throw new RuntimeException("Key cannot be an empty string");
+            throw new InvalidPathException("Key cannot be an empty string");
         }
 
         $currentValue =& $this->data;
@@ -88,7 +89,7 @@ public function append(string $key, $value = null): void
     public function set(string $key, $value = null): void
     {
         if (0 == strlen($key)) {
-            throw new RuntimeException("Key cannot be an empty string");
+            throw new InvalidPathException("Key cannot be an empty string");
         }
 
         $currentValue =& $this->data;
@@ -107,7 +108,7 @@ public function set(string $key, $value = null): void
                 $currentValue[$currentKey] = [];
             }
             if (!is_array($currentValue[$currentKey])) {
-                throw new RuntimeException("Key path at $currentKey of $key cannot be indexed into (is not an array)");
+                throw new DataException("Key path at $currentKey of $key cannot be indexed into (is not an array)");
             }
             $currentValue =& $currentValue[$currentKey];
         }
@@ -120,7 +121,7 @@ public function set(string $key, $value = null): void
     public function remove(string $key): void
     {
         if (0 == strlen($key)) {
-            throw new RuntimeException("Key cannot be an empty string");
+            throw new InvalidPathException("Key cannot be an empty string");
         }
 
         $currentValue =& $this->data;
@@ -203,7 +204,7 @@ public function getData(string $key): DataInterface
             return new Data($value);
         }
 
-        throw new RuntimeException("Value at '$key' could not be represented as a DataInterface");
+        throw new DataException("Value at '$key' could not be represented as a DataInterface");
     }
 
     /**

src/DataInterface.php

@@ -11,13 +11,18 @@
 
 namespace Dflydev\DotAccessData;
 
+use Dflydev\DotAccessData\Exception\DataException;
+use Dflydev\DotAccessData\Exception\InvalidPathException;
+
 interface DataInterface
 {
     /**
      * Append a value to a key (assumes key refers to an array value)
      *
      * @param string $key
      * @param mixed  $value
+     *
+     * @throws InvalidPathException if the given path is empty
      */
     public function append(string $key, $value = null): void;
 
@@ -26,13 +31,18 @@ public function append(string $key, $value = null): void;
      *
      * @param string $key
      * @param mixed  $value
+     *
+     * @throws InvalidPathException if the given path is empty
+     * @throws DataException if the given path does not target an array
      */
     public function set(string $key, $value = null): void;
 
     /**
      * Remove a key
      *
      * @param string $key
+     *
+     * @throws InvalidPathException if the given path is empty
      */
     public function remove(string $key): void;
 
@@ -66,6 +76,8 @@ public function has(string $key): bool;
      *
      * @return DataInterface
      *
+     * @throws DataException if the given path does not reference an array
+     *
      * @psalm-mutation-free
      */
     public function getData(string $key): DataInterface;

src/Exception/DataException.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is a part of dflydev/dot-access-data.
+ *
+ * (c) Dragonfly Development Inc.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dflydev\DotAccessData\Exception;
+
+/**
+ * Base runtime exception type thrown by this library
+ */
+class DataException extends \RuntimeException
+{
+}

src/Exception/InvalidPathException.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is a part of dflydev/dot-access-data.
+ *
+ * (c) Dragonfly Development Inc.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dflydev\DotAccessData\Exception;
+
+/**
+ * Thrown when trying to access an invalid path in the data array
+ */
+class InvalidPathException extends DataException
+{
+}

tests/DataTest.php

@@ -11,7 +11,8 @@
 
 namespace Dflydev\DotAccessData;
 
-use RuntimeException;
+use Dflydev\DotAccessData\Exception\DataException;
+use Dflydev\DotAccessData\Exception\InvalidPathException;
 use PHPUnit\Framework\TestCase;
 
 class DataTest extends TestCase
@@ -81,7 +82,7 @@ public function testAppend()
         $this->assertEquals(['I', 'I2'], $data->get('h.i'));
         $this->assertEquals(['L'], $data->get('i.k.l'));
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(InvalidPathException::class);
 
         $data->append('', 'broken');
     }
@@ -104,7 +105,7 @@ public function testSet()
         $this->assertEquals('F', $data->get('d.e.f'));
         $this->assertEquals(['e' => ['f' => 'F', 'g' => 'G']], $data->get('d'));
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(InvalidPathException::class);
 
         $data->set('', 'broken');
     }
@@ -115,7 +116,7 @@ public function testSetClobberStringInPath()
 
         $data->set('a.b.c', 'Should not be able to write to a.b.c.d.e');
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(DataException::class);
 
         $data->set('a.b.c.d.e', 'broken');
     }
@@ -137,7 +138,7 @@ public function testRemove()
         $this->assertNull(null);
         $this->assertEquals('D2', $data->get('b.d.d2'));
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(InvalidPathException::class);
 
         $data->remove('', 'broken');
     }
@@ -178,7 +179,7 @@ public function testGetData()
 
         $this->runSampleDataTests($data);
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(DataException::class);
 
         $data = $wrappedData->getData('wrapped.sampleData.a');
     }
@@ -260,7 +261,7 @@ public function testOffsetSet()
         $this->assertEquals('F', $data['d.e.f']);
         $this->assertEquals(['e' => ['f' => 'F', 'g' => 'G']], $data['d']);
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(InvalidPathException::class);
 
         $data->set('', 'broken');
     }
@@ -282,7 +283,7 @@ public function testOffsetUnset()
         $this->assertNull(null);
         $this->assertEquals('D2', $data['b.d.d2']);
 
-        $this->expectException(RuntimeException::class);
+        $this->expectException(InvalidPathException::class);
 
         unset($data['']);
     }