Skip to content

Commit e6180dc

Browse files
QuentinGabQuentinGab
committed
denormalize amounts in invoice table
1 parent ac619d9 commit e6180dc

File tree

11 files changed

+199
-43
lines changed

11 files changed

+199
-43
lines changed

‎composer.json‎

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,15 @@
2525
},
2626
"require-dev": {
2727
"laravel/pint": "^1.0",
28-
"nunomaduro/collision": "^7.0",
28+
"nunomaduro/collision": "^7.8",
2929
"nunomaduro/larastan": "^2.0.1",
30-
"orchestra/testbench": "^8.0",
30+
"orchestra/testbench": "^8.8",
3131
"pestphp/pest": "^2.0",
32+
"pestphp/pest-plugin-arch": "^2.0",
3233
"pestphp/pest-plugin-laravel": "^2.0",
3334
"phpstan/extension-installer": "^1.1",
3435
"phpstan/phpstan-deprecation-rules": "^1.0",
35-
"phpstan/phpstan-phpunit": "^1.0",
36-
"phpunit/phpunit": "^10.0",
37-
"spatie/laravel-ray": "^1.26"
36+
"phpstan/phpstan-phpunit": "^1.0"
3837
},
3938
"autoload": {
4039
"psr-4": {
@@ -44,14 +43,39 @@
4443
},
4544
"autoload-dev": {
4645
"psr-4": {
47-
"Finller\\Invoice\\Tests\\": "tests"
46+
"Finller\\Invoice\\Tests\\": "tests",
47+
"Workbench\\App\\": "workbench/app/",
48+
"Workbench\\Database\\Factories\\": "workbench/database/factories/",
49+
"Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
4850
}
4951
},
5052
"scripts": {
53+
"post-autoload-dump": [
54+
"@clear",
55+
"@prepare",
56+
"@composer run prepare"
57+
],
58+
"clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
59+
"prepare": "@php vendor/bin/testbench package:discover --ansi",
60+
"build": "@php vendor/bin/testbench workbench:build --ansi",
61+
"start": [
62+
"Composer\\Config::disableProcessTimeout",
63+
"@composer run build",
64+
"@php vendor/bin/testbench serve"
65+
],
5166
"analyse": "vendor/bin/phpstan analyse",
5267
"test": "vendor/bin/pest",
5368
"test-coverage": "vendor/bin/pest --coverage",
54-
"format": "vendor/bin/pint"
69+
"format": "vendor/bin/pint",
70+
"serve": [
71+
"Composer\\Config::disableProcessTimeout",
72+
"@build",
73+
"@php vendor/bin/testbench serve"
74+
],
75+
"lint": [
76+
"@php vendor/bin/pint",
77+
"@php vendor/bin/phpstan analyse"
78+
]
5579
},
5680
"config": {
5781
"sort-packages": true,
@@ -72,4 +96,4 @@
7296
},
7397
"minimum-stability": "dev",
7498
"prefer-stable": true
75-
}
99+
}

‎database/factories/InvoiceItemFactory.php‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Finller\Invoice\Database\Factories;
44

5+
use Brick\Money\Money;
56
use Finller\Invoice\InvoiceItem;
67
use Illuminate\Database\Eloquent\Factories\Factory;
78

@@ -11,17 +12,18 @@ class InvoiceItemFactory extends Factory
1112

1213
public function definition()
1314
{
14-
$price = fake()->numberBetween(100.00, 100000.00);
15+
$price = Money::ofMinor(fake()->numberBetween(1000, 100000), config('invoices.default_currency'));
16+
$unit_tax = Money::ofMinor(fake()->numberBetween(0, $price->getAmount()->toFloat()), config('invoices.default_currency'));
1517

1618
$useTaxPercentage = fake()->boolean();
1719

1820
return [
1921
'label' => fake()->sentence(),
2022
'description' => fake()->sentence(),
21-
'unit_price' => $price,
22-
'unit_tax' => ! $useTaxPercentage ? fake()->numberBetween(0, $price) : null,
23+
'unit_price' => $price->getMinorAmount()->toInt(),
24+
'currency' => $price->getCurrency()->getCurrencyCode(),
25+
'unit_tax' => ! $useTaxPercentage ? $unit_tax : null,
2326
'tax_percentage' => $useTaxPercentage ? fake()->numberBetween(0, 100) : null,
24-
'currency' => fake()->currencyCode(),
2527
'quantity' => fake()->numberBetween(1, 10),
2628
];
2729
}

‎database/migrations/add_denormalized_columns_to_invoices_table.php.stub‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
3+
use Illuminate\Database\Migrations\Migration;
4+
use Illuminate\Database\Schema\Blueprint;
5+
use Illuminate\Support\Facades\Schema;
6+
7+
return new class extends Migration
8+
{
9+
/**
10+
* Run the migrations.
11+
*/
12+
public function up(): void
13+
{
14+
Schema::table('invoices', function (Blueprint $table) {
15+
$table->bigInteger('subtotal_amount')->nullable();
16+
$table->bigInteger('discount_amount')->nullable();
17+
$table->bigInteger('tax_amount')->nullable();
18+
$table->bigInteger('total_amount')->nullable();
19+
$table->string('currency')->nullable();
20+
});
21+
}
22+
23+
/**
24+
* Reverse the migrations.
25+
*/
26+
public function down(): void
27+
{
28+
Schema::table('invoices', function (Blueprint $table) {
29+
$table->dropColumn('subtotal_amount');
30+
$table->dropColumn('discount_amount');
31+
$table->dropColumn('tax_amount');
32+
$table->dropColumn('total_amount');
33+
$table->dropColumn('currency');
34+
});
35+
}
36+
};

‎database/migrations/add_type_column_to_invoices_table.php.stub‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ return new class extends Migration
1313
{
1414
Schema::table('invoices', function (Blueprint $table) {
1515
$table->string('type')->default('invoice');
16-
$table->foreignId('parent_id')->nullable()
16+
$table->foreignId('parent_id')->nullable();
1717
});
1818
}
1919

‎src/Commands/DenormalizeInvoicesCommand.php‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?php
2+
3+
namespace Finller\Invoice;
4+
5+
use Illuminate\Console\Command;
6+
use Illuminate\Database\Eloquent\Builder;
7+
use Illuminate\Database\Eloquent\Collection;
8+
9+
class DenormalizeInvoicesCommand extends Command
10+
{
11+
public $signature = 'invoices:denormalize {ids?*}';
12+
13+
public $description = 'Denormalize amount, tax and discounts to the invoice table';
14+
15+
public function handle(): int
16+
{
17+
$ids = $this->argument('ids');
18+
19+
$model = config('invoices.model_invoice');
20+
21+
/** @var Builder $query */
22+
$query = $model::query();
23+
$query
24+
->with(['items'])
25+
->when($ids, fn (Builder $q) => $q->whereIn('id', $ids));
26+
27+
/** @var int */
28+
$total = $query->count();
29+
30+
$bar = $this->output->createProgressBar($total);
31+
32+
$query
33+
->chunk(200, function (Collection $invoices) use ($bar) {
34+
$invoices->each(function (Invoice $invoice) use ($bar) {
35+
$invoice->denormalize()->saveQuietly();
36+
$bar->advance();
37+
});
38+
});
39+
40+
$bar->finish();
41+
42+
return self::SUCCESS;
43+
}
44+
}

‎src/Invoice.php‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
namespace Finller\Invoice;
44

5+
use Brick\Money\Money;
56
use Carbon\Carbon;
67
use Finller\Invoice\Casts\Discounts;
8+
use Finller\Money\MoneyCast;
79
use Illuminate\Contracts\Mail\Attachable;
810
use Illuminate\Database\Eloquent\Builder;
911
use Illuminate\Database\Eloquent\Casts\ArrayObject;
@@ -24,7 +26,7 @@
2426
* @property ?Invoice $credit
2527
* @property InvoiceType $type
2628
* @property string $serial_number
27-
* @property ArrayObject $serial_number_details
29+
* @property ?ArrayObject $serial_number_details
2830
* @property string $description
2931
* @property ?ArrayObject $seller_information
3032
* @property ?ArrayObject $buyer_information
@@ -47,6 +49,11 @@
4749
* @property Carbon $updated_at
4850
* @property null|InvoiceDiscount[] $discounts
4951
* @property ?ArrayObject $metadata
52+
* @property ?Money $subtotal_amount
53+
* @property ?Money $discount_amount
54+
* @property ?Money $tax_amount
55+
* @property ?Money $total_amount
56+
* @property ?string $currency
5057
*/
5158
class Invoice extends Model implements Attachable
5259
{
@@ -68,6 +75,10 @@ class Invoice extends Model implements Attachable
6875
'metadata' => AsArrayObject::class,
6976
'discounts' => Discounts::class,
7077
'serial_number_details' => AsArrayObject::class,
78+
'total_amount' => MoneyCast::class.':currency',
79+
'subtotal_amount' => MoneyCast::class.':currency',
80+
'discount' => MoneyCast::class.':currency',
81+
'tax' => MoneyCast::class.':currency',
7182
];
7283

7384
public static function booted()
@@ -283,6 +294,22 @@ public function getDiscounts(): ?array
283294
return $this->discounts;
284295
}
285296

297+
/**
298+
* Denormalize amounts computed from items to the invoice table
299+
* Allowing easier query
300+
*/
301+
public function denormalize(): static
302+
{
303+
$pdfInvoice = $this->toPdfInvoice();
304+
$this->currency = $pdfInvoice->getCurrency();
305+
$this->subtotal_amount = $pdfInvoice->subTotalAmount();
306+
$this->discount_amount = $pdfInvoice->totalDiscountAmount();
307+
$this->tax_amount = $pdfInvoice->totalTaxAmount();
308+
$this->total_amount = $pdfInvoice->totalAmount();
309+
310+
return $this;
311+
}
312+
286313
public function scopePaid(Builder $query): Builder
287314
{
288315
return $query->where('state', InvoiceState::Paid);

‎src/InvoiceServiceProvider.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public function configurePackage(Package $package): void
2222
->hasMigration('create_invoices_table')
2323
->hasMigration('create_invoice_items_table')
2424
->hasMigration('add_discounts_column_to_invoices_table')
25-
->hasMigration('add_type_column_to_invoices_table');
25+
->hasMigration('add_type_column_to_invoices_table')
26+
->hasMigration('add_denormalized_columns_to_invoices_table');
2627
}
2728
}

‎src/PdfInvoice.php‎

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,14 @@ public function getFilename(): string
4949
return $this->filename ?? $this->generateFilename();
5050
}
5151

52+
public function getCurrency(): string
53+
{
54+
/** @var ?PdfInvoiceItem $firstItem */
55+
$firstItem = Arr::first($this->items);
56+
57+
return $firstItem?->currency ?? config('invoices.default_currency');
58+
}
59+
5260
public function getLogo(): string
5361
{
5462
$type = pathinfo($this->logo, PATHINFO_EXTENSION);
@@ -62,42 +70,26 @@ public function getLogo(): string
6270
*/
6371
public function subTotalAmount(): Money
6472
{
65-
if (empty($this->items)) {
66-
return Money::ofMinor(0, config('invoices.default_currency'));
67-
}
68-
69-
$firstItem = Arr::first($this->items);
70-
71-
$currency = $firstItem->currency;
72-
7373
return array_reduce(
7474
$this->items,
7575
fn (Money $total, PdfInvoiceItem $item) => $total->plus($item->subTotalAmount()),
76-
Money::of(0, $currency)
76+
Money::of(0, $this->getCurrency())
7777
);
7878
}
7979

8080
public function totalTaxAmount(): Money
8181
{
82-
if (empty($this->items)) {
83-
return Money::ofMinor(0, config('invoices.default_currency'));
84-
}
85-
86-
$firstItem = Arr::first($this->items);
87-
88-
$currency = $firstItem->currency;
89-
9082
return array_reduce(
9183
$this->items,
9284
fn (Money $total, PdfInvoiceItem $item) => $total->plus($item->totalTaxAmount()),
93-
Money::of(0, $currency)
85+
Money::of(0, $this->getCurrency())
9486
);
9587
}
9688

9789
public function totalDiscountAmount(): Money
9890
{
9991
if (! $this->discounts) {
100-
return Money::of(0, $this->subTotalAmount()->getCurrency());
92+
return Money::of(0, $this->getCurrency());
10193
}
10294

10395
$subtotal = $this->subTotalAmount();
@@ -109,18 +101,10 @@ public function totalDiscountAmount(): Money
109101

110102
public function totalAmount(): Money
111103
{
112-
if (empty($this->items)) {
113-
return Money::ofMinor(0, config('invoices.default_currency'));
114-
}
115-
116-
$firstItem = Arr::first($this->items);
117-
118-
$currency = $firstItem->currency;
119-
120104
$total = array_reduce(
121105
$this->items,
122106
fn (Money $total, PdfInvoiceItem $item) => $total->plus($item->totalAmount()),
123-
Money::of(0, $currency)
107+
Money::of(0, $this->getCurrency())
124108
);
125109

126110
return $total->minus($this->totalDiscountAmount());

‎tests/ArchTest.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?php
2+
3+
it('will not use debugging functions')
4+
->expect(['dd', 'dump', 'ray'])
5+
->each->not->toBeUsed();

‎tests/Feature/InvoiceTest.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<?php
22

33
use Finller\Invoice\Invoice;
4+
use Finller\Invoice\InvoiceItem;
45

56
it('can create and generate unique serial numbers', function () {
67
$prefix = 'INV';
@@ -72,3 +73,26 @@
7273
'count' => 1,
7374
]);
7475
});
76+
77+
it('denormalize amounts in invoice', function () {
78+
/** @var Invoice */
79+
$invoice = Invoice::factory()->make();
80+
$invoice->save();
81+
82+
$invoice->items()->saveMany(InvoiceItem::factory(2)->make());
83+
84+
$invoice->denormalize()->save();
85+
$pdfInvoice = $invoice->toPdfInvoice();
86+
87+
expect($invoice->subtotal_amount->getAmount()->toFloat())
88+
->toEqual($pdfInvoice->subTotalAmount()->getAmount()->toFloat());
89+
90+
expect($invoice->discount_amount->getAmount()->toFloat())
91+
->toEqual($pdfInvoice->totalDiscountAmount()->getAmount()->toFloat());
92+
93+
expect($invoice->tax_amount->getAmount()->toFloat())
94+
->toEqual($pdfInvoice->totalTaxAmount()->getAmount()->toFloat());
95+
96+
expect($invoice->total_amount->getAmount()->toFloat())
97+
->toEqual($pdfInvoice->totalAmount()->getAmount()->toFloat());
98+
});

0 commit comments

Comments
 (0)