silva
/
adrema
2
1
Fork 0
Code Issues 23 Pull Requests 1 Projects 1 Releases 106 Wiki Activity

--wip-- [skip ci]

This commit is contained in:
philipp lang 2025-06-23 22:37:06 +02:00
parent 17ce78964a
commit 88487f0d39
7 changed files with 288 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
app/Form/Actions/GenerateContributionAction.php Normal file
View File

@ -0,0 +1,43 @@
<?php
namespace App\Form\Actions;
use App\Contribution\Contracts\HasContributionData;
use App\Contribution\ContributionFactory;
use App\Form\Models\Form;
use App\Rules\JsonBase64Rule;
use Illuminate\Http\JsonResponse;
use Lorisleiva\Actions\ActionRequest;
use Lorisleiva\Actions\Concerns\AsAction;
use Zoomyboy\Tex\BaseCompiler;
use Zoomyboy\Tex\Tex;
class GenerateContributionAction
{
use AsAction;
public function handle(HasContributionData $request): BaseCompiler
{
return Tex::compile($request->type()::fromPayload($request));
}
public function asController(ActionRequest $request, Form $form): BaseCompiler|JsonResponse
{
app(ContributionFactory::class)->validateType($form);
$form->validateContribution();
return $request->input('validate')
? response()->json([])
: $this->handle($form);
}
/**
* @return array<string, mixed>
*/
public function rules(): array
{
return [
'payload' => [new JsonBase64Rule()],
];
}
}

7
app/Form/Data/FieldCollection.php
View File

@ -114,7 +114,12 @@ class FieldCollection extends Collection
return $this->map(fn ($field) => $field->presentRaw())->toArray();
}
private function findBySpecialType(SpecialType $specialType): ?Field
public function hasSpecialType(SpecialType $specialType): bool
{
return $this->findBySpecialType($specialType) !== null;
}
public function findBySpecialType(SpecialType $specialType): ?Field
{
return $this->first(fn ($field) => $field->specialType === $specialType);
}

6
app/Form/Enums/SpecialType.php
View File

@ -7,6 +7,12 @@ enum SpecialType: string
case FIRSTNAME = 'Vorname';
case LASTNAME = 'Nachname';
case EMAIL = 'E-Mail-Adresse';
case BIRTHDAY = 'Geburtsdatum';
case ZIP = 'PLZ';
case LOCATION = 'Ort';
case ADDRESS = 'Adresse';
case GENDER = 'Geschlecht';
case LEADER = 'LeiterIn';
/**
* @return array<int, array{name: string, id: string}>

112
app/Form/Models/Form.php
View File

@ -2,18 +2,25 @@
namespace App\Form\Models;
use App\Contribution\Contracts\HasContributionData;
use App\Contribution\Data\MemberData;
use App\Country;
use App\Form\Actions\UpdateParticipantSearchIndexAction;
use App\Form\Data\ExportData;
use App\Form\Data\FieldCollection;
use App\Form\Data\FormConfigData;
use App\Form\Enums\SpecialType;
use App\Lib\Editor\Condition;
use App\Lib\Editor\EditorData;
use App\Lib\Sorting;
use Carbon\Carbon;
use Cviebrock\EloquentSluggable\Sluggable;
use Database\Factories\Form\Models\FormFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Collection;
use Illuminate\Validation\ValidationException;
use Laravel\Scout\Searchable;
use Spatie\Image\Enums\Fit;
use Spatie\MediaLibrary\HasMedia;
@ -22,7 +29,7 @@ use Spatie\MediaLibrary\MediaCollections\Models\Media;
use Zoomyboy\MedialibraryHelper\DefersUploads;
/** @todo replace editor content with EditorData cast */
class Form extends Model implements HasMedia
class Form extends Model implements HasMedia, HasContributionData
{
/** @use HasFactory<FormFactory> */
use HasFactory;
@ -74,20 +81,20 @@ class Form extends Model implements HasMedia
{
$this->addMediaCollection('headerImage')
->singleFile()
->maxWidth(fn () => 500)
->forceFileName(fn (Form $model, string $name) => $model->slug)
->convert(fn () => 'jpg')
->maxWidth(fn() => 500)
->forceFileName(fn(Form $model, string $name) => $model->slug)
->convert(fn() => 'jpg')
->registerMediaConversions(function (Media $media) {
$this->addMediaConversion('square')->fit(Fit::Crop, 400, 400);
});
$this->addMediaCollection('mailattachments')
->withDefaultProperties(fn () => [
->withDefaultProperties(fn() => [
'conditions' => [
'mode' => 'all',
'ifs' => []
],
])
->withPropertyValidation(fn () => [
->withPropertyValidation(fn() => [
'conditions.mode' => 'required|string|in:all,any',
'conditions.ifs' => 'array',
'conditions.ifs.*.field' => 'required',
@ -101,7 +108,7 @@ class Form extends Model implements HasMedia
*/
public function getRegistrationRules(): array
{
return $this->getFields()->reduce(fn ($carry, $field) => [
return $this->getFields()->reduce(fn($carry, $field) => [
...$carry,
...$field->getRegistrationRules($this),
], []);
@ -112,7 +119,7 @@ class Form extends Model implements HasMedia
*/
public function getRegistrationMessages(): array
{
return $this->getFields()->reduce(fn ($carry, $field) => [
return $this->getFields()->reduce(fn($carry, $field) => [
...$carry,
...$field->getRegistrationMessages($this),
], []);
@ -123,7 +130,7 @@ class Form extends Model implements HasMedia
*/
public function getRegistrationAttributes(): array
{
return $this->getFields()->reduce(fn ($carry, $field) => [
return $this->getFields()->reduce(fn($carry, $field) => [
...$carry,
...$field->getRegistrationAttributes($this),
], []);
@ -201,4 +208,91 @@ class Form extends Model implements HasMedia
return true;
}
public function payload(): array
{
return [
'dateFrom' => $this->dateFrom()->format('Y-m-d'),
'eventName' => $this->name,
'members' => [],
];
}
/**
* @return class-string<ContributionDocument>
*/
public function type(): string
{
return request()->input('type');
}
public function dateFrom(): Carbon
{
return now();
}
public function dateUntil(): Carbon
{
return now();
}
public function zipLocation(): string
{
return '';
}
public function eventName(): string
{
return $this->name;
}
public function members(): Collection
{
$members = [];
$fields = [
[SpecialType::FIRSTNAME, 'firstname'],
[SpecialType::LASTNAME, 'lastname'],
[SpecialType::BIRTHDAY, 'birthday'],
[SpecialType::ADDRESS, 'address'],
[SpecialType::ZIP, 'zip'],
[SpecialType::LOCATION, 'location']
];
foreach ($this->participants as $participant) {
$member = [];
foreach ($fields as [$type, $name]) {
$f = $this->getFields()->findBySpecialType($type);
$member[$name] = $participant->getFields()->find($f)->value;
}
$members[] = [
'is_leader' => false,
'gender' => null,
...$member,
];
}
return MemberData::fromApi($members);
}
public function country(): ?Country
{
return Country::first();
}
public function validateContribution(): void
{
$messages = [];
foreach ($this->type()::requiredFormSpecialTypes() as $type) {
if (!$this->getFields()->hasSpecialType($type)) {
$messages[$type->name] = 'Kein Feld für ' . $type->value . ' vorhanden.';
}
}
if ($this->participants->count() === 0) {
$messages['participants'] = 'Veranstaltung besitzt noch keine Teilnehmer*innen.';
}
throw_unless(empty($messages), ValidationException::withMessages($messages));
}
}

4
docker-compose.yml
View File

@ -92,6 +92,8 @@ services:
socketi:
image: quay.io/soketi/soketi:89604f268623cf799573178a7ba56b7491416bde-16-debian
ports:
- "6001:6001"
environment:
SOKETI_DEFAULT_APP_ID: adremaid
SOKETI_DEFAULT_APP_KEY: adremakey
@ -104,6 +106,8 @@ services:
meilisearch:
image: getmeili/meilisearch:v1.6
ports:
- "7700:7700"
volumes:
- ./data/meilisearch:/meili_data
env_file:

10
tests/Datasets/contribution.php
View File

@ -100,3 +100,13 @@ dataset('contribution-assertions', fn () => [
[BdkjHesse::class, ["Max", "Muster", "Jane"]],
[WuppertalDocument::class, ["Max", "Muster", "Jane", "42777 SG", "15.06.1991", "16.06.1991"]],
]);
dataset('contribution-documents', fn () => [
CitySolingenDocument::class,
RdpNrwDocument::class,
CityRemscheidDocument::class,
CityFrankfurtMainDocument::class,
BdkjHesse::class,
WuppertalDocument::class,
]);

116
tests/Feature/Form/GenerateContributionTest.php Normal file
View File

@ -0,0 +1,116 @@
<?php
namespace Tests\Feature\Form;
use App\Contribution\Documents\CitySolingenDocument;
use App\Contribution\Documents\RdpNrwDocument;
use App\Form\Enums\SpecialType;
use App\Form\Models\Form;
use App\Form\Models\Participant;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Tests\Lib\CreatesFormFields;
use Zoomyboy\Tex\Tex;
uses(DatabaseTransactions::class);
uses(CreatesFormFields::class);
/**
* @param array<int, FormtemplateFieldRequest> $fields
*/
it('doesnt create document when no special fields given', function (array $fields, string $field, string $message, string $type) {
$this->login()->loginNami();
$form = Form::factory()
->fields($fields)
->has(Participant::factory())
->create();
$this->json('GET', route('form.contribution', [
'type' => $type,
'form' => $form,
'validate' => '1',
]))->assertJsonValidationErrors([$field => $message]);
})
->with([
[fn () => [], 'FIRSTNAME', 'Kein Feld für Vorname vorhanden.'],
[fn () => [test()->textField('f')->specialType(SpecialType::FIRSTNAME)], 'LASTNAME', 'Kein Feld für Nachname vorhanden.'],
[fn () => [test()->textField('f')->specialType(SpecialType::FIRSTNAME), test()->textField('l')->specialType(SpecialType::LASTNAME)], 'BIRTHDAY', 'Kein Feld für Geburtsdatum vorhanden.'],
[fn () => [test()->textField('f')->specialType(SpecialType::FIRSTNAME), test()->textField('l')->specialType(SpecialType::LASTNAME), test()->dateField('b')->specialType(SpecialType::BIRTHDAY)], 'ZIP', 'Kein Feld für PLZ vorhanden.'],
[fn () => [test()->textField('f')->specialType(SpecialType::FIRSTNAME), test()->textField('l')->specialType(SpecialType::LASTNAME), test()->dateField('b')->specialType(SpecialType::BIRTHDAY), test()->dateField('p')->specialType(SpecialType::ZIP)], 'LOCATION', 'Kein Feld für Ort vorhanden.'],
])->with('contribution-documents');
/**
* @param array<int, FormtemplateFieldRequest> $fields
*/
it('validates special types of each document', function (string $type, array $fields, string $field, string $message) {
$this->login()->loginNami();
$form = Form::factory()->fields([
test()->textField('f')->specialType(SpecialType::FIRSTNAME),
test()->textField('l')->specialType(SpecialType::LASTNAME),
test()->dateField('b')->specialType(SpecialType::BIRTHDAY),
test()->dateField('p')->specialType(SpecialType::ZIP),
test()->dateField('l')->specialType(SpecialType::LOCATION),
...$fields,
])
->has(Participant::factory())
->create();
$this->json('GET', route('form.contribution', [
'type' => $type,
'form' => $form,
'validate' => '1',
]))->assertJsonValidationErrors([$field => $message]);
})
->with([
[CitySolingenDocument::class, [], 'ADDRESS', 'Kein Feld für Adresse vorhanden.'],
[RdpNrwDocument::class, [], 'GENDER', 'Kein Feld für Geschlecht vorhanden.'],
]);
it('throws error when not validating but fields are not present', function () {
$this->login()->loginNami();
$form = Form::factory()->fields([])
->has(Participant::factory())
->create();
$this->json('GET', route('form.contribution', [
'type' => CitySolingenDocument::class,
'form' => $form,
]))->assertStatus(422);
});
it('throws error when form doesnt have participants', function () {
$this->login()->loginNami();
$form = Form::factory()->fields([])->create();
$this->json('GET', route('form.contribution', [
'type' => CitySolingenDocument::class,
'form' => $form,
'validate' => '1',
]))->assertJsonValidationErrors(['participants' => 'Veranstaltung besitzt noch keine Teilnehmer*innen.']);
});
it('creates document when fields are present', function () {
Tex::spy();
$this->login()->loginNami();
$form = Form::factory()->fields([
test()->textField('fn')->specialType(SpecialType::FIRSTNAME),
test()->textField('ln')->specialType(SpecialType::LASTNAME),
test()->dateField('bd')->specialType(SpecialType::BIRTHDAY),
test()->dateField('zip')->specialType(SpecialType::ZIP),
test()->dateField('loc')->specialType(SpecialType::LOCATION),
test()->dateField('add')->specialType(SpecialType::ADDRESS),
])
->has(Participant::factory()->data(['fn' => 'Baum', 'ln' => 'Muster', 'bd' => '1991-05-06', 'zip' => '33333', 'loc' => 'Musterstadt', 'add' => 'Laastr 4']))
->create();
$this->json('GET', route('form.contribution', [
'type' => CitySolingenDocument::class,
'form' => $form,
]))->assertOk();
Tex::assertCompiled(CitySolingenDocument::class, fn ($document) => $document->hasAllContent(['Baum', 'Muster', '1991', 'Musterstadt', 'Laastr 4', '33333']));
});