export providers and exact globe integration

app/DataTransferObjects/ExportFormat.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\DataTransferObjects;
+
+use App\Enums\ExportPeriodOptions;
+
+readonly class ExportFormat
+{
+    public function __construct(
+        public string $key,
+        public string $label,
+        public ExportPeriodOptions $periodOptions,
+        public string $extension = 'xlsx',
+    ) {}
+}

app/DataTransferObjects/ExportPeriod.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\DataTransferObjects;
+
+use Carbon\CarbonImmutable;
+use InvalidArgumentException;
+
+readonly class ExportPeriod
+{
+    public function __construct(
+        public ?int $year,
+        public ?int $month,
+    ) {}
+
+    public function start(): CarbonImmutable
+    {
+        $start = CarbonImmutable::create($this->requireYear(), $this->month ?? 1, 1);
+
+        assert($start !== null);
+
+        return $start;
+    }
+
+    public function end(): CarbonImmutable
+    {
+        return $this->month === null
+            ? $this->start()->endOfYear()
+            : $this->start()->endOfMonth();
+    }
+
+    public function requireYear(): int
+    {
+        return $this->year ?? throw new InvalidArgumentException('This export requires a year.');
+    }
+
+    public function requireMonth(): int
+    {
+        return $this->month ?? throw new InvalidArgumentException('This export requires a month.');
+    }
+}

app/Enums/ExportPeriodOptions.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Enums;
+
+enum ExportPeriodOptions: string
+{
+    case None = 'none';
+    case Monthly = 'monthly';
+    case MonthlyAndYearly = 'monthly-and-yearly';
+
+    public function yearIsRequired(): bool
+    {
+        return $this == self::Monthly || $this == self::MonthlyAndYearly;
+    }
+
+    public function monthIsRequired(): bool
+    {
+        return $this === self::Monthly;
+    }
+}

app/Exports/BudgetsExport.php

@@ -3,13 +3,14 @@
 namespace App\Exports;
 
 use App\DataTransferObjects\BudgetExportRow;
+use App\Integrations\Contracts\ExportInterface;
 use App\Models\Budget;
 use Exception;
 use Illuminate\Database\Eloquent\Collection;
 use OpenSpout\Common\Entity\Row;
 use OpenSpout\Writer\XLSX\Writer;
 
-class BudgetsExport
+class BudgetsExport implements ExportInterface
 {
     /**
      * @throws Exception

app/Exports/CoreExportProvider.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Exports;
+
+use App\DataTransferObjects\ExportFormat;
+use App\DataTransferObjects\ExportPeriod;
+use App\Enums\ExportPeriodOptions;
+use App\Integrations\Contracts\ExportInterface;
+use App\Integrations\Contracts\ExportProviderInterface;
+use App\Services\BudgetUsageService;
+use Illuminate\Support\Collection;
+use InvalidArgumentException;
+
+final class CoreExportProvider implements ExportProviderInterface
+{
+    public function exportFormats(): Collection
+    {
+        return collect([
+            new ExportFormat('budgets-monthly-excel', 'Budget mutations', ExportPeriodOptions::Monthly),
+            new ExportFormat('budgets-excel', 'Budgets current balance', ExportPeriodOptions::None),
+            new ExportFormat('entries-excel', 'Entries dump', ExportPeriodOptions::MonthlyAndYearly),
+            new ExportFormat('users-monthly-summary-excel', 'Monthly summary per user', ExportPeriodOptions::Monthly),
+        ]);
+    }
+
+    public function createExport(string $key, ExportPeriod $period): ExportInterface
+    {
+        return match ($key) {
+            'budgets-monthly-excel' => new MonthlyBudgetsExport($period->requireYear(), $period->requireMonth(), app(BudgetUsageService::class)),
+            'budgets-excel' => new BudgetsExport,
+            'entries-excel' => new EntriesExport($period->start(), $period->end()),
+            'users-monthly-summary-excel' => new UsersMonthlySummaryExport($period->start(), $period->end()),
+            default => throw new InvalidArgumentException("Unknown export format: {$key}"),
+        };
+    }
+
+    public static function fromConfig(array $config): static
+    {
+        return new self;
+    }
+}

app/Exports/EntriesExport.php

@@ -3,6 +3,7 @@
 namespace App\Exports;
 
 use App\DataTransferObjects\EntryExportRow;
+use App\Integrations\Contracts\ExportInterface;
 use App\Models\Entry;
 use App\Models\User;
 use Brick\Math\BigDecimal;
@@ -12,7 +13,7 @@
 use OpenSpout\Common\Entity\Row;
 use OpenSpout\Writer\XLSX\Writer;
 
-class EntriesExport
+class EntriesExport implements ExportInterface
 {
     private CarbonInterface $start;
 

app/Exports/MonthlyBudgetsExport.php

@@ -3,6 +3,7 @@
 namespace App\Exports;
 
 use App\DataTransferObjects\BudgetMutation;
+use App\Integrations\Contracts\ExportInterface;
 use App\Models\Customer;
 use App\Models\User;
 use App\Services\BudgetUsageService;
@@ -11,7 +12,7 @@
 use OpenSpout\Common\Entity\Row;
 use OpenSpout\Writer\XLSX\Writer;
 
-class MonthlyBudgetsExport
+class MonthlyBudgetsExport implements ExportInterface
 {
     private Carbon $month;
 

app/Exports/UsersMonthlySummaryExport.php

@@ -2,6 +2,7 @@
 
 namespace App\Exports;
 
+use App\Integrations\Contracts\ExportInterface;
 use App\Models\Entry;
 use App\Models\User;
 use App\Queries\HoursPerUserPerMonth;
@@ -11,7 +12,7 @@
 use OpenSpout\Common\Entity\Row;
 use OpenSpout\Writer\XLSX\Writer;
 
-class UsersMonthlySummaryExport
+class UsersMonthlySummaryExport implements ExportInterface
 {
     public function __construct(
         private CarbonInterface $start,

app/Filament/Resources/Integrations/Tables/IntegrationsTable.php

@@ -2,7 +2,6 @@
 
 namespace App\Filament\Resources\Integrations\Tables;
 
-use App\Filament\Resources\Integrations\IntegrationResource;
 use App\Integrations\IntegrationTypeRegistry;
 use App\Models\Integration;
 use Filament\Tables\Columns\TextColumn;
@@ -23,7 +22,7 @@ public static function configure(Table $table): Table
 
                 return $pageClass
                     ? $pageClass::getUrl(['record' => $record->id])
-                    : IntegrationResource::getUrl('edit', ['record' => $record]);
+                    : null;
             });
     }
 }

app/Http/Controllers/ExportEmailController.php

@@ -5,7 +5,6 @@
 use App\Http\Requests\ExportRequest;
 use App\Jobs\ExportBudgetsJob;
 use App\Models\User;
-use App\Services\BudgetUsageService;
 use Dedoc\Scramble\Attributes\ExcludeRouteFromDocs;
 use Illuminate\Container\Attributes\CurrentUser;
 use Illuminate\Http\JsonResponse;
@@ -19,15 +18,15 @@ class ExportEmailController extends Controller
      * @return JsonResponse
      */
     #[ExcludeRouteFromDocs]
-    public function __invoke(ExportRequest $request, BudgetUsageService $usageService, #[CurrentUser] User $user)
+    public function __invoke(ExportRequest $request, #[CurrentUser] User $user)
     {
         $validated = $request->validated();
 
         $exportType = $validated['exportType'];
-        $year = $validated['year'];
+        $year = $validated['year'] ?? null;
         $month = $validated['month'] ?? null;
 
-        ExportBudgetsJob::dispatch($user, $exportType, $year, $month, $usageService);
+        ExportBudgetsJob::dispatch($user, $exportType, $year, $month);
 
         return response()->json(['message' => __('Export gestart. Je ontvangt een e-mail zodra het bestand klaar is.')], Response::HTTP_ACCEPTED);
     }
@@ -43,6 +42,5 @@ public function download(string $fileName)
         }
 
         return Storage::download($fileName);
-
     }
 }

app/Http/Controllers/ExportFormatController.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Http\Resources\ExportFormat as ExportFormatResource;
+use App\Integrations\ExportService;
+use TiMacDonald\JsonApi\JsonApiResourceCollection;
+
+class ExportFormatController extends Controller
+{
+    public function __invoke(ExportService $exportService): JsonApiResourceCollection
+    {
+        return ExportFormatResource::collection($exportService->formats());
+    }
+}

app/Http/Requests/ExportRequest.php

@@ -2,8 +2,10 @@
 
 namespace App\Http\Requests;
 
+use App\Integrations\ExportService;
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
 
 class ExportRequest extends FormRequest
 {
@@ -20,12 +22,20 @@ public function authorize(): bool
      *
      * @return array<string, ValidationRule|array<mixed>|string>
      */
-    public function rules(): array
+    public function rules(ExportService $exportService): array
     {
+        $format = $exportService->findFormat($this->string('exportType')->toString());
+
         return [
-            'exportType' => 'required|string',
-            'year' => 'required|integer|min:2000|max:'.date('Y'),
-            'month' => 'required_unless:exportType,entries-excel|nullable|integer|min:1|max:12',
+            'exportType' => ['required', 'string', Rule::in($exportService->formatKeys())],
+            'year' => [
+                Rule::requiredIf($format?->periodOptions->yearIsRequired() ?? false),
+                'nullable', 'integer', 'min:2000', 'max:'.date('Y'),
+            ],
+            'month' => [
+                Rule::requiredIf($format?->periodOptions->monthIsRequired() ?? false),
+                'nullable', 'integer', 'min:1', 'max:12',
+            ],
         ];
     }
 }

app/Http/Resources/ExportFormat.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Request;
+use TiMacDonald\JsonApi\JsonApiResource;
+
+/**
+ * @mixin \App\DataTransferObjects\ExportFormat
+ */
+class ExportFormat extends JsonApiResource
+{
+    public function toAttributes(Request $request): array
+    {
+        return [
+            'label' => $this->label,
+            'periodOptions' => $this->periodOptions->value,
+            'extension' => $this->extension,
+        ];
+    }
+
+    public function toType(Request $request): string
+    {
+        return 'exportFormats';
+    }
+
+    public function toId(Request $request): string
+    {
+        return $this->key;
+    }
+}

app/Integrations/Contracts/ExportInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Integrations\Contracts;
+
+interface ExportInterface
+{
+    public function export(string $filePath): void;
+}

app/Integrations/Contracts/ExportProviderInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Integrations\Contracts;
+
+use App\DataTransferObjects\ExportFormat;
+use App\DataTransferObjects\ExportPeriod;
+use Illuminate\Support\Collection;
+
+interface ExportProviderInterface
+{
+    /**
+     * @return Collection<int, ExportFormat>
+     */
+    public function exportFormats(): Collection;
+
+    public function createExport(string $key, ExportPeriod $period): ExportInterface;
+
+    /** @param array<string, mixed> $config */
+    public static function fromConfig(array $config): static;
+}

app/Integrations/ExportProviderRegistry.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Integrations;
+
+use App\Integrations\Contracts\ExportProviderInterface;
+
+class ExportProviderRegistry
+{
+    /** @var array<string, list<class-string<ExportProviderInterface>>> */
+    private array $classes = [];
+
+    /** @param class-string<ExportProviderInterface> $providerClass */
+    public function register(string $type, string $providerClass): void
+    {
+        $this->classes[$type][] = $providerClass;
+    }
+
+    /**
+     * @param  array<string, mixed>  $config
+     * @return list<ExportProviderInterface>
+     */
+    public function makeProviders(string $type, array $config): array
+    {
+        return array_map(
+            fn (string $class): ExportProviderInterface => $class::fromConfig($config),
+            $this->classes[$type] ?? [],
+        );
+    }
+
+    /** @return list<string> */
+    public function registeredTypes(): array
+    {
+        return array_keys($this->classes);
+    }
+}