Add yearly mail

This commit is contained in:
philipp lang 2025-05-28 21:57:31 +02:00
parent 196b81a82d
commit 4f21dfceee
12 changed files with 276 additions and 44 deletions

View File

@ -33,7 +33,7 @@ class PreventionRememberAction
continue;
}
if ($participant->getFields()->getMailRecipient() === null || count($participant->preventions()) === 0) {
if ($participant->getFields()->getMailRecipient() === null || $participant->preventions()->count() === 0) {
continue;
}

View File

@ -14,6 +14,7 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Mail;
use Laravel\Scout\Searchable;
use stdClass;
@ -81,17 +82,12 @@ class Participant extends Model implements Preventable
Mail::to($this->getMailRecipient())->queue(new ConfirmRegistrationMail($this));
}
public function preventableLayout(): string
{
return 'mail.prevention.prevention-remember-participant';
}
/**
* @inheritdoc
*/
public function preventions(): array
public function preventions(): Collection
{
return $this->member?->preventions($this->form->from) ?: [];
return $this->member?->preventions($this->form->from) ?: collect([]);
}
public function getMailRecipient(): ?stdClass

View File

@ -13,6 +13,8 @@ use App\Nami\HasNamiField;
use App\Nationality;
use App\Payment\Subscription;
use App\Pdf\Sender;
use App\Prevention\Contracts\Preventable;
use App\Prevention\Data\PreventionData;
use App\Region;
use App\Setting\NamiSettings;
use Carbon\Carbon;
@ -35,12 +37,14 @@ use Zoomyboy\Phone\HasPhoneNumbers;
use App\Prevention\Enums\Prevention;
use Database\Factories\Member\MemberFactory;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Support\Collection;
use stdClass;
/**
* @property string $subscription_name
* @property int $pending_payment
*/
class Member extends Model implements Geolocatable
class Member extends Model implements Geolocatable, Preventable
{
use Notifiable;
use HasNamiField;
@ -194,6 +198,20 @@ class Member extends Model implements Geolocatable
return (int) $this->invoicePositions()->whereHas('invoice', fn($query) => $query->whereNeedsPayment())->sum('price');
}
public function getMailRecipient(): ?stdClass
{
if (!$this->fullname) {
return null;
}
return (object) ['name' => $this->fullname, 'email' => $this->email];
}
public function preventableSubject(): string
{
return 'Nachweise erforderlich';
}
// ---------------------------------- Relations ----------------------------------
/**
* @return BelongsTo<Country, $this>
@ -364,32 +382,47 @@ class Member extends Model implements Geolocatable
}
/**
* @return array<int, Prevention>
* @inheritdoc
*/
public function preventions(?Carbon $date = null): array
public function preventions(?Carbon $date = null): Collection
{
$date = $date ?: now();
/** @var array<int, Prevention> */
$preventions = [];
/** @var Collection<int, PreventionData> */
$preventions = collect([]);
if ($this->efz === null || $this->efz->diffInYears($date) >= 5) {
$preventions[] = Prevention::EFZ;
$preventions->push(PreventionData::from([
'type' => Prevention::EFZ,
'expires' => $this->efz === null ? now() : $this->efz->addYears(5)
]));
}
if (!$this->has_vk) {
$preventions[] = Prevention::VK;
$preventions->push(PreventionData::from([
'type' => Prevention::VK,
'expires' => now(),
]));
}
if ($this->more_ps_at === null) {
if ($this->ps_at === null) {
$preventions[] = Prevention::PS;
$preventions->push(PreventionData::from([
'type' => Prevention::PS,
'expires' => now(),
]));
} else if ($this->ps_at->diffInYears($date) >= 5) {
$preventions[] = Prevention::MOREPS;
$preventions->push(PreventionData::from([
'type' => Prevention::MOREPS,
'expires' => $this->ps_at->addYears(5),
]));
}
} else {
if ($this->more_ps_at === null || $this->more_ps_at->diffInYears($date) >= 5) {
$preventions[] = Prevention::MOREPS;
$preventions->push(PreventionData::from([
'type' => Prevention::MOREPS,
'expires' => $this->more_ps_at->addYears(5),
]));
}
}

View File

@ -0,0 +1,56 @@
<?php
namespace App\Prevention\Actions;
use App\Member\Member;
use App\Prevention\Data\PreventionData;
use App\Prevention\Mails\YearlyMail;
use App\Prevention\Models\PreventionHistory;
use App\Prevention\PreventionSettings;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Mail;
use Lorisleiva\Actions\Concerns\AsAction;
class YearlyRememberAction
{
use AsAction;
public string $commandSignature = 'prevention:remember-yearly';
public function handle(): void
{
$settings = app(PreventionSettings::class);
$expireDate = now()->addWeeks($settings->weeks);
foreach (Member::get() as $member) {
$noticePreventions = $member->preventions($expireDate)
->filter(fn($prevention) => $prevention->expiresAt($expireDate));
if ($noticePreventions->count() === 0) {
continue;
}
Mail::send($this->createMail($member, $noticePreventions));
}
foreach (Member::get() as $member) {
$preventions = $member->preventions()
->filter(fn($prevention) => $prevention->expiresAt(now()));
if ($preventions->count() === 0) {
continue;
}
Mail::send($this->createMail($member, $preventions));
}
}
/**
* @param Collection<int, PreventionData> $preventions
*/
protected function createMail(Member $member, Collection $preventions): YearlyMail
{
$body = app(PreventionSettings::class)->refresh()->formmail;
return new YearlyMail($member, $body, $preventions);
}
}

View File

@ -2,19 +2,19 @@
namespace App\Prevention\Contracts;
use App\Prevention\Enums\Prevention;
use App\Prevention\Data\PreventionData;
use Illuminate\Support\Collection;
use stdClass;
interface Preventable
{
public function preventableLayout(): string;
public function preventableSubject(): string;
/**
* @return array<int, Prevention>
* @return Collection<int, PreventionData>
*/
public function preventions(): array;
public function preventions(): Collection;
public function getMailRecipient(): ?stdClass;
}

View File

@ -0,0 +1,17 @@
<?php
namespace App\Prevention\Data;
use App\Prevention\Enums\Prevention;
use Carbon\Carbon;
use Spatie\LaravelData\Data;
class PreventionData extends Data
{
public function __construct(public Prevention $type, public Carbon $expires) {}
public function expiresAt(Carbon $date): bool
{
return $this->expires->isSameDay($date);
}
}

View File

@ -2,8 +2,6 @@
namespace App\Prevention\Enums;
use App\Member\Member;
use Carbon\Carbon;
use Illuminate\Support\Collection;
enum Prevention
@ -44,7 +42,7 @@ enum Prevention
*/
public static function items(array $preventions): Collection
{
return collect(static::cases())->map(fn ($case) => [
return collect(static::cases())->map(fn($case) => [
'letter' => $case->letter(),
'value' => !in_array($case, $preventions),
'tooltip' => $case->tooltip(!in_array($case, $preventions)),

View File

@ -25,7 +25,7 @@ class PreventionRememberMail extends Mailable
{
$this->settings = app(InvoiceSettings::class);
$this->bodyText = $this->bodyText
->replaceWithList('wanted', collect($preventable->preventions())->map(fn($prevention) => $prevention->text())->toArray());
->replaceWithList('wanted', collect($preventable->preventions())->map(fn($prevention) => $prevention->type->text())->toArray());
}
/**
@ -48,7 +48,7 @@ class PreventionRememberMail extends Mailable
public function content()
{
return new Content(
markdown: $this->preventable->preventableLayout(),
markdown: 'mail.prevention.prevention-remember-participant',
);
}

View File

@ -0,0 +1,68 @@
<?php
namespace App\Prevention\Mails;
use App\Invoice\InvoiceSettings;
use App\Lib\Editor\EditorData;
use App\Prevention\Contracts\Preventable;
use App\Prevention\Data\PreventionData;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Attachment;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Envelope;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Collection;
class YearlyMail extends Mailable
{
use Queueable, SerializesModels;
public InvoiceSettings $settings;
/**
* Create a new message instance.
*
* @param Collection<int, PreventionData> $preventions
*/
public function __construct(public Preventable $preventable, public EditorData $bodyText, public Collection $preventions)
{
$this->settings = app(InvoiceSettings::class);
$this->bodyText = $this->bodyText
->replaceWithList('wanted', collect($preventions)->pluck('type')->map(fn($prevention) => $prevention->text())->toArray());
}
/**
* Get the message envelope.
*
* @return \Illuminate\Mail\Mailables\Envelope
*/
public function envelope()
{
return (new Envelope(
subject: $this->preventable->preventableSubject(),
))->to($this->preventable->getMailRecipient()->email, $this->preventable->getMailRecipient()->name);
}
/**
* Get the message content definition.
*
* @return \Illuminate\Mail\Mailables\Content
*/
public function content()
{
return new Content(
markdown: 'mail.prevention.prevention-remember-participant',
);
}
/**
* Get the attachments for the message.
*
* @return array<int, Attachment>
*/
public function attachments(): array
{
return [];
}
}

View File

@ -10,6 +10,7 @@ class PreventionSettings extends LocalSettings
public EditorData $formmail;
public EditorData $yearlymail;
public int $weeks;
public static function group(): string
{

View File

@ -7,5 +7,6 @@ return new class extends SettingsMigration
public function up(): void
{
$this->migrator->add('prevention.yearlymail', ['time' => 1, 'blocks' => [], 'version' => '1.0']);
$this->migrator->add('prevention.weeks', 8);
}
};

View File

@ -13,14 +13,13 @@ use App\Lib\Editor\Condition;
use App\Prevention\Mails\PreventionRememberMail;
use App\Member\Member;
use App\Member\Membership;
use App\Prevention\Actions\YearlyRememberAction;
use App\Prevention\Mails\YearlyMail;
use App\Prevention\PreventionSettings;
use Generator;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Support\Facades\Mail;
use PHPUnit\Framework\Attributes\DataProvider;
use Tests\Lib\CreatesFormFields;
use Tests\RequestFactories\EditorRequestFactory;
use Tests\TestCase;
uses(DatabaseTransactions::class);
uses(CreatesFormFields::class);
@ -43,7 +42,17 @@ function createParticipant(Form $form): Participant
])->for(Member::factory()->defaults()->has(Membership::factory()->inLocal('€ LeiterIn', 'Wölfling')))->create();
}
function createMember(array $attributes): Member
{
return Member::factory()->defaults()->has(Membership::factory()->inLocal('€ LeiterIn', 'Wölfling'))->create($attributes);
}
dataset('attributes', fn() => [
[
['has_vk' => false, 'efz' => null, 'ps_at' => null],
[Prevention::EFZ, Prevention::VK, Prevention::PS]
],
[
['has_vk' => true, 'efz' => null, 'ps_at' => now()],
[Prevention::EFZ]
@ -174,7 +183,7 @@ it('testItDoesntRememberWhenParticipantDoesntHaveMember', function () {
$this->assertNull($participant->fresh()->last_remembered_at);
});
it('testItRemembersNonLeaders', function () {
it('doesnt remember non leaders', function () {
Mail::fake();
$form = createForm();
$participant = createParticipant($form);
@ -186,7 +195,7 @@ it('testItRemembersNonLeaders', function () {
});
it('testItRemembersMember', function ($attrs, $preventions) {
it('remembers event participant', function ($attrs, $preventions) {
Mail::fake();
$form = createForm();
$participant = createParticipant($form);
@ -195,7 +204,7 @@ it('testItRemembersMember', function ($attrs, $preventions) {
PreventionRememberAction::run();
if (count($preventions)) {
Mail::assertSent(PreventionRememberMail::class, fn($mail) => $mail->preventable->preventions() === $preventions);
Mail::assertSent(PreventionRememberMail::class, fn($mail) => $mail->preventable->preventions()->pluck('type')->toArray() === $preventions);
$this->assertNotNull($participant->fresh()->last_remembered_at);
} else {
Mail::assertNotSent(PreventionRememberMail::class);
@ -203,6 +212,49 @@ it('testItRemembersMember', function ($attrs, $preventions) {
}
})->with('attributes');
it('sets due date in mail when not now', function () {
Mail::fake();
$form = createForm();
$form->update(['from' => now()->addMonths(8)]);
$participant = createParticipant($form);
$participant->member->update(['efz' => now()->subYears(5)->addMonth(), 'ps_at' => now(), 'has_vk' => true]);
PreventionRememberAction::run();
Mail::assertSent(PreventionRememberMail::class, fn($mail) => $mail->preventable->preventions()->first()->expires->isSameDay(now()->addMonth()));
});
it('notices a few weeks before', function ($date, bool $shouldSend) {
Mail::fake();
app(PreventionSettings::class)->fill(['weeks' => 2])->save();
createMember(['efz' => $date, 'ps_at' => now(), 'has_vk' => true]);
YearlyRememberAction::run();
$shouldSend
? Mail::assertSent(YearlyMail::class, fn($mail) => $mail->preventions->first()->expires->isSameDay(now()->addWeeks(2)))
: Mail::assertNotSent(YearlyMail::class);
})->with([
[fn() => now()->subYears(5)->addWeeks(2), true],
[fn() => now()->subYears(5)->addWeeks(2)->addDay(), false],
[fn() => now()->subYears(5)->addWeeks(2)->subDay(), false],
]);
it('remembers members yearly', function ($date, $shouldSend) {
Mail::fake();
createMember(['efz' => $date, 'ps_at' => now(), 'has_vk' => true]);
YearlyRememberAction::run();
$shouldSend
? Mail::assertSent(YearlyMail::class, fn($mail) => $mail->preventions->first()->expires->isSameDay(now()))
: Mail::assertNotSent(YearlyMail::class);
})->with([
[fn() => now()->subYears(5), true],
[fn() => now()->subYears(5)->addDay(), false],
[fn() => now()->subYears(5)->subDay(), false],
]);
it('testItDoesntRememberParticipantThatHasNoMail', function () {
Mail::fake();
$form = createForm();
@ -214,16 +266,6 @@ it('testItDoesntRememberParticipantThatHasNoMail', function () {
Mail::assertNotSent(PreventionRememberMail::class);
});
it('testItRendersMail', function () {
InvoiceSettings::fake(['from_long' => 'Stamm Beispiel']);
$form = createForm();
$participant = createParticipant($form);
(new PreventionRememberMail($participant, app(PreventionSettings::class)->formmail))
->assertSeeInText($participant->member->firstname)
->assertSeeInText($participant->member->lastname)
->assertSeeInText('Stamm Beispiel');
});
it('testItRendersSetttingMail', function () {
Mail::fake();
app(PreventionSettings::class)->fill([
@ -273,10 +315,30 @@ it('testItDoesntAppendTextTwice', function () {
Mail::assertSent(PreventionRememberMail::class, fn($mail) => $mail->bodyText->hasAll(['oberhausen']) && !$mail->bodyText->hasAll(['siegburg']));
});
it('testItDisplaysBodyTextInMail', function () {
/* ----------------------------------------- Mail contents ----------------------------------------- */
it('displays body text in prevention remember mail', function () {
$form = createForm();
$participant = createParticipant($form);
$mail = new PreventionRememberMail($participant, EditorRequestFactory::new()->paragraphs(['ggtt'])->toData());
$mail->assertSeeInText('ggtt');
});
it('renders prevention mail for events with group name', function () {
InvoiceSettings::fake(['from_long' => 'Stamm Beispiel']);
$form = createForm();
$participant = createParticipant($form);
(new PreventionRememberMail($participant, app(PreventionSettings::class)->formmail, collect([])))
->assertSeeInText('Max')
->assertSeeInText('Muster')
->assertSeeInText('Stamm Beispiel');
});
it('renders yearly mail', function () {
InvoiceSettings::fake(['from_long' => 'Stamm Beispiel']);
$member = createMember([]);
$mail = new YearlyMail($member, EditorRequestFactory::new()->paragraphs(['ggtt'])->toData(), collect([]));
$mail
->assertSeeInText('ggtt')
->assertSeeInText('Stamm Beispiel');
});