feat: simplified goal check (#64)

* feat: simplified goal check

* docs: updated usage

BREAKING CHANGE: this alters core flows

Author: kvernon

README.md

@@ -258,4 +258,4 @@ The example result object models:
 
 ```
 
-In it you can get an estimate monthly cash flow by calling `const estimated = timeline.getEstimatedMonthlyCashFlow();`
+In it you can get an estimate monthly cash flow by calling `const mostRecentMonthlyCashflow = timeline.getCashFlowMonthByEndDate();`

src/account/i-user-goal.ts

@@ -1,5 +1,3 @@
-import { IRentalPropertyEntity } from '../properties/i-rental-property-entity';
-
 export interface IUserGoal {
   /**
    * used to determine how much you need want for monthly expenses
@@ -9,7 +7,6 @@ export interface IUserGoal {
   /**
    * method used to help determine if you have met your expenses
    * @param today
-   * @param properties
    */
-  metMonthlyGoal(today: Date, properties: IRentalPropertyEntity[]): boolean;
+  metMonthlyGoal(today: Date): boolean;
 }

src/account/user.ts

@@ -22,9 +22,8 @@ export interface IUser extends IUserInvestorCheck {
   /**
    * method used to help determine if you have met your expenses
    * @param today
-   * @param properties
    */
-  getEstimatedMonthlyCashFlow(today: Date, properties: IRentalPropertyEntity[]): number;
+  getCashFlowMonth(today: Date): number;
 
   clone(): IUser;
 }
@@ -48,23 +47,17 @@ export class User implements IUser {
   /**
    * method used to help determine if you have met your expenses
    * @param today
-   * @param properties
    */
-  metMonthlyGoal(today: Date, properties: IRentalPropertyEntity[]): boolean {
-    return this.getEstimatedMonthlyCashFlow(today, properties) >= this.monthlyIncomeAmountGoal;
+  metMonthlyGoal(today: Date): boolean {
+    return this.getCashFlowMonth(today) >= this.monthlyIncomeAmountGoal;
   }
 
-  getEstimatedMonthlyCashFlow(today: Date, properties: IRentalPropertyEntity[]): number {
-    if (!properties || properties.length === 0) {
+  getCashFlowMonth(today: Date): number {
+    if (!this.ledgerCollection) {
       return 0;
     }
 
-    return currency(
-      properties.reduce(
-        (previousValue, currentValue) => previousValue + currentValue.getEstimatedMonthlyCashFlow(today),
-        0
-      )
-    );
+    return currency(this.ledgerCollection.getCashFlowMonth(today));
   }
 
   /**
@@ -120,8 +113,7 @@ export class User implements IUser {
     let minMonthsRequired = 0;
     if (this.loanSettings && this.loanSettings.length > 0) {
       const found = this.loanSettings.find(
-        (ls) =>
-          ls.name === LoanSettings.MinimumMonthlyReservesForRental && ls.propertyType === PropertyType.SingleFamily
+        (ls) => ls.name === LoanSettings.MinimumMonthlyReservesForRental && ls.propertyType === PropertyType.SingleFamily,
       );
       minMonthsRequired = found?.value ?? 0;
     }
@@ -138,8 +130,7 @@ export class User implements IUser {
     let minMonthsRequired = 0;
     if (this.loanSettings && this.loanSettings.length > 0) {
       const found = this.loanSettings.find(
-        (ls) =>
-          ls.name === LoanSettings.MinimumMonthlyReservesForRental && ls.propertyType === PropertyType.SingleFamily
+        (ls) => ls.name === LoanSettings.MinimumMonthlyReservesForRental && ls.propertyType === PropertyType.SingleFamily,
       );
       minMonthsRequired = found?.value ?? 0;
     }
@@ -156,16 +147,12 @@ export class User implements IUser {
     let minMonthsRequired = 0;
     if (this.loanSettings && this.loanSettings.length > 0) {
       const found = this.loanSettings.find(
-        (ls) =>
-          ls.name === LoanSettings.MinimumMonthlyReservesForRental && ls.propertyType === PropertyType.SingleFamily
+        (ls) => ls.name === LoanSettings.MinimumMonthlyReservesForRental && ls.propertyType === PropertyType.SingleFamily,
       );
       minMonthsRequired = found?.value ?? 0;
     }
 
-    return (
-      this.ledgerCollection.getBalance(date) -
-      this.ledgerCollection.getMinimumSavings(properties, date, minMonthsRequired)
-    );
+    return this.ledgerCollection.getBalance(date) - this.ledgerCollection.getMinimumSavings(properties, date, minMonthsRequired);
   }
 
   clone(): IUser {

src/ledger/ledger-collection.ts

@@ -87,9 +87,7 @@ export class LedgerCollection implements ILedgerCollection {
       return 0;
     }
 
-    return collection
-      .filter((x) => x.typeMatches(type))
-      .reduce((previousValue, currentValue) => previousValue + currentValue.amount, 0);
+    return collection.filter((x) => x.typeMatches(type)).reduce((previousValue, currentValue) => previousValue + currentValue.amount, 0);
   }
 
   constructor() {
@@ -118,7 +116,7 @@ export class LedgerCollection implements ILedgerCollection {
     }
     return this.filter((i) => (date ? i.created.getTime() <= date.getTime() : !!i)).reduce(
       (previousValue, currentValue) => previousValue + currentValue.amount,
-      0
+      0,
     );
   }
 
@@ -154,7 +152,7 @@ export class LedgerCollection implements ILedgerCollection {
 
     return (
       itiriri(properties.filter((p) => p.propertyType === PropertyType.SingleFamily)).sum((r) =>
-        r.getExpensesByDate(date ?? this.collection.last().created)
+        r.getExpensesByDate(date ?? this.collection.last().created),
       ) * minMonthsRequired || 0
     );
   }
@@ -257,15 +255,10 @@ export class LedgerCollection implements ILedgerCollection {
     const ledgerItemsCashFlow = boundary.filter((x) => x.type === LedgerItemType.CashFlow);
 
     result.cashFlow = this.getSummaryByType(boundary, LedgerItemType.CashFlow);
-    result.averageCashFlow = currency(
-      ledgerItemsCashFlow.length > 0 ? result.cashFlow / ledgerItemsCashFlow.length : 0
-    );
+    result.averageCashFlow = currency(ledgerItemsCashFlow.length > 0 ? result.cashFlow / ledgerItemsCashFlow.length : 0);
     result.equity = this.getSummaryByType(boundary, LedgerItemType.Equity);
     result.purchases = this.getSummaryByType(boundary, LedgerItemType.Purchase);
-    result.balance = this.filter((li) => li.dateNotGreaterThan(date)).reduce(
-      (previousValue, currentValue) => previousValue + currentValue.amount,
-      0
-    );
+    result.balance = this.filter((li) => li.dateNotGreaterThan(date)).reduce((previousValue, currentValue) => previousValue + currentValue.amount, 0);
 
     return result;
   }
@@ -321,10 +314,7 @@ export class LedgerCollection implements ILedgerCollection {
     } else {
       for (let month = boundary[0].created.getUTCMonth(); month < 12; month++) {
         const expectedDate = new Date(Date.UTC(year, month, 1));
-        if (
-          !boundary.some((x) => x.dateMatchesYearAndMonth(expectedDate)) &&
-          expectedDate.getTime() >= lastLedgerItem.created.getTime()
-        ) {
+        if (!boundary.some((x) => x.dateMatchesYearAndMonth(expectedDate)) && expectedDate.getTime() >= lastLedgerItem.created.getTime()) {
           const summaryMonth = this.getSummaryMonth(lastLedgerItem.created);
           summaryMonth.date = cloneDateUtc(expectedDate);
           collection.push(summaryMonth);

src/time/default-has-met-goal-or-max-time.ts

@@ -1,29 +1,21 @@
 import { HasMetGoalOrMaxTime } from './has-met-goal-or-max-time';
 import { isEqual, differenceInMonths } from 'date-fns';
 import { IUser } from '../account/user';
-import { IRentalPropertyEntity } from '../properties/i-rental-property-entity';
 import { cloneDateUtc } from '../utils/data-clone-date';
 
 /**
  * Method will compare basic dates w/ null user and all rentals
  * @param start
  * @param today
  * @param user
- * @param rentals
  * @param maxYears
  */
-export const defaultHasMetGoalOrMaxTime: HasMetGoalOrMaxTime = (
-  start: Date,
-  today: Date,
-  user: IUser,
-  rentals: IRentalPropertyEntity[],
-  maxYears: number
-): boolean => {
+export const defaultHasMetGoalOrMaxTime: HasMetGoalOrMaxTime = (start: Date, today: Date, user: IUser, maxYears: number): boolean => {
   if (isEqual(start, today) && !user) {
     return false;
   }
 
-  if (user && user.metMonthlyGoal(today, rentals)) {
+  if (user && user.metMonthlyGoal(today)) {
     return true;
   }
 

src/time/has-met-goal-or-max-time.ts

@@ -1,13 +1,6 @@
 import { IUser } from '../account/user';
-import { IRentalPropertyEntity } from '../properties/i-rental-property-entity';
 
 /**
  * a way to determine if the loop should end based on the user's rules
  */
-export type HasMetGoalOrMaxTime = (
-  start: Date,
-  today: Date,
-  user: IUser,
-  rentals: IRentalPropertyEntity[],
-  maxYears: number
-) => boolean;
+export type HasMetGoalOrMaxTime = (start: Date, today: Date, user: IUser, maxYears: number) => boolean;

src/time/movement.ts

@@ -13,6 +13,8 @@ import { looper } from './looper';
 
 /**
  * This is where the magic happens. You provide the options, and you let this calculate the rest.
+ * The flow is that you do work on a day, then after the changes are done for that day you evaluate it to determine if you met the goal or reached the end.
+ * If you did not meet the goal you start a new day and try again.
  * @param options
  * @param user
  */
@@ -31,9 +33,7 @@ export function movement(options: ILoopOptions, user: IUser): ITimeline {
   }
 
   if (!options.propertyGeneratorPassiveApartment && !options.propertyGeneratorSingleFamily) {
-    throw new Error(
-      'Invalid Argument: must declare at least 1, either propertyGeneratorSingleFamily or propertyGeneratorPassiveApartment'
-    );
+    throw new Error('Invalid Argument: must declare at least 1, either propertyGeneratorSingleFamily or propertyGeneratorPassiveApartment');
   }
 
   ensureArray<ILoanSetting>(user.loanSettings, {
@@ -51,12 +51,7 @@ export function movement(options: ILoopOptions, user: IUser): ITimeline {
     ignoreError: !options.propertyGeneratorSingleFamily && !!options.propertyGeneratorPassiveApartment,
   });
 
-  let result: ITimeline = new Timeline(
-    cloneDateUtc(options.startDate),
-    cloneDateUtc(options.startDate),
-    [],
-    user.clone()
-  );
+  let result: ITimeline = new Timeline(cloneDateUtc(options.startDate), cloneDateUtc(options.startDate), [], user.clone());
 
   do {
     result = looper(options, result);
@@ -65,8 +60,7 @@ export function movement(options: ILoopOptions, user: IUser): ITimeline {
       result.startDate,
       cloneDateUtc(result.user.ledgerCollection.getLatestLedgerItem().created),
       result.user,
-      result.rentals.map((x) => x.property).filter((x) => x.isOwned),
-      options.maxYears
+      options.maxYears,
     )
   );
 

src/time/timeline.ts

@@ -1,6 +1,5 @@
 import { IHistoricalProperty } from './i-historical-property';
 import { IUser } from '../account/user';
-import { ILedgerSummary } from '../ledger/i-ledger-summary';
 import { cloneDateUtc } from '../utils';
 
 export interface ITimeline {
@@ -9,7 +8,7 @@ export interface ITimeline {
   rentals: IHistoricalProperty[];
   user: IUser;
 
-  getEstimatedMonthlyCashFlow(): number;
+  getCashFlowMonthByEndDate(): number;
 
   getBalance(date?: Date): number;
 
@@ -29,35 +28,14 @@ export class Timeline implements ITimeline {
   startDate: Date;
   user: IUser;
 
-  getEstimatedMonthlyCashFlow(): number {
-    return this.user.getEstimatedMonthlyCashFlow(
-      this.endDate,
-      this.rentals.map((x) => x.property).filter((x) => x.isOwned)
-    );
+  getCashFlowMonthByEndDate(): number {
+    return this.user.getCashFlowMonth(cloneDateUtc(this.endDate));
   }
 
   getBalance(date?: Date): number {
     return this.user.ledgerCollection.getBalance(date ?? this.endDate);
   }
 
-  getSummariesAnnualByYear(year?: number): ILedgerSummary[] {
-    return this.user.ledgerCollection.getSummariesAnnual(year ?? this.endDate.getUTCFullYear());
-  }
-
-  getAllSummariesAnnual(): ILedgerSummary[] {
-    let result: ILedgerSummary[] = [];
-
-    for (
-      let startYear: number = this.startDate.getUTCFullYear();
-      startYear < this.endDate.getUTCFullYear();
-      startYear++
-    ) {
-      result = result.concat(this.getSummariesAnnualByYear(startYear));
-    }
-
-    return result;
-  }
-
   clone(): ITimeline {
     return new Timeline(
       cloneDateUtc(this.startDate),
@@ -66,7 +44,7 @@ export class Timeline implements ITimeline {
         property: x.property.clone(),
         reasons: x.reasons.map((x) => ({ ...x })),
       })),
-      this.user.clone()
+      this.user.clone(),
     );
   }
 }

tests/accounts/user.spec.ts

@@ -160,56 +160,17 @@ describe('User unit tests', () => {
   });
 
   describe('and metMonthlyGoal', () => {
-    let rental: jest.Mocked<IRentalPropertyEntity>;
-    beforeEach(() => {
-      rental = {
-        sellPriceByDate: jest.fn(),
-        getEstimatedEquityFromSell: jest.fn(),
-        estimatedCashOnCashReturn: 0,
-        estimatedReturnOnCapitalGain: 0,
-        isAvailable: false,
-        wasPurchased: true,
-        rawEstimatedAnnualCashFlow: 0,
-        getExpensesByDate: jest.fn(),
-        getEstimatedMonthlyCashFlow: jest.fn(),
-        offeredInvestmentAmounts: [0],
-        propertyType: PropertyType.SingleFamily,
-        clone: jest.fn().mockReturnThis(),
-        equityCapturePercent: 0,
-        minSellYears: 0,
-        rawCashFlow: 0,
-        address: '',
-        availableEndDate: new Date(),
-        availableStartDate: new Date(),
-        id: '',
-        isOwned: false,
-        purchaseDate: undefined,
-        purchasePrice: 0,
-        sellPriceAppreciationPercent: 0,
-        soldDate: undefined,
-        canInvestByUser: jest.fn(),
-        canSell: jest.fn(),
-        get costDownPrice(): number {
-          return 0;
-        },
-        getEquityFromSell: jest.fn(),
-        getCashFlowByDate: jest.fn(),
-        isAvailableByDate: jest.fn(),
-      };
-    });
-
     test('should be true', () => {
       const date = new Date();
 
       const expected = 500;
 
-      rental.getEstimatedMonthlyCashFlow.mockReturnValue(expected);
-
       instance.monthlyIncomeAmountGoal = 500;
 
-      expect(instance.metMonthlyGoal(date, [rental])).toBeTruthy();
-      expect(instance.getEstimatedMonthlyCashFlow(date, [rental])).toEqual(expected);
-      expect(rental.getEstimatedMonthlyCashFlow).toHaveBeenCalledWith(date);
+      ledgerCollection.getCashFlowMonth.mockReturnValue(expected);
+
+      expect(instance.metMonthlyGoal(date)).toBeTruthy();
+      expect(instance.getCashFlowMonth(date)).toEqual(expected);
     });
 
     test('should be false', () => {
@@ -219,11 +180,10 @@ describe('User unit tests', () => {
 
       instance.monthlyIncomeAmountGoal = 500;
 
-      rental.getEstimatedMonthlyCashFlow.mockReturnValue(expected);
+      ledgerCollection.getCashFlowMonth.mockReturnValue(expected);
 
-      expect(instance.metMonthlyGoal(date, [rental])).toBeFalsy();
-      expect(instance.getEstimatedMonthlyCashFlow(date, [rental])).toEqual(expected);
-      expect(rental.getEstimatedMonthlyCashFlow).toHaveBeenCalledWith(date);
+      expect(instance.metMonthlyGoal(date)).toBeFalsy();
+      expect(instance.getCashFlowMonth(date)).toEqual(expected);
     });
   });
 });