feat: exposed ledgercollection; fixed dates

Author: kvernon

.circleci/config.yml

@@ -73,6 +73,38 @@ jobs:
           path: ./reports/junit/
       - store_artifacts:
           path: ./reports/junit/
+  unit-test-badge:
+    executor: my-custom-executor
+    working_directory: ~/tmp
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            # when lock file changes, use increasingly general patterns to restore cache
+            - node-{{ .Branch }}-{{ checksum "package-lock.json" }}-<< pipeline.id >>
+      - restore_cache:
+          keys:
+            # when lock file changes, use increasingly general patterns to restore cache
+            - node-{{ .Branch }}-build-<< pipeline.id >>
+      - run:
+          name: Run tests with JUnit as reporter
+          command: npm run test:cov-and-badge
+  int-test:
+    executor: my-custom-executor
+    working_directory: ~/tmp
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            # when lock file changes, use increasingly general patterns to restore cache
+            - node-{{ .Branch }}-{{ checksum "package-lock.json" }}-<< pipeline.id >>
+      - restore_cache:
+          keys:
+            # when lock file changes, use increasingly general patterns to restore cache
+            - node-{{ .Branch }}-build-<< pipeline.id >>
+      - run:
+          name: Run tests with JUnit as reporter
+          command: npm run test:ci:int
   publish:
     executor: my-custom-executor
     working_directory: ~/tmp
@@ -106,9 +138,20 @@ workflows:
       - unit-test:
           requires:
             - lint
-      - publish:
+            - build
+      - int-test:
           requires:
             - unit-test
+      - unit-test-badge:
+          requires:
+            - unit-test
+          filters:
+            branches:
+              only: main
+      - publish:
+          requires:
+            - int-test
+            - unit-test-badge
           filters:
             branches:
               only: main

README.md

@@ -1,7 +1,9 @@
 # realty-investor-timeline
 
-[![CircleCI](https://circleci.com/gh/kvernon/realty-investor-timeline.svg?style=shield)](https://circleci.com/gh/kvernon/realty-investor-timeline) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![Wallaby.js](https://img.shields.io/badge/wallaby.js-configured-green.svg)](https://wallabyjs.com) ![](./badges/badge.svg)
+[![CircleCI](https://circleci.com/gh/kvernon/realty-investor-timeline.svg?style=shield)](https://circleci.com/gh/kvernon/realty-investor-timeline)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Wallaby.js](https://img.shields.io/badge/wallaby.js-configured-green.svg)](https://wallabyjs.com)
+![](./badges/badge.svg)
 
 A way to determine if and when your expenses would be covered through rental properties
 

badges/badge.svg

@@ -13,5 +13,6 @@ delete uConfig.testMatch;
 
 export default {
   ...uConfig,
-  testMatch: ['<rootDir>/tests_int/*.+(int-spec|int-test).[jt]s?(x)'],
+  verbose: false,
+  testMatch: ['<rootDir>/tests_int/*.+(spec|test).[jt]s?(x)'],
 };

jest.integation.config.ts

@@ -12,11 +12,13 @@
     "test": "jest",
     "pretest": "rimraf ./.jestcache",
     "test:cov": "jest --coverage",
+    "test:cov:badge": "jest --coverage --ci --runInBand",
     "test:ci": "jest --config ./jest.ci.config.ts --ci --runInBand",
     "test:int": "jest --config ./jest.integation.config.ts",
+    "test:ci:int": "jest --config ./jest.integation.config.ts --ci --runInBand",
     "test:related": "jest --findRelatedTests",
     "test:gen-badges": "make-coverage-badge --output-path \"./badges/badge.svg\"",
-    "test:cov-and-badge": "npm run test:cov  && npm run test:gen-badges",
+    "test:cov-and-badge": "npm run test:cov:badge  && npm run test:gen-badges",
     "eslint": "eslint . --ext .js,.jsx,.ts,.tsx --config .eslintrc.json",
     "eslint:fix": "eslint . --ext .js,.jsx,.ts,.tsx --config .eslintrc.json --fix",
     "prepare": "husky install"

package.json

@@ -8,7 +8,7 @@ module.exports = {
     }],
     ['@semantic-release/npm'],
     ['@semantic-release/git', {
-      'assets': ['docs', 'package.json', 'package-lock.json'],
+      'assets': ['docs', 'package.json', 'package-lock.json', 'badges'],
       'message': 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
     }]
   ]

release.config.js

@@ -20,6 +20,8 @@ export interface IUser extends IUserInvestorCheck {
 
   addLedgerItem(item: LedgerItem | Iterable<LedgerItem>): void;
 
+  getCashFlowMonth(date: Date): number;
+
   getSummaryMonth(date: Date): ILedgerSummary;
 
   getSummaryAnnual(year: number): ILedgerSummary;
@@ -73,6 +75,10 @@ export class User implements IUser {
     return this.ledgerCollection.getBalance(date);
   }
 
+  getCashFlowMonth(date: Date): number {
+    return this.ledgerCollection.getCashFlowMonth(date);
+  }
+
   addLedgerItem(item: LedgerItem | Iterable<LedgerItem>): void {
     this.ledgerCollection.add(item);
   }

src/account/user.ts

@@ -4,6 +4,8 @@ import { ILedgerSummary } from './i-ledger-summary';
 import { LedgerItemType } from './ledger-item-type';
 import { IRentalSavings, RentalSingleFamily } from '../properties';
 import currency from '../formatters/currency';
+import { cloneDateUtc } from '../utils/data-clone-date';
+import { differenceInMonths } from 'date-fns';
 
 export interface ILedgerCollection {
   getBalance(date: Date): number;
@@ -25,20 +27,27 @@ export interface ILedgerCollection {
   clone(): ILedgerCollection;
 }
 
+export type LedgerItemPredicate = (x: LedgerItem, index: number) => boolean;
+
 export class LedgerCollection implements ILedgerCollection {
   private collection: IterableQuery<LedgerItem>;
 
   private getSummaryByType(collection: IterableQuery<LedgerItem>, type: LedgerItemType): number {
     if (!collection) {
       return 0;
     }
+
     return collection.filter((x) => x.typeMatches(type)).sum((x) => x.amount) || 0;
   }
 
   constructor() {
     this.collection = itiriri([]);
   }
 
+  filter(pred: LedgerItemPredicate): LedgerItem[] {
+    return this.collection.filter(pred).toArray();
+  }
+
   getBalance(date: Date): number {
     return this.isEmpty()
       ? 0
@@ -113,7 +122,7 @@ export class LedgerCollection implements ILedgerCollection {
     }
 
     const result: ILedgerSummary = {
-      date: new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), 1)),
+      date: cloneDateUtc(date),
       balance: 0,
       cashFlow: 0,
       averageCashFlow: 0,
@@ -131,14 +140,14 @@ export class LedgerCollection implements ILedgerCollection {
       return result;
     }
 
-    const salary = this.getSummaryByType(boundary, LedgerItemType.Salary);
     result.cashFlow = this.getSummaryByType(boundary, LedgerItemType.CashFlow);
     result.averageCashFlow = currency(
       boundary.filter((x) => x.type === LedgerItemType.CashFlow).average((x) => x.amount) || 0
     );
     result.equity = this.getSummaryByType(boundary, LedgerItemType.Equity);
     result.purchases = this.getSummaryByType(boundary, LedgerItemType.Purchase);
-    result.balance = result.cashFlow + salary + result.equity - result.purchases || 0;
+    result.purchases = this.getSummaryByType(boundary, LedgerItemType.Purchase);
+    result.balance = this.collection.filter((li) => li.dateNotGreaterThan(date)).sum((x) => x.amount) || 0;
 
     return result;
   }
@@ -157,12 +166,14 @@ export class LedgerCollection implements ILedgerCollection {
       };
     }
 
+    const cashFlowSum = summaries.sum((x) => x.cashFlow || 0);
+
     return {
       date: summaries.first().date,
-      balance: summaries.sum((x) => x.balance || 0),
+      balance: summaries.last().balance,
       equity: summaries.sum((x) => x.equity || 0),
-      cashFlow: summaries.sum((x) => x.cashFlow || 0),
-      averageCashFlow: currency(summaries.average((x) => x.cashFlow || 0)),
+      cashFlow: cashFlowSum,
+      averageCashFlow: currency(cashFlowSum / summaries.length()),
       purchases: summaries.sum((x) => x.purchases || 0),
     };
   }
@@ -183,11 +194,19 @@ export class LedgerCollection implements ILedgerCollection {
     }
 
     const collection = [];
-    for (let month = boundary.first().created.getUTCMonth(); month < 12; month++) {
-      collection.push(this.getSummaryMonth(new Date(Date.UTC(year, month, 1))));
+
+    //need to determine monthDiff between boundary
+    const totalMonths = differenceInMonths(boundary.first().created, boundary.last().created);
+
+    if (totalMonths === 0) {
+      collection.push(this.getSummaryMonth(boundary.first().created));
+    } else {
+      for (let month = boundary.first().created.getUTCMonth(); month < 12; month++) {
+        collection.push(this.getSummaryMonth(new Date(Date.UTC(year, month, 1))));
+      }
     }
 
-    return collection;
+    return collection; //?
   }
 
   clone(): ILedgerCollection {

src/ledger/ledger-collection.ts

@@ -1,4 +1,5 @@
 import { LedgerItemType } from './ledger-item-type';
+import compareDates from '../utils/data-compare-date';
 
 /**
  * this is an entry into the account. Think of it as a checking account, and it's simply a transaction line.
@@ -29,6 +30,22 @@ export class LedgerItem {
     return today.getUTCMonth() === this.created.getUTCMonth();
   }
 
+  dateLessThanOrEqualTo(today: Date): boolean {
+    if (!today || !this.created) {
+      return false;
+    }
+
+    return compareDates(this.created, today) >= 0;
+  }
+
+  dateNotGreaterThan(today: Date): boolean {
+    if (!today || !this.created) {
+      return false;
+    }
+
+    return compareDates(this.created, today) !== 1;
+  }
+
   dateMatchesYear(year: number): boolean {
     if (!this.created) {
       return false;

src/ledger/ledger-item.ts

@@ -177,7 +177,7 @@ export class RentalSingleFamily implements IEntityExistence, IRentalSavings, IRe
       return false;
     }
 
-    return compareDates(this.minSellDate, today) !== -1 || areSameDate(this.minSellDate, today);
+    return compareDates(this.minSellDate, today) <= 0 || areSameDate(this.minSellDate, today);
   }
 
   get minSellDate(): Date {
@@ -212,7 +212,7 @@ export class RentalSingleFamily implements IEntityExistence, IRentalSavings, IRe
       return 0;
     }
 
-    if (!this.soldDate && compareDates(this.purchaseDate, today) === -1) {
+    if (!this.soldDate || compareDates(this.purchaseDate, today) === -1) {
       return this.monthlyPrincipalInterestTaxInterest;
     }