feat: user

Author: kvernon

.circleci/config.yml

@@ -3,18 +3,19 @@ version: 2.1
 executors:
   my-custom-executor:
     docker:
-      - image: cimg/node:14.17.6
+      - image: cimg/node:14.18.0
 
 # Define the jobs we want to run for this project
 jobs:
   build:
     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" }}
+            - node-{{ .Branch }}-{{ checksum "package-lock.json" }}-<< pipeline.id >>
       - restore_cache:
           keys:
             # when lock file changes, use increasingly general patterns to restore cache
@@ -25,20 +26,24 @@ jobs:
           command: npm run build
       - save_cache:
           paths:
-            - node_modules
-          key: node-{{ .Branch }}-{{ checksum "package-lock.json" }}
+            - ~/tmp/node_modules
+          key: node-{{ .Branch }}-{{ checksum "package-lock.json" }}-<< pipeline.id >>
       - save_cache:
           paths:
-            - dist
+            - ~/tmp/dist
           key: node-{{ .Branch }}-build-<< pipeline.id >>
+      - store_artifacts:
+          path: ~/tmp/dist
+          destination: artifact-dist
   lint:
     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" }}
+            - node-{{ .Branch }}-{{ checksum "package-lock.json" }}-<< pipeline.id >>
       - restore_cache:
           keys:
             # when lock file changes, use increasingly general patterns to restore cache
@@ -48,27 +53,34 @@ jobs:
           command: npm run eslint
   unit-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" }}
+            - 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: unit testing
-          command:  npm run test
+          name: Run tests with JUnit as reporter
+          command: npm run test:ci
+          environment:
+            - JEST_JUNIT_OUTPUT_FILE: "reports/junit/junit.xml"
+      - store_test_results:
+          path: ./reports/junit/
+      - store_artifacts:
+          path: ./reports/junit/
   publish:
     executor: my-custom-executor
     steps:
       - checkout
       - restore_cache:
           keys:
             # when lock file changes, use increasingly general patterns to restore cache
-            - node-{{ .Branch }}-{{ checksum "package-lock.json" }}
+            - node-{{ .Branch }}-{{ checksum "package-lock.json" }}-<< pipeline.id >>
       - restore_cache:
           keys:
             # when lock file changes, use increasingly general patterns to restore cache

.gitignore

@@ -57,6 +57,9 @@ typings/
 # Optional eslint cache
 .eslintcache
 
+# Optional jest cache
+.jestcache
+
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/

README.md

@@ -13,29 +13,34 @@ Will be based on version 1
 ## Inspiration
 
 This was originally used as a discussion point between me and my SO. The idea is that we like our jobs, but we also want
-a way to ensure that if anything happens to us, would we be able to sustain our income.
+a way to ensure that if anything happens to us, we would be able to sustain our income.
 
 For me, I was inspired by a game originally from early 2000's where you could quickly click on houses and flip them, but
 after this idea and speaking with mentors, the idea has become find an optimal way to _ramp-up_.
 
+> ☝️Mentors are great! They do a great job at helping you discover how to get to the next point in your life. Also, a
+> mentor is someone who has done the thing and is either where you've been or want to go. AKA, don't ask a someone how
+> to become a CEO when that person has never been a CEO. (Hopefully that give you a good idea)
+
 ## What this does
 
-As mentioned prior, we want to find a way to _ramp-up_. This library will show work through the scenarios of houses and
-provide a way to collect them. Equally, it'll provide feedback as to why you passed on a property. For example, it could
-be that you didn't have enough cash. Another is that you may have wanted more cash flow per month. After you see the
-trends, and based on the time-line hand at play, you could realize that your ideas need to become a littler more broad.
+As mentioned prior, we want to find a way to _ramp-up_. This library will work through the scenarios of houses and
+provide a way to collect them. Once it completes, it'll provide feedback as to why you passed on a property.
+
+For example, it could be that you didn't have enough cash. Another is that you may have wanted more cash flow per month.
+After you see the trends, and based on the time-line hand at play, you could realize that you might need to expand on
+your ideal finds.
 
-The basics are that we do a loop that simulates a per-month advance. In there we take your money saved and determine if
-you have enough to acquire more properties. Equally, we run through selling of properties too, because it's a common
-practice.
+The library loop simulates a per-month savings. In there it will take your money saved and determine if you have enough
+to acquire more properties. Equally, we run through selling of properties too, because it's a common practice.
 
 ## Building
 
 ### Node version
 
-On linux, mac, etc... do: `$ nvm install`
+On linux, mac, etc... do: `$ nvm install`, referencing this manager: `https://github.com/nvm-sh/nvm`
 
-on windows: `$ nvs install`
+on windows: `$ nvs install`, referencing this manager: `https://github.com/jasongin/nvs`
 
 ### Getting the Repo up and running
 
@@ -47,7 +52,7 @@ on windows: `$ nvs install`
 
 `$ npm run tests`
 
-> ⚠ This can run using Wallaby.js in automatic config, or you can use the config supplied here
+> ☝️This can run using Wallaby.js in automatic config, or you can use the config supplied here
 
 ### CI/CD (Delivery)
 
@@ -68,7 +73,10 @@ Once a feature's PR is merged, the pipeline will run checks and publish.
 - Mortgage calc ✔
 - Rent amount ✔
 - Cash flow ✔
+- Appreciation calculation ✔
 - Equity (simple) ✔
+- Monthly summaries ✔
+- Annual summaries ✔
 
 ### Needed things (in no order)
 
@@ -81,8 +89,9 @@ Once a feature's PR is merged, the pipeline will run checks and publish.
 
 ## Missing features
 
-1. user
-2. apartments (passive investor)
+1. currency formatting
+2. easier setup
+3. apartments (passive investor)
 
 ## Future
 
@@ -93,27 +102,148 @@ Once a feature's PR is merged, the pipeline will run checks and publish.
 As this is still in progress, the current flow is as follows:
 
 ```typescript
-import * as all from "@cubedelement.com/realty-investor-timeline";
-
-const metGoal: all.HasMetGoalOrMaxTime = (
-  start: Date,
-  today: Date,
-  user: all.IUser,
-  maxYears: number
-): boolean => {
-  if (user.goals.metMonthlyGoal(today)) {
-    return true;
-  }
-
-  return false;
+import {
+  HasMetGoalOrMaxTime,
+  ILoopOptions,
+  loop,
+  LedgerCollection,
+  LoanSettings,
+  PropertyType,
+  RentalGenerator,
+  RentalSingleFamily,
+  RuleEvaluation,
+  PurchaseRuleTypes,
+  ValueCache,
+  User,
+} from "@cubedelement.com/realty-investor-timeline";
+
+// setup up how much money you have to get started
+const totalSavings = new LedgerItem();
+totalSavings.amount = 100000;
+totalSavings.note = "already saved";
+totalSavings.type = LedgerItemType.Saved;
+totalSavings.created = new Date();
+totalSavings.created.setDate(1);
+
+const ledgerCollection = new LedgerCollection();
+ledgerCollection.add(totalSavings);
+
+//you
+const user = new User(ledgerCollection);
+user.monthlySavedAmount = 10000; //everything you put into savings each month after your expenses
+
+//TODO: clean this idea up
+user.goals = {
+  metMonthlyGoal(today: Date): boolean {
+    return (
+      ledgerCollection.getCashFlowMonth(today) >=
+      user.goals.monthlyIncomeAmountGoal
+    );
+  },
+  monthlyIncomeAmountGoal: 10000,
 };
 
-const results = all.loop(
+//These are loan rules. In this example for SingleFamily (SF) we have good credit loan amount with a conventional 30 year mortgage.
+//Also, for this state, it's required to keep 6 months of savings for each rental
+user.loanSettings = [
+  {
+    propertyType: PropertyType.SingleFamily,
+    name: LoanSettings.minimumReservesSingleFamily,
+    value: 6,
+  },
+  {
+    name: LoanSettings.loanRatePercent,
+    value: 4,
+    propertyType: PropertyType.SingleFamily,
+  },
   {
-    startDate: new Date(),
-    maxYears: 30,
-    hasMetGoalOrMaxTime: metGoal,
+    name: LoanSettings.loanTermInYears,
+    value: 30,
+    propertyType: PropertyType.SingleFamily,
   },
-  user
+];
+
+//These are your requirements for what you're looking for in a property!
+user.purchaseRules = [
+  new RuleEvaluation(30000, PurchaseRuleTypes.maxEstimatedOutOfPocket),
+  new RuleEvaluation(7000, PurchaseRuleTypes.minEstimatedCapitalGains),
+  new RuleEvaluation(200, PurchaseRuleTypes.minEstimatedCashFlowPerMonth),
+];
+
+const date = new Date();
+const valueCache = new ValueCache(
+  new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), 1)),
+  [],
+  2
 );
+const propertyGeneratorSingleFamily = new RentalGenerator<RentalSingleFamily>(
+  valueCache,
+  generateSingleFamily
+);
+propertyGeneratorSingleFamily.maxRentalOpportunities = 4;
+propertyGeneratorSingleFamily.highestMinSellInYears = 1;
+propertyGeneratorSingleFamily.lowestMinSellInYears = 1;
+propertyGeneratorSingleFamily.highestPriceDown = 200000;
+propertyGeneratorSingleFamily.lowestPriceDown = 150000;
+propertyGeneratorSingleFamily.highestSellAppreciationPercent = 7;
+propertyGeneratorSingleFamily.lowestSellAppreciationPercent = 5;
+propertyGeneratorSingleFamily.lowestCashFlowMonthly = 200;
+propertyGeneratorSingleFamily.highestCashFlowMonthly = 500;
+propertyGeneratorSingleFamily.lowestEquityCapturePercent = 7;
+propertyGeneratorSingleFamily.highestEquityCapturePercent = 15;
+
+const options: ILoopOptions = {
+  propertyGeneratorSingleFamily,
+  maxYears: 1,
+};
+
+const actual = loop(options, user);
+
+//Finally, to review your results, you can use the ledgerCollection from above.
+const lastYear = ledgerCollection.getSummariesAnnual(
+  actual.endDate.getUTCFullYear()
+);
+```
+
+The example result object models:
+ITimeline:
+
+```JSON
+{
+  "startDate": "2021-11-01T00:00:00.000Z",
+  "endDate": "2022-11-01T00:00:00.000Z",
+  "rentals": [
+    {
+      "property": {
+        "sellPriceAppreciationPercent": 6,
+        "minSellYears": 1,
+        "id": "7674c1ec-2fb6-4828-9490-271e9ab4a3c4",
+        "purchasePrice": 162373,
+        "address": "1791 Wama Extension",
+        "monthlyCashFlow": 237,
+        "availableStartDate": "2021-12-01T00:00:00.000Z",
+        "availableEndDate": "2022-02-01T00:00:00.000Z",
+        "cashDownPercent": 25,
+        "monthlyPrincipalInterestTaxInterest": 949.5723384565815,
+        "_purchaseDate": "2022-01-01T06:00:00.000Z",
+        "_soldDate": "2022-02-01T06:00:00.000Z"
+      },
+      "reasons": []
+    }
+  ],
+  "user": {
+    "ledgerCollection": {
+      "collection": {
+        "source": [
+          {
+            "amount": 119603.25,
+            "type": "Equity Capture",
+            "created": "2022-11-01T00:00:00.000Z",
+            "note": "for: 1791 Wama Extension, id: 7674c1ec-2fb6-4828-9490-271e9ab4a3c4"
+          }
+        ]
+      }
+    }
+  }
+}
 ```

jest.ci.config.ts

@@ -0,0 +1,13 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const uConfig = require('./jest.config').default;
+
+export default {
+  ...uConfig,
+  testResultsProcessor: 'jest-junit',
+  reporters: ['default', 'jest-junit'],
+};

jest.config.ts

@@ -11,7 +11,7 @@ export default {
   // bail: 0,
 
   // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "",
+  cacheDirectory: ".jestcache",
 
   // Automatically clear mock calls and instances between every test
   // clearMocks: false,
@@ -26,7 +26,7 @@ export default {
   coverageDirectory: "coverage",
 
   // An array of regexp pattern strings used to skip coverage collection
-  coveragePathIgnorePatterns: ["\\node_modules\\", "\\src\\**\\index.ts"],
+  coveragePathIgnorePatterns: ["/node_modules/", "index.ts"],
 
   // Indicates which provider should be used to instrument code for coverage
   // coverageProvider: "babel",
@@ -167,7 +167,7 @@ export default {
   // unmockedModulePathPatterns: undefined,
 
   // Indicates whether each individual test should be reported during the run
-  // verbose: true,
+  verbose: true,
 
   // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
   // watchPathIgnorePatterns: [],