Rename Sse classes

Author: bencroker

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "putyourlightson/craft-datastar-module",
   "description": "A template-driven, reactive hypermedia framework for Craft.",
-  "version": "1.0.0-RC.6",
+  "version": "1.0.0-RC.7",
   "type": "yii-module",
   "license": "mit",
   "require": {

src/Datastar.php

@@ -9,13 +9,13 @@
 use craft\web\Response;
 use putyourlightson\datastar\assets\DatastarAssetBundle;
 use putyourlightson\datastar\models\Settings;
-use putyourlightson\datastar\services\Sse;
+use putyourlightson\datastar\services\SseService;
 use putyourlightson\datastar\twigextensions\DatastarTwigExtension;
 use yii\base\Event;
 use yii\base\Module;
 
 /**
- * @property-read Sse $sse
+ * @property-read SseService $sse
  * @property-read Settings $settings
  */
 class Datastar extends Module
@@ -81,7 +81,7 @@ public function getSettings(): Settings
     private function registerComponents(): void
     {
         $this->setComponents([
-            'sse' => Sse::class,
+            'sse' => SseService::class,
         ]);
     }
 

src/controllers/DefaultController.php

@@ -8,14 +8,14 @@
 use Craft;
 use craft\web\Controller;
 use putyourlightson\datastar\models\Config;
-use putyourlightson\datastar\traits\SseTrait;
+use putyourlightson\datastar\traits\Sse;
 use yii\web\BadRequestHttpException;
 use yii\web\ForbiddenHttpException;
 use yii\web\Response;
 
 class DefaultController extends Controller
 {
-    use SseTrait;
+    use Sse;
 
     /**
      * @inheritdoc

src/helpers/Action.php

@@ -17,24 +17,24 @@ class Action
     /**
      * Returns a Datastar action.
      */
-    public static function getAction(string $method, string $route, array $params = [], array $options = []): string
+    public static function getAction(string $method, string $route, array $params = [], array|string $options = []): string
     {
         $url = self::getUrl($route, $params);
-        $args = ["'$url'"];
+        $args = ['"' . $url . '"'];
 
         if ($method !== 'get') {
-            $headers = $options['headers'] ?? [];
-            $headers[Request::CSRF_HEADER] = Craft::$app->getRequest()->getCsrfToken();
-            $options['headers'] = $headers;
+            $options = self::addCsrfToken($options);
+        } else {
+            $options = is_array($options) ? Json::encode($options) : $options;
         }
 
-        if (!empty($options)) {
-            $args[] = Json::encode($options);
+        if ($options !== '{}') {
+            $args[] = $options;
         }
 
         $args = implode(', ', $args);
 
-        return "@$method($args)";
+        return '@' . $method . '(' . $args . ')';
     }
 
     /**
@@ -56,4 +56,46 @@ public static function getUrl(string $route, array $params = []): string
             'config' => $config->getHashed(),
         ]);
     }
+
+    private static function addCsrfToken(array|string $options): string
+    {
+        $token = Craft::$app->getRequest()->getCsrfToken();
+        $csrfHeader = Request::CSRF_HEADER;
+
+        if (is_array($options)) {
+            return self::addCsrfToArray($options, $token, $csrfHeader);
+        }
+
+        return self::addCsrfToString($options, $token, $csrfHeader);
+    }
+
+    private static function addCsrfToArray(array $options, string $token, string $csrfHeader): string
+    {
+        $headers = $options['headers'] ?? [];
+        $headers[$csrfHeader] = $token;
+        $options['headers'] = $headers;
+
+        return Json::encode($options);
+    }
+
+    private static function addCsrfToString(string $options, string $token, string $csrfHeader): string
+    {
+        if (preg_match('/headers:\s*\{/i', $options)) {
+            return preg_replace(
+                '/headers:\s*\{/i',
+                'headers: {"' . $csrfHeader . '": "' . $token . '", ',
+                $options
+            );
+        }
+
+        if (preg_match('/}\s*$/', $options)) {
+            return preg_replace(
+                '/}\s*$/',
+                ', headers: {"' . $csrfHeader . '": "' . $token . '"}}',
+                $options
+            );
+        }
+
+        return Json::encode(['headers' => [$csrfHeader => $token]]);
+    }
 }

src/services/Sse.php src/services/SseService.phpsrc/services/Sse.php renamed to src/services/SseService.php

@@ -20,7 +20,7 @@
 use Throwable;
 use yii\web\BadRequestHttpException;
 
-class Sse extends Component
+class SseService extends Component
 {
     /**
      * Whether the response is a streamed response.

src/traits/SseTrait.php src/traits/Sse.phpsrc/traits/SseTrait.php renamed to src/traits/Sse.php

@@ -6,14 +6,14 @@
 namespace putyourlightson\datastar\traits;
 
 use putyourlightson\datastar\Datastar;
-use putyourlightson\datastar\services\Sse;
+use putyourlightson\datastar\services\SseService;
 
-trait SseTrait
+trait Sse
 {
     /**
      * Returns the `SseService` instance.
      */
-    protected function sse(): Sse
+    protected function sse(): SseService
     {
         return Datastar::getInstance()->sse;
     }

src/twigextensions/nodes/CompileWithOptionsTrait.php

@@ -6,15 +6,15 @@
 namespace putyourlightson\datastar\twigextensions\nodes;
 
 use putyourlightson\datastar\Datastar;
-use putyourlightson\datastar\services\Sse;
+use putyourlightson\datastar\services\SseService;
 use Twig\Compiler;
 
 trait CompileWithOptionsTrait
 {
     /**
      * Compiles a node with options.
      *
-     * @uses Sse::setSseMethodInProcess()
+     * @uses SseService::setSseMethodInProcess()
      */
     public function compileWithOptions(Compiler $compiler, string $method): void
     {

src/twigextensions/nodes/ExecuteScriptNode.php

@@ -5,7 +5,7 @@
 
 namespace putyourlightson\datastar\twigextensions\nodes;
 
-use putyourlightson\datastar\services\Sse;
+use putyourlightson\datastar\services\SseService;
 use Twig\Compiler;
 use Twig\Node\Node;
 
@@ -14,7 +14,7 @@ class ExecuteScriptNode extends Node
     use CompileWithOptionsTrait;
 
     /**
-     * @uses Sse::executeScript()
+     * @uses SseService::executeScript()
      */
     public function compile(Compiler $compiler): void
     {

src/twigextensions/nodes/LocationNode.php

@@ -6,14 +6,14 @@
 namespace putyourlightson\datastar\twigextensions\nodes;
 
 use putyourlightson\datastar\Datastar;
-use putyourlightson\datastar\services\Sse;
+use putyourlightson\datastar\services\SseService;
 use Twig\Compiler;
 use Twig\Node\Node;
 
 class LocationNode extends Node
 {
     /**
-     * @uses Sse::location()
+     * @uses SseService::location()
      */
     public function compile(Compiler $compiler): void
     {

src/twigextensions/nodes/PatchElementsNode.php

@@ -5,7 +5,7 @@
 
 namespace putyourlightson\datastar\twigextensions\nodes;
 
-use putyourlightson\datastar\services\Sse;
+use putyourlightson\datastar\services\SseService;
 use Twig\Compiler;
 use Twig\Node\Node;
 
@@ -14,7 +14,7 @@ class PatchElementsNode extends Node
     use CompileWithOptionsTrait;
 
     /**
-     * @uses Sse::patchElements()
+     * @uses SseService::patchElements()
      */
     public function compile(Compiler $compiler): void
     {