Add config quote filter

Author: antonmedv

.github/warp-logo@2x.png

@@ -115,8 +115,15 @@ public function parse(mixed $value): mixed
     {
         if (is_string($value)) {
             $normalizedValue = normalize_line_endings($value);
-            return preg_replace_callback('/\{\{\s*([\w\.\/-]+)\s*\}\}/', function (array $matches) {
-                return $this->get($matches[1]);
+            return preg_replace_callback('/\{\{\s*([\w\.\/-]+)\s*(?:\|\s*(\w+)\s*)?\}\}/', function (array $matches) {
+                $value = $this->get($matches[1]);
+                if (isset($matches[2])) {
+                    $value = match ($matches[2]) {
+                        'quote' => quote((string) $value),
+                        default => throw new \InvalidArgumentException("Unknown filter: {$matches[2]}"),
+                    };
+                }
+                return $value;
             }, $normalizedValue);
         }
 

src/Configuration.php

@@ -376,6 +376,12 @@ function within(string $path, callable $callback): mixed
  * run("echo $path");
  * ```
  *
+ * Use `| quote` filter to safely quote config values as shell arguments:
+ * ```php
+ * run('echo {{ message | quote }}');
+ * run('grep -r {{ pattern | quote }} {{release_path}}');
+ * ```
+ *
  * @param string $command Command to run on remote host.
  * @param string|null $cwd Sets the process working directory. If not set {{working_path}} will be used.
  * @param int|null $timeout Sets the process timeout (max. runtime). The timeout in seconds (default: 300 sec; see {{default_timeout}}, `null` to disable).

src/functions.php

@@ -159,6 +159,32 @@ public function testAddToParentCallback()
         self::assertEquals(['a', 'b', 'c'], $alpha->get('files'));
     }
 
+    public function testParseQuoteFilter()
+    {
+        $config = new Configuration();
+        $config->set('name', "it's a test");
+
+        self::assertEquals("\$'it\\'s a test'", $config->parse('{{ name | quote }}'));
+    }
+
+    public function testParseQuoteFilterSafeValue()
+    {
+        $config = new Configuration();
+        $config->set('path', '/usr/local/bin');
+
+        self::assertEquals('/usr/local/bin', $config->parse('{{ path | quote }}'));
+    }
+
+    public function testParseUnknownFilter()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Unknown filter: upper');
+
+        $config = new Configuration();
+        $config->set('name', 'test');
+        $config->parse('{{ name | upper }}');
+    }
+
     public function testPersist()
     {
         $parent = new Configuration();