From 26996ec0f067d85f7ca45e38b93cb4b57687e549 Mon Sep 17 00:00:00 2001 From: Severin Beauvais Date: Fri, 16 Nov 2018 11:30:34 -0800 Subject: [PATCH] PRC-693: model cleanup --- .../application-list.component.html | 46 +++++------ .../review-comments.component.ts | 5 -- src/app/models/application.ts | 78 +++++++++---------- src/app/models/comment.ts | 27 ++++--- src/app/models/commentperiod.ts | 35 +++------ src/app/models/decision.ts | 3 +- src/app/models/document.ts | 1 - src/app/models/feature.ts | 74 +++++++++--------- src/app/models/search.ts | 10 ++- src/app/models/user.ts | 12 +-- src/app/services/api.ts | 14 ++-- src/app/services/application.service.spec.ts | 10 +-- src/app/services/application.service.ts | 3 +- src/app/services/commentperiod.service.ts | 5 -- src/app/services/search.service.ts | 2 - 15 files changed, 147 insertions(+), 178 deletions(-) diff --git a/src/app/applications/application-list/application-list.component.html b/src/app/applications/application-list/application-list.component.html index 8d690274..472b6933 100644 --- a/src/app/applications/application-list/application-list.component.html +++ b/src/app/applications/application-list/application-list.component.html @@ -46,68 +46,68 @@

Crown Lands Applications in British Columbia

- - + + -
+
  • Comment Period Status: - {{item.cpStatus}} + {{app.cpStatus}}
    • -
  • +
  • Comment Period Dates: - {{item.currentPeriod.startDate | date:'mediumDate'}} to {{item.currentPeriod.endDate | date:'mediumDate'}} - -  ({{item.currentPeriod['daysRemaining'] + (item.currentPeriod['daysRemaining'] === 1 ? ' day ' : ' days ') + 'remaining'}}) + {{app.currentPeriod.startDate | date:'mediumDate'}} to {{app.currentPeriod.endDate | date:'mediumDate'}} + +  ({{app.currentPeriod['daysRemaining'] + (app.currentPeriod['daysRemaining'] === 1 ? ' day ' : ' days ') + 'remaining'}})
    • -
  • +
  • Comments Received: - {{item['numComments']}} + {{app['numComments']}}
  • Location: - {{item.location || '-'}} + {{app.location || '-'}}
  • Description: - +
- + info_outline Application Details - + message Review Comments - diff --git a/src/app/applications/review-comments/review-comments.component.ts b/src/app/applications/review-comments/review-comments.component.ts index ffd01ed2..efc0cadb 100644 --- a/src/app/applications/review-comments/review-comments.component.ts +++ b/src/app/applications/review-comments/review-comments.component.ts @@ -146,11 +146,7 @@ export class ReviewCommentsComponent implements OnInit, OnDestroy { const flatComments = comments.map(comment => { // sanitize and flatten each comment object delete comment._commentPeriod; - delete comment.commentAuthor.internal.tags; - delete comment.commentAuthor.tags; delete comment.commentNumber; - delete comment.review.tags; - delete comment.tags; // sanitize documents comment.documents.forEach(document => { delete document._id; @@ -161,7 +157,6 @@ export class ReviewCommentsComponent implements OnInit, OnDestroy { delete document.internalURL; delete document.internalMime; delete document.isDeleted; - delete document.tags; }); // add necessary properties // comment['client'] = this.application.client; // FUTURE diff --git a/src/app/models/application.ts b/src/app/models/application.ts index 0a35707e..033b0a7e 100644 --- a/src/app/models/application.ts +++ b/src/app/models/application.ts @@ -1,21 +1,12 @@ -import { Document } from './document'; +import * as _ from 'lodash'; import { CommentPeriod } from './commentperiod'; import { Decision } from './decision'; +import { Document } from './document'; import { Feature } from './feature'; -import * as _ from 'lodash'; - -class Internal { - notes: string; - - constructor(obj?: any) { - this.notes = obj && obj.notes || null; - } -} export class Application { - _id: string; - // the following are retrieved from the API + _id: string; agency: string; areaHectares: number; businessUnit: string; @@ -23,11 +14,10 @@ export class Application { cl_file: number; client: string; description: string = null; - internal: Internal; legalDescription: string = null; location: string; - name: string; // MAY BE OBSOLETE - publishDate: Date; + name: string; + publishDate: Date = null; purpose: string; status: string; subpurpose: string; @@ -43,38 +33,34 @@ export class Application { isPublished = false; // depends on tags; see below // associated data - documents: Array = []; currentPeriod: CommentPeriod = null; decision: Decision = null; + documents: Array = []; features: Array = []; constructor(obj?: any) { - this._id = obj && obj._id || null; - - this.agency = obj && obj.agency || null; - this.areaHectares = obj && obj.areaHectares || null; - this.businessUnit = obj && obj.businessUnit || null; - this.cl_file = obj && obj.cl_file || null; - this.client = obj && obj.client || null; - this.location = obj && obj.location || null; - this.name = obj && obj.name || null; - this.publishDate = obj && obj.publishDate || null; - this.purpose = obj && obj.purpose || null; - this.status = obj && obj.status || null; - this.subpurpose = obj && obj.subpurpose || null; - this.subtype = obj && obj.subtype || null; - this.tantalisID = obj && obj.tantalisID || null; // not zero - this.tenureStage = obj && obj.tenureStage || null; - this.type = obj && obj.type || null; - - this.region = obj && obj.region || null; - this.appStatus = obj && obj.appStatus || null; - this.cpStatus = obj && obj.cpStatus || null; - - this.currentPeriod = obj && obj.currentPeriod || null; - this.decision = obj && obj.decision || null; - - this.internal = new Internal(obj && obj.internal || null); + this._id = obj && obj._id || null; + this.agency = obj && obj.agency || null; + this.areaHectares = obj && obj.areaHectares || null; + this.businessUnit = obj && obj.businessUnit || null; + this.cl_file = obj && obj.cl_file || null; + this.client = obj && obj.client || null; + this.location = obj && obj.location || null; + this.name = obj && obj.name || null; + this.purpose = obj && obj.purpose || null; + this.status = obj && obj.status || null; + this.subpurpose = obj && obj.subpurpose || null; + this.subtype = obj && obj.subtype || null; + this.tantalisID = obj && obj.tantalisID || null; // not zero + this.tenureStage = obj && obj.tenureStage || null; + this.type = obj && obj.type || null; + this.region = obj && obj.region || null; + this.appStatus = obj && obj.appStatus || null; + this.cpStatus = obj && obj.cpStatus || null; + + if (obj && obj.publishDate) { + this.publishDate = new Date(obj.publishDate); + } // replace \\n (JSON format) with newlines if (obj && obj.description) { @@ -91,6 +77,14 @@ export class Application { } } + if (obj && obj.currentPeriod) { + this.currentPeriod = new CommentPeriod(obj.currentPeriod); + } + + if (obj && obj.decision) { + this.decision = new Decision(obj.decision); + } + // copy documents if (obj && obj.documents) { for (const doc of obj.documents) { diff --git a/src/app/models/comment.ts b/src/app/models/comment.ts index da68bbe2..1429f8b7 100644 --- a/src/app/models/comment.ts +++ b/src/app/models/comment.ts @@ -4,7 +4,6 @@ import { Document } from './document'; class Internal { email: string; phone: string; - tags: Array; isPublished = false; // depends on tags; see below @@ -31,7 +30,6 @@ class CommentAuthor { location: string; requestedAnonymous: boolean; internal: Internal; - tags: Array; isPublished = false; // depends on tags; see below @@ -42,7 +40,7 @@ class CommentAuthor { this.location = obj && obj.location || null; this.requestedAnonymous = obj && obj.requestedAnonymous || null; - this.internal = new Internal(obj && obj.internal || null); + this.internal = new Internal(obj && obj.internal || null); // must exist // wrap isPublished around the tags we receive for this object if (obj && obj.tags) { @@ -59,20 +57,22 @@ class CommentAuthor { class Review { _reviewerId: string; // object id -> User reviewerNotes: string = null; - reviewerDate: Date; - tags: Array; + reviewerDate: Date = null; isPublished = false; // depends on tags; see below constructor(obj?: any) { - this._reviewerId = obj && obj._reviewerId || null; - this.reviewerDate = obj && obj.reviewerDate || null; + this._reviewerId = obj && obj._reviewerId || null; // replace \\n (JSON format) with newlines if (obj && obj.reviewerNotes) { this.reviewerNotes = obj.reviewerNotes.replace(/\\n/g, '\n'); } + if (obj && obj.reviewerDate) { + this.reviewerDate = new Date(obj.reviewerDate); + } + // wrap isPublished around the tags we receive for this object if (obj && obj.tags) { for (const tag of obj.tags) { @@ -93,10 +93,10 @@ export class Comment { comment: string = null; commentAuthor: CommentAuthor; review: Review; - dateAdded: Date; + dateAdded: Date = null; commentStatus: string; - tags: Array; + // associated data documents: Array = []; isPublished = false; // depends on tags; see below @@ -106,12 +106,15 @@ export class Comment { this._addedBy = obj && obj._addedBy || null; this._commentPeriod = obj && obj._commentPeriod || null; this.commentNumber = obj && obj.commentNumber || 0; - this.dateAdded = obj && obj.dateAdded || null; this.commentStatus = obj && obj.commentStatus || null; - this.commentAuthor = new CommentAuthor(obj && obj.commentAuthor || null); + if (obj && obj.dateAdded) { + this.dateAdded = new Date(obj.dateAdded); + } + + this.commentAuthor = new CommentAuthor(obj && obj.commentAuthor || null); // must exist - this.review = new Review(obj && obj.review || null); + this.review = new Review(obj && obj.review || null); // must exist // replace \\n (JSON format) with newlines if (obj && obj.comment) { diff --git a/src/app/models/commentperiod.ts b/src/app/models/commentperiod.ts index 131b41c2..c4cb4510 100644 --- a/src/app/models/commentperiod.ts +++ b/src/app/models/commentperiod.ts @@ -1,40 +1,25 @@ import * as _ from 'lodash'; -class Internal { - notes: string; - _addedBy: string; - - constructor(obj?: any) { - this.notes = obj && obj.notes || null; - this._addedBy = obj && obj._addedBy || null; - } -} - export class CommentPeriod { _id: string; _addedBy: string; _application: string; - description: string = null; - code: string; - startDate: Date; - endDate: Date; - internal: Internal; // OBSOLETE BUT API V1 EXPECTS IT - REMOVE LATER + startDate: Date = null; + endDate: Date = null; isPublished = false; // depends on tags; see below constructor(obj?: any) { - this._id = obj && obj._id || null; - this._addedBy = obj && obj._addedBy || null; - this._application = obj && obj._application || null; - this.code = obj && obj.code || null; - this.startDate = obj && obj.startDate && new Date(obj.startDate) || null; - this.endDate = obj && obj.endDate && new Date(obj.endDate) || null; + this._id = obj && obj._id || null; + this._addedBy = obj && obj._addedBy || null; + this._application = obj && obj._application || null; - this.internal = new Internal(obj && obj.internal || null); + if (obj && obj.startDate) { + this.startDate = new Date(obj.startDate); + } - // replace \\n (JSON format) with newlines - if (obj && obj.description) { - this.description = obj.description.replace(/\\n/g, '\n'); + if (obj && obj.endDate) { + this.endDate = new Date(obj.endDate); } // wrap isPublished around the tags we receive for this object diff --git a/src/app/models/decision.ts b/src/app/models/decision.ts index aa2232df..87be0b5d 100644 --- a/src/app/models/decision.ts +++ b/src/app/models/decision.ts @@ -5,10 +5,10 @@ export class Decision { _id: string; _addedBy: string; _application: string; // objectid -> Application - code: string; name: string; description: string = null; + // associated data documents: Array = []; isPublished = false; // depends on tags; see below @@ -17,7 +17,6 @@ export class Decision { this._id = obj && obj._id || null; this._addedBy = obj && obj._addedBy || null; this._application = obj && obj._application || null; - this.code = obj && obj.code || null; this.name = obj && obj.name || null; // replace \\n (JSON format) with newlines diff --git a/src/app/models/document.ts b/src/app/models/document.ts index d580b419..4507f6d9 100644 --- a/src/app/models/document.ts +++ b/src/app/models/document.ts @@ -11,7 +11,6 @@ export class Document { internalURL: string; isDeleted: boolean; internalMime: string; - tags: Array; isPublished = false; // depends on tags; see below diff --git a/src/app/models/feature.ts b/src/app/models/feature.ts index c9914689..5c0170fb 100644 --- a/src/app/models/feature.ts +++ b/src/app/models/feature.ts @@ -1,41 +1,41 @@ export class Feature { - geometry: { - type: string; - coordinates: any; - }; - geometry_name: string; - id: string; - properties: { - CODE_CHR_STAGE: string; - CROWN_LANDS_FILE: string; - DISPOSITION_TRANSACTION_SID: number; - FEATURE_AREA_SQM: number; - FEATURE_CODE: string; - FEATURE_LENGTH_M: number; - INTRID_SID: number; - OBJECTID: number; - RESPONSIBLE_BUSINESS_UNIT: string; - SW_ANNO_CAD_DATA: any; // TODO: what type is this? - TENURE_AREA_DERIVATION: string; - TENURE_AREA_IN_HECTARES: number; - TENURE_DOCUMENT: string; - TENURE_EXPIRY: string; // TODO: convert to date? - TENURE_LEGAL_DESCRIPTION: string; - TENURE_LOCATION: string; - TENURE_PURPOSE: string; - TENURE_STAGE: string; - TENURE_STATUS: string; - TENURE_SUBPURPOSE: string; - TENURE_SUBTYPE: string; - TENURE_TYPE: string; - }; + geometry: { type: string; + coordinates: any; + }; + geometry_name: string; + id: string; + properties: { + CODE_CHR_STAGE: string; + CROWN_LANDS_FILE: string; + DISPOSITION_TRANSACTION_SID: number; + FEATURE_AREA_SQM: number; + FEATURE_CODE: string; + FEATURE_LENGTH_M: number; + INTRID_SID: number; + OBJECTID: number; + RESPONSIBLE_BUSINESS_UNIT: string; + SW_ANNO_CAD_DATA: any; // TODO: what type is this? + TENURE_AREA_DERIVATION: string; + TENURE_AREA_IN_HECTARES: number; + TENURE_DOCUMENT: string; + TENURE_EXPIRY: string; // TODO: convert to date? + TENURE_LEGAL_DESCRIPTION: string; + TENURE_LOCATION: string; + TENURE_PURPOSE: string; + TENURE_STAGE: string; + TENURE_STATUS: string; + TENURE_SUBPURPOSE: string; + TENURE_SUBTYPE: string; + TENURE_TYPE: string; + }; + type: string; - constructor(obj?: any) { - this.geometry = obj && obj.geometry || null; - this.geometry_name = obj && obj.geometry_name || null; - this.id = obj && obj.id || null; - this.properties = obj && obj.properties || null; - this.type = obj && obj.type || null; - } + constructor(obj?: any) { + this.geometry = obj && obj.geometry || null; + this.geometry_name = obj && obj.geometry_name || null; + this.id = obj && obj.id || null; + this.properties = obj && obj.properties || null; + this.type = obj && obj.type || null; + } } diff --git a/src/app/models/search.ts b/src/app/models/search.ts index 9bf65f48..09fc248d 100644 --- a/src/app/models/search.ts +++ b/src/app/models/search.ts @@ -1,18 +1,19 @@ import { Params } from '@angular/router'; +import { NgbDateStruct } from '@ng-bootstrap/ng-bootstrap'; import * as _ from 'lodash'; import { Feature } from './feature'; -import { NgbDateStruct } from '@ng-bootstrap/ng-bootstrap'; import { InterestedParty } from './interestedParty'; export class SearchResults { _id: string; totalFeatures: number; - date: Date; + date: Date = null; crs: string; type: string; status: string; hostname: string; + features: Array = []; sidsFound: Array = []; @@ -35,7 +36,6 @@ export class SearchResults { constructor(search?: any, hostname?: any) { this._id = search && search._id || null; this.totalFeatures = search && search.totalFeatures || 0; - this.date = search && search.date || null; this.crs = search && search.crs || null; this.type = search && search.type || null; this.status = search && search.status || null; @@ -56,6 +56,10 @@ export class SearchResults { this.centroid = search && search.centroid || null; this.parcels = search && search.parcels || null; + if (search && search.date) { + this.date = new Date(search.date); + } + // copy features if (search && search.features) { for (const feature of search.features) { diff --git a/src/app/models/user.ts b/src/app/models/user.ts index d5d57362..fc070ae8 100644 --- a/src/app/models/user.ts +++ b/src/app/models/user.ts @@ -13,12 +13,12 @@ export class User { isPublished = false; // depends on tags; see below constructor(obj?: any) { - this._id = obj && obj._id || null; - this.username = obj && obj.username || null; - this.displayName = obj && obj.displayName || null; - this.firstName = obj && obj.firstName || null; - this.lastName = obj && obj.lastName || null; - this.password = obj && obj.password || null; + this._id = obj && obj._id || null; + this.username = obj && obj.username || null; + this.displayName = obj && obj.displayName || null; + this.firstName = obj && obj.firstName || null; + this.lastName = obj && obj.lastName || null; + this.password = obj && obj.password || null; // copy roles if (obj && obj.roles) { diff --git a/src/app/services/api.ts b/src/app/services/api.ts index 507bd4ca..5643b0bb 100644 --- a/src/app/services/api.ts +++ b/src/app/services/api.ts @@ -10,7 +10,6 @@ import * as _ from 'lodash'; import { KeycloakService } from 'app/services/keycloak.service'; import { Application } from 'app/models/application'; -import { Client } from 'app/models/client'; import { Comment } from 'app/models/comment'; import { CommentPeriod } from 'app/models/commentperiod'; import { Decision } from 'app/models/decision'; @@ -133,7 +132,7 @@ export class ApiService { // // Applications // - getApplications(): Observable { + getApplications(pageNum: number, pageSize: number): Observable { const fields = [ 'agency', 'areaHectares', @@ -142,7 +141,6 @@ export class ApiService { 'cl_file', 'client', 'description', - 'internal', 'legalDescription', 'location', 'name', @@ -155,8 +153,10 @@ export class ApiService { 'tenureStage', 'type' ]; - // NB: max 1000 records - const queryString = `application?isDeleted=false&pageNum=0&pageSize=1000&fields=${this.buildValues(fields)}`; + let queryString = 'application?isDeleted=false&'; + if (pageNum !== null) { queryString += `pageNum=${pageNum}&`; } + if (pageSize !== null) { queryString += `pageSize=${pageSize}&`; } + queryString += `fields=${this.buildValues(fields)}`; return this.http.get(`${this.pathAPI}/${queryString}`, {}); } @@ -170,7 +170,6 @@ export class ApiService { 'cl_file', 'client', 'description', - 'internal', 'legalDescription', 'location', 'name', @@ -235,7 +234,6 @@ export class ApiService { 'cl_file', 'client', 'description', - 'internal', 'legalDescription', 'location', 'name', @@ -320,7 +318,6 @@ export class ApiService { const fields = [ '_addedBy', '_application', - 'code', 'name', 'description' ]; @@ -333,7 +330,6 @@ export class ApiService { const fields = [ '_addedBy', '_application', - 'code', 'name', 'description' ]; diff --git a/src/app/services/application.service.spec.ts b/src/app/services/application.service.spec.ts index 01239c44..8c1cd744 100644 --- a/src/app/services/application.service.spec.ts +++ b/src/app/services/application.service.spec.ts @@ -1,4 +1,7 @@ import { TestBed, inject } from '@angular/core/testing'; +import { of } from 'rxjs'; +import { Observable } from 'rxjs/Observable'; +import * as moment from 'moment'; import { ApplicationService } from './application.service'; import { ApiService } from 'app/services/api'; @@ -7,9 +10,7 @@ import { CommentPeriodService } from 'app/services/commentperiod.service'; import { CommentService } from 'app/services/comment.service'; import { DecisionService } from 'app/services/decision.service'; import { FeatureService } from 'app/services/feature.service'; -import { of } from 'rxjs'; -import { Observable } from 'rxjs/Observable'; -import * as moment from 'moment'; + import { Feature } from 'app/models/feature'; import { Document } from 'app/models/document'; import { CommentPeriod } from 'app/models/commentperiod'; @@ -17,7 +18,7 @@ import { Decision } from 'app/models/decision'; import { Application } from 'app/models/application'; describe('ApplicationService', () => { - let service; + let service: any; const apiServiceStub = { getApplication(id: string) { @@ -36,7 +37,6 @@ describe('ApplicationService', () => { } }; - const featureServiceStub = { getByApplicationId(applicationId: string) { const features = [ diff --git a/src/app/services/application.service.ts b/src/app/services/application.service.ts index 0ca2b80a..e83d103a 100644 --- a/src/app/services/application.service.ts +++ b/src/app/services/application.service.ts @@ -63,7 +63,8 @@ export class ApplicationService { // get all applications getAll(params: GetParameters = null): Observable { // first get just the applications - return this.api.getApplications() + // NB: max 1000 records + return this.api.getApplications(0, 1000) .pipe( flatMap(apps => { if (!apps || apps.length === 0) { diff --git a/src/app/services/commentperiod.service.ts b/src/app/services/commentperiod.service.ts index c4024005..9ab49dfa 100644 --- a/src/app/services/commentperiod.service.ts +++ b/src/app/services/commentperiod.service.ts @@ -54,11 +54,6 @@ export class CommentPeriodService { // ID must not exist on POST delete period._id; - // replace newlines with \\n (JSON format) - if (period.description) { - period.description = period.description.replace(/\n/g, '\\n'); - } - return this.api.addCommentPeriod(period) .catch(error => this.api.handleError(error)); } diff --git a/src/app/services/search.service.ts b/src/app/services/search.service.ts index dad5c105..0b61fddb 100644 --- a/src/app/services/search.service.ts +++ b/src/app/services/search.service.ts @@ -8,9 +8,7 @@ import * as _ from 'lodash'; import { ApiService } from './api'; import { ApplicationService } from 'app/services/application.service'; import { SearchResults } from 'app/models/search'; -import { Client } from 'app/models/client'; import { Application } from 'app/models/application'; -import { Feature } from 'app/models/feature'; @Injectable() export class SearchService {