Added Pay Distribution Template to Goal-templates #3078

Midgetwombat · 2024-07-17T15:16:07Z

THIS PR HAS BEEN REPLACED WITH PR #3176. Please read here for comments and explanation. And review code at 3176.

Added a new Template type called Pay Distribution, which is designed to be triggered every time the apply template is clicked. if a Pay Distribution template is applied to a category then instead of adding to the goal the distribution template will just add its value to the currently budgeted amount. if a normal template is applied to the category as well, then that template will add to the goal but will not change the value of the budgeted column.

The purpose of this new template is for people who budget by paycheck which may not be monthly, or for those who are still working on building up their funds to have enough to budget for a month.

The pay Distribution Template has two operations either a set amount OR a percentage of the remaining available funds.
Additionally, if the pay distribution template is added to the same category as the remainder template, then the remaining budget will be added to that category also. Otherwise, the remainder template will retain its normal functionality.

…ted instead of replacing. Added + to the syntax for goal-template. When put before the value and after the priority will prevent ProcessTemplate() from clearing the value from budgeted, so the template can add its amount instead. This feature will be useful for people who do their budgets weekly or by paycheck. EXAMPLE: #template +$50 Note: This functionality was not applied to all template types; schedule was skipped.

netlify · 2024-07-17T15:16:23Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`5097edc`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/66aca6f6199cd200089bfb4c
😎 Deploy Preview	https://deploy-preview-3078.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2024-07-17T15:17:18Z

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
9	4.8 MB → 4.8 MB (-3.61 kB)	-0.07%

Changeset

File	Δ	Size
`src/components/budget/index.tsx`	📈 +42 B (+0.47%)	8.7 kB → 8.75 kB
`src/components/mobile/budget/index.tsx`	📈 +36 B (+0.37%)	9.62 kB → 9.65 kB
`src/components/mobile/transactions/TransactionEdit.jsx`	📉 -31 B (-0.09%)	32.51 kB → 32.48 kB
`src/components/autocomplete/CategoryAutocomplete.tsx`	📉 -13 B (-0.13%)	9.96 kB → 9.95 kB
`src/components/settings/Experimental.tsx`	📉 -13 B (-0.41%)	3.08 kB → 3.06 kB
`src/components/settings/BudgetTypeSettings.tsx`	📉 -13 B (-0.51%)	2.49 kB → 2.48 kB
`src/components/reports/graphs/SpendingGraph.tsx`	📉 -211 B (-2.48%)	8.31 kB → 8.1 kB
`src/components/reports/reports/SpendingCard.tsx`	📉 -252 B (-6.42%)	3.83 kB → 3.59 kB
`src/components/reports/spreadsheets/spending-spreadsheet.ts`	📉 -750 B (-14.54%)	5.04 kB → 4.3 kB
`src/components/reports/reports/Spending.tsx`	📉 -2.43 kB (-16.76%)	14.52 kB → 12.08 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
static/js/wide.js	277.26 kB → 277.31 kB (+42 B)	+0.01%
static/js/narrow.js	78.27 kB → 78.3 kB (+36 B)	+0.04%

Smaller

Asset	File Size	% Changed
static/js/ReportRouter.js	1.23 MB → 1.23 MB (-3.62 kB)	-0.29%
static/js/index.js	3.04 MB → 3.04 MB (-70 B)	-0.00%

Unchanged

Asset	File Size	% Changed
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/usePreviewTransactions.js	790 B	0%
static/js/AppliedFilters.js	27.61 kB	0%

github-actions · 2024-07-17T15:17:19Z

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
1	1.14 MB → 1.14 MB (+1.93 kB)	+0.17%

Changeset

File	Δ	Size
`packages/loot-core/src/server/budget/goals/payDistribution.ts`	🆕 +1.03 kB	0 B → 1.03 kB
`packages/loot-core/src/server/budget/goals/goalsRemainder.ts`	📈 +210 B (+13.78%)	1.49 kB → 1.69 kB
`packages/loot-core/src/server/budget/goaltemplates.ts`	📈 +3.18 kB (+13.67%)	23.29 kB → 26.48 kB
`packages/loot-core/src/server/budget/goal-template.pegjs`	📈 +6.44 kB (+11.83%)	54.47 kB → 60.91 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
kcab.worker.js	1.14 MB → 1.14 MB (+1.93 kB)	+0.17%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

youngcw · 2024-07-17T15:22:59Z

If you are ready to get this reviewed remove the [WIP] label. Also to fix the lint error run yarn lint --fix. It looks like there are some debug prints in there, could you remove those?

Fixed a mistake I made with not removing the test code.

youngcw · 2024-07-17T15:50:02Z

I haven't tried it yet, but I don't think this makes sense to add to the remainder template

Midgetwombat · 2024-07-17T16:02:08Z

I haven't tried it yet, but I don't think this makes sense to add to the remainder template

You're probably right, i haven't played with the remainder feature and originally i didn't have it. But before pushing in my mind I thought someone may like the remainder of their paycheck to be added to a 'budgeted' like savings.

youngcw · 2024-07-17T18:13:42Z

Im wondering if it would be better to keep the number of templates that can do this low. Some of the more involved templates could just get confusing with this option. I think we need to figure something out as well for the what goal gets set. Right now the goal is set like normal, but the budget amount likely is higher than that goal.

Midgetwombat · 2024-07-18T05:11:28Z

Im wondering if it would be better to keep the number of templates that can do this low. Some of the more involved templates could just get confusing with this option. I think we need to figure something out as well for the what goal gets set. Right now the goal is set like normal, but the budget amount likely is higher than that goal.

Okay so what i'll do is, reduce the templates down to simple and percentage i think that's a good middle ground, I Still think having the remainder is a good idea But i trust someone who has done this for a while. When you mention about the 'goal is normal, but budget amount likely is higher', not quite sure what you mean. If your referring to the 'up to' syntax then i'll do some testing and if that does not work correctly i'll see what i can do about it. I do have another idea of implementation of this that could help with that issue. Let me know if i need to change this back to [WIP]. Again this is my first time contributing to a project and using Git. Thanks a lot for your time.

youngcw · 2024-07-18T14:29:53Z

When you mention about the 'goal is normal, but budget amount likely is higher', not quite sure what you mean.

I mean the part of the processing that sets the goal in the database. Thats what informs the green/yellow coloring in the budget table. Those aren't getting changed to match that the new amount that the template wants is greater than a single template run asks for. This makes it so you could remove funds and still be in the green even though the budgeted amount is less than what the templates budgeted.

Midgetwombat · 2024-07-18T14:37:36Z

When you mention about the 'goal is normal, but budget amount likely is higher', not quite sure what you mean.

I mean the part of the processing that sets the goal in the database. Thats what informs the green/yellow coloring in the budget table. Those aren't getting changed to match that the new amount that the template wants is greater than a single template run asks for. This makes it so you could remove funds and still be in the green even though the budgeted amount is less than what the templates budgeted.

Okay thanks, I'm going to move this back to work in progress and test for these things, and prob do some rework of code. I'll move it back to review when I think I have corrected the issues and maybe a draft for documentation, explaining the feature better. I appreciate your input.

The new code will allow users to distribute each pay without effecting goals.

Made a mistake in merging, first time with github

Still fixing merging issues

This should make branch the same, before own changes can be added. [Still fixing merging mistake]

New Pay Distribution code. Merge errors fixed.

Midgetwombat · 2024-07-30T01:49:46Z

Pay Distribution Template has been added. This adds the + directive and can only be used as "#template +$" for a set amount to be taken from the available budget, or "#template +%" to use a percentage of the available amount. This new template will not set a goal but be used to add to the current budgeted amount for that month. Additionally, all other templates active on that category will till register to a goal but will not add their amounts to the budgeted. The mindset behind this template is for people who budget by paycheck or don't have the funds to budget for a whole month but want to work towards a goal. Also if a secondary template has the 'up to' and 'hold' flags active the new Pay Distribution template will respect those rules.

Midgetwombat · 2024-07-30T02:33:10Z

EXAMPLE 1:

In this example we have activated the pay distribution template to put $50 in each time the apply template is clicked. We have also indicated we want to set a goal of $100 but don't want more than $200. Additionally, anything we have manually put into our budgeted we don't want to be wiped.

EXAMPLE 2:

In this example, we want 20% of the remaining available budget to be put into the budgeted each time we click apply template. (available budget may differ from originally displayed as it works on what's left after each category takes its share). We are also not setting a goal here so the balance will always be green.

EXAMPLE 3:

In this example, we are using the remainder template notice we have used the Pay Distribution template also with a value of zero. The purpose here is so the Pay distribution template will not add anything to the budgeted but instead trigger the remainder template to always add whatever is left into its category after each click of apply template.

The way to think of Pay Distribution is to quickly distribute your wages into the categories you need if you are not paid monthly. But use the normal templates to set your goals. All other templates should work as normal. the only functionality on other templates that change is setting the budgeted amount when there is a Pay Distribution template active on that category.

RESULTS:
Food = Example 1
Bills = Example 2
Savings = Example 3

BEFORE:

AFTER:

ADDED PAYCHECK:

BEFORE APPLY TEMPLATE:

AFTER APPLY TEMPLATE:

packages/loot-core/src/server/budget/goaltemplates.ts

This reverts commit f75a5bf, reversing changes made to bf70b2e.

actual-github-bot bot changed the title ~~Added feature to Goal-template, so when triggered adds value to budge…~~ [WIP] Added feature to Goal-template, so when triggered adds value to budge… Jul 17, 2024

actual-github-bot bot added the 🚧 WIP label Jul 17, 2024

Midgetwombat added 2 commits July 18, 2024 01:25

Update goaltemplates.ts

06a804c

Fixed a mistake I made with not removing the test code.

Create 3078.md

52cc78d

Midgetwombat changed the title ~~[WIP] Added feature to Goal-template, so when triggered adds value to budge…~~ Added feature to Goal-template, so when triggered adds value to budge… Jul 17, 2024

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Jul 17, 2024

youngcw linked an issue Jul 17, 2024 that may be closed by this pull request

[Feature] Goal template flag to add funds to category #2351

Closed

2 tasks

Merge branch 'master' into goalTemplate-AdditionFeature

4ee6312

Midgetwombat changed the title ~~Added feature to Goal-template, so when triggered adds value to budge…~~ [WIP] Added feature to Goal-template, so when triggered adds value to budge… Jul 18, 2024

actual-github-bot bot added 🚧 WIP and removed 🔍 Ready for review labels Jul 18, 2024

Midgetwombat added 4 commits July 25, 2024 00:39

Merge branch 'master' into goalTemplate-AdditionFeature

e359708

Updated How the Pay Distribution worked as to not effect goals set.

7b73626

The new code will allow users to distribute each pay without effecting goals.

Fixed a merge error

5208bd1

Merge branch 'master' into goalTemplate-AdditionFeature

de8c6f5

Midgetwombat marked this pull request as draft July 29, 2024 07:01

Midgetwombat added 2 commits July 29, 2024 18:46

Delete packages/loot-core/src/server/budget/goals/payDistribution.ts

f338ea1

Made a mistake in merging, first time with github

Delete packages/loot-core/src/server/budget/goal-template.pegjs

d2d805b

Still fixing merging issues

Midgetwombat added 6 commits July 29, 2024 19:06

Merge branch 'master' into goalTemplate-AdditionFeature

1bd87c7

Merge branch 'master' into goalTemplate-AdditionFeature

60d6f24

Fix Merging Issues

dbe585b

This should make branch the same, before own changes can be added. [Still fixing merging mistake]

Merge branch 'master' of https://github.com/Midgetwombat/actual

1f257c7

Merge branch 'master' into goalTemplate-AdditionFeature

2911f0a

New Pay Distribution Code

54ceaaf

New Pay Distribution code. Merge errors fixed.

Midgetwombat added 3 commits July 30, 2024 11:55

Fixed Lint Issues

67611d1

Fixed issue with Pay distribution dealing with percentage

83f7447

More lint

bf70b2e

Midgetwombat marked this pull request as ready for review July 30, 2024 02:33

actual-github-bot bot changed the title ~~[WIP] Added feature to Goal-template, so when triggered adds value to budge…~~ Added feature to Goal-template, so when triggered adds value to budge… Jul 30, 2024

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Jul 30, 2024

Midgetwombat commented Jul 30, 2024

View reviewed changes

packages/loot-core/src/server/budget/goaltemplates.ts Show resolved Hide resolved

Midgetwombat changed the title ~~Added feature to Goal-template, so when triggered adds value to budge…~~ Added Pay Distribution Template to Goal-templates Jul 30, 2024

Midgetwombat mentioned this pull request Jul 30, 2024

Pay Distribution Template Docs actualbudget/docs#417

Closed

Midgetwombat added 2 commits August 2, 2024 10:19

Merge branch 'master' into goalTemplate-AdditionFeature

f75a5bf

Revert "Merge branch 'master' into goalTemplate-AdditionFeature"

5097edc

This reverts commit f75a5bf, reversing changes made to bf70b2e.

Midgetwombat mentioned this pull request Aug 2, 2024

Pay Distribution Template - PR Replacement for #3078 #3176

Closed

Midgetwombat closed this Aug 2, 2024

actual-github-bot bot removed the 🔍 Ready for review label Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Pay Distribution Template to Goal-templates #3078

Added Pay Distribution Template to Goal-templates #3078

Midgetwombat commented Jul 17, 2024 •

edited

Loading

netlify bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading

youngcw commented Jul 17, 2024

youngcw commented Jul 17, 2024

Midgetwombat commented Jul 17, 2024

youngcw commented Jul 17, 2024

Midgetwombat commented Jul 18, 2024 •

edited

Loading

youngcw commented Jul 18, 2024

Midgetwombat commented Jul 18, 2024

Midgetwombat commented Jul 30, 2024

Midgetwombat commented Jul 30, 2024 •

edited

Loading

Added Pay Distribution Template to Goal-templates #3078

Added Pay Distribution Template to Goal-templates #3078

Conversation

Midgetwombat commented Jul 17, 2024 • edited Loading

netlify bot commented Jul 17, 2024 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Jul 17, 2024 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Jul 17, 2024 • edited Loading

Bundle Stats — loot-core

youngcw commented Jul 17, 2024

youngcw commented Jul 17, 2024

Midgetwombat commented Jul 17, 2024

youngcw commented Jul 17, 2024

Midgetwombat commented Jul 18, 2024 • edited Loading

youngcw commented Jul 18, 2024

Midgetwombat commented Jul 18, 2024

Midgetwombat commented Jul 30, 2024

Midgetwombat commented Jul 30, 2024 • edited Loading

Midgetwombat commented Jul 17, 2024 •

edited

Loading

netlify bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading

Midgetwombat commented Jul 18, 2024 •

edited

Loading

Midgetwombat commented Jul 30, 2024 •

edited

Loading