refactor: replace with text block type

impress-org · Jan 24, 2025 · 64ae975 · 64ae975
1 parent 2ce51ba
commit 64ae975
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 11 deletions.
diff --git a/src/DonationForms/Actions/ConvertDonationFormBlocksToFieldsApi.php b/src/DonationForms/Actions/ConvertDonationFormBlocksToFieldsApi.php
@@ -2,6 +2,7 @@
 
 namespace Give\DonationForms\Actions;
 
+use Exception;
 use Give\DonationForms\Repositories\DonationFormRepository;
 use Give\DonationForms\Rules\AuthenticationRule;
 use Give\DonationForms\Rules\BillingAddressCityRule;
@@ -10,6 +11,7 @@
 use Give\DonationForms\Rules\GatewayRule;
 use Give\DonationForms\Rules\PhoneIntlInputRule;
 use Give\FormBuilder\BlockModels\DonationAmountBlockModel;
+use Give\FormBuilder\BlockTypes\TextBlockType;
 use Give\Framework\Blocks\BlockCollection;
 use Give\Framework\Blocks\BlockModel;
 use Give\Framework\FieldsAPI\Authentication;
@@ -129,6 +131,7 @@ protected function convertInnerBlockToNode(BlockModel $block, int $blockIndex)
     }
 
     /**
+     * @unreleased updated to use TextBlockType
      * @since 3.19.4 add max rule to company field
      * @since 3.9.0 Add "givewp/donor-phone" block
      * @since 3.0.0
@@ -137,6 +140,7 @@ protected function convertInnerBlockToNode(BlockModel $block, int $blockIndex)
      * @throws NameCollisionException
      *
      * @throws EmptyNameException
+     * @throws Exception
      */
     protected function createNodeFromBlockWithUniqueAttributes(BlockModel $block, int $blockIndex)
     {
@@ -195,15 +199,13 @@ protected function createNodeFromBlockWithUniqueAttributes(BlockModel $block, in
             case "givewp/company":
                 return Text::make('company')->rules('max:255');
 
-            case "givewp/text":
-                return Text::make(
-                    $block->hasAttribute('fieldName') ?
-                        $block->getAttribute('fieldName') :
-                        $block->getShortName() . '-' . $blockIndex
-                )->storeAsDonorMeta(
-                    $block->hasAttribute('storeAsDonorMeta') ? $block->getAttribute('storeAsDonorMeta') : false
-                )->description($block->getAttribute('description'))
-                    ->defaultValue($block->getAttribute('defaultValue'));
+            case TextBlockType::name():
+                $textBlockType = new TextBlockType($block);
+
+                return Text::make($textBlockType->getFieldName($blockIndex))
+                    ->storeAsDonorMeta($textBlockType->storeAsDonorMeta)
+                    ->description($textBlockType->description)
+                    ->defaultValue($textBlockType->defaultValue);
 
             case "givewp/terms-and-conditions":
                 return $this->createNodeFromConsentBlock($block, $blockIndex)

diff --git a/src/FormBuilder/BlockTypes/TextBlockType.php b/src/FormBuilder/BlockTypes/TextBlockType.php
@@ -19,4 +19,12 @@ public static function name(): string
     {
         return 'givewp/text';
     }
+
+    /**
+     * @unreleased
+     */
+    public function getFieldName(int $blockIndex): string
+    {
+        return !empty($this->fieldName) ? $this->fieldName : $this->block->getShortName() . '-' . $blockIndex;
+    }
 }
diff --git a/tests/Unit/FormBuilder/BlockTypes/TestTextBlockType.php b/tests/Unit/FormBuilder/BlockTypes/TestTextBlockType.php
@@ -3,6 +3,7 @@
 namespace Give\Tests\Unit\FormBuilder\BlockTypes;
 
 use Exception;
+use Give\FormBuilder\BlockTypes\TextBlockType;
 use Give\Framework\Blocks\BlockModel;
 use Give\Tests\TestCase;
 use Give\Tests\TestTraits\RefreshDatabase;
@@ -26,7 +27,7 @@ public function testNameShouldMatch(): void
             ]
         );
 
-        $blockType = new \Give\FormBuilder\BlockTypes\TextBlockType($blockModel);
+        $blockType = new TextBlockType($blockModel);
 
         $this->assertSame('givewp/text', $blockType::name());
     }
@@ -67,7 +68,7 @@ public function testAttributesShouldMatchProperties(): void
             ]
         );
 
-        $blockType = new \Give\FormBuilder\BlockTypes\TextBlockType($blockModel);
+        $blockType = new TextBlockType($blockModel);
 
         $this->assertSame('Test Label', $blockType->label);
         $this->assertSame('Test Description', $blockType->description);
@@ -94,4 +95,44 @@ public function testAttributesShouldMatchProperties(): void
             $blockType->conditionalLogic
         );
     }
+
+    /**
+     * @unreleased
+     * @throws Exception
+     */
+    public function testGetFieldNameShouldReturnCustomName(): void
+    {
+        $blockModel = BlockModel::make(
+            [
+                'name' => 'givewp/text',
+                'attributes' => [
+                    'fieldName' => 'custom_field_name',
+                ]
+            ]
+        );
+
+        $blockType = new TextBlockType($blockModel);
+
+        $this->assertSame('custom_field_name', $blockType->getFieldName(1));
+    }
+
+    /**
+     * @unreleased
+     * @throws Exception
+     */
+    public function testGetFieldNameShouldReturnNameWithIndex()
+    {
+        $blockModel = BlockModel::make(
+            [
+                'name' => 'givewp/text',
+                'attributes' => [
+                    'fieldName' => '',
+                ]
+            ]
+        );
+
+        $blockType = new TextBlockType($blockModel);
+
+        $this->assertSame('text-1', $blockType->getFieldName(1));
+    }
 }