Fine-tuning of default values for getBoolean()

Author: roberto-butti

README.md

@@ -292,6 +292,22 @@ $data1->getInt("0.author.idx"); // Returns null because the field doesn't exists
 $data1->getInt("0.author.idx", 44); // Returns 44 because the field doesn't exists, and you set a default, in this case 44
 ```
 
+### The `getBoolean()` method
+
+The `getBoolean()` method retrieves the value of a specified field as a boolean from a data block. If the field does not exist or is null, it returns a default value, which can be customized (null by default).
+Parameters:
+
+- `$path` (string): The path to the field (e.g., "0.author.id").
+- `$default` (null|bool): (Optional) The default value to return if the field doesn't exist. Defaults to null.
+- `$charNestedKey` (string): the character separator for nested field names.  The default is ".".
+
+Example usage:
+```php
+$data1->getBoolean("0.author.site_admin"); // Returns the field value as an boolean, for example true
+$data1->getBoolean("0.author.site_admin_notexists"); // Returns null because the field doesn't exists
+$data1->getBoolean("0.author.site_admin_notexists", true); // Returns true because the field doesn't exists, and you set a default, in this case true
+```
+
 
 ### The `getBlock()` method
 If you need to manage a complex array (nested array) or an array obtained from a complex JSON structure, you can access a portion of the array and obtain the `Block` object via the `getBlock()` method.

src/Traits/FormattableBlock.php

@@ -70,19 +70,4 @@ public function getFormattedByte(
         return number_format($bytes / $terabyte, $precision) . ' TB';
     }
 
-
-
-    /**
-     * Return a forced boolean value from the get() method
-     * @param mixed $key the filed key , can be nested for example "commits.0.editable"
-     * @param bool|null $defaultValue the default value returned if no value is found
-     * @param non-empty-string $charNestedKey for nested field the . character is the default
-     */
-    public function getBoolean(
-        mixed $key,
-        ?bool $defaultValue = null,
-        string $charNestedKey = ".",
-    ): bool {
-        return (bool) $this->get($key, $defaultValue, $charNestedKey);
-    }
 }

src/Traits/TypeableBlock.php

@@ -36,4 +36,24 @@ public function getInt(int|string $key, ?int $defaultValue = null, string $charN
 
         return $defaultValue;
     }
+
+    /**
+     * Return a forced boolean value from the get() method
+     * @param int|string $key the filed key , can be nested for example "commits.0.editable"
+     * @param bool|null $defaultValue the default value returned if no value is found
+     * @param non-empty-string $charNestedKey for nested field the . character is the default
+     */
+    public function getBoolean(
+        int|string $key,
+        ?bool $defaultValue = null,
+        string $charNestedKey = ".",
+    ): ?bool {
+        $returnValue = $this->get($key, $defaultValue, $charNestedKey);
+
+        if (is_scalar($returnValue)) {
+            return boolval($returnValue);
+        }
+
+        return $defaultValue;
+    }
 }

tests/Unit/Traits/FormattableBlokTest.php

@@ -57,22 +57,3 @@ function (): void {
         expect($data1->getFormattedByte("assets.1.total_bytes", 0))->toBe("2 GB");
     },
 );
-
-test(
-    'Force field to boolean',
-    function (): void {
-        $data1 = Block::fromJsonFile(__DIR__ . "/../../data/commits-json/commits-10-p1.json");
-        $data2 = Block::fromJsonFile(__DIR__ . "/../../data/commits-json/commits-10-p2.json");
-        $data3 = Block::fromJsonFile(__DIR__ . "/../../data/commits-json/commits-10-p3.json");
-        $data1->append($data2)->append($data3);
-        expect($data1)->toHaveCount(30);
-        expect($data2)->toHaveCount(10);
-        expect($data1->getBoolean("0.author.site_admin"))->toBeBool();
-        expect($data1->getBoolean("0.author.notexist"))->toBeBool();
-        expect($data1->getBoolean("0.author.notexist"))->toBeBool()->toEqual(false);
-        expect($data1->getBoolean("0.author.notexist", "true"))->toEqual(true);
-        expect($data1->getBoolean("0.author.site_admin"))->toBeBool()->toEqual(false);
-        expect($data1->getBoolean("0.author.site_admin", true))->toBeBool()->toEqual(false);
-        expect($data1->getBoolean("0.commit.comment_countnotexists", true))->toBeBool()->toEqual(true);
-    },
-);

tests/Unit/Traits/TypeableBlockTest.php

@@ -34,3 +34,23 @@ function (): void {
 
     },
 );
+
+test(
+    'Testing getBoolean()',
+    function (): void {
+        $data1 = Block::fromJsonFile(__DIR__ . "/../../data/commits-json/commits-10-p1.json");
+        $data2 = Block::fromJsonFile(__DIR__ . "/../../data/commits-json/commits-10-p2.json");
+        $data3 = Block::fromJsonFile(__DIR__ . "/../../data/commits-json/commits-10-p3.json");
+        $data1->append($data2)->append($data3);
+        expect($data1)->toHaveCount(30);
+        expect($data2)->toHaveCount(10);
+        expect($data1->getBoolean("0.author.site_admin"))->toBeBool();
+        expect($data1->getBoolean("0.author.notexist"))->toBeNull();
+        expect($data1->getBoolean("0.author.notexist"))->toBeNull();
+        expect($data1->getBoolean("0.author.notexist", true))->toBeBool()->toEqual(true);
+        expect($data1->getBoolean("0.author.notexist", false))->toBeBool()->toEqual(false);
+        expect($data1->getBoolean("0.author.site_admin"))->toBeBool()->toEqual(false);
+        expect($data1->getBoolean("0.author.site_admin", true))->toBeBool()->toEqual(false);
+        expect($data1->getBoolean("0.commit.comment_countnotexists", true))->toBeBool()->toEqual(true);
+    },
+);