Initial commit of symfony/ux-twig-component

Co-authored-by: Kevin Bond <[email protected]>

Author: weaverryan

src/LiveComponent/src/Attribute/BeforeReRender.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Attribute;
+
+/**
+ * Call a method before re-rendering.
+ *
+ * This hook ONLY happens when rendering via HTTP: it does
+ * not happen during the initial render of a component.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @experimental
+ */
+final class BeforeReRender
+{
+}

src/LiveComponent/src/Attribute/LiveAction.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Attribute;
+
+/**
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @experimental
+ */
+final class LiveAction
+{
+}

src/LiveComponent/src/Attribute/LiveProp.php

@@ -0,0 +1,94 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Attribute;
+
+use Symfony\UX\LiveComponent\LiveComponentInterface;
+
+/**
+ * @Annotation
+ * @Target("PROPERTY")
+ *
+ * @experimental
+ */
+final class LiveProp
+{
+    /** @var bool */
+    private $writable = false;
+
+    /** @var string[] */
+    private $exposed = [];
+
+    /** @var string|null */
+    private $hydrateWith = null;
+
+    /** @var string|null */
+    private $dehydrateWith = null;
+
+    /**
+     *The "frontend" field name that should be used for this property.
+     *
+     * This can be used, for example, to have a property called "foo", which actually
+     * maps to a frontend data model called "bar".
+     *
+     * If you pass a string that ends in () - like "getFieldName()" - that
+     * method on the component will be called to determine this.
+     *
+     * @var string|null
+     */
+    private $fieldName = null;
+
+    public function __construct(array $values)
+    {
+        $validOptions = ['writable', 'exposed', 'hydrateWith', 'dehydrateWith', 'fieldName'];
+
+        foreach ($values as $name => $value) {
+            if (!in_array($name, $validOptions)) {
+                throw new \InvalidArgumentException(sprintf('Unknown option "%s" passed to LiveProp. Valid options are: %s.', $name, implode(', ', $validOptions)));
+            }
+
+            $this->$name = $value;
+        }
+    }
+
+    public function isReadonly(): bool
+    {
+        return !$this->writable;
+    }
+
+    public function exposed(): array
+    {
+        return $this->exposed;
+    }
+
+    public function hydrateMethod(): ?string
+    {
+        return $this->hydrateWith ? trim($this->hydrateWith, '()') : null;
+    }
+
+    public function dehydrateMethod(): ?string
+    {
+        return $this->dehydrateWith ? trim($this->dehydrateWith, '()') : null;
+    }
+
+    public function calculateFieldName(LiveComponentInterface $component, string $fallback): string
+    {
+        if (!$this->fieldName) {
+            return $fallback;
+        }
+
+        if (str_ends_with($this->fieldName, '()')) {
+            return $component->{trim($this->fieldName, '()')}();
+        }
+
+        return $this->fieldName;
+    }
+}

src/LiveComponent/src/Attribute/PostHydrate.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Attribute;
+
+/**
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @experimental
+ */
+final class PostHydrate
+{
+}

src/LiveComponent/src/Attribute/PreDehydrate.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Attribute;
+
+/**
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @experimental
+ */
+final class PreDehydrate
+{
+}

src/LiveComponent/src/ComponentValidator.php

@@ -0,0 +1,102 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent;
+
+use Psr\Container\ContainerInterface;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\Validator\ConstraintViolation;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Symfony\Contracts\Service\ServiceSubscriberInterface;
+
+/**
+ * @author Ryan Weaver <[email protected]>
+ *
+ * @experimental
+ * @internal
+ */
+class ComponentValidator implements ComponentValidatorInterface, ServiceSubscriberInterface
+{
+    /** @var ContainerInterface */
+    private $container;
+
+    public function __construct(ContainerInterface $container)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * @return ConstraintViolation[][]
+     */
+    public function validate(object $component): array
+    {
+        $errors = $this->getValidator()->validate($component);
+
+        $validationErrors = [];
+        foreach ($errors as $error) {
+            /** @var ConstraintViolation $error */
+            $property = $error->getPropertyPath();
+            if (!isset($validationErrors[$property])) {
+                $validationErrors[$property] = [];
+            }
+
+            $validationErrors[$property][] = $error;
+        }
+
+        return $validationErrors;
+    }
+
+    /**
+     * Validates a single field.
+     *
+     * If a property path - like post.title - is passed, this will
+     * validate the *entire* "post" property. It will then loop
+     * over all the errors and collect only those for "post.title".
+     *
+     * @return ConstraintViolation[]
+     */
+    public function validateField(object $component, string $propertyPath): array
+    {
+        $propertyParts = explode('.', $propertyPath);
+        $propertyName = $propertyParts[0];
+
+        /** @var  $errors */
+        $errors = $this->getValidator()->validateProperty($component, $propertyName);
+
+        $errorsForPath = [];
+        foreach ($errors as $error) {
+            /** @var ConstraintViolation $error */
+            if ($error->getPropertyPath() === $propertyPath) {
+                $errorsForPath[] = $error;
+            }
+        }
+
+        return $errorsForPath;
+    }
+
+    private function getValidator(): ValidatorInterface
+    {
+        return $this->container->get('validator');
+    }
+
+    private function getPropertyAccessor(): PropertyAccessorInterface
+    {
+        return $this->container->get('property_accessor');
+    }
+
+    public static function getSubscribedServices(): array
+    {
+        return [
+            'validator' => ValidatorInterface::class,
+            'property_accessor' => PropertyAccessorInterface::class,
+        ];
+    }
+}

src/LiveComponent/src/ComponentValidatorInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent;
+
+use Symfony\Component\Validator\ConstraintViolation;
+
+/**
+ * @author Ryan Weaver <[email protected]>
+ *
+ * @experimental
+ */
+interface ComponentValidatorInterface
+{
+    /**
+     * Returns an array - keyed by the property path - containing
+     * another array of validation errors.
+     *
+     * For example:
+     *
+     *      [
+     *          'firstName' => [ConstraintViolation, ConstraintViolation],
+     *      ]
+     *
+     * @return ConstraintViolation[][]
+     */
+    public function validate(object $component): array;
+
+    /**
+     * Returns an array of violations for this one specific property.
+     *
+     * @return ConstraintViolation[]
+     */
+    public function validateField(object $component, string $propertyName): array;
+}