self-review improvements

yceruto · yceruto · commit 3dc5c9c4a939 · 2024-08-29T08:23:54.000-04:00
diff --git a/src/Symfony/Bridge/Doctrine/Attribute/Transactional.php b/src/Symfony/Bridge/Doctrine/Attribute/Transactional.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Decorator\Attribute\Decorate;
 
 /**
- * Indicates that an object method should be wrapped within a single Doctrine transaction.
+ * Wraps persistence method operations within a single Doctrine transaction.
  *
  * @author Yonel Ceruto <open@yceruto.dev>
  */
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -5,7 +5,7 @@ CHANGELOG
 ---
 
  * Accept `ReadableCollection` in `CollectionToArrayTransformer`
- * Add `DoctrineTransactionDecorator` and `Transactional` attribute
+ * Add `Transactional` attribute and `DoctrineTransactionDecorator`
 
 7.1
 ---
diff --git a/src/Symfony/Bridge/Doctrine/Decorator/DoctrineTransactionDecorator.php b/src/Symfony/Bridge/Doctrine/Decorator/DoctrineTransactionDecorator.php
@@ -16,14 +16,12 @@
 use Symfony\Component\Decorator\DecoratorInterface;
 
 /**
- * Wraps a persistence functionality in a single Doctrine transaction.
- *
  * @author Yonel Ceruto <open@yceruto.dev>
  */
-final readonly class DoctrineTransactionDecorator implements DecoratorInterface
+class DoctrineTransactionDecorator implements DecoratorInterface
 {
     public function __construct(
-        private ManagerRegistry $managerRegistry,
+        private readonly ManagerRegistry $managerRegistry,
     ) {
     }
 
@@ -35,7 +33,7 @@ public function decorate(\Closure $func, ?string $name = null): \Closure
             throw new \RuntimeException(\sprintf('The manager "%s" is not an entity manager.', $name));
         }
 
-        return function (mixed ...$args) use ($func, $entityManager) {
+        return static function (mixed ...$args) use ($func, $entityManager) {
             $entityManager->getConnection()->beginTransaction();
 
             try {
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -12,7 +12,8 @@ CHANGELOG
  * Deprecate making `cache.app` adapter taggable, use the `cache.app.taggable` adapter instead
  * Enable `json_decode_detailed_errors` in the default serializer context in debug mode by default when `seld/jsonlint` is installed
  * Register `Symfony\Component\Serializer\NameConverter\SnakeCaseToCamelCaseNameConverter` as a service named `serializer.name_converter.snake_case_to_camel_case` if available
- * Add Decorator component integration and controller decoration support
+ * Add Decorator component integration
+ * Add controller decoration support
 
 7.1
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/DecorateControllerListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/DecorateControllerListener.php
@@ -19,10 +19,10 @@
 /**
  * @author Yonel Ceruto <open@yceruto.dev>
  */
-final readonly class DecorateControllerListener implements EventSubscriberInterface
+class DecorateControllerListener implements EventSubscriberInterface
 {
     public function __construct(
-        private DecoratorInterface $decorator,
+        private readonly DecoratorInterface $decorator,
     ) {
     }
 
diff --git a/src/Symfony/Component/Decorator/Attribute/Decorate.php b/src/Symfony/Component/Decorator/Attribute/Decorate.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Decorator\Attribute;
 
 /**
- * An attribute that specifies under which decorator a function or method should be wrapped.
+ * Specifies the decorator to wrap a function or method.
  *
  * @author Yonel Ceruto <open@yceruto.dev>
  *
@@ -21,6 +21,10 @@
 #[\Attribute(\Attribute::TARGET_FUNCTION | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class Decorate
 {
+    /**
+     * @param string $id                    The decorator service id
+     * @param array<string, mixed> $options The decorator options to pass through
+     */
     public function __construct(
         public string $id,
         public array $options = [],
diff --git a/src/Symfony/Component/Decorator/DecoratorChain.php b/src/Symfony/Component/Decorator/DecoratorChain.php
@@ -20,13 +20,13 @@
  *
  * @experimental
  */
-readonly class DecoratorChain implements DecoratorInterface
+class DecoratorChain implements DecoratorInterface
 {
     /**
      * @param ContainerInterface $decorators Locator of decorators, keyed by service id
      */
     public function __construct(
-        private ContainerInterface $decorators,
+        private readonly ContainerInterface $decorators,
     ) {
     }
 
diff --git a/src/Symfony/Component/Decorator/README.md b/src/Symfony/Component/Decorator/README.md
@@ -1,7 +1,8 @@
 Decorator Component
 ===================
 
-Symfony Decorator modify the functionality of other functions or methods.
+The Symfony Decorator modifies a function's behavior by adding actions before
+and after its execution.
 
 **This Component is experimental**.
 [Experimental features](https://symfony.com/doc/current/contributing/code/experimental.html)
@@ -40,7 +41,7 @@ $decorator = DecoratorChain::from([
     DebugDecorator::class => fn () => new DebugDecorator(),
 ]);
 
-#[\Attribute(\Attribute::TARGET_FUNCTION | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+#[\Attribute(\Attribute::TARGET_METHOD)]
 class Debug extends Decorate
 {
     public function __construct()

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`use Symfony\Component\Decorator\Attribute\Decorate;`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * Indicates that an object method should be wrapped within a single Doctrine transaction.`
	`18`	`+ * Wraps persistence method operations within a single Doctrine transaction.`
`19`	`19`	`*`
`20`	`20`	`* @author Yonel Ceruto <open@yceruto.dev>`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,10 @@`
`19`	`19`	`/**`
`20`	`20`	`* @author Yonel Ceruto <open@yceruto.dev>`
`21`	`21`	`*/`
`22`		`-final readonly class DecorateControllerListener implements EventSubscriberInterface`
	`22`	`+class DecorateControllerListener implements EventSubscriberInterface`
`23`	`23`	`{`
`24`	`24`	`public function __construct(`
`25`		`- private DecoratorInterface $decorator,`
	`25`	`+ private readonly DecoratorInterface $decorator,`
`26`	`26`	`) {`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Decorator\Attribute;`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * An attribute that specifies under which decorator a function or method should be wrapped.`
	`15`	`+ * Specifies the decorator to wrap a function or method.`
`16`	`16`	`*`
`17`	`17`	`* @author Yonel Ceruto <open@yceruto.dev>`
`18`	`18`	`*`
`@@ -21,6 +21,10 @@`
`21`	`21`	`#[\Attribute(\Attribute::TARGET_FUNCTION \| \Attribute::TARGET_METHOD \| \Attribute::IS_REPEATABLE)]`
`22`	`22`	`class Decorate`
`23`	`23`	`{`
	`24`	`+ /**`
	`25`	`+ * @param string $id The decorator service id`
	`26`	`+ * @param array<string, mixed> $options The decorator options to pass through`
	`27`	`+ */`
`24`	`28`	`public function __construct(`
`25`	`29`	`public string $id,`
`26`	`30`	`public array $options = [],`
Original file line number	Diff line number	Diff line change
`@@ -20,13 +20,13 @@`
`20`	`20`	`*`
`21`	`21`	`* @experimental`
`22`	`22`	`*/`
`23`		`-readonly class DecoratorChain implements DecoratorInterface`
	`23`	`+class DecoratorChain implements DecoratorInterface`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* @param ContainerInterface $decorators Locator of decorators, keyed by service id`
`27`	`27`	`*/`
`28`	`28`	`public function __construct(`
`29`		`- private ContainerInterface $decorators,`
	`29`	`+ private readonly ContainerInterface $decorators,`
`30`	`30`	`) {`
`31`	`31`	`}`
`32`	`32`