Fix #200: Don't enrich fields from rules with non-null "when" paramet…

…er (#209)
yiisoft · Jun 16, 2022 · 087da0f · 087da0f
1 parent 79bb78a
commit 087da0f
Show file tree

Hide file tree

Showing 33 changed files with 162 additions and 0 deletions.
diff --git a/src/Field/Base/DateTimeInputField.php b/src/Field/Base/DateTimeInputField.php
@@ -11,6 +11,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\Required;
 
 use function is_string;
@@ -148,6 +149,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Email.php b/src/Field/Email.php
@@ -13,6 +13,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Regex;
 use Yiisoft\Validator\Rule\Required;
@@ -209,6 +210,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/File.php b/src/Field/File.php
@@ -12,6 +12,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\Required;
 
 /**
@@ -161,6 +162,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Number.php b/src/Field/Number.php
@@ -14,6 +14,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\Number as NumberRule;
 use Yiisoft\Validator\Rule\Required;
 
@@ -169,6 +170,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Password.php b/src/Field/Password.php
@@ -13,6 +13,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Regex;
 use Yiisoft\Validator\Rule\Required;
@@ -200,6 +201,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Range.php b/src/Field/Range.php
@@ -12,6 +12,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\Number as NumberRule;
 use Yiisoft\Validator\Rule\Required;
 
@@ -197,6 +198,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Select.php b/src/Field/Select.php
@@ -14,6 +14,7 @@
 use Yiisoft\Html\Tag\Optgroup;
 use Yiisoft\Html\Tag\Option;
 use Yiisoft\Html\Tag\Select as SelectTag;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\Required;
 
 /**
@@ -249,6 +250,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Telephone.php b/src/Field/Telephone.php
@@ -13,6 +13,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Regex;
 use Yiisoft\Validator\Rule\Required;
@@ -195,6 +196,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Text.php b/src/Field/Text.php
@@ -13,6 +13,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Regex;
 use Yiisoft\Validator\Rule\Required;
@@ -211,6 +212,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Textarea.php b/src/Field/Textarea.php
@@ -13,6 +13,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Required;
 
@@ -225,6 +226,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/src/Field/Url.php b/src/Field/Url.php
@@ -13,6 +13,7 @@
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
 use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
 use Yiisoft\Html\Html;
+use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Regex;
 use Yiisoft\Validator\Rule\Required;
@@ -196,6 +197,10 @@ protected function beforeRender(): void
         if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
             $rules = $this->getFormModel()->getRules()[$this->getFormAttributeName()] ?? [];
             foreach ($rules as $rule) {
+                if ($rule instanceof BeforeValidationInterface && $rule->getWhen() !== null) {
+                    continue;
+                }
+
                 if ($rule instanceof Required) {
                     $this->inputAttributes['required'] = true;
                 }

diff --git a/tests/Field/Base/DateTimeInputFieldTest.php b/tests/Field/Base/DateTimeInputFieldTest.php
@@ -189,6 +189,23 @@ public function testEnrichmentFromRules(): void
         $this->assertSame($expected, $result);
     }
 
+    public function testEnrichmentFromRulesWithWhen(): void
+    {
+        $result = StubDateTimeInputField::widget()
+            ->formAttribute(new DateForm(), 'second')
+            ->hideLabel()
+            ->enrichmentFromRules(true)
+            ->render();
+
+        $expected = <<<HTML
+            <div>
+            <input type="datetime" id="dateform-second" name="DateForm[second]">
+            </div>
+            HTML;
+
+        $this->assertSame($expected, $result);
+    }
+
     public function testInvalidValue(): void
     {
         $widget = StubDateTimeInputField::widget()

diff --git a/tests/Field/EmailTest.php b/tests/Field/EmailTest.php
@@ -268,6 +268,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="email" id="emailform-nocode" name="EmailForm[nocode]">',
                 'nocode',
             ],
+            'required-with-when' => [
+                '<input type="email" id="emailform-requiredwhen" name="EmailForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/FileTest.php b/tests/Field/FileTest.php
@@ -248,6 +248,23 @@ public function testEnrichmentFromRules(): void
         $this->assertSame($expected, $result);
     }
 
+    public function testEnrichmentFromRulesWithWhen(): void
+    {
+        $result = File::widget()
+            ->formAttribute(new FileForm(), 'photo')
+            ->hideLabel()
+            ->enrichmentFromRules(true)
+            ->render();
+
+        $expected = <<<HTML
+            <div>
+            <input type="file" id="fileform-photo" name="FileForm[photo]">
+            </div>
+            HTML;
+
+        $this->assertSame($expected, $result);
+    }
+
     public function testInvalidValue(): void
     {
         $field = File::widget()

diff --git a/tests/Field/NumberTest.php b/tests/Field/NumberTest.php
@@ -300,6 +300,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="number" id="numberform-step" name="NumberForm[step]" min="5" max="95">',
                 'step',
             ],
+            'required-with-when' => [
+                '<input type="number" id="numberform-requiredwhen" name="NumberForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/PasswordTest.php b/tests/Field/PasswordTest.php
@@ -230,6 +230,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="password" id="passwordform-nocode" name="PasswordForm[nocode]">',
                 'nocode',
             ],
+            'required-with-when' => [
+                '<input type="password" id="passwordform-requiredwhen" name="PasswordForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/RangeTest.php b/tests/Field/RangeTest.php
@@ -352,6 +352,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="range" id="rangeform-count" name="RangeForm[count]" min="1" max="9">',
                 'count',
             ],
+            'required-with-when' => [
+                '<input type="range" id="rangeform-requiredwhen" name="RangeForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/SelectTest.php b/tests/Field/SelectTest.php
@@ -596,6 +596,25 @@ public function testEnrichmentFromRules(): void
         $this->assertSame($expected, $result);
     }
 
+    public function testEnrichmentFromRulesWithWhen(): void
+    {
+        $result = Select::widget()
+            ->formAttribute(new SelectForm(), 'requiredWhen')
+            ->optionsData(['red' => 'Red'])
+            ->enrichmentFromRules(true)
+            ->hideLabel()
+            ->useContainer(false)
+            ->render();
+
+        $expected = <<<HTML
+            <select id="selectform-requiredwhen" name="SelectForm[requiredWhen]">
+            <option value="red">Red</option>
+            </select>
+            HTML;
+
+        $this->assertSame($expected, $result);
+    }
+
     public function testImmutability(): void
     {
         $field = Select::widget();

diff --git a/tests/Field/TelephoneTest.php b/tests/Field/TelephoneTest.php
@@ -220,6 +220,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="tel" id="telephoneform-nocode" name="TelephoneForm[nocode]">',
                 'nocode',
             ],
+            'required-with-when' => [
+                '<input type="tel" id="telephoneform-requiredwhen" name="TelephoneForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/TextTest.php b/tests/Field/TextTest.php
@@ -672,6 +672,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="text" id="textform-nocode" name="TextForm[nocode]" value>',
                 'nocode',
             ],
+            'required-with-when' => [
+                '<input type="text" id="textform-requiredwhen" name="TextForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/TextareaTest.php b/tests/Field/TextareaTest.php
@@ -251,6 +251,10 @@ public function dataEnrichmentFromRules(): array
                 '<textarea id="textareaform-shortdesc" name="TextareaForm[shortdesc]" maxlength="199" minlength="10"></textarea>',
                 'shortdesc',
             ],
+            'required-with-when' => [
+                '<textarea id="textareaform-requiredwhen" name="TextareaForm[requiredWhen]"></textarea>',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Field/UrlTest.php b/tests/Field/UrlTest.php
@@ -254,6 +254,10 @@ public function dataEnrichmentFromRules(): array
                 '<input type="url" id="urlform-beach2" name="UrlForm[beach2]" value pattern="^((?i)http|https):\/\/(([a-zA-Z0-9][a-zA-Z0-9_-]*)(\.[a-zA-Z0-9][a-zA-Z0-9_-]*)+)(?::\d{1,5})?([?\/#].*$|$)">',
                 'beach2',
             ],
+            'required-with-when' => [
+                '<input type="url" id="urlform-requiredwhen" name="UrlForm[requiredWhen]">',
+                'requiredWhen',
+            ],
         ];
     }
 

diff --git a/tests/Support/Form/DateForm.php b/tests/Support/Form/DateForm.php
@@ -13,12 +13,14 @@ final class DateForm extends FormModel
     private ?string $startDate = null;
     private ?string $endDate = null;
     private ?string $main = null;
+    private ?string $second = null;
     private int $age = 42;
 
     public function getRules(): array
     {
         return [
             'main' => [new Required()],
+            'second' => [new Required(when: static fn () => false)],
         ];
     }