minor #185 [ci] fix flex plugin & legacy stimulus tests (jrushlow)

This PR was squashed before being merged into the main branch.

Discussion
----------

[ci] fix flex plugin & legacy stimulus tests

- adds `flex` to composers allowed plugins
- moves Stimulus `action`, `controller`, & `target` test cases w/ array's as the first arg to legacy tests. (silence deprecation's in CI)

Commits
-------

238a8ee [ci] fix flex plugin & legacy stimulus tests

Author: weaverryan

.github/workflows/ci.yml

@@ -36,6 +36,10 @@ jobs:
             coverage: "none"
             php-version: "${{ matrix.php-version }}"
 
+      - name: Allow Flex Plugin
+        run: |
+          composer global config --no-plugins allow-plugins.symfony/flex true
+
       - name: Install Global Dependencies
         run: |
           composer global require --no-progress --no-scripts --no-plugins symfony/flex @dev

src/Dto/AbstractStimulusDto.php

@@ -39,7 +39,7 @@ protected function getFormattedValue($value)
     {
         if ($value instanceof \Stringable || (\is_object($value) && \is_callable([$value, '__toString']))) {
             $value = (string) $value;
-        } elseif (!is_scalar($value)) {
+        } elseif (!\is_scalar($value)) {
             $value = json_encode($value);
         } elseif (\is_bool($value)) {
             $value = $value ? 'true' : 'false';

tests/IntegrationTest.php

@@ -203,6 +203,68 @@ public function testAutowireDefaultBuildArgument()
     }
 
     public function provideRenderStimulusController()
+    {
+        yield 'normalize-names' => [
+            'dataOrControllerName' => '@symfony/ux-dropzone/dropzone',
+            'controllerValues' => [
+                'my"Key"' => true,
+            ],
+            'expectedString' => 'data-controller="symfony--ux-dropzone--dropzone" data-symfony--ux-dropzone--dropzone-my-key-value="true"',
+            'expectedArray' => ['data-controller' => 'symfony--ux-dropzone--dropzone', 'data-symfony--ux-dropzone--dropzone-my-key-value' => 'true'],
+        ];
+
+        yield 'short-single-controller-no-data' => [
+            'dataOrControllerName' => 'my-controller',
+            'controllerValues' => [],
+            'expectedString' => 'data-controller="my-controller"',
+            'expectedArray' => ['data-controller' => 'my-controller'],
+        ];
+
+        yield 'short-single-controller-with-data' => [
+            'dataOrControllerName' => 'my-controller',
+            'controllerValues' => ['myValue' => 'scalar-value'],
+            'expectedString' => 'data-controller="my-controller" data-my-controller-my-value-value="scalar-value"',
+            'expectedArray' => ['data-controller' => 'my-controller', 'data-my-controller-my-value-value' => 'scalar-value'],
+        ];
+
+        yield 'false-attribute-value-renders-false' => [
+            'dataOrControllerName' => 'false-controller',
+            'controllerValues' => ['isEnabled' => false],
+            'expectedString' => 'data-controller="false-controller" data-false-controller-is-enabled-value="false"',
+            'expectedArray' => ['data-controller' => 'false-controller', 'data-false-controller-is-enabled-value' => 'false'],
+        ];
+
+        yield 'true-attribute-value-renders-true' => [
+            'dataOrControllerName' => 'true-controller',
+            'controllerValues' => ['isEnabled' => true],
+            'expectedString' => 'data-controller="true-controller" data-true-controller-is-enabled-value="true"',
+            'expectedArray' => ['data-controller' => 'true-controller', 'data-true-controller-is-enabled-value' => 'true'],
+        ];
+
+        yield 'null-attribute-value-does-not-render' => [
+            'dataOrControllerName' => 'null-controller',
+            'controllerValues' => ['firstName' => null],
+            'expectedString' => 'data-controller="null-controller"',
+            'expectedArray' => ['data-controller' => 'null-controller'],
+        ];
+    }
+
+    /**
+     * @dataProvider provideRenderStimulusController
+     */
+    public function testRenderStimulusController($dataOrControllerName, array $controllerValues, string $expectedString, array $expectedArray)
+    {
+        $kernel = new WebpackEncoreIntegrationTestKernel(true);
+        $kernel->boot();
+        $twig = $this->getTwigEnvironmentFromBootedKernel($kernel);
+
+        $extension = new StimulusTwigExtension();
+        $dto = $extension->renderStimulusController($twig, $dataOrControllerName, $controllerValues);
+        $this->assertSame($expectedString, (string) $dto);
+        $this->assertSame($expectedArray, $dto->toArray());
+    }
+
+    public function provideLegacyRenderMultipleStimulusControllers()
     {
         yield 'empty' => [
             'dataOrControllerName' => [],
@@ -279,47 +341,13 @@ public function provideRenderStimulusController()
             'expectedString' => 'data-controller="symfony--ux-dropzone--dropzone" data-symfony--ux-dropzone--dropzone-my-key-value="true"',
             'expectedArray' => ['data-controller' => 'symfony--ux-dropzone--dropzone', 'data-symfony--ux-dropzone--dropzone-my-key-value' => 'true'],
         ];
-
-        yield 'short-single-controller-no-data' => [
-            'dataOrControllerName' => 'my-controller',
-            'controllerValues' => [],
-            'expectedString' => 'data-controller="my-controller"',
-            'expectedArray' => ['data-controller' => 'my-controller'],
-        ];
-
-        yield 'short-single-controller-with-data' => [
-            'dataOrControllerName' => 'my-controller',
-            'controllerValues' => ['myValue' => 'scalar-value'],
-            'expectedString' => 'data-controller="my-controller" data-my-controller-my-value-value="scalar-value"',
-            'expectedArray' => ['data-controller' => 'my-controller', 'data-my-controller-my-value-value' => 'scalar-value'],
-        ];
-
-        yield 'false-attribute-value-renders-false' => [
-            'dataOrControllerName' => 'false-controller',
-            'controllerValues' => ['isEnabled' => false],
-            'expectedString' => 'data-controller="false-controller" data-false-controller-is-enabled-value="false"',
-            'expectedArray' => ['data-controller' => 'false-controller', 'data-false-controller-is-enabled-value' => 'false'],
-        ];
-
-        yield 'true-attribute-value-renders-true' => [
-            'dataOrControllerName' => 'true-controller',
-            'controllerValues' => ['isEnabled' => true],
-            'expectedString' => 'data-controller="true-controller" data-true-controller-is-enabled-value="true"',
-            'expectedArray' => ['data-controller' => 'true-controller', 'data-true-controller-is-enabled-value' => 'true'],
-        ];
-
-        yield 'null-attribute-value-does-not-render' => [
-            'dataOrControllerName' => 'null-controller',
-            'controllerValues' => ['firstName' => null],
-            'expectedString' => 'data-controller="null-controller"',
-            'expectedArray' => ['data-controller' => 'null-controller'],
-        ];
     }
 
     /**
-     * @dataProvider provideRenderStimulusController
+     * @dataProvider provideLegacyRenderMultipleStimulusControllers
+     * @legacy
      */
-    public function testRenderStimulusController($dataOrControllerName, array $controllerValues, string $expectedString, array $expectedArray)
+    public function testLegacyRenderMultipleStimulusControllers($dataOrControllerName, array $controllerValues, string $expectedString, array $expectedArray)
     {
         $kernel = new WebpackEncoreIntegrationTestKernel(true);
         $kernel->boot();
@@ -374,6 +402,42 @@ public function provideRenderStimulusAction()
             'expectedArray' => ['data-action' => 'my-controller#onClick', 'data-my-controller-bool-param-param' => 'true', 'data-my-controller-int-param-param' => '4', 'data-my-controller-string-param-param' => 'test'],
         ];
 
+        yield 'normalize-name, with default event' => [
+            'dataOrControllerName' => '@symfony/ux-dropzone/dropzone',
+            'actionName' => 'onClick',
+            'eventName' => null,
+            'parameters' => [],
+            'expectedString' => 'data-action="symfony--ux-dropzone--dropzone#onClick"',
+            'expectedArray' => ['data-action' => 'symfony--ux-dropzone--dropzone#onClick'],
+        ];
+
+        yield 'normalize-name, with custom event' => [
+            'dataOrControllerName' => '@symfony/ux-dropzone/dropzone',
+            'actionName' => 'onClick',
+            'eventName' => 'click',
+            'parameters' => [],
+            'expectedString' => 'data-action="click->symfony--ux-dropzone--dropzone#onClick"',
+            'expectedArray' => ['data-action' => 'click->symfony--ux-dropzone--dropzone#onClick'],
+        ];
+    }
+
+    /**
+     * @dataProvider provideRenderStimulusAction
+     */
+    public function testRenderStimulusAction($dataOrControllerName, ?string $actionName, ?string $eventName, array $parameters, string $expectedString, array $expectedArray)
+    {
+        $kernel = new WebpackEncoreIntegrationTestKernel(true);
+        $kernel->boot();
+        $twig = $this->getTwigEnvironmentFromBootedKernel($kernel);
+
+        $extension = new StimulusTwigExtension();
+        $dto = $extension->renderStimulusAction($twig, $dataOrControllerName, $actionName, $eventName, $parameters);
+        $this->assertSame($expectedString, (string) $dto);
+        $this->assertSame($expectedArray, $dto->toArray());
+    }
+
+    public function provideLegacyRenderMultipleStimulusAction(): \Generator
+    {
         yield 'multiple actions, with default event' => [
             'dataOrControllerName' => [
                 'my-controller' => 'onClick',
@@ -414,30 +478,13 @@ public function provideRenderStimulusAction()
             'expectedString' => 'data-action="click->my-controller#onClick my-second-controller#onClick click->my-second-controller#onAnotherClick change->my-second-controller#onSomethingElse resize@window->resize-controller#onWindowResize click->foo--bar-controller#onClick"',
             'expectedArray' => ['data-action' => 'click->my-controller#onClick my-second-controller#onClick click->my-second-controller#onAnotherClick change->my-second-controller#onSomethingElse resize@window->resize-controller#onWindowResize click->foo--bar-controller#onClick'],
         ];
-
-        yield 'normalize-name, with default event' => [
-            'dataOrControllerName' => '@symfony/ux-dropzone/dropzone',
-            'actionName' => 'onClick',
-            'eventName' => null,
-            'parameters' => [],
-            'expectedString' => 'data-action="symfony--ux-dropzone--dropzone#onClick"',
-            'expectedArray' => ['data-action' => 'symfony--ux-dropzone--dropzone#onClick'],
-        ];
-
-        yield 'normalize-name, with custom event' => [
-            'dataOrControllerName' => '@symfony/ux-dropzone/dropzone',
-            'actionName' => 'onClick',
-            'eventName' => 'click',
-            'parameters' => [],
-            'expectedString' => 'data-action="click->symfony--ux-dropzone--dropzone#onClick"',
-            'expectedArray' => ['data-action' => 'click->symfony--ux-dropzone--dropzone#onClick'],
-        ];
     }
 
     /**
-     * @dataProvider provideRenderStimulusAction
+     * @dataProvider provideLegacyRenderMultipleStimulusAction
+     * @legacy
      */
-    public function testRenderStimulusAction($dataOrControllerName, ?string $actionName, ?string $eventName, array $parameters, string $expectedString, array $expectedArray)
+    public function testLegacyRenderMultipleStimulusActions($dataOrControllerName, ?string $actionName, ?string $eventName, array $parameters, string $expectedString, array $expectedArray)
     {
         $kernel = new WebpackEncoreIntegrationTestKernel(true);
         $kernel->boot();
@@ -478,19 +525,6 @@ public function provideRenderStimulusTarget()
             'expectedString' => 'data-symfony--ux-dropzone--dropzone-target="myTarget"',
             'expectedArray' => ['data-symfony--ux-dropzone--dropzone-target' => 'myTarget'],
         ];
-
-        yield 'multiple' => [
-            'dataOrControllerName' => [
-                'my-controller' => 'myTarget',
-                '@symfony/ux-dropzone/dropzone' => 'anotherTarget fooTarget',
-            ],
-            'targetName' => null,
-            'expectedString' => 'data-my-controller-target="myTarget" data-symfony--ux-dropzone--dropzone-target="anotherTarget fooTarget"',
-            'expectedArray' => [
-                'data-my-controller-target' => 'myTarget',
-                'data-symfony--ux-dropzone--dropzone-target' => 'anotherTarget fooTarget',
-            ],
-        ];
     }
 
     /**
@@ -508,6 +542,34 @@ public function testRenderStimulusTarget($dataOrControllerName, ?string $targetN
         $this->assertSame($expectedArray, $dto->toArray());
     }
 
+    /**
+     * @legacy
+     */
+    public function testLegacyRenderMultipleStimulusTargets()
+    {
+        $kernel = new WebpackEncoreIntegrationTestKernel(true);
+        $kernel->boot();
+        $twig = $this->getTwigEnvironmentFromBootedKernel($kernel);
+
+        $extension = new StimulusTwigExtension();
+        $dto = $extension->renderStimulusTarget($twig, [
+            'my-controller' => 'myTarget',
+            '@symfony/ux-dropzone/dropzone' => 'anotherTarget fooTarget',
+        ]);
+
+        $this->assertSame(
+            'data-my-controller-target="myTarget" data-symfony--ux-dropzone--dropzone-target="anotherTarget fooTarget"',
+            (string) $dto
+        );
+
+        $this->assertSame([
+                'data-my-controller-target' => 'myTarget',
+                'data-symfony--ux-dropzone--dropzone-target' => 'anotherTarget fooTarget',
+            ],
+            $dto->toArray()
+        );
+    }
+
     public function testAppendStimulusTarget()
     {
         $kernel = new WebpackEncoreIntegrationTestKernel(true);