From a7973190c2e11d54d41ae0e10979e607407cdd72 Mon Sep 17 00:00:00 2001 From: James Cole Date: Wed, 30 Jul 2025 20:35:28 +0200 Subject: [PATCH] Start improving bill overview. --- .../Models/Bill/ShowController.php | 11 ++ .../Enrichments/SubscriptionEnrichment.php | 157 ++++++++++++++++++ app/Transformers/BillTransformer.php | 143 ++++++++-------- .../v2/src/pages/dashboard/subscriptions.js | 19 +-- resources/lang/en_US/firefly.php | 2 + .../dashboard/subscriptions.blade.php | 13 +- 6 files changed, 254 insertions(+), 91 deletions(-) create mode 100644 app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php diff --git a/app/Api/V1/Controllers/Models/Bill/ShowController.php b/app/Api/V1/Controllers/Models/Bill/ShowController.php index b4f336d7f2..48b5e15199 100644 --- a/app/Api/V1/Controllers/Models/Bill/ShowController.php +++ b/app/Api/V1/Controllers/Models/Bill/ShowController.php @@ -28,7 +28,9 @@ use FireflyIII\Api\V1\Controllers\Controller; use FireflyIII\Exceptions\FireflyException; use FireflyIII\Models\Bill; use FireflyIII\Repositories\Bill\BillRepositoryInterface; +use FireflyIII\Support\JsonApi\Enrichments\SubscriptionEnrichment; use FireflyIII\Transformers\BillTransformer; +use FireflyIII\User; use Illuminate\Http\JsonResponse; use Illuminate\Pagination\LengthAwarePaginator; use League\Fractal\Pagination\IlluminatePaginatorAdapter; @@ -76,6 +78,15 @@ class ShowController extends Controller $bills = $bills->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize); $paginator = new LengthAwarePaginator($bills, $count, $pageSize, $this->parameters->get('page')); + // enrich + /** @var User $admin */ + $admin = auth()->user(); + $enrichment = new SubscriptionEnrichment(); + $enrichment->setUser($admin); + $enrichment->setConvertToNative($this->convertToNative); + $enrichment->setNative($this->nativeCurrency); + $bills = $enrichment->enrich($bills); + /** @var BillTransformer $transformer */ $transformer = app(BillTransformer::class); $transformer->setParameters($this->parameters); diff --git a/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php b/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php new file mode 100644 index 0000000000..f8ff54f2ee --- /dev/null +++ b/app/Support/JsonApi/Enrichments/SubscriptionEnrichment.php @@ -0,0 +1,157 @@ +collection = $collection; + $this->collectSubscriptionIds(); + $this->collectNotes(); + $this->collectObjectGroups(); + + $notes = $this->notes; + $objectGroups = $this->objectGroups; + $this->collection = $this->collection->map(function (Bill $item) use ($notes, $objectGroups) { + $id = (int) $item->id; + $currency = $item->transactionCurrency; + $meta = [ + 'notes' => null, + 'object_group_id' => null, + 'object_group_title' => null, + 'object_group_order' => null, + ]; + $amounts = [ + 'amount_min' => Steam::bcround($item->amount_min, $currency->decimal_places), + 'amount_max' => Steam::bcround($item->amount_max, $currency->decimal_places), + 'average' => Steam::bcround(bcdiv(bcadd($item->amount_min, $item->amount_max), '2'), $currency->decimal_places), + ]; + + // add object group if available + if (array_key_exists($id, $this->mappedObjects)) { + $key = $this->mappedObjects[$id]; + $meta['object_group_id'] = $objectGroups[$key]['id']; + $meta['object_group_title'] = $objectGroups[$key]['title']; + $meta['object_group_order'] = $objectGroups[$key]['order']; + } + + // Add notes if available. + if (array_key_exists($item->id, $notes)) { + $meta['notes'] = $notes[$item->id]; + } + + // Convert amounts to native currency if needed + if ($this->convertToNative && $item->currency_id !== $this->nativeCurrency->id) { + $converter = new ExchangeRateConverter(); + $amounts = [ + 'amount_min' => Steam::bcround($converter->convert($item->transactionCurrency, $this->nativeCurrency, today(), $item->amount_min), $this->nativeCurrency->decimal_places), + 'amount_max' => Steam::bcround($converter->convert($item->transactionCurrency, $this->nativeCurrency, today(), $item->amount_max), $this->nativeCurrency->decimal_places), + ]; + $amounts['average'] =Steam::bcround(bcdiv(bcadd($amounts['amount_min'], $amounts['amount_max']), '2'), $this->nativeCurrency->decimal_places); + } + $item->amounts = $amounts; + $item->meta = $meta; + return $item; + }); + + return $collection; + } + + public function enrichSingle(Model|array $model): array|Model + { + Log::debug(__METHOD__); + $collection = new Collection([$model]); + $collection = $this->enrich($collection); + + return $collection->first(); + } + + private function collectNotes(): void + { + $notes = Note::query()->whereIn('noteable_id', $this->subscriptionIds) + ->whereNotNull('notes.text') + ->where('notes.text', '!=', '') + ->where('noteable_type', Bill::class)->get(['notes.noteable_id', 'notes.text'])->toArray() + ; + foreach ($notes as $note) { + $this->notes[(int) $note['noteable_id']] = (string) $note['text']; + } + Log::debug(sprintf('Enrich with %d note(s)', count($this->notes))); + } + + public function setUser(User $user): void + { + $this->user = $user; + $this->userGroup = $user->userGroup; + } + + public function setUserGroup(UserGroup $userGroup): void + { + $this->userGroup = $userGroup; + } + + public function setConvertToNative(bool $convertToNative): void + { + $this->convertToNative = $convertToNative; + } + + public function setNative(TransactionCurrency $nativeCurrency): void + { + $this->nativeCurrency = $nativeCurrency; + } + private function collectSubscriptionIds(): void + { + /** @var Bill $bill */ + foreach ($this->collection as $bill) { + $this->subscriptionIds[] = (int) $bill->id; + } + $this->subscriptionIds = array_unique($this->subscriptionIds); + } + + private function collectObjectGroups(): void + { + $set = DB::table('object_groupables') + ->whereIn('object_groupable_id', $this->subscriptionIds) + ->where('object_groupable_type', Bill::class) + ->get(['object_groupable_id','object_group_id']); + + $ids = array_unique($set->pluck('object_group_id')->toArray()); + + foreach($set as $entry) { + $this->mappedObjects[(int)$entry->object_groupable_id] = (int)$entry->object_group_id; + } + + $groups = ObjectGroup::whereIn('id', $ids)->get(['id', 'title','order'])->toArray(); + foreach($groups as $group) { + $group['id'] = (int) $group['id']; + $group['order'] = (int) $group['order']; + $this->objectGroups[(int)$group['id']] = $group; + } + } + +} diff --git a/app/Transformers/BillTransformer.php b/app/Transformers/BillTransformer.php index ac9a230144..346b1be254 100644 --- a/app/Transformers/BillTransformer.php +++ b/app/Transformers/BillTransformer.php @@ -44,7 +44,7 @@ class BillTransformer extends AbstractTransformer { private readonly BillDateCalculator $calculator; private readonly bool $convertToNative; - private readonly TransactionCurrency $default; + private readonly TransactionCurrency $native; private readonly BillRepositoryInterface $repository; /** @@ -54,7 +54,7 @@ class BillTransformer extends AbstractTransformer { $this->repository = app(BillRepositoryInterface::class); $this->calculator = app(BillDateCalculator::class); - $this->default = Amount::getNativeCurrency(); + $this->native = Amount::getNativeCurrency(); $this->convertToNative = Amount::convertToNative(); } @@ -66,33 +66,19 @@ class BillTransformer extends AbstractTransformer */ public function transform(Bill $bill): array { - $default = $this->parameters->get('defaultCurrency') ?? $this->default; - - $paidData = $this->paidData($bill); - $lastPaidDate = $this->getLastPaidDate($paidData); - $start = $this->parameters->get('start') ?? today()->subYears(10); - $end = $this->parameters->get('end') ?? today()->addYears(10); - $payDates = $this->calculator->getPayDates($start, $end, $bill->date, $bill->repeat_freq, $bill->skip, $lastPaidDate); - $currency = $bill->transactionCurrency; - $notes = $this->repository->getNoteText($bill); - $notes = '' === $notes ? null : $notes; - $objectGroupId = null; - $objectGroupOrder = null; - $objectGroupTitle = null; + $paidData = $this->paidData($bill); + $lastPaidDate = $this->getLastPaidDate($paidData); + $start = $this->parameters->get('start') ?? today()->subYears(10); + $end = $this->parameters->get('end') ?? today()->addYears(10); + $payDates = $this->calculator->getPayDates($start, $end, $bill->date, $bill->repeat_freq, $bill->skip, $lastPaidDate); + $currency = $bill->transactionCurrency; $this->repository->setUser($bill->user); - /** @var null|ObjectGroup $objectGroup */ - $objectGroup = $bill->objectGroups->first(); - if (null !== $objectGroup) { - $objectGroupId = $objectGroup->id; - $objectGroupOrder = $objectGroup->order; - $objectGroupTitle = $objectGroup->title; - } $paidDataFormatted = []; $payDatesFormatted = []; foreach ($paidData as $object) { - $date = Carbon::createFromFormat('!Y-m-d', $object['date'], config('app.timezone')); + $date = Carbon::createFromFormat('!Y-m-d', $object['date'], config('app.timezone')); if (!$date instanceof Carbon) { $date = today(config('app.timezone')); } @@ -101,24 +87,24 @@ class BillTransformer extends AbstractTransformer } foreach ($payDates as $string) { - $date = Carbon::createFromFormat('!Y-m-d', $string, config('app.timezone')); + $date = Carbon::createFromFormat('!Y-m-d', $string, config('app.timezone')); if (!$date instanceof Carbon) { $date = today(config('app.timezone')); } $payDatesFormatted[] = $date->toAtomString(); } // next expected match - $nem = null; - $nemDate = null; - $nemDiff = trans('firefly.not_expected_period'); - $firstPayDate = $payDates[0] ?? null; + $nem = null; + $nemDate = null; + $nemDiff = trans('firefly.not_expected_period'); + $firstPayDate = $payDates[0] ?? null; if (null !== $firstPayDate) { $nemDate = Carbon::createFromFormat('!Y-m-d', $firstPayDate, config('app.timezone')); if (!$nemDate instanceof Carbon) { $nemDate = today(config('app.timezone')); } - $nem = $nemDate->toAtomString(); + $nem = $nemDate->toAtomString(); // nullify again when it's outside the current view range. if ( @@ -139,7 +125,7 @@ class BillTransformer extends AbstractTransformer $current = $payDatesFormatted[0] ?? null; if (null !== $current && !$nemDate->isToday()) { - $temp2 = Carbon::createFromFormat('Y-m-d\TH:i:sP', $current); + $temp2 = Carbon::createFromFormat('Y-m-d\TH:i:sP', $current); if (!$temp2 instanceof Carbon) { $temp2 = today(config('app.timezone')); } @@ -149,43 +135,44 @@ class BillTransformer extends AbstractTransformer } return [ - 'id' => $bill->id, - 'created_at' => $bill->created_at->toAtomString(), - 'updated_at' => $bill->updated_at->toAtomString(), - 'currency_id' => (string)$bill->transaction_currency_id, - 'currency_code' => $currency->code, - 'currency_symbol' => $currency->symbol, - 'currency_decimal_places' => $currency->decimal_places, - 'native_currency_id' => null === $default ? null : (string)$default->id, - 'native_currency_code' => $default?->code, - 'native_currency_symbol' => $default?->symbol, - 'native_currency_decimal_places' => $default?->decimal_places, - 'name' => $bill->name, - 'amount_min' => app('steam')->bcround($bill->amount_min, $currency->decimal_places), - 'amount_max' => app('steam')->bcround($bill->amount_max, $currency->decimal_places), - 'native_amount_min' => $this->convertToNative ? app('steam')->bcround($bill->native_amount_min, $default->decimal_places) : null, - 'native_amount_max' => $this->convertToNative ? app('steam')->bcround($bill->native_amount_max, $default->decimal_places) : null, - 'date' => $bill->date->toAtomString(), - 'end_date' => $bill->end_date?->toAtomString(), - 'extension_date' => $bill->extension_date?->toAtomString(), - 'repeat_freq' => $bill->repeat_freq, - 'skip' => $bill->skip, - 'active' => $bill->active, - 'order' => $bill->order, - 'notes' => $notes, - 'object_group_id' => null !== $objectGroupId ? (string)$objectGroupId : null, - 'object_group_order' => $objectGroupOrder, - 'object_group_title' => $objectGroupTitle, + 'id' => $bill->id, + 'created_at' => $bill->created_at->toAtomString(), + 'updated_at' => $bill->updated_at->toAtomString(), + 'currency_id' => (string)$bill->transaction_currency_id, + 'currency_code' => $currency->code, + 'currency_symbol' => $currency->symbol, + 'currency_decimal_places' => $currency->decimal_places, + + 'native_currency_id' => (string)$this->native->id, + 'native_currency_code' => $this->native->code, + 'native_currency_symbol' => $this->native->symbol, + 'native_currency_decimal_places' => $this->native->decimal_places, + + 'name' => $bill->name, + 'amount_min' => $bill->amounts['amount_min'], + 'amount_max' => $bill->amounts['amount_max'], + 'amount_avg' => $bill->amounts['average'], + 'date' => $bill->date->toAtomString(), + 'end_date' => $bill->end_date?->toAtomString(), + 'extension_date' => $bill->extension_date?->toAtomString(), + 'repeat_freq' => $bill->repeat_freq, + 'skip' => $bill->skip, + 'active' => $bill->active, + 'order' => $bill->order, + 'notes' => $bill->meta['notes'], + 'object_group_id' => $bill->meta['object_group_id'], + 'object_group_order' => $bill->meta['object_group_order'], + 'object_group_title' => $bill->meta['object_group_title'], // these fields need work: - 'next_expected_match' => $nem, - 'next_expected_match_diff' => $nemDiff, - 'pay_dates' => $payDatesFormatted, - 'paid_dates' => $paidDataFormatted, - 'links' => [ + // 'next_expected_match' => $nem, + // 'next_expected_match_diff' => $nemDiff, + // 'pay_dates' => $payDatesFormatted, + // 'paid_dates' => $paidDataFormatted, + 'links' => [ [ 'rel' => 'self', - 'uri' => '/bills/'.$bill->id, + 'uri' => '/bills/' . $bill->id, ], ], ]; @@ -207,13 +194,13 @@ class BillTransformer extends AbstractTransformer // 2023-07-18 this particular date is used to search for the last paid date. // 2023-07-18 the cloned $searchDate is used to grab the correct transactions. /** @var Carbon $start */ - $start = clone $this->parameters->get('start'); - $searchStart = clone $start; + $start = clone $this->parameters->get('start'); + $searchStart = clone $start; $start->subDay(); /** @var Carbon $end */ - $end = clone $this->parameters->get('end'); - $searchEnd = clone $end; + $end = clone $this->parameters->get('end'); + $searchEnd = clone $end; // move the search dates to the start of the day. $searchStart->startOfDay(); @@ -223,7 +210,7 @@ class BillTransformer extends AbstractTransformer Log::debug(sprintf('Search parameters are: start: %s', $searchStart->format('Y-m-d'))); // Get from database when bill was paid. - $set = $this->repository->getPaidDatesInRange($bill, $searchStart, $searchEnd); + $set = $this->repository->getPaidDatesInRange($bill, $searchStart, $searchEnd); Log::debug(sprintf('Count %d entries in getPaidDatesInRange()', $set->count())); // Grab from array the most recent payment. If none exist, fall back to the start date and pretend *that* was the last paid date. @@ -232,17 +219,17 @@ class BillTransformer extends AbstractTransformer Log::debug(sprintf('Result of lastPaidDate is %s', $lastPaidDate->format('Y-m-d'))); // At this point the "next match" is exactly after the last time the bill was paid. - $result = []; + $result = []; foreach ($set as $entry) { - $array = [ - 'transaction_group_id' => (string)$entry->transaction_group_id, - 'transaction_journal_id' => (string)$entry->id, - 'date' => $entry->date->format('Y-m-d'), - 'date_object' => $entry->date, - 'currency_id' => $entry->transaction_currency_id, - 'currency_code' => $entry->transaction_currency_code, - 'currency_decimal_places' => $entry->transaction_currency_decimal_places, - 'amount' => Steam::bcround($entry->amount, $entry->transaction_currency_decimal_places), + $array = [ + 'transaction_group_id' => (string)$entry->transaction_group_id, + 'transaction_journal_id' => (string)$entry->id, + 'date' => $entry->date->format('Y-m-d'), + 'date_object' => $entry->date, + 'currency_id' => $entry->transaction_currency_id, + 'currency_code' => $entry->transaction_currency_code, + 'currency_decimal_places' => $entry->transaction_currency_decimal_places, + 'amount' => Steam::bcround($entry->amount, $entry->transaction_currency_decimal_places), ]; if (null !== $entry->foreign_amount && null !== $entry->foreign_currency_code) { $array['foreign_currency_id'] = $entry->foreign_currency_id; diff --git a/resources/assets/v2/src/pages/dashboard/subscriptions.js b/resources/assets/v2/src/pages/dashboard/subscriptions.js index bb632f2514..20fab2772a 100644 --- a/resources/assets/v2/src/pages/dashboard/subscriptions.js +++ b/resources/assets/v2/src/pages/dashboard/subscriptions.js @@ -163,14 +163,10 @@ function downloadSubscriptions(params) { currency_code: bill.currency_code, paid: 0, unpaid: 0, - // native_currency_code: bill.native_currency_code, - // native_paid: 0, - //native_unpaid: 0, }; } subscriptionData[objectGroupId].payment_info[bill.currency_code].unpaid += totalAmount; - //subscriptionData[objectGroupId].payment_info[bill.currency_code].native_unpaid += totalNativeAmount; } if (current.attributes.paid_dates.length > 0) { @@ -178,8 +174,6 @@ function downloadSubscriptions(params) { if (current.attributes.paid_dates.hasOwnProperty(ii)) { // bill is paid! // since bill is paid, 3 possible currencies: - // native, currency, foreign currency. - // foreign currency amount (converted to native or not) will be ignored. let currentJournal = current.attributes.paid_dates[ii]; // new array for the currency if (!subscriptionData[objectGroupId].payment_info.hasOwnProperty(currentJournal.currency_code)) { @@ -187,15 +181,10 @@ function downloadSubscriptions(params) { currency_code: bill.currency_code, paid: 0, unpaid: 0, - // native_currency_code: bill.native_currency_code, - // native_paid: 0, - //native_unpaid: 0, }; } const amount = parseFloat(currentJournal.amount) * -1; - // const nativeAmount = parseFloat(currentJournal.native_amount) * -1; subscriptionData[objectGroupId].payment_info[currentJournal.currency_code].paid += amount; - // subscriptionData[objectGroupId].payment_info[currentJournal.currency_code].native_paid += nativeAmount; } } } @@ -221,6 +210,14 @@ export default () => ({ formatMoney(amount, currencyCode) { return formatMoney(amount, currencyCode); }, + eventListeners: { + ['@convert-to-native.window'](event){ + console.log('I heard that! (dashboard/subscriptions)'); + this.convertToNative = event.detail; + this.startSubscriptions(); + } + }, + startSubscriptions() { this.loading = true; let start = new Date(window.store.get('start')); diff --git a/resources/lang/en_US/firefly.php b/resources/lang/en_US/firefly.php index f9c07625ad..173a5e7c5e 100644 --- a/resources/lang/en_US/firefly.php +++ b/resources/lang/en_US/firefly.php @@ -1865,6 +1865,8 @@ return [ // bills: 'left_to_pay_lc' => 'left to pay', + 'less_than_expected' => 'less than expected', + 'more_than_expected' => 'more than expected', 'skip_help_text' => 'Use the skip field to create bi-monthly (skip = 1) or other custom intervals.', 'subscription' => 'Subscription', 'not_expected_period' => 'Not expected this period', diff --git a/resources/views/v2/partials/dashboard/subscriptions.blade.php b/resources/views/v2/partials/dashboard/subscriptions.blade.php index b8e92ba9a3..a1850cd124 100644 --- a/resources/views/v2/partials/dashboard/subscriptions.blade.php +++ b/resources/views/v2/partials/dashboard/subscriptions.blade.php @@ -1,4 +1,4 @@ -
+