From 572a07bf45a16b70467a64266b747f47b4e0019b Mon Sep 17 00:00:00 2001
From: Karan Takalkar <karant@iitk.ac.in>
Date: Thu, 13 Aug 2020 17:44:23 +0530
Subject: [PATCH] refactor: fixed deposits module (#1201)

See: #1196
---
 src/app/clients/clients-view/clients-view.component.html  | 2 +-
 .../fixed-deposit-account-currency-step.component.ts      | 6 ++++++
 ...-deposit-account-interest-rate-chart-step.component.ts | 1 +
 .../inactivate-charge-dialog.component.ts                 | 1 -
 .../fixed-deposit-account-view.component.ts               | 6 +++---
 .../standing-instructions-tab.component.ts                | 7 +++++++
 .../transactions-tab/transactions-tab.component.ts        | 3 ++-
 .../view-transaction/view-transaction.component.ts        | 1 -
 .../fixed-deposits/fixed-deposits-routing.module.ts       | 4 ++--
 src/app/deposits/fixed-deposits/fixed-deposits.module.ts  | 5 +++++
 src/app/deposits/fixed-deposits/fixed-deposits.service.ts | 8 +++++++-
 11 files changed, 34 insertions(+), 10 deletions(-)

diff --git a/src/app/clients/clients-view/clients-view.component.html b/src/app/clients/clients-view/clients-view.component.html
index 8cafb9e73..06a42de63 100644
--- a/src/app/clients/clients-view/clients-view.component.html
+++ b/src/app/clients/clients-view/clients-view.component.html
@@ -66,7 +66,7 @@
         <button mat-menu-item [routerLink]="['savingsaccounts', 'create-savings-account']">New Savings Account</button>
         <button mat-menu-item *mifosxHasPermission="'CREATE_SHAREACCOUNT'" [routerLink]="['shares-accounts', 'create']">New Share Account</button>
         <button mat-menu-item [routerLink]="['recurringdeposits', 'create-recurring-deposits-account']">New Recurring Deposit Account</button>
-        <button mat-menu-item [routerLink]="['fixed-deposits-accounts', 'create-fixed-deposit-account']">New Fixed Deposits Account</button>
+        <button mat-menu-item [routerLink]="['fixed-deposits-accounts', 'create']">New Fixed Deposits Account</button>
       </mat-menu>
 
       <button mat-raised-button [matMenuTriggerFor]="Actions">
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-currency-step/fixed-deposit-account-currency-step.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-currency-step/fixed-deposit-account-currency-step.component.ts
index b65df2439..499426df9 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-currency-step/fixed-deposit-account-currency-step.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-currency-step/fixed-deposit-account-currency-step.component.ts
@@ -22,6 +22,9 @@ export class FixedDepositAccountCurrencyStepComponent implements OnChanges {
   /** Currency Data */
   currencyData: any;
 
+  /**
+   * @param {FormBuilder} formBuilder Form Builder
+   */
   constructor(private formBuilder: FormBuilder) {
     this.createFixedDepositAccountCurrencyForm();
   }
@@ -36,6 +39,9 @@ export class FixedDepositAccountCurrencyStepComponent implements OnChanges {
     }
   }
 
+  /**
+   * Creates fd currency form.
+   */
   createFixedDepositAccountCurrencyForm() {
     this.fixedDepositAccountCurrencyForm = this.formBuilder.group({
       'currencyCode': [{ value: '', disabled: true}],
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-interest-rate-chart-step/fixed-deposit-account-interest-rate-chart-step.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-interest-rate-chart-step/fixed-deposit-account-interest-rate-chart-step.component.ts
index 7b78dc899..fc6d26374 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-interest-rate-chart-step/fixed-deposit-account-interest-rate-chart-step.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-stepper/fixed-deposit-account-interest-rate-chart-step/fixed-deposit-account-interest-rate-chart-step.component.ts
@@ -36,6 +36,7 @@ export class FixedDepositAccountInterestRateChartStepComponent implements OnChan
   /** Expand Chart Slab Index used in the view */
   expandChartSlabIndex: number;
 
+  /** Interest Rate charts table reference */
   @ViewChild('chartsTable') chartsTableRef: MatTable<Element>;
 
   constructor() { }
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/custom-dialogs/inactivate-charge-dialog/inactivate-charge-dialog.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/custom-dialogs/inactivate-charge-dialog/inactivate-charge-dialog.component.ts
index 6a3515dfc..4996a76e9 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/custom-dialogs/inactivate-charge-dialog/inactivate-charge-dialog.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/custom-dialogs/inactivate-charge-dialog/inactivate-charge-dialog.component.ts
@@ -14,7 +14,6 @@ export class InactivateChargeDialogComponent {
 
   /**
    * @param {MatDialogRef} dialogRef Component reference to dialog.
-   * @param {any} data.
    */
   constructor(public dialogRef: MatDialogRef<InactivateChargeDialogComponent>,
     @Inject(MAT_DIALOG_DATA) public data: any) { }
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/fixed-deposit-account-view.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/fixed-deposit-account-view.component.ts
index c364efde7..8af78ddb4 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/fixed-deposit-account-view.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/fixed-deposit-account-view.component.ts
@@ -103,7 +103,7 @@ export class FixedDepositAccountViewComponent implements OnInit {
         this.router.navigate([`actions/${name}`], { relativeTo: this.route });
         break;
       case 'Modify Application':
-        this.router.navigate(['edit-fixed-deposit-account'], { relativeTo: this.route });
+        this.router.navigate(['edit'], { relativeTo: this.route });
         break;
       case 'Delete':
         this.deleteFixedDepositsAccount();
@@ -140,7 +140,7 @@ export class FixedDepositAccountViewComponent implements OnInit {
   }
 
   /**
-   * Calculates savings account's interest
+   * Calculates fixed deposit account's interest
    */
   private calculateInterest() {
     const calculateInterestAccountDialogRef = this.dialog.open(CalculateInterestDialogComponent);
@@ -154,7 +154,7 @@ export class FixedDepositAccountViewComponent implements OnInit {
   }
 
   /**
-   * Posts savings account's interest
+   * Posts fixed deposit account's interest
    */
   private postInterest() {
     const postInterestAccountDialogRef = this.dialog.open(PostInterestDialogComponent);
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/standing-instructions-tab/standing-instructions-tab.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/standing-instructions-tab/standing-instructions-tab.component.ts
index 439a6871e..b9fa0b3dd 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/standing-instructions-tab/standing-instructions-tab.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/standing-instructions-tab/standing-instructions-tab.component.ts
@@ -43,6 +43,9 @@ export class StandingInstructionsTabComponent implements OnInit {
   /**
    * Retrieves Fixed Deposits Account Data from `resolve`.
    * @param {ActivatedRoute} route Activated Route.
+   * @param {FixedDepositsService} fixedDepositsService FixedDepositsService
+   * @param {MatDialog} dialog Mat Dialog
+   * @param {AccountTransfersService} accountTransfersService Accounts Transfer Service
    */
   constructor(private route: ActivatedRoute,
               private fixedDepositsService: FixedDepositsService,
@@ -73,6 +76,10 @@ export class StandingInstructionsTabComponent implements OnInit {
     });
   }
 
+  /**
+   * Deletes a standing instruction
+   * @param {any} instructionId Instruction Id
+   */
   deleteStandingInstruction(instructionId: any) {
     const deleteStandingInstructionDialogRef = this.dialog.open(DeleteDialogComponent, {
       data: { deleteContext: `standing instruction id: ${instructionId}` }
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/transactions-tab/transactions-tab.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/transactions-tab/transactions-tab.component.ts
index b6dfd0be5..56e548d42 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/transactions-tab/transactions-tab.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/transactions-tab/transactions-tab.component.ts
@@ -25,6 +25,7 @@ export class TransactionsTabComponent implements OnInit {
   /**
    * Retrieves fixed deposits account data from `resolve`.
    * @param {ActivatedRoute} route Activated Route.
+   * @param {Router} router Router
    */
   constructor(private route: ActivatedRoute,
               private router: Router) {
@@ -49,7 +50,7 @@ export class TransactionsTabComponent implements OnInit {
 
   /**
    * Show Transactions Details
-   * @param transactionsData Transactions Data
+   * @param {any} transactionsData Transactions Data
    */
   showTransactions(transactionsData: any) {
     if (transactionsData.transfer) {
diff --git a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/view-transaction/view-transaction.component.ts b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/view-transaction/view-transaction.component.ts
index c1c510ef1..c1f1ea16e 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposit-account-view/view-transaction/view-transaction.component.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposit-account-view/view-transaction/view-transaction.component.ts
@@ -5,7 +5,6 @@ import { MatDialog } from '@angular/material';
 
 /**
  * View Transaction Component.
- * TODO: Add support for account transfers.
  */
 @Component({
   selector: 'mifosx-view-transaction',
diff --git a/src/app/deposits/fixed-deposits/fixed-deposits-routing.module.ts b/src/app/deposits/fixed-deposits/fixed-deposits-routing.module.ts
index dbf6c39dc..9f5224f8c 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposits-routing.module.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposits-routing.module.ts
@@ -32,7 +32,7 @@ const routes: Routes = [
     data: { title: extract('All Fixed Deposits'), breadcrumb: 'Fixed Deposits', routeParamBreadcrumb: false },
     children: [
       {
-        path: 'create-fixed-deposit-account',
+        path: 'create',
         data: { title: extract('Create Fixed Deposit Account'), breadcrumb: 'Create Fixed Deposit Account' },
         component: CreateFixedDepositAccountComponent,
         resolve: {
@@ -87,7 +87,7 @@ const routes: Routes = [
             ]
           },
           {
-            path: 'edit-fixed-deposit-account',
+            path: 'edit',
             data: { title: extract('Edit Fixed Deposit Account'), breadcrumb: 'Edit', routeParamBreadcrumb: false },
             component: EditFixedDepositAccountComponent,
             resolve: {
diff --git a/src/app/deposits/fixed-deposits/fixed-deposits.module.ts b/src/app/deposits/fixed-deposits/fixed-deposits.module.ts
index adb78698f..d07ea695c 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposits.module.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposits.module.ts
@@ -42,6 +42,11 @@ import { FixedDepositAccountPreviewStepComponent } from './fixed-deposit-account
 import { FixedDepositAccountCurrencyStepComponent } from './fixed-deposit-account-stepper/fixed-deposit-account-currency-step/fixed-deposit-account-currency-step.component';
 import { EditFixedDepositAccountComponent } from './edit-fixed-deposit-account/edit-fixed-deposit-account.component';
 
+/**
+ * Fixed Deposits Module
+ *
+ * All components related to fixed deposits functions should be declared here.
+ */
 @NgModule({
   declarations: [
     FixedDepositAccountViewComponent,
diff --git a/src/app/deposits/fixed-deposits/fixed-deposits.service.ts b/src/app/deposits/fixed-deposits/fixed-deposits.service.ts
index 545b9694c..827c50f9c 100644
--- a/src/app/deposits/fixed-deposits/fixed-deposits.service.ts
+++ b/src/app/deposits/fixed-deposits/fixed-deposits.service.ts
@@ -13,6 +13,9 @@ import { Observable } from 'rxjs';
 })
 export class FixedDepositsService {
 
+  /**
+   * @param {HttpClient} http HttpClient
+   */
   constructor(private http: HttpClient) {}
 
   /**
@@ -83,7 +86,10 @@ export class FixedDepositsService {
     return this.http.get('/fixeddepositaccounts/template', { params: httpParams });
   }
 
-
+  /**
+   * @param {string} accountId Fixed Deposits Account Id
+   * @returns {Observable<any>}
+   */
   getFixedDepositsAccountAndTemplate(accountId: any) {
     const httpParams = new HttpParams().set('associations', 'charges,+linkedAccount')
       .set('template', 'true');