mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-08-04 15:12:12 +00:00
05e8acc3b1
Only invoices and estimates could be customised. Payment receipts and all five
reports were hardcoded to app.pdf.*, so changing them meant editing files inside
the image -- and losing the edit on the next upgrade.
Those documents have no template picker and no design to choose between, so
overriding one is not a selection: it is a same-named file in
storage/app/templates/pdf/{type}/ winning over the built-in. PdfTemplateUtils::
resolveView() is that rule, and it needs no setting, no column and no UI.
resolveView asks View::exists rather than checking the storage disk. The disk and
the view namespace are registered separately and could disagree about where
custom templates live; asking the thing that will actually render removes that
possibility.
make:template covers the new types. Their names are not free, since an override
replaces one specific document, so it validates against the real list -- 'payment'
for payments, and the five report names -- and reports what is available when the
name is wrong. Neither type gets a preview image written, having no picker to
show one in.
The payment preview route also went through the built-in view directly rather
than the service, so ?preview ignored an override and rendered with none of the
shared data. It goes through the service now, like invoices and estimates.
Claude-Session: https://claude.ai/code/session_01QmECndmNZwzN65Zz9P87dF
91 lines
3.5 KiB
PHP
91 lines
3.5 KiB
PHP
<?php
|
|
|
|
use App\Models\Payment;
|
|
use App\Models\User;
|
|
use App\Support\Pdf\PdfTemplateUtils;
|
|
use Illuminate\Support\Facades\Artisan;
|
|
use Illuminate\Support\Facades\File;
|
|
use Illuminate\Support\Facades\Storage;
|
|
use Illuminate\Support\Facades\View;
|
|
use Laravel\Sanctum\Sanctum;
|
|
|
|
use function Pest\Laravel\get;
|
|
|
|
/**
|
|
* Payment receipts and reports have no template picker, so overriding one means
|
|
* dropping a same-named file into storage/app/templates/pdf/{type}/ and having
|
|
* it win. Both used to be hardcoded to app.pdf.*, so there was no way to change
|
|
* them short of editing files inside the image.
|
|
*/
|
|
beforeEach(function () {
|
|
Artisan::call('db:seed', ['--class' => 'DatabaseSeeder', '--force' => true]);
|
|
Artisan::call('db:seed', ['--class' => 'DemoSeeder', '--force' => true]);
|
|
|
|
$user = User::find(1);
|
|
$this->company = $user->companies()->first();
|
|
$this->withHeaders(['company' => $this->company->id]);
|
|
Sanctum::actingAs($user, ['*']);
|
|
|
|
Storage::fake('pdf_templates');
|
|
Storage::fake('public');
|
|
|
|
// The disk and the view namespace are registered separately, and only the
|
|
// disk is faked. Point the namespace at the same place so a template written
|
|
// here is the one Blade resolves.
|
|
View::addNamespace('pdf_templates', Storage::disk('pdf_templates')->path(''));
|
|
View::getFinder()->flush();
|
|
|
|
config(['pdf.driver' => 'dompdf']);
|
|
|
|
$this->override = function (string $type, string $name, string $markup) {
|
|
$dir = Storage::disk('pdf_templates')->path($type);
|
|
File::ensureDirectoryExists($dir);
|
|
File::put("{$dir}/{$name}.blade.php", $markup);
|
|
View::getFinder()->flush();
|
|
};
|
|
});
|
|
|
|
test('the built-in view is used when nothing overrides it', function () {
|
|
expect(PdfTemplateUtils::resolveView('payment', 'payment'))->toBe('app.pdf.payment.payment');
|
|
expect(PdfTemplateUtils::resolveView('reports', 'expenses'))->toBe('app.pdf.reports.expenses');
|
|
});
|
|
|
|
test('a custom file takes over', function () {
|
|
($this->override)('payment', 'payment', '<html></html>');
|
|
|
|
expect(PdfTemplateUtils::resolveView('payment', 'payment'))->toBe('pdf_templates::payment.payment');
|
|
});
|
|
|
|
test('an overridden payment receipt is what actually renders', function () {
|
|
($this->override)('payment', 'payment', '<html><body>OVERRIDDEN RECEIPT {{ $payment->payment_number }}</body></html>');
|
|
|
|
$payment = Payment::factory()->create(['company_id' => $this->company->id]);
|
|
|
|
get("/payments/pdf/{$payment->unique_hash}?preview=true")
|
|
->assertOk()
|
|
->assertSee('OVERRIDDEN RECEIPT')
|
|
->assertSee($payment->payment_number);
|
|
});
|
|
|
|
test('an overridden report is what actually renders', function () {
|
|
($this->override)('reports', 'expenses', '<html><body>OVERRIDDEN REPORT for {{ $company->name }}</body></html>');
|
|
|
|
get("/reports/expenses/{$this->company->unique_hash}?from_date=2020-01-01&to_date=2030-12-31&preview=true")
|
|
->assertOk()
|
|
->assertSee('OVERRIDDEN REPORT')
|
|
->assertSee($this->company->name);
|
|
});
|
|
|
|
/**
|
|
* The override receives the same shared data the built-in does, so a custom file
|
|
* can use every variable the original template used.
|
|
*/
|
|
test('an overridden report still renders as a pdf', function () {
|
|
($this->override)('reports', 'expenses', '<html><body>{{ $currency->name }} {{ $from_date }}</body></html>');
|
|
|
|
$response = get("/reports/expenses/{$this->company->unique_hash}?from_date=2020-01-01&to_date=2030-12-31");
|
|
|
|
$response->assertOk();
|
|
expect($response->getContent())->toStartWith('%PDF-');
|
|
});
|