Update doc, changelog, fix tests using fieldname and url binding

Author: squrious

src/LiveComponent/CHANGELOG.md

@@ -1,13 +1,16 @@
 # CHANGELOG
 
+## 2.17.0
+
+-   Add `modifier` option in `LiveProp` so options can be modified at runtime.
+
 ## 2.15.0
 
 -   [BC BREAK] The `data-live-id` attribute was changed to `id` #1484
 -   Fixed child handling bug during re-rendering introduced with the
     new morphing library in 2.14.0 #1484
 -   Fix bug where the active input would maintain its value, but lose its cursor position #1501
 -   Restrict Twig 3.9 for now #1486
--   Add `modifier` option in `LiveProp` so options can be modified at runtime.
 
 ## 2.14.1
 

src/LiveComponent/doc/index.rst

@@ -3351,9 +3351,9 @@ the change of one specific key::
 Set LiveProp Options Dynamically
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. versionadded:: 2.15
+.. versionadded:: 2.17
 
-    The ``modifier`` option was added in LiveComponents 2.15.
+    The ``modifier`` option was added in LiveComponents 2.17.
 
 
 If you need to configure a LiveProp's options dynamically, you can use the ``modifier`` option to use a custom
@@ -3364,7 +3364,7 @@ method in your component that returns a modified version of your LiveProp::
     class ProductSearch
     {
         #[LiveProp(writable: true, modifier: 'modifyAddedDate')]
-        public ?\DateTimeImmutable $addedDate;
+        public ?\DateTimeImmutable $addedDate = null;
 
         #[LiveProp]
         public string $dateFormat = 'Y-m-d';
@@ -3390,8 +3390,9 @@ All ``LiveProp::with*`` methods are immutable, so you need to use their return v
 
 .. caution::
 
-    You must not rely on props that also use a modifier in other modifiers methods. This is because
-    those properties may not have been hydrated by this point.
+    Avoid relying on props that also use a modifier in other modifiers methods. For example, if the ``$dateFormat``
+    property above also had a ``modifier`` option, then it wouldn't be safe to reference it from the ``modifyAddedDate``
+    modifier method. This is because the ``$dateFormat`` property may not have been hydrated by this point.
 
 
 Debugging Components

src/LiveComponent/tests/Fixtures/Component/ComponentWithUrlBoundProps.php

@@ -39,14 +39,22 @@ class ComponentWithUrlBoundProps
     #[LiveProp(fieldName: 'field6', url: true)]
     public ?string $prop6 = null;
 
-    #[LiveProp(modifier: 'modifyProp7')]
+    #[LiveProp(fieldName: 'getProp7Name()', url: true)]
     public ?string $prop7 = null;
 
+    #[LiveProp(modifier: 'modifyProp8')]
+    public ?string $prop8 = null;
+
     #[LiveProp]
-    public ?bool $prop7InUrl = false;
+    public ?bool $prop8InUrl = false;
+
+    public function getProp7Name(): string
+    {
+        return 'field7';
+    }
 
-    public function modifyProp7(LiveProp $prop): LiveProp
+    public function modifyProp8(LiveProp $prop): LiveProp
     {
-        return $prop->withUrl($this->prop7InUrl);
+        return $prop->withUrl($this->prop8InUrl);
     }
 }

src/LiveComponent/tests/Fixtures/templates/components/component_with_url_bound_props.html.twig

@@ -6,4 +6,5 @@
     Prop5: address: {{ prop5.address ?? '' }} city: {{ prop5.city ?? '' }}
     Prop6: {{ prop6 }}
     Prop7: {{ prop7 }}
+    Prop8: {{ prop8 }}
 </div>

src/LiveComponent/tests/Fixtures/templates/render_component_with_url_bound_props.html.twig

@@ -1,3 +1,3 @@
 {{ component('component_with_url_bound_props', {
-    prop7InUrl: true
+    prop8InUrl: true
 }) }}

src/LiveComponent/tests/Functional/EventListener/AddLiveAttributesSubscriberTest.php

@@ -151,7 +151,8 @@ public function testQueryStringMappingAttribute()
             'prop3' => ['name' => 'prop3'],
             'prop5' => ['name' => 'prop5'],
             'field6' => ['name' => 'field6'],
-            'prop7' => ['name' => 'prop7'],
+            'field7' => ['name' => 'field7'],
+            'prop8' => ['name' => 'prop8'],
         ];
 
         $this->assertEquals($expected, $queryMapping);

src/LiveComponent/tests/Functional/EventListener/QueryStringInitializerSubscriberTest.php

@@ -22,7 +22,7 @@ public function testQueryStringPropsInitialization()
     {
         $this->browser()
             ->throwExceptions()
-            ->get('/render-template/render_component_with_url_bound_props?prop1=foo&prop2=42&prop3[]=foo&prop3[]=bar&prop4=unbound&prop5[address]=foo&prop5[city]=bar&field6=foo&prop7=foo')
+            ->get('/render-template/render_component_with_url_bound_props?prop1=foo&prop2=42&prop3[]=foo&prop3[]=bar&prop4=unbound&prop5[address]=foo&prop5[city]=bar&field6=foo&field7=foo&prop8=foo')
             ->assertSuccessful()
             ->assertContains('Prop1: foo')
             ->assertContains('Prop2: 42')
@@ -31,6 +31,7 @@ public function testQueryStringPropsInitialization()
             ->assertContains('Prop5: address: foo city: bar')
             ->assertContains('Prop6: foo')
             ->assertContains('Prop7: foo')
+            ->assertContains('Prop8: foo')
         ;
     }
 }

src/LiveComponent/tests/Functional/Metadata/LiveComponentMetadataFactoryTest.php

@@ -41,5 +41,9 @@ public function testQueryStringMapping()
         $this->assertTrue($propsMetadataByName['prop5']->queryStringMapping());
 
         $this->assertTrue($propsMetadataByName['prop6']->queryStringMapping());
+
+        $this->assertTrue($propsMetadataByName['prop7']->queryStringMapping());
+
+        $this->assertFalse($propsMetadataByName['prop8']->queryStringMapping());
     }
 }