feat: add month spent sum (#474)

Author: morremeyer

api/docs.go

@@ -3579,6 +3579,11 @@ const docTemplate = `{
                     "description": "The name of the Budget",
                     "type": "string",
                     "example": "Zero budget"
+                },
+                "spent": {
+                    "description": "The amount of money spent in this month",
+                    "type": "number",
+                    "example": 133.7
                 }
             }
         },

api/swagger.json

@@ -3567,6 +3567,11 @@
                     "description": "The name of the Budget",
                     "type": "string",
                     "example": "Zero budget"
+                },
+                "spent": {
+                    "description": "The amount of money spent in this month",
+                    "type": "number",
+                    "example": 133.7
                 }
             }
         },

api/swagger.yaml

@@ -651,6 +651,10 @@ definitions:
         description: The name of the Budget
         example: Zero budget
         type: string
+      spent:
+        description: The amount of money spent in this month
+        example: 133.7
+        type: number
     type: object
   models.MonthConfigCreate:
     properties:

pkg/controllers/month.go

@@ -159,6 +159,7 @@ func (co Controller) GetMonth(c *gin.Context) {
 
 			// Update the month's balance
 			month.Balance = month.Balance.Add(envelopeMonth.Balance)
+			month.Spent = month.Spent.Add(envelopeMonth.Spent)
 
 			// Set the allocation link. If there is no allocation, we send the collection endpoint.
 			// With this, any client will be able to see that the "Budgeted" amount is 0 and therefore

pkg/controllers/month_test.go

@@ -98,6 +98,7 @@ func (suite *TestSuiteStandard) TestMonth() {
 					Month:   time.Date(2022, 1, 1, 0, 0, 0, 0, time.UTC),
 					Income:  decimal.NewFromFloat(0),
 					Balance: decimal.NewFromFloat(10.99),
+					Spent:   decimal.NewFromFloat(10),
 					Categories: []models.CategoryEnvelopes{
 						{
 							Name: category.Data.Name,
@@ -126,6 +127,7 @@ func (suite *TestSuiteStandard) TestMonth() {
 					Month:   time.Date(2022, 2, 1, 0, 0, 0, 0, time.UTC),
 					Income:  decimal.NewFromFloat(0),
 					Balance: decimal.NewFromFloat(53.11),
+					Spent:   decimal.NewFromFloat(5),
 					Categories: []models.CategoryEnvelopes{
 						{
 							Name: category.Data.Name,
@@ -154,6 +156,7 @@ func (suite *TestSuiteStandard) TestMonth() {
 					Month:   time.Date(2022, 3, 1, 0, 0, 0, 0, time.UTC),
 					Income:  decimal.NewFromFloat(1500),
 					Balance: decimal.NewFromFloat(69.28),
+					Spent:   decimal.NewFromFloat(15),
 					Categories: []models.CategoryEnvelopes{
 						{
 							Name: category.Data.Name,
@@ -197,6 +200,8 @@ func (suite *TestSuiteStandard) TestMonth() {
 			suite.Assert().FailNow("Response envelope length does not match!", "Envelope list does not have exactly 1 item, it has %d, Request ID: %s", len(month.Data.Categories[0].Envelopes), r.Header().Get("x-request-id"))
 		}
 
+		suite.Assert().True(month.Data.Spent.Equal(tt.response.Data.Spent), "Month spent is wrong. Should be %v, but is %v: %#v", tt.response.Data.Spent, month.Data.Spent, month.Data)
+
 		expected := tt.response.Data.Categories[0].Envelopes[0]
 		envelope := month.Data.Categories[0].Envelopes[0]
 		suite.Assert().True(envelope.Spent.Equal(expected.Spent), "Monthly spent calculation for %v is wrong: should be %v, but is %v: %#v", month.Data.Month, expected.Spent, envelope.Spent, month.Data)

pkg/models/month.go

@@ -21,5 +21,6 @@ type Month struct {
 	Income     decimal.Decimal     `json:"income" example:"2317.34"`                          // The total income for the month (sum of all incoming transactions without an Envelope)
 	Available  decimal.Decimal     `json:"available" example:"217.34"`                        // The amount available to budget
 	Balance    decimal.Decimal     `json:"balance" example:"5231.37"`                         // The sum of all envelope balances
+	Spent      decimal.Decimal     `json:"spent" example:"133.70"`                            // The amount of money spent in this month
 	Categories []CategoryEnvelopes `json:"categories"`                                        // A list of envelope month calculations grouped by category
 }