bug #2159 [StimulusBundle] Normalize Stimulus controller name in event name (7-zete-7)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[StimulusBundle] Normalize Stimulus controller name in event name

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Issues        | Fix #2151
| License       | MIT

Adds the ability to use non-normalized Stimulus controller names when describing actions on events from other Stimulus controllers.

Commits
-------

a09e9af [StimulusBundle] Normalize Stimulus controller name in event name

Author: Kocal

src/StimulusBundle/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.20.1
+
+-   Normalize Stimulus controller name in event name
+
 ## 2.14.2
 
 -   Fix bug with finding UX Packages with non-standard project structure

src/StimulusBundle/src/Dto/StimulusAttributes.php

@@ -75,7 +75,7 @@ public function addAction(string $controllerName, string $actionName, ?string $e
         $this->actions[] = [
             'controllerName' => $controllerName,
             'actionName' => $actionName,
-            'eventName' => $eventName,
+            'eventName' => null !== $eventName ? $this->normalizeEventName($eventName) : null,
         ];
 
         foreach ($parameters as $name => $value) {
@@ -218,6 +218,14 @@ private function normalizeControllerName(string $controllerName): string
         return preg_replace('/^@/', '', str_replace('_', '-', str_replace('/', '--', $controllerName)));
     }
 
+    /**
+     * @see https://stimulus.hotwired.dev/reference/actions
+     */
+    private function normalizeEventName(string $eventName): string
+    {
+        return preg_replace_callback('/^.+(?=:)/', fn (array $matches): string => $this->normalizeControllerName($matches[0]), $eventName);
+    }
+
     /**
      * Normalize a Stimulus Value API key into its HTML equivalent ("kebab case").
      * Backport features from symfony/string.

src/StimulusBundle/tests/Dto/StimulusAttributesTest.php

@@ -148,4 +148,91 @@ public function testAddAttribute()
         $this->assertSame('foo="bar baz"', (string) $this->stimulusAttributes);
         $this->assertSame(['foo' => 'bar baz'], $this->stimulusAttributes->toArray());
     }
+
+    /**
+     * @dataProvider provideAddComplexActionData
+     */
+    public function testAddComplexAction(string $controllerName, string $actionName, ?string $eventName, string $expectedAction): void
+    {
+        $this->stimulusAttributes->addAction($controllerName, $actionName, $eventName);
+        $attributesHtml = (string) $this->stimulusAttributes;
+        self::assertSame(\sprintf('data-action="%s"', $expectedAction), $attributesHtml);
+    }
+
+    /**
+     * @return iterable<array{
+     *     controllerName: string,
+     *     actionName: string,
+     *     eventName: ?string,
+     *     expectedAction: string,
+     * }>
+     */
+    public static function provideAddComplexActionData(): iterable
+    {
+        // basic datasets
+        yield 'foo#bar' => [
+            'controllerName' => 'foo',
+            'actionName' => 'bar',
+            'eventName' => null,
+            'expectedAction' => 'foo#bar',
+        ];
+        yield 'baz->foo#bar' => [
+            'controllerName' => 'foo',
+            'actionName' => 'bar',
+            'eventName' => 'baz',
+            'expectedAction' => 'baz->foo#bar',
+        ];
+
+        // datasets from https://github.com/hotwired/stimulus
+        yield 'keydown.esc@document->a#log' => [
+            'controllerName' => 'a',
+            'actionName' => 'log',
+            'eventName' => 'keydown.esc@document',
+            'expectedAction' => 'keydown.esc@document->a#log',
+        ];
+        yield 'keydown.enter->a#log' => [
+            'controllerName' => 'a',
+            'actionName' => 'log',
+            'eventName' => 'keydown.enter',
+            'expectedAction' => 'keydown.enter->a#log',
+        ];
+        yield 'keydown.shift+a->a#log' => [
+            'controllerName' => 'a',
+            'actionName' => 'log',
+            'eventName' => 'keydown.shift+a',
+            'expectedAction' => 'keydown.shift+a->a#log',
+        ];
+        yield 'keydown@window->c#log' => [
+            'controllerName' => 'c',
+            'actionName' => 'log',
+            'eventName' => 'keydown@window',
+            'expectedAction' => 'keydown@window->c#log',
+        ];
+        yield 'click->c#log:once' => [
+            'controllerName' => 'c',
+            'actionName' => 'log:once',
+            'eventName' => 'click',
+            'expectedAction' => 'click->c#log:once',
+        ];
+
+        // extended datasets
+        yield 'vue:mount->foo#bar:passive' => [
+            'controllerName' => 'foo',
+            'actionName' => 'bar:passive',
+            'eventName' => 'vue:mount',
+            'expectedAction' => 'vue:mount->foo#bar:passive',
+        ];
+        yield 'foo--controller-1:baz->bar--controller-2#log' => [
+            'controllerName' => '@bar/controller_2',
+            'actionName' => 'log',
+            'eventName' => '@foo/controller_1:baz',
+            'expectedAction' => 'foo--controller-1:baz->bar--controller-2#log',
+        ];
+        yield 'foo--controller-1:baz@document->bar--controller-2#log:capture' => [
+            'controllerName' => '@bar/controller_2',
+            'actionName' => 'log:capture',
+            'eventName' => '@foo/controller_1:baz@document',
+            'expectedAction' => 'foo--controller-1:baz@document->bar--controller-2#log:capture',
+        ];
+    }
 }