[5.x] Make it possible to add to form configuration screen

src/Forms/Form.php

@@ -7,6 +7,7 @@
 use Statamic\Contracts\Data\Augmented;
 use Statamic\Contracts\Forms\Form as FormContract;
 use Statamic\Contracts\Forms\Submission;
+use Statamic\Data\ContainsData;
 use Statamic\Data\HasAugmentedInstance;
 use Statamic\Events\FormBlueprintFound;
 use Statamic\Events\FormCreated;
@@ -27,7 +28,7 @@
 
 class Form implements Arrayable, Augmentable, FormContract
 {
-    use FluentlyGetsAndSets, HasAugmentedInstance;
+    use ContainsData, FluentlyGetsAndSets, HasAugmentedInstance;
 
     protected $handle;
     protected $title;
@@ -39,6 +40,11 @@ class Form implements Arrayable, Augmentable, FormContract
     protected $afterSaveCallbacks = [];
     protected $withEvents = true;
 
+    public function __construct()
+    {
+        $this->data = collect();
+    }
+
     /**
      * Get or set the handle.
      *
@@ -184,7 +190,7 @@ public function save()
             }
         }
 
-        $data = collect([
+        $data = $this->data->merge(collect([
             'title' => $this->title,
             'honeypot' => $this->honeypot,
             'email' => collect(isset($this->email['to']) ? [$this->email] : $this->email)->map(function ($email) {
@@ -194,7 +200,7 @@ public function save()
                 return Arr::removeNullValues($email);
             })->all(),
             'metrics' => $this->metrics,
-        ])->filter()->all();
+        ]))->filter()->all();
 
         if ($this->store === false) {
             $data['store'] = false;
@@ -234,14 +240,20 @@ public function delete()
      */
     public function hydrate()
     {
-        collect(YAML::parse(File::get($this->path())))
-            ->filter(function ($value, $property) {
-                return in_array($property, [
-                    'title',
-                    'honeypot',
-                    'store',
-                    'email',
-                ]);
+        $contents = YAML::parse(File::get($this->path()));
+
+        $methods = [
+            'title',
+            'honeypot',
+            'store',
+            'email',
+        ];
+
+        $this->merge(collect($contents)->except($methods));
+
+        collect($contents)
+            ->filter(function ($value, $property) use ($methods) {
+                return in_array($property, $methods);
             })
             ->each(function ($value, $property) {
                 $this->{$property}($value);

src/Forms/FormRepository.php

@@ -9,9 +9,12 @@
 use Statamic\Facades\File;
 use Statamic\Facades\Folder;
 use Statamic\Forms\Exporters\ExporterRepository;
+use Statamic\Support\Arr;
+use Statamic\Support\Str;
 
 class FormRepository implements Contract
 {
+    private $configs = [];
     private $redirects = [];
 
     /**
@@ -70,6 +73,37 @@ public function make($handle = null)
         return $form;
     }
 
+    public function appendConfigFields($handles, string $display, array $fields)
+    {
+        $this->configs[] = [
+            'display' => $display,
+            'handles' => Arr::wrap($handles),
+            'fields' => $fields,
+        ];
+    }
+
+    public function getConfigFor($handle)
+    {
+        $reserved = ['title', 'honeypot', 'store', 'email'];
+
+        return collect($this->configs)
+            ->filter(function ($config) use ($handle) {
+                return in_array('*', $config['handles']) || in_array($handle, $config['handles']);
+            })
+            ->flatMap(function ($config) use ($reserved) {
+
+                return [
+                    Str::slugify($config['display']) => [
+                        'display' => $config['display'],
+                        'fields' => collect($config['fields'])
+                            ->filter(fn ($field, $index) => ! in_array($field['handle'] ?? $index, $reserved))
+                            ->all(),
+                    ],
+                ];
+            })
+            ->all();
+    }
+
     public function redirect(string $form, Closure $callback)
     {
         $this->redirects[$form] = $callback;

src/Http/Controllers/CP/Forms/FormsController.php

@@ -139,13 +139,13 @@ public function edit($form)
     {
         $this->authorize('edit', $form);
 
-        $values = [
+        $values = array_merge($form->data()->all(), [
             'handle' => $form->handle(),
             'title' => $form->title(),
             'honeypot' => $form->honeypot(),
             'store' => $form->store(),
             'email' => $form->email(),
-        ];
+        ]);
 
         $fields = ($blueprint = $this->editFormBlueprint($form))
             ->fields()
@@ -170,11 +170,14 @@ public function update($form, Request $request)
 
         $values = $fields->process()->values()->all();
 
+        $data = collect($values)->except(['title', 'honeypot', 'store', 'email']);
+
         $form
             ->title($values['title'])
             ->honeypot($values['honeypot'])
             ->store($values['store'])
-            ->email($values['email']);
+            ->email($values['email'])
+            ->merge($data);
 
         $form->save();
 
@@ -190,7 +193,7 @@ public function destroy($form)
 
     protected function editFormBlueprint($form)
     {
-        return Blueprint::makeFromTabs([
+        $fields = array_merge([
             'name' => [
                 'display' => __('Name'),
                 'fields' => [
@@ -312,6 +315,10 @@ protected function editFormBlueprint($form)
             ],
 
             // metrics
-        ]);
+            // ...
+
+        ], Form::getConfigFor($form->handle()));
+
+        return Blueprint::makeFromTabs($fields);
     }
 }

tests/Feature/Forms/UpdateFormTest.php

@@ -107,6 +107,39 @@ public function it_updates_emails()
         ], $updated->email());
     }
 
+    /** @test */
+    public function it_updates_data()
+    {
+        $form = tap(Form::make('test'))->save();
+        $this->assertNull($form->email());
+
+        Form::appendConfigFields('*', 'Test Config', [
+            'another_config' => [
+                'handle' => 'another_config',
+                'field' => [
+                    'type' => 'text',
+                ],
+            ],
+            'some_config' => [
+                'handle' => 'some_config',
+                'field' => [
+                    'type' => 'text',
+                ],
+            ],
+        ]);
+
+        $this
+            ->actingAs($this->userWithPermission())
+            ->update($form, ['some_config' => 'foo', 'another_config' => 'bar'])
+            ->assertOk();
+
+        $updated = Form::all()->first();
+        $this->assertEquals([
+            'another_config' => 'bar',
+            'some_config' => 'foo',
+        ], $updated->data()->all());
+    }
+
     private function userWithoutPermission()
     {
         $this->setTestRoles(['test' => ['access cp']]);

tests/Forms/FormRepositoryTest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Tests\Forms;
+
+use Statamic\Facades\Form;
+use Tests\TestCase;
+
+class FormRepositoryTest extends TestCase
+{
+    /** @test */
+    public function it_registers_config()
+    {
+        Form::appendConfigFields('test_form', 'Test Config', [
+            'another_config' => [
+                'handle' => 'another_config',
+                'field' => [
+                    'type' => 'text',
+                ],
+            ],
+            'some_config' => [
+                'handle' => 'some_config',
+                'field' => [
+                    'type' => 'text',
+                ],
+            ],
+        ]);
+
+        $this->assertNotNull(Form::getConfigFor('test_form'));
+        $this->assertEmpty(Form::getConfigFor('another_form'));
+    }
+
+    /** @test */
+    public function it_registers_wildcard_config()
+    {
+        Form::appendConfigFields('*', 'Test Config', [
+            'another_config' => [
+                'handle' => 'another_config',
+                'field' => [
+                    'type' => 'text',
+                ],
+            ],
+            'some_config' => [
+                'handle' => 'some_config',
+                'field' => [
+                    'type' => 'text',
+                ],
+            ],
+        ]);
+
+        $this->assertNotNull(Form::getConfigFor('test_form'));
+        $this->assertNotNull(Form::getConfigFor('another_form'));
+    }
+}

tests/Forms/FormTest.php

@@ -30,13 +30,21 @@ public function it_saves_a_form()
 
         $form = Form::make('contact_us')
             ->title('Contact Us')
-            ->honeypot('winnie');
+            ->honeypot('winnie')
+            ->data([
+                'foo' => 'bar',
+                'roo' => 'rar',
+            ]);
 
         $form->save();
 
         $this->assertEquals('contact_us', $form->handle());
         $this->assertEquals('Contact Us', $form->title());
         $this->assertEquals('winnie', $form->honeypot());
+        $this->assertEquals([
+            'foo' => 'bar',
+            'roo' => 'rar',
+        ], $form->data()->all());
 
         Event::assertDispatched(FormCreating::class, function ($event) use ($form) {
             return $event->form === $form;