API consistency and default get value

Author: Robin de Graaf

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Parable GetSet
 
+## 0.1.1
+
+_Changes_
+- Add `string` type-hinting to `$key` for `get()` and `getAndRemove()`, in line with the rest.
+- Add `$default = null` parameter to `get()`, so that the scenarios of 'not set' and 'set but `null`' can be distinguished between.
+
 ## 0.1.0
 
 _Changes_

README.md

@@ -71,8 +71,8 @@ dot-notation get/set logic.
 
 - `getAll(): array` - returns all values currently stored
 - `getAllAndClear(): array` - returns all values currently stored and then clears them
-- `get(string $key): mixed` - returns value by key or `null` if not found
-- `getAndRemove(string $key): mixed` - returns value by key and then removes it, or `null` if not found
+- `get(string $key, $default = null): mixed` - returns value by key or `null` if not found
+- `getAndRemove(string $key, $default = null): mixed` - returns value by key and then removes it, or `null` if not found
 - `set(string $key, $value): void` - set a value by key
 - `setMany(array $values): void` - set all values passed one-by-one, overwriting pre-existing values
 - `setAll(array $values): void` - set all values, overwriting any pre-existing ones

composer.json

@@ -13,7 +13,8 @@
     }
   ],
   "require": {
-    "php": ">=7.1"
+    "php": ">=7.1",
+    "ext-json": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^7.0"

src/BaseCollection.php

@@ -32,23 +32,23 @@ public function getAllAndClear(): array
         return $data;
     }
 
-    public function get($key)
+    public function get(string $key, $default = null)
     {
         $keys = explode('.', $key);
 
         $resource = $this->getAll();
 
         foreach ($keys as $key) {
             if (!isset($resource[$key])) {
-                return null;
+                return $default;
             }
             $resource = &$resource[$key];
         }
 
         return $resource;
     }
 
-    public function getAndRemove($key)
+    public function getAndRemove(string $key)
     {
         $data = $this->get($key);
         $this->remove($key);
@@ -100,13 +100,6 @@ public function setAll(array $values): void
 
     public function remove(string $key): void
     {
-        if (!$this->has($key)) {
-            throw new Exception(sprintf(
-                "Cannot remove non-existing value by key '%s'",
-                $key
-            ));
-        }
-
         $keys = explode('.', $key);
 
         $data = $this->getAll();
@@ -115,7 +108,10 @@ public function remove(string $key): void
 
         foreach ($keys as $index => $key) {
             if (!isset($resource[$key])) {
-                return;
+                throw new Exception(sprintf(
+                    "Cannot remove non-existing value by key '%s'",
+                    $key
+                ));
             }
             if ($index < (count($keys) - 1)) {
                 $resource = &$resource[$key];
@@ -148,8 +144,14 @@ public function has(string $key): bool
         return true;
     }
 
-    public function count(): int
+    public function count(string $key = null): int
     {
-        return count($this->getAll());
+        if ($key === null) {
+            $data = $this->getAll();
+        } else {
+            $data = $this->get($key, []);
+        }
+
+        return count($data);
     }
 }

tests/GetSetTest.php

@@ -313,11 +313,41 @@ public function testRemoveHierarchalKey()
         self::assertTrue(is_array($this->getSet->get('one')));
     }
 
-    public function testGetNonExistingKeyReturnsNull()
+    public function testCountWithKey()
+    {
+        $this->getSet->set('one.two.three', 'totally');
+        $this->getSet->set('one.two.four', 'also');
+
+        // count only counts the top level, which is 1: ['one']
+        self::assertSame(1, $this->getSet->count());
+        // this level is 1: ['two']
+        self::assertSame(1, $this->getSet->count('one'));
+        // but 'two' contains both 'three' and 'four'
+        self::assertSame(2, $this->getSet->count('one.two'));
+    }
+
+    public function testHas()
+    {
+        $this->getSet->set('one.two.three', 'totally');
+
+        self::assertTrue($this->getSet->has('one'));
+        self::assertTrue($this->getSet->has('one.two'));
+        self::assertTrue($this->getSet->has('one.two.three'));
+
+        self::assertFalse($this->getSet->has('one.two.three.totally'));
+        self::assertFalse($this->getSet->has('random'));
+    }
+
+    public function testGetNonExistingKeyReturnsNullByDefault()
     {
         self::assertNull($this->getSet->get('nope'));
     }
 
+    public function testGetNonExistingKeyReturnsDefaultIfPassed()
+    {
+        self::assertSame('default', $this->getSet->get('nope', 'default'));
+    }
+
     public function testGlobalValuesAreSetGlobally()
     {
         $server = new ServerCollection();