feat: Use PropertyAccess Component syntax for nested variables access

.gitignore

@@ -5,3 +5,4 @@
 /my-app.*
 /var/
 /vendor/
+.idea/

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Add a `yaml_dump()` function to dump any PHP value to a YAML string
 * Add a `yaml_parse()` function to parse a YAML string to a PHP value
 * Remove the default timeout of 60 seconds from the Context
+* Add possibility to use [Property Access Component](https://symfony.com/doc/current/components/property_access.html) syntax for getting variable from context.
 
 ## 0.13.1 (2024-02-27)
 

composer.json

@@ -43,6 +43,7 @@
         "symfony/http-client": "^6.4.3",
         "symfony/monolog-bridge": "^6.4.3",
         "symfony/process": "^6.4.3",
+        "symfony/property-access": "^6.4",
         "symfony/string": "^6.4.3",
         "symfony/translation-contracts": "^3.4.1",
         "symfony/var-dumper": "^6.4.3",

doc/getting-started/context.md

@@ -53,13 +53,15 @@ function foo(): void
 {
     $foobar = variable('foobar', 'default value');
 
-    // Same as:
     $context = context();
-    try {
-        $foobar = $context['foobar'];
-    } catch (\OutOfBoundsException) {
-        $foobar = 'default value;
-    }
+    // Same as:
+    $foobar = $context['foobar'] ?? 'default value';
+
+    // Getting nested values
+    $foobar = variable('[foo][bar][baz]', 'default value');
+
+    // Same as:
+    $foobar = $context['foo']['bar']['baz'] ?? 'default value';
 }
 ```
 

examples/context.php

@@ -21,6 +21,9 @@ function defaultContext(): Context
         'name' => 'my_default',
         'production' => false,
         'foo' => 'bar',
+        'nested' => [
+            'key' => 'nested_value',
+        ],
     ]);
 }
 
@@ -83,6 +86,7 @@ function contextInfo(): void
     echo 'Production? ' . (variable('production', false) ? 'yes' : 'no') . "\n";
     echo "verbosity: {$context->verbosityLevel->value}\n";
     echo 'context: ' . variable('foo', 'N/A') . "\n";
+    echo 'nested key: ' . variable('[nested][key]', 'N/A') . "\n";
 }
 
 /**

src/ContextRegistry.php

@@ -2,6 +2,8 @@
 
 namespace Castor;
 
+use Symfony\Component\PropertyAccess\PropertyAccess;
+
 /** @internal */
 class ContextRegistry
 {
@@ -113,11 +115,11 @@ public function getVariable(string $key, mixed $default = null): mixed
     {
         $context = $this->getCurrentContext();
 
-        if (!isset($context[$key])) {
-            return $default;
+        if (str_starts_with($key, '[')) {
+            return PropertyAccess::createPropertyAccessor()->getValue($context, $key) ?? $default;
         }
 
-        return $context[$key];
+        return $context[$key] ?? $default;
     }
 
     /**

tests/Examples/Generated/ContextContextDynamicTest.php.output.txt

@@ -2,3 +2,4 @@ context name: dynamic
 Production? no
 verbosity: 1
 context: baz
+nested key: N/A

tests/Examples/Generated/ContextContextMyDefaultTest.php.output.txt

@@ -2,3 +2,4 @@ context name: my_default
 Production? no
 verbosity: 2
 context: bar
+nested key: nested_value

tests/Examples/Generated/ContextContextPathTest.php.output.txt

@@ -2,3 +2,4 @@ context name: path
 Production? yes
 verbosity: 1
 context: bar
+nested key: N/A

tests/Examples/Generated/ContextContextProductionTest.php.output.txt

@@ -2,3 +2,4 @@ context name: production
 Production? yes
 verbosity: 1
 context: bar
+nested key: nested_value

tests/Examples/Generated/ContextContextRunTest.php.output.txt

@@ -2,3 +2,4 @@ context name: run
 Production? no
 verbosity: 1
 context: no defined
+nested key: N/A

tests/Examples/Generated/ContextContextTest.php.output.txt

@@ -2,3 +2,4 @@ context name: my_default
 Production? no
 verbosity: 1
 context: bar
+nested key: nested_value

tests/Examples/Generated/ContextContextWithTest.php.output.txt

@@ -2,4 +2,5 @@ context name: dynamic
 Production? no
 verbosity: -1
 context: bar
-bar
+nested key: N/A
+bar