From b1a25718584c41a2def85890d24309bff60dfee8 Mon Sep 17 00:00:00 2001 From: lotte Date: Fri, 25 Jan 2019 13:27:18 +0100 Subject: [PATCH 01/18] 59334: basic edit metadata implementation --- resources/i18n/en.json | 3 + .../edit-item-page.component.html | 2 +- .../edit-item-page/edit-item-page.module.ts | 6 +- .../edit-in-place-field.component.html | 42 ++++++++++++++ .../edit-in-place-field.component.scss | 3 + .../edit-in-place-field.component.ts | 41 +++++++++++++ .../item-metadata.component.html | 12 ++++ .../item-metadata/item-metadata.component.ts | 37 ++++++++++++ .../builders/remote-data-build.service.ts | 19 ++----- src/app/core/registry/registry.service.ts | 57 ++++++++++++++++++- src/app/core/shared/metadatum.model.ts | 1 - src/app/core/shared/operators.ts | 2 +- 12 files changed, 206 insertions(+), 19 deletions(-) create mode 100644 src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html create mode 100644 src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss create mode 100644 src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts create mode 100644 src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html create mode 100644 src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts diff --git a/resources/i18n/en.json b/resources/i18n/en.json index 95b39fdb15..f8aa8eddca 100644 --- a/resources/i18n/en.json +++ b/resources/i18n/en.json @@ -159,6 +159,9 @@ "cancel": "Cancel", "success": "The item has been deleted", "error": "An error occured while deleting the item" + }, + "metadata": { + "add-button": "Add new metadata" } } }, diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.html b/src/app/+item-page/edit-item-page/edit-item-page.component.html index 001b484c2c..46a8126b05 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.html +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.html @@ -16,7 +16,7 @@ - + diff --git a/src/app/+item-page/edit-item-page/edit-item-page.module.ts b/src/app/+item-page/edit-item-page/edit-item-page.module.ts index 0a7b363d6a..adbcf6b0df 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.module.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.module.ts @@ -12,6 +12,8 @@ import {AbstractSimpleItemActionComponent} from './simple-item-action/abstract-s import {ItemPrivateComponent} from './item-private/item-private.component'; import {ItemPublicComponent} from './item-public/item-public.component'; import {ItemDeleteComponent} from './item-delete/item-delete.component'; +import { ItemMetadataComponent } from './item-metadata/item-metadata.component'; +import { EditInPlaceComponent } from './item-metadata/edit-in-place-field/edit-in-place-field.component'; /** * Module that contains all components related to the Edit Item page administrator functionality @@ -32,7 +34,9 @@ import {ItemDeleteComponent} from './item-delete/item-delete.component'; ItemPrivateComponent, ItemPublicComponent, ItemDeleteComponent, - ItemStatusComponent + ItemStatusComponent, + ItemMetadataComponent, + EditInPlaceComponent ] }) export class EditItemPageModule { diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html new file mode 100644 index 0000000000..5a5e16383a --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -0,0 +1,42 @@ + + + {{metadata.key}} + + + + + + + + + + + + + + +
+ {{metadata.value}} +
+
+ +
+ + +
+ {{metadata.language}} +
+
+ +
+ + +
+ + +
+
+ + +
+ diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss new file mode 100644 index 0000000000..58c24635e6 --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss @@ -0,0 +1,3 @@ +textarea, input, select { + width: 100%; +} \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts new file mode 100644 index 0000000000..1139415ecc --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -0,0 +1,41 @@ +import { Component, EventEmitter, Input, Output } from '@angular/core'; +import { isNotEmpty } from '../../../../shared/empty.util'; +import { Metadatum } from '../../../../core/shared/metadatum.model'; +import { RegistryService } from '../../../../core/registry/registry.service'; + +@Component({ + selector: 'ds-edit-in-place-field.', + styleUrls: ['./edit-in-place-field.component.scss'], + templateUrl: './edit-in-place-field.component.html', +}) +/** + * Component for displaying an item's status + */ +export class EditInPlaceComponent { + + /** + * The value to display + */ + @Input() metadata: Metadatum; + @Output() mdUpdate: EventEmitter = new EventEmitter(); + @Output() mdRemove: EventEmitter = new EventEmitter(); + editable = false; + + constructor( + private metadataFieldService: RegistryService, + ) { + + } + + isNotEmpty(value) { + return isNotEmpty(value); + } + + update() { + this.mdUpdate.emit(); + } + + remove() { + this.mdRemove.emit() + } +} diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html new file mode 100644 index 0000000000..bf32358d37 --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -0,0 +1,12 @@ +
+
+ + + + + + + +
+
+
diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts new file mode 100644 index 0000000000..cf9420658d --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -0,0 +1,37 @@ +import { Component, Input } from '@angular/core'; +import { Item } from '../../../core/shared/item.model'; +import { ItemDataService } from '../../../core/data/item-data.service'; +import { Metadatum } from '../../../core/shared/metadatum.model'; + +@Component({ + selector: 'ds-item-metadata', + templateUrl: './item-metadata.component.html', +}) +/** + * Component for displaying an item's status + */ +export class ItemMetadataComponent { + + /** + * The item to display the metadata for + */ + @Input() item: Item; + + constructor(private itemService: ItemDataService) { + + } + + update() { + this.itemService.update(this.item); + } + + removeMetadata(i: number) { + this.item.metadata = this.item.metadata.filter((metadatum: Metadatum, index: number) => index !== i); + this.update(); + } + + addMetadata() { + this.item.metadata = [new Metadatum(), ...this.item.metadata]; + this.update(); + } +} diff --git a/src/app/core/cache/builders/remote-data-build.service.ts b/src/app/core/cache/builders/remote-data-build.service.ts index 62a4992787..96945cea81 100644 --- a/src/app/core/cache/builders/remote-data-build.service.ts +++ b/src/app/core/cache/builders/remote-data-build.service.ts @@ -5,15 +5,7 @@ import { race as observableRace } from 'rxjs'; import { Injectable } from '@angular/core'; -import { - distinctUntilChanged, - first, - flatMap, - map, - startWith, - switchMap, - take -} from 'rxjs/operators'; +import { distinctUntilChanged, flatMap, map, startWith, switchMap } from 'rxjs/operators'; import { hasValue, hasValueOperator, isEmpty, isNotEmpty } from '../../../shared/empty.util'; import { PaginatedList } from '../../data/paginated-list'; import { RemoteData } from '../../data/remote-data'; @@ -29,7 +21,8 @@ import { getMapsTo, getRelationMetadata, getRelationships } from './build-decora import { PageInfo } from '../../shared/page-info.model'; import { filterSuccessfulResponses, - getRequestFromRequestHref, getRequestFromRequestUUID, + getRequestFromRequestHref, + getRequestFromRequestUUID, getResourceLinksFromResponse } from '../../shared/operators'; @@ -51,8 +44,6 @@ export class RemoteDataBuildService { const requestEntry$ = observableRace( href$.pipe(getRequestFromRequestHref(this.requestService)), requestUUID$.pipe(getRequestFromRequestUUID(this.requestService)), - ).pipe( - take(1) ); // always use self link if that is cached, only if it isn't, get it via the response. @@ -94,8 +85,8 @@ export class RemoteDataBuildService { toRemoteDataObservable(requestEntry$: Observable, payload$: Observable) { return observableCombineLatest(requestEntry$, payload$).pipe( map(([reqEntry, payload]) => { - const requestPending = hasValue(reqEntry) && hasValue(reqEntry.requestPending) ? reqEntry.requestPending : true; - const responsePending = hasValue(reqEntry) && hasValue(reqEntry.responsePending) ? reqEntry.responsePending : false; + const requestPending = hasValue(reqEntry.requestPending) ? reqEntry.requestPending : true; + const responsePending = hasValue(reqEntry.responsePending) ? reqEntry.responsePending : false; let isSuccessful: boolean; let error: RemoteDataError; if (hasValue(reqEntry) && hasValue(reqEntry.response)) { diff --git a/src/app/core/registry/registry.service.ts b/src/app/core/registry/registry.service.ts index 6cd3a7fa28..4bd0dabb70 100644 --- a/src/app/core/registry/registry.service.ts +++ b/src/app/core/registry/registry.service.ts @@ -28,7 +28,7 @@ import { import { HALEndpointService } from '../shared/hal-endpoint.service'; import { RegistryMetadatafieldsResponseParsingService } from '../data/registry-metadatafields-response-parsing.service'; import { RegistryMetadatafieldsResponse } from './registry-metadatafields-response.model'; -import { hasValue, isNotEmpty, isNotEmptyOperator } from '../../shared/empty.util'; +import { hasValue, hasNoValue, isNotEmpty, isNotEmptyOperator } from '../../shared/empty.util'; import { URLCombiner } from '../url-combiner/url-combiner'; import { PaginationComponentOptions } from '../../shared/pagination/pagination-component-options.model'; import { RegistryBitstreamformatsResponseParsingService } from '../data/registry-bitstreamformats-response-parsing.service'; @@ -166,6 +166,41 @@ export class RegistryService { return this.rdb.toRemoteDataObservable(requestEntryObs, payloadObs); } + public getAllMetadataFields(pagination?: PaginationComponentOptions): Observable>> { + if (hasNoValue(pagination)) { + pagination = { currentPage: 1, pageSize: Number.MAX_VALUE } as any; + } + const requestObs = this.getMetadataFieldsRequestObs(pagination); + + const requestEntryObs = requestObs.pipe( + flatMap((request: RestRequest) => this.requestService.getByHref(request.href)) + ); + + const rmrObs: Observable = requestEntryObs.pipe( + getResponseFromEntry(), + map((response: RegistryMetadatafieldsSuccessResponse) => response.metadatafieldsResponse) + ); + + const metadatafieldsObs: Observable = rmrObs.pipe( + map((rmr: RegistryMetadatafieldsResponse) => rmr.metadatafields), + map((metadataFields: MetadataField[]) => metadataFields) + ); + + const pageInfoObs: Observable = requestEntryObs.pipe( + getResponseFromEntry(), + + map((response: RegistryMetadatafieldsSuccessResponse) => response.pageInfo) + ); + + const payloadObs = observableCombineLatest(metadatafieldsObs, pageInfoObs).pipe( + map(([metadatafields, pageInfo]) => { + return new PaginatedList(pageInfo, metadatafields); + }) + ); + + return this.rdb.toRemoteDataObservable(requestEntryObs, payloadObs); + } + public getBitstreamFormats(pagination: PaginationComponentOptions): Observable>> { const requestObs = this.getBitstreamFormatsRequestObs(pagination); @@ -238,6 +273,26 @@ export class RegistryService { ); } + private getMetadataFieldsRequestObs(pagination: PaginationComponentOptions): Observable { + return this.halService.getEndpoint(this.metadataFieldsPath).pipe( + map((url: string) => { + const args: string[] = []; + args.push(`size=${pagination.pageSize}`); + args.push(`page=${pagination.currentPage - 1}`); + if (isNotEmpty(args)) { + url = new URLCombiner(url, `?${args.join('&')}`).toString(); + } + const request = new GetRequest(this.requestService.generateRequestId(), url); + return Object.assign(request, { + getResponseParser(): GenericConstructor { + return RegistryMetadatafieldsResponseParsingService; + } + }); + }), + tap((request: RestRequest) => this.requestService.configure(request)), + ); + } + private getBitstreamFormatsRequestObs(pagination: PaginationComponentOptions): Observable { return this.halService.getEndpoint(this.bitstreamFormatsPath).pipe( map((url: string) => { diff --git a/src/app/core/shared/metadatum.model.ts b/src/app/core/shared/metadatum.model.ts index a3c5830608..ca1f3d8591 100644 --- a/src/app/core/shared/metadatum.model.ts +++ b/src/app/core/shared/metadatum.model.ts @@ -19,5 +19,4 @@ export class Metadatum { */ @autoserialize value: string; - } diff --git a/src/app/core/shared/operators.ts b/src/app/core/shared/operators.ts index 6fe510c1aa..4540bed0c4 100644 --- a/src/app/core/shared/operators.ts +++ b/src/app/core/shared/operators.ts @@ -60,7 +60,7 @@ export const getRemoteDataPayload = () => export const getSucceededRemoteData = () => (source: Observable>): Observable> => - source.pipe(find((rd: RemoteData) => rd.hasSucceeded), hasValueOperator()); + source.pipe(find((rd: RemoteData) => rd.hasSucceeded)); export const getAllSucceededRemoteData = () => (source: Observable>): Observable> => From 58b45801b77090ef9d1f4edf8b6c7ffc36112197 Mon Sep 17 00:00:00 2001 From: lotte Date: Fri, 25 Jan 2019 16:40:37 +0100 Subject: [PATCH 02/18] 59334: added reducer for editing items --- .../item-metadata/item-metadata.component.ts | 2 +- .../models/normalized-collection.model.ts | 10 +- .../models/normalized-dspace-object.model.ts | 2 +- .../cache/models/normalized-item.model.ts | 10 +- src/app/core/data/data.service.ts | 2 +- .../core/data/metadata-schema-data.service.ts | 11 +- .../object-updates/object-updates.actions.ts | 101 ++++++++++++++++ .../object-updates/object-updates.reducer.ts | 112 ++++++++++++++++++ src/app/shared/utils/debounce.directive.ts | 1 + 9 files changed, 237 insertions(+), 14 deletions(-) create mode 100644 src/app/core/data/object-updates/object-updates.actions.ts create mode 100644 src/app/core/data/object-updates/object-updates.reducer.ts diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index cf9420658d..614f342b26 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -22,7 +22,7 @@ export class ItemMetadataComponent { } update() { - this.itemService.update(this.item); + this.itemService.update(this.item).subscribe(); } removeMetadata(i: number) { diff --git a/src/app/core/cache/models/normalized-collection.model.ts b/src/app/core/cache/models/normalized-collection.model.ts index a2c634c3e5..07e741a88b 100644 --- a/src/app/core/cache/models/normalized-collection.model.ts +++ b/src/app/core/cache/models/normalized-collection.model.ts @@ -1,4 +1,4 @@ -import { autoserialize, inheritSerialization } from 'cerialize'; +import { autoserialize, deserialize, inheritSerialization } from 'cerialize'; import { NormalizedDSpaceObject } from './normalized-dspace-object.model'; import { Collection } from '../../shared/collection.model'; @@ -21,28 +21,28 @@ export class NormalizedCollection extends NormalizedDSpaceObject { /** * The Bitstream that represents the logo of this Collection */ - @autoserialize + @deserialize @relationship(ResourceType.Bitstream, false) logo: string; /** * An array of Communities that are direct parents of this Collection */ - @autoserialize + @deserialize @relationship(ResourceType.Community, true) parents: string[]; /** * The Community that owns this Collection */ - @autoserialize + @deserialize @relationship(ResourceType.Community, false) owner: string; /** * List of Items that are part of (not necessarily owned by) this Collection */ - @autoserialize + @deserialize @relationship(ResourceType.Item, true) items: string[]; diff --git a/src/app/core/cache/models/normalized-dspace-object.model.ts b/src/app/core/cache/models/normalized-dspace-object.model.ts index efdfa6dd74..030e17364a 100644 --- a/src/app/core/cache/models/normalized-dspace-object.model.ts +++ b/src/app/core/cache/models/normalized-dspace-object.model.ts @@ -18,7 +18,7 @@ export class NormalizedDSpaceObject extends NormalizedObject { * Repeated here to make the serialization work, * inheritSerialization doesn't seem to work for more than one level */ - @autoserialize + @deserialize self: string; /** diff --git a/src/app/core/cache/models/normalized-item.model.ts b/src/app/core/cache/models/normalized-item.model.ts index 7d518bd048..3065e37796 100644 --- a/src/app/core/cache/models/normalized-item.model.ts +++ b/src/app/core/cache/models/normalized-item.model.ts @@ -1,4 +1,4 @@ -import { inheritSerialization, autoserialize, autoserializeAs } from 'cerialize'; +import { inheritSerialization, deserialize, autoserialize, autoserializeAs } from 'cerialize'; import { NormalizedDSpaceObject } from './normalized-dspace-object.model'; import { Item } from '../../shared/item.model'; @@ -21,7 +21,7 @@ export class NormalizedItem extends NormalizedDSpaceObject { /** * The Date of the last modification of this Item */ - @autoserialize + @deserialize lastModified: Date; /** @@ -45,21 +45,21 @@ export class NormalizedItem extends NormalizedDSpaceObject { /** * An array of Collections that are direct parents of this Item */ - @autoserialize + @deserialize @relationship(ResourceType.Collection, true) parents: string[]; /** * The Collection that owns this Item */ - @autoserialize + @deserialize @relationship(ResourceType.Collection, false) owningCollection: string; /** * List of Bitstreams that are owned by this Item */ - @autoserialize + @deserialize @relationship(ResourceType.Bitstream, true) bitstreams: string[]; diff --git a/src/app/core/data/data.service.ts b/src/app/core/data/data.service.ts index 440013c31c..6d1359d833 100644 --- a/src/app/core/data/data.service.ts +++ b/src/app/core/data/data.service.ts @@ -139,7 +139,7 @@ export abstract class DataService> { const oldVersion$ = this.objectCache.getBySelfLink(object.self); - return oldVersion$.pipe(first(), mergeMap((oldVersion: TNormalized) => { + return oldVersion$.pipe(take(1), mergeMap((oldVersion: TNormalized) => { const newVersion = this.dataBuildService.normalize(object); const operations = this.comparator.diff(oldVersion, newVersion); if (isNotEmpty(operations)) { diff --git a/src/app/core/data/metadata-schema-data.service.ts b/src/app/core/data/metadata-schema-data.service.ts index d568bd01f7..8dd0c5d24f 100644 --- a/src/app/core/data/metadata-schema-data.service.ts +++ b/src/app/core/data/metadata-schema-data.service.ts @@ -12,6 +12,10 @@ import { FindAllOptions, GetRequest, RestRequest } from './request.models'; import { ObjectCacheService } from '../cache/object-cache.service'; import { MetadataSchema } from '../metadata/metadataschema.model'; import { NormalizedMetadataSchema } from '../metadata/normalized-metadata-schema.model'; +import { ChangeAnalyzer } from './change-analyzer'; +import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; +import { HttpClient } from '@angular/common/http'; +import { NotificationsService } from '../../shared/notifications/notifications.service'; @Injectable() export class MetadataSchemaDataService extends DataService { @@ -23,7 +27,11 @@ export class MetadataSchemaDataService extends DataService, private bs: BrowseService, protected halService: HALEndpointService, - protected objectCache: ObjectCacheService) { + protected objectCache: ObjectCacheService, + protected comparator: ChangeAnalyzer, + protected dataBuildService: NormalizedObjectBuildService, + protected http: HttpClient, + protected notificationsService: NotificationsService) { super(); } @@ -37,4 +45,5 @@ export class MetadataSchemaDataService extends DataService Date: Tue, 29 Jan 2019 16:03:50 +0100 Subject: [PATCH 03/18] got rid of TNormalized everywhere --- .../create-collection-page.component.ts | 3 +- .../delete-collection-page.component.ts | 6 +- .../edit-collection-page.component.ts | 2 +- .../create-community-page.component.ts | 3 +- .../delete-community-page.component.ts | 3 +- .../edit-community-page.component.ts | 3 +- .../item-metadata.component.html | 4 +- .../item-metadata/item-metadata.component.ts | 29 ++++--- src/app/core/auth/auth-object-factory.ts | 4 +- src/app/core/auth/auth.service.ts | 4 +- .../models/normalized-auth-status.model.ts | 2 +- src/app/core/auth/server-auth.service.ts | 3 +- .../normalized-object-build.service.ts | 2 +- .../builders/remote-data-build.service.ts | 19 ++-- .../normalized-bitstream-format.model.ts | 2 +- .../models/normalized-bitstream.model.ts | 2 +- .../cache/models/normalized-bundle.model.ts | 2 +- .../models/normalized-collection.model.ts | 2 +- .../models/normalized-community.model.ts | 2 +- .../models/normalized-dspace-object.model.ts | 2 +- .../cache/models/normalized-item.model.ts | 2 +- .../cache/models/normalized-object-factory.ts | 3 +- .../cache/models/normalized-object.model.ts | 2 +- .../normalized-resource-policy.model.ts | 2 +- src/app/core/cache/object-cache.service.ts | 10 +-- src/app/core/data/change-analyzer.ts | 5 +- src/app/core/data/collection-data.service.ts | 4 +- src/app/core/data/comcol-data.service.spec.ts | 8 +- src/app/core/data/comcol-data.service.ts | 17 +--- src/app/core/data/community-data.service.ts | 6 +- src/app/core/data/data.service.spec.ts | 5 +- src/app/core/data/data.service.ts | 29 +++---- .../core/data/dso-change-analyzer.service.ts | 5 +- .../core/data/dso-response-parsing.service.ts | 3 +- .../core/data/dspace-object-data.service.ts | 7 +- src/app/core/data/item-data.service.ts | 8 +- .../core/data/metadata-schema-data.service.ts | 8 +- .../object-updates/object-updates.actions.ts | 60 +++++++++---- .../object-updates/object-updates.reducer.ts | 87 ++++++++++++------- src/app/core/eperson/models/eperson.model.ts | 3 + .../models/normalized-eperson.model.ts | 2 +- .../eperson/models/normalized-group.model.ts | 2 +- .../normalized-metadata-schema.model.ts | 2 +- .../auth-nav-menu.component.html | 2 +- .../create-comcol-page.component.spec.ts | 5 +- .../create-comcol-page.component.ts | 5 +- .../delete-comcol-page.component.spec.ts | 5 +- .../delete-comcol-page.component.ts | 8 +- .../edit-comcol-page.component.spec.ts | 5 +- .../edit-comcol-page.component.ts | 5 +- 50 files changed, 223 insertions(+), 191 deletions(-) diff --git a/src/app/+collection-page/create-collection-page/create-collection-page.component.ts b/src/app/+collection-page/create-collection-page/create-collection-page.component.ts index 52497694b9..94229b4932 100644 --- a/src/app/+collection-page/create-collection-page/create-collection-page.component.ts +++ b/src/app/+collection-page/create-collection-page/create-collection-page.component.ts @@ -3,7 +3,6 @@ import { CommunityDataService } from '../../core/data/community-data.service'; import { RouteService } from '../../shared/services/route.service'; import { Router } from '@angular/router'; import { CreateComColPageComponent } from '../../shared/comcol-forms/create-comcol-page/create-comcol-page.component'; -import { NormalizedCollection } from '../../core/cache/models/normalized-collection.model'; import { Collection } from '../../core/shared/collection.model'; import { CollectionDataService } from '../../core/data/collection-data.service'; @@ -15,7 +14,7 @@ import { CollectionDataService } from '../../core/data/collection-data.service'; styleUrls: ['./create-collection-page.component.scss'], templateUrl: './create-collection-page.component.html' }) -export class CreateCollectionPageComponent extends CreateComColPageComponent { +export class CreateCollectionPageComponent extends CreateComColPageComponent { protected frontendURL = '/collections/'; public constructor( diff --git a/src/app/+collection-page/delete-collection-page/delete-collection-page.component.ts b/src/app/+collection-page/delete-collection-page/delete-collection-page.component.ts index 80abb83694..5f2bd89942 100644 --- a/src/app/+collection-page/delete-collection-page/delete-collection-page.component.ts +++ b/src/app/+collection-page/delete-collection-page/delete-collection-page.component.ts @@ -1,12 +1,8 @@ import { Component } from '@angular/core'; -import { Community } from '../../core/shared/community.model'; -import { CommunityDataService } from '../../core/data/community-data.service'; import { ActivatedRoute, Router } from '@angular/router'; -import { NormalizedCommunity } from '../../core/cache/models/normalized-community.model'; import { DeleteComColPageComponent } from '../../shared/comcol-forms/delete-comcol-page/delete-comcol-page.component'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { CollectionDataService } from '../../core/data/collection-data.service'; -import { NormalizedCollection } from '../../core/cache/models/normalized-collection.model'; import { Collection } from '../../core/shared/collection.model'; import { TranslateService } from '@ngx-translate/core'; @@ -18,7 +14,7 @@ import { TranslateService } from '@ngx-translate/core'; styleUrls: ['./delete-collection-page.component.scss'], templateUrl: './delete-collection-page.component.html' }) -export class DeleteCollectionPageComponent extends DeleteComColPageComponent { +export class DeleteCollectionPageComponent extends DeleteComColPageComponent { protected frontendURL = '/collections/'; public constructor( diff --git a/src/app/+collection-page/edit-collection-page/edit-collection-page.component.ts b/src/app/+collection-page/edit-collection-page/edit-collection-page.component.ts index 9bbdbfb9a1..a3978a5e43 100644 --- a/src/app/+collection-page/edit-collection-page/edit-collection-page.component.ts +++ b/src/app/+collection-page/edit-collection-page/edit-collection-page.component.ts @@ -13,7 +13,7 @@ import { CollectionDataService } from '../../core/data/collection-data.service'; styleUrls: ['./edit-collection-page.component.scss'], templateUrl: './edit-collection-page.component.html' }) -export class EditCollectionPageComponent extends EditComColPageComponent { +export class EditCollectionPageComponent extends EditComColPageComponent { protected frontendURL = '/collections/'; public constructor( diff --git a/src/app/+community-page/create-community-page/create-community-page.component.ts b/src/app/+community-page/create-community-page/create-community-page.component.ts index 47fb065038..828d8338af 100644 --- a/src/app/+community-page/create-community-page/create-community-page.component.ts +++ b/src/app/+community-page/create-community-page/create-community-page.component.ts @@ -4,7 +4,6 @@ import { CommunityDataService } from '../../core/data/community-data.service'; import { RouteService } from '../../shared/services/route.service'; import { Router } from '@angular/router'; import { CreateComColPageComponent } from '../../shared/comcol-forms/create-comcol-page/create-comcol-page.component'; -import { NormalizedCommunity } from '../../core/cache/models/normalized-community.model'; /** * Component that represents the page where a user can create a new Community @@ -14,7 +13,7 @@ import { NormalizedCommunity } from '../../core/cache/models/normalized-communit styleUrls: ['./create-community-page.component.scss'], templateUrl: './create-community-page.component.html' }) -export class CreateCommunityPageComponent extends CreateComColPageComponent { +export class CreateCommunityPageComponent extends CreateComColPageComponent { protected frontendURL = '/communities/'; public constructor( diff --git a/src/app/+community-page/delete-community-page/delete-community-page.component.ts b/src/app/+community-page/delete-community-page/delete-community-page.component.ts index 01741a7577..9f1465a3c7 100644 --- a/src/app/+community-page/delete-community-page/delete-community-page.component.ts +++ b/src/app/+community-page/delete-community-page/delete-community-page.component.ts @@ -2,7 +2,6 @@ import { Component } from '@angular/core'; import { Community } from '../../core/shared/community.model'; import { CommunityDataService } from '../../core/data/community-data.service'; import { ActivatedRoute, Router } from '@angular/router'; -import { NormalizedCommunity } from '../../core/cache/models/normalized-community.model'; import { DeleteComColPageComponent } from '../../shared/comcol-forms/delete-comcol-page/delete-comcol-page.component'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { TranslateService } from '@ngx-translate/core'; @@ -15,7 +14,7 @@ import { TranslateService } from '@ngx-translate/core'; styleUrls: ['./delete-community-page.component.scss'], templateUrl: './delete-community-page.component.html' }) -export class DeleteCommunityPageComponent extends DeleteComColPageComponent { +export class DeleteCommunityPageComponent extends DeleteComColPageComponent { protected frontendURL = '/communities/'; public constructor( diff --git a/src/app/+community-page/edit-community-page/edit-community-page.component.ts b/src/app/+community-page/edit-community-page/edit-community-page.component.ts index 68f092e915..9f49ac49dd 100644 --- a/src/app/+community-page/edit-community-page/edit-community-page.component.ts +++ b/src/app/+community-page/edit-community-page/edit-community-page.component.ts @@ -2,7 +2,6 @@ import { Component } from '@angular/core'; import { Community } from '../../core/shared/community.model'; import { CommunityDataService } from '../../core/data/community-data.service'; import { ActivatedRoute, Router } from '@angular/router'; -import { NormalizedCommunity } from '../../core/cache/models/normalized-community.model'; import { EditComColPageComponent } from '../../shared/comcol-forms/edit-comcol-page/edit-comcol-page.component'; /** @@ -13,7 +12,7 @@ import { EditComColPageComponent } from '../../shared/comcol-forms/edit-comcol-p styleUrls: ['./edit-community-page.component.scss'], templateUrl: './edit-community-page.component.html' }) -export class EditCommunityPageComponent extends EditComColPageComponent { +export class EditCommunityPageComponent extends EditComColPageComponent { protected frontendURL = '/communities/'; public constructor( diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index bf32358d37..f1c45ddda7 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -1,10 +1,10 @@
- + - +
diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index 614f342b26..9fe1d76a03 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -2,6 +2,7 @@ import { Component, Input } from '@angular/core'; import { Item } from '../../../core/shared/item.model'; import { ItemDataService } from '../../../core/data/item-data.service'; import { Metadatum } from '../../../core/shared/metadatum.model'; +import { DSOChangeAnalyzer } from '../../../core/data/dso-change-analyzer.service'; @Component({ selector: 'ds-item-metadata', @@ -16,22 +17,24 @@ export class ItemMetadataComponent { * The item to display the metadata for */ @Input() item: Item; - - constructor(private itemService: ItemDataService) { - + updateItem: Item; + constructor(private itemService: ItemDataService, private dsoChanges: DSOChangeAnalyzer) { + this.updateItem = Object.assign({}, this.item); } update() { - this.itemService.update(this.item).subscribe(); + this.dsoChanges.diff(this.item, this.updateItem); } - removeMetadata(i: number) { - this.item.metadata = this.item.metadata.filter((metadatum: Metadatum, index: number) => index !== i); - this.update(); - } - - addMetadata() { - this.item.metadata = [new Metadatum(), ...this.item.metadata]; - this.update(); - } + // submit() { + // + // } + // + // discard() { + // + // } + // + // undo() { + // + // } } diff --git a/src/app/core/auth/auth-object-factory.ts b/src/app/core/auth/auth-object-factory.ts index b6df1fac34..e37475d94c 100644 --- a/src/app/core/auth/auth-object-factory.ts +++ b/src/app/core/auth/auth-object-factory.ts @@ -3,10 +3,10 @@ import { GenericConstructor } from '../shared/generic-constructor'; import { NormalizedAuthStatus } from './models/normalized-auth-status.model'; import { NormalizedEPerson } from '../eperson/models/normalized-eperson.model'; import { NormalizedObject } from '../cache/models/normalized-object.model'; -import { EPerson } from '../eperson/models/eperson.model'; +import { CacheableObject } from '../cache/object-cache.reducer'; export class AuthObjectFactory { - public static getConstructor(type): GenericConstructor { + public static getConstructor(type): GenericConstructor> { switch (type) { case AuthType.EPerson: { return NormalizedEPerson diff --git a/src/app/core/auth/auth.service.ts b/src/app/core/auth/auth.service.ts index 2e6f68851a..fdb372f643 100644 --- a/src/app/core/auth/auth.service.ts +++ b/src/app/core/auth/auth.service.ts @@ -131,7 +131,7 @@ export class AuthService { * @returns {Observable} */ public isAuthenticated(): Observable { - return of(true); + return this.store.pipe(select(isAuthenticated)); } /** @@ -152,7 +152,7 @@ export class AuthService { // TODO this should be cleaned up, AuthStatus could be parsed by the RemoteDataService as a whole... // Review when https://jira.duraspace.org/browse/DS-4006 is fixed // See https://github.com/DSpace/dspace-angular/issues/292 - const person$ = this.rdbService.buildSingle(status.eperson.toString()); + const person$ = this.rdbService.buildSingle(status.eperson.toString()); return person$.pipe(map((eperson) => eperson.payload)); } else { throw(new Error('Not authenticated')); diff --git a/src/app/core/auth/models/normalized-auth-status.model.ts b/src/app/core/auth/models/normalized-auth-status.model.ts index b8dd2aa23e..a13a996604 100644 --- a/src/app/core/auth/models/normalized-auth-status.model.ts +++ b/src/app/core/auth/models/normalized-auth-status.model.ts @@ -7,7 +7,7 @@ import { IDToUUIDSerializer } from '../../cache/id-to-uuid-serializer'; @mapsTo(AuthStatus) @inheritSerialization(NormalizedObject) -export class NormalizedAuthStatus extends NormalizedObject { +export class NormalizedAuthStatus extends NormalizedObject { @autoserialize id: string; diff --git a/src/app/core/auth/server-auth.service.ts b/src/app/core/auth/server-auth.service.ts index 25ec1156ee..b61b11a4f2 100644 --- a/src/app/core/auth/server-auth.service.ts +++ b/src/app/core/auth/server-auth.service.ts @@ -10,7 +10,6 @@ import { AuthService } from './auth.service'; import { AuthTokenInfo } from './models/auth-token-info.model'; import { CheckAuthenticationTokenAction } from './auth.actions'; import { EPerson } from '../eperson/models/eperson.model'; -import { NormalizedEPerson } from '../eperson/models/normalized-eperson.model'; /** * The auth service. @@ -40,7 +39,7 @@ export class ServerAuthService extends AuthService { if (status.authenticated) { // TODO this should be cleaned up, AuthStatus could be parsed by the RemoteDataService as a whole... - const person$ = this.rdbService.buildSingle(status.eperson.toString()); + const person$ = this.rdbService.buildSingle(status.eperson.toString()); return person$.pipe( map((eperson) => eperson.payload) ); diff --git a/src/app/core/cache/builders/normalized-object-build.service.ts b/src/app/core/cache/builders/normalized-object-build.service.ts index 9d97ccda75..79665fec3d 100644 --- a/src/app/core/cache/builders/normalized-object-build.service.ts +++ b/src/app/core/cache/builders/normalized-object-build.service.ts @@ -35,7 +35,7 @@ export class NormalizedObjectBuildService { * * @param {TDomain} domainModel a domain model */ - normalize(domainModel: TDomain): TNormalized { + normalize(domainModel: T): NormalizedObject { const normalizedConstructor = NormalizedObjectFactory.getConstructor(domainModel.type); const relationships = getRelationships(normalizedConstructor) || []; diff --git a/src/app/core/cache/builders/remote-data-build.service.ts b/src/app/core/cache/builders/remote-data-build.service.ts index f9707fc723..cab3a21e5b 100644 --- a/src/app/core/cache/builders/remote-data-build.service.ts +++ b/src/app/core/cache/builders/remote-data-build.service.ts @@ -25,6 +25,7 @@ import { getRequestFromRequestUUID, getResourceLinksFromResponse } from '../../shared/operators'; +import { CacheableObject } from '../object-cache.reducer'; @Injectable() export class RemoteDataBuildService { @@ -32,7 +33,7 @@ export class RemoteDataBuildService { protected requestService: RequestService) { } - buildSingle(href$: string | Observable): Observable> { + buildSingle(href$: string | Observable): Observable> { if (typeof href$ === 'string') { href$ = observableOf(href$); } @@ -49,7 +50,7 @@ export class RemoteDataBuildService { const payload$ = observableCombineLatest( href$.pipe( - switchMap((href: string) => this.objectCache.getBySelfLink(href)), + switchMap((href: string) => this.objectCache.getBySelfLink>(href)), startWith(undefined)), requestEntry$.pipe( getResourceLinksFromResponse(), @@ -72,8 +73,8 @@ export class RemoteDataBuildService { } }), hasValueOperator(), - map((normalized: TNormalized) => { - return this.build(normalized); + map((normalized: NormalizedObject) => { + return this.build(normalized); }), startWith(undefined), distinctUntilChanged() @@ -106,7 +107,7 @@ export class RemoteDataBuildService { ); } - buildList(href$: string | Observable): Observable>> { + buildList(href$: string | Observable): Observable>> { if (typeof href$ === 'string') { href$ = observableOf(href$); } @@ -116,9 +117,9 @@ export class RemoteDataBuildService { getResourceLinksFromResponse(), flatMap((resourceUUIDs: string[]) => { return this.objectCache.getList(resourceUUIDs).pipe( - map((normList: TNormalized[]) => { - return normList.map((normalized: TNormalized) => { - return this.build(normalized); + map((normList: Array>) => { + return normList.map((normalized: NormalizedObject) => { + return this.build(normalized); }); })); }), @@ -148,7 +149,7 @@ export class RemoteDataBuildService { return this.toRemoteDataObservable(requestEntry$, payload$); } - build(normalized: TNormalized): TDomain { + build(normalized: NormalizedObject): T { const links: any = {}; const relationships = getRelationships(normalized.constructor) || []; diff --git a/src/app/core/cache/models/normalized-bitstream-format.model.ts b/src/app/core/cache/models/normalized-bitstream-format.model.ts index 5d11c97107..994792d535 100644 --- a/src/app/core/cache/models/normalized-bitstream-format.model.ts +++ b/src/app/core/cache/models/normalized-bitstream-format.model.ts @@ -11,7 +11,7 @@ import { SupportLevel } from './support-level.model'; */ @mapsTo(BitstreamFormat) @inheritSerialization(NormalizedObject) -export class NormalizedBitstreamFormat extends NormalizedObject { +export class NormalizedBitstreamFormat extends NormalizedObject { /** * Short description of this Bitstream Format diff --git a/src/app/core/cache/models/normalized-bitstream.model.ts b/src/app/core/cache/models/normalized-bitstream.model.ts index 63f84add41..64a17aae84 100644 --- a/src/app/core/cache/models/normalized-bitstream.model.ts +++ b/src/app/core/cache/models/normalized-bitstream.model.ts @@ -10,7 +10,7 @@ import { ResourceType } from '../../shared/resource-type'; */ @mapsTo(Bitstream) @inheritSerialization(NormalizedDSpaceObject) -export class NormalizedBitstream extends NormalizedDSpaceObject { +export class NormalizedBitstream extends NormalizedDSpaceObject { /** * The size of this bitstream in bytes diff --git a/src/app/core/cache/models/normalized-bundle.model.ts b/src/app/core/cache/models/normalized-bundle.model.ts index 5535ab57e5..342b13629f 100644 --- a/src/app/core/cache/models/normalized-bundle.model.ts +++ b/src/app/core/cache/models/normalized-bundle.model.ts @@ -10,7 +10,7 @@ import { ResourceType } from '../../shared/resource-type'; */ @mapsTo(Bundle) @inheritSerialization(NormalizedDSpaceObject) -export class NormalizedBundle extends NormalizedDSpaceObject { +export class NormalizedBundle extends NormalizedDSpaceObject { /** * The primary bitstream of this Bundle */ diff --git a/src/app/core/cache/models/normalized-collection.model.ts b/src/app/core/cache/models/normalized-collection.model.ts index 07e741a88b..4eb6e1027b 100644 --- a/src/app/core/cache/models/normalized-collection.model.ts +++ b/src/app/core/cache/models/normalized-collection.model.ts @@ -10,7 +10,7 @@ import { ResourceType } from '../../shared/resource-type'; */ @mapsTo(Collection) @inheritSerialization(NormalizedDSpaceObject) -export class NormalizedCollection extends NormalizedDSpaceObject { +export class NormalizedCollection extends NormalizedDSpaceObject { /** * A string representing the unique handle of this Collection diff --git a/src/app/core/cache/models/normalized-community.model.ts b/src/app/core/cache/models/normalized-community.model.ts index e915d2f50a..f561089949 100644 --- a/src/app/core/cache/models/normalized-community.model.ts +++ b/src/app/core/cache/models/normalized-community.model.ts @@ -10,7 +10,7 @@ import { ResourceType } from '../../shared/resource-type'; */ @mapsTo(Community) @inheritSerialization(NormalizedDSpaceObject) -export class NormalizedCommunity extends NormalizedDSpaceObject { +export class NormalizedCommunity extends NormalizedDSpaceObject { /** * A string representing the unique handle of this Community diff --git a/src/app/core/cache/models/normalized-dspace-object.model.ts b/src/app/core/cache/models/normalized-dspace-object.model.ts index 030e17364a..dc38a8530e 100644 --- a/src/app/core/cache/models/normalized-dspace-object.model.ts +++ b/src/app/core/cache/models/normalized-dspace-object.model.ts @@ -10,7 +10,7 @@ import { NormalizedObject } from './normalized-object.model'; * An model class for a DSpaceObject. */ @mapsTo(DSpaceObject) -export class NormalizedDSpaceObject extends NormalizedObject { +export class NormalizedDSpaceObject extends NormalizedObject { /** * The link to the rest endpoint where this object can be found diff --git a/src/app/core/cache/models/normalized-item.model.ts b/src/app/core/cache/models/normalized-item.model.ts index 3065e37796..9e8c034e81 100644 --- a/src/app/core/cache/models/normalized-item.model.ts +++ b/src/app/core/cache/models/normalized-item.model.ts @@ -10,7 +10,7 @@ import { ResourceType } from '../../shared/resource-type'; */ @mapsTo(Item) @inheritSerialization(NormalizedDSpaceObject) -export class NormalizedItem extends NormalizedDSpaceObject { +export class NormalizedItem extends NormalizedDSpaceObject { /** * A string representing the unique handle of this Item diff --git a/src/app/core/cache/models/normalized-object-factory.ts b/src/app/core/cache/models/normalized-object-factory.ts index afa10920cb..681dbea984 100644 --- a/src/app/core/cache/models/normalized-object-factory.ts +++ b/src/app/core/cache/models/normalized-object-factory.ts @@ -11,9 +11,10 @@ import { NormalizedResourcePolicy } from './normalized-resource-policy.model'; import { NormalizedEPerson } from '../../eperson/models/normalized-eperson.model'; import { NormalizedGroup } from '../../eperson/models/normalized-group.model'; import { NormalizedMetadataSchema } from '../../metadata/normalized-metadata-schema.model'; +import { CacheableObject } from '../object-cache.reducer'; export class NormalizedObjectFactory { - public static getConstructor(type: ResourceType): GenericConstructor { + public static getConstructor(type: ResourceType): GenericConstructor> { switch (type) { case ResourceType.Bitstream: { return NormalizedBitstream diff --git a/src/app/core/cache/models/normalized-object.model.ts b/src/app/core/cache/models/normalized-object.model.ts index e98081d68a..de04572dcd 100644 --- a/src/app/core/cache/models/normalized-object.model.ts +++ b/src/app/core/cache/models/normalized-object.model.ts @@ -4,7 +4,7 @@ import { ResourceType } from '../../shared/resource-type'; /** * An abstract model class for a NormalizedObject. */ -export abstract class NormalizedObject implements CacheableObject { +export abstract class NormalizedObject implements CacheableObject { /** * The link to the rest endpoint where this object can be found diff --git a/src/app/core/cache/models/normalized-resource-policy.model.ts b/src/app/core/cache/models/normalized-resource-policy.model.ts index b767ca6491..b6c8c1369a 100644 --- a/src/app/core/cache/models/normalized-resource-policy.model.ts +++ b/src/app/core/cache/models/normalized-resource-policy.model.ts @@ -12,7 +12,7 @@ import { ActionType } from './action-type.model'; */ @mapsTo(ResourcePolicy) @inheritSerialization(NormalizedObject) -export class NormalizedResourcePolicy extends NormalizedObject { +export class NormalizedResourcePolicy extends NormalizedObject { /** * The action that is allowed by this Resource Policy diff --git a/src/app/core/cache/object-cache.service.ts b/src/app/core/cache/object-cache.service.ts index af30646f53..d4d52b404f 100644 --- a/src/app/core/cache/object-cache.service.ts +++ b/src/app/core/cache/object-cache.service.ts @@ -78,7 +78,7 @@ export class ObjectCacheService { * @return Observable * An observable of the requested object */ - getByUUID(uuid: string): Observable { + getByUUID(uuid: string): Observable> { return this.store.pipe( select(selfLinkFromUuidSelector(uuid)), mergeMap((selfLink: string) => this.getBySelfLink(selfLink) @@ -86,7 +86,7 @@ export class ObjectCacheService { ) } - getBySelfLink(selfLink: string): Observable { + getBySelfLink(selfLink: string): Observable> { return this.getEntry(selfLink).pipe( map((entry: ObjectCacheEntry) => { if (isNotEmpty(entry.patches)) { @@ -99,8 +99,8 @@ export class ObjectCacheService { } ), map((entry: ObjectCacheEntry) => { - const type: GenericConstructor = NormalizedObjectFactory.getConstructor(entry.data.type); - return Object.assign(new type(), entry.data) as T + const type: GenericConstructor> = NormalizedObjectFactory.getConstructor(entry.data.type); + return Object.assign(new type(), entry.data) as NormalizedObject }) ); } @@ -145,7 +145,7 @@ export class ObjectCacheService { * The type of the objects to get * @return Observable> */ - getList(selfLinks: string[]): Observable { + getList(selfLinks: string[]): Observable>> { return observableCombineLatest( selfLinks.map((selfLink: string) => this.getBySelfLink(selfLink)) ); diff --git a/src/app/core/data/change-analyzer.ts b/src/app/core/data/change-analyzer.ts index caf9e38c7c..6b5a69259b 100644 --- a/src/app/core/data/change-analyzer.ts +++ b/src/app/core/data/change-analyzer.ts @@ -1,11 +1,12 @@ import { NormalizedObject } from '../cache/models/normalized-object.model'; import { Operation } from 'fast-json-patch/lib/core'; +import { CacheableObject } from '../cache/object-cache.reducer'; /** * An interface to determine what differs between two * NormalizedObjects */ -export interface ChangeAnalyzer { +export interface ChangeAnalyzer { /** * Compare two objects and return their differences as a @@ -16,5 +17,5 @@ export interface ChangeAnalyzer { * @param {NormalizedObject} object2 * The second object to compare */ - diff(object1: TNormalized, object2: TNormalized): Operation[]; + diff(object1: T | NormalizedObject, object2: T | NormalizedObject): Operation[]; } diff --git a/src/app/core/data/collection-data.service.ts b/src/app/core/data/collection-data.service.ts index e8a682ba0e..d9b722fb46 100644 --- a/src/app/core/data/collection-data.service.ts +++ b/src/app/core/data/collection-data.service.ts @@ -15,7 +15,7 @@ import { NormalizedObjectBuildService } from '../cache/builders/normalized-objec import { DSOChangeAnalyzer } from './dso-change-analyzer.service'; @Injectable() -export class CollectionDataService extends ComColDataService { +export class CollectionDataService extends ComColDataService { protected linkPath = 'collections'; constructor( @@ -28,7 +28,7 @@ export class CollectionDataService extends ComColDataService ) { super(); } diff --git a/src/app/core/data/comcol-data.service.spec.ts b/src/app/core/data/comcol-data.service.spec.ts index 4c20a4cfeb..784075c855 100644 --- a/src/app/core/data/comcol-data.service.spec.ts +++ b/src/app/core/data/comcol-data.service.spec.ts @@ -18,14 +18,16 @@ import { NotificationsService } from '../../shared/notifications/notifications.s import { HttpClient } from '@angular/common/http'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { DSOChangeAnalyzer } from './dso-change-analyzer.service'; +import { Item } from '../shared/item.model'; +import { Community } from '../shared/community.model'; const LINK_NAME = 'test'; /* tslint:disable:max-classes-per-file */ -class NormalizedTestObject extends NormalizedObject { +class NormalizedTestObject extends NormalizedObject { } -class TestService extends ComColDataService { +class TestService extends ComColDataService { constructor( protected requestService: RequestService, @@ -38,7 +40,7 @@ class TestService extends ComColDataService { protected halService: HALEndpointService, protected notificationsService: NotificationsService, protected http: HttpClient, - protected comparator: DSOChangeAnalyzer, + protected comparator: DSOChangeAnalyzer, protected linkPath: string ) { super(); diff --git a/src/app/core/data/comcol-data.service.ts b/src/app/core/data/comcol-data.service.ts index 8a1ea51bb3..693b8af58b 100644 --- a/src/app/core/data/comcol-data.service.ts +++ b/src/app/core/data/comcol-data.service.ts @@ -1,28 +1,17 @@ -import { - distinctUntilChanged, - filter, - first, - map, - mergeMap, - share, - take, - tap -} from 'rxjs/operators'; +import { distinctUntilChanged, filter, map, mergeMap, share, take, tap } from 'rxjs/operators'; import { merge as observableMerge, Observable, throwError as observableThrowError } from 'rxjs'; -import { hasValue, isEmpty, isNotEmpty } from '../../shared/empty.util'; +import { isEmpty, isNotEmpty } from '../../shared/empty.util'; import { NormalizedCommunity } from '../cache/models/normalized-community.model'; import { ObjectCacheService } from '../cache/object-cache.service'; import { CommunityDataService } from './community-data.service'; import { DataService } from './data.service'; import { FindAllOptions, FindByIDRequest } from './request.models'; -import { NormalizedObject } from '../cache/models/normalized-object.model'; import { HALEndpointService } from '../shared/hal-endpoint.service'; -import { RequestEntry } from './request.reducer'; import { getResponseFromEntry } from '../shared/operators'; import { CacheableObject } from '../cache/object-cache.reducer'; -export abstract class ComColDataService extends DataService { +export abstract class ComColDataService extends DataService { protected abstract cds: CommunityDataService; protected abstract objectCache: ObjectCacheService; protected abstract halService: HALEndpointService; diff --git a/src/app/core/data/community-data.service.ts b/src/app/core/data/community-data.service.ts index d09a0b9757..662b82d6ea 100644 --- a/src/app/core/data/community-data.service.ts +++ b/src/app/core/data/community-data.service.ts @@ -21,7 +21,7 @@ import { NormalizedObjectBuildService } from '../cache/builders/normalized-objec import { DSOChangeAnalyzer } from './dso-change-analyzer.service'; @Injectable() -export class CommunityDataService extends ComColDataService { +export class CommunityDataService extends ComColDataService { protected linkPath = 'communities'; protected topLinkPath = 'communities/search/top'; protected cds = this; @@ -35,7 +35,7 @@ export class CommunityDataService extends ComColDataService ) { super(); } @@ -54,6 +54,6 @@ export class CommunityDataService extends ComColDataService(hrefObs) as Observable>>; + return this.rdbService.buildList(hrefObs) as Observable>>; } } diff --git a/src/app/core/data/data.service.spec.ts b/src/app/core/data/data.service.spec.ts index 9b39f0b68e..178a16d4c1 100644 --- a/src/app/core/data/data.service.spec.ts +++ b/src/app/core/data/data.service.spec.ts @@ -16,14 +16,15 @@ import { HttpClient } from '@angular/common/http'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { compare } from 'fast-json-patch'; +import { Item } from '../shared/item.model'; const endpoint = 'https://rest.api/core'; // tslint:disable:max-classes-per-file -class NormalizedTestObject extends NormalizedObject { +class NormalizedTestObject extends NormalizedObject { } -class TestService extends DataService { +class TestService extends DataService { constructor( protected requestService: RequestService, protected rdbService: RemoteDataBuildService, diff --git a/src/app/core/data/data.service.ts b/src/app/core/data/data.service.ts index 6d1359d833..ac56436539 100644 --- a/src/app/core/data/data.service.ts +++ b/src/app/core/data/data.service.ts @@ -42,7 +42,7 @@ import { RequestEntry } from './request.reducer'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { ChangeAnalyzer } from './change-analyzer'; -export abstract class DataService { +export abstract class DataService { protected abstract requestService: RequestService; protected abstract rdbService: RemoteDataBuildService; protected abstract dataBuildService: NormalizedObjectBuildService; @@ -52,7 +52,7 @@ export abstract class DataService; + protected abstract comparator: ChangeAnalyzer; public abstract getBrowseEndpoint(options: FindAllOptions, linkPath?: string): Observable @@ -81,7 +81,7 @@ export abstract class DataService>> { + findAll(options: FindAllOptions = {}): Observable>> { const hrefObs = this.getFindAllHref(options); hrefObs.pipe( @@ -92,7 +92,7 @@ export abstract class DataService(hrefObs) as Observable>>; + return this.rdbService.buildList(hrefObs) as Observable>>; } /** @@ -104,7 +104,7 @@ export abstract class DataService> { + findById(id: string): Observable> { const hrefObs = this.halService.getEndpoint(this.linkPath).pipe( map((endpoint: string) => this.getIDHref(endpoint, id))); @@ -115,12 +115,12 @@ export abstract class DataService(hrefObs); + return this.rdbService.buildSingle(hrefObs); } - findByHref(href: string): Observable> { + findByHref(href: string): Observable> { this.requestService.configure(new GetRequest(this.requestService.generateRequestId(), href)); - return this.rdbService.buildSingle(href); + return this.rdbService.buildSingle(href); } /** @@ -137,11 +137,10 @@ export abstract class DataService> { + update(object: T): Observable> { const oldVersion$ = this.objectCache.getBySelfLink(object.self); - return oldVersion$.pipe(take(1), mergeMap((oldVersion: TNormalized) => { - const newVersion = this.dataBuildService.normalize(object); - const operations = this.comparator.diff(oldVersion, newVersion); + return oldVersion$.pipe(take(1), mergeMap((oldVersion: T) => { + const operations = this.comparator.diff(oldVersion, object); if (isNotEmpty(operations)) { this.objectCache.addPatch(object.self, operations); } @@ -160,7 +159,7 @@ export abstract class DataService> { + create(dso: T, parentUUID: string): Observable> { const requestId = this.requestService.generateRequestId(); const endpoint$ = this.halService.getEndpoint(this.linkPath).pipe( isNotEmptyOperator(), @@ -168,7 +167,7 @@ export abstract class DataService parentUUID ? `${endpoint}?parentCommunity=${parentUUID}` : endpoint) ); - const normalizedObject: TNormalized = this.dataBuildService.normalize(dso); + const normalizedObject: NormalizedObject = this.dataBuildService.normalize(dso); const serializedDso = new DSpaceRESTv2Serializer(NormalizedObjectFactory.getConstructor(dso.type)).serialize(normalizedObject); const request$ = endpoint$.pipe( @@ -209,7 +208,7 @@ export abstract class DataService { + delete(dso: T): Observable { const requestId = this.requestService.generateRequestId(); const hrefObs = this.halService.getEndpoint(this.linkPath).pipe( diff --git a/src/app/core/data/dso-change-analyzer.service.ts b/src/app/core/data/dso-change-analyzer.service.ts index a47359e5c0..dd3487d3d0 100644 --- a/src/app/core/data/dso-change-analyzer.service.ts +++ b/src/app/core/data/dso-change-analyzer.service.ts @@ -3,13 +3,14 @@ import { compare } from 'fast-json-patch'; import { ChangeAnalyzer } from './change-analyzer'; import { NormalizedDSpaceObject } from '../cache/models/normalized-dspace-object.model'; import { Injectable } from '@angular/core'; +import { DSpaceObject } from '../shared/dspace-object.model'; /** * A class to determine what differs between two * DSpaceObjects */ @Injectable() -export class DSOChangeAnalyzer implements ChangeAnalyzer { +export class DSOChangeAnalyzer implements ChangeAnalyzer { /** * Compare the metadata of two DSpaceObjects and return the differences as @@ -20,7 +21,7 @@ export class DSOChangeAnalyzer implements ChangeAnalyzer * @param {NormalizedDSpaceObject} object2 * The second object to compare */ - diff(object1: NormalizedDSpaceObject, object2: NormalizedDSpaceObject): Operation[] { + diff(object1: T | NormalizedDSpaceObject, object2: T | NormalizedDSpaceObject): Operation[] { return compare(object1.metadata, object2.metadata).map((operation: Operation) => Object.assign({}, operation, { path: '/metadata' + operation.path })); } } diff --git a/src/app/core/data/dso-response-parsing.service.ts b/src/app/core/data/dso-response-parsing.service.ts index 1066d11a50..fddd7b263c 100644 --- a/src/app/core/data/dso-response-parsing.service.ts +++ b/src/app/core/data/dso-response-parsing.service.ts @@ -13,6 +13,7 @@ import { RestRequest } from './request.models'; import { ResponseParsingService } from './parsing.service'; import { BaseResponseParsingService } from './base-response-parsing.service'; import { hasNoValue, hasValue } from '../../shared/empty.util'; +import { DSpaceObject } from '../shared/dspace-object.model'; @Injectable() export class DSOResponseParsingService extends BaseResponseParsingService implements ResponseParsingService { @@ -28,7 +29,7 @@ export class DSOResponseParsingService extends BaseResponseParsingService implem } parse(request: RestRequest, data: DSpaceRESTV2Response): RestResponse { - const processRequestDTO = this.process(data.payload, request.uuid); + const processRequestDTO = this.process, ResourceType>(data.payload, request.uuid); let objectList = processRequestDTO; if (hasNoValue(processRequestDTO)) { diff --git a/src/app/core/data/dspace-object-data.service.ts b/src/app/core/data/dspace-object-data.service.ts index 86ce9be7a9..bb02afbcd1 100644 --- a/src/app/core/data/dspace-object-data.service.ts +++ b/src/app/core/data/dspace-object-data.service.ts @@ -2,7 +2,6 @@ import { Injectable } from '@angular/core'; import { Store } from '@ngrx/store'; import { Observable } from 'rxjs'; import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; -import { NormalizedDSpaceObject } from '../cache/models/normalized-dspace-object.model'; import { CoreState } from '../core.reducers'; import { DSpaceObject } from '../shared/dspace-object.model'; import { HALEndpointService } from '../shared/hal-endpoint.service'; @@ -17,7 +16,7 @@ import { NormalizedObjectBuildService } from '../cache/builders/normalized-objec import { DSOChangeAnalyzer } from './dso-change-analyzer.service'; /* tslint:disable:max-classes-per-file */ -class DataServiceImpl extends DataService { +class DataServiceImpl extends DataService { protected linkPath = 'dso'; constructor( @@ -29,7 +28,7 @@ class DataServiceImpl extends DataService protected halService: HALEndpointService, protected notificationsService: NotificationsService, protected http: HttpClient, - protected comparator: DSOChangeAnalyzer) { + protected comparator: DSOChangeAnalyzer) { super(); } @@ -55,7 +54,7 @@ export class DSpaceObjectDataService { protected halService: HALEndpointService, protected notificationsService: NotificationsService, protected http: HttpClient, - protected comparator: DSOChangeAnalyzer) { + protected comparator: DSOChangeAnalyzer) { this.dataService = new DataServiceImpl(requestService, rdbService, dataBuildService, null, objectCache, halService, notificationsService, http, comparator); } diff --git a/src/app/core/data/item-data.service.ts b/src/app/core/data/item-data.service.ts index bd3c42a67c..3fcdf57498 100644 --- a/src/app/core/data/item-data.service.ts +++ b/src/app/core/data/item-data.service.ts @@ -1,12 +1,10 @@ - -import {distinctUntilChanged, map, filter} from 'rxjs/operators'; +import { distinctUntilChanged, filter, map } from 'rxjs/operators'; import { Injectable } from '@angular/core'; import { Store } from '@ngrx/store'; import { Observable } from 'rxjs'; import { isNotEmpty } from '../../shared/empty.util'; import { BrowseService } from '../browse/browse.service'; import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service'; -import { NormalizedItem } from '../cache/models/normalized-item.model'; import { CoreState } from '../core.reducers'; import { Item } from '../shared/item.model'; import { URLCombiner } from '../url-combiner/url-combiner'; @@ -24,7 +22,7 @@ import { configureRequest, getRequestFromRequestHref } from '../shared/operators import { RequestEntry } from './request.reducer'; @Injectable() -export class ItemDataService extends DataService { +export class ItemDataService extends DataService { protected linkPath = 'items'; constructor( @@ -37,7 +35,7 @@ export class ItemDataService extends DataService { protected halService: HALEndpointService, protected notificationsService: NotificationsService, protected http: HttpClient, - protected comparator: DSOChangeAnalyzer) { + protected comparator: DSOChangeAnalyzer) { super(); } diff --git a/src/app/core/data/metadata-schema-data.service.ts b/src/app/core/data/metadata-schema-data.service.ts index 8dd0c5d24f..7f17ad9cf1 100644 --- a/src/app/core/data/metadata-schema-data.service.ts +++ b/src/app/core/data/metadata-schema-data.service.ts @@ -8,17 +8,16 @@ import { CoreState } from '../core.reducers'; import { DataService } from './data.service'; import { RequestService } from './request.service'; import { HALEndpointService } from '../shared/hal-endpoint.service'; -import { FindAllOptions, GetRequest, RestRequest } from './request.models'; +import { FindAllOptions } from './request.models'; import { ObjectCacheService } from '../cache/object-cache.service'; import { MetadataSchema } from '../metadata/metadataschema.model'; -import { NormalizedMetadataSchema } from '../metadata/normalized-metadata-schema.model'; import { ChangeAnalyzer } from './change-analyzer'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { HttpClient } from '@angular/common/http'; import { NotificationsService } from '../../shared/notifications/notifications.service'; @Injectable() -export class MetadataSchemaDataService extends DataService { +export class MetadataSchemaDataService extends DataService { protected linkPath = 'metadataschemas'; constructor( @@ -28,7 +27,7 @@ export class MetadataSchemaDataService extends DataService, + protected comparator: ChangeAnalyzer, protected dataBuildService: NormalizedObjectBuildService, protected http: HttpClient, protected notificationsService: NotificationsService) { @@ -45,5 +44,4 @@ export class MetadataSchemaDataService extends DataService implements CacheableObject, ListableObject { @autoserialize public handle: string; diff --git a/src/app/core/eperson/models/normalized-group.model.ts b/src/app/core/eperson/models/normalized-group.model.ts index be5995d9c5..d576f399ff 100644 --- a/src/app/core/eperson/models/normalized-group.model.ts +++ b/src/app/core/eperson/models/normalized-group.model.ts @@ -7,7 +7,7 @@ import { Group } from './group.model'; @mapsTo(Group) @inheritSerialization(NormalizedDSpaceObject) -export class NormalizedGroup extends NormalizedDSpaceObject implements CacheableObject, ListableObject { +export class NormalizedGroup extends NormalizedDSpaceObject implements CacheableObject, ListableObject { @autoserialize public handle: string; diff --git a/src/app/core/metadata/normalized-metadata-schema.model.ts b/src/app/core/metadata/normalized-metadata-schema.model.ts index 432a8bfd5e..0a19c874e2 100644 --- a/src/app/core/metadata/normalized-metadata-schema.model.ts +++ b/src/app/core/metadata/normalized-metadata-schema.model.ts @@ -6,7 +6,7 @@ import { ListableObject } from '../../shared/object-collection/shared/listable-o import { MetadataSchema } from './metadataschema.model'; @mapsTo(MetadataSchema) -export class NormalizedMetadataSchema extends NormalizedObject implements CacheableObject, ListableObject { +export class NormalizedMetadataSchema extends NormalizedObject implements ListableObject { @autoserialize id: number; diff --git a/src/app/shared/auth-nav-menu/auth-nav-menu.component.html b/src/app/shared/auth-nav-menu/auth-nav-menu.component.html index 56a62c0fbd..97c3e39353 100644 --- a/src/app/shared/auth-nav-menu/auth-nav-menu.component.html +++ b/src/app/shared/auth-nav-menu/auth-nav-menu.component.html @@ -14,7 +14,7 @@
    -
  • {{(user | async).name}}
    • +
  • {{(user | async).name}} ({{(user | async).email}})
diff --git a/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.spec.ts b/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.spec.ts index fd3464ba5e..4dad4a703f 100644 --- a/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.spec.ts +++ b/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.spec.ts @@ -11,13 +11,12 @@ import { CommonModule } from '@angular/common'; import { RouterTestingModule } from '@angular/router/testing'; import { NO_ERRORS_SCHEMA } from '@angular/core'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; -import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-dspace-object.model'; import { CreateComColPageComponent } from './create-comcol-page.component'; import { DataService } from '../../../core/data/data.service'; describe('CreateComColPageComponent', () => { - let comp: CreateComColPageComponent; - let fixture: ComponentFixture>; + let comp: CreateComColPageComponent; + let fixture: ComponentFixture>; let communityDataService: CommunityDataService; let dsoDataService: CommunityDataService; let routeService: RouteService; diff --git a/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.ts b/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.ts index fc7ee3ee70..c9fcfecb97 100644 --- a/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.ts +++ b/src/app/shared/comcol-forms/create-comcol-page/create-comcol-page.component.ts @@ -10,7 +10,6 @@ import { take } from 'rxjs/operators'; import { getSucceededRemoteData } from '../../../core/shared/operators'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; import { DataService } from '../../../core/data/data.service'; -import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-dspace-object.model'; /** * Component representing the create page for communities and collections @@ -19,7 +18,7 @@ import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-ds selector: 'ds-create-comcol', template: '' }) -export class CreateComColPageComponent implements OnInit { +export class CreateComColPageComponent implements OnInit { /** * Frontend endpoint for this type of DSO */ @@ -36,7 +35,7 @@ export class CreateComColPageComponent>; public constructor( - protected dsoDataService: DataService, + protected dsoDataService: DataService, protected parentDataService: CommunityDataService, protected routeService: RouteService, protected router: Router diff --git a/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.spec.ts b/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.spec.ts index 81ec9c47a0..b5c3c3640d 100644 --- a/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.spec.ts +++ b/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.spec.ts @@ -9,15 +9,14 @@ import { CommonModule } from '@angular/common'; import { RouterTestingModule } from '@angular/router/testing'; import { NO_ERRORS_SCHEMA } from '@angular/core'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; -import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-dspace-object.model'; import { DataService } from '../../../core/data/data.service'; import { DeleteComColPageComponent } from './delete-comcol-page.component'; import { NotificationsService } from '../../notifications/notifications.service'; import { NotificationsServiceStub } from '../../testing/notifications-service-stub'; describe('DeleteComColPageComponent', () => { - let comp: DeleteComColPageComponent; - let fixture: ComponentFixture>; + let comp: DeleteComColPageComponent; + let fixture: ComponentFixture>; let dsoDataService: CommunityDataService; let router: Router; diff --git a/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.ts b/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.ts index 6e3a826e87..e2e73bae14 100644 --- a/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.ts +++ b/src/app/shared/comcol-forms/delete-comcol-page/delete-comcol-page.component.ts @@ -1,13 +1,9 @@ import { Component, OnInit } from '@angular/core'; import { Observable } from 'rxjs'; -import { RouteService } from '../../services/route.service'; import { ActivatedRoute, Router } from '@angular/router'; import { RemoteData } from '../../../core/data/remote-data'; -import { isNotUndefined } from '../../empty.util'; import { first, map } from 'rxjs/operators'; -import { getSucceededRemoteData } from '../../../core/shared/operators'; import { DataService } from '../../../core/data/data.service'; -import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-dspace-object.model'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; import { NotificationsService } from '../../notifications/notifications.service'; import { TranslateService } from '@ngx-translate/core'; @@ -19,7 +15,7 @@ import { TranslateService } from '@ngx-translate/core'; selector: 'ds-delete-comcol', template: '' }) -export class DeleteComColPageComponent implements OnInit { +export class DeleteComColPageComponent implements OnInit { /** * Frontend endpoint for this type of DSO */ @@ -30,7 +26,7 @@ export class DeleteComColPageComponent>; public constructor( - protected dsoDataService: DataService, + protected dsoDataService: DataService, protected router: Router, protected route: ActivatedRoute, protected notifications: NotificationsService, diff --git a/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.spec.ts b/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.spec.ts index 88c11a0b4d..75b7fe40e7 100644 --- a/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.spec.ts +++ b/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.spec.ts @@ -10,13 +10,12 @@ import { CommonModule } from '@angular/common'; import { RouterTestingModule } from '@angular/router/testing'; import { NO_ERRORS_SCHEMA } from '@angular/core'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; -import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-dspace-object.model'; import { EditComColPageComponent } from './edit-comcol-page.component'; import { DataService } from '../../../core/data/data.service'; describe('EditComColPageComponent', () => { - let comp: EditComColPageComponent; - let fixture: ComponentFixture>; + let comp: EditComColPageComponent; + let fixture: ComponentFixture>; let dsoDataService: CommunityDataService; let router: Router; diff --git a/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.ts b/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.ts index b669fcea54..24181b5e61 100644 --- a/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.ts +++ b/src/app/shared/comcol-forms/edit-comcol-page/edit-comcol-page.component.ts @@ -6,7 +6,6 @@ import { isNotUndefined } from '../../empty.util'; import { first, map } from 'rxjs/operators'; import { getSucceededRemoteData } from '../../../core/shared/operators'; import { DataService } from '../../../core/data/data.service'; -import { NormalizedDSpaceObject } from '../../../core/cache/models/normalized-dspace-object.model'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; /** @@ -16,7 +15,7 @@ import { DSpaceObject } from '../../../core/shared/dspace-object.model'; selector: 'ds-edit-comcol', template: '' }) -export class EditComColPageComponent implements OnInit { +export class EditComColPageComponent implements OnInit { /** * Frontend endpoint for this type of DSO */ @@ -27,7 +26,7 @@ export class EditComColPageComponent>; public constructor( - protected dsoDataService: DataService, + protected dsoDataService: DataService, protected router: Router, protected route: ActivatedRoute ) { From ace523ed14c91feff6713a219dc85163b170ddda Mon Sep 17 00:00:00 2001 From: lotte Date: Fri, 8 Feb 2019 14:42:34 +0100 Subject: [PATCH 04/18] intermediate commit for tests --- config/environment.default.js | 5 +- resources/i18n/en.json | 21 +- .../edit-item-page.component.html | 5 +- .../edit-item-page/edit-item-page.module.ts | 4 +- .../edit-in-place-field.component.html | 89 +++--- .../edit-in-place-field.component.scss | 3 - .../edit-in-place-field.component.spec.ts | 290 ++++++++++++++++++ .../edit-in-place-field.component.ts | 166 ++++++++-- .../item-metadata.component.html | 51 ++- .../item-metadata.component.spec.ts | 199 ++++++++++++ .../item-metadata/item-metadata.component.ts | 167 ++++++++-- .../+item-page/item-page-routing.module.ts | 4 +- .../search-facet-filter.component.ts | 8 +- .../search-service/facet-value.model.ts | 1 - .../builders/remote-data-build.service.ts | 4 +- .../core/cache/server-sync-buffer.reducer.ts | 1 - src/app/core/core.effects.ts | 4 +- src/app/core/core.module.ts | 2 + src/app/core/core.reducers.ts | 19 +- .../object-updates/object-updates.actions.ts | 94 +++--- .../object-updates.effects.spec.ts | 55 ++++ .../object-updates/object-updates.effects.ts | 63 ++++ .../object-updates/object-updates.reducer.ts | 279 +++++++++++------ .../object-updates/object-updates.service.ts | 134 ++++++++ src/app/core/metadata/metadatafield.model.ts | 9 + src/app/core/registry/registry.service.ts | 27 +- src/app/core/shared/metadatum.model.ts | 2 + .../input-suggestions.component.html | 12 +- .../input-suggestions.component.scss | 3 + .../input-suggestions.component.ts | 64 +++- .../input-suggestions.model.ts | 4 + .../notifications/notifications.service.ts | 18 +- src/app/shared/shared.module.ts | 2 + src/app/shared/utils/object-values-pipe.ts | 18 ++ src/styles/_bootstrap_variables.scss | 3 +- 35 files changed, 1560 insertions(+), 270 deletions(-) create mode 100644 src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts create mode 100644 src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts create mode 100644 src/app/core/data/object-updates/object-updates.effects.spec.ts create mode 100644 src/app/core/data/object-updates/object-updates.effects.ts create mode 100644 src/app/core/data/object-updates/object-updates.service.ts create mode 100644 src/app/shared/input-suggestions/input-suggestions.model.ts create mode 100644 src/app/shared/utils/object-values-pipe.ts diff --git a/config/environment.default.js b/config/environment.default.js index d46dc10dee..788a1fb827 100644 --- a/config/environment.default.js +++ b/config/environment.default.js @@ -79,5 +79,8 @@ module.exports = { code: 'nl', label: 'Nederlands', active: false, - }] + }], + item: { + + } }; diff --git a/resources/i18n/en.json b/resources/i18n/en.json index a87d36ef9b..cd7e1276f1 100644 --- a/resources/i18n/en.json +++ b/resources/i18n/en.json @@ -223,7 +223,26 @@ "error": "An error occured while deleting the item" }, "metadata": { - "add-button": "Add new metadata" + "add-button": "Add", + "discard-button": "Discard", + "reinstate-button": "Undo", + "save-button": "Save", + "headers": { + "field": "Field", + "value": "Value", + "language": "Lang", + "edit": "Edit" + }, + "notifications": { + "outdated": { + "title": "Changed outdated", + "content": "The item you're currently working on has been changed by another user. Your current changes are discarded to prevent conflicts" + }, + "discarded": { + "title": "Changed discarded", + "content": "Your changes were discarded. To reinstate your changes click the 'Undo' button" + } + } } } }, diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.html b/src/app/+item-page/edit-item-page/edit-item-page.component.html index 46a8126b05..82a4b0c283 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.html +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.html @@ -14,9 +14,10 @@ - + - + + diff --git a/src/app/+item-page/edit-item-page/edit-item-page.module.ts b/src/app/+item-page/edit-item-page/edit-item-page.module.ts index adbcf6b0df..1c0c747ffb 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.module.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.module.ts @@ -13,7 +13,7 @@ import {ItemPrivateComponent} from './item-private/item-private.component'; import {ItemPublicComponent} from './item-public/item-public.component'; import {ItemDeleteComponent} from './item-delete/item-delete.component'; import { ItemMetadataComponent } from './item-metadata/item-metadata.component'; -import { EditInPlaceComponent } from './item-metadata/edit-in-place-field/edit-in-place-field.component'; +import { EditInPlaceFieldComponent } from './item-metadata/edit-in-place-field/edit-in-place-field.component'; /** * Module that contains all components related to the Edit Item page administrator functionality @@ -36,7 +36,7 @@ import { EditInPlaceComponent } from './item-metadata/edit-in-place-field/edit-i ItemDeleteComponent, ItemStatusComponent, ItemMetadataComponent, - EditInPlaceComponent + EditInPlaceFieldComponent ] }) export class EditItemPageModule { diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html index 5a5e16383a..279552565c 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -1,42 +1,47 @@ - - - {{metadata.key}} - - - - - - - - - - - - - - -
- {{metadata.value}} -
-
- -
- - -
- {{metadata.language}} -
-
- -
- - -
- - -
-
- - -
- +
+ + +
+ {{metadata?.key}} +
+
+ +
+ + +
+ {{metadata?.value}} +
+
+ +
+ + +
+ {{metadata?.language}} +
+
+ +
+ + +
+ + + + +
+ +
\ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss index 58c24635e6..e69de29bb2 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss @@ -1,3 +0,0 @@ -textarea, input, select { - width: 100%; -} \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts new file mode 100644 index 0000000000..0d7006b85c --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -0,0 +1,290 @@ +import { async, ComponentFixture, TestBed } from '@angular/core/testing'; +import { CUSTOM_ELEMENTS_SCHEMA, DebugElement } from '@angular/core'; +import { EditInPlaceFieldComponent } from './edit-in-place-field.component'; +import { RegistryService } from '../../../../core/registry/registry.service'; +import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; +import { of as observableOf } from 'rxjs'; +import { RemoteData } from '../../../../core/data/remote-data'; +import { PaginatedList } from '../../../../core/data/paginated-list'; +import { MetadataField } from '../../../../core/metadata/metadatafield.model'; +import { By } from '@angular/platform-browser'; +import { Metadatum } from '../../../../core/shared/metadatum.model'; +import { FormsModule } from '@angular/forms'; +import { SharedModule } from '../../../../shared/shared.module'; +import { getTestScheduler } from 'jasmine-marbles'; +import { InputSuggestion } from '../../../../shared/input-suggestions/input-suggestions.model'; +import { TestScheduler } from 'rxjs/testing'; +import { MetadataSchema } from '../../../../core/metadata/metadataschema.model'; +import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; + +let comp: EditInPlaceFieldComponent; +let fixture: ComponentFixture; +let de: DebugElement; +let el: HTMLElement; +let metadataFieldService; +let objectUpdatesService; +let paginatedMetadataFields; +const mdSchema = Object.assign(new MetadataSchema(), { prefix: 'dc' }) +const mdField1 = Object.assign(new MetadataField(), { + schema: mdSchema, + element: 'contributor', + qualifier: 'author' +}); +const mdField2 = Object.assign(new MetadataField(), { schema: mdSchema, element: 'title' }); +const mdField3 = Object.assign(new MetadataField(), { + schema: mdSchema, + element: 'description', + qualifier: 'abstract' +}); + +const metadatum = Object.assign(new Metadatum(), { + key: 'dc.description.abstract', + value: 'Example abstract', + language: 'en' +}); + +const route = 'http://test-url.com/test-url'; +const fieldUpdate = { + field: metadatum, + changeType: undefined +}; +let scheduler: TestScheduler; + +describe('EditInPlaceFieldComponent', () => { + + beforeEach(async(() => { + scheduler = getTestScheduler(); + + paginatedMetadataFields = new PaginatedList(undefined, [mdField1, mdField2, mdField3]); + + metadataFieldService = jasmine.createSpyObj({ + queryMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)) + }); + objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', + { + saveChangeFieldUpdate: {}, + saveRemoveFieldUpdate: {}, + setEditableFieldUpdate: {}, + removeSingleFieldUpdate: {}, + isEditable: observableOf(false) // should always return something --> its in ngOnInit + } + ); + + TestBed.configureTestingModule({ + imports: [FormsModule, SharedModule], + declarations: [EditInPlaceFieldComponent], + providers: [ + { provide: RegistryService, useValue: metadataFieldService }, + { provide: ObjectUpdatesService, useValue: objectUpdatesService }, + ], schemas: [ + CUSTOM_ELEMENTS_SCHEMA + ] + }).compileComponents(); + })); + + beforeEach(() => { + fixture = TestBed.createComponent(EditInPlaceFieldComponent); + comp = fixture.componentInstance; // EditInPlaceFieldComponent test instance + de = fixture.debugElement.query(By.css('div.d-flex')); + el = de.nativeElement; + + comp.route = route; + comp.fieldUpdate = fieldUpdate; + comp.metadata = metadatum; + + fixture.detectChanges(); + }); + + describe('update', () => { + beforeEach(() => { + comp.update(); + }); + + it('it should call saveChangeFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { + expect(objectUpdatesService.saveChangeFieldUpdate).toHaveBeenCalledWith(route, metadatum); + }); + }); + + describe('setEditable', () => { + const editable = false; + beforeEach(() => { + comp.setEditable(editable); + }); + + it('it should call setEditableFieldUpdate on the objectUpdatesService with the correct route and uuid and false', () => { + expect(objectUpdatesService.setEditableFieldUpdate).toHaveBeenCalledWith(route, metadatum.uuid, editable); + }); + }); + + describe('remove', () => { + beforeEach(() => { + comp.remove(); + }); + + it('it should call saveRemoveFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { + expect(objectUpdatesService.saveRemoveFieldUpdate).toHaveBeenCalledWith(route, metadatum); + }); + }); + + describe('remove', () => { + beforeEach(() => { + comp.remove(); + }); + + it('it should call saveRemoveFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { + expect(objectUpdatesService.saveRemoveFieldUpdate).toHaveBeenCalledWith(route, metadatum); + }); + }); + + describe('findMetadataFieldSuggestions', () => { + const query = 'query string'; + + const metadataFieldSuggestions: InputSuggestion[] = + [ + { displayValue: mdField1.toString(), value: mdField1.toString() }, + { displayValue: mdField2.toString(), value: mdField2.toString() }, + { displayValue: mdField3.toString(), value: mdField3.toString() } + ]; + + beforeEach(() => { + comp.findMetadataFieldSuggestions(query); + + }); + + it('it should call queryMetadataFields on the metadataFieldService with the correct query', () => { + + expect(metadataFieldService.queryMetadataFields).toHaveBeenCalledWith(query); + }); + + it('it should set metadataFieldSuggestions to the right value', () => { + const expected = 'a'; + scheduler.expectObservable(comp.metadataFieldSuggestions).toBe(expected, { a: metadataFieldSuggestions }); + }); + }); + + describe('canSetEditable', () => { + describe('when editable is currently true', () => { + beforeEach(() => { + comp.editable = observableOf(true); + }); + + it('canSetEditable should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canSetEditable()).toBe(expected, { a: false }); + }); + }); + + describe('when editable is currently false', () => { + beforeEach(() => { + comp.editable = observableOf(false); + }); + + describe('when the fieldUpdate\'s changeType is currently not REMOVE', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.ADD; + }); + it('canSetEditable should return an observable emitting true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canSetEditable()).toBe(expected, { a: true }); + }); + }); + + describe('when the fieldUpdate\'s changeType is currently REMOVE', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.REMOVE; + }); + it('canSetEditable should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canSetEditable()).toBe(expected, { a: false }); + }); + }) + }); + }); + + describe('canSetUneditable', () => { + describe('when editable is currently true', () => { + beforeEach(() => { + comp.editable = observableOf(true); + }); + + it('canSetUneditable should return an observable emitting true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canSetUneditable()).toBe(expected, { a: true }); + }); + }); + + describe('when editable is currently false', () => { + beforeEach(() => { + comp.editable = observableOf(false); + }); + + it('canSetUneditable should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canSetUneditable()).toBe(expected, { a: false }); + }); + }); + }); + + describe('canRemove', () => { + describe('when editable is currently true', () => { + beforeEach(() => { + comp.editable = observableOf(true); + }); + it('canRemove should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: false }); + }); + }); + + describe('when editable is currently false', () => { + beforeEach(() => { + comp.editable = observableOf(false); + }); + + describe('when the fieldUpdate\'s changeType is currently not REMOVE or ADD', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.UPDATE; + }); + it('canRemove should return an observable emitting true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: true }); + }); + }); + + describe('when the fieldUpdate\'s changeType is currently ADD', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.ADD; + }); + it('canRemove should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: false }); + }); + }) + }); + }); + + describe('canUndo', () => { + + describe('when the fieldUpdate\'s changeType is currently ADD, UPDATE or REMOVE', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.ADD; + }); + + it('canUndo should return an observable emitting true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canUndo()).toBe(expected, { a: true }); + }); + }); + + describe('when the fieldUpdate\'s changeType is currently undefined', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = undefined; + }); + + it('canUndo should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canUndo()).toBe(expected, { a: false }); + }); + }); + }); +}); diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index 1139415ecc..8902125985 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -1,41 +1,169 @@ -import { Component, EventEmitter, Input, Output } from '@angular/core'; +import { Component, Input, OnChanges, OnInit } from '@angular/core'; import { isNotEmpty } from '../../../../shared/empty.util'; import { Metadatum } from '../../../../core/shared/metadatum.model'; import { RegistryService } from '../../../../core/registry/registry.service'; +import { cloneDeep } from 'lodash'; +import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; +import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; +import { BehaviorSubject, Observable } from 'rxjs'; +import { map, take } from 'rxjs/operators'; +import { MetadataField } from '../../../../core/metadata/metadatafield.model'; +import { InputSuggestion } from '../../../../shared/input-suggestions/input-suggestions.model'; +import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; +import { of as observableOf } from 'rxjs'; @Component({ - selector: 'ds-edit-in-place-field.', + selector: 'ds-edit-in-place-field', styleUrls: ['./edit-in-place-field.component.scss'], templateUrl: './edit-in-place-field.component.html', }) /** - * Component for displaying an item's status + * Component that displays a single metadatum of an item on the edit page */ -export class EditInPlaceComponent { +export class EditInPlaceFieldComponent implements OnInit, OnChanges { /** - * The value to display + * The current field, value and state of the metadatum */ - @Input() metadata: Metadatum; - @Output() mdUpdate: EventEmitter = new EventEmitter(); - @Output() mdRemove: EventEmitter = new EventEmitter(); - editable = false; + @Input() fieldUpdate: FieldUpdate; + /** + * The current route of this page + */ + @Input() route: string; + /** + * The metadatum of this field + */ + metadata: Metadatum; + /** + * Emits whether or not this field is currently editable + */ + editable: Observable; + + /** + * The current suggestions for the metadatafield when editing + */ + metadataFieldSuggestions: BehaviorSubject = new BehaviorSubject([]); constructor( private metadataFieldService: RegistryService, + private objectUpdatesService: ObjectUpdatesService, ) { - } - isNotEmpty(value) { + /** + * Sends a new change update for this field to the object updates service + */ + update() { + this.objectUpdatesService.saveChangeFieldUpdate(this.route, this.metadata); + } + + /** + * Sends a new editable state for this field to the service to change it + * @param editable The new editable state for this field + */ + setEditable(editable: boolean) { + this.objectUpdatesService.setEditableFieldUpdate(this.route, this.metadata.uuid, editable); + } + + /** + * Sends a new remove update for this field to the object updates service + */ + remove() { + this.objectUpdatesService.saveRemoveFieldUpdate(this.route, this.metadata); + } + + /** + * Notifies the object updates service that the updates for the current field can be removed + */ + removeChangesFromField() { + this.objectUpdatesService.removeSingleFieldUpdate(this.route, this.metadata.uuid); + } + + /** + * Sets up an observable that keeps track of the current editable state of this field + */ + ngOnInit(): void { + this.editable = this.objectUpdatesService.isEditable(this.route, this.metadata.uuid); + } + + /** + * Sets the current metadatafield based on the fieldUpdate input field + */ + ngOnChanges(): void { + this.metadata = cloneDeep(this.fieldUpdate.field) as Metadatum; + } + + /** + * Requests all metadata fields that contain the query string in their key + * Then sets all found metadata fields as metadataFieldSuggestions + * @param query The query to look for + */ + findMetadataFieldSuggestions(query: string): void { + this.metadataFieldService.queryMetadataFields(query).pipe( + // getSucceededRemoteData(), + take(1), + map((data) => data.payload.page) + ).subscribe( + (fields: MetadataField[]) => this.metadataFieldSuggestions.next( + fields.map((field: MetadataField) => { + return { + displayValue: field.toString(), + value: field.toString() + } + }) + ) + ); + } + + /** + * Check if a user should be allowed to edit this field + * @return an observable that emits true when the user should be able to edit this field and false when they should not + */ + canSetEditable(): Observable { + return this.editable.pipe( + map((editable: boolean) => { + if (editable) { + return false; + } else { + return this.fieldUpdate.changeType !== FieldChangeType.REMOVE; + } + }) + ); + } + + /** + * Check if a user should be allowed to disabled editing this field + * @return an observable that emits true when the user should be able to disable editing this field and false when they should not + */ + canSetUneditable(): Observable { + return this.editable; + } + + /** + * Check if a user should be allowed to remove this field + * @return an observable that emits true when the user should be able to remove this field and false when they should not + */ + canRemove(): Observable { + return this.editable.pipe( + map((editable: boolean) => { + if (editable) { + return false; + } else { + return this.fieldUpdate.changeType !== FieldChangeType.REMOVE && this.fieldUpdate.changeType !== FieldChangeType.ADD; + } + }) + ); + } + + /** + * Check if a user should be allowed to undo changes to this field + * @return an observable that emits true when the user should be able to undo changes to this field and false when they should not + */ + canUndo(): Observable { + return observableOf(this.fieldUpdate.changeType >= 0); + } + + protected isNotEmpty(value): boolean { return isNotEmpty(value); } - - update() { - this.mdUpdate.emit(); - } - - remove() { - this.mdRemove.emit() - } } diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index f1c45ddda7..bc8e52d48b 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -1,12 +1,55 @@
- - +
+ + +
+ + + +
+
+
- - + + + + + + + +
{{'item.edit.metadata.headers.field' | translate}}{{'item.edit.metadata.headers.value' | translate}}{{'item.edit.metadata.headers.language' | translate}}{{'item.edit.metadata.headers.edit' | translate}}
+
+ + + +
diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts new file mode 100644 index 0000000000..bbeda39716 --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts @@ -0,0 +1,199 @@ +import { async, ComponentFixture, TestBed } from '@angular/core/testing'; +import { CUSTOM_ELEMENTS_SCHEMA, DebugElement } from '@angular/core'; +import { of as observableOf } from 'rxjs'; +import { getTestScheduler } from 'jasmine-marbles'; +import { ItemMetadataComponent } from './item-metadata.component'; +import { Metadatum } from '../../../core/shared/metadatum.model'; +import { TestScheduler } from 'rxjs/testing'; +import { SharedModule } from '../../../shared/shared.module'; +import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; +import { Router } from '@angular/router'; +import { NotificationsService } from '../../../shared/notifications/notifications.service'; +import { TranslateModule, TranslateService } from '@ngx-translate/core'; +import { ItemDataService } from '../../../core/data/item-data.service'; +import { By } from '@angular/platform-browser'; +import { + INotification, + Notification +} from '../../../shared/notifications/models/notification.model'; +import { NotificationType } from '../../../shared/notifications/models/notification-type'; +import { RouterStub } from '../../../shared/testing/router-stub'; +import { GLOBAL_CONFIG } from '../../../../config'; +import { Item } from '../../../core/shared/item.model'; +import { FieldChangeType } from '../../../core/data/object-updates/object-updates.actions'; +import { RemoteData } from '../../../core/data/remote-data'; + +let comp: ItemMetadataComponent; +let fixture: ComponentFixture; +let de: DebugElement; +let el: HTMLElement; +let objectUpdatesService; +const infoNotification: INotification = new Notification('id', NotificationType.Info, 'info'); +const warningNotification: INotification = new Notification('id', NotificationType.Warning, 'warning'); +const date = new Date(); +const router = new RouterStub(); +let itemService; +const notificationsService = jasmine.createSpyObj('notificationsService', + { + info: infoNotification, + warning: warningNotification + } +); +const metadatum1 = Object.assign(new Metadatum(), { + key: 'dc.description.abstract', + value: 'Example abstract', + language: 'en' +}); + +const metadatum2 = Object.assign(new Metadatum(), { + key: 'dc.title', + value: 'Title test', + language: 'de' +}); + +const metadatum3 = Object.assign(new Metadatum(), { + key: 'dc.contributor.author', + value: 'Shakespeare, William', +}); + +const route = 'http://test-url.com/test-url'; + +router.url = route; + +const fieldUpdate1 = { + field: metadatum1, + changeType: undefined +}; + +const fieldUpdate2 = { + field: metadatum2, + changeType: FieldChangeType.REMOVE +}; + +const fieldUpdate3 = { + field: metadatum3, + changeType: undefined +}; + +let scheduler: TestScheduler; +let item; +describe('ItemMetadataComponent', () => { + beforeEach(async(() => { + item = Object.assign(new Item(), { metadata: [metadatum1, metadatum2, metadatum3] }, { lastModified: date }); + itemService = jasmine.createSpyObj('itemService', { + update: observableOf(new RemoteData(false, false, true, undefined, item)) + }); + scheduler = getTestScheduler(); + objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', + { + getFieldUpdates: observableOf({ + [metadatum1.uuid]: fieldUpdate1, + [metadatum2.uuid]: fieldUpdate2, + [metadatum3.uuid]: fieldUpdate3 + }), + saveAddFieldUpdate: {}, + discardFieldUpdates: {}, + reinstateFieldUpdates: observableOf(true), + initialize: {}, + getUpdatedFields: observableOf([metadatum1, metadatum2, metadatum3]), + getLastModified: observableOf(date), + hasUpdates: observableOf(true), + isReinstatable: observableOf(false) // should always return something --> its in ngOnInit + } + ); + + TestBed.configureTestingModule({ + imports: [SharedModule, TranslateModule.forRoot()], + declarations: [ItemMetadataComponent], + providers: [ + { provide: ItemDataService, useValue: itemService }, + { provide: ObjectUpdatesService, useValue: objectUpdatesService }, + { provide: Router, useValue: router }, + { provide: NotificationsService, useValue: notificationsService }, + { provide: GLOBAL_CONFIG, useValue: { notifications: { timeOut: 10 } } as any } + ], schemas: [ + CUSTOM_ELEMENTS_SCHEMA + ] + }).compileComponents(); + }) + ) + ; + + beforeEach(() => { + fixture = TestBed.createComponent(ItemMetadataComponent); + comp = fixture.componentInstance; // EditInPlaceFieldComponent test instance + de = fixture.debugElement.query(By.css('div.d-flex')); + el = de.nativeElement; + comp.item = item; + comp.route = route; + fixture.detectChanges(); + }); + + describe('add', () => { + const md = new Metadatum(); + beforeEach(() => { + comp.add(md); + }); + + it('it should call saveAddFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { + expect(objectUpdatesService.saveAddFieldUpdate).toHaveBeenCalledWith(route, md); + }); + }); + + describe('discard', () => { + beforeEach(() => { + comp.discard(); + }); + + it('it should call discardFieldUpdates on the objectUpdatesService with the correct route and notification', () => { + expect(objectUpdatesService.discardFieldUpdates).toHaveBeenCalledWith(route, infoNotification); + }); + }); + + describe('reinstate', () => { + beforeEach(() => { + comp.reinstate(); + }); + + it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct route', () => { + expect(objectUpdatesService.reinstateFieldUpdates).toHaveBeenCalledWith(route); + }); + }); + + describe('submit', () => { + beforeEach(() => { + comp.submit(); + }); + + it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct route and metadata', () => { + expect(objectUpdatesService.getUpdatedFields).toHaveBeenCalledWith(route, comp.item.metadata); + expect(itemService.update).toHaveBeenCalledWith(comp.item); + expect(objectUpdatesService.getFieldUpdates).toHaveBeenCalledWith(route, comp.item.metadata); + }); + }); + + describe('hasChanges', () => { + describe('when the objectUpdatesService\'s hasUpdated method returns true', () => { + beforeEach(() => { + objectUpdatesService.hasUpdates.and.returnValue(observableOf(true)); + }); + + it('should return an observable that emits true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.hasChanges()).toBe(expected, { a: true }); + }); + }); + + describe('when the objectUpdatesService\'s hasUpdated method returns false', () => { + beforeEach(() => { + objectUpdatesService.hasUpdates.and.returnValue(observableOf(false)); + }); + + it('should return an observable that emits false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.hasChanges()).toBe(expected, { a: false }); + }); + }); + }); +}) +; diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index 9fe1d76a03..6c7b310ce2 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -1,40 +1,165 @@ -import { Component, Input } from '@angular/core'; +import { Component, Inject, Input, OnInit } from '@angular/core'; import { Item } from '../../../core/shared/item.model'; import { ItemDataService } from '../../../core/data/item-data.service'; +import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; +import { Router } from '@angular/router'; +import { cloneDeep } from 'lodash'; +import { Observable } from 'rxjs'; +import { + FieldUpdate, + FieldUpdates, + Identifiable +} from '../../../core/data/object-updates/object-updates.reducer'; import { Metadatum } from '../../../core/shared/metadatum.model'; -import { DSOChangeAnalyzer } from '../../../core/data/dso-change-analyzer.service'; +import { first, switchMap } from 'rxjs/operators'; +import { getSucceededRemoteData } from '../../../core/shared/operators'; +import { RemoteData } from '../../../core/data/remote-data'; +import { NotificationsService } from '../../../shared/notifications/notifications.service'; +import { GLOBAL_CONFIG, GlobalConfig } from '../../../../config'; +import { TranslateService } from '@ngx-translate/core'; @Component({ selector: 'ds-item-metadata', templateUrl: './item-metadata.component.html', }) /** - * Component for displaying an item's status + * Component for displaying an item's metadata edit page */ -export class ItemMetadataComponent { +export class ItemMetadataComponent implements OnInit { /** - * The item to display the metadata for + * The item to display the edit page for */ @Input() item: Item; - updateItem: Item; - constructor(private itemService: ItemDataService, private dsoChanges: DSOChangeAnalyzer) { - this.updateItem = Object.assign({}, this.item); + /** + * The current values and updates for all this item's metadata fields + */ + updates$: Observable; + /** + * The current route of this page + */ + route: string; + /** + * The time span for being able to undo discarding changes + */ + private discardTimeOut: number; + + constructor( + private itemService: ItemDataService, + private objectUpdatesService: ObjectUpdatesService, + private router: Router, + private notificationsService: NotificationsService, + private translateService: TranslateService, + @Inject(GLOBAL_CONFIG) protected EnvConfig: GlobalConfig + ) { + } - update() { - this.dsoChanges.diff(this.item, this.updateItem); + ngOnInit(): void { + this.discardTimeOut = this.EnvConfig.notifications.timeOut; + this.route = this.router.url; + if (this.route.indexOf('?') > 0) { + this.route = this.route.substr(0, this.route.indexOf('?')); + } + this.hasChanges().pipe(first()).subscribe((hasChanges) => { + if (!hasChanges) { + this.initializeOriginalFields(); + } else { + this.checkLastModified(); + } + }); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.route, this.item.metadata); } - // submit() { - // - // } - // - // discard() { - // - // } - // - // undo() { - // - // } + /** + * Sends a new add update for a field to the object updates service + * @param metadata The metadata to add, if no parameter is supplied, create a new Metadatum + */ + add(metadata: Metadatum = new Metadatum()) { + this.objectUpdatesService.saveAddFieldUpdate(this.route, metadata); + } + + /** + * Request the object updates service to discard all current changes to this item + * Shows a notification to remind the user that they can undo this + */ + discard() { + const title = this.translateService.instant('item.edit.metadata.notifications.discarded.title'); + const content = this.translateService.instant('item.edit.metadata.notifications.discarded.content'); + const undoNotification = this.notificationsService.info(title, content, { timeOut: this.discardTimeOut }); + this.objectUpdatesService.discardFieldUpdates(this.route, undoNotification); + } + + /** + * Request the object updates service to undo discarding all changes to this item + */ + reinstate() { + this.objectUpdatesService.reinstateFieldUpdates(this.route); + } + + /** + * Sends all initial values of this item to the object updates service + */ + private initializeOriginalFields() { + this.objectUpdatesService.initialize(this.route, this.item.metadata, this.item.lastModified); + } + + /* Prevent unnecessary rerendering so fields don't lose focus **/ + protected trackUpdate(index, update: FieldUpdate) { + return update && update.field ? update.field.uuid : undefined; + } + + /** + * Requests all current metadata for this item and requests the item service to update the item + * Makes sure the new version of the item is rendered on the page + */ + submit() { + const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.route, this.item.metadata) as Observable; + metadata$.pipe( + first(), + switchMap((metadata: Metadatum[]) => { + const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); + return this.itemService.update(updatedItem); + }), + getSucceededRemoteData() + ).subscribe( + (rd: RemoteData) => { + this.item = rd.payload; + this.initializeOriginalFields(); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.route, this.item.metadata); + } + ) + } + + /** + * Checks whether or not there are currently updates for this item + */ + hasChanges(): Observable { + return this.objectUpdatesService.hasUpdates(this.route); + } + + /** + * Checks whether or not the item is currently reinstatable + */ + isReinstatable(): Observable { + return this.objectUpdatesService.isReinstatable(this.route); + } + + /** + * Checks if the current item is still in sync with the version in the store + * If it's not, a notification is shown and the changes are removed + */ + private checkLastModified() { + const currentVersion = this.item.lastModified; + this.objectUpdatesService.getLastModified(this.route).pipe(first()).subscribe( + (updateVersion: Date) => { + if (updateVersion.getDate() !== currentVersion.getDate()) { + const title = this.translateService.instant('item.edit.metadata.notifications.outdated.title'); + const content = this.translateService.instant('item.edit.metadata.notifications.outdated.content'); + this.notificationsService.warning(title, content); + this.initializeOriginalFields(); + } + } + ); + } } diff --git a/src/app/+item-page/item-page-routing.module.ts b/src/app/+item-page/item-page-routing.module.ts index 8c1f317bb7..1ce4f3ad88 100644 --- a/src/app/+item-page/item-page-routing.module.ts +++ b/src/app/+item-page/item-page-routing.module.ts @@ -4,9 +4,9 @@ import { RouterModule } from '@angular/router'; import { ItemPageComponent } from './simple/item-page.component'; import { FullItemPageComponent } from './full/full-item-page.component'; import { ItemPageResolver } from './item-page.resolver'; +import { URLCombiner } from '../core/url-combiner/url-combiner'; +import { getItemModulePath } from '../app-routing.module'; import { AuthenticatedGuard } from '../core/auth/authenticated.guard'; -import {URLCombiner} from '../core/url-combiner/url-combiner'; -import {getItemModulePath} from '../app-routing.module'; export function getItemPageRoute(itemId: string) { return new URLCombiner(getItemModulePath(), itemId).toString(); diff --git a/src/app/+search-page/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts b/src/app/+search-page/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts index fd5a75e7d1..1675dd051a 100644 --- a/src/app/+search-page/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts +++ b/src/app/+search-page/search-filters/search-filter/search-facet-filter/search-facet-filter.component.ts @@ -21,6 +21,7 @@ import { SearchService } from '../../../search-service/search.service'; import { FILTER_CONFIG, SearchFilterService } from '../search-filter.service'; import { SearchConfigurationService } from '../../../search-service/search-configuration.service'; import { getSucceededRemoteData } from '../../../../core/shared/operators'; +import { InputSuggestion } from '../../../../shared/input-suggestions/input-suggestions.model'; @Component({ selector: 'ds-search-facet-filter', @@ -59,7 +60,7 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy { /** * Emits the result values for this filter found by the current filter query */ - filterSearchResults: Observable = observableOf([]); + filterSearchResults: Observable = observableOf([]); /** * Emits the active values for this filter @@ -266,7 +267,10 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy { map( (rd: RemoteData>) => { return rd.payload.page.map((facet) => { - return { displayValue: this.getDisplayValue(facet, data), value: facet.value } + return { + displayValue: this.getDisplayValue(facet, data), + value: facet.value + } }) } )) diff --git a/src/app/+search-page/search-service/facet-value.model.ts b/src/app/+search-page/search-service/facet-value.model.ts index a597528d50..0f673f3485 100644 --- a/src/app/+search-page/search-service/facet-value.model.ts +++ b/src/app/+search-page/search-service/facet-value.model.ts @@ -1,4 +1,3 @@ - import { autoserialize, autoserializeAs } from 'cerialize'; /** diff --git a/src/app/core/cache/builders/remote-data-build.service.ts b/src/app/core/cache/builders/remote-data-build.service.ts index cab3a21e5b..7cfbcdd252 100644 --- a/src/app/core/cache/builders/remote-data-build.service.ts +++ b/src/app/core/cache/builders/remote-data-build.service.ts @@ -50,13 +50,13 @@ export class RemoteDataBuildService { const payload$ = observableCombineLatest( href$.pipe( - switchMap((href: string) => this.objectCache.getBySelfLink>(href)), + switchMap((href: string) => this.objectCache.getBySelfLink(href)), startWith(undefined)), requestEntry$.pipe( getResourceLinksFromResponse(), switchMap((resourceSelfLinks: string[]) => { if (isNotEmpty(resourceSelfLinks)) { - return this.objectCache.getBySelfLink(resourceSelfLinks[0]); + return this.objectCache.getBySelfLink(resourceSelfLinks[0]); } else { return observableOf(undefined); } diff --git a/src/app/core/cache/server-sync-buffer.reducer.ts b/src/app/core/cache/server-sync-buffer.reducer.ts index 3e3715d186..c86a0d5654 100644 --- a/src/app/core/cache/server-sync-buffer.reducer.ts +++ b/src/app/core/cache/server-sync-buffer.reducer.ts @@ -26,7 +26,6 @@ export interface ServerSyncBufferState { buffer: ServerSyncBufferEntry[]; } -// Object.create(null) ensures the object has no default js properties (e.g. `__proto__`) const initialState: ServerSyncBufferState = { buffer: [] }; /** diff --git a/src/app/core/core.effects.ts b/src/app/core/core.effects.ts index c9a352c545..a23516aa45 100644 --- a/src/app/core/core.effects.ts +++ b/src/app/core/core.effects.ts @@ -4,11 +4,13 @@ import { UUIDIndexEffects } from './index/index.effects'; import { RequestEffects } from './data/request.effects'; import { AuthEffects } from './auth/auth.effects'; import { ServerSyncBufferEffects } from './cache/server-sync-buffer.effects'; +import { ObjectUpdatesEffects } from './data/object-updates/object-updates.effects'; export const coreEffects = [ RequestEffects, ObjectCacheEffects, UUIDIndexEffects, AuthEffects, - ServerSyncBufferEffects + ServerSyncBufferEffects, + ObjectUpdatesEffects ]; diff --git a/src/app/core/core.module.ts b/src/app/core/core.module.ts index aba53e2a7f..1039ded993 100644 --- a/src/app/core/core.module.ts +++ b/src/app/core/core.module.ts @@ -67,6 +67,7 @@ import { CSSVariableService } from '../shared/sass-helper/sass-helper.service'; import { MenuService } from '../shared/menu/menu.service'; import { NormalizedObjectBuildService } from './cache/builders/normalized-object-build.service'; import { DSOChangeAnalyzer } from './data/dso-change-analyzer.service'; +import { ObjectUpdatesService } from './data/object-updates/object-updates.service'; const IMPORTS = [ CommonModule, @@ -134,6 +135,7 @@ const PROVIDERS = [ DSOChangeAnalyzer, CSSVariableService, MenuService, + ObjectUpdatesService, // register AuthInterceptor as HttpInterceptor { provide: HTTP_INTERCEPTORS, diff --git a/src/app/core/core.reducers.ts b/src/app/core/core.reducers.ts index 1843e10671..760d3ddeaf 100644 --- a/src/app/core/core.reducers.ts +++ b/src/app/core/core.reducers.ts @@ -1,14 +1,26 @@ -import { ActionReducerMap, createFeatureSelector } from '@ngrx/store'; +import { + ActionReducerMap, + createFeatureSelector, + createSelector, + MemoizedSelector +} from '@ngrx/store'; import { objectCacheReducer, ObjectCacheState } from './cache/object-cache.reducer'; import { indexReducer, IndexState } from './index/index.reducer'; import { requestReducer, RequestState } from './data/request.reducer'; import { authReducer, AuthState } from './auth/auth.reducer'; import { serverSyncBufferReducer, ServerSyncBufferState } from './cache/server-sync-buffer.reducer'; +import { + objectUpdatesReducer, + ObjectUpdatesState +} from './data/object-updates/object-updates.reducer'; +import { hasValue } from '../shared/empty.util'; +import { AppState } from '../app.reducer'; export interface CoreState { 'cache/object': ObjectCacheState, 'cache/syncbuffer': ServerSyncBufferState, + 'cache/object-updates': ObjectUpdatesState 'data/request': RequestState, 'index': IndexState, 'auth': AuthState, @@ -17,9 +29,10 @@ export interface CoreState { export const coreReducers: ActionReducerMap = { 'cache/object': objectCacheReducer, 'cache/syncbuffer': serverSyncBufferReducer, + 'cache/object-updates': objectUpdatesReducer, 'data/request': requestReducer, 'index': indexReducer, - 'auth': authReducer + 'auth': authReducer, }; -export const coreSelector = createFeatureSelector('core'); +export const coreSelector = createFeatureSelector('core'); \ No newline at end of file diff --git a/src/app/core/data/object-updates/object-updates.actions.ts b/src/app/core/data/object-updates/object-updates.actions.ts index 54f7fba190..96b85b9179 100644 --- a/src/app/core/data/object-updates/object-updates.actions.ts +++ b/src/app/core/data/object-updates/object-updates.actions.ts @@ -1,73 +1,86 @@ import { type } from '../../../shared/ngrx/type'; import { Action } from '@ngrx/store'; -import { Operation } from 'fast-json-patch'; +import { Identifiable } from './object-updates.reducer'; +import { INotification } from '../../../shared/notifications/models/notification.model'; export const ObjectUpdatesActionTypes = { - ADD: type('dspace/core/object-updates/ADD'), - APPLY: type('dspace/core/object-updates/APPLY'), - DISCARD: type('dspace/core/object-updates/DISCARD'), - REINSTATE: type('dspace/core/object-updates/REINSTATE'), - REMOVE: type('dspace/core/object-updates/REMOVE'), - REMOVE_SINGLE: type('dspace/core/object-updates/REMOVE_SINGLE'), - REPLACE: type('dspace/core/object-updates/REPLACE') + INITIALIZE_FIELDS: type('dspace/core/cache/object-updates/INITIALIZE_FIELDS'), + SET_EDITABLE_FIELD: type('dspace/core/cache/object-updates/SET_EDITABLE_FIELD'), + ADD_FIELD: type('dspace/core/cache/object-updates/ADD_FIELD'), + DISCARD: type('dspace/core/cache/object-updates/DISCARD'), + REINSTATE: type('dspace/core/cache/object-updates/REINSTATE'), + REMOVE: type('dspace/core/cache/object-updates/REMOVE'), + REMOVE_FIELD: type('dspace/core/cache/object-updates/REMOVE_FIELD'), }; /* tslint:disable:max-classes-per-file */ +export enum FieldChangeType { + UPDATE = 0, + ADD = 1, + REMOVE = 2 +} -export class ReplaceObjectUpdatesAction implements Action { - type = ObjectUpdatesActionTypes.REPLACE; +export class InitializeFieldsAction implements Action { + type = ObjectUpdatesActionTypes.INITIALIZE_FIELDS; payload: { url: string, - operations: Operation[], - lastModified: number + fields: Identifiable[], + lastModified: Date }; constructor( url: string, - operations: Operation[], - lastModified: number + fields: Identifiable[], + lastModified: Date ) { - this.payload = { url, operations, lastModified }; + this.payload = { url, fields, lastModified }; } } -export class AddToObjectUpdatesAction implements Action { - type = ObjectUpdatesActionTypes.ADD; +export class AddFieldUpdateAction implements Action { + type = ObjectUpdatesActionTypes.ADD_FIELD; payload: { url: string, - operation: Operation + field: Identifiable, + changeType: FieldChangeType, }; constructor( url: string, - operation: Operation) { - this.payload = { url, operation }; + field: Identifiable, + changeType: FieldChangeType) { + this.payload = { url, field, changeType }; } } -export class ApplyObjectUpdatesAction implements Action { - type = ObjectUpdatesActionTypes.APPLY; +export class SetEditableFieldUpdateAction implements Action { + type = ObjectUpdatesActionTypes.SET_EDITABLE_FIELD; payload: { - url: string + url: string, + uuid: string, + editable: boolean, }; constructor( - url: string - ) { - this.payload.url = url; + url: string, + fieldUUID: string, + editable: boolean) { + this.payload = { url, uuid: fieldUUID, editable }; } } export class DiscardObjectUpdatesAction implements Action { type = ObjectUpdatesActionTypes.DISCARD; payload: { - url: string + url: string, + notification }; constructor( - url: string + url: string, + notification: INotification ) { - this.payload.url = url; + this.payload = { url, notification }; } } @@ -80,7 +93,7 @@ export class ReinstateObjectUpdatesAction implements Action { constructor( url: string ) { - this.payload.url = url; + this.payload = { url }; } } @@ -93,35 +106,34 @@ export class RemoveObjectUpdatesAction implements Action { constructor( url: string ) { - this.payload.url = url; + this.payload = { url }; } } -export class RemoveSingleObjectUpdateAction implements Action { - type = ObjectUpdatesActionTypes.REMOVE_SINGLE; +export class RemoveFieldUpdateAction implements Action { + type = ObjectUpdatesActionTypes.REMOVE_FIELD; payload: { url: string, - fieldID: string + uuid: string }; constructor( url: string, - fieldID: string + uuid: string ) { - this.payload = { url, fieldID }; + this.payload = { url, uuid }; } } /* tslint:enable:max-classes-per-file */ /** - * A type to encompass all RequestActions + * A type to encompass all ObjectUpdatesActions */ export type ObjectUpdatesAction - = AddToObjectUpdatesAction - | ApplyObjectUpdatesAction + = AddFieldUpdateAction + | InitializeFieldsAction | DiscardObjectUpdatesAction | ReinstateObjectUpdatesAction | RemoveObjectUpdatesAction - | RemoveSingleObjectUpdateAction - | ReplaceObjectUpdatesAction; + | RemoveFieldUpdateAction; diff --git a/src/app/core/data/object-updates/object-updates.effects.spec.ts b/src/app/core/data/object-updates/object-updates.effects.spec.ts new file mode 100644 index 0000000000..a81a0665bf --- /dev/null +++ b/src/app/core/data/object-updates/object-updates.effects.spec.ts @@ -0,0 +1,55 @@ +import { TestBed } from '@angular/core/testing'; +import { Observable } from 'rxjs'; +import { provideMockActions } from '@ngrx/effects/testing'; +import { cold, hot } from 'jasmine-marbles'; +import { NotificationsService } from '../../../shared/notifications/notifications.service'; +import { ObjectUpdatesEffects } from './object-updates.effects'; +import { RemoveObjectUpdatesAction } from './object-updates.actions'; + +fdescribe('ObjectUpdatesEffects', () => { + let updatesEffects: ObjectUpdatesEffects; + let actions: Observable; + const testURL = 'www.dspace.org/dspace7'; + beforeEach(() => { + TestBed.configureTestingModule({ + providers: [ + ObjectUpdatesEffects, + provideMockActions(() => actions), + { + provide: NotificationsService, useClass: { + remove: (notification) => { /* empty */ + } + } + }, + // other providers + ], + }); + + updatesEffects = TestBed.get(ObjectUpdatesEffects); + }); + + describe('mapLastActions$', () => { + describe('When any ObjectUpdatesAction is triggered', () => { + const action = new RemoveObjectUpdatesAction(testURL); + it('should emit the action from the actionMap\'s value which key matches the action\'s URL', () => { + actions = hot('--a-', { a: action }); + + const expected = cold('--b-', { b: action }); + + expect((updatesEffects as any).actionMap[testURL]).toBeObservable(expected); + }); + }); + }); + + // describe('removeAfterDiscardOrReinstateOnUndo$', () => { + // + // it('should return a COLLAPSE action in response to an UPDATE_LOCATION action', () => { + // actions = hot('--a-', { a: { type: fromRouter.ROUTER_NAVIGATION } }); + // + // const expected = cold('--b-', { b: new CollapseMenuAction(MenuID.PUBLIC) }); + // + // expect(updatesEffects.routeChange$).toBeObservable(expected); + // }); + // + // }); +}); diff --git a/src/app/core/data/object-updates/object-updates.effects.ts b/src/app/core/data/object-updates/object-updates.effects.ts new file mode 100644 index 0000000000..f89700f6fe --- /dev/null +++ b/src/app/core/data/object-updates/object-updates.effects.ts @@ -0,0 +1,63 @@ +import { Injectable } from '@angular/core'; +import { Actions, Effect, ofType } from '@ngrx/effects'; +import { + DiscardObjectUpdatesAction, + ObjectUpdatesAction, + ObjectUpdatesActionTypes +} from './object-updates.actions'; +import { map } from 'rxjs/operators'; +import { Subject } from 'rxjs'; +import { hasNoValue } from '../../../shared/empty.util'; +import { NotificationsService } from '../../../shared/notifications/notifications.service'; + +@Injectable() +export class ObjectUpdatesEffects { + private actionMap: { + /* Use Subject instead of BehaviorSubject: + we only want Actions that are fired while we're listening + actions that were previously fired do not matter anymore + */ + [url: string]: Subject + } = {}; + + @Effect({ dispatch: false }) mapLastActions$ = this.actions$ + .pipe( + ofType(...Object.values(ObjectUpdatesActionTypes)), + map((action: DiscardObjectUpdatesAction) => { + const url: string = action.payload.url; + if (hasNoValue(this.actionMap[url])) { + this.actionMap[url] = new Subject(); + } + this.actionMap[url].next(action); + } + ) + ); + + // @Effect() removeAfterDiscardOrReinstateOnUndo$ = this.actions$ + // .pipe( + // ofType(ObjectUpdatesActionTypes.DISCARD), + // switchMap((action: DiscardObjectUpdatesAction) => { + // const url: string = action.payload.url; + // const notification: INotification = action.payload.notification; + // const timeOut = notification.options.timeOut; + // return observableRace( + // // Either wait for the delay and perform a remove action + // observableOf(new RemoveObjectUpdatesAction(action.payload.url)).pipe(delay(timeOut)), + // // Or wait for a reinstate action and perform no action + // this.actionMap[url].pipe( + // // filter((updateAction: ObjectUpdatesAction) => updateAction.type === ObjectUpdatesActionTypes.REINSTATE), + // tap(() => this.notificationsService.remove(notification)), + // map(() => { + // return { type: 'NO_ACTION' } + // } + // ) + // ) + // ) + // } + // ) + // ); + + constructor(private actions$: Actions, private notificationsService: NotificationsService) { + } + +} diff --git a/src/app/core/data/object-updates/object-updates.reducer.ts b/src/app/core/data/object-updates/object-updates.reducer.ts index 486a7b143d..4345373bfa 100644 --- a/src/app/core/data/object-updates/object-updates.reducer.ts +++ b/src/app/core/data/object-updates/object-updates.reducer.ts @@ -1,45 +1,66 @@ import { - AddToObjectUpdatesAction, - ApplyObjectUpdatesAction, + AddFieldUpdateAction, DiscardObjectUpdatesAction, + FieldChangeType, + InitializeFieldsAction, ObjectUpdatesAction, ObjectUpdatesActionTypes, ReinstateObjectUpdatesAction, - RemoveObjectUpdatesAction, - RemoveSingleObjectUpdateAction, ReplaceObjectUpdatesAction + RemoveFieldUpdateAction, + RemoveObjectUpdatesAction, SetEditableFieldUpdateAction } from './object-updates.actions'; -import { Operation } from 'fast-json-patch'; -import { hasValue } from '../../../shared/empty.util'; +import { hasNoValue, hasValue } from '../../../shared/empty.util'; + +export const OBJECT_UPDATES_TRASH_PATH = '/trash'; + +export interface FieldState { + editable: boolean, + isNew: boolean +} + +export interface FieldStates { + [uuid: string]: FieldState; +} + +export interface Identifiable { + uuid: string +} + +export interface FieldUpdate { + field: Identifiable, + changeType: FieldChangeType +} + +export interface FieldUpdates { + [uuid: string]: FieldUpdate; +} export interface ObjectUpdatesEntry { - updates: Operation[]; - lastServerUpdate: number; - lastModified: number; - discarded: boolean; + fieldStates: FieldStates; + fieldUpdates: FieldUpdates + lastModified: Date; + // lastUpdate: Date; } export interface ObjectUpdatesState { [url: string]: ObjectUpdatesEntry; } +const initialFieldState = { editable: false, isNew: false }; +const initialNewFieldState = { editable: true, isNew: true }; + // Object.create(null) ensures the object has no default js properties (e.g. `__proto__`) const initialState = Object.create(null); export function objectUpdatesReducer(state = initialState, action: ObjectUpdatesAction): ObjectUpdatesState { let newState = state; switch (action.type) { - case ObjectUpdatesActionTypes.REPLACE: { - newState = replaceObjectUpdates(state, action as ReplaceObjectUpdatesAction); + case ObjectUpdatesActionTypes.INITIALIZE_FIELDS: { + newState = initializeFieldsUpdate(state, action as InitializeFieldsAction); break; } - case ObjectUpdatesActionTypes.ADD: { - newState = addToObjectUpdates(state, action as AddToObjectUpdatesAction); - break; - } - case ObjectUpdatesActionTypes.APPLY: { - /* For now do nothing, handle in effect */ - // return applyObjectUpdates(state, action as ApplyObjectUpdatesAction); - newState = state; + case ObjectUpdatesActionTypes.ADD_FIELD: { + newState = addFieldUpdate(state, action as AddFieldUpdateAction); break; } case ObjectUpdatesActionTypes.DISCARD: { @@ -54,86 +75,162 @@ export function objectUpdatesReducer(state = initialState, action: ObjectUpdates newState = removeObjectUpdates(state, action as RemoveObjectUpdatesAction); break; } - case ObjectUpdatesActionTypes.REMOVE_SINGLE: { - newState = removeSingleObjectUpdates(state, action as RemoveSingleObjectUpdateAction); + case ObjectUpdatesActionTypes.REMOVE_FIELD: { + newState = removeFieldUpdate(state, action as RemoveFieldUpdateAction); break; } + case ObjectUpdatesActionTypes.SET_EDITABLE_FIELD: { + // return directly, no need to change the lastModified date + return setEditableFieldUpdate(state, action as SetEditableFieldUpdateAction); + } default: { return state; } } - return setLastModified(newState, action.payload.url); -} - -function replaceObjectUpdates(state: any, action: ReplaceObjectUpdatesAction) { - const key: string = action.payload.url; - const operations: Operation[] = action.payload.operations; - const newUpdateEntry = Object.assign({}, state[key] || {}, { updates: operations }); - return Object.assign({}, state, { [key]: newUpdateEntry }); -} - -function addToObjectUpdates(state: any, action: AddToObjectUpdatesAction) { - const key: string = action.payload.url; - const operation: Operation = action.payload.operation; - const keyState = state[key] || { - updates: {}, - lastServerUpdate: 0, - discarded: false - }; - const objectUpdates: Operation[] = keyState.updates || []; - const newUpdates = [...objectUpdates, operation]; - const newKeyState = Object.assign({}, state[key], { updates: newUpdates }); - return Object.assign({}, state, newKeyState); -} - -function discardObjectUpdates(state: any, action: DiscardObjectUpdatesAction) { - const key: string = action.payload.url; - const keyState = state[key]; - if (hasValue(keyState)) { - const newKeyState = Object.assign({}, keyState, { discarded: true }); - return Object.assign({}, state, newKeyState); - } - return state; -} - -function reinstateObjectUpdates(state: any, action: ReinstateObjectUpdatesAction) { - const key: string = action.payload.url; - const keyState = state[key]; - if (hasValue(keyState)) { - const newKeyState = Object.assign({}, keyState, { discarded: false }); - return Object.assign({}, state, newKeyState); - } - return state; -} - -function removeObjectUpdates(state: any, action: RemoveObjectUpdatesAction) { - const key: string = action.payload.url; - return removeObjectUpdatesByURL(state, key); -} - -function removeObjectUpdatesByURL(state: any, url: string) { - const keyState = state[url]; - const newState = Object.assign({}, state); - if (hasValue(keyState)) { - delete newState[url]; - } + // return setUpdated(newState, action.payload.url); return newState; } -function removeSingleObjectUpdates(state: any, action: RemoveSingleObjectUpdateAction) { - const key: string = action.payload.url; - let newKeyState = state[key]; - if (hasValue(newKeyState)) { - const newUpdates: Operation[] = Object.assign({}, newKeyState.updates); - if (hasValue(newUpdates[action.payload.fieldID])) { - delete newUpdates[action.payload.fieldID]; - } - newKeyState = Object.assign({}, state[key], { updates: newUpdates }); - } - return Object.assign({}, state, newKeyState); +function initializeFieldsUpdate(state: any, action: InitializeFieldsAction) { + const url: string = action.payload.url; + const fields: Identifiable[] = action.payload.fields; + const lastModifiedServer: Date = action.payload.lastModified; + const fieldStates = createInitialFieldStates(fields); + const newPageState = Object.assign( + {}, + state[url], + { fieldStates: fieldStates }, + { fieldUpdates: {} }, + { lastServerUpdate: lastModifiedServer } + ); + return Object.assign({}, state, { [url]: newPageState }); } -function setLastModified(state: any, url: string) { - const newKeyState = Object.assign({}, state[url] || {}, { lastModified: Date.now() }); - return Object.assign({}, state, newKeyState); +function addFieldUpdate(state: any, action: AddFieldUpdateAction) { + const url: string = action.payload.url; + const field: Identifiable = action.payload.field; + const changeType: FieldChangeType = action.payload.changeType; + const pageState: ObjectUpdatesEntry = state[url] || {}; + + let states = pageState.fieldStates; + if (changeType === FieldChangeType.ADD) { + states = Object.assign({}, { [field.uuid]: initialNewFieldState }, pageState.fieldStates) + } + + let fieldUpdate: any = pageState.fieldUpdates[field.uuid] || {}; + const newChangeType = determineChangeType(fieldUpdate.changeType, changeType); + + fieldUpdate = Object.assign({}, { field, changeType: newChangeType }); + + const fieldUpdates = Object.assign({}, pageState.fieldUpdates, { [field.uuid]: fieldUpdate }); + + const newPageState = Object.assign({}, pageState, + { fieldStates: states }, + { fieldUpdates: fieldUpdates }); + return Object.assign({}, state, { [url]: newPageState }); +} + +function discardObjectUpdates(state: any, action: DiscardObjectUpdatesAction) { + const url: string = action.payload.url; + const pageState: ObjectUpdatesEntry = state[url]; + const newFieldStates = {}; + Object.keys(pageState.fieldStates).forEach((uuid: string) => { + const fieldState: FieldState = pageState.fieldStates[uuid]; + if (!fieldState.isNew) { + /* After discarding we don't want the reset fields to stay editable */ + newFieldStates[uuid] = Object.assign({}, fieldState, { editable: false }); + } + }); + + const discardedPageState = Object.assign({}, pageState, { + fieldUpdates: {}, + fieldStates: newFieldStates + }); + return Object.assign({}, state, { [url]: discardedPageState }, { [url + OBJECT_UPDATES_TRASH_PATH]: pageState }); +} + +function reinstateObjectUpdates(state: any, action: ReinstateObjectUpdatesAction) { + const url: string = action.payload.url; + const trashState = state[url + OBJECT_UPDATES_TRASH_PATH]; + + const newState = Object.assign({}, state, { [url]: trashState }); + delete newState[url + OBJECT_UPDATES_TRASH_PATH]; + return newState; +} + +function removeObjectUpdates(state: any, action: RemoveObjectUpdatesAction) { + const url: string = action.payload.url; + return removeObjectUpdatesByURL(state, url); +} + +function removeObjectUpdatesByURL(state: any, url: string) { + const newState = Object.assign({}, state); + delete newState[url + OBJECT_UPDATES_TRASH_PATH]; + return newState; +} + +function removeFieldUpdate(state: any, action: RemoveFieldUpdateAction) { + const url: string = action.payload.url; + const uuid: string = action.payload.uuid; + let newPageState: ObjectUpdatesEntry = state[url]; + if (hasValue(newPageState)) { + const newUpdates: FieldUpdates = Object.assign({}, newPageState.fieldUpdates); + if (hasValue(newUpdates[uuid])) { + delete newUpdates[uuid]; + } + const newFieldStates: FieldStates = Object.assign({}, newPageState.fieldStates); + if (hasValue(newFieldStates[uuid])) { + /* When resetting, make field not editable */ + if (newFieldStates[uuid].isNew) { + /* If this field was added, just throw it away */ + delete newFieldStates[uuid]; + } else { + newFieldStates[uuid] = Object.assign({}, newFieldStates[uuid], { editable: false }); + } + } + newPageState = Object.assign({}, state[url], { + fieldUpdates: newUpdates, + fieldStates: newFieldStates + }); + } + return Object.assign({}, state, { [url]: newPageState }); +} + +function setUpdated(state: any, url: string) { + const newPageState = Object.assign({}, state[url] || {}, { lastUpdated: Date.now() }); + return Object.assign({}, state, { [url]: newPageState }); +} + +function determineChangeType(oldType: FieldChangeType, newType: FieldChangeType): FieldChangeType { + if (hasNoValue(newType)) { + return oldType; + } + if (hasNoValue(oldType)) { + return newType; + } + return oldType.valueOf() > newType.valueOf() ? oldType : newType; +} + +function setEditableFieldUpdate(state: any, action: SetEditableFieldUpdateAction) { + const url: string = action.payload.url; + const uuid: string = action.payload.uuid; + const editable: boolean = action.payload.editable; + + const pageState: ObjectUpdatesEntry = state[url]; + + const fieldState = pageState.fieldStates[uuid]; + const newFieldState = Object.assign({}, fieldState, { editable }); + + const newFieldStates = Object.assign({}, pageState.fieldStates, { [uuid]: newFieldState }); + + const newPageState = Object.assign({}, pageState, { fieldStates: newFieldStates }); + + return Object.assign({}, state, { [url]: newPageState }); +} + +function createInitialFieldStates(fields: Identifiable[]) { + const uuids = fields.map((field: Identifiable) => field.uuid); + const fieldStates = {}; + uuids.forEach((uuid: string) => fieldStates[uuid] = initialFieldState); + return fieldStates; } diff --git a/src/app/core/data/object-updates/object-updates.service.ts b/src/app/core/data/object-updates/object-updates.service.ts new file mode 100644 index 0000000000..2f3e31eb7c --- /dev/null +++ b/src/app/core/data/object-updates/object-updates.service.ts @@ -0,0 +1,134 @@ +import { Injectable } from '@angular/core'; +import { createSelector, MemoizedSelector, select, Store } from '@ngrx/store'; +import { coreSelector, CoreState } from '../../core.reducers'; +import { + FieldUpdates, + Identifiable, OBJECT_UPDATES_TRASH_PATH, + ObjectUpdatesEntry, + ObjectUpdatesState +} from './object-updates.reducer'; +import { Observable } from 'rxjs'; +import { + AddFieldUpdateAction, + DiscardObjectUpdatesAction, + FieldChangeType, + InitializeFieldsAction, + ReinstateObjectUpdatesAction, + RemoveFieldUpdateAction, + SetEditableFieldUpdateAction +} from './object-updates.actions'; +import { filter, map } from 'rxjs/operators'; +import { hasNoValue, hasValue, isEmpty, isNotEmpty } from '../../../shared/empty.util'; +import { INotification } from '../../../shared/notifications/models/notification.model'; + +function objectUpdatesStateSelector(): MemoizedSelector { + return createSelector(coreSelector, (state: CoreState) => state['cache/object-updates']); +} + +function filterByUrlObjectUpdatesStateSelector(url: string): MemoizedSelector { + return createSelector(objectUpdatesStateSelector(), (state: ObjectUpdatesState) => state[url]); +} + +@Injectable() +export class ObjectUpdatesService { + constructor(private store: Store) { + + } + + initialize(url, fields: Identifiable[], lastModified: Date): void { + this.store.dispatch(new InitializeFieldsAction(url, fields, lastModified)); + } + + private saveFieldUpdate(url: string, field: Identifiable, changeType: FieldChangeType) { + this.store.dispatch(new AddFieldUpdateAction(url, field, changeType)) + } + + private getObjectEntry(url: string): Observable { + return this.store.pipe(select(filterByUrlObjectUpdatesStateSelector(url))); + } + + getFieldUpdates(url: string, initialFields: Identifiable[]): Observable { + const objectUpdates = this.getObjectEntry(url); + return objectUpdates.pipe(map((objectEntry) => { + const fieldUpdates: FieldUpdates = {}; + Object.keys(objectEntry.fieldStates).forEach((uuid) => { + let fieldUpdate = objectEntry.fieldUpdates[uuid]; + if (isEmpty(fieldUpdate)) { + const identifiable = initialFields.find((object: Identifiable) => object.uuid === uuid); + fieldUpdate = { field: identifiable, changeType: undefined }; + } + fieldUpdates[uuid] = fieldUpdate; + }); + return fieldUpdates; + })) + } + + isEditable(url: string, uuid: string): Observable { + const objectUpdates = this.getObjectEntry(url); + return objectUpdates.pipe( + filter((objectEntry) => hasValue(objectEntry.fieldStates[uuid])), + map((objectEntry) => objectEntry.fieldStates[uuid].editable + ) + ) + } + + saveAddFieldUpdate(url: string, field: Identifiable) { + this.saveFieldUpdate(url, field, FieldChangeType.ADD); + } + + saveRemoveFieldUpdate(url: string, field: Identifiable) { + this.saveFieldUpdate(url, field, FieldChangeType.REMOVE); + } + + saveChangeFieldUpdate(url: string, field: Identifiable) { + this.saveFieldUpdate(url, field, FieldChangeType.UPDATE); + } + + setEditableFieldUpdate(url: string, uuid: string, editable: boolean) { + this.store.dispatch(new SetEditableFieldUpdateAction(url, uuid, editable)); + } + + discardFieldUpdates(url: string, undoNotification: INotification) { + this.store.dispatch(new DiscardObjectUpdatesAction(url, undoNotification)); + } + + reinstateFieldUpdates(url: string) { + this.store.dispatch(new ReinstateObjectUpdatesAction(url)); + } + + removeSingleFieldUpdate(url: string, uuid) { + this.store.dispatch(new RemoveFieldUpdateAction(url, uuid)); + } + + getUpdatedFields(url: string, initialFields: Identifiable[]): Observable { + const objectUpdates = this.getObjectEntry(url); + return objectUpdates.pipe(map((objectEntry) => { + const fields: Identifiable[] = []; + Object.keys(objectEntry.fieldStates).forEach((uuid) => { + const fieldUpdate = objectEntry.fieldUpdates[uuid]; + if (hasNoValue(fieldUpdate) || fieldUpdate.changeType !== FieldChangeType.REMOVE) { + let field; + if (isNotEmpty(fieldUpdate)) { + field = fieldUpdate.field; + } else { + field = initialFields.find((object: Identifiable) => object.uuid === uuid); + } + fields.push(field); + } + }); + return fields; + })) + } + + hasUpdates(url: string): Observable { + return this.getObjectEntry(url).pipe(map((objectEntry) => hasValue(objectEntry) && isNotEmpty(objectEntry.fieldUpdates))); + } + + isReinstatable(route: string): Observable { + return this.hasUpdates(route + OBJECT_UPDATES_TRASH_PATH) + } + + getLastModified(url: string): Observable { + return this.getObjectEntry(url).pipe(map((entry: ObjectUpdatesEntry) => entry.lastModified)); + } +} diff --git a/src/app/core/metadata/metadatafield.model.ts b/src/app/core/metadata/metadatafield.model.ts index f9b5155649..36f97d8d6f 100644 --- a/src/app/core/metadata/metadatafield.model.ts +++ b/src/app/core/metadata/metadatafield.model.ts @@ -1,6 +1,7 @@ import { MetadataSchema } from './metadataschema.model'; import { autoserialize } from 'cerialize'; import { ListableObject } from '../../shared/object-collection/shared/listable-object.model'; +import { isNotEmpty } from '../../shared/empty.util'; export class MetadataField implements ListableObject { @autoserialize @@ -20,4 +21,12 @@ export class MetadataField implements ListableObject { @autoserialize schema: MetadataSchema; + + toString(): string { + let key = this.schema.prefix + '.' + this.element; + if (isNotEmpty(this.qualifier)) { + key += '.' + this.qualifier; + } + return key; + } } diff --git a/src/app/core/registry/registry.service.ts b/src/app/core/registry/registry.service.ts index 4bd0dabb70..539cb6a596 100644 --- a/src/app/core/registry/registry.service.ts +++ b/src/app/core/registry/registry.service.ts @@ -33,13 +33,19 @@ import { URLCombiner } from '../url-combiner/url-combiner'; import { PaginationComponentOptions } from '../../shared/pagination/pagination-component-options.model'; import { RegistryBitstreamformatsResponseParsingService } from '../data/registry-bitstreamformats-response-parsing.service'; import { RegistryBitstreamformatsResponse } from './registry-bitstreamformats-response.model'; -import { configureRequest, getResponseFromEntry, getSucceededRemoteData } from '../shared/operators'; +import { + configureRequest, + getResponseFromEntry, + getSucceededRemoteData +} from '../shared/operators'; import { createSelector, select, Store } from '@ngrx/store'; import { AppState } from '../../app.reducer'; import { MetadataRegistryState } from '../../+admin/admin-registries/metadata-registry/metadata-registry.reducers'; import { MetadataRegistryCancelFieldAction, - MetadataRegistryCancelSchemaAction, MetadataRegistryDeselectAllFieldAction, MetadataRegistryDeselectAllSchemaAction, + MetadataRegistryCancelSchemaAction, + MetadataRegistryDeselectAllFieldAction, + MetadataRegistryDeselectAllSchemaAction, MetadataRegistryDeselectFieldAction, MetadataRegistryDeselectSchemaAction, MetadataRegistryEditFieldAction, @@ -168,7 +174,7 @@ export class RegistryService { public getAllMetadataFields(pagination?: PaginationComponentOptions): Observable>> { if (hasNoValue(pagination)) { - pagination = { currentPage: 1, pageSize: Number.MAX_VALUE } as any; + pagination = { currentPage: 1, pageSize: 10000 } as any; } const requestObs = this.getMetadataFieldsRequestObs(pagination); @@ -533,4 +539,19 @@ export class RegistryService { } }); } + + queryMetadataFields(query: string): Observable>> { + /** + * This should come directly from the server in the future + */ + return this.getAllMetadataFields().pipe( + map((rd: RemoteData>) => { + const filteredFields: MetadataField[] = rd.payload.page.filter( + (field: MetadataField) => field.toString().indexOf(query) >= 0 + ); + const page: PaginatedList = new PaginatedList(new PageInfo(), filteredFields) + return Object.assign({}, rd, { payload: page }); + }) + ); + } } diff --git a/src/app/core/shared/metadatum.model.ts b/src/app/core/shared/metadatum.model.ts index ca1f3d8591..02f6e00765 100644 --- a/src/app/core/shared/metadatum.model.ts +++ b/src/app/core/shared/metadatum.model.ts @@ -1,7 +1,9 @@ import { autoserialize } from 'cerialize'; +import * as uuidv4 from 'uuid/v4'; export class Metadatum { + uuid: string = uuidv4(); /** * The metadata field of this Metadatum */ diff --git a/src/app/shared/input-suggestions/input-suggestions.component.html b/src/app/shared/input-suggestions/input-suggestions.component.html index bbe090dac0..2ee80e576a 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.html +++ b/src/app/shared/input-suggestions/input-suggestions.component.html @@ -1,21 +1,21 @@ -
-
-
    -
  • +
    +
    -
    • -
+
+
\ No newline at end of file diff --git a/src/app/shared/input-suggestions/input-suggestions.component.scss b/src/app/shared/input-suggestions/input-suggestions.component.scss index bea74cf7af..f2587e1b6f 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.scss +++ b/src/app/shared/input-suggestions/input-suggestions.component.scss @@ -1,8 +1,11 @@ +@import "../../../styles/_variables.scss"; + .autocomplete { width: 100%; .dropdown-item { white-space: normal; word-break: break-word; + padding: $input-padding-y $input-padding-x; &:focus { outline: none; } diff --git a/src/app/shared/input-suggestions/input-suggestions.component.ts b/src/app/shared/input-suggestions/input-suggestions.component.ts index 8a8069d71e..b9f068b30f 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.ts @@ -1,6 +1,6 @@ import { Component, - ElementRef, EventEmitter, + ElementRef, EventEmitter, forwardRef, Input, Output, QueryList, SimpleChanges, @@ -9,21 +9,30 @@ import { } from '@angular/core'; import { BehaviorSubject } from 'rxjs'; import { hasValue, isNotEmpty } from '../empty.util'; +import { InputSuggestion } from './input-suggestions.model'; +import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms'; @Component({ selector: 'ds-input-suggestions', styleUrls: ['./input-suggestions.component.scss'], - templateUrl: './input-suggestions.component.html' + templateUrl: './input-suggestions.component.html', + providers: [ + { + provide: NG_VALUE_ACCESSOR, + useExisting: forwardRef(() => InputSuggestionsComponent), + multi: true + } + ] }) /** * Component representing a form with a autocomplete functionality */ -export class InputSuggestionsComponent { +export class InputSuggestionsComponent implements ControlValueAccessor { /** * The suggestions that should be shown */ - @Input() suggestions: any[] = []; + @Input() suggestions: InputSuggestion[] = []; /** * The time waited to detect if any other input will follow before requesting the suggestions @@ -45,16 +54,6 @@ export class InputSuggestionsComponent { */ @Input() name; - /** - * Value of the input field - */ - @Input() ngModel; - - /** - * Output for when the input field's value changes - */ - @Output() ngModelChange = new EventEmitter(); - /** * Output for when the form is submitted */ @@ -94,6 +93,15 @@ export class InputSuggestionsComponent { */ @ViewChildren('suggestion') resultViews: QueryList; + /** + * Value of the input field + */ + _value: string; + + propagateChange = (_: any) => { + /* Empty implementation */ + }; + /** * When any of the inputs change, check if we should still show the suggestions */ @@ -170,6 +178,7 @@ export class InputSuggestionsComponent { * Make sure that if a suggestion is clicked, the suggestions dropdown closes, does not reopen and the focus moves to the input field */ onClickSuggestion(data) { + this.value = data; this.clickSuggestion.emit(data); this.close(); this.blockReopen = true; @@ -188,4 +197,31 @@ export class InputSuggestionsComponent { this.blockReopen = false; } + onSubmit(data) { + this.value = data; + this.submitSuggestion.emit(data); + } + + registerOnChange(fn: any): void { + this.propagateChange = fn; + } + + registerOnTouched(fn: any): void { + } + + setDisabledState(isDisabled: boolean): void { + } + + writeValue(value: any): void { + this.value = value; + } + + get value() { + return this._value; + } + + set value(val) { + this._value = val; + this.propagateChange(this._value); + } } diff --git a/src/app/shared/input-suggestions/input-suggestions.model.ts b/src/app/shared/input-suggestions/input-suggestions.model.ts new file mode 100644 index 0000000000..34ab769587 --- /dev/null +++ b/src/app/shared/input-suggestions/input-suggestions.model.ts @@ -0,0 +1,4 @@ +export interface InputSuggestion { + displayValue: string, + value: string +} diff --git a/src/app/shared/notifications/notifications.service.ts b/src/app/shared/notifications/notifications.service.ts index 55df6a4f7f..bb57aebd78 100644 --- a/src/app/shared/notifications/notifications.service.ts +++ b/src/app/shared/notifications/notifications.service.ts @@ -27,27 +27,30 @@ export class NotificationsService { success(title: any = observableOf(''), content: any = observableOf(''), - options: NotificationOptions = this.getDefaultOptions(), + options: Partial = {}, html: boolean = false): INotification { - const notification = new Notification(uniqueId(), NotificationType.Success, title, content, options, html); + const notificationOptions = { ...this.getDefaultOptions(), ...options }; + const notification = new Notification(uniqueId(), NotificationType.Success, title, content, notificationOptions, html); this.add(notification); return notification; } error(title: any = observableOf(''), content: any = observableOf(''), - options: NotificationOptions = this.getDefaultOptions(), + options: Partial = {}, html: boolean = false): INotification { - const notification = new Notification(uniqueId(), NotificationType.Error, title, content, options, html); + const notificationOptions = { ...this.getDefaultOptions(), ...options }; + const notification = new Notification(uniqueId(), NotificationType.Error, title, content, notificationOptions, html); this.add(notification); return notification; } info(title: any = observableOf(''), content: any = observableOf(''), - options: NotificationOptions = this.getDefaultOptions(), + options: Partial = {}, html: boolean = false): INotification { - const notification = new Notification(uniqueId(), NotificationType.Info, title, content, options, html); + const notificationOptions = { ...this.getDefaultOptions(), ...options }; + const notification = new Notification(uniqueId(), NotificationType.Info, title, content, notificationOptions, html); this.add(notification); return notification; } @@ -56,7 +59,8 @@ export class NotificationsService { content: any = observableOf(''), options: NotificationOptions = this.getDefaultOptions(), html: boolean = false): INotification { - const notification = new Notification(uniqueId(), NotificationType.Warning, title, content, options, html); + const notificationOptions = { ...this.getDefaultOptions(), ...options }; + const notification = new Notification(uniqueId(), NotificationType.Warning, title, content, notificationOptions, html); this.add(notification); return notification; } diff --git a/src/app/shared/shared.module.ts b/src/app/shared/shared.module.ts index 53cf15ab6e..c3e7051304 100644 --- a/src/app/shared/shared.module.ts +++ b/src/app/shared/shared.module.ts @@ -91,6 +91,7 @@ import { CreateComColPageComponent } from './comcol-forms/create-comcol-page/cre import { EditComColPageComponent } from './comcol-forms/edit-comcol-page/edit-comcol-page.component'; import { DeleteComColPageComponent } from './comcol-forms/delete-comcol-page/delete-comcol-page.component'; import { LangSwitchComponent } from './lang-switch/lang-switch.component'; +import { ObjectValuesPipe } from './utils/object-values-pipe'; const MODULES = [ // Do NOT include UniversalModule, HttpModule, or JsonpModule here @@ -124,6 +125,7 @@ const PIPES = [ EmphasizePipe, CapitalizePipe, ObjectKeysPipe, + ObjectValuesPipe, ConsolePipe ]; diff --git a/src/app/shared/utils/object-values-pipe.ts b/src/app/shared/utils/object-values-pipe.ts new file mode 100644 index 0000000000..79efd1cb76 --- /dev/null +++ b/src/app/shared/utils/object-values-pipe.ts @@ -0,0 +1,18 @@ +import { PipeTransform, Pipe } from '@angular/core'; + +@Pipe({name: 'dsObjectValues'}) +/** + * Pipe for parsing all values of an object to an array of values + */ +export class ObjectValuesPipe implements PipeTransform { + + /** + * @param value An object + * @returns {any} Array with all values of the input object + */ + transform(value, args:string[]): any { + const values = []; + Object.values(value).forEach((v) => values.push(v)); + return values; + } +} diff --git a/src/styles/_bootstrap_variables.scss b/src/styles/_bootstrap_variables.scss index 2739503284..d24811b382 100644 --- a/src/styles/_bootstrap_variables.scss +++ b/src/styles/_bootstrap_variables.scss @@ -24,7 +24,7 @@ $gray-100: lighten($gray-base, 93.5%) !default; // #eee $blue: #2B4E72 !default; $green: #94BA65 !default; $cyan: #2790B0 !default; -$yellow: #EBBB54 !default; +$yellow: #ec9433 !default; $red: #CF4444 !default; $dark: darken($blue, 17%) !default; @@ -56,3 +56,4 @@ $grid-breakpoints: ( xl: (1200px - $collapsed-sidebar-width) ) !default; +$yiq-contrasted-threshold: 165 !default; From 643c0d6e1a382c8b03ac6e4de5511b5b209a1780 Mon Sep 17 00:00:00 2001 From: lotte Date: Mon, 11 Feb 2019 15:45:41 +0100 Subject: [PATCH 05/18] finished tests for item metadata updates --- .../edit-item-page/edit-item-page.module.ts | 28 +- .../edit-in-place-field.component.spec.ts | 142 ++++++++++ .../edit-in-place-field.component.ts | 4 +- .../item-metadata.component.spec.ts | 5 +- .../item-metadata/item-metadata.component.ts | 3 +- src/app/core/data/data.service.ts | 9 + .../object-updates/object-updates.actions.ts | 77 +++++- .../object-updates.effects.spec.ts | 113 ++++++-- .../object-updates/object-updates.effects.ts | 78 ++++-- .../object-updates.reducer.spec.ts | 256 ++++++++++++++++++ .../object-updates/object-updates.reducer.ts | 84 ++++-- .../object-updates.service.spec.ts | 233 ++++++++++++++++ .../object-updates/object-updates.service.ts | 86 +++++- .../input-suggestions.component.html | 2 +- .../input-suggestions.component.spec.ts | 20 +- .../input-suggestions.component.ts | 2 + 16 files changed, 1037 insertions(+), 105 deletions(-) create mode 100644 src/app/core/data/object-updates/object-updates.reducer.spec.ts create mode 100644 src/app/core/data/object-updates/object-updates.service.spec.ts diff --git a/src/app/+item-page/edit-item-page/edit-item-page.module.ts b/src/app/+item-page/edit-item-page/edit-item-page.module.ts index 1c0c747ffb..98904517f9 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.module.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.module.ts @@ -1,17 +1,17 @@ -import {NgModule} from '@angular/core'; -import {CommonModule} from '@angular/common'; -import {SharedModule} from '../../shared/shared.module'; -import {EditItemPageRoutingModule} from './edit-item-page.routing.module'; -import {EditItemPageComponent} from './edit-item-page.component'; -import {ItemStatusComponent} from './item-status/item-status.component'; -import {ItemOperationComponent} from './item-operation/item-operation.component'; -import {ModifyItemOverviewComponent} from './modify-item-overview/modify-item-overview.component'; -import {ItemWithdrawComponent} from './item-withdraw/item-withdraw.component'; -import {ItemReinstateComponent} from './item-reinstate/item-reinstate.component'; -import {AbstractSimpleItemActionComponent} from './simple-item-action/abstract-simple-item-action.component'; -import {ItemPrivateComponent} from './item-private/item-private.component'; -import {ItemPublicComponent} from './item-public/item-public.component'; -import {ItemDeleteComponent} from './item-delete/item-delete.component'; +import { NgModule } from '@angular/core'; +import { CommonModule } from '@angular/common'; +import { SharedModule } from '../../shared/shared.module'; +import { EditItemPageRoutingModule } from './edit-item-page.routing.module'; +import { EditItemPageComponent } from './edit-item-page.component'; +import { ItemStatusComponent } from './item-status/item-status.component'; +import { ItemOperationComponent } from './item-operation/item-operation.component'; +import { ModifyItemOverviewComponent } from './modify-item-overview/modify-item-overview.component'; +import { ItemWithdrawComponent } from './item-withdraw/item-withdraw.component'; +import { ItemReinstateComponent } from './item-reinstate/item-reinstate.component'; +import { AbstractSimpleItemActionComponent } from './simple-item-action/abstract-simple-item-action.component'; +import { ItemPrivateComponent } from './item-private/item-private.component'; +import { ItemPublicComponent } from './item-public/item-public.component'; +import { ItemDeleteComponent } from './item-delete/item-delete.component'; import { ItemMetadataComponent } from './item-metadata/item-metadata.component'; import { EditInPlaceFieldComponent } from './item-metadata/edit-in-place-field/edit-in-place-field.component'; diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index 0d7006b85c..aad94931dd 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -105,6 +105,36 @@ describe('EditInPlaceFieldComponent', () => { }); }); + describe('changeType is UPDATE', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.UPDATE; + fixture.detectChanges(); + }); + it('the div should have class table-warning', () => { + expect(el.classList).toContain('table-warning'); + }); + }); + + describe('changeType is ADD', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.ADD; + fixture.detectChanges(); + }); + it('the div should have class table-success', () => { + expect(el.classList).toContain('table-success'); + }); + }); + + describe('changeType is REMOVE', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.REMOVE; + fixture.detectChanges(); + }); + it('the div should have class table-danger', () => { + expect(el.classList).toContain('table-danger'); + }); + }); + describe('setEditable', () => { const editable = false; beforeEach(() => { @@ -116,6 +146,30 @@ describe('EditInPlaceFieldComponent', () => { }); }); + describe('editable is true', () => { + beforeEach(() => { + comp.editable = observableOf(true); + fixture.detectChanges(); + }); + it('the div should contain input fields or textareas', () => { + const inputField = de.queryAll(By.css('input')); + const textAreas = de.queryAll(By.css('textarea')); + expect(inputField.length + textAreas.length).toBeGreaterThan(0); + }); + }); + + describe('editable is false', () => { + beforeEach(() => { + comp.editable = observableOf(false); + fixture.detectChanges(); + }); + it('the div should contain no input fields or textareas', () => { + const inputField = de.queryAll(By.css('input')); + const textAreas = de.queryAll(By.css('textarea')); + expect(inputField.length + textAreas.length).toBe(0); + }); + }); + describe('remove', () => { beforeEach(() => { comp.remove(); @@ -225,10 +279,98 @@ describe('EditInPlaceFieldComponent', () => { }); }); + describe('when canSetEditable emits true', () => { + beforeEach(() => { + spyOn(comp, 'canSetEditable').and.returnValue(observableOf(true)); + }); + it('the div should contain a edit icon', () => { + const editIcon = de.query(By.css('i.fa-edit')); + expect(editIcon).not.toBeNull(); + }); + }); + + describe('when canSetEditable emits false', () => { + beforeEach(() => { + spyOn(comp, 'canSetEditable').and.returnValue(observableOf(false)); + fixture.detectChanges(); + }); + it('the div should not contain a edit icon', () => { + const editIcon = de.query(By.css('i.fa-edit')); + expect(editIcon).toBeNull(); + }); + }); + + describe('when canSetUneditable emits true', () => { + beforeEach(() => { + spyOn(comp, 'canSetUneditable').and.returnValue(observableOf(true)); + fixture.detectChanges(); + }); + it('the div should contain a check icon', () => { + const checkIcon = de.query(By.css('i.fa-check')); + expect(checkIcon).not.toBeNull(); + }); + }); + + describe('when canSetUneditable emits false', () => { + beforeEach(() => { + spyOn(comp, 'canSetUneditable').and.returnValue(observableOf(false)); + fixture.detectChanges(); + }); + it('the div should not contain a check icon', () => { + const checkIcon = de.query(By.css('i.fa-check')); + expect(checkIcon).toBeNull(); + }); + }); + + describe('when canRemove emits true', () => { + beforeEach(() => { + spyOn(comp, 'canRemove').and.returnValue(observableOf(true)); + fixture.detectChanges(); + }); + it('the div should contain a trash icon', () => { + const trashIcon = de.query(By.css('i.fa-trash-alt')); + expect(trashIcon).not.toBeNull(); + }); + }); + + describe('when canRemove emits false', () => { + beforeEach(() => { + spyOn(comp, 'canRemove').and.returnValue(observableOf(false)); + fixture.detectChanges(); + }); + it('the div should not contain a trash icon', () => { + const trashIcon = de.query(By.css('i.fa-trash-alt')); + expect(trashIcon).toBeNull(); + }); + }); + + describe('when canUndo emits true', () => { + beforeEach(() => { + spyOn(comp, 'canUndo').and.returnValue(observableOf(true)); + fixture.detectChanges(); + }); + it('the div should contain a undo icon', () => { + const undoIcon = de.query(By.css('i.fa-undo-alt')); + expect(undoIcon).not.toBeNull(); + }); + }); + + describe('when canUndo emits false', () => { + beforeEach(() => { + spyOn(comp, 'canUndo').and.returnValue(observableOf(false)); + fixture.detectChanges(); + }); + it('the div should not contain a undo icon', () => { + const undoIcon = de.query(By.css('i.fa-undo-alt')); + expect(undoIcon).toBeNull(); + }); + }); + describe('canRemove', () => { describe('when editable is currently true', () => { beforeEach(() => { comp.editable = observableOf(true); + fixture.detectChanges(); }); it('canRemove should return an observable emitting false', () => { const expected = '(a|)'; diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index 8902125985..38470c54c4 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -3,14 +3,14 @@ import { isNotEmpty } from '../../../../shared/empty.util'; import { Metadatum } from '../../../../core/shared/metadatum.model'; import { RegistryService } from '../../../../core/registry/registry.service'; import { cloneDeep } from 'lodash'; -import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; -import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; import { BehaviorSubject, Observable } from 'rxjs'; import { map, take } from 'rxjs/operators'; import { MetadataField } from '../../../../core/metadata/metadatafield.model'; import { InputSuggestion } from '../../../../shared/input-suggestions/input-suggestions.model'; import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; import { of as observableOf } from 'rxjs'; +import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; +import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; @Component({ selector: 'ds-edit-in-place-field', diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts index bbeda39716..b6c53fdbf1 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts @@ -9,7 +9,7 @@ import { SharedModule } from '../../../shared/shared.module'; import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; import { Router } from '@angular/router'; import { NotificationsService } from '../../../shared/notifications/notifications.service'; -import { TranslateModule, TranslateService } from '@ngx-translate/core'; +import { TranslateModule } from '@ngx-translate/core'; import { ItemDataService } from '../../../core/data/item-data.service'; import { By } from '@angular/platform-browser'; import { @@ -81,7 +81,8 @@ describe('ItemMetadataComponent', () => { beforeEach(async(() => { item = Object.assign(new Item(), { metadata: [metadatum1, metadatum2, metadatum3] }, { lastModified: date }); itemService = jasmine.createSpyObj('itemService', { - update: observableOf(new RemoteData(false, false, true, undefined, item)) + update: observableOf(new RemoteData(false, false, true, undefined, item)), + commitUpdates: {} }); scheduler = getTestScheduler(); objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index 6c7b310ce2..d2231e615d 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -11,7 +11,7 @@ import { Identifiable } from '../../../core/data/object-updates/object-updates.reducer'; import { Metadatum } from '../../../core/shared/metadatum.model'; -import { first, switchMap } from 'rxjs/operators'; +import { first, switchMap, tap } from 'rxjs/operators'; import { getSucceededRemoteData } from '../../../core/shared/operators'; import { RemoteData } from '../../../core/data/remote-data'; import { NotificationsService } from '../../../shared/notifications/notifications.service'; @@ -121,6 +121,7 @@ export class ItemMetadataComponent implements OnInit { const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); return this.itemService.update(updatedItem); }), + tap(() => this.itemService.commitUpdates()), getSucceededRemoteData() ).subscribe( (rd: RemoteData) => { diff --git a/src/app/core/data/data.service.ts b/src/app/core/data/data.service.ts index ac56436539..59605da4d8 100644 --- a/src/app/core/data/data.service.ts +++ b/src/app/core/data/data.service.ts @@ -41,6 +41,7 @@ import { CacheableObject } from '../cache/object-cache.reducer'; import { RequestEntry } from './request.reducer'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { ChangeAnalyzer } from './change-analyzer'; +import { RestRequestMethod } from './rest-request-method'; export abstract class DataService { protected abstract requestService: RequestService; @@ -228,4 +229,12 @@ export abstract class DataService { ); } + /** + * Commit current object changes to the server + * @param method The RestRequestMethod for which de server sync buffer should be committed + */ + commitUpdates(method?: RestRequestMethod) { + this.requestService.commit(method); + } + } diff --git a/src/app/core/data/object-updates/object-updates.actions.ts b/src/app/core/data/object-updates/object-updates.actions.ts index 96b85b9179..5f76d6dde9 100644 --- a/src/app/core/data/object-updates/object-updates.actions.ts +++ b/src/app/core/data/object-updates/object-updates.actions.ts @@ -2,6 +2,9 @@ import { type } from '../../../shared/ngrx/type'; import { Action } from '@ngrx/store'; import { Identifiable } from './object-updates.reducer'; import { INotification } from '../../../shared/notifications/models/notification.model'; +/** + * The list of ObjectUpdatesAction type definitions + */ export const ObjectUpdatesActionTypes = { INITIALIZE_FIELDS: type('dspace/core/cache/object-updates/INITIALIZE_FIELDS'), @@ -14,12 +17,19 @@ export const ObjectUpdatesActionTypes = { }; /* tslint:disable:max-classes-per-file */ + +/** + * Enum that represents the different types of updates that can be performed on a field in the ObjectUpdates store + */ export enum FieldChangeType { UPDATE = 0, ADD = 1, REMOVE = 2 } +/** + * An ngrx action to initialize a new page's fields in the ObjectUpdates state + */ export class InitializeFieldsAction implements Action { type = ObjectUpdatesActionTypes.INITIALIZE_FIELDS; payload: { @@ -28,6 +38,14 @@ export class InitializeFieldsAction implements Action { lastModified: Date }; + /** + * Create a new InitializeFieldsAction + * + * @param url + * the unique url of the page for which the fields are being initialized + * @param fields The identifiable fields of which the updates are kept track of + * @param lastModified The last modified date of the object that belongs to the page + */ constructor( url: string, fields: Identifiable[], @@ -37,6 +55,9 @@ export class InitializeFieldsAction implements Action { } } +/** + * An ngrx action to add a new field update in the ObjectUpdates state for a certain page url + */ export class AddFieldUpdateAction implements Action { type = ObjectUpdatesActionTypes.ADD_FIELD; payload: { @@ -45,6 +66,14 @@ export class AddFieldUpdateAction implements Action { changeType: FieldChangeType, }; + /** + * Create a new AddFieldUpdateAction + * + * @param url + * the unique url of the page for which a field update is added + * @param field The identifiable field of which a new update is added + * @param changeType The update's change type + */ constructor( url: string, field: Identifiable, @@ -53,6 +82,9 @@ export class AddFieldUpdateAction implements Action { } } +/** + * An ngrx action to set the editable state of an existing field in the ObjectUpdates state for a certain page url + */ export class SetEditableFieldUpdateAction implements Action { type = ObjectUpdatesActionTypes.SET_EDITABLE_FIELD; payload: { @@ -61,6 +93,14 @@ export class SetEditableFieldUpdateAction implements Action { editable: boolean, }; + /** + * Create a new SetEditableFieldUpdateAction + * + * @param url + * the unique url of the page + * @param fieldUUID The UUID of the field of which + * @param editable The new editable value for the field + */ constructor( url: string, fieldUUID: string, @@ -69,13 +109,23 @@ export class SetEditableFieldUpdateAction implements Action { } } +/** + * An ngrx action to discard all existing updates in the ObjectUpdates state for a certain page url + */ export class DiscardObjectUpdatesAction implements Action { type = ObjectUpdatesActionTypes.DISCARD; payload: { url: string, - notification + notification: INotification }; + /** + * Create a new DiscardObjectUpdatesAction + * + * @param url + * the unique url of the page for which the changes should be discarded + * @param notification The notification that is raised when changes are discarded + */ constructor( url: string, notification: INotification @@ -84,12 +134,21 @@ export class DiscardObjectUpdatesAction implements Action { } } +/** + * An ngrx action to reinstate all previously discarded updates in the ObjectUpdates state for a certain page url + */ export class ReinstateObjectUpdatesAction implements Action { type = ObjectUpdatesActionTypes.REINSTATE; payload: { url: string }; + /** + * Create a new ReinstateObjectUpdatesAction + * + * @param url + * the unique url of the page for which the changes should be reinstated + */ constructor( url: string ) { @@ -97,12 +156,21 @@ export class ReinstateObjectUpdatesAction implements Action { } } +/** + * An ngrx action to remove all previously discarded updates in the ObjectUpdates state for a certain page url + */ export class RemoveObjectUpdatesAction implements Action { type = ObjectUpdatesActionTypes.REMOVE; payload: { url: string }; + /** + * Create a new RemoveObjectUpdatesAction + * + * @param url + * the unique url of the page for which the changes should be removed + */ constructor( url: string ) { @@ -117,6 +185,13 @@ export class RemoveFieldUpdateAction implements Action { uuid: string }; + /** + * Create a new RemoveObjectUpdatesAction + * + * @param url + * the unique url of the page for which a field's change should be removed + * @param uuid The UUID of the field for which the change should be removed + */ constructor( url: string, uuid: string diff --git a/src/app/core/data/object-updates/object-updates.effects.spec.ts b/src/app/core/data/object-updates/object-updates.effects.spec.ts index a81a0665bf..79b1b2df72 100644 --- a/src/app/core/data/object-updates/object-updates.effects.spec.ts +++ b/src/app/core/data/object-updates/object-updates.effects.spec.ts @@ -1,55 +1,122 @@ -import { TestBed } from '@angular/core/testing'; -import { Observable } from 'rxjs'; +import { async, TestBed } from '@angular/core/testing'; +import { Observable, Subject } from 'rxjs'; import { provideMockActions } from '@ngrx/effects/testing'; import { cold, hot } from 'jasmine-marbles'; import { NotificationsService } from '../../../shared/notifications/notifications.service'; import { ObjectUpdatesEffects } from './object-updates.effects'; -import { RemoveObjectUpdatesAction } from './object-updates.actions'; +import { + DiscardObjectUpdatesAction, + ObjectUpdatesAction, + ReinstateObjectUpdatesAction, + RemoveFieldUpdateAction, + RemoveObjectUpdatesAction +} from './object-updates.actions'; +import { + INotification, + Notification +} from '../../../shared/notifications/models/notification.model'; +import { NotificationType } from '../../../shared/notifications/models/notification-type'; +import { filter } from 'rxjs/operators'; +import { hasValue } from '../../../shared/empty.util'; -fdescribe('ObjectUpdatesEffects', () => { +describe('ObjectUpdatesEffects', () => { let updatesEffects: ObjectUpdatesEffects; let actions: Observable; - const testURL = 'www.dspace.org/dspace7'; - beforeEach(() => { + let testURL = 'www.dspace.org/dspace7'; + let testUUID = '20e24c2f-a00a-467c-bdee-c929e79bf08d'; + beforeEach(async(() => { TestBed.configureTestingModule({ providers: [ ObjectUpdatesEffects, provideMockActions(() => actions), { - provide: NotificationsService, useClass: { + provide: NotificationsService, + useValue: { remove: (notification) => { /* empty */ } } }, - // other providers ], }); + })); + beforeEach(() => { + testURL = 'www.dspace.org/dspace7'; + testUUID = '20e24c2f-a00a-467c-bdee-c929e79bf08d'; updatesEffects = TestBed.get(ObjectUpdatesEffects); + (updatesEffects as any).actionMap[testURL] = new Subject(); }); describe('mapLastActions$', () => { describe('When any ObjectUpdatesAction is triggered', () => { - const action = new RemoveObjectUpdatesAction(testURL); + let action; + let emittedAction; + beforeEach(() => { + action = new RemoveObjectUpdatesAction(testURL); + }); it('should emit the action from the actionMap\'s value which key matches the action\'s URL', () => { + action = new RemoveObjectUpdatesAction(testURL); actions = hot('--a-', { a: action }); + (updatesEffects as any).actionMap[testURL].subscribe((act) => emittedAction = act); + const expected = cold('--b-', { b: undefined }); - const expected = cold('--b-', { b: action }); - - expect((updatesEffects as any).actionMap[testURL]).toBeObservable(expected); + expect(updatesEffects.mapLastActions$).toBeObservable(expected); + expect(emittedAction).toBe(action); }); }); }); - // describe('removeAfterDiscardOrReinstateOnUndo$', () => { - // - // it('should return a COLLAPSE action in response to an UPDATE_LOCATION action', () => { - // actions = hot('--a-', { a: { type: fromRouter.ROUTER_NAVIGATION } }); - // - // const expected = cold('--b-', { b: new CollapseMenuAction(MenuID.PUBLIC) }); - // - // expect(updatesEffects.routeChange$).toBeObservable(expected); - // }); - // - // }); + describe('removeAfterDiscardOrReinstateOnUndo$', () => { + describe('When an ObjectUpdatesActionTypes.DISCARD action is triggered', () => { + let infoNotification: INotification; + let removeAction; + describe('When there is no user interactions before the timeout is finished', () => { + beforeEach(() => { + infoNotification = new Notification('id', NotificationType.Info, 'info'); + infoNotification.options.timeOut = 0; + removeAction = new RemoveObjectUpdatesAction(testURL) + }); + it('should return a RemoveObjectUpdatesAction', () => { + actions = hot('a|', { a: new DiscardObjectUpdatesAction(testURL, infoNotification) }); + updatesEffects.removeAfterDiscardOrReinstateOnUndo$.pipe( + filter(((action) => hasValue(action)))) + .subscribe((t) => { + expect(t).toEqual(removeAction); + } + ) + ; + }); + }); + + describe('When there a REINSTATE action is fired before the timeout is finished', () => { + beforeEach(() => { + infoNotification = new Notification('id', NotificationType.Info, 'info'); + infoNotification.options.timeOut = 10; + }); + it('should return an action with type NO_ACTION', () => { + actions = hot('a', { a: new DiscardObjectUpdatesAction(testURL, infoNotification) }); + actions = hot('b', { b: new ReinstateObjectUpdatesAction(testURL) }); + updatesEffects.removeAfterDiscardOrReinstateOnUndo$.subscribe((t) => { + expect(t).toEqual({ type: 'NO_ACTION' }); + } + ); + }); + }); + + describe('When there any ObjectUpdates action - other than REINSTATE - is fired before the timeout is finished', () => { + beforeEach(() => { + infoNotification = new Notification('id', NotificationType.Info, 'info'); + infoNotification.options.timeOut = 10; + }); + it('should return a RemoveObjectUpdatesAction', () => { + actions = hot('a', { a: new DiscardObjectUpdatesAction(testURL, infoNotification) }); + actions = hot('b', { b: new RemoveFieldUpdateAction(testURL, testUUID) }); + + updatesEffects.removeAfterDiscardOrReinstateOnUndo$.subscribe((t) => + expect(t).toEqual(new RemoveObjectUpdatesAction(testURL)) + ); + }); + }); + }); + }); }); diff --git a/src/app/core/data/object-updates/object-updates.effects.ts b/src/app/core/data/object-updates/object-updates.effects.ts index f89700f6fe..ae49071dc1 100644 --- a/src/app/core/data/object-updates/object-updates.effects.ts +++ b/src/app/core/data/object-updates/object-updates.effects.ts @@ -3,15 +3,23 @@ import { Actions, Effect, ofType } from '@ngrx/effects'; import { DiscardObjectUpdatesAction, ObjectUpdatesAction, - ObjectUpdatesActionTypes + ObjectUpdatesActionTypes, + RemoveObjectUpdatesAction } from './object-updates.actions'; -import { map } from 'rxjs/operators'; -import { Subject } from 'rxjs'; +import { delay, map, switchMap, take, tap } from 'rxjs/operators'; +import { of as observableOf, race as observableRace, Subject } from 'rxjs'; import { hasNoValue } from '../../../shared/empty.util'; import { NotificationsService } from '../../../shared/notifications/notifications.service'; +import { INotification } from '../../../shared/notifications/models/notification.model'; +/** + * NGRX effects for ObjectUpdatesActions + */ @Injectable() export class ObjectUpdatesEffects { + /** + * Map that keeps track of the latest ObjectUpdatesAction for each page's url + */ private actionMap: { /* Use Subject instead of BehaviorSubject: we only want Actions that are fired while we're listening @@ -20,6 +28,9 @@ export class ObjectUpdatesEffects { [url: string]: Subject } = {}; + /** + * Effect that makes sure all last fired ObjectUpdatesActions are stored in the map of this service, with the url as their key + */ @Effect({ dispatch: false }) mapLastActions$ = this.actions$ .pipe( ofType(...Object.values(ObjectUpdatesActionTypes)), @@ -33,31 +44,44 @@ export class ObjectUpdatesEffects { ) ); - // @Effect() removeAfterDiscardOrReinstateOnUndo$ = this.actions$ - // .pipe( - // ofType(ObjectUpdatesActionTypes.DISCARD), - // switchMap((action: DiscardObjectUpdatesAction) => { - // const url: string = action.payload.url; - // const notification: INotification = action.payload.notification; - // const timeOut = notification.options.timeOut; - // return observableRace( - // // Either wait for the delay and perform a remove action - // observableOf(new RemoveObjectUpdatesAction(action.payload.url)).pipe(delay(timeOut)), - // // Or wait for a reinstate action and perform no action - // this.actionMap[url].pipe( - // // filter((updateAction: ObjectUpdatesAction) => updateAction.type === ObjectUpdatesActionTypes.REINSTATE), - // tap(() => this.notificationsService.remove(notification)), - // map(() => { - // return { type: 'NO_ACTION' } - // } - // ) - // ) - // ) - // } - // ) - // ); + /** + * Effect that checks whether the removeAction's notification timeout ends before a user triggers another ObjectUpdatesAction + * When no ObjectUpdatesAction is fired during the timeout, a RemoteObjectUpdatesAction will be returned + * When a REINSTATE action is fired during the timeout, a NO_ACTION action will be returned + * When any other ObjectUpdatesAction is fired during the timeout, a RemoteObjectUpdatesAction will be returned + */ + @Effect() removeAfterDiscardOrReinstateOnUndo$ = this.actions$ + .pipe( + ofType(ObjectUpdatesActionTypes.DISCARD), + switchMap((action: DiscardObjectUpdatesAction) => { + const url: string = action.payload.url; + const notification: INotification = action.payload.notification; + const timeOut = notification.options.timeOut; + return observableRace( + // Either wait for the delay and perform a remove action + observableOf(new RemoveObjectUpdatesAction(action.payload.url)).pipe(delay(timeOut)), + // Or wait for a a user action + this.actionMap[url].pipe( + take(1), + tap(() => this.notificationsService.remove(notification)), + map((updateAction: ObjectUpdatesAction) => { + if (updateAction.type === ObjectUpdatesActionTypes.REINSTATE) { + // If someone reinstated, do nothing, just let the reinstating happen + return { type: 'NO_ACTION' } + } else { + // If someone performed another action, assume the user does not want to reinstate and remove all changes + return new RemoveObjectUpdatesAction(action.payload.url); + } + }) + ) + ) + } + ) + ); + + constructor(private actions$: Actions, + private notificationsService: NotificationsService) { - constructor(private actions$: Actions, private notificationsService: NotificationsService) { } } diff --git a/src/app/core/data/object-updates/object-updates.reducer.spec.ts b/src/app/core/data/object-updates/object-updates.reducer.spec.ts new file mode 100644 index 0000000000..377b3ab1b4 --- /dev/null +++ b/src/app/core/data/object-updates/object-updates.reducer.spec.ts @@ -0,0 +1,256 @@ +import * as deepFreeze from 'deep-freeze'; +import { + AddFieldUpdateAction, + DiscardObjectUpdatesAction, + FieldChangeType, + InitializeFieldsAction, + ReinstateObjectUpdatesAction, + RemoveFieldUpdateAction, RemoveObjectUpdatesAction, + SetEditableFieldUpdateAction +} from './object-updates.actions'; +import { OBJECT_UPDATES_TRASH_PATH, objectUpdatesReducer } from './object-updates.reducer'; + +class NullAction extends RemoveFieldUpdateAction { + type = null; + payload = null; + + constructor() { + super(null, null); + } +} + +const identifiable1 = { + uuid: '8222b07e-330d-417b-8d7f-3b82aeaf2320', + key: 'dc.contributor.author', + language: null, + value: 'Smith, John' +}; + +const identifiable1update = { + uuid: '8222b07e-330d-417b-8d7f-3b82aeaf2320', + key: 'dc.contributor.author', + language: null, + value: 'Smith, James' +}; +const identifiable2 = { + uuid: '26cbb5ce-5786-4e57-a394-b9fcf8eaf241', + key: 'dc.title', + language: null, + value: 'New title' +}; +const identifiable3 = { + uuid: 'c5d2c2f7-d757-48bf-84cc-8c9229c8407e', + key: 'dc.description.abstract', + language: null, + value: 'Unchanged value' +}; + +const modDate = new Date(2010, 2, 11); +const uuid = identifiable1.uuid; +const url = 'test-object.url/edit'; +describe('objectUpdatesReducer', () => { + const testState = { + [url]: { + fieldStates: { + [identifiable1.uuid]: { + editable: true, + isNew: false + }, + [identifiable2.uuid]: { + editable: false, + isNew: true + }, + [identifiable3.uuid]: { + editable: false, + isNew: false + }, + }, + fieldUpdates: { + [identifiable2.uuid]: { + field: { + uuid: identifiable2.uuid, + key: 'dc.title', + language: null, + value: 'New title' + }, + changeType: FieldChangeType.ADD + } + }, + lastModified: modDate + } + }; + + const discardedTestState = { + [url]: { + fieldStates: { + [identifiable1.uuid]: { + editable: true, + isNew: false + }, + [identifiable2.uuid]: { + editable: false, + isNew: true + }, + [identifiable3.uuid]: { + editable: false, + isNew: false + }, + }, + lastModified: modDate + }, + [url + OBJECT_UPDATES_TRASH_PATH]: { + fieldStates: { + [identifiable1.uuid]: { + editable: true, + isNew: false + }, + [identifiable2.uuid]: { + editable: false, + isNew: true + }, + [identifiable3.uuid]: { + editable: false, + isNew: false + }, + }, + fieldUpdates: { + [identifiable2.uuid]: { + field: { + uuid: identifiable2.uuid, + key: 'dc.title', + language: null, + value: 'New title' + }, + changeType: FieldChangeType.ADD + } + }, + lastModified: modDate + } + }; + + deepFreeze(testState); + + it('should return the current state when no valid actions have been made', () => { + const action = new NullAction(); + const newState = objectUpdatesReducer(testState, action); + + expect(newState).toEqual(testState); + }); + + it('should start with an empty object', () => { + const action = new NullAction(); + const initialState = objectUpdatesReducer(undefined, action); + + expect(initialState).toEqual({}); + }); + + it('should perform the INITIALIZE_FIELDS action without affecting the previous state', () => { + const action = new InitializeFieldsAction(url, [identifiable1, identifiable2], modDate); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should perform the SET_EDITABLE_FIELD action without affecting the previous state', () => { + const action = new SetEditableFieldUpdateAction(url, uuid, false); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should perform the ADD_FIELD action without affecting the previous state', () => { + const action = new AddFieldUpdateAction(url, identifiable1update, FieldChangeType.UPDATE); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should perform the DISCARD action without affecting the previous state', () => { + const action = new DiscardObjectUpdatesAction(url, null); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should perform the REINSTATE action without affecting the previous state', () => { + const action = new ReinstateObjectUpdatesAction(url); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should perform the REMOVE action without affecting the previous state', () => { + const action = new RemoveFieldUpdateAction(url, uuid); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should perform the REMOVE_FIELD action without affecting the previous state', () => { + const action = new RemoveFieldUpdateAction(url, uuid); + // testState has already been frozen above + objectUpdatesReducer(testState, action); + }); + + it('should initialize all fields when the INITIALIZE action is dispatched, based on the payload', () => { + const action = new InitializeFieldsAction(url, [identifiable1, identifiable3], modDate); + + const expectedState = { + [url]: { + fieldStates: { + [identifiable1.uuid]: { + editable: false, + isNew: false + }, + [identifiable3.uuid]: { + editable: false, + isNew: false + }, + }, + fieldUpdates: {}, + lastModified: modDate + } + }; + const newState = objectUpdatesReducer(testState, action); + expect(newState).toEqual(expectedState); + }); + + it('should set the given field\'s fieldStates when the SET_EDITABLE_FIELD action is dispatched, based on the payload', () => { + const action = new SetEditableFieldUpdateAction(url, identifiable3.uuid, true); + + const newState = objectUpdatesReducer(testState, action); + expect(newState[url].fieldStates[identifiable3.uuid].editable).toBeTruthy(); + }); + + it('should add a given field\'s update to the state when the ADD_FIELD action is dispatched, based on the payload', () => { + const action = new AddFieldUpdateAction(url, identifiable1update, FieldChangeType.UPDATE); + + const newState = objectUpdatesReducer(testState, action); + expect(newState[url].fieldUpdates[identifiable1.uuid].field).toEqual(identifiable1update); + expect(newState[url].fieldUpdates[identifiable1.uuid].changeType).toEqual(FieldChangeType.UPDATE); + }); + + it('should discard a given url\'s updates from the state when the DISCARD action is dispatched, based on the payload', () => { + const action = new DiscardObjectUpdatesAction(url, null); + + const newState = objectUpdatesReducer(testState, action); + expect(newState[url].fieldUpdates).toEqual({}); + expect(newState[url + OBJECT_UPDATES_TRASH_PATH]).toEqual(testState[url]); + }); + + it('should reinstate a given url\'s updates from the state when the REINSTATE action is dispatched, based on the payload', () => { + const action = new ReinstateObjectUpdatesAction(url); + + const newState = objectUpdatesReducer(discardedTestState, action); + expect(newState).toEqual(testState); + }); + + it('should remove a given url\'s updates from the state when the REMOVE action is dispatched, based on the payload', () => { + const action = new RemoveObjectUpdatesAction(url); + + const newState = objectUpdatesReducer(discardedTestState, action); + expect(newState[url].fieldUpdates).toBeUndefined(); + expect(newState[url + OBJECT_UPDATES_TRASH_PATH]).toBeUndefined(); + }); + + it('should remove a given field\'s update from the state when the REMOVE_FIELD action is dispatched, based on the payload', () => { + const action = new RemoveFieldUpdateAction(url, uuid); + + const newState = objectUpdatesReducer(testState, action); + expect(newState[url].fieldUpdates[uuid]).toBeUndefined(); + }); +}); diff --git a/src/app/core/data/object-updates/object-updates.reducer.ts b/src/app/core/data/object-updates/object-updates.reducer.ts index 4345373bfa..c46438bd90 100644 --- a/src/app/core/data/object-updates/object-updates.reducer.ts +++ b/src/app/core/data/object-updates/object-updates.reducer.ts @@ -52,45 +52,45 @@ const initialNewFieldState = { editable: true, isNew: true }; // Object.create(null) ensures the object has no default js properties (e.g. `__proto__`) const initialState = Object.create(null); +/** + * Reducer method to calculate the next ObjectUpdates state, based on the current state and the ObjectUpdatesAction + * @param state The current state + * @param action The action to perform on the current state + */ export function objectUpdatesReducer(state = initialState, action: ObjectUpdatesAction): ObjectUpdatesState { - let newState = state; switch (action.type) { case ObjectUpdatesActionTypes.INITIALIZE_FIELDS: { - newState = initializeFieldsUpdate(state, action as InitializeFieldsAction); - break; + return initializeFieldsUpdate(state, action as InitializeFieldsAction); } case ObjectUpdatesActionTypes.ADD_FIELD: { - newState = addFieldUpdate(state, action as AddFieldUpdateAction); - break; + return addFieldUpdate(state, action as AddFieldUpdateAction); } case ObjectUpdatesActionTypes.DISCARD: { - newState = discardObjectUpdates(state, action as DiscardObjectUpdatesAction); - break; + return discardObjectUpdates(state, action as DiscardObjectUpdatesAction); } case ObjectUpdatesActionTypes.REINSTATE: { - newState = reinstateObjectUpdates(state, action as ReinstateObjectUpdatesAction); - break; + return reinstateObjectUpdates(state, action as ReinstateObjectUpdatesAction); } case ObjectUpdatesActionTypes.REMOVE: { - newState = removeObjectUpdates(state, action as RemoveObjectUpdatesAction); - break; + return removeObjectUpdates(state, action as RemoveObjectUpdatesAction); } case ObjectUpdatesActionTypes.REMOVE_FIELD: { - newState = removeFieldUpdate(state, action as RemoveFieldUpdateAction); - break; + return removeFieldUpdate(state, action as RemoveFieldUpdateAction); } case ObjectUpdatesActionTypes.SET_EDITABLE_FIELD: { - // return directly, no need to change the lastModified date return setEditableFieldUpdate(state, action as SetEditableFieldUpdateAction); } default: { return state; } } - // return setUpdated(newState, action.payload.url); - return newState; } +/** + * Initialize the state for a specific url and store all its fields in the store + * @param state The current state + * @param action The action to perform on the current state + */ function initializeFieldsUpdate(state: any, action: InitializeFieldsAction) { const url: string = action.payload.url; const fields: Identifiable[] = action.payload.fields; @@ -101,11 +101,16 @@ function initializeFieldsUpdate(state: any, action: InitializeFieldsAction) { state[url], { fieldStates: fieldStates }, { fieldUpdates: {} }, - { lastServerUpdate: lastModifiedServer } + { lastModified: lastModifiedServer } ); return Object.assign({}, state, { [url]: newPageState }); } +/** + * Add a new update for a specific field to the store + * @param state The current state + * @param action The action to perform on the current state + */ function addFieldUpdate(state: any, action: AddFieldUpdateAction) { const url: string = action.payload.url; const field: Identifiable = action.payload.field; @@ -130,6 +135,11 @@ function addFieldUpdate(state: any, action: AddFieldUpdateAction) { return Object.assign({}, state, { [url]: newPageState }); } +/** + * Discard all updates for a specific action's url in the store + * @param state The current state + * @param action The action to perform on the current state + */ function discardObjectUpdates(state: any, action: DiscardObjectUpdatesAction) { const url: string = action.payload.url; const pageState: ObjectUpdatesEntry = state[url]; @@ -149,6 +159,11 @@ function discardObjectUpdates(state: any, action: DiscardObjectUpdatesAction) { return Object.assign({}, state, { [url]: discardedPageState }, { [url + OBJECT_UPDATES_TRASH_PATH]: pageState }); } +/** + * Reinstate all updates for a specific action's url in the store + * @param state The current state + * @param action The action to perform on the current state + */ function reinstateObjectUpdates(state: any, action: ReinstateObjectUpdatesAction) { const url: string = action.payload.url; const trashState = state[url + OBJECT_UPDATES_TRASH_PATH]; @@ -158,17 +173,32 @@ function reinstateObjectUpdates(state: any, action: ReinstateObjectUpdatesAction return newState; } +/** + * Remove all updates for a specific action's url in the store + * @param state The current state + * @param action The action to perform on the current state + */ function removeObjectUpdates(state: any, action: RemoveObjectUpdatesAction) { const url: string = action.payload.url; return removeObjectUpdatesByURL(state, url); } +/** + * Remove all updates for a specific url in the store + * @param state The current state + * @param action The action to perform on the current state + */ function removeObjectUpdatesByURL(state: any, url: string) { const newState = Object.assign({}, state); delete newState[url + OBJECT_UPDATES_TRASH_PATH]; return newState; } +/** + * Discard the update for a specific action's url and field UUID in the store + * @param state The current state + * @param action The action to perform on the current state + */ function removeFieldUpdate(state: any, action: RemoveFieldUpdateAction) { const url: string = action.payload.url; const uuid: string = action.payload.uuid; @@ -196,11 +226,12 @@ function removeFieldUpdate(state: any, action: RemoveFieldUpdateAction) { return Object.assign({}, state, { [url]: newPageState }); } -function setUpdated(state: any, url: string) { - const newPageState = Object.assign({}, state[url] || {}, { lastUpdated: Date.now() }); - return Object.assign({}, state, { [url]: newPageState }); -} - +/** + * Determine the most prominent FieldChangeType, ordered as follows: + * undefined < UPDATE < ADD < REMOVE + * @param oldType The current type + * @param newType The new type that should possibly override the new type + */ function determineChangeType(oldType: FieldChangeType, newType: FieldChangeType): FieldChangeType { if (hasNoValue(newType)) { return oldType; @@ -211,6 +242,11 @@ function determineChangeType(oldType: FieldChangeType, newType: FieldChangeType) return oldType.valueOf() > newType.valueOf() ? oldType : newType; } +/** + * Set the state of a specific action's url and uuid to false or true + * @param state The current state + * @param action The action to perform on the current state + */ function setEditableFieldUpdate(state: any, action: SetEditableFieldUpdateAction) { const url: string = action.payload.url; const uuid: string = action.payload.uuid; @@ -228,6 +264,10 @@ function setEditableFieldUpdate(state: any, action: SetEditableFieldUpdateAction return Object.assign({}, state, { [url]: newPageState }); } +/** + * Method to create an initial FieldStates object based on a list of Identifiable objects + * @param fields Identifiable objects + */ function createInitialFieldStates(fields: Identifiable[]) { const uuids = fields.map((field: Identifiable) => field.uuid); const fieldStates = {}; diff --git a/src/app/core/data/object-updates/object-updates.service.spec.ts b/src/app/core/data/object-updates/object-updates.service.spec.ts new file mode 100644 index 0000000000..4f0393c641 --- /dev/null +++ b/src/app/core/data/object-updates/object-updates.service.spec.ts @@ -0,0 +1,233 @@ +import { Store } from '@ngrx/store'; +import { CoreState } from '../../core.reducers'; +import { ObjectUpdatesService } from './object-updates.service'; +import { + DiscardObjectUpdatesAction, + FieldChangeType, + InitializeFieldsAction, ReinstateObjectUpdatesAction, RemoveFieldUpdateAction, + SetEditableFieldUpdateAction +} from './object-updates.actions'; +import { of as observableOf } from 'rxjs'; +import { Notification } from '../../../shared/notifications/models/notification.model'; +import { NotificationType } from '../../../shared/notifications/models/notification-type'; +import { OBJECT_UPDATES_TRASH_PATH } from './object-updates.reducer'; + +describe('ObjectUpdatesService', () => { + let service: ObjectUpdatesService; + let store: Store; + const value = 'test value'; + const url = 'test-url.com/dspace'; + const identifiable1 = { uuid: '8222b07e-330d-417b-8d7f-3b82aeaf2320' }; + const identifiable1Updated = { uuid: '8222b07e-330d-417b-8d7f-3b82aeaf2320', value: value }; + const identifiable2 = { uuid: '26cbb5ce-5786-4e57-a394-b9fcf8eaf241' }; + const identifiable3 = { uuid: 'c5d2c2f7-d757-48bf-84cc-8c9229c8407e' }; + const identifiables = [identifiable1, identifiable2]; + + const fieldUpdates = { + [identifiable1.uuid]: { field: identifiable1Updated, changeType: FieldChangeType.UPDATE }, + [identifiable3.uuid]: { field: identifiable3, changeType: FieldChangeType.ADD } + }; + + const modDate = new Date(2010, 2, 11); + + beforeEach(() => { + const fieldStates = { + [identifiable1.uuid]: { editable: false, isNew: false }, + [identifiable2.uuid]: { editable: true, isNew: false }, + [identifiable3.uuid]: { editable: true, isNew: true }, + }; + + const objectEntry = { + fieldStates, fieldUpdates, lastModified: modDate + }; + store = new Store(undefined, undefined, undefined); + spyOn(store, 'dispatch'); + service = new ObjectUpdatesService(store); + + spyOn(service as any, 'getObjectEntry').and.returnValue(observableOf(objectEntry)); + spyOn(service as any, 'saveFieldUpdate'); + }); + + describe('initialize', () => { + it('should dispatch an INITIALIZE action with the correct URL, initial identifiables and the last modified date', () => { + service.initialize(url, identifiables, modDate); + expect(store.dispatch).toHaveBeenCalledWith(new InitializeFieldsAction(url, identifiables, modDate)); + }); + }); + + describe('getFieldUpdates', () => { + it('should return the list of all fields, including their update if there is one', () => { + const result$ = service.getFieldUpdates(url, identifiables); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + + const expectedResult = { + [identifiable1.uuid]: { field: identifiable1Updated, changeType: FieldChangeType.UPDATE }, + [identifiable2.uuid]: { field: identifiable2, changeType: undefined }, + [identifiable3.uuid]: { field: identifiable3, changeType: FieldChangeType.ADD } + }; + + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + }); + + describe('isEditable', () => { + it('should return false if this identifiable is currently not editable in the store', () => { + const result$ = service.isEditable(url, identifiable1.uuid); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + result$.subscribe((result) => { + expect(result).toEqual(false); + }); + }); + + it('should return true if this identifiable is currently editable in the store', () => { + const result$ = service.isEditable(url, identifiable2.uuid); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + result$.subscribe((result) => { + expect(result).toEqual(true); + }); + }); + }); + + describe('saveAddFieldUpdate', () => { + it('should call saveFieldUpdate on the service with FieldChangeType.ADD', () => { + service.saveAddFieldUpdate(url, identifiable1); + expect((service as any).saveFieldUpdate).toHaveBeenCalledWith(url, identifiable1, FieldChangeType.ADD); + }); + }); + + describe('saveRemoveFieldUpdate', () => { + it('should call saveFieldUpdate on the service with FieldChangeType.REMOVE', () => { + service.saveRemoveFieldUpdate(url, identifiable1); + expect((service as any).saveFieldUpdate).toHaveBeenCalledWith(url, identifiable1, FieldChangeType.REMOVE); + }); + }); + + describe('saveChangeFieldUpdate', () => { + it('should call saveFieldUpdate on the service with FieldChangeType.UPDATE', () => { + service.saveChangeFieldUpdate(url, identifiable1); + expect((service as any).saveFieldUpdate).toHaveBeenCalledWith(url, identifiable1, FieldChangeType.UPDATE); + }); + }); + + describe('setEditableFieldUpdate', () => { + it('should dispatch a SetEditableFieldUpdateAction action with the correct URL, uuid and true when true was set', () => { + service.setEditableFieldUpdate(url, identifiable1.uuid, true); + expect(store.dispatch).toHaveBeenCalledWith(new SetEditableFieldUpdateAction(url, identifiable1.uuid, true)); + }); + + it('should dispatch an SetEditableFieldUpdateAction action with the correct URL, uuid and false when false was set', () => { + service.setEditableFieldUpdate(url, identifiable1.uuid, false); + expect(store.dispatch).toHaveBeenCalledWith(new SetEditableFieldUpdateAction(url, identifiable1.uuid, false)); + }); + }); + + describe('discardFieldUpdates', () => { + it('should dispatch a DiscardObjectUpdatesAction action with the correct URL and passed notification ', () => { + const undoNotification = new Notification('id', NotificationType.Info, 'undo'); + service.discardFieldUpdates(url, undoNotification); + expect(store.dispatch).toHaveBeenCalledWith(new DiscardObjectUpdatesAction(url, undoNotification)); + }); + }); + + describe('reinstateFieldUpdates', () => { + it('should dispatch a ReinstateObjectUpdatesAction action with the correct URL ', () => { + service.reinstateFieldUpdates(url); + expect(store.dispatch).toHaveBeenCalledWith(new ReinstateObjectUpdatesAction(url)); + }); + }); + + describe('removeSingleFieldUpdate', () => { + it('should dispatch a RemoveFieldUpdateAction action with the correct URL and uuid', () => { + service.removeSingleFieldUpdate(url, identifiable1.uuid); + expect(store.dispatch).toHaveBeenCalledWith(new RemoveFieldUpdateAction(url, identifiable1.uuid)); + }); + }); + + describe('getUpdatedFields', () => { + it('should return the list of all metadata fields with their new values', () => { + const result$ = service.getUpdatedFields(url, identifiables); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + + const expectedResult = [identifiable1Updated, identifiable2, identifiable3]; + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + }); + + describe('hasUpdates', () => { + it('should return true when there are updates', () => { + const result$ = service.hasUpdates(url); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + + const expectedResult = true; + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + describe('when updates are emtpy', () => { + beforeEach(() => { + (service as any).getObjectEntry.and.returnValue(observableOf({})) + }); + + it('should return false when there are no updates', () => { + const result$ = service.hasUpdates(url); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + + const expectedResult = false; + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + }); + }); + + describe('isReinstatable', () => { + + describe('when updates are not emtpy', () => { + beforeEach(() => { + spyOn(service, 'hasUpdates').and.returnValue(observableOf(true)); + }); + + it('should return true', () => { + const result$ = service.isReinstatable(url); + expect(service.hasUpdates).toHaveBeenCalledWith(url + OBJECT_UPDATES_TRASH_PATH); + + const expectedResult = true; + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + }); + + describe('when updates are emtpy', () => { + beforeEach(() => { + spyOn(service, 'hasUpdates').and.returnValue(observableOf(false)); + }); + + it('should return false', () => { + const result$ = service.isReinstatable(url); + expect(service.hasUpdates).toHaveBeenCalledWith(url + OBJECT_UPDATES_TRASH_PATH); + const expectedResult = false; + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + }); + }); + + describe('getLastModified', () => { + it('should return true when hasUpdates returns true', () => { + const result$ = service.getLastModified(url); + expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + + const expectedResult = modDate; + result$.subscribe((result) => { + expect(result).toEqual(expectedResult); + }); + }); + }); + +}); diff --git a/src/app/core/data/object-updates/object-updates.service.ts b/src/app/core/data/object-updates/object-updates.service.ts index 2f3e31eb7c..4b6c7def0d 100644 --- a/src/app/core/data/object-updates/object-updates.service.ts +++ b/src/app/core/data/object-updates/object-updates.service.ts @@ -29,24 +29,49 @@ function filterByUrlObjectUpdatesStateSelector(url: string): MemoizedSelector state[url]); } +/** + * Service that dispatches and reads from the ObjectUpdates' state in the store + */ @Injectable() export class ObjectUpdatesService { constructor(private store: Store) { } + /** + * Method to dispatch an InitializeFieldsAction to the store + * @param url The page's URL for which the changes are being mapped + * @param fields The initial fields for the page's object + * @param lastModified The date the object was last modified + */ initialize(url, fields: Identifiable[], lastModified: Date): void { this.store.dispatch(new InitializeFieldsAction(url, fields, lastModified)); } + /** + * Method to dispatch an AddFieldUpdateAction to the store + * @param url The page's URL for which the changes are saved + * @param field An updated field for the page's object + * @param changeType The last type of change applied to this field + */ private saveFieldUpdate(url: string, field: Identifiable, changeType: FieldChangeType) { this.store.dispatch(new AddFieldUpdateAction(url, field, changeType)) } + /** + * Request the ObjectUpdatesEntry state for a specific URL + * @param url The URL to filter by + */ private getObjectEntry(url: string): Observable { return this.store.pipe(select(filterByUrlObjectUpdatesStateSelector(url))); } + /** + * Method that combines the state's updates with the initial values (when there's no update) to create + * a FieldUpdates object + * @param url The URL of the page for which the FieldUpdates should be requested + * @param initialFields The initial values of the fields + */ getFieldUpdates(url: string, initialFields: Identifiable[]): Observable { const objectUpdates = this.getObjectEntry(url); return objectUpdates.pipe(map((objectEntry) => { @@ -63,6 +88,11 @@ export class ObjectUpdatesService { })) } + /** + * Method to check if a specific field is currently editable in the store + * @param url The URL of the page on which the field resides + * @param uuid The UUID of the field + */ isEditable(url: string, uuid: string): Observable { const objectUpdates = this.getObjectEntry(url); return objectUpdates.pipe( @@ -72,34 +102,74 @@ export class ObjectUpdatesService { ) } + /** + * Calls the saveFieldUpdate method with FieldChangeType.ADD + * @param url The page's URL for which the changes are saved + * @param field An updated field for the page's object + */ saveAddFieldUpdate(url: string, field: Identifiable) { this.saveFieldUpdate(url, field, FieldChangeType.ADD); } + /** + * Calls the saveFieldUpdate method with FieldChangeType.REMOVE + * @param url The page's URL for which the changes are saved + * @param field An updated field for the page's object + */ saveRemoveFieldUpdate(url: string, field: Identifiable) { this.saveFieldUpdate(url, field, FieldChangeType.REMOVE); } + /** + * Calls the saveFieldUpdate method with FieldChangeType.UPDATE + * @param url The page's URL for which the changes are saved + * @param field An updated field for the page's object + */ saveChangeFieldUpdate(url: string, field: Identifiable) { this.saveFieldUpdate(url, field, FieldChangeType.UPDATE); } + /** + * Dispatches a SetEditableFieldUpdateAction to the store to set a field's editable state + * @param url The URL of the page on which the field resides + * @param uuid The UUID of the field that should be set + * @param editable The new value of editable in the store for this field + */ setEditableFieldUpdate(url: string, uuid: string, editable: boolean) { this.store.dispatch(new SetEditableFieldUpdateAction(url, uuid, editable)); } + /** + * Method to dispatch an DiscardObjectUpdatesAction to the store + * @param url The page's URL for which the changes should be discarded + * @param undoNotification The notification which is should possibly be canceled + */ discardFieldUpdates(url: string, undoNotification: INotification) { this.store.dispatch(new DiscardObjectUpdatesAction(url, undoNotification)); } + /** + * Method to dispatch an ReinstateObjectUpdatesAction to the store + * @param url The page's URL for which the changes should be reinstated + */ reinstateFieldUpdates(url: string) { this.store.dispatch(new ReinstateObjectUpdatesAction(url)); } + /** + * Method to dispatch an RemoveFieldUpdateAction to the store + * @param url The page's URL for which the changes should be removed + */ removeSingleFieldUpdate(url: string, uuid) { this.store.dispatch(new RemoveFieldUpdateAction(url, uuid)); } + /** + * Method that combines the state's updates with the initial values (when there's no update) to create + * a list of updates fields + * @param url The URL of the page for which the updated fields should be requested + * @param initialFields The initial values of the fields + */ getUpdatedFields(url: string, initialFields: Identifiable[]): Observable { const objectUpdates = this.getObjectEntry(url); return objectUpdates.pipe(map((objectEntry) => { @@ -120,14 +190,26 @@ export class ObjectUpdatesService { })) } + /** + * Checks if the page currently has updates in the store or not + * @param url The page's url to check for in the store + */ hasUpdates(url: string): Observable { return this.getObjectEntry(url).pipe(map((objectEntry) => hasValue(objectEntry) && isNotEmpty(objectEntry.fieldUpdates))); } - isReinstatable(route: string): Observable { - return this.hasUpdates(route + OBJECT_UPDATES_TRASH_PATH) + /** + * Checks if the page currently is reinstatable in the store or not + * @param url The page's url to check for in the store + */ + isReinstatable(url: string): Observable { + return this.hasUpdates(url + OBJECT_UPDATES_TRASH_PATH) } + /** + * Request the current lastModified date stored for the updates in the store + * @param url The page's url to check for in the store + */ getLastModified(url: string): Observable { return this.getObjectEntry(url).pipe(map((entry: ObjectUpdatesEntry) => entry.lastModified)); } diff --git a/src/app/shared/input-suggestions/input-suggestions.component.html b/src/app/shared/input-suggestions/input-suggestions.component.html index 2ee80e576a..b620f4b79a 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.html +++ b/src/app/shared/input-suggestions/input-suggestions.component.html @@ -10,7 +10,7 @@ [ngModelOptions]="{standalone: true}" autocomplete="off"/>
-
+
diff --git a/src/app/shared/input-suggestions/input-suggestions.component.spec.ts b/src/app/shared/input-suggestions/input-suggestions.component.spec.ts index 8b6cdd2aa5..1f16a84b2c 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.spec.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.spec.ts @@ -77,7 +77,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the last element ', () => { - const lastLink = de.query(By.css('.list-unstyled > li:last-child a')); + const lastLink = de.query(By.css('.dropdown-list > div:last-child a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(lastLink.nativeElement); }); @@ -103,7 +103,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the first element ', () => { - const firstLink = de.query(By.css('.list-unstyled > li:first-child a')); + const firstLink = de.query(By.css('.dropdown-list > div:first-child a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(firstLink.nativeElement); }); @@ -117,7 +117,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the second element', () => { - const secondLink = de.query(By.css('.list-unstyled > li:nth-child(2) a')); + const secondLink = de.query(By.css('.dropdown-list > div:nth-child(2) a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(secondLink.nativeElement); }); @@ -126,7 +126,7 @@ describe('InputSuggestionsComponent', () => { describe('when the first element is in focus', () => { beforeEach(() => { - const firstLink = de.query(By.css('.list-unstyled > li:first-child a')); + const firstLink = de.query(By.css('.dropdown-list > div:first-child a')); firstLink.nativeElement.focus(); comp.selectedIndex = 0; fixture.detectChanges(); @@ -140,7 +140,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the last element ', () => { - const lastLink = de.query(By.css('.list-unstyled > li:last-child a')); + const lastLink = de.query(By.css('.dropdown-list > div:last-child a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(lastLink.nativeElement); }); @@ -153,7 +153,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the second element ', () => { - const secondLink = de.query(By.css('.list-unstyled > li:nth-child(2) a')); + const secondLink = de.query(By.css('.dropdown-list > div:nth-child(2) a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(secondLink.nativeElement); }); @@ -162,7 +162,7 @@ describe('InputSuggestionsComponent', () => { describe('when the last element is in focus', () => { beforeEach(() => { - const lastLink = de.query(By.css('.list-unstyled > li:last-child a')); + const lastLink = de.query(By.css('.dropdown-list > div:last-child a')); lastLink.nativeElement.focus(); comp.selectedIndex = suggestions.length - 1; fixture.detectChanges(); @@ -176,7 +176,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the second last element ', () => { - const secondLastLink = de.query(By.css('.list-unstyled > li:nth-last-child(2) a')); + const secondLastLink = de.query(By.css('.dropdown-list > div:nth-last-child(2) a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(secondLastLink.nativeElement); }); @@ -189,7 +189,7 @@ describe('InputSuggestionsComponent', () => { }); it('should put the focus on the first element ', () => { - const firstLink = de.query(By.css('.list-unstyled > li:first-child a')); + const firstLink = de.query(By.css('.dropdown-list > div:first-child a')); const activeElement = el.ownerDocument.activeElement; expect(activeElement).toEqual(firstLink.nativeElement); }); @@ -294,7 +294,7 @@ describe('InputSuggestionsComponent', () => { const clickedIndex = 0; beforeEach(() => { spyOn(comp, 'onClickSuggestion'); - const clickedLink = de.query(By.css('.list-unstyled > li:nth-child(' + (clickedIndex + 1) + ') a')); + const clickedLink = de.query(By.css('.dropdown-list > div:nth-child(' + (clickedIndex + 1) + ') a')); clickedLink.triggerEventHandler('click', {} ); fixture.detectChanges(); }); diff --git a/src/app/shared/input-suggestions/input-suggestions.component.ts b/src/app/shared/input-suggestions/input-suggestions.component.ts index b9f068b30f..434a285818 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.ts @@ -207,9 +207,11 @@ export class InputSuggestionsComponent implements ControlValueAccessor { } registerOnTouched(fn: any): void { + /* no implementation */ } setDisabledState(isDisabled: boolean): void { + /* no implementation */ } writeValue(value: any): void { From 714811dc0761db42f029466d395d909deeced547 Mon Sep 17 00:00:00 2001 From: lotte Date: Tue, 12 Feb 2019 12:48:32 +0100 Subject: [PATCH 06/18] 59334: added validation --- resources/i18n/en.json | 7 +++ .../edit-in-place-field.component.html | 16 +++++-- .../edit-in-place-field.component.scss | 1 + .../edit-in-place-field.component.ts | 39 +++++++++++---- .../item-metadata.component.scss | 5 ++ .../item-metadata/item-metadata.component.ts | 47 ++++++++++++------- .../+item-page/item-page-routing.module.ts | 2 +- src/app/core/core.reducers.ts | 6 +-- .../object-updates/object-updates.actions.ts | 28 +++++++++++ .../object-updates/object-updates.reducer.ts | 42 +++++++++++++---- .../object-updates/object-updates.service.ts | 40 +++++++++++++++- .../comcol-form/comcol-form.component.html | 2 +- .../comcol-form/comcol-form.component.spec.ts | 12 +++-- .../comcol-form/comcol-form.component.ts | 4 ++ .../input-suggestions.component.ts | 18 +++++-- src/app/shared/utils/validator.functions.ts | 7 +++ src/styles/_custom_variables.scss | 2 + 17 files changed, 226 insertions(+), 52 deletions(-) create mode 100644 src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss create mode 100644 src/app/shared/utils/validator.functions.ts diff --git a/resources/i18n/en.json b/resources/i18n/en.json index cd7e1276f1..795b3cc747 100644 --- a/resources/i18n/en.json +++ b/resources/i18n/en.json @@ -233,6 +233,9 @@ "language": "Lang", "edit": "Edit" }, + "metadatafield": { + "invalid": "Please choose a valid metadata field" + }, "notifications": { "outdated": { "title": "Changed outdated", @@ -241,6 +244,10 @@ "discarded": { "title": "Changed discarded", "content": "Your changes were discarded. To reinstate your changes click the 'Undo' button" + }, + "invalid": { + "title": "Metadata invalid", + "content": "Please make sure all fields are valid" } } } diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html index 279552565c..51f4c650af 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -13,10 +13,14 @@ [(ngModel)]="metadata.key" (submitSuggestion)="update()" (clickSuggestion)="update()" + (typeSuggestion)="update()" (findSuggestions)="findMetadataFieldSuggestions($event)" + [formControl]="formControl" ngDefaultControl >
+ {{"item.edit.metadata.metadatafield.invalid" | translate}}
@@ -38,10 +42,14 @@
- - - - + + + +
\ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss index e69de29bb2..3575cae797 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss @@ -0,0 +1 @@ +@import '../../../../../styles/variables.scss'; diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index 38470c54c4..b85b558cfd 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -11,6 +11,9 @@ import { FieldChangeType } from '../../../../core/data/object-updates/object-upd import { of as observableOf } from 'rxjs'; import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; +import { inListValidator } from '../../../../shared/utils/validator.functions'; +import { getSucceededRemoteData } from '../../../../core/shared/operators'; +import { FormControl, ValidationErrors, ValidatorFn } from '@angular/forms'; @Component({ selector: 'ds-edit-in-place-field', @@ -21,7 +24,6 @@ import { ObjectUpdatesService } from '../../../../core/data/object-updates/objec * Component that displays a single metadatum of an item on the edit page */ export class EditInPlaceFieldComponent implements OnInit, OnChanges { - /** * The current field, value and state of the metadatum */ @@ -39,22 +41,43 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { */ editable: Observable; + /** + * Emits whether or not this field is currently valid + */ + valid: Observable; + /** * The current suggestions for the metadatafield when editing */ metadataFieldSuggestions: BehaviorSubject = new BehaviorSubject([]); + formControl: FormControl; + constructor( private metadataFieldService: RegistryService, private objectUpdatesService: ObjectUpdatesService, ) { } + /** + * Sets up an observable that keeps track of the current editable and valid state of this field + * Also creates a form control object for the input suggestions + */ + ngOnInit(): void { + this.editable = this.objectUpdatesService.isEditable(this.route, this.metadata.uuid); + this.valid = this.objectUpdatesService.isValid(this.route, this.metadata.uuid); + this.findMetadataFields().pipe(take(1)).subscribe((metadataFields: string[]) => { + const validator = inListValidator(metadataFields); + this.formControl = new FormControl('', validator); + }); + } + /** * Sends a new change update for this field to the object updates service */ update() { this.objectUpdatesService.saveChangeFieldUpdate(this.route, this.metadata); + this.objectUpdatesService.setValidFieldUpdate(this.route, this.metadata.uuid, this.formControl.valid); } /** @@ -79,13 +102,6 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { this.objectUpdatesService.removeSingleFieldUpdate(this.route, this.metadata.uuid); } - /** - * Sets up an observable that keeps track of the current editable state of this field - */ - ngOnInit(): void { - this.editable = this.objectUpdatesService.isEditable(this.route, this.metadata.uuid); - } - /** * Sets the current metadatafield based on the fieldUpdate input field */ @@ -115,6 +131,13 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { ); } + findMetadataFields(): Observable { + return this.metadataFieldService.getAllMetadataFields().pipe( + getSucceededRemoteData(), + take(1), + map((remoteData$) => remoteData$.payload.page.map((field: MetadataField) => field.toString()))); + } + /** * Check if a user should be allowed to edit this field * @return an observable that emits true when the user should be able to edit this field and false when they should not diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss new file mode 100644 index 0000000000..b2994dcec7 --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss @@ -0,0 +1,5 @@ +@import '../../../../styles/variables.scss'; + +.button-row .btn { + min-width: $button-min-width; +} \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index d2231e615d..ae32028486 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -11,7 +11,7 @@ import { Identifiable } from '../../../core/data/object-updates/object-updates.reducer'; import { Metadatum } from '../../../core/shared/metadatum.model'; -import { first, switchMap, tap } from 'rxjs/operators'; +import { first, map, switchMap, tap } from 'rxjs/operators'; import { getSucceededRemoteData } from '../../../core/shared/operators'; import { RemoteData } from '../../../core/data/remote-data'; import { NotificationsService } from '../../../shared/notifications/notifications.service'; @@ -20,6 +20,7 @@ import { TranslateService } from '@ngx-translate/core'; @Component({ selector: 'ds-item-metadata', + styleUrls: ['./item-metadata.component.scss'], templateUrl: './item-metadata.component.html', }) /** @@ -114,22 +115,30 @@ export class ItemMetadataComponent implements OnInit { * Makes sure the new version of the item is rendered on the page */ submit() { - const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.route, this.item.metadata) as Observable; - metadata$.pipe( - first(), - switchMap((metadata: Metadatum[]) => { - const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); - return this.itemService.update(updatedItem); - }), - tap(() => this.itemService.commitUpdates()), - getSucceededRemoteData() - ).subscribe( - (rd: RemoteData) => { - this.item = rd.payload; - this.initializeOriginalFields(); - this.updates$ = this.objectUpdatesService.getFieldUpdates(this.route, this.item.metadata); - } - ) + this.isValid().pipe(first()).subscribe((isValid) => { + if (isValid) { + const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.route, this.item.metadata) as Observable; + metadata$.pipe( + first(), + switchMap((metadata: Metadatum[]) => { + const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); + return this.itemService.update(updatedItem); + }), + tap(() => this.itemService.commitUpdates()), + getSucceededRemoteData() + ).subscribe( + (rd: RemoteData) => { + this.item = rd.payload; + this.initializeOriginalFields(); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.route, this.item.metadata); + } + ) + } else { + const title = this.translateService.instant('item.edit.metadata.notifications.invalid.title'); + const content = this.translateService.instant('item.edit.metadata.notifications.invalid.content'); + this.notificationsService.error(title, content); + } + }); } /** @@ -163,4 +172,8 @@ export class ItemMetadataComponent implements OnInit { } ); } + + private isValid() { + return this.objectUpdatesService.isValidPage(this.route); + } } diff --git a/src/app/+item-page/item-page-routing.module.ts b/src/app/+item-page/item-page-routing.module.ts index 1ce4f3ad88..0f2f0817f6 100644 --- a/src/app/+item-page/item-page-routing.module.ts +++ b/src/app/+item-page/item-page-routing.module.ts @@ -38,7 +38,7 @@ const ITEM_EDIT_PATH = ':id/edit'; { path: ITEM_EDIT_PATH, loadChildren: './edit-item-page/edit-item-page.module#EditItemPageModule', - canActivate: [AuthenticatedGuard] + // canActivate: [AuthenticatedGuard] } ]) ], diff --git a/src/app/core/core.reducers.ts b/src/app/core/core.reducers.ts index 760d3ddeaf..e0ddb4a9de 100644 --- a/src/app/core/core.reducers.ts +++ b/src/app/core/core.reducers.ts @@ -1,8 +1,6 @@ import { ActionReducerMap, createFeatureSelector, - createSelector, - MemoizedSelector } from '@ngrx/store'; import { objectCacheReducer, ObjectCacheState } from './cache/object-cache.reducer'; @@ -14,8 +12,6 @@ import { objectUpdatesReducer, ObjectUpdatesState } from './data/object-updates/object-updates.reducer'; -import { hasValue } from '../shared/empty.util'; -import { AppState } from '../app.reducer'; export interface CoreState { 'cache/object': ObjectCacheState, @@ -35,4 +31,4 @@ export const coreReducers: ActionReducerMap = { 'auth': authReducer, }; -export const coreSelector = createFeatureSelector('core'); \ No newline at end of file +export const coreSelector = createFeatureSelector('core'); diff --git a/src/app/core/data/object-updates/object-updates.actions.ts b/src/app/core/data/object-updates/object-updates.actions.ts index 5f76d6dde9..c1b35d07b4 100644 --- a/src/app/core/data/object-updates/object-updates.actions.ts +++ b/src/app/core/data/object-updates/object-updates.actions.ts @@ -9,6 +9,7 @@ import { INotification } from '../../../shared/notifications/models/notification export const ObjectUpdatesActionTypes = { INITIALIZE_FIELDS: type('dspace/core/cache/object-updates/INITIALIZE_FIELDS'), SET_EDITABLE_FIELD: type('dspace/core/cache/object-updates/SET_EDITABLE_FIELD'), + SET_VALID_FIELD: type('dspace/core/cache/object-updates/SET_VALID_FIELD'), ADD_FIELD: type('dspace/core/cache/object-updates/ADD_FIELD'), DISCARD: type('dspace/core/cache/object-updates/DISCARD'), REINSTATE: type('dspace/core/cache/object-updates/REINSTATE'), @@ -109,6 +110,33 @@ export class SetEditableFieldUpdateAction implements Action { } } +/** + * An ngrx action to set the isValid state of an existing field in the ObjectUpdates state for a certain page url + */ +export class SetValidFieldUpdateAction implements Action { + type = ObjectUpdatesActionTypes.SET_VALID_FIELD; + payload: { + url: string, + uuid: string, + isValid: boolean, + }; + + /** + * Create a new SetEditableFieldUpdateAction + * + * @param url + * the unique url of the page + * @param fieldUUID The UUID of the field of which + * @param isValid The new isValid value for the field + */ + constructor( + url: string, + fieldUUID: string, + isValid: boolean) { + this.payload = { url, uuid: fieldUUID, isValid }; + } +} + /** * An ngrx action to discard all existing updates in the ObjectUpdates state for a certain page url */ diff --git a/src/app/core/data/object-updates/object-updates.reducer.ts b/src/app/core/data/object-updates/object-updates.reducer.ts index c46438bd90..dad394e84f 100644 --- a/src/app/core/data/object-updates/object-updates.reducer.ts +++ b/src/app/core/data/object-updates/object-updates.reducer.ts @@ -7,7 +7,7 @@ import { ObjectUpdatesActionTypes, ReinstateObjectUpdatesAction, RemoveFieldUpdateAction, - RemoveObjectUpdatesAction, SetEditableFieldUpdateAction + RemoveObjectUpdatesAction, SetEditableFieldUpdateAction, SetValidFieldUpdateAction } from './object-updates.actions'; import { hasNoValue, hasValue } from '../../../shared/empty.util'; @@ -15,7 +15,8 @@ export const OBJECT_UPDATES_TRASH_PATH = '/trash'; export interface FieldState { editable: boolean, - isNew: boolean + isNew: boolean, + isValid: boolean } export interface FieldStates { @@ -46,8 +47,8 @@ export interface ObjectUpdatesState { [url: string]: ObjectUpdatesEntry; } -const initialFieldState = { editable: false, isNew: false }; -const initialNewFieldState = { editable: true, isNew: true }; +const initialFieldState = { editable: false, isNew: false, isValid: true }; +const initialNewFieldState = { editable: true, isNew: true, isValid: true }; // Object.create(null) ensures the object has no default js properties (e.g. `__proto__`) const initialState = Object.create(null); @@ -80,6 +81,9 @@ export function objectUpdatesReducer(state = initialState, action: ObjectUpdates case ObjectUpdatesActionTypes.SET_EDITABLE_FIELD: { return setEditableFieldUpdate(state, action as SetEditableFieldUpdateAction); } + case ObjectUpdatesActionTypes.SET_VALID_FIELD: { + return setValidFieldUpdate(state, action as SetValidFieldUpdateAction); + } default: { return state; } @@ -147,8 +151,8 @@ function discardObjectUpdates(state: any, action: DiscardObjectUpdatesAction) { Object.keys(pageState.fieldStates).forEach((uuid: string) => { const fieldState: FieldState = pageState.fieldStates[uuid]; if (!fieldState.isNew) { - /* After discarding we don't want the reset fields to stay editable */ - newFieldStates[uuid] = Object.assign({}, fieldState, { editable: false }); + /* After discarding we don't want the reset fields to stay editable or invalid */ + newFieldStates[uuid] = Object.assign({}, fieldState, { editable: false, isValid: true }); } }); @@ -215,7 +219,7 @@ function removeFieldUpdate(state: any, action: RemoveFieldUpdateAction) { /* If this field was added, just throw it away */ delete newFieldStates[uuid]; } else { - newFieldStates[uuid] = Object.assign({}, newFieldStates[uuid], { editable: false }); + newFieldStates[uuid] = Object.assign({}, newFieldStates[uuid], { editable: false, isValid: true }); } } newPageState = Object.assign({}, state[url], { @@ -243,7 +247,7 @@ function determineChangeType(oldType: FieldChangeType, newType: FieldChangeType) } /** - * Set the state of a specific action's url and uuid to false or true + * Set the editable state of a specific action's url and uuid to false or true * @param state The current state * @param action The action to perform on the current state */ @@ -264,6 +268,28 @@ function setEditableFieldUpdate(state: any, action: SetEditableFieldUpdateAction return Object.assign({}, state, { [url]: newPageState }); } +/** + * Set the isValid state of a specific action's url and uuid to false or true + * @param state The current state + * @param action The action to perform on the current state + */ +function setValidFieldUpdate(state: any, action: SetValidFieldUpdateAction) { + const url: string = action.payload.url; + const uuid: string = action.payload.uuid; + const isValid: boolean = action.payload.isValid; + + const pageState: ObjectUpdatesEntry = state[url]; + + const fieldState = pageState.fieldStates[uuid]; + const newFieldState = Object.assign({}, fieldState, { isValid }); + + const newFieldStates = Object.assign({}, pageState.fieldStates, { [uuid]: newFieldState }); + + const newPageState = Object.assign({}, pageState, { fieldStates: newFieldStates }); + + return Object.assign({}, state, { [url]: newPageState }); +} + /** * Method to create an initial FieldStates object based on a list of Identifiable objects * @param fields Identifiable objects diff --git a/src/app/core/data/object-updates/object-updates.service.ts b/src/app/core/data/object-updates/object-updates.service.ts index 4b6c7def0d..6136d31ac0 100644 --- a/src/app/core/data/object-updates/object-updates.service.ts +++ b/src/app/core/data/object-updates/object-updates.service.ts @@ -2,6 +2,7 @@ import { Injectable } from '@angular/core'; import { createSelector, MemoizedSelector, select, Store } from '@ngrx/store'; import { coreSelector, CoreState } from '../../core.reducers'; import { + FieldState, FieldUpdates, Identifiable, OBJECT_UPDATES_TRASH_PATH, ObjectUpdatesEntry, @@ -15,7 +16,7 @@ import { InitializeFieldsAction, ReinstateObjectUpdatesAction, RemoveFieldUpdateAction, - SetEditableFieldUpdateAction + SetEditableFieldUpdateAction, SetValidFieldUpdateAction } from './object-updates.actions'; import { filter, map } from 'rxjs/operators'; import { hasNoValue, hasValue, isEmpty, isNotEmpty } from '../../../shared/empty.util'; @@ -102,6 +103,33 @@ export class ObjectUpdatesService { ) } + /** + * Method to check if a specific field is currently valid in the store + * @param url The URL of the page on which the field resides + * @param uuid The UUID of the field + */ + isValid(url: string, uuid: string): Observable { + const objectUpdates = this.getObjectEntry(url); + return objectUpdates.pipe( + filter((objectEntry) => hasValue(objectEntry.fieldStates[uuid])), + map((objectEntry) => objectEntry.fieldStates[uuid].isValid + ) + ) + } + + /** + * Method to check if a specific page is currently valid in the store + * @param url The URL of the page + */ + isValidPage(url: string): Observable { + const objectUpdates = this.getObjectEntry(url); + return objectUpdates.pipe( + map((entry: ObjectUpdatesEntry) => { + return Object.values(entry.fieldStates).findIndex((state: FieldState) => !state.isValid) < 0 + }) + ) + } + /** * Calls the saveFieldUpdate method with FieldChangeType.ADD * @param url The page's URL for which the changes are saved @@ -139,6 +167,16 @@ export class ObjectUpdatesService { this.store.dispatch(new SetEditableFieldUpdateAction(url, uuid, editable)); } + /** + * Dispatches a SetValidFieldUpdateAction to the store to set a field's isValid state + * @param url The URL of the page on which the field resides + * @param uuid The UUID of the field that should be set + * @param valid The new value of isValid in the store for this field + */ + setValidFieldUpdate(url: string, uuid: string, valid: boolean) { + this.store.dispatch(new SetValidFieldUpdateAction(url, uuid, valid)); + } + /** * Method to dispatch an DiscardObjectUpdatesAction to the store * @param url The page's URL for which the changes should be discarded diff --git a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.html b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.html index 720ad0c1cf..6c67937063 100644 --- a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.html +++ b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.html @@ -1,3 +1,3 @@ + [formModel]="formModel" (submitForm)="onSubmit()" (cancel)="onCancel()"> diff --git a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.spec.ts b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.spec.ts index a6f5e0d45a..51c5928348 100644 --- a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.spec.ts +++ b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.spec.ts @@ -50,10 +50,7 @@ describe('ComColFormComponent', () => { ]; /* tslint:disable:no-empty */ - const locationStub = { - back: () => { - } - }; + const locationStub = jasmine.createSpyObj('location', ['back']); /* tslint:enable:no-empty */ beforeEach(async(() => { @@ -112,4 +109,11 @@ describe('ComColFormComponent', () => { ); }) }); + + describe('onCancel', () => { + it('should call the back method on the Location service', () => { + comp.onCancel(); + expect(locationStub.back).toHaveBeenCalled(); + }); + }); }); diff --git a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts index 17710fd1c6..a7d638e791 100644 --- a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts +++ b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts @@ -112,4 +112,8 @@ export class ComColFormComponent implements OnInit { } ); } + + onCancel() { + this.location.back(); + } } diff --git a/src/app/shared/input-suggestions/input-suggestions.component.ts b/src/app/shared/input-suggestions/input-suggestions.component.ts index 434a285818..afb405a60a 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.ts @@ -1,9 +1,13 @@ import { Component, - ElementRef, EventEmitter, forwardRef, + ElementRef, + EventEmitter, + forwardRef, Input, + OnChanges, Output, - QueryList, SimpleChanges, + QueryList, + SimpleChanges, ViewChild, ViewChildren } from '@angular/core'; @@ -19,6 +23,8 @@ import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms'; providers: [ { provide: NG_VALUE_ACCESSOR, + // Usage of forwardRef necessary https://github.com/angular/angular.io/issues/1151 + // tslint:disable-next-line:no-forward-ref useExisting: forwardRef(() => InputSuggestionsComponent), multi: true } @@ -28,7 +34,7 @@ import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms'; /** * Component representing a form with a autocomplete functionality */ -export class InputSuggestionsComponent implements ControlValueAccessor { +export class InputSuggestionsComponent implements ControlValueAccessor, OnChanges { /** * The suggestions that should be shown */ @@ -64,6 +70,11 @@ export class InputSuggestionsComponent implements ControlValueAccessor { */ @Output() clickSuggestion = new EventEmitter(); + /** + * Output for when something is typed in the input field + */ + @Output() typeSuggestion = new EventEmitter(); + /** * Output for when new suggestions should be requested */ @@ -195,6 +206,7 @@ export class InputSuggestionsComponent implements ControlValueAccessor { this.findSuggestions.emit(data); } this.blockReopen = false; + this.typeSuggestion.emit(data); } onSubmit(data) { diff --git a/src/app/shared/utils/validator.functions.ts b/src/app/shared/utils/validator.functions.ts new file mode 100644 index 0000000000..55fe498747 --- /dev/null +++ b/src/app/shared/utils/validator.functions.ts @@ -0,0 +1,7 @@ +import { AbstractControl, ValidatorFn } from '@angular/forms'; + +export function inListValidator(list: string[]): ValidatorFn { + return (control: AbstractControl): {[key: string]: any} | null => { + const contains = list.indexOf(control.value) > 0; + return contains ? null : {inList: {value: control.value}} }; +} diff --git a/src/styles/_custom_variables.scss b/src/styles/_custom_variables.scss index e8d839826d..dda018ad2c 100644 --- a/src/styles/_custom_variables.scss +++ b/src/styles/_custom_variables.scss @@ -1,6 +1,8 @@ $content-spacing: $spacer * 1.5; $button-height: $input-btn-padding-y * 2 + $input-btn-line-height + calculateRem($input-btn-border-width*2); +$button-min-width: 100px; + $card-height-percentage:98%; $card-thumbnail-height:240px; $dropdown-menu-max-height: 200px; From 7eec961fa78a37d03f016eebad6cc0fe8451038c Mon Sep 17 00:00:00 2001 From: lotte Date: Wed, 13 Feb 2019 11:39:32 +0100 Subject: [PATCH 07/18] 59334: edit item metadata finished --- .../metadata-schema-form.component.spec.ts | 3 +- .../metadata-field-form.component.spec.ts | 3 +- .../edit-in-place-field.component.html | 37 ++++---- .../edit-in-place-field.component.spec.ts | 95 +++++++++++++------ .../edit-in-place-field.component.ts | 27 +++--- .../item-metadata.component.html | 4 +- .../item-metadata.component.spec.ts | 3 +- .../object-updates/object-updates.actions.ts | 2 +- .../object-updates.reducer.spec.ts | 46 ++++++--- .../object-updates.service.spec.ts | 31 +++++- .../object-updates/object-updates.service.ts | 38 +++++--- src/app/shared/shared.module.ts | 4 +- .../utils/in-list-validator.directive.ts | 32 +++++++ src/app/shared/utils/validator.functions.ts | 6 +- 14 files changed, 233 insertions(+), 98 deletions(-) create mode 100644 src/app/shared/utils/in-list-validator.directive.ts diff --git a/src/app/+admin/admin-registries/metadata-registry/metadata-schema-form/metadata-schema-form.component.spec.ts b/src/app/+admin/admin-registries/metadata-registry/metadata-schema-form/metadata-schema-form.component.spec.ts index 02cf168387..42b6d1f133 100644 --- a/src/app/+admin/admin-registries/metadata-registry/metadata-schema-form/metadata-schema-form.component.spec.ts +++ b/src/app/+admin/admin-registries/metadata-registry/metadata-schema-form/metadata-schema-form.component.spec.ts @@ -20,7 +20,8 @@ describe('MetadataSchemaFormComponent', () => { /* tslint:disable:no-empty */ const registryServiceStub = { getActiveMetadataSchema: () => observableOf(undefined), - createOrUpdateMetadataSchema: (schema: MetadataSchema) => observableOf(schema) + createOrUpdateMetadataSchema: (schema: MetadataSchema) => observableOf(schema), + cancelEditMetadataSchema: () => {} }; const formBuilderServiceStub = { createFormGroup: () => { diff --git a/src/app/+admin/admin-registries/metadata-schema/metadata-field-form/metadata-field-form.component.spec.ts b/src/app/+admin/admin-registries/metadata-schema/metadata-field-form/metadata-field-form.component.spec.ts index 25502a27c8..4364b0234a 100644 --- a/src/app/+admin/admin-registries/metadata-schema/metadata-field-form/metadata-field-form.component.spec.ts +++ b/src/app/+admin/admin-registries/metadata-schema/metadata-field-form/metadata-field-form.component.spec.ts @@ -27,7 +27,8 @@ describe('MetadataFieldFormComponent', () => { /* tslint:disable:no-empty */ const registryServiceStub = { getActiveMetadataField: () => observableOf(undefined), - createOrUpdateMetadataField: (field: MetadataField) => observableOf(field) + createOrUpdateMetadataField: (field: MetadataField) => observableOf(field), + cancelEditMetadataSchema: () => {}, }; const formBuilderServiceStub = { createFormGroup: () => { diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html index 51f4c650af..e4fdc60a1e 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -1,3 +1,4 @@ +
{{"item.edit.metadata.metadatafield.invalid" | translate}} - +
{{metadata?.value}}
@@ -40,16 +41,20 @@ (onDebounce)="update()"/>
- -
- - - - + +
+ + + +
\ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index aad94931dd..927a4a96b1 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -16,6 +16,7 @@ import { InputSuggestion } from '../../../../shared/input-suggestions/input-sugg import { TestScheduler } from 'rxjs/testing'; import { MetadataSchema } from '../../../../core/metadata/metadataschema.model'; import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; +import { TranslateModule } from '@ngx-translate/core'; let comp: EditInPlaceFieldComponent; let fixture: ComponentFixture; @@ -58,20 +59,23 @@ describe('EditInPlaceFieldComponent', () => { paginatedMetadataFields = new PaginatedList(undefined, [mdField1, mdField2, mdField3]); metadataFieldService = jasmine.createSpyObj({ - queryMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)) + queryMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)), + getAllMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)) }); objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', { saveChangeFieldUpdate: {}, saveRemoveFieldUpdate: {}, setEditableFieldUpdate: {}, + setValidFieldUpdate: {}, removeSingleFieldUpdate: {}, - isEditable: observableOf(false) // should always return something --> its in ngOnInit + isEditable: observableOf(false), // should always return something --> its in ngOnInit + isValid: observableOf(true) // should always return something --> its in ngOnInit } ); TestBed.configureTestingModule({ - imports: [FormsModule, SharedModule], + imports: [FormsModule, SharedModule, TranslateModule.forRoot()], declarations: [EditInPlaceFieldComponent], providers: [ { provide: RegistryService, useValue: metadataFieldService }, @@ -170,13 +174,27 @@ describe('EditInPlaceFieldComponent', () => { }); }); - describe('remove', () => { + describe('isValid is true', () => { beforeEach(() => { - comp.remove(); + comp.valid = observableOf(true); + fixture.detectChanges(); }); + it('the div should not contain an error message', () => { + const errorMessages = de.queryAll(By.css('small.text-danger')); + expect(errorMessages.length).toBe(0); + + }); + }); + + describe('isValid is false', () => { + beforeEach(() => { + comp.valid = observableOf(false); + fixture.detectChanges(); + }); + it('the div should contain no input fields or textareas', () => { + const errorMessages = de.queryAll(By.css('small.text-danger')); + expect(errorMessages.length).toBeGreaterThan(0); - it('it should call saveRemoveFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { - expect(objectUpdatesService.saveRemoveFieldUpdate).toHaveBeenCalledWith(route, metadatum); }); }); @@ -190,6 +208,16 @@ describe('EditInPlaceFieldComponent', () => { }); }); + describe('removeChangesFromField', () => { + beforeEach(() => { + comp.removeChangesFromField(); + }); + + it('it should call removeChangesFromField on the objectUpdatesService with the correct route and uuid', () => { + expect(objectUpdatesService.removeSingleFieldUpdate).toHaveBeenCalledWith(route, metadatum.uuid); + }); + }); + describe('findMetadataFieldSuggestions', () => { const query = 'query string'; @@ -281,44 +309,49 @@ describe('EditInPlaceFieldComponent', () => { describe('when canSetEditable emits true', () => { beforeEach(() => { + comp.editable = observableOf(false); spyOn(comp, 'canSetEditable').and.returnValue(observableOf(true)); + fixture.detectChanges(); }); - it('the div should contain a edit icon', () => { - const editIcon = de.query(By.css('i.fa-edit')); - expect(editIcon).not.toBeNull(); + it('the div should have an enabled button with an edit icon', () => { + const editIcon = de.query(By.css('i.fa-edit')).parent.nativeElement.disabled; + expect(editIcon).toBe(false); }); }); describe('when canSetEditable emits false', () => { beforeEach(() => { + comp.editable = observableOf(false); spyOn(comp, 'canSetEditable').and.returnValue(observableOf(false)); fixture.detectChanges(); }); - it('the div should not contain a edit icon', () => { - const editIcon = de.query(By.css('i.fa-edit')); - expect(editIcon).toBeNull(); + it('the div should have a disabled button with an edit icon', () => { + const editIcon = de.query(By.css('i.fa-edit')).parent.nativeElement.disabled; + expect(editIcon).toBe(true); }); }); describe('when canSetUneditable emits true', () => { beforeEach(() => { + comp.editable = observableOf(true); spyOn(comp, 'canSetUneditable').and.returnValue(observableOf(true)); fixture.detectChanges(); }); - it('the div should contain a check icon', () => { - const checkIcon = de.query(By.css('i.fa-check')); - expect(checkIcon).not.toBeNull(); + it('the div should have an enabled button with a check icon', () => { + const checkButtonAttrs = de.query(By.css('i.fa-check')).parent.nativeElement.disabled; + expect(checkButtonAttrs).toBe(false); }); }); describe('when canSetUneditable emits false', () => { beforeEach(() => { + comp.editable = observableOf(true); spyOn(comp, 'canSetUneditable').and.returnValue(observableOf(false)); fixture.detectChanges(); }); - it('the div should not contain a check icon', () => { - const checkIcon = de.query(By.css('i.fa-check')); - expect(checkIcon).toBeNull(); + it('the div should have a disabled button with a check icon', () => { + const checkButtonAttrs = de.query(By.css('i.fa-check')).parent.nativeElement.disabled; + expect(checkButtonAttrs).toBe(true); }); }); @@ -327,9 +360,9 @@ describe('EditInPlaceFieldComponent', () => { spyOn(comp, 'canRemove').and.returnValue(observableOf(true)); fixture.detectChanges(); }); - it('the div should contain a trash icon', () => { - const trashIcon = de.query(By.css('i.fa-trash-alt')); - expect(trashIcon).not.toBeNull(); + it('the div should have an enabled button with a trash icon', () => { + const trashButtonAttrs = de.query(By.css('i.fa-trash-alt')).parent.nativeElement.disabled; + expect(trashButtonAttrs).toBe(false); }); }); @@ -338,9 +371,9 @@ describe('EditInPlaceFieldComponent', () => { spyOn(comp, 'canRemove').and.returnValue(observableOf(false)); fixture.detectChanges(); }); - it('the div should not contain a trash icon', () => { - const trashIcon = de.query(By.css('i.fa-trash-alt')); - expect(trashIcon).toBeNull(); + it('the div should have a disabled button with a trash icon', () => { + const trashButtonAttrs = de.query(By.css('i.fa-trash-alt')).parent.nativeElement.disabled; + expect(trashButtonAttrs).toBe(true); }); }); @@ -349,9 +382,9 @@ describe('EditInPlaceFieldComponent', () => { spyOn(comp, 'canUndo').and.returnValue(observableOf(true)); fixture.detectChanges(); }); - it('the div should contain a undo icon', () => { - const undoIcon = de.query(By.css('i.fa-undo-alt')); - expect(undoIcon).not.toBeNull(); + it('the div should have an enabled button with an undo icon', () => { + const undoIcon = de.query(By.css('i.fa-undo-alt')).parent.nativeElement.disabled; + expect(undoIcon).toBe(false); }); }); @@ -360,9 +393,9 @@ describe('EditInPlaceFieldComponent', () => { spyOn(comp, 'canUndo').and.returnValue(observableOf(false)); fixture.detectChanges(); }); - it('the div should not contain a undo icon', () => { - const undoIcon = de.query(By.css('i.fa-undo-alt')); - expect(undoIcon).toBeNull(); + it('the div should have a disabled button with an undo icon', () => { + const undoIcon = de.query(By.css('i.fa-undo-alt')).parent.nativeElement.disabled; + expect(undoIcon).toBe(true); }); }); diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index b85b558cfd..d0b35b7a82 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -1,19 +1,18 @@ import { Component, Input, OnChanges, OnInit } from '@angular/core'; -import { isNotEmpty } from '../../../../shared/empty.util'; +import { hasValue, isNotEmpty } from '../../../../shared/empty.util'; import { Metadatum } from '../../../../core/shared/metadatum.model'; import { RegistryService } from '../../../../core/registry/registry.service'; import { cloneDeep } from 'lodash'; -import { BehaviorSubject, Observable } from 'rxjs'; +import { BehaviorSubject, Observable, of as observableOf } from 'rxjs'; import { map, take } from 'rxjs/operators'; import { MetadataField } from '../../../../core/metadata/metadatafield.model'; import { InputSuggestion } from '../../../../shared/input-suggestions/input-suggestions.model'; import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; -import { of as observableOf } from 'rxjs'; import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; import { inListValidator } from '../../../../shared/utils/validator.functions'; import { getSucceededRemoteData } from '../../../../core/shared/operators'; -import { FormControl, ValidationErrors, ValidatorFn } from '@angular/forms'; +import { FormControl } from '@angular/forms'; @Component({ selector: 'ds-edit-in-place-field', @@ -51,7 +50,10 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { */ metadataFieldSuggestions: BehaviorSubject = new BehaviorSubject([]); - formControl: FormControl; + /** + * List of strings with all metadata field keys available + */ + metadataFields: Observable; constructor( private metadataFieldService: RegistryService, @@ -61,23 +63,21 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { /** * Sets up an observable that keeps track of the current editable and valid state of this field - * Also creates a form control object for the input suggestions */ ngOnInit(): void { this.editable = this.objectUpdatesService.isEditable(this.route, this.metadata.uuid); this.valid = this.objectUpdatesService.isValid(this.route, this.metadata.uuid); - this.findMetadataFields().pipe(take(1)).subscribe((metadataFields: string[]) => { - const validator = inListValidator(metadataFields); - this.formControl = new FormControl('', validator); - }); + this.metadataFields = this.findMetadataFields() } /** * Sends a new change update for this field to the object updates service */ - update() { + update(control?: FormControl) { this.objectUpdatesService.saveChangeFieldUpdate(this.route, this.metadata); - this.objectUpdatesService.setValidFieldUpdate(this.route, this.metadata.uuid, this.formControl.valid); + if (hasValue(control)) { + this.objectUpdatesService.setValidFieldUpdate(this.route, this.metadata.uuid, control.valid); + } } /** @@ -131,6 +131,9 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { ); } + /** + * Method to request all metadata fields and convert them to a list of strings + */ findMetadataFields(): Observable { return this.metadataFieldService.getAllMetadataFields().pipe( getSucceededRemoteData(), diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index bc8e52d48b..36d18372bd 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -26,9 +26,9 @@ {{'item.edit.metadata.headers.field' | translate}} - {{'item.edit.metadata.headers.value' | translate}} + {{'item.edit.metadata.headers.value' | translate}} {{'item.edit.metadata.headers.language' | translate}} - {{'item.edit.metadata.headers.edit' | translate}} + {{'item.edit.metadata.headers.edit' | translate}} { getUpdatedFields: observableOf([metadatum1, metadatum2, metadatum3]), getLastModified: observableOf(date), hasUpdates: observableOf(true), - isReinstatable: observableOf(false) // should always return something --> its in ngOnInit + isReinstatable: observableOf(false), // should always return something --> its in ngOnInit + isValidPage: observableOf(true) } ); diff --git a/src/app/core/data/object-updates/object-updates.actions.ts b/src/app/core/data/object-updates/object-updates.actions.ts index c1b35d07b4..7381188892 100644 --- a/src/app/core/data/object-updates/object-updates.actions.ts +++ b/src/app/core/data/object-updates/object-updates.actions.ts @@ -2,10 +2,10 @@ import { type } from '../../../shared/ngrx/type'; import { Action } from '@ngrx/store'; import { Identifiable } from './object-updates.reducer'; import { INotification } from '../../../shared/notifications/models/notification.model'; + /** * The list of ObjectUpdatesAction type definitions */ - export const ObjectUpdatesActionTypes = { INITIALIZE_FIELDS: type('dspace/core/cache/object-updates/INITIALIZE_FIELDS'), SET_EDITABLE_FIELD: type('dspace/core/cache/object-updates/SET_EDITABLE_FIELD'), diff --git a/src/app/core/data/object-updates/object-updates.reducer.spec.ts b/src/app/core/data/object-updates/object-updates.reducer.spec.ts index 377b3ab1b4..f5698b9b78 100644 --- a/src/app/core/data/object-updates/object-updates.reducer.spec.ts +++ b/src/app/core/data/object-updates/object-updates.reducer.spec.ts @@ -6,7 +6,7 @@ import { InitializeFieldsAction, ReinstateObjectUpdatesAction, RemoveFieldUpdateAction, RemoveObjectUpdatesAction, - SetEditableFieldUpdateAction + SetEditableFieldUpdateAction, SetValidFieldUpdateAction } from './object-updates.actions'; import { OBJECT_UPDATES_TRASH_PATH, objectUpdatesReducer } from './object-updates.reducer'; @@ -54,22 +54,25 @@ describe('objectUpdatesReducer', () => { fieldStates: { [identifiable1.uuid]: { editable: true, - isNew: false + isNew: false, + isValid: true }, [identifiable2.uuid]: { editable: false, - isNew: true + isNew: true, + isValid: true }, [identifiable3.uuid]: { editable: false, - isNew: false + isNew: false, + isValid: false }, }, fieldUpdates: { [identifiable2.uuid]: { field: { uuid: identifiable2.uuid, - key: 'dc.title', + key: 'dc.titl', language: null, value: 'New title' }, @@ -85,15 +88,18 @@ describe('objectUpdatesReducer', () => { fieldStates: { [identifiable1.uuid]: { editable: true, - isNew: false + isNew: false, + isValid: true }, [identifiable2.uuid]: { editable: false, - isNew: true + isNew: true, + isValid: true }, [identifiable3.uuid]: { editable: false, - isNew: false + isNew: false, + isValid: true }, }, lastModified: modDate @@ -102,22 +108,25 @@ describe('objectUpdatesReducer', () => { fieldStates: { [identifiable1.uuid]: { editable: true, - isNew: false + isNew: false, + isValid: true }, [identifiable2.uuid]: { editable: false, - isNew: true + isNew: true, + isValid: true }, [identifiable3.uuid]: { editable: false, - isNew: false + isNew: false, + isValid: false }, }, fieldUpdates: { [identifiable2.uuid]: { field: { uuid: identifiable2.uuid, - key: 'dc.title', + key: 'dc.titl', language: null, value: 'New title' }, @@ -194,11 +203,13 @@ describe('objectUpdatesReducer', () => { fieldStates: { [identifiable1.uuid]: { editable: false, - isNew: false + isNew: false, + isValid: true }, [identifiable3.uuid]: { editable: false, - isNew: false + isNew: false, + isValid: true }, }, fieldUpdates: {}, @@ -216,6 +227,13 @@ describe('objectUpdatesReducer', () => { expect(newState[url].fieldStates[identifiable3.uuid].editable).toBeTruthy(); }); + it('should set the given field\'s fieldStates when the SET_VALID_FIELD action is dispatched, based on the payload', () => { + const action = new SetValidFieldUpdateAction(url, identifiable3.uuid, false); + + const newState = objectUpdatesReducer(testState, action); + expect(newState[url].fieldStates[identifiable3.uuid].isValid).toBeFalsy(); + }); + it('should add a given field\'s update to the state when the ADD_FIELD action is dispatched, based on the payload', () => { const action = new AddFieldUpdateAction(url, identifiable1update, FieldChangeType.UPDATE); diff --git a/src/app/core/data/object-updates/object-updates.service.spec.ts b/src/app/core/data/object-updates/object-updates.service.spec.ts index 4f0393c641..e9fc4652b0 100644 --- a/src/app/core/data/object-updates/object-updates.service.spec.ts +++ b/src/app/core/data/object-updates/object-updates.service.spec.ts @@ -32,9 +32,9 @@ describe('ObjectUpdatesService', () => { beforeEach(() => { const fieldStates = { - [identifiable1.uuid]: { editable: false, isNew: false }, - [identifiable2.uuid]: { editable: true, isNew: false }, - [identifiable3.uuid]: { editable: true, isNew: true }, + [identifiable1.uuid]: { editable: false, isNew: false, isValid: true }, + [identifiable2.uuid]: { editable: true, isNew: false, isValid: false }, + [identifiable3.uuid]: { editable: true, isNew: true, isValid: true }, }; const objectEntry = { @@ -45,6 +45,9 @@ describe('ObjectUpdatesService', () => { service = new ObjectUpdatesService(store); spyOn(service as any, 'getObjectEntry').and.returnValue(observableOf(objectEntry)); + spyOn(service as any, 'getFieldState').and.callFake((uuid) => { + return observableOf(fieldStates[uuid]); + }); spyOn(service as any, 'saveFieldUpdate'); }); @@ -75,7 +78,7 @@ describe('ObjectUpdatesService', () => { describe('isEditable', () => { it('should return false if this identifiable is currently not editable in the store', () => { const result$ = service.isEditable(url, identifiable1.uuid); - expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + expect((service as any).getFieldState).toHaveBeenCalledWith(url, identifiable1.uuid); result$.subscribe((result) => { expect(result).toEqual(false); }); @@ -83,7 +86,25 @@ describe('ObjectUpdatesService', () => { it('should return true if this identifiable is currently editable in the store', () => { const result$ = service.isEditable(url, identifiable2.uuid); - expect((service as any).getObjectEntry).toHaveBeenCalledWith(url); + expect((service as any).getFieldState).toHaveBeenCalledWith(url, identifiable2.uuid); + result$.subscribe((result) => { + expect(result).toEqual(true); + }); + }); + }); + + describe('isValid', () => { + it('should return false if this identifiable is currently not valid in the store', () => { + const result$ = service.isValid(url, identifiable2.uuid); + expect((service as any).getFieldState).toHaveBeenCalledWith(url, identifiable2.uuid); + result$.subscribe((result) => { + expect(result).toEqual(false); + }); + }); + + it('should return true if this identifiable is currently valid in the store', () => { + const result$ = service.isValid(url, identifiable1.uuid); + expect((service as any).getFieldState).toHaveBeenCalledWith(url, identifiable1.uuid); result$.subscribe((result) => { expect(result).toEqual(true); }); diff --git a/src/app/core/data/object-updates/object-updates.service.ts b/src/app/core/data/object-updates/object-updates.service.ts index 6136d31ac0..85e17b5b2f 100644 --- a/src/app/core/data/object-updates/object-updates.service.ts +++ b/src/app/core/data/object-updates/object-updates.service.ts @@ -18,7 +18,7 @@ import { RemoveFieldUpdateAction, SetEditableFieldUpdateAction, SetValidFieldUpdateAction } from './object-updates.actions'; -import { filter, map } from 'rxjs/operators'; +import { distinctUntilChanged, filter, map, tap } from 'rxjs/operators'; import { hasNoValue, hasValue, isEmpty, isNotEmpty } from '../../../shared/empty.util'; import { INotification } from '../../../shared/notifications/models/notification.model'; @@ -30,6 +30,10 @@ function filterByUrlObjectUpdatesStateSelector(url: string): MemoizedSelector state[url]); } +function filterByUrlAndUUIDFieldStateSelector(url: string, uuid: string): MemoizedSelector { + return createSelector(filterByUrlObjectUpdatesStateSelector(url), (state: ObjectUpdatesEntry) => state.fieldStates[uuid]); +} + /** * Service that dispatches and reads from the ObjectUpdates' state in the store */ @@ -67,6 +71,15 @@ export class ObjectUpdatesService { return this.store.pipe(select(filterByUrlObjectUpdatesStateSelector(url))); } + /** + * Request the getFieldState state for a specific URL and UUID + * @param url The URL to filter by + * @param uuid The field's UUID to filter by + */ + private getFieldState(url: string, uuid: string): Observable { + return this.store.pipe(select(filterByUrlAndUUIDFieldStateSelector(url, uuid))); + } + /** * Method that combines the state's updates with the initial values (when there's no update) to create * a FieldUpdates object @@ -95,11 +108,11 @@ export class ObjectUpdatesService { * @param uuid The UUID of the field */ isEditable(url: string, uuid: string): Observable { - const objectUpdates = this.getObjectEntry(url); - return objectUpdates.pipe( - filter((objectEntry) => hasValue(objectEntry.fieldStates[uuid])), - map((objectEntry) => objectEntry.fieldStates[uuid].editable - ) + const fieldState$ = this.getFieldState(url, uuid); + return fieldState$.pipe( + filter((fieldState) => hasValue(fieldState)), + map((fieldState) => fieldState.editable), + distinctUntilChanged() ) } @@ -109,11 +122,11 @@ export class ObjectUpdatesService { * @param uuid The UUID of the field */ isValid(url: string, uuid: string): Observable { - const objectUpdates = this.getObjectEntry(url); - return objectUpdates.pipe( - filter((objectEntry) => hasValue(objectEntry.fieldStates[uuid])), - map((objectEntry) => objectEntry.fieldStates[uuid].isValid - ) + const fieldState$ = this.getFieldState(url, uuid); + return fieldState$.pipe( + filter((fieldState) => hasValue(fieldState)), + map((fieldState) => fieldState.isValid), + distinctUntilChanged() ) } @@ -126,7 +139,8 @@ export class ObjectUpdatesService { return objectUpdates.pipe( map((entry: ObjectUpdatesEntry) => { return Object.values(entry.fieldStates).findIndex((state: FieldState) => !state.isValid) < 0 - }) + }), + distinctUntilChanged() ) } diff --git a/src/app/shared/shared.module.ts b/src/app/shared/shared.module.ts index c3e7051304..6bdeabec43 100644 --- a/src/app/shared/shared.module.ts +++ b/src/app/shared/shared.module.ts @@ -92,6 +92,7 @@ import { EditComColPageComponent } from './comcol-forms/edit-comcol-page/edit-co import { DeleteComColPageComponent } from './comcol-forms/delete-comcol-page/delete-comcol-page.component'; import { LangSwitchComponent } from './lang-switch/lang-switch.component'; import { ObjectValuesPipe } from './utils/object-values-pipe'; +import { InListValidator } from './utils/in-list-validator.directive'; const MODULES = [ // Do NOT include UniversalModule, HttpModule, or JsonpModule here @@ -197,7 +198,8 @@ const DIRECTIVES = [ VarDirective, DragClickDirective, DebounceDirective, - ClickOutsideDirective + ClickOutsideDirective, + InListValidator ]; @NgModule({ diff --git a/src/app/shared/utils/in-list-validator.directive.ts b/src/app/shared/utils/in-list-validator.directive.ts new file mode 100644 index 0000000000..621ae93b83 --- /dev/null +++ b/src/app/shared/utils/in-list-validator.directive.ts @@ -0,0 +1,32 @@ +import { Directive, Input } from '@angular/core'; +import { FormControl, NG_VALIDATORS, ValidationErrors, Validator } from '@angular/forms'; +import { inListValidator } from './validator.functions'; + +/** + * Directive for validating if a ngModel value is in a given list + */ +@Directive({ + selector: '[ngModel][dsInListValidator]', + // We add our directive to the list of existing validators + providers: [ + { provide: NG_VALIDATORS, useExisting: InListValidator, multi: true } + ] +}) +export class InListValidator implements Validator { + /** + * The list to look in + */ + @Input() + dsInListValidator: string[]; + + /** + * The function that checks if the form control's value is currently valid + * @param c The FormControl + */ + validate(c: FormControl): ValidationErrors | null { + if (this.dsInListValidator !== null) { + return inListValidator(this.dsInListValidator)(c); + } + return null; + } +} diff --git a/src/app/shared/utils/validator.functions.ts b/src/app/shared/utils/validator.functions.ts index 55fe498747..3ad660731a 100644 --- a/src/app/shared/utils/validator.functions.ts +++ b/src/app/shared/utils/validator.functions.ts @@ -1,7 +1,11 @@ import { AbstractControl, ValidatorFn } from '@angular/forms'; +/** + * Returns a validator function to check if the control's value is in a given list + * @param list The list to look in + */ export function inListValidator(list: string[]): ValidatorFn { return (control: AbstractControl): {[key: string]: any} | null => { - const contains = list.indexOf(control.value) > 0; + const contains = list.indexOf(control.value) > -1; return contains ? null : {inList: {value: control.value}} }; } From 86115c44ce12e1715c2855371dd090d85535d083 Mon Sep 17 00:00:00 2001 From: lotte Date: Wed, 13 Feb 2019 12:18:21 +0100 Subject: [PATCH 08/18] started navigation for tabs --- .../edit-item-page/edit-item-page.component.html | 10 +++++----- .../edit-item-page/edit-item-page.component.ts | 5 +++-- src/app/+item-page/item-page-routing.module.ts | 4 ++-- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.html b/src/app/+item-page/edit-item-page/edit-item-page.component.html index 82a4b0c283..2cb05ab21f 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.html +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.html @@ -3,13 +3,13 @@

{{'item.edit.head' | translate}}

- - + + - + @@ -20,12 +20,12 @@ - + - + diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.ts b/src/app/+item-page/edit-item-page/edit-item-page.component.ts index b8d3ca7957..a795dd3dee 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.ts @@ -1,6 +1,6 @@ import {fadeIn, fadeInOut} from '../../shared/animations/fade'; import {ChangeDetectionStrategy, Component, OnInit} from '@angular/core'; -import {ActivatedRoute} from '@angular/router'; +import { ActivatedRoute, Params } from '@angular/router'; import {RemoteData} from '../../core/data/remote-data'; import {Item} from '../../core/shared/item.model'; import {Observable} from 'rxjs'; @@ -24,12 +24,13 @@ export class EditItemPageComponent implements OnInit { * The item to edit */ itemRD$: Observable>; - + params$: Observable; constructor(private route: ActivatedRoute) { } ngOnInit(): void { this.itemRD$ = this.route.data.pipe(map((data) => data.item)); + this.params$ = this.route.params; } } diff --git a/src/app/+item-page/item-page-routing.module.ts b/src/app/+item-page/item-page-routing.module.ts index 0f2f0817f6..962f659076 100644 --- a/src/app/+item-page/item-page-routing.module.ts +++ b/src/app/+item-page/item-page-routing.module.ts @@ -15,7 +15,7 @@ export function getItemEditPath(id: string) { return new URLCombiner(getItemModulePath(),ITEM_EDIT_PATH.replace(/:id/, id)).toString() } -const ITEM_EDIT_PATH = ':id/edit'; +const ITEM_EDIT_PATH = ':id/edit/:page'; @NgModule({ imports: [ @@ -38,7 +38,7 @@ const ITEM_EDIT_PATH = ':id/edit'; { path: ITEM_EDIT_PATH, loadChildren: './edit-item-page/edit-item-page.module#EditItemPageModule', - // canActivate: [AuthenticatedGuard] + canActivate: [AuthenticatedGuard] } ]) ], From bfa1e77177ee3baca7c2200eb143e5b6aa0f2a33 Mon Sep 17 00:00:00 2001 From: lotte Date: Tue, 19 Feb 2019 10:13:49 +0100 Subject: [PATCH 09/18] finalised edit item page --- resources/i18n/en.json | 20 ++-- .../edit-item-page.component.html | 52 ++++------- .../edit-item-page.component.ts | 37 +++++--- .../edit-item-page.routing.module.ts | 51 ++++++++-- .../edit-in-place-field.component.html | 21 +++-- .../edit-in-place-field.component.spec.ts | 20 ++-- .../edit-in-place-field.component.ts | 42 +++++---- .../item-metadata.component.html | 35 +++---- .../item-metadata.component.scss | 12 ++- .../item-metadata.component.spec.ts | 40 ++++---- .../item-metadata/item-metadata.component.ts | 92 +++++++++++-------- .../item-status/item-status.component.spec.ts | 17 +++- .../item-status/item-status.component.ts | 68 ++++++++------ .../+item-page/item-page-routing.module.ts | 4 +- src/app/core/metadata/metadatafield.model.ts | 6 +- .../input-suggestions.component.html | 2 + .../input-suggestions.component.ts | 14 +++ src/app/shared/shared.module.ts | 4 +- src/app/shared/utils/auto-focus.directive.ts | 22 +++++ 19 files changed, 346 insertions(+), 213 deletions(-) create mode 100644 src/app/shared/utils/auto-focus.directive.ts diff --git a/resources/i18n/en.json b/resources/i18n/en.json index 795b3cc747..12f4547cf6 100644 --- a/resources/i18n/en.json +++ b/resources/i18n/en.json @@ -188,7 +188,7 @@ "confirm": "Withdraw", "cancel": "Cancel", "success": "The item was withdrawn successfully", - "error": "An error occured while withdrawing the item" + "error": "An error occurred while withdrawing the item" }, "reinstate": { "header": "Reinstate item: {{ id }}", @@ -196,7 +196,7 @@ "confirm": "Reinstate", "cancel": "Cancel", "success": "The item was reinstated successfully", - "error": "An error occured while reinstating the item" + "error": "An error occurred while reinstating the item" }, "private": { "header": "Make item private: {{ id }}", @@ -204,7 +204,7 @@ "confirm": "Make it Private", "cancel": "Cancel", "success": "The item is now private", - "error": "An error occured while making the item private" + "error": "An error occurred while making the item private" }, "public": { "header": "Make item public: {{ id }}", @@ -212,7 +212,7 @@ "confirm": "Make it Public", "cancel": "Cancel", "success": "The item is now public", - "error": "An error occured while making the item public" + "error": "An error occurred while making the item public" }, "delete": { "header": "Delete item: {{ id }}", @@ -220,7 +220,7 @@ "confirm": "Delete", "cancel": "Cancel", "success": "The item has been deleted", - "error": "An error occured while deleting the item" + "error": "An error occurred while deleting the item" }, "metadata": { "add-button": "Add", @@ -233,6 +233,14 @@ "language": "Lang", "edit": "Edit" }, + "edit": { + "buttons": { + "edit": "Edit", + "unedit": "Stop editing", + "remove": "Remove", + "undo": "Undo changes" + } + }, "metadatafield": { "invalid": "Please choose a valid metadata field" }, @@ -247,7 +255,7 @@ }, "invalid": { "title": "Metadata invalid", - "content": "Please make sure all fields are valid" + "content": "Your changes were not saved. Please make sure all fields are valid before you save." } } } diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.html b/src/app/+item-page/edit-item-page/edit-item-page.component.html index 2cb05ab21f..f580d21d18 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.html +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.html @@ -1,37 +1,21 @@
-
-
-

{{'item.edit.head' | translate}}

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+

{{'item.edit.head' | translate}}

+
+ +
+ +
+
+
-
diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.ts b/src/app/+item-page/edit-item-page/edit-item-page.component.ts index a795dd3dee..d7ab3ea199 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.ts @@ -1,10 +1,11 @@ -import {fadeIn, fadeInOut} from '../../shared/animations/fade'; -import {ChangeDetectionStrategy, Component, OnInit} from '@angular/core'; -import { ActivatedRoute, Params } from '@angular/router'; -import {RemoteData} from '../../core/data/remote-data'; -import {Item} from '../../core/shared/item.model'; -import {Observable} from 'rxjs'; -import {map} from 'rxjs/operators'; +import { fadeIn, fadeInOut } from '../../shared/animations/fade'; +import { ChangeDetectionStrategy, Component, OnInit } from '@angular/core'; +import { ActivatedRoute, Params, Router } from '@angular/router'; +import { RemoteData } from '../../core/data/remote-data'; +import { Item } from '../../core/shared/item.model'; +import { Observable } from 'rxjs'; +import { map } from 'rxjs/operators'; +import { isNotEmpty } from '../../shared/empty.util'; @Component({ selector: 'ds-edit-item-page', @@ -24,13 +25,27 @@ export class EditItemPageComponent implements OnInit { * The item to edit */ itemRD$: Observable>; - params$: Observable; - constructor(private route: ActivatedRoute) { + + /** + * The current page outlet string + */ + currentPage: string; + + /** + * All possible page outlet strings + */ + pages: string[]; + + constructor(private route: ActivatedRoute, private router: Router) { + this.router.events.subscribe(() => { + this.currentPage = this.route.snapshot.firstChild.routeConfig.path; + }); } ngOnInit(): void { + this.pages = this.route.routeConfig.children + .map((child: any) => child.path) + .filter((path: string) => isNotEmpty(path)); // ignore reroutes this.itemRD$ = this.route.data.pipe(map((data) => data.item)); - this.params$ = this.route.params; } - } diff --git a/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts b/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts index 8ef6f43e17..8a45c42ff6 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts @@ -1,12 +1,14 @@ -import {ItemPageResolver} from '../item-page.resolver'; -import {NgModule} from '@angular/core'; -import {RouterModule} from '@angular/router'; -import {EditItemPageComponent} from './edit-item-page.component'; -import {ItemWithdrawComponent} from './item-withdraw/item-withdraw.component'; -import {ItemReinstateComponent} from './item-reinstate/item-reinstate.component'; -import {ItemPrivateComponent} from './item-private/item-private.component'; -import {ItemPublicComponent} from './item-public/item-public.component'; -import {ItemDeleteComponent} from './item-delete/item-delete.component'; +import { ItemPageResolver } from '../item-page.resolver'; +import { NgModule } from '@angular/core'; +import { RouterModule } from '@angular/router'; +import { EditItemPageComponent } from './edit-item-page.component'; +import { ItemWithdrawComponent } from './item-withdraw/item-withdraw.component'; +import { ItemReinstateComponent } from './item-reinstate/item-reinstate.component'; +import { ItemPrivateComponent } from './item-private/item-private.component'; +import { ItemPublicComponent } from './item-public/item-public.component'; +import { ItemDeleteComponent } from './item-delete/item-delete.component'; +import { ItemStatusComponent } from './item-status/item-status.component'; +import { ItemMetadataComponent } from './item-metadata/item-metadata.component'; const ITEM_EDIT_WITHDRAW_PATH = 'withdraw'; const ITEM_EDIT_REINSTATE_PATH = 'reinstate'; @@ -25,7 +27,36 @@ const ITEM_EDIT_DELETE_PATH = 'delete'; component: EditItemPageComponent, resolve: { item: ItemPageResolver - } + }, + children: [ + { + path: '', + redirectTo: 'status' + }, + { + path: 'status', + component: ItemStatusComponent + }, + { + path: 'bitstreams', + /* TODO - change when bitstreams page exists */ + component: ItemStatusComponent + }, + { + path: 'metadata', + component: ItemMetadataComponent + }, + { + path: 'view', + /* TODO - change when view page exists */ + component: ItemStatusComponent + }, + { + path: 'curate', + /* TODO - change when curate page exists */ + component: ItemStatusComponent + }, + ] }, { path: ITEM_EDIT_WITHDRAW_PATH, diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html index e4fdc60a1e..25f586d0ed 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -7,7 +7,7 @@
- {{metadata?.key}} + {{metadata?.key?.split('.').join('.​')}}
- - - -
diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index 927a4a96b1..cefbb3620a 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -44,7 +44,7 @@ const metadatum = Object.assign(new Metadatum(), { language: 'en' }); -const route = 'http://test-url.com/test-url'; +const url = 'http://test-url.com/test-url'; const fieldUpdate = { field: metadatum, changeType: undefined @@ -92,7 +92,7 @@ describe('EditInPlaceFieldComponent', () => { de = fixture.debugElement.query(By.css('div.d-flex')); el = de.nativeElement; - comp.route = route; + comp.url = url; comp.fieldUpdate = fieldUpdate; comp.metadata = metadatum; @@ -104,8 +104,8 @@ describe('EditInPlaceFieldComponent', () => { comp.update(); }); - it('it should call saveChangeFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { - expect(objectUpdatesService.saveChangeFieldUpdate).toHaveBeenCalledWith(route, metadatum); + it('it should call saveChangeFieldUpdate on the objectUpdatesService with the correct url and metadata', () => { + expect(objectUpdatesService.saveChangeFieldUpdate).toHaveBeenCalledWith(url, metadatum); }); }); @@ -145,8 +145,8 @@ describe('EditInPlaceFieldComponent', () => { comp.setEditable(editable); }); - it('it should call setEditableFieldUpdate on the objectUpdatesService with the correct route and uuid and false', () => { - expect(objectUpdatesService.setEditableFieldUpdate).toHaveBeenCalledWith(route, metadatum.uuid, editable); + it('it should call setEditableFieldUpdate on the objectUpdatesService with the correct url and uuid and false', () => { + expect(objectUpdatesService.setEditableFieldUpdate).toHaveBeenCalledWith(url, metadatum.uuid, editable); }); }); @@ -203,8 +203,8 @@ describe('EditInPlaceFieldComponent', () => { comp.remove(); }); - it('it should call saveRemoveFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { - expect(objectUpdatesService.saveRemoveFieldUpdate).toHaveBeenCalledWith(route, metadatum); + it('it should call saveRemoveFieldUpdate on the objectUpdatesService with the correct url and metadata', () => { + expect(objectUpdatesService.saveRemoveFieldUpdate).toHaveBeenCalledWith(url, metadatum); }); }); @@ -213,8 +213,8 @@ describe('EditInPlaceFieldComponent', () => { comp.removeChangesFromField(); }); - it('it should call removeChangesFromField on the objectUpdatesService with the correct route and uuid', () => { - expect(objectUpdatesService.removeSingleFieldUpdate).toHaveBeenCalledWith(route, metadatum.uuid); + it('it should call removeChangesFromField on the objectUpdatesService with the correct url and uuid', () => { + expect(objectUpdatesService.removeSingleFieldUpdate).toHaveBeenCalledWith(url, metadatum.uuid); }); }); diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index d0b35b7a82..f24de359b8 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -10,7 +10,6 @@ import { InputSuggestion } from '../../../../shared/input-suggestions/input-sugg import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; -import { inListValidator } from '../../../../shared/utils/validator.functions'; import { getSucceededRemoteData } from '../../../../core/shared/operators'; import { FormControl } from '@angular/forms'; @@ -28,9 +27,9 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { */ @Input() fieldUpdate: FieldUpdate; /** - * The current route of this page + * The current url of this page */ - @Input() route: string; + @Input() url: string; /** * The metadatum of this field */ @@ -65,8 +64,8 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * Sets up an observable that keeps track of the current editable and valid state of this field */ ngOnInit(): void { - this.editable = this.objectUpdatesService.isEditable(this.route, this.metadata.uuid); - this.valid = this.objectUpdatesService.isValid(this.route, this.metadata.uuid); + this.editable = this.objectUpdatesService.isEditable(this.url, this.metadata.uuid); + this.valid = this.objectUpdatesService.isValid(this.url, this.metadata.uuid); this.metadataFields = this.findMetadataFields() } @@ -74,32 +73,41 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * Sends a new change update for this field to the object updates service */ update(control?: FormControl) { - this.objectUpdatesService.saveChangeFieldUpdate(this.route, this.metadata); + this.objectUpdatesService.saveChangeFieldUpdate(this.url, this.metadata); if (hasValue(control)) { - this.objectUpdatesService.setValidFieldUpdate(this.route, this.metadata.uuid, control.valid); + this.checkValidity(control); } } + /** + * Method to check the validity of a form control + * @param control The form control to check + */ + private checkValidity(control: FormControl) { + control.updateValueAndValidity(); + this.objectUpdatesService.setValidFieldUpdate(this.url, this.metadata.uuid, control.valid); + } + /** * Sends a new editable state for this field to the service to change it * @param editable The new editable state for this field */ setEditable(editable: boolean) { - this.objectUpdatesService.setEditableFieldUpdate(this.route, this.metadata.uuid, editable); + this.objectUpdatesService.setEditableFieldUpdate(this.url, this.metadata.uuid, editable); } /** * Sends a new remove update for this field to the object updates service */ remove() { - this.objectUpdatesService.saveRemoveFieldUpdate(this.route, this.metadata); + this.objectUpdatesService.saveRemoveFieldUpdate(this.url, this.metadata); } /** * Notifies the object updates service that the updates for the current field can be removed */ removeChangesFromField() { - this.objectUpdatesService.removeSingleFieldUpdate(this.route, this.metadata.uuid); + this.objectUpdatesService.removeSingleFieldUpdate(this.url, this.metadata.uuid); } /** @@ -170,15 +178,7 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * @return an observable that emits true when the user should be able to remove this field and false when they should not */ canRemove(): Observable { - return this.editable.pipe( - map((editable: boolean) => { - if (editable) { - return false; - } else { - return this.fieldUpdate.changeType !== FieldChangeType.REMOVE && this.fieldUpdate.changeType !== FieldChangeType.ADD; - } - }) - ); + return observableOf(this.fieldUpdate.changeType !== FieldChangeType.REMOVE && this.fieldUpdate.changeType !== FieldChangeType.ADD); } /** @@ -186,7 +186,9 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * @return an observable that emits true when the user should be able to undo changes to this field and false when they should not */ canUndo(): Observable { - return observableOf(this.fieldUpdate.changeType >= 0); + return this.editable.pipe( + map((editable: boolean) => this.fieldUpdate.changeType >= 0 || editable) + ); } protected isNotEmpty(value): boolean { diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index 36d18372bd..04896ee4a6 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -5,8 +5,7 @@ (click)="add()"> {{"item.edit.metadata.add-button" | translate}} - -
+
- - +
+
+ + + +
diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss index b2994dcec7..1ae2839606 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss @@ -1,5 +1,13 @@ @import '../../../../styles/variables.scss'; -.button-row .btn { - min-width: $button-min-width; +.button-row { + .spaced-btn-group > .btn { + margin-right: 0.5 * $spacer; + &:last-child { + margin-right: 0; + } + } + .btn { + min-width: $button-min-width; + } } \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts index e57c4af67c..a9c8c4327f 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts @@ -7,7 +7,7 @@ import { Metadatum } from '../../../core/shared/metadatum.model'; import { TestScheduler } from 'rxjs/testing'; import { SharedModule } from '../../../shared/shared.module'; import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; -import { Router } from '@angular/router'; +import { ActivatedRoute, Router } from '@angular/router'; import { NotificationsService } from '../../../shared/notifications/notifications.service'; import { TranslateModule } from '@ngx-translate/core'; import { ItemDataService } from '../../../core/data/item-data.service'; @@ -32,6 +32,8 @@ const infoNotification: INotification = new Notification('id', NotificationType. const warningNotification: INotification = new Notification('id', NotificationType.Warning, 'warning'); const date = new Date(); const router = new RouterStub(); +let routeStub; + let itemService; const notificationsService = jasmine.createSpyObj('notificationsService', { @@ -56,9 +58,9 @@ const metadatum3 = Object.assign(new Metadatum(), { value: 'Shakespeare, William', }); -const route = 'http://test-url.com/test-url'; +const url = 'http://test-url.com/test-url'; -router.url = route; +router.url = url; const fieldUpdate1 = { field: metadatum1, @@ -84,6 +86,11 @@ describe('ItemMetadataComponent', () => { update: observableOf(new RemoteData(false, false, true, undefined, item)), commitUpdates: {} }); + routeStub = { + parent: { + data: observableOf({ item: new RemoteData(false, false, true, null, item) }) + } + }; scheduler = getTestScheduler(); objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', { @@ -111,6 +118,9 @@ describe('ItemMetadataComponent', () => { { provide: ItemDataService, useValue: itemService }, { provide: ObjectUpdatesService, useValue: objectUpdatesService }, { provide: Router, useValue: router }, + { + provide: ActivatedRoute, useValue: routeStub + }, { provide: NotificationsService, useValue: notificationsService }, { provide: GLOBAL_CONFIG, useValue: { notifications: { timeOut: 10 } } as any } ], schemas: [ @@ -118,16 +128,14 @@ describe('ItemMetadataComponent', () => { ] }).compileComponents(); }) - ) - ; + ); beforeEach(() => { fixture = TestBed.createComponent(ItemMetadataComponent); comp = fixture.componentInstance; // EditInPlaceFieldComponent test instance de = fixture.debugElement.query(By.css('div.d-flex')); el = de.nativeElement; - comp.item = item; - comp.route = route; + comp.url = url; fixture.detectChanges(); }); @@ -137,8 +145,8 @@ describe('ItemMetadataComponent', () => { comp.add(md); }); - it('it should call saveAddFieldUpdate on the objectUpdatesService with the correct route and metadata', () => { - expect(objectUpdatesService.saveAddFieldUpdate).toHaveBeenCalledWith(route, md); + it('it should call saveAddFieldUpdate on the objectUpdatesService with the correct url and metadata', () => { + expect(objectUpdatesService.saveAddFieldUpdate).toHaveBeenCalledWith(url, md); }); }); @@ -147,8 +155,8 @@ describe('ItemMetadataComponent', () => { comp.discard(); }); - it('it should call discardFieldUpdates on the objectUpdatesService with the correct route and notification', () => { - expect(objectUpdatesService.discardFieldUpdates).toHaveBeenCalledWith(route, infoNotification); + it('it should call discardFieldUpdates on the objectUpdatesService with the correct url and notification', () => { + expect(objectUpdatesService.discardFieldUpdates).toHaveBeenCalledWith(url, infoNotification); }); }); @@ -157,8 +165,8 @@ describe('ItemMetadataComponent', () => { comp.reinstate(); }); - it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct route', () => { - expect(objectUpdatesService.reinstateFieldUpdates).toHaveBeenCalledWith(route); + it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct url', () => { + expect(objectUpdatesService.reinstateFieldUpdates).toHaveBeenCalledWith(url); }); }); @@ -167,10 +175,10 @@ describe('ItemMetadataComponent', () => { comp.submit(); }); - it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct route and metadata', () => { - expect(objectUpdatesService.getUpdatedFields).toHaveBeenCalledWith(route, comp.item.metadata); + it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct url and metadata', () => { + expect(objectUpdatesService.getUpdatedFields).toHaveBeenCalledWith(url, comp.item.metadata); expect(itemService.update).toHaveBeenCalledWith(comp.item); - expect(objectUpdatesService.getFieldUpdates).toHaveBeenCalledWith(route, comp.item.metadata); + expect(objectUpdatesService.getFieldUpdates).toHaveBeenCalledWith(url, comp.item.metadata); }); }); diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index ae32028486..380e05c334 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -2,7 +2,7 @@ import { Component, Inject, Input, OnInit } from '@angular/core'; import { Item } from '../../../core/shared/item.model'; import { ItemDataService } from '../../../core/data/item-data.service'; import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; -import { Router } from '@angular/router'; +import { ActivatedRoute, Router } from '@angular/router'; import { cloneDeep } from 'lodash'; import { Observable } from 'rxjs'; import { @@ -31,15 +31,15 @@ export class ItemMetadataComponent implements OnInit { /** * The item to display the edit page for */ - @Input() item: Item; + item: Item; /** * The current values and updates for all this item's metadata fields */ updates$: Observable; /** - * The current route of this page + * The current url of this page */ - route: string; + url: string; /** * The time span for being able to undo discarding changes */ @@ -51,16 +51,25 @@ export class ItemMetadataComponent implements OnInit { private router: Router, private notificationsService: NotificationsService, private translateService: TranslateService, - @Inject(GLOBAL_CONFIG) protected EnvConfig: GlobalConfig + @Inject(GLOBAL_CONFIG) protected EnvConfig: GlobalConfig, + private route: ActivatedRoute ) { } ngOnInit(): void { + this.route.parent.data.pipe(map((data) => data.item)) + .pipe( + first(), + map((data: RemoteData) => data.payload) + ).subscribe((item: Item) => { + this.item = item; + }); + this.discardTimeOut = this.EnvConfig.notifications.timeOut; - this.route = this.router.url; - if (this.route.indexOf('?') > 0) { - this.route = this.route.substr(0, this.route.indexOf('?')); + this.url = this.router.url; + if (this.url.indexOf('?') > 0) { + this.url = this.url.substr(0, this.url.indexOf('?')); } this.hasChanges().pipe(first()).subscribe((hasChanges) => { if (!hasChanges) { @@ -69,7 +78,8 @@ export class ItemMetadataComponent implements OnInit { this.checkLastModified(); } }); - this.updates$ = this.objectUpdatesService.getFieldUpdates(this.route, this.item.metadata); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.url, this.item.metadata); + } /** @@ -77,7 +87,8 @@ export class ItemMetadataComponent implements OnInit { * @param metadata The metadata to add, if no parameter is supplied, create a new Metadatum */ add(metadata: Metadatum = new Metadatum()) { - this.objectUpdatesService.saveAddFieldUpdate(this.route, metadata); + this.objectUpdatesService.saveAddFieldUpdate(this.url, metadata); + } /** @@ -88,21 +99,21 @@ export class ItemMetadataComponent implements OnInit { const title = this.translateService.instant('item.edit.metadata.notifications.discarded.title'); const content = this.translateService.instant('item.edit.metadata.notifications.discarded.content'); const undoNotification = this.notificationsService.info(title, content, { timeOut: this.discardTimeOut }); - this.objectUpdatesService.discardFieldUpdates(this.route, undoNotification); + this.objectUpdatesService.discardFieldUpdates(this.url, undoNotification); } /** * Request the object updates service to undo discarding all changes to this item */ reinstate() { - this.objectUpdatesService.reinstateFieldUpdates(this.route); + this.objectUpdatesService.reinstateFieldUpdates(this.url); } /** * Sends all initial values of this item to the object updates service */ private initializeOriginalFields() { - this.objectUpdatesService.initialize(this.route, this.item.metadata, this.item.lastModified); + this.objectUpdatesService.initialize(this.url, this.item.metadata, this.item.lastModified); } /* Prevent unnecessary rerendering so fields don't lose focus **/ @@ -117,42 +128,42 @@ export class ItemMetadataComponent implements OnInit { submit() { this.isValid().pipe(first()).subscribe((isValid) => { if (isValid) { - const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.route, this.item.metadata) as Observable; - metadata$.pipe( - first(), - switchMap((metadata: Metadatum[]) => { - const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); - return this.itemService.update(updatedItem); - }), - tap(() => this.itemService.commitUpdates()), - getSucceededRemoteData() - ).subscribe( - (rd: RemoteData) => { - this.item = rd.payload; - this.initializeOriginalFields(); - this.updates$ = this.objectUpdatesService.getFieldUpdates(this.route, this.item.metadata); - } - ) - } else { - const title = this.translateService.instant('item.edit.metadata.notifications.invalid.title'); - const content = this.translateService.instant('item.edit.metadata.notifications.invalid.content'); - this.notificationsService.error(title, content); - } - }); + const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.url, this.item.metadata) as Observable; + metadata$.pipe( + first(), + switchMap((metadata: Metadatum[]) => { + const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); + return this.itemService.update(updatedItem); + }), + tap(() => this.itemService.commitUpdates()), + getSucceededRemoteData() + ).subscribe( + (rd: RemoteData) => { + this.item = rd.payload; + this.initializeOriginalFields(); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.url, this.item.metadata); + } + ) + } else { + const title = this.translateService.instant('item.edit.metadata.notifications.invalid.title'); + const content = this.translateService.instant('item.edit.metadata.notifications.invalid.content'); + this.notificationsService.error(title, content); + } + }); } /** * Checks whether or not there are currently updates for this item */ hasChanges(): Observable { - return this.objectUpdatesService.hasUpdates(this.route); + return this.objectUpdatesService.hasUpdates(this.url); } /** * Checks whether or not the item is currently reinstatable */ isReinstatable(): Observable { - return this.objectUpdatesService.isReinstatable(this.route); + return this.objectUpdatesService.isReinstatable(this.url); } /** @@ -161,7 +172,7 @@ export class ItemMetadataComponent implements OnInit { */ private checkLastModified() { const currentVersion = this.item.lastModified; - this.objectUpdatesService.getLastModified(this.route).pipe(first()).subscribe( + this.objectUpdatesService.getLastModified(this.url).pipe(first()).subscribe( (updateVersion: Date) => { if (updateVersion.getDate() !== currentVersion.getDate()) { const title = this.translateService.instant('item.edit.metadata.notifications.outdated.title'); @@ -173,7 +184,10 @@ export class ItemMetadataComponent implements OnInit { ); } + /** + * Check if the current page is entirely valid + */ private isValid() { - return this.objectUpdatesService.isValidPage(this.route); + return this.objectUpdatesService.isValidPage(this.url); } } diff --git a/src/app/+item-page/edit-item-page/item-status/item-status.component.spec.ts b/src/app/+item-page/edit-item-page/item-status/item-status.component.spec.ts index 319d4c47ae..9c3049c638 100644 --- a/src/app/+item-page/edit-item-page/item-status/item-status.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-status/item-status.component.spec.ts @@ -6,11 +6,13 @@ import { CommonModule } from '@angular/common'; import { HostWindowServiceStub } from '../../../shared/testing/host-window-service-stub'; import { HostWindowService } from '../../../shared/host-window.service'; import { RouterTestingModule } from '@angular/router/testing'; -import { Router } from '@angular/router'; +import { ActivatedRoute, Router } from '@angular/router'; import { RouterStub } from '../../../shared/testing/router-stub'; import { Item } from '../../../core/shared/item.model'; import { By } from '@angular/platform-browser'; -import {CUSTOM_ELEMENTS_SCHEMA} from '@angular/core'; +import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; +import { of as observableOf } from 'rxjs'; +import { RemoteData } from '../../../core/data/remote-data'; describe('ItemStatusComponent', () => { let comp: ItemStatusComponent; @@ -27,12 +29,19 @@ describe('ItemStatusComponent', () => { url: `${itemPageUrl}/edit` }); + const routeStub = { + parent: { + data: observableOf({ item: new RemoteData(false, false, true, null, mockItem) }) + } + }; + beforeEach(async(() => { TestBed.configureTestingModule({ imports: [CommonModule, RouterTestingModule.withRoutes([]), TranslateModule.forRoot(), NgbModule.forRoot()], declarations: [ItemStatusComponent], providers: [ { provide: Router, useValue: routerStub }, + { provide: ActivatedRoute, useValue: routeStub }, { provide: HostWindowService, useValue: new HostWindowServiceStub(0) } ], schemas: [CUSTOM_ELEMENTS_SCHEMA] }).compileComponents(); @@ -41,7 +50,6 @@ describe('ItemStatusComponent', () => { beforeEach(() => { fixture = TestBed.createComponent(ItemStatusComponent); comp = fixture.componentInstance; - comp.item = mockItem; fixture.detectChanges(); }); @@ -65,4 +73,5 @@ describe('ItemStatusComponent', () => { expect(statusItemPage.textContent).toContain(itemPageUrl); }); -}); +}) +; diff --git a/src/app/+item-page/edit-item-page/item-status/item-status.component.ts b/src/app/+item-page/edit-item-page/item-status/item-status.component.ts index 2b2c7a2ed4..28cd23a5fe 100644 --- a/src/app/+item-page/edit-item-page/item-status/item-status.component.ts +++ b/src/app/+item-page/edit-item-page/item-status/item-status.component.ts @@ -1,8 +1,11 @@ -import {ChangeDetectionStrategy, Component, Input, OnInit} from '@angular/core'; -import {fadeIn, fadeInOut} from '../../../shared/animations/fade'; -import {Item} from '../../../core/shared/item.model'; -import {Router} from '@angular/router'; -import {ItemOperation} from '../item-operation/itemOperation.model'; +import { ChangeDetectionStrategy, Component, Input, OnInit } from '@angular/core'; +import { fadeIn, fadeInOut } from '../../../shared/animations/fade'; +import { Item } from '../../../core/shared/item.model'; +import { ActivatedRoute, Router } from '@angular/router'; +import { ItemOperation } from '../item-operation/itemOperation.model'; +import { first, map } from 'rxjs/operators'; +import { Observable } from 'rxjs'; +import { RemoteData } from '../../../core/data/remote-data'; @Component({ selector: 'ds-item-status', @@ -21,7 +24,7 @@ export class ItemStatusComponent implements OnInit { /** * The item to display the status for */ - @Input() item: Item; + itemRD$: Observable>; /** * The data to show in the status @@ -37,39 +40,46 @@ export class ItemStatusComponent implements OnInit { * key: id value: url to action's component */ operations: ItemOperation[]; + /** * The keys of the actions (to loop over) */ actionsKeys; - constructor(private router: Router) { + constructor(private router: Router, private route: ActivatedRoute) { } ngOnInit(): void { - this.statusData = Object.assign({ - id: this.item.id, - handle: this.item.handle, - lastModified: this.item.lastModified + this.itemRD$ = this.route.parent.data.pipe(map((data) => data.item)); + this.itemRD$.pipe( + first(), + map((data: RemoteData) => data.payload) + ).subscribe((item: Item) => { + this.statusData = Object.assign({ + id: item.id, + handle: item.handle, + lastModified: item.lastModified + }); + this.statusDataKeys = Object.keys(this.statusData); + /* + The key is used to build messages + i18n example: 'item.edit.tabs.status.buttons..label' + The value is supposed to be a href for the button + */ + this.operations = []; + if (item.isWithdrawn) { + this.operations.push(new ItemOperation('reinstate', this.getCurrentUrl() + '/reinstate')); + } else { + this.operations.push(new ItemOperation('withdraw', this.getCurrentUrl() + '/withdraw')); + } + if (item.isDiscoverable) { + this.operations.push(new ItemOperation('private', this.getCurrentUrl() + '/private')); + } else { + this.operations.push(new ItemOperation('public', this.getCurrentUrl() + '/public')); + } + this.operations.push(new ItemOperation('delete', this.getCurrentUrl() + '/delete')); }); - this.statusDataKeys = Object.keys(this.statusData); - /* - The key is used to build messages - i18n example: 'item.edit.tabs.status.buttons..label' - The value is supposed to be a href for the button - */ - this.operations = []; - if (this.item.isWithdrawn) { - this.operations.push(new ItemOperation('reinstate', this.getCurrentUrl() + '/reinstate')); - } else { - this.operations.push(new ItemOperation('withdraw', this.getCurrentUrl() + '/withdraw')); - } - if (this.item.isDiscoverable) { - this.operations.push(new ItemOperation('private', this.getCurrentUrl() + '/private')); - } else { - this.operations.push(new ItemOperation('public', this.getCurrentUrl() + '/public')); - } - this.operations.push(new ItemOperation('delete', this.getCurrentUrl() + '/delete')); } /** diff --git a/src/app/+item-page/item-page-routing.module.ts b/src/app/+item-page/item-page-routing.module.ts index 962f659076..ec562842aa 100644 --- a/src/app/+item-page/item-page-routing.module.ts +++ b/src/app/+item-page/item-page-routing.module.ts @@ -15,7 +15,7 @@ export function getItemEditPath(id: string) { return new URLCombiner(getItemModulePath(),ITEM_EDIT_PATH.replace(/:id/, id)).toString() } -const ITEM_EDIT_PATH = ':id/edit/:page'; +const ITEM_EDIT_PATH = ':id/edit'; @NgModule({ imports: [ @@ -39,7 +39,7 @@ const ITEM_EDIT_PATH = ':id/edit/:page'; path: ITEM_EDIT_PATH, loadChildren: './edit-item-page/edit-item-page.module#EditItemPageModule', canActivate: [AuthenticatedGuard] - } + }, ]) ], providers: [ diff --git a/src/app/core/metadata/metadatafield.model.ts b/src/app/core/metadata/metadatafield.model.ts index 36f97d8d6f..ba28b59d0e 100644 --- a/src/app/core/metadata/metadatafield.model.ts +++ b/src/app/core/metadata/metadatafield.model.ts @@ -22,10 +22,10 @@ export class MetadataField implements ListableObject { @autoserialize schema: MetadataSchema; - toString(): string { - let key = this.schema.prefix + '.' + this.element; + toString(separator: string = '.'): string { + let key = this.schema.prefix + separator + this.element; if (isNotEmpty(this.qualifier)) { - key += '.' + this.qualifier; + key += separator + this.qualifier; } return key; } diff --git a/src/app/shared/input-suggestions/input-suggestions.component.html b/src/app/shared/input-suggestions/input-suggestions.component.html index b620f4b79a..1bd3cde22e 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.html +++ b/src/app/shared/input-suggestions/input-suggestions.component.html @@ -5,8 +5,10 @@ (dsClickOutside)="close()">
diff --git a/src/app/shared/input-suggestions/input-suggestions.component.ts b/src/app/shared/input-suggestions/input-suggestions.component.ts index afb405a60a..8bdc0cf762 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.ts @@ -60,6 +60,11 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange */ @Input() name; + /** + * Whether or not the current input is valid + */ + @Input() valid; + /** * Output for when the form is submitted */ @@ -80,6 +85,11 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange */ @Output() findSuggestions = new EventEmitter(); + /** + * Emits event when the input field loses focus + */ + @Output() blur = new EventEmitter(); + /** * Emits true when the list of suggestions should be shown */ @@ -238,4 +248,8 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange this._value = val; this.propagateChange(this._value); } + + focus() { + this.queryInput.nativeElement.focus(); + } } diff --git a/src/app/shared/shared.module.ts b/src/app/shared/shared.module.ts index 6bdeabec43..3a2a676a1c 100644 --- a/src/app/shared/shared.module.ts +++ b/src/app/shared/shared.module.ts @@ -93,6 +93,7 @@ import { DeleteComColPageComponent } from './comcol-forms/delete-comcol-page/del import { LangSwitchComponent } from './lang-switch/lang-switch.component'; import { ObjectValuesPipe } from './utils/object-values-pipe'; import { InListValidator } from './utils/in-list-validator.directive'; +import { AutoFocusDirective } from './utils/auto-focus.directive'; const MODULES = [ // Do NOT include UniversalModule, HttpModule, or JsonpModule here @@ -199,7 +200,8 @@ const DIRECTIVES = [ DragClickDirective, DebounceDirective, ClickOutsideDirective, - InListValidator + InListValidator, + AutoFocusDirective ]; @NgModule({ diff --git a/src/app/shared/utils/auto-focus.directive.ts b/src/app/shared/utils/auto-focus.directive.ts new file mode 100644 index 0000000000..b6ebdcbb7f --- /dev/null +++ b/src/app/shared/utils/auto-focus.directive.ts @@ -0,0 +1,22 @@ +import { Directive, AfterViewInit, ElementRef, Input } from '@angular/core'; +import { isNotEmpty } from '../empty.util'; + +@Directive({ + selector: '[dsAutoFocus]' +}) +export class AutoFocusDirective implements AfterViewInit { + + @Input() autoFocusSelector: string; + + constructor(private el: ElementRef) { + } + + ngAfterViewInit() { + if (isNotEmpty(this.autoFocusSelector)) { + return this.el.nativeElement.querySelector(this.autoFocusSelector).focus(); + + } else { + return this.el.nativeElement.focus(); + } + } +} From 0ebb0de3ddda7f8762ad77aa616047b68ac4b47c Mon Sep 17 00:00:00 2001 From: lotte Date: Tue, 19 Feb 2019 14:49:26 +0100 Subject: [PATCH 10/18] 59334: edit metadata finetuning --- .../edit-item-page.component.html | 7 +- .../edit-item-page.component.scss | 5 + .../edit-item-page.component.ts | 5 + .../edit-item-page/edit-item-page.module.ts | 2 + .../edit-item-page.routing.module.ts | 8 +- .../item-bitstreams.component.html | 3 + .../item-bitstreams.component.scss | 1 + .../item-bitstreams.component.ts | 13 ++ .../edit-in-place-field.component.html | 87 +++++++------- .../edit-in-place-field.component.scss | 9 ++ .../edit-in-place-field.component.spec.ts | 76 ++++++------ .../edit-in-place-field.component.ts | 5 +- .../item-metadata.component.html | 111 ++++++++++-------- .../item-metadata.component.scss | 15 ++- .../item-metadata/item-metadata.component.ts | 9 +- .../item-status/item-status.component.html | 2 +- .../item-status/item-status.component.ts | 23 ++-- src/app/core/core.module.ts | 2 + .../data/default-change-analyzer.service.ts | 29 +++++ .../core/data/metadata-schema-data.service.ts | 4 +- .../core/metadata/metadata.service.spec.ts | 1 + src/styles/_bootstrap_variables.scss | 1 - src/styles/_custom_variables.scss | 4 +- 23 files changed, 258 insertions(+), 164 deletions(-) create mode 100644 src/app/+item-page/edit-item-page/edit-item-page.component.scss create mode 100644 src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.html create mode 100644 src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.scss create mode 100644 src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.ts create mode 100644 src/app/core/data/default-change-analyzer.service.ts diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.html b/src/app/+item-page/edit-item-page/edit-item-page.component.html index f580d21d18..ca1c809cd9 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.html +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.html @@ -7,13 +7,16 @@
  • + [routerLink]="['./' + page]"> {{'item.edit.tabs.' + page + '.head' | translate}}
    • - +
    + +
    + Cancel
    diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.scss b/src/app/+item-page/edit-item-page/edit-item-page.component.scss new file mode 100644 index 0000000000..f22ca8f8de --- /dev/null +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.scss @@ -0,0 +1,5 @@ +@import '../../../styles/variables.scss'; + +.btn { + min-width: $edit-item-button-min-width; +} diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.ts b/src/app/+item-page/edit-item-page/edit-item-page.component.ts index d7ab3ea199..efde7c52fb 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.ts @@ -6,6 +6,7 @@ import { Item } from '../../core/shared/item.model'; import { Observable } from 'rxjs'; import { map } from 'rxjs/operators'; import { isNotEmpty } from '../../shared/empty.util'; +import { getItemPageRoute } from '../item-page-routing.module'; @Component({ selector: 'ds-edit-item-page', @@ -48,4 +49,8 @@ export class EditItemPageComponent implements OnInit { .filter((path: string) => isNotEmpty(path)); // ignore reroutes this.itemRD$ = this.route.data.pipe(map((data) => data.item)); } + + getItemPage(item: Item): string { + return getItemPageRoute(item.id) + } } diff --git a/src/app/+item-page/edit-item-page/edit-item-page.module.ts b/src/app/+item-page/edit-item-page/edit-item-page.module.ts index 98904517f9..0c1de642ce 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.module.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.module.ts @@ -14,6 +14,7 @@ import { ItemPublicComponent } from './item-public/item-public.component'; import { ItemDeleteComponent } from './item-delete/item-delete.component'; import { ItemMetadataComponent } from './item-metadata/item-metadata.component'; import { EditInPlaceFieldComponent } from './item-metadata/edit-in-place-field/edit-in-place-field.component'; +import { ItemBitstreamsComponent } from './item-bitstreams/item-bitstreams.component'; /** * Module that contains all components related to the Edit Item page administrator functionality @@ -36,6 +37,7 @@ import { EditInPlaceFieldComponent } from './item-metadata/edit-in-place-field/e ItemDeleteComponent, ItemStatusComponent, ItemMetadataComponent, + ItemBitstreamsComponent, EditInPlaceFieldComponent ] }) diff --git a/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts b/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts index 8a45c42ff6..48fd6ceb9b 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.routing.module.ts @@ -9,6 +9,7 @@ import { ItemPublicComponent } from './item-public/item-public.component'; import { ItemDeleteComponent } from './item-delete/item-delete.component'; import { ItemStatusComponent } from './item-status/item-status.component'; import { ItemMetadataComponent } from './item-metadata/item-metadata.component'; +import { ItemBitstreamsComponent } from './item-bitstreams/item-bitstreams.component'; const ITEM_EDIT_WITHDRAW_PATH = 'withdraw'; const ITEM_EDIT_REINSTATE_PATH = 'reinstate'; @@ -39,8 +40,7 @@ const ITEM_EDIT_DELETE_PATH = 'delete'; }, { path: 'bitstreams', - /* TODO - change when bitstreams page exists */ - component: ItemStatusComponent + component: ItemBitstreamsComponent }, { path: 'metadata', @@ -49,12 +49,12 @@ const ITEM_EDIT_DELETE_PATH = 'delete'; { path: 'view', /* TODO - change when view page exists */ - component: ItemStatusComponent + component: ItemBitstreamsComponent }, { path: 'curate', /* TODO - change when curate page exists */ - component: ItemStatusComponent + component: ItemBitstreamsComponent }, ] }, diff --git a/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.html b/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.html new file mode 100644 index 0000000000..b80e6e0678 --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.html @@ -0,0 +1,3 @@ +
    + +
    diff --git a/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.scss b/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.scss new file mode 100644 index 0000000000..88eb98509a --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.scss @@ -0,0 +1 @@ +@import '../../../../styles/variables.scss'; \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.ts b/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.ts new file mode 100644 index 0000000000..71f25cd5cf --- /dev/null +++ b/src/app/+item-page/edit-item-page/item-bitstreams/item-bitstreams.component.ts @@ -0,0 +1,13 @@ +import { Component } from '@angular/core'; + +@Component({ + selector: 'ds-item-bitstreams', + styleUrls: ['./item-bitstreams.component.scss'], + templateUrl: './item-bitstreams.component.html', +}) +/** + * Component for displaying an item's bitstreams edit page + */ +export class ItemBitstreamsComponent { + /* TODO implement */ +} diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html index 25f586d0ed..44c6cf2258 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -1,11 +1,6 @@ - -
    - - + + +
    {{metadata?.key?.split('.').join('.​')}}
    @@ -25,39 +20,47 @@
    {{"item.edit.metadata.metadatafield.invalid" | translate}} - - -
    - {{metadata?.value}} -
    -
    +
    + + +
    + {{metadata?.value}} +
    +
    -
    - - -
    - {{metadata?.language}} -
    -
    - -
    - - -
    - - - - -
    - -
    \ No newline at end of file +
    + + +
    + {{metadata?.language}} +
    +
    + +
    + + +
    + + + + +
    + \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss index 3575cae797..65bdbc38e0 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.scss @@ -1 +1,10 @@ @import '../../../../../styles/variables.scss'; +.btn[disabled] { + color: $gray-600; + border-color: $gray-600; + z-index: 0; // prevent border colors jumping on hover +} + +.metadata-field { + width: $edit-item-metadata-field-width; +} \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index cefbb3620a..133ee19e43 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -400,66 +400,64 @@ describe('EditInPlaceFieldComponent', () => { }); describe('canRemove', () => { - describe('when editable is currently true', () => { + describe('when the fieldUpdate\'s changeType is currently not REMOVE or ADD', () => { beforeEach(() => { - comp.editable = observableOf(true); - fixture.detectChanges(); + comp.fieldUpdate.changeType = FieldChangeType.UPDATE; + }); + it('canRemove should return an observable emitting true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: true }); + }); + }); + + describe('when the fieldUpdate\'s changeType is currently ADD', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.ADD; }); it('canRemove should return an observable emitting false', () => { const expected = '(a|)'; scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: false }); }); - }); - - describe('when editable is currently false', () => { - beforeEach(() => { - comp.editable = observableOf(false); - }); - - describe('when the fieldUpdate\'s changeType is currently not REMOVE or ADD', () => { - beforeEach(() => { - comp.fieldUpdate.changeType = FieldChangeType.UPDATE; - }); - it('canRemove should return an observable emitting true', () => { - const expected = '(a|)'; - scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: true }); - }); - }); - - describe('when the fieldUpdate\'s changeType is currently ADD', () => { - beforeEach(() => { - comp.fieldUpdate.changeType = FieldChangeType.ADD; - }); - it('canRemove should return an observable emitting false', () => { - const expected = '(a|)'; - scheduler.expectObservable(comp.canRemove()).toBe(expected, { a: false }); - }); - }) - }); + }) }); describe('canUndo', () => { - describe('when the fieldUpdate\'s changeType is currently ADD, UPDATE or REMOVE', () => { + describe('when editable is currently true', () => { beforeEach(() => { - comp.fieldUpdate.changeType = FieldChangeType.ADD; + comp.editable = observableOf(true); + comp.fieldUpdate.changeType = undefined; + fixture.detectChanges(); }); - it('canUndo should return an observable emitting true', () => { const expected = '(a|)'; scheduler.expectObservable(comp.canUndo()).toBe(expected, { a: true }); }); }); - describe('when the fieldUpdate\'s changeType is currently undefined', () => { - beforeEach(() => { - comp.fieldUpdate.changeType = undefined; + describe('when editable is currently false', () => { + describe('when the fieldUpdate\'s changeType is currently ADD, UPDATE or REMOVE', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = FieldChangeType.ADD; + }); + + it('canUndo should return an observable emitting true', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canUndo()).toBe(expected, { a: true }); + }); }); - it('canUndo should return an observable emitting false', () => { - const expected = '(a|)'; - scheduler.expectObservable(comp.canUndo()).toBe(expected, { a: false }); + describe('when the fieldUpdate\'s changeType is currently undefined', () => { + beforeEach(() => { + comp.fieldUpdate.changeType = undefined; + }); + + it('canUndo should return an observable emitting false', () => { + const expected = '(a|)'; + scheduler.expectObservable(comp.canUndo()).toBe(expected, { a: false }); + }); }); }); + }); }); diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index f24de359b8..7d4922de43 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -14,7 +14,8 @@ import { getSucceededRemoteData } from '../../../../core/shared/operators'; import { FormControl } from '@angular/forms'; @Component({ - selector: 'ds-edit-in-place-field', + // tslint:disable-next-line:component-selector + selector: '[ds-edit-in-place-field]', styleUrls: ['./edit-in-place-field.component.scss'], templateUrl: './edit-in-place-field.component.html', }) @@ -131,7 +132,7 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { (fields: MetadataField[]) => this.metadataFieldSuggestions.next( fields.map((field: MetadataField) => { return { - displayValue: field.toString(), + displayValue: field.toString().split('.').join('.​'), value: field.toString() } }) diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index 04896ee4a6..bb0c188f05 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -1,56 +1,63 @@ -
    -
    -
    - + + + +
    + + + + + + + + + + + + +
    {{'item.edit.metadata.headers.field' | translate}}{{'item.edit.metadata.headers.value' | translate}}{{'item.edit.metadata.headers.language' | translate}}{{'item.edit.metadata.headers.edit' | translate}}
    +
    +
    + + + -
    - - - -
    -
    - - - - - - - - - - - - -
    {{'item.edit.metadata.headers.field' | translate}}{{'item.edit.metadata.headers.value' | translate}}{{'item.edit.metadata.headers.language' | translate}}{{'item.edit.metadata.headers.edit' | translate}}
    -
    -
    - - - -
    diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss index 1ae2839606..f3075702e6 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.scss @@ -1,13 +1,22 @@ @import '../../../../styles/variables.scss'; .button-row { - .spaced-btn-group > .btn { + .btn { margin-right: 0.5 * $spacer; + &:last-child { margin-right: 0; } + + @media screen and (min-width: map-get($grid-breakpoints, sm)) { + min-width: $edit-item-button-min-width; + } } - .btn { - min-width: $button-min-width; + + &.top .btn { + margin-top: $spacer/2; + margin-bottom: $spacer/2; } + + } \ No newline at end of file diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index 380e05c334..46098ff69d 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -57,6 +57,9 @@ export class ItemMetadataComponent implements OnInit { } + /** + * Set up and initialize all fields + */ ngOnInit(): void { this.route.parent.data.pipe(map((data) => data.item)) .pipe( @@ -116,8 +119,10 @@ export class ItemMetadataComponent implements OnInit { this.objectUpdatesService.initialize(this.url, this.item.metadata, this.item.lastModified); } - /* Prevent unnecessary rerendering so fields don't lose focus **/ - protected trackUpdate(index, update: FieldUpdate) { + /** + * Prevent unnecessary rerendering so fields don't lose focus + */ + trackUpdate(index, update: FieldUpdate) { return update && update.field ? update.field.uuid : undefined; } diff --git a/src/app/+item-page/edit-item-page/item-status/item-status.component.html b/src/app/+item-page/edit-item-page/item-status/item-status.component.html index 0f7d9a5607..e60fa0490d 100644 --- a/src/app/+item-page/edit-item-page/item-status/item-status.component.html +++ b/src/app/+item-page/edit-item-page/item-status/item-status.component.html @@ -12,7 +12,7 @@ {{'item.edit.tabs.status.labels.itemPage' | translate}}:
    diff --git a/src/app/+item-page/edit-item-page/item-status/item-status.component.ts b/src/app/+item-page/edit-item-page/item-status/item-status.component.ts index 28cd23a5fe..b9a9e4a2f3 100644 --- a/src/app/+item-page/edit-item-page/item-status/item-status.component.ts +++ b/src/app/+item-page/edit-item-page/item-status/item-status.component.ts @@ -6,6 +6,7 @@ import { ItemOperation } from '../item-operation/itemOperation.model'; import { first, map } from 'rxjs/operators'; import { Observable } from 'rxjs'; import { RemoteData } from '../../../core/data/remote-data'; +import { getItemEditPath, getItemPageRoute } from '../../item-page-routing.module'; @Component({ selector: 'ds-item-status', @@ -68,16 +69,16 @@ export class ItemStatusComponent implements OnInit { */ this.operations = []; if (item.isWithdrawn) { - this.operations.push(new ItemOperation('reinstate', this.getCurrentUrl() + '/reinstate')); + this.operations.push(new ItemOperation('reinstate', this.getCurrentUrl(item) + '/reinstate')); } else { - this.operations.push(new ItemOperation('withdraw', this.getCurrentUrl() + '/withdraw')); + this.operations.push(new ItemOperation('withdraw', this.getCurrentUrl(item) + '/withdraw')); } if (item.isDiscoverable) { - this.operations.push(new ItemOperation('private', this.getCurrentUrl() + '/private')); + this.operations.push(new ItemOperation('private', this.getCurrentUrl(item) + '/private')); } else { - this.operations.push(new ItemOperation('public', this.getCurrentUrl() + '/public')); + this.operations.push(new ItemOperation('public', this.getCurrentUrl(item) + '/public')); } - this.operations.push(new ItemOperation('delete', this.getCurrentUrl() + '/delete')); + this.operations.push(new ItemOperation('delete', this.getCurrentUrl(item) + '/delete')); }); } @@ -86,20 +87,16 @@ export class ItemStatusComponent implements OnInit { * Get the url to the simple item page * @returns {string} url */ - getItemPage(): string { - return this.router.url.substr(0, this.router.url.lastIndexOf('/')); + getItemPage(item: Item): string { + return getItemPageRoute(item.id) } /** * Get the current url without query params * @returns {string} url */ - getCurrentUrl(): string { - if (this.router.url.indexOf('?') > -1) { - return this.router.url.substr(0, this.router.url.indexOf('?')); - } else { - return this.router.url; - } + getCurrentUrl(item: Item): string { + return getItemEditPath(item.id); } } diff --git a/src/app/core/core.module.ts b/src/app/core/core.module.ts index 1039ded993..357f552074 100644 --- a/src/app/core/core.module.ts +++ b/src/app/core/core.module.ts @@ -68,6 +68,7 @@ import { MenuService } from '../shared/menu/menu.service'; import { NormalizedObjectBuildService } from './cache/builders/normalized-object-build.service'; import { DSOChangeAnalyzer } from './data/dso-change-analyzer.service'; import { ObjectUpdatesService } from './data/object-updates/object-updates.service'; +import { DefaultChangeAnalyzer } from './data/default-change-analyzer.service'; const IMPORTS = [ CommonModule, @@ -133,6 +134,7 @@ const PROVIDERS = [ UUIDService, DSpaceObjectDataService, DSOChangeAnalyzer, + DefaultChangeAnalyzer, CSSVariableService, MenuService, ObjectUpdatesService, diff --git a/src/app/core/data/default-change-analyzer.service.ts b/src/app/core/data/default-change-analyzer.service.ts new file mode 100644 index 0000000000..1fd207d2bf --- /dev/null +++ b/src/app/core/data/default-change-analyzer.service.ts @@ -0,0 +1,29 @@ +import { Operation } from 'fast-json-patch/lib/core'; +import { compare } from 'fast-json-patch'; +import { ChangeAnalyzer } from './change-analyzer'; +import { NormalizedDSpaceObject } from '../cache/models/normalized-dspace-object.model'; +import { Injectable } from '@angular/core'; +import { DSpaceObject } from '../shared/dspace-object.model'; +import { CacheableObject } from '../cache/object-cache.reducer'; +import { NormalizedObject } from '../cache/models/normalized-object.model'; + +/** + * A class to determine what differs between two + * CacheableObjects + */ +@Injectable() +export class DefaultChangeAnalyzer implements ChangeAnalyzer { + + /** + * Compare the metadata of two CacheableObject and return the differences as + * a JsonPatch Operation Array + * + * @param {NormalizedObject} object1 + * The first object to compare + * @param {NormalizedObject} object2 + * The second object to compare + */ + diff(object1: T | NormalizedObject, object2: T | NormalizedObject): Operation[] { + return compare(object1, object2); + } +} diff --git a/src/app/core/data/metadata-schema-data.service.ts b/src/app/core/data/metadata-schema-data.service.ts index 7f17ad9cf1..ab5b859530 100644 --- a/src/app/core/data/metadata-schema-data.service.ts +++ b/src/app/core/data/metadata-schema-data.service.ts @@ -11,10 +11,10 @@ import { HALEndpointService } from '../shared/hal-endpoint.service'; import { FindAllOptions } from './request.models'; import { ObjectCacheService } from '../cache/object-cache.service'; import { MetadataSchema } from '../metadata/metadataschema.model'; -import { ChangeAnalyzer } from './change-analyzer'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { HttpClient } from '@angular/common/http'; import { NotificationsService } from '../../shared/notifications/notifications.service'; +import { DefaultChangeAnalyzer } from './default-change-analyzer.service'; @Injectable() export class MetadataSchemaDataService extends DataService { @@ -27,7 +27,7 @@ export class MetadataSchemaDataService extends DataService { private bs: BrowseService, protected halService: HALEndpointService, protected objectCache: ObjectCacheService, - protected comparator: ChangeAnalyzer, + protected comparator: DefaultChangeAnalyzer, protected dataBuildService: NormalizedObjectBuildService, protected http: HttpClient, protected notificationsService: NotificationsService) { diff --git a/src/app/core/metadata/metadata.service.spec.ts b/src/app/core/metadata/metadata.service.spec.ts index 1841fba6a0..25579a0690 100644 --- a/src/app/core/metadata/metadata.service.spec.ts +++ b/src/app/core/metadata/metadata.service.spec.ts @@ -228,6 +228,7 @@ describe('MetadataService', () => { const mockPublisher = (mockItem: Item): Item => { const publishedMockItem = Object.assign(new Item(), mockItem) as Item; publishedMockItem.metadata.push({ + uuid: 'b3826cf5-5f07-44cf-88d8-2da968354d18', key: 'dc.publisher', language: 'en_US', value: 'Mock Publisher' diff --git a/src/styles/_bootstrap_variables.scss b/src/styles/_bootstrap_variables.scss index d24811b382..7be76ff5d3 100644 --- a/src/styles/_bootstrap_variables.scss +++ b/src/styles/_bootstrap_variables.scss @@ -19,7 +19,6 @@ $gray-700: lighten($gray-base, 46.6%) !default; // #777 $gray-600: lighten($gray-base, 73.3%) !default; // #bbb $gray-100: lighten($gray-base, 93.5%) !default; // #eee - /* Reassign color vars to semantic color scheme */ $blue: #2B4E72 !default; $green: #94BA65 !default; diff --git a/src/styles/_custom_variables.scss b/src/styles/_custom_variables.scss index dda018ad2c..05387e8740 100644 --- a/src/styles/_custom_variables.scss +++ b/src/styles/_custom_variables.scss @@ -1,7 +1,6 @@ $content-spacing: $spacer * 1.5; $button-height: $input-btn-padding-y * 2 + $input-btn-line-height + calculateRem($input-btn-border-width*2); -$button-min-width: 100px; $card-height-percentage:98%; $card-thumbnail-height:240px; @@ -24,3 +23,6 @@ $admin-sidebar-header-bg: darken($dark, 7%); $dark-scrollbar-background: $admin-sidebar-active-bg; $dark-scrollbar-foreground: #47495d; + +$edit-item-button-min-width: 100px; +$edit-item-metadata-field-width: 190px; \ No newline at end of file From 1cea791cba6e014d3a1283227c5286fb3768a7a2 Mon Sep 17 00:00:00 2001 From: lotte Date: Tue, 19 Feb 2019 15:59:03 +0100 Subject: [PATCH 11/18] fixed tests and added some more documentation --- .../edit-item-page.component.ts | 4 ++ .../edit-in-place-field.component.spec.ts | 38 ++------------- .../item-metadata.component.html | 4 +- .../item-metadata.component.spec.ts | 46 +++++++++++++++---- .../item-status/item-status.component.spec.ts | 9 +--- .../item-status/item-status.component.ts | 6 +-- .../object-updates/object-updates.actions.ts | 5 +- .../object-updates/object-updates.reducer.ts | 32 ++++++++++++- .../input-suggestions.component.ts | 6 +-- .../input-suggestions.model.ts | 10 ++++ 10 files changed, 100 insertions(+), 60 deletions(-) diff --git a/src/app/+item-page/edit-item-page/edit-item-page.component.ts b/src/app/+item-page/edit-item-page/edit-item-page.component.ts index efde7c52fb..4ea47f08e7 100644 --- a/src/app/+item-page/edit-item-page/edit-item-page.component.ts +++ b/src/app/+item-page/edit-item-page/edit-item-page.component.ts @@ -50,6 +50,10 @@ export class EditItemPageComponent implements OnInit { this.itemRD$ = this.route.data.pipe(map((data) => data.item)); } + /** + * Get the item page url + * @param item The item for which the url is requested + */ getItemPage(item: Item): string { return getItemPageRoute(item.id) } diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index 133ee19e43..565c720a75 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -89,7 +89,7 @@ describe('EditInPlaceFieldComponent', () => { beforeEach(() => { fixture = TestBed.createComponent(EditInPlaceFieldComponent); comp = fixture.componentInstance; // EditInPlaceFieldComponent test instance - de = fixture.debugElement.query(By.css('div.d-flex')); + de = fixture.debugElement; el = de.nativeElement; comp.url = url; @@ -109,36 +109,6 @@ describe('EditInPlaceFieldComponent', () => { }); }); - describe('changeType is UPDATE', () => { - beforeEach(() => { - comp.fieldUpdate.changeType = FieldChangeType.UPDATE; - fixture.detectChanges(); - }); - it('the div should have class table-warning', () => { - expect(el.classList).toContain('table-warning'); - }); - }); - - describe('changeType is ADD', () => { - beforeEach(() => { - comp.fieldUpdate.changeType = FieldChangeType.ADD; - fixture.detectChanges(); - }); - it('the div should have class table-success', () => { - expect(el.classList).toContain('table-success'); - }); - }); - - describe('changeType is REMOVE', () => { - beforeEach(() => { - comp.fieldUpdate.changeType = FieldChangeType.REMOVE; - fixture.detectChanges(); - }); - it('the div should have class table-danger', () => { - expect(el.classList).toContain('table-danger'); - }); - }); - describe('setEditable', () => { const editable = false; beforeEach(() => { @@ -223,9 +193,9 @@ describe('EditInPlaceFieldComponent', () => { const metadataFieldSuggestions: InputSuggestion[] = [ - { displayValue: mdField1.toString(), value: mdField1.toString() }, - { displayValue: mdField2.toString(), value: mdField2.toString() }, - { displayValue: mdField3.toString(), value: mdField3.toString() } + { displayValue: mdField1.toString().split('.').join('.​'), value: mdField1.toString() }, + { displayValue: mdField2.toString().split('.').join('.​'), value: mdField2.toString() }, + { displayValue: mdField3.toString().split('.').join('.​'), value: mdField3.toString() } ]; beforeEach(() => { diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index bb0c188f05..03b0e143b4 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -30,8 +30,8 @@ {{'item.edit.metadata.headers.language' | translate}} {{'item.edit.metadata.headers.edit' | translate}} - -
    - {{metadata?.value}} -
    -
    +
    +
    + {{metadata?.value}} +
    +
    +
    -
    - {{metadata?.language}} -
    -
    - +
    +
    + {{metadata?.language}} +
    +
    + +
    -
    +
    diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index 7d4922de43..47bcc66537 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -11,7 +11,7 @@ import { FieldChangeType } from '../../../../core/data/object-updates/object-upd import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; import { getSucceededRemoteData } from '../../../../core/shared/operators'; -import { FormControl } from '@angular/forms'; +import { NgModel } from '@angular/forms'; @Component({ // tslint:disable-next-line:component-selector @@ -27,14 +27,22 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * The current field, value and state of the metadatum */ @Input() fieldUpdate: FieldUpdate; + /** * The current url of this page */ @Input() url: string; + + /** + * List of strings with all metadata field keys available + */ + @Input() metadataFields: string[]; + /** * The metadatum of this field */ metadata: Metadatum; + /** * Emits whether or not this field is currently editable */ @@ -50,11 +58,6 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { */ metadataFieldSuggestions: BehaviorSubject = new BehaviorSubject([]); - /** - * List of strings with all metadata field keys available - */ - metadataFields: Observable; - constructor( private metadataFieldService: RegistryService, private objectUpdatesService: ObjectUpdatesService, @@ -67,26 +70,26 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { ngOnInit(): void { this.editable = this.objectUpdatesService.isEditable(this.url, this.metadata.uuid); this.valid = this.objectUpdatesService.isValid(this.url, this.metadata.uuid); - this.metadataFields = this.findMetadataFields() } /** * Sends a new change update for this field to the object updates service */ - update(control?: FormControl) { + update(ngModel?: NgModel) { this.objectUpdatesService.saveChangeFieldUpdate(this.url, this.metadata); - if (hasValue(control)) { - this.checkValidity(control); + if (hasValue(ngModel)) { + this.checkValidity(ngModel); } } /** * Method to check the validity of a form control - * @param control The form control to check + * @param ngModel */ - private checkValidity(control: FormControl) { - control.updateValueAndValidity(); - this.objectUpdatesService.setValidFieldUpdate(this.url, this.metadata.uuid, control.valid); + private checkValidity(ngModel: NgModel) { + ngModel.control.setValue(ngModel.viewModel); + ngModel.control.updateValueAndValidity(); + this.objectUpdatesService.setValidFieldUpdate(this.url, this.metadata.uuid, ngModel.control.valid); } /** @@ -124,30 +127,24 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * @param query The query to look for */ findMetadataFieldSuggestions(query: string): void { - this.metadataFieldService.queryMetadataFields(query).pipe( - // getSucceededRemoteData(), - take(1), - map((data) => data.payload.page) - ).subscribe( - (fields: MetadataField[]) => this.metadataFieldSuggestions.next( - fields.map((field: MetadataField) => { - return { - displayValue: field.toString().split('.').join('.​'), - value: field.toString() - } - }) - ) - ); - } - - /** - * Method to request all metadata fields and convert them to a list of strings - */ - findMetadataFields(): Observable { - return this.metadataFieldService.getAllMetadataFields().pipe( - getSucceededRemoteData(), - take(1), - map((remoteData$) => remoteData$.payload.page.map((field: MetadataField) => field.toString()))); + if (isNotEmpty(query)) { + this.metadataFieldService.queryMetadataFields(query).pipe( + // getSucceededRemoteData(), + take(1), + map((data) => data.payload.page) + ).subscribe( + (fields: MetadataField[]) => this.metadataFieldSuggestions.next( + fields.map((field: MetadataField) => { + return { + displayValue: field.toString().split('.').join('.​'), + value: field.toString() + }; + }) + ) + ); + } else { + this.metadataFieldSuggestions.next([]); + } } /** diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html index 03b0e143b4..496429a3ba 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.html @@ -33,6 +33,7 @@ + (dsClickOutside)="close();">
    diff --git a/src/app/shared/input-suggestions/input-suggestions.component.ts b/src/app/shared/input-suggestions/input-suggestions.component.ts index c754ecfb97..620c984be3 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.ts @@ -85,11 +85,6 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange */ @Output() findSuggestions = new EventEmitter(); - /** - * Emits event when the input field loses focus - */ - @Output() blur = new EventEmitter(); - /** * Emits true when the list of suggestions should be shown */ @@ -119,9 +114,14 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange */ _value: string; + /** Fields needed to add ngModel */ + @Input() disabled = false; propagateChange = (_: any) => { /* Empty implementation */ }; + propagateTouch = (_: any) => { + /* Empty implementation */ + }; /** * When any of the inputs change, check if we should still show the suggestions @@ -214,9 +214,9 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange find(data) { if (!this.blockReopen) { this.findSuggestions.emit(data); + this.typeSuggestion.emit(data); } this.blockReopen = false; - this.typeSuggestion.emit(data); } onSubmit(data) { @@ -230,11 +230,11 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange } registerOnTouched(fn: any): void { - /* no implementation */ + this.propagateTouch = fn; } setDisabledState(isDisabled: boolean): void { - /* no implementation */ + this.disabled = isDisabled; } writeValue(value: any): void { diff --git a/src/app/shared/utils/auto-focus.directive.ts b/src/app/shared/utils/auto-focus.directive.ts index b6ebdcbb7f..b009754412 100644 --- a/src/app/shared/utils/auto-focus.directive.ts +++ b/src/app/shared/utils/auto-focus.directive.ts @@ -14,7 +14,6 @@ export class AutoFocusDirective implements AfterViewInit { ngAfterViewInit() { if (isNotEmpty(this.autoFocusSelector)) { return this.el.nativeElement.querySelector(this.autoFocusSelector).focus(); - } else { return this.el.nativeElement.focus(); } diff --git a/src/app/shared/utils/click-outside.directive.ts b/src/app/shared/utils/click-outside.directive.ts index e8efdf2d7a..b9397c65e5 100644 --- a/src/app/shared/utils/click-outside.directive.ts +++ b/src/app/shared/utils/click-outside.directive.ts @@ -16,9 +16,11 @@ export class ClickOutsideDirective { constructor(private _elementRef: ElementRef) { } - @HostListener('document:click', ['$event.target']) - public onClick(targetElement) { - const clickedInside = this._elementRef.nativeElement.contains(targetElement); + @HostListener('document:click') + public onClick() { + const hostElement = this._elementRef.nativeElement; + const focusElement = hostElement.ownerDocument.activeElement; + const clickedInside = hostElement.contains(focusElement); if (!clickedInside) { this.dsClickOutside.emit(null); } diff --git a/src/app/shared/utils/debounce.directive.ts b/src/app/shared/utils/debounce.directive.ts index c2f2ecf076..8830679e2b 100644 --- a/src/app/shared/utils/debounce.directive.ts +++ b/src/app/shared/utils/debounce.directive.ts @@ -25,12 +25,6 @@ export class DebounceDirective implements OnInit, OnDestroy { @Input() public dsDebounce = 500; - /** - * True if no changes have been made to the input field's value - */ - @Input() - private isFirstChange = true; - /** * Subject to unsubscribe from */ @@ -47,11 +41,9 @@ export class DebounceDirective implements OnInit, OnDestroy { this.model.valueChanges.pipe( takeUntil(this.subject), debounceTime(this.dsDebounce), - distinctUntilChanged(),) + distinctUntilChanged()) .subscribe((modelValue) => { - if (this.isFirstChange) { - this.isFirstChange = false; - } else { + if (this.model.dirty) { this.onDebounce.emit(modelValue); } }); diff --git a/src/app/shared/utils/in-list-validator.directive.ts b/src/app/shared/utils/in-list-validator.directive.ts index 621ae93b83..42ff7da1fd 100644 --- a/src/app/shared/utils/in-list-validator.directive.ts +++ b/src/app/shared/utils/in-list-validator.directive.ts @@ -24,9 +24,6 @@ export class InListValidator implements Validator { * @param c The FormControl */ validate(c: FormControl): ValidationErrors | null { - if (this.dsInListValidator !== null) { - return inListValidator(this.dsInListValidator)(c); - } - return null; + return inListValidator(this.dsInListValidator)(c); } } diff --git a/src/app/shared/utils/validator.functions.ts b/src/app/shared/utils/validator.functions.ts index 3ad660731a..464a4f5487 100644 --- a/src/app/shared/utils/validator.functions.ts +++ b/src/app/shared/utils/validator.functions.ts @@ -1,11 +1,17 @@ import { AbstractControl, ValidatorFn } from '@angular/forms'; +import { isNotEmpty } from '../empty.util'; /** * Returns a validator function to check if the control's value is in a given list * @param list The list to look in */ export function inListValidator(list: string[]): ValidatorFn { - return (control: AbstractControl): {[key: string]: any} | null => { - const contains = list.indexOf(control.value) > -1; - return contains ? null : {inList: {value: control.value}} }; + return (control: AbstractControl): { [key: string]: any } | null => { + const hasValue = isNotEmpty(control.value); + let inList = true; + if (isNotEmpty(list)) { + inList = list.indexOf(control.value) > -1; + } + return (hasValue && inList) ? null : { inList: { value: control.value } } + }; } From 8a9f57966f5d020c02660d0371d73c8ed475c98f Mon Sep 17 00:00:00 2001 From: lotte Date: Tue, 26 Feb 2019 16:06:33 +0100 Subject: [PATCH 14/18] Fixed conflicts with new metadata map --- .../edit-in-place-field.component.spec.ts | 4 +- .../edit-in-place-field.component.ts | 7 +- .../item-metadata.component.spec.ts | 10 +- .../item-metadata/item-metadata.component.ts | 17 +-- .../modify-item-overview.component.ts | 2 +- .../metadata-uri-values.component.ts | 2 +- .../metadata-values.component.ts | 2 +- .../full/full-item-page.component.ts | 2 +- .../normalized-search-result.model.ts | 2 +- src/app/+search-page/search-result.model.ts | 2 +- .../models/normalized-dspace-object.model.ts | 18 +-- .../data/search-response-parsing.service.ts | 4 +- src/app/core/eperson/models/eperson.model.ts | 2 +- .../core/metadata/metadata.service.spec.ts | 2 +- src/app/core/shared/dspace-object.model.ts | 12 +- src/app/core/shared/metadata.interfaces.ts | 30 ----- src/app/core/shared/metadata.model.spec.ts | 112 ++++++++++++------ src/app/core/shared/metadata.models.ts | 75 ++++++++++++ .../{metadata.model.ts => metadata.utils.ts} | 41 ++++++- .../comcol-form/comcol-form.component.ts | 9 +- .../input-suggestions.component.ts | 4 +- .../search-result-grid-element.component.ts | 2 +- .../search-result-list-element.component.ts | 2 +- 23 files changed, 243 insertions(+), 120 deletions(-) delete mode 100644 src/app/core/shared/metadata.interfaces.ts create mode 100644 src/app/core/shared/metadata.models.ts rename src/app/core/shared/{metadata.model.ts => metadata.utils.ts} (85%) diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index 565c720a75..02e4bf3413 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -8,7 +8,6 @@ import { RemoteData } from '../../../../core/data/remote-data'; import { PaginatedList } from '../../../../core/data/paginated-list'; import { MetadataField } from '../../../../core/metadata/metadatafield.model'; import { By } from '@angular/platform-browser'; -import { Metadatum } from '../../../../core/shared/metadatum.model'; import { FormsModule } from '@angular/forms'; import { SharedModule } from '../../../../shared/shared.module'; import { getTestScheduler } from 'jasmine-marbles'; @@ -17,6 +16,7 @@ import { TestScheduler } from 'rxjs/testing'; import { MetadataSchema } from '../../../../core/metadata/metadataschema.model'; import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; import { TranslateModule } from '@ngx-translate/core'; +import { MetadatumViewModel } from '../../../../core/shared/metadata.models'; let comp: EditInPlaceFieldComponent; let fixture: ComponentFixture; @@ -38,7 +38,7 @@ const mdField3 = Object.assign(new MetadataField(), { qualifier: 'abstract' }); -const metadatum = Object.assign(new Metadatum(), { +const metadatum = Object.assign(new MetadatumViewModel(), { key: 'dc.description.abstract', value: 'Example abstract', language: 'en' diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts index 47bcc66537..0b9bc62c55 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.ts @@ -1,6 +1,5 @@ import { Component, Input, OnChanges, OnInit } from '@angular/core'; import { hasValue, isNotEmpty } from '../../../../shared/empty.util'; -import { Metadatum } from '../../../../core/shared/metadatum.model'; import { RegistryService } from '../../../../core/registry/registry.service'; import { cloneDeep } from 'lodash'; import { BehaviorSubject, Observable, of as observableOf } from 'rxjs'; @@ -10,8 +9,8 @@ import { InputSuggestion } from '../../../../shared/input-suggestions/input-sugg import { FieldChangeType } from '../../../../core/data/object-updates/object-updates.actions'; import { FieldUpdate } from '../../../../core/data/object-updates/object-updates.reducer'; import { ObjectUpdatesService } from '../../../../core/data/object-updates/object-updates.service'; -import { getSucceededRemoteData } from '../../../../core/shared/operators'; import { NgModel } from '@angular/forms'; +import { MetadatumViewModel } from '../../../../core/shared/metadata.models'; @Component({ // tslint:disable-next-line:component-selector @@ -41,7 +40,7 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { /** * The metadatum of this field */ - metadata: Metadatum; + metadata: MetadatumViewModel; /** * Emits whether or not this field is currently editable @@ -118,7 +117,7 @@ export class EditInPlaceFieldComponent implements OnInit, OnChanges { * Sets the current metadatafield based on the fieldUpdate input field */ ngOnChanges(): void { - this.metadata = cloneDeep(this.fieldUpdate.field) as Metadatum; + this.metadata = cloneDeep(this.fieldUpdate.field) as MetadatumViewModel; } /** diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts index 840a086293..c1d36c70fa 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts @@ -3,7 +3,6 @@ import { CUSTOM_ELEMENTS_SCHEMA, DebugElement, NO_ERRORS_SCHEMA } from '@angular import { of as observableOf } from 'rxjs'; import { getTestScheduler } from 'jasmine-marbles'; import { ItemMetadataComponent } from './item-metadata.component'; -import { Metadatum } from '../../../core/shared/metadatum.model'; import { TestScheduler } from 'rxjs/testing'; import { SharedModule } from '../../../shared/shared.module'; import { ObjectUpdatesService } from '../../../core/data/object-updates/object-updates.service'; @@ -22,6 +21,7 @@ import { GLOBAL_CONFIG } from '../../../../config'; import { Item } from '../../../core/shared/item.model'; import { FieldChangeType } from '../../../core/data/object-updates/object-updates.actions'; import { RemoteData } from '../../../core/data/remote-data'; +import { MetadatumViewModel } from '../../../core/shared/metadata.models'; let comp: ItemMetadataComponent; let fixture: ComponentFixture; @@ -43,19 +43,19 @@ const notificationsService = jasmine.createSpyObj('notificationsService', success: successNotification } ); -const metadatum1 = Object.assign(new Metadatum(), { +const metadatum1 = Object.assign(new MetadatumViewModel(), { key: 'dc.description.abstract', value: 'Example abstract', language: 'en' }); -const metadatum2 = Object.assign(new Metadatum(), { +const metadatum2 = Object.assign(new MetadatumViewModel(), { key: 'dc.title', value: 'Title test', language: 'de' }); -const metadatum3 = Object.assign(new Metadatum(), { +const metadatum3 = Object.assign(new MetadatumViewModel(), { key: 'dc.contributor.author', value: 'Shakespeare, William', }); @@ -140,7 +140,7 @@ describe('ItemMetadataComponent', () => { }); describe('add', () => { - const md = new Metadatum(); + const md = new MetadatumViewModel(); beforeEach(() => { comp.add(md); }); diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index 7b02d6fd1e..fb6820d5fd 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -10,7 +10,6 @@ import { FieldUpdates, Identifiable } from '../../../core/data/object-updates/object-updates.reducer'; -import { Metadatum } from '../../../core/shared/metadatum.model'; import { first, map, switchMap, take, tap } from 'rxjs/operators'; import { getSucceededRemoteData } from '../../../core/shared/operators'; import { RemoteData } from '../../../core/data/remote-data'; @@ -19,6 +18,8 @@ import { GLOBAL_CONFIG, GlobalConfig } from '../../../../config'; import { TranslateService } from '@ngx-translate/core'; import { RegistryService } from '../../../core/registry/registry.service'; import { MetadataField } from '../../../core/metadata/metadatafield.model'; +import { MetadatumViewModel } from '../../../core/shared/metadata.models'; +import { Metadata } from '../../../core/shared/metadata.utils'; @Component({ selector: 'ds-item-metadata', @@ -92,14 +93,14 @@ export class ItemMetadataComponent implements OnInit { this.checkLastModified(); } }); - this.updates$ = this.objectUpdatesService.getFieldUpdates(this.url, this.item.metadata); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.url, this.item.metadataAsList); } /** * Sends a new add update for a field to the object updates service * @param metadata The metadata to add, if no parameter is supplied, create a new Metadatum */ - add(metadata: Metadatum = new Metadatum()) { + add(metadata: MetadatumViewModel = new MetadatumViewModel()) { this.objectUpdatesService.saveAddFieldUpdate(this.url, metadata); } @@ -124,7 +125,7 @@ export class ItemMetadataComponent implements OnInit { * Sends all initial values of this item to the object updates service */ private initializeOriginalFields() { - this.objectUpdatesService.initialize(this.url, this.item.metadata, this.item.lastModified); + this.objectUpdatesService.initialize(this.url, this.item.metadataAsList, this.item.lastModified); } /** @@ -141,11 +142,11 @@ export class ItemMetadataComponent implements OnInit { submit() { this.isValid().pipe(first()).subscribe((isValid) => { if (isValid) { - const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.url, this.item.metadata) as Observable; + const metadata$: Observable = this.objectUpdatesService.getUpdatedFields(this.url, this.item.metadataAsList) as Observable; metadata$.pipe( first(), - switchMap((metadata: Metadatum[]) => { - const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata }); + switchMap((metadata: MetadatumViewModel[]) => { + const updatedItem: Item = Object.assign(cloneDeep(this.item), { metadata: Metadata.toMetadataMap(metadata) }); return this.itemService.update(updatedItem); }), tap(() => this.itemService.commitUpdates()), @@ -154,7 +155,7 @@ export class ItemMetadataComponent implements OnInit { (rd: RemoteData) => { this.item = rd.payload; this.initializeOriginalFields(); - this.updates$ = this.objectUpdatesService.getFieldUpdates(this.url, this.item.metadata); + this.updates$ = this.objectUpdatesService.getFieldUpdates(this.url, this.item.metadataAsList); this.notificationsService.success(this.getNotificationTitle('saved'), this.getNotificationContent('saved')); } ) diff --git a/src/app/+item-page/edit-item-page/modify-item-overview/modify-item-overview.component.ts b/src/app/+item-page/edit-item-page/modify-item-overview/modify-item-overview.component.ts index 282f8687e1..974bc8d37f 100644 --- a/src/app/+item-page/edit-item-page/modify-item-overview/modify-item-overview.component.ts +++ b/src/app/+item-page/edit-item-page/modify-item-overview/modify-item-overview.component.ts @@ -1,6 +1,6 @@ import {Component, Input, OnInit} from '@angular/core'; import {Item} from '../../../core/shared/item.model'; -import {MetadataMap} from '../../../core/shared/metadata.interfaces'; +import {MetadataMap} from '../../../core/shared/metadata.models'; @Component({ selector: 'ds-modify-item-overview', diff --git a/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts b/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts index 09d855e951..67684d44af 100644 --- a/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts +++ b/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts @@ -1,7 +1,7 @@ import { Component, Input } from '@angular/core'; import { MetadataValuesComponent } from '../metadata-values/metadata-values.component'; -import { MetadataValue } from '../../../core/shared/metadata.interfaces'; +import { MetadataValue } from '../../../core/shared/metadata.models'; /** * This component renders the configured 'values' into the ds-metadata-field-wrapper component as a link. diff --git a/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts b/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts index 708bdb49c7..abcd90848d 100644 --- a/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts +++ b/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts @@ -1,5 +1,5 @@ import { Component, Input } from '@angular/core'; -import { MetadataValue } from '../../../core/shared/metadata.interfaces'; +import { MetadataValue } from '../../../core/shared/metadata.models'; /** * This component renders the configured 'values' into the ds-metadata-field-wrapper component. diff --git a/src/app/+item-page/full/full-item-page.component.ts b/src/app/+item-page/full/full-item-page.component.ts index fcb724b564..6e19a50864 100644 --- a/src/app/+item-page/full/full-item-page.component.ts +++ b/src/app/+item-page/full/full-item-page.component.ts @@ -6,7 +6,7 @@ import { ActivatedRoute } from '@angular/router'; import { Observable } from 'rxjs'; import { ItemPageComponent } from '../simple/item-page.component'; -import { MetadataMap } from '../../core/shared/metadata.interfaces'; +import { MetadataMap } from '../../core/shared/metadata.models'; import { ItemDataService } from '../../core/data/item-data.service'; import { RemoteData } from '../../core/data/remote-data'; diff --git a/src/app/+search-page/normalized-search-result.model.ts b/src/app/+search-page/normalized-search-result.model.ts index 3c1a46872c..46f14c042d 100644 --- a/src/app/+search-page/normalized-search-result.model.ts +++ b/src/app/+search-page/normalized-search-result.model.ts @@ -1,5 +1,5 @@ import { autoserialize } from 'cerialize'; -import { MetadataMap } from '../core/shared/metadata.interfaces'; +import { MetadataMap } from '../core/shared/metadata.models'; import { ListableObject } from '../shared/object-collection/shared/listable-object.model'; /** diff --git a/src/app/+search-page/search-result.model.ts b/src/app/+search-page/search-result.model.ts index b2e5eafdec..ff865610c6 100644 --- a/src/app/+search-page/search-result.model.ts +++ b/src/app/+search-page/search-result.model.ts @@ -1,5 +1,5 @@ import { DSpaceObject } from '../core/shared/dspace-object.model'; -import { MetadataMap } from '../core/shared/metadata.interfaces'; +import { MetadataMap } from '../core/shared/metadata.models'; import { ListableObject } from '../shared/object-collection/shared/listable-object.model'; /** diff --git a/src/app/core/cache/models/normalized-dspace-object.model.ts b/src/app/core/cache/models/normalized-dspace-object.model.ts index c53607ce79..2248b62509 100644 --- a/src/app/core/cache/models/normalized-dspace-object.model.ts +++ b/src/app/core/cache/models/normalized-dspace-object.model.ts @@ -1,6 +1,6 @@ -import { autoserialize, autoserializeAs, deserialize, serialize } from 'cerialize'; +import { autoserializeAs, deserializeAs } from 'cerialize'; import { DSpaceObject } from '../../shared/dspace-object.model'; -import { MetadataMap } from '../../shared/metadata.interfaces'; +import { MetadataMap, MetadataMapSerializer } from '../../shared/metadata.models'; import { ResourceType } from '../../shared/resource-type'; import { mapsTo } from '../builders/build-decorators'; import { NormalizedObject } from './normalized-object.model'; @@ -17,7 +17,7 @@ export class NormalizedDSpaceObject extends NormalizedOb * Repeated here to make the serialization work, * inheritSerialization doesn't seem to work for more than one level */ - @deserialize + @deserializeAs(String) self: string; /** @@ -35,31 +35,31 @@ export class NormalizedDSpaceObject extends NormalizedOb * Repeated here to make the serialization work, * inheritSerialization doesn't seem to work for more than one level */ - @autoserialize + @autoserializeAs(String) uuid: string; /** * A string representing the kind of DSpaceObject, e.g. community, item, … */ - @autoserialize + @autoserializeAs(String) type: ResourceType; /** * All metadata of this DSpaceObject */ - @autoserialize + @autoserializeAs(MetadataMapSerializer) metadata: MetadataMap; /** * An array of DSpaceObjects that are direct parents of this DSpaceObject */ - @deserialize + @deserializeAs(String) parents: string[]; /** * The DSpaceObject that owns this DSpaceObject */ - @deserialize + @deserializeAs(String) owner: string; /** @@ -68,7 +68,7 @@ export class NormalizedDSpaceObject extends NormalizedOb * Repeated here to make the serialization work, * inheritSerialization doesn't seem to work for more than one level */ - @deserialize + @deserializeAs(Object) _links: { [name: string]: string } diff --git a/src/app/core/data/search-response-parsing.service.ts b/src/app/core/data/search-response-parsing.service.ts index 46b2572c4e..8e3171d05e 100644 --- a/src/app/core/data/search-response-parsing.service.ts +++ b/src/app/core/data/search-response-parsing.service.ts @@ -7,7 +7,7 @@ import { DSpaceRESTV2Response } from '../dspace-rest-v2/dspace-rest-v2-response. import { DSpaceRESTv2Serializer } from '../dspace-rest-v2/dspace-rest-v2.serializer'; import { hasValue } from '../../shared/empty.util'; import { SearchQueryResponse } from '../../+search-page/search-service/search-query-response.model'; -import { MetadataMap, MetadataValue } from '../shared/metadata.interfaces'; +import { MetadataMap, MetadataValue } from '../shared/metadata.models'; @Injectable() export class SearchResponseParsingService implements ResponseParsingService { @@ -22,7 +22,7 @@ export class SearchResponseParsingService implements ResponseParsingService { const mdMap: MetadataMap = {}; if (hhObject) { for (const key of Object.keys(hhObject)) { - const value: MetadataValue = { value: hhObject[key].join('...'), language: null }; + const value: MetadataValue = Object.assign(new MetadataValue(), { value: hhObject[key].join('...'), language: null }); mdMap[key] = [ value ]; } } diff --git a/src/app/core/eperson/models/eperson.model.ts b/src/app/core/eperson/models/eperson.model.ts index c349d22a9e..0218e52c7d 100644 --- a/src/app/core/eperson/models/eperson.model.ts +++ b/src/app/core/eperson/models/eperson.model.ts @@ -20,6 +20,6 @@ export class EPerson extends DSpaceObject { public selfRegistered: boolean; get name(): string { - return this.findMetadata('eperson.firstname') + ' ' + this.findMetadata('eperson.lastname'); + return this.firstMetadataValue('eperson.firstname') + ' ' + this.firstMetadataValue('eperson.lastname'); } } diff --git a/src/app/core/metadata/metadata.service.spec.ts b/src/app/core/metadata/metadata.service.spec.ts index 15b1bb52df..bd3532b840 100644 --- a/src/app/core/metadata/metadata.service.spec.ts +++ b/src/app/core/metadata/metadata.service.spec.ts @@ -37,7 +37,7 @@ import { HttpClient } from '@angular/common/http'; import { EmptyError } from 'rxjs/internal-compatibility'; import { NormalizedObjectBuildService } from '../cache/builders/normalized-object-build.service'; import { DSOChangeAnalyzer } from '../data/dso-change-analyzer.service'; -import { MetadataValue } from '../shared/metadata.interfaces'; +import { MetadataValue } from '../shared/metadata.models'; /* tslint:disable:max-classes-per-file */ @Component({ diff --git a/src/app/core/shared/dspace-object.model.ts b/src/app/core/shared/dspace-object.model.ts index edd82eca85..b23de0da90 100644 --- a/src/app/core/shared/dspace-object.model.ts +++ b/src/app/core/shared/dspace-object.model.ts @@ -1,11 +1,10 @@ -import { MetadataMap, MetadataValue, MetadataValueFilter } from './metadata.interfaces'; -import { Metadata } from './metadata.model'; +import { MetadataMap, MetadataValue, MetadataValueFilter } from './metadata.models'; +import { Metadata } from './metadata.utils'; import { CacheableObject } from '../cache/object-cache.reducer'; import { RemoteData } from '../data/remote-data'; import { ResourceType } from './resource-type'; import { ListableObject } from '../../shared/object-collection/shared/listable-object.model'; import { Observable } from 'rxjs'; -import { autoserialize } from 'cerialize'; /** * An abstract model class for a DSpaceObject. @@ -17,13 +16,11 @@ export class DSpaceObject implements CacheableObject, ListableObject { /** * The human-readable identifier of this DSpaceObject */ - @autoserialize id: string; /** * The universally unique identifier of this DSpaceObject */ - @autoserialize uuid: string; /** @@ -41,9 +38,12 @@ export class DSpaceObject implements CacheableObject, ListableObject { /** * All metadata of this DSpaceObject */ - @autoserialize metadata: MetadataMap; + get metadataAsList() { + return Metadata.toViewModelList(this.metadata); + } + /** * An array of DSpaceObjects that are direct parents of this DSpaceObject */ diff --git a/src/app/core/shared/metadata.interfaces.ts b/src/app/core/shared/metadata.interfaces.ts deleted file mode 100644 index 3590117ce8..0000000000 --- a/src/app/core/shared/metadata.interfaces.ts +++ /dev/null @@ -1,30 +0,0 @@ -/** A map of metadata keys to an ordered list of MetadataValue objects. */ -export interface MetadataMap { - [ key: string ]: MetadataValue[]; -} - -/** A single metadata value and its properties. */ -export interface MetadataValue { - - /** The language. */ - language: string; - - /** The string value. */ - value: string; -} - -/** Constraints for matching metadata values. */ -export interface MetadataValueFilter { - - /** The language constraint. */ - language?: string; - - /** The value constraint. */ - value?: string; - - /** Whether the value constraint should match without regard to case. */ - ignoreCase?: boolean; - - /** Whether the value constraint should match as a substring. */ - substring?: boolean; -} diff --git a/src/app/core/shared/metadata.model.spec.ts b/src/app/core/shared/metadata.model.spec.ts index dfeff8d600..7fbea14b13 100644 --- a/src/app/core/shared/metadata.model.spec.ts +++ b/src/app/core/shared/metadata.model.spec.ts @@ -1,10 +1,16 @@ import { isUndefined } from '../../shared/empty.util'; -import { MetadataValue, MetadataValueFilter } from './metadata.interfaces'; -import { Metadata } from './metadata.model'; +import * as uuidv4 from 'uuid/v4'; +import { + MetadataMap, + MetadataValue, + MetadataValueFilter, + MetadatumViewModel +} from './metadata.models'; +import { Metadata } from './metadata.utils'; const mdValue = (value: string, language?: string): MetadataValue => { - return { value: value, language: isUndefined(language) ? null : language }; -} + return { uuid: uuidv4(), value: value, language: isUndefined(language) ? null : language }; +}; const dcDescription = mdValue('Some description'); const dcAbstract = mdValue('Some abstract'); @@ -13,19 +19,27 @@ const dcTitle1 = mdValue('Title 1'); const dcTitle2 = mdValue('Title 2', 'en_US'); const bar = mdValue('Bar'); -const singleMap = { 'dc.title': [ dcTitle0 ] }; +const singleMap = { 'dc.title': [dcTitle0] }; const multiMap = { - 'dc.description': [ dcDescription ], - 'dc.description.abstract': [ dcAbstract ], - 'dc.title': [ dcTitle1, dcTitle2 ], - 'foo': [ bar ] + 'dc.description': [dcDescription], + 'dc.description.abstract': [dcAbstract], + 'dc.title': [dcTitle1, dcTitle2], + 'foo': [bar] }; +const multiViewModelList = [ + { key: 'dc.description', ...dcDescription, order: 0 }, + { key: 'dc.description.abstract', ...dcAbstract, order: 0 }, + { key: 'dc.title', ...dcTitle1, order: 0 }, + { key: 'dc.title', ...dcTitle2, order: 1 }, + { key: 'foo', ...bar, order: 0 } +]; + const testMethod = (fn, resultKind, mapOrMaps, keyOrKeys, expected, filter?) => { - const keys = keyOrKeys instanceof Array ? keyOrKeys : [ keyOrKeys ]; + const keys = keyOrKeys instanceof Array ? keyOrKeys : [keyOrKeys]; describe('and key' + (keys.length === 1 ? (' ' + keys[0]) : ('s ' + JSON.stringify(keys))) - + ' with ' + (isUndefined(filter) ? 'no filter' : 'filter ' + JSON.stringify(filter)), () => { + + ' with ' + (isUndefined(filter) ? 'no filter' : 'filter ' + JSON.stringify(filter)), () => { const result = fn(mapOrMaps, keys, filter); let shouldReturn; if (resultKind === 'boolean') { @@ -34,7 +48,7 @@ const testMethod = (fn, resultKind, mapOrMaps, keyOrKeys, expected, filter?) => shouldReturn = 'undefined'; } else if (expected instanceof Array) { shouldReturn = 'an array with ' + expected.length + ' ' + (expected.length > 1 ? 'ordered ' : '') - + resultKind + (expected.length !== 1 ? 's' : ''); + + resultKind + (expected.length !== 1 ? 's' : ''); } else { shouldReturn = 'a ' + resultKind; } @@ -57,30 +71,30 @@ describe('Metadata', () => { }); describe('with singleMap', () => { testAll(singleMap, 'foo', []); - testAll(singleMap, '*', [ dcTitle0 ]); + testAll(singleMap, '*', [dcTitle0]); testAll(singleMap, '*', [], { value: 'baz' }); - testAll(singleMap, 'dc.title', [ dcTitle0 ]); - testAll(singleMap, 'dc.*', [ dcTitle0 ]); + testAll(singleMap, 'dc.title', [dcTitle0]); + testAll(singleMap, 'dc.*', [dcTitle0]); }); describe('with multiMap', () => { - testAll(multiMap, 'foo', [ bar ]); - testAll(multiMap, '*', [ dcDescription, dcAbstract, dcTitle1, dcTitle2, bar ]); - testAll(multiMap, 'dc.title', [ dcTitle1, dcTitle2 ]); - testAll(multiMap, 'dc.*', [ dcDescription, dcAbstract, dcTitle1, dcTitle2 ]); - testAll(multiMap, [ 'dc.title', 'dc.*' ], [ dcTitle1, dcTitle2, dcDescription, dcAbstract ]); + testAll(multiMap, 'foo', [bar]); + testAll(multiMap, '*', [dcDescription, dcAbstract, dcTitle1, dcTitle2, bar]); + testAll(multiMap, 'dc.title', [dcTitle1, dcTitle2]); + testAll(multiMap, 'dc.*', [dcDescription, dcAbstract, dcTitle1, dcTitle2]); + testAll(multiMap, ['dc.title', 'dc.*'], [dcTitle1, dcTitle2, dcDescription, dcAbstract]); }); describe('with [ singleMap, multiMap ]', () => { - testAll([ singleMap, multiMap ], 'foo', [ bar ]); - testAll([ singleMap, multiMap ], '*', [ dcTitle0 ]); - testAll([ singleMap, multiMap ], 'dc.title', [ dcTitle0 ]); - testAll([ singleMap, multiMap ], 'dc.*', [ dcTitle0 ]); + testAll([singleMap, multiMap], 'foo', [bar]); + testAll([singleMap, multiMap], '*', [dcTitle0]); + testAll([singleMap, multiMap], 'dc.title', [dcTitle0]); + testAll([singleMap, multiMap], 'dc.*', [dcTitle0]); }); describe('with [ multiMap, singleMap ]', () => { - testAll([ multiMap, singleMap ], 'foo', [ bar ]); - testAll([ multiMap, singleMap ], '*', [ dcDescription, dcAbstract, dcTitle1, dcTitle2, bar ]); - testAll([ multiMap, singleMap ], 'dc.title', [ dcTitle1, dcTitle2 ]); - testAll([ multiMap, singleMap ], 'dc.*', [ dcDescription, dcAbstract, dcTitle1, dcTitle2 ]); - testAll([ multiMap, singleMap ], [ 'dc.title', 'dc.*' ], [ dcTitle1, dcTitle2, dcDescription, dcAbstract ]); + testAll([multiMap, singleMap], 'foo', [bar]); + testAll([multiMap, singleMap], '*', [dcDescription, dcAbstract, dcTitle1, dcTitle2, bar]); + testAll([multiMap, singleMap], 'dc.title', [dcTitle1, dcTitle2]); + testAll([multiMap, singleMap], 'dc.*', [dcDescription, dcAbstract, dcTitle1, dcTitle2]); + testAll([multiMap, singleMap], ['dc.title', 'dc.*'], [dcTitle1, dcTitle2, dcDescription, dcAbstract]); }); }); @@ -93,10 +107,10 @@ describe('Metadata', () => { testAllValues({}, '*', []); }); describe('with singleMap', () => { - testAllValues([ singleMap, multiMap ], '*', [ dcTitle0.value ]); + testAllValues([singleMap, multiMap], '*', [dcTitle0.value]); }); describe('with [ multiMap, singleMap ]', () => { - testAllValues([ multiMap, singleMap ], '*', [ dcDescription.value, dcAbstract.value, dcTitle1.value, dcTitle2.value, bar.value ]); + testAllValues([multiMap, singleMap], '*', [dcDescription.value, dcAbstract.value, dcTitle1.value, dcTitle2.value, bar.value]); }); }); @@ -112,7 +126,7 @@ describe('Metadata', () => { testFirst(singleMap, '*', dcTitle0); }); describe('with [ multiMap, singleMap ]', () => { - testFirst([ multiMap, singleMap ], '*', dcDescription); + testFirst([multiMap, singleMap], '*', dcDescription); }); }); @@ -128,7 +142,7 @@ describe('Metadata', () => { testFirstValue(singleMap, '*', dcTitle0.value); }); describe('with [ multiMap, singleMap ]', () => { - testFirstValue([ multiMap, singleMap ], '*', dcDescription.value); + testFirstValue([multiMap, singleMap], '*', dcDescription.value); }); }); @@ -145,7 +159,7 @@ describe('Metadata', () => { testHas(singleMap, '*', false, { value: 'baz' }); }); describe('with [ multiMap, singleMap ]', () => { - testHas([ multiMap, singleMap ], '*', true); + testHas([multiMap, singleMap], '*', true); }); }); @@ -153,7 +167,7 @@ describe('Metadata', () => { const testValueMatches = (value: MetadataValue, expected: boolean, filter?: MetadataValueFilter) => { describe('with value ' + JSON.stringify(value) + ' and filter ' - + (isUndefined(filter) ? 'undefined' : JSON.stringify(filter)), () => { + + (isUndefined(filter) ? 'undefined' : JSON.stringify(filter)), () => { const result = Metadata.valueMatches(value, filter); it('should return ' + expected, () => { expect(result).toEqual(expected); @@ -172,4 +186,32 @@ describe('Metadata', () => { testValueMatches(mdValue('a', 'en_US'), true, { language: 'en_US' }); }); + describe('toViewModelList method', () => { + + const testToViewModelList = (map: MetadataMap, expected: MetadatumViewModel[]) => { + describe('with map ' + JSON.stringify(map), () => { + const result = Metadata.toViewModelList(map); + it('should return ' + JSON.stringify(expected), () => { + expect(result).toEqual(expected); + }); + }); + }; + + testToViewModelList(multiMap, multiViewModelList); + }); + + describe('toMetadataMap method', () => { + + const testToMetadataMap = (metadatumList: MetadatumViewModel[], expected: MetadataMap) => { + describe('with metadatum list ' + JSON.stringify(metadatumList), () => { + const result = Metadata.toMetadataMap(metadatumList); + it('should return ' + JSON.stringify(expected), () => { + expect(result).toEqual(expected); + }); + }); + }; + + testToMetadataMap(multiViewModelList, multiMap); + }); + }); diff --git a/src/app/core/shared/metadata.models.ts b/src/app/core/shared/metadata.models.ts new file mode 100644 index 0000000000..9ff08d3c3d --- /dev/null +++ b/src/app/core/shared/metadata.models.ts @@ -0,0 +1,75 @@ +import * as uuidv4 from 'uuid/v4'; +import { autoserialize, Serialize, Deserialize } from 'cerialize'; + +/** A map of metadata keys to an ordered list of MetadataValue objects. */ +export class MetadataMap { + [key: string]: MetadataValue[]; +} + +/** A single metadata value and its properties. */ + +export class MetadataValue { + + /** The uuid. */ + uuid: string = uuidv4(); + + /** The language. */ + @autoserialize + language: string; + + /** The string value. */ + @autoserialize + value: string; + +} + +/** Constraints for matching metadata values. */ +export interface MetadataValueFilter { + /** The language constraint. */ + language?: string; + + /** The value constraint. */ + value?: string; + + /** Whether the value constraint should match without regard to case. */ + ignoreCase?: boolean; + + /** Whether the value constraint should match as a substring. */ + substring?: boolean; +} + +export class MetadatumViewModel { + /** The uuid. */ + uuid: string = uuidv4(); + + /** The metadatafield key. */ + key: string; + + /** The language. */ + language: string; + + /** The string value. */ + value: string; + + /** The order. */ + order: number; +} + + +export const MetadataMapSerializer = { + Serialize(map: MetadataMap): any { + const json = {}; + Object.keys(map).forEach((key: string) => { + json[key] = Serialize(map[key], MetadataValue); + }); + return json; + }, + + Deserialize(json: any): MetadataMap { + const metadataMap: MetadataMap = {}; + Object.keys(json).forEach((key: string) => { + metadataMap[key] = Deserialize(json[key], MetadataValue); + }); + return metadataMap; + } +}; diff --git a/src/app/core/shared/metadata.model.ts b/src/app/core/shared/metadata.utils.ts similarity index 85% rename from src/app/core/shared/metadata.model.ts rename to src/app/core/shared/metadata.utils.ts index 2b29659252..f6edc619dc 100644 --- a/src/app/core/shared/metadata.model.ts +++ b/src/app/core/shared/metadata.utils.ts @@ -1,5 +1,11 @@ import { isEmpty, isNotUndefined, isUndefined } from '../../shared/empty.util'; -import { MetadataMap, MetadataValue, MetadataValueFilter } from './metadata.interfaces'; +import { + MetadataMap, + MetadataValue, + MetadataValueFilter, + MetadatumViewModel +} from './metadata.models'; +import { groupBy, sortBy } from 'lodash'; /** * Utility class for working with DSpace object metadata. @@ -27,7 +33,7 @@ export class Metadata { */ public static all(mapOrMaps: MetadataMap | MetadataMap[], keyOrKeys: string | string[], filter?: MetadataValueFilter): MetadataValue[] { - const mdMaps: MetadataMap[] = mapOrMaps instanceof Array ? mapOrMaps : [ mapOrMaps ]; + const mdMaps: MetadataMap[] = mapOrMaps instanceof Array ? mapOrMaps : [mapOrMaps]; const matches: MetadataValue[] = []; for (const mdMap of mdMaps) { for (const mdKey of Metadata.resolveKeys(mdMap, keyOrKeys)) { @@ -71,7 +77,7 @@ export class Metadata { */ public static first(mdMapOrMaps: MetadataMap | MetadataMap[], keyOrKeys: string | string[], filter?: MetadataValueFilter): MetadataValue { - const mdMaps: MetadataMap[] = mdMapOrMaps instanceof Array ? mdMapOrMaps : [ mdMapOrMaps ]; + const mdMaps: MetadataMap[] = mdMapOrMaps instanceof Array ? mdMapOrMaps : [mdMapOrMaps]; for (const mdMap of mdMaps) { for (const key of Metadata.resolveKeys(mdMap, keyOrKeys)) { const values: MetadataValue[] = mdMap[key]; @@ -144,7 +150,7 @@ export class Metadata { * @param {string|string[]} keyOrKeys The metadata key(s) in scope. Wildcards are supported; see above. */ private static resolveKeys(mdMap: MetadataMap, keyOrKeys: string | string[]): string[] { - const inputKeys: string[] = keyOrKeys instanceof Array ? keyOrKeys : [ keyOrKeys ]; + const inputKeys: string[] = keyOrKeys instanceof Array ? keyOrKeys : [keyOrKeys]; const outputKeys: string[] = []; for (const inputKey of inputKeys) { if (inputKey.includes('*')) { @@ -160,4 +166,31 @@ export class Metadata { } return outputKeys; } + + public static toViewModelList(mdMap: MetadataMap) { + let metadatumList: MetadatumViewModel[] = []; + Object.keys(mdMap).forEach((key: string) => { + const fields = mdMap[key].map( + (metadataValue: MetadataValue, index: number) => + Object.assign( + {}, + metadataValue, + { + order: index, + key + })); + metadatumList = [...metadatumList, ...fields]; + }); + return metadatumList; + } + + public static toMetadataMap(viewModelList: MetadatumViewModel[]) { + const metadataMap: MetadataMap = {}; + const groupedList = groupBy(viewModelList, (viewModel) => viewModel.key); + Object.keys(groupedList).forEach((key: string) => { + const orderedValues = sortBy(groupedList[key], ['order']); + metadataMap[key] = orderedValues.map((value: MetadataValue, index: number) => Object.assign({}, value, { order: index })) + }); + return metadataMap; + } } diff --git a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts index 6b28579491..f8263fab73 100644 --- a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts +++ b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts @@ -8,7 +8,7 @@ import { FormGroup } from '@angular/forms'; import { DynamicFormControlModel } from '@ng-dynamic-forms/core/src/model/dynamic-form-control.model'; import { TranslateService } from '@ngx-translate/core'; import { DSpaceObject } from '../../../core/shared/dspace-object.model'; -import { MetadataMap, MetadataValue } from '../../../core/shared/metadata.interfaces'; +import { MetadataMap, MetadataValue } from '../../../core/shared/metadata.models'; import { isNotEmpty } from '../../empty.util'; import { ResourceType } from '../../../core/shared/resource-type'; @@ -83,11 +83,14 @@ export class ComColFormComponent implements OnInit { onSubmit() { const formMetadata = new Object() as MetadataMap; this.formModel.forEach((fieldModel: DynamicInputModel) => { - const value: MetadataValue = { value: fieldModel.value as string, language: null }; + const value: MetadataValue = Object.assign(new MetadataValue(), { + value: fieldModel.value as string, + language: null + }); if (formMetadata.hasOwnProperty(fieldModel.name)) { formMetadata[fieldModel.name].push(value); } else { - formMetadata[fieldModel.name] = [ value ]; + formMetadata[fieldModel.name] = [value]; } }); diff --git a/src/app/shared/input-suggestions/input-suggestions.component.ts b/src/app/shared/input-suggestions/input-suggestions.component.ts index 620c984be3..727421c83e 100644 --- a/src/app/shared/input-suggestions/input-suggestions.component.ts +++ b/src/app/shared/input-suggestions/input-suggestions.component.ts @@ -12,7 +12,7 @@ import { ViewChildren } from '@angular/core'; import { BehaviorSubject } from 'rxjs'; -import { hasValue, isNotEmpty } from '../empty.util'; +import { hasValue, isNotEmpty, isNotUndefined } from '../empty.util'; import { InputSuggestion } from './input-suggestions.model'; import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms'; @@ -128,7 +128,7 @@ export class InputSuggestionsComponent implements ControlValueAccessor, OnChange */ ngOnChanges(changes: SimpleChanges) { if (hasValue(changes.suggestions)) { - this.show.next(isNotEmpty(changes.suggestions.currentValue)); + this.show.next(isNotEmpty(changes.suggestions.currentValue) && !changes.suggestions.firstChange); } } diff --git a/src/app/shared/object-grid/search-result-grid-element/search-result-grid-element.component.ts b/src/app/shared/object-grid/search-result-grid-element/search-result-grid-element.component.ts index 0901b7b8cc..844d0bc165 100644 --- a/src/app/shared/object-grid/search-result-grid-element/search-result-grid-element.component.ts +++ b/src/app/shared/object-grid/search-result-grid-element/search-result-grid-element.component.ts @@ -6,7 +6,7 @@ import { AbstractListableElementComponent } from '../../object-collection/shared import { ListableObject } from '../../object-collection/shared/listable-object.model'; import { TruncatableService } from '../../truncatable/truncatable.service'; import { Observable } from 'rxjs'; -import { Metadata } from '../../../core/shared/metadata.model'; +import { Metadata } from '../../../core/shared/metadata.utils'; @Component({ selector: 'ds-search-result-grid-element', diff --git a/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts b/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts index 2a16b0b754..525d39e798 100644 --- a/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts +++ b/src/app/shared/object-list/search-result-list-element/search-result-list-element.component.ts @@ -6,7 +6,7 @@ import { DSpaceObject } from '../../../core/shared/dspace-object.model'; import { ListableObject } from '../../object-collection/shared/listable-object.model'; import { AbstractListableElementComponent } from '../../object-collection/shared/object-collection-element/abstract-listable-element.component'; import { TruncatableService } from '../../truncatable/truncatable.service'; -import { Metadata } from '../../../core/shared/metadata.model'; +import { Metadata } from '../../../core/shared/metadata.utils'; @Component({ selector: 'ds-search-result-list-element', From 664d58f40edb56874239544752689f97972a151f Mon Sep 17 00:00:00 2001 From: lotte Date: Tue, 26 Feb 2019 16:53:37 +0100 Subject: [PATCH 15/18] fixed sorting issue --- src/app/core/shared/metadata.utils.ts | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/app/core/shared/metadata.utils.ts b/src/app/core/shared/metadata.utils.ts index f6edc619dc..d7cca987d6 100644 --- a/src/app/core/shared/metadata.utils.ts +++ b/src/app/core/shared/metadata.utils.ts @@ -169,7 +169,9 @@ export class Metadata { public static toViewModelList(mdMap: MetadataMap) { let metadatumList: MetadatumViewModel[] = []; - Object.keys(mdMap).forEach((key: string) => { + Object.keys(mdMap) + .sort() + .forEach((key: string) => { const fields = mdMap[key].map( (metadataValue: MetadataValue, index: number) => Object.assign( @@ -187,10 +189,12 @@ export class Metadata { public static toMetadataMap(viewModelList: MetadatumViewModel[]) { const metadataMap: MetadataMap = {}; const groupedList = groupBy(viewModelList, (viewModel) => viewModel.key); - Object.keys(groupedList).forEach((key: string) => { - const orderedValues = sortBy(groupedList[key], ['order']); - metadataMap[key] = orderedValues.map((value: MetadataValue, index: number) => Object.assign({}, value, { order: index })) - }); + Object.keys(groupedList) + .sort() + .forEach((key: string) => { + const orderedValues = sortBy(groupedList[key], ['order']); + metadataMap[key] = orderedValues.map((value: MetadataValue, index: number) => Object.assign({}, value, { order: index })) + }); return metadataMap; } } From 8125f56009cff1fca29fc6da5a8497ba07845fd6 Mon Sep 17 00:00:00 2001 From: lotte Date: Wed, 27 Feb 2019 13:18:35 +0100 Subject: [PATCH 16/18] finished docs and tests --- .../edit-in-place-field.component.spec.ts | 1 - .../item-metadata.component.spec.ts | 49 ++++++++++++++++--- .../item-metadata/item-metadata.component.ts | 2 +- src/app/core/eperson/models/eperson.model.ts | 1 + src/app/core/shared/dspace-object.model.ts | 12 ++++- src/app/core/shared/metadata.models.ts | 9 ++-- ...a.model.spec.ts => metadata.utils.spec.ts} | 0 src/app/core/shared/metadata.utils.ts | 48 ++++++++++++------ .../comcol-form/comcol-form.component.ts | 8 +-- 9 files changed, 98 insertions(+), 32 deletions(-) rename src/app/core/shared/{metadata.model.spec.ts => metadata.utils.spec.ts} (100%) diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts index 02e4bf3413..09363b9964 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.spec.ts @@ -60,7 +60,6 @@ describe('EditInPlaceFieldComponent', () => { metadataFieldService = jasmine.createSpyObj({ queryMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)), - getAllMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)) }); objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', { diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts index c1d36c70fa..674e41e13f 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts @@ -1,5 +1,5 @@ import { async, ComponentFixture, TestBed } from '@angular/core/testing'; -import { CUSTOM_ELEMENTS_SCHEMA, DebugElement, NO_ERRORS_SCHEMA } from '@angular/core'; +import { DebugElement, NO_ERRORS_SCHEMA } from '@angular/core'; import { of as observableOf } from 'rxjs'; import { getTestScheduler } from 'jasmine-marbles'; import { ItemMetadataComponent } from './item-metadata.component'; @@ -22,6 +22,11 @@ import { Item } from '../../../core/shared/item.model'; import { FieldChangeType } from '../../../core/data/object-updates/object-updates.actions'; import { RemoteData } from '../../../core/data/remote-data'; import { MetadatumViewModel } from '../../../core/shared/metadata.models'; +import { RegistryService } from '../../../core/registry/registry.service'; +import { PaginatedList } from '../../../core/data/paginated-list'; +import { MetadataSchema } from '../../../core/metadata/metadataschema.model'; +import { MetadataField } from '../../../core/metadata/metadatafield.model'; +import { Metadata } from '../../../core/shared/metadata.utils'; let comp: ItemMetadataComponent; let fixture: ComponentFixture; @@ -33,8 +38,23 @@ const warningNotification: INotification = new Notification('id', NotificationTy const successNotification: INotification = new Notification('id', NotificationType.Success, 'success'); const date = new Date(); const router = new RouterStub(); +let metadataFieldService; +let paginatedMetadataFields; let routeStub; +const mdSchema = Object.assign(new MetadataSchema(), { prefix: 'dc' }); +const mdField1 = Object.assign(new MetadataField(), { + schema: mdSchema, + element: 'contributor', + qualifier: 'author' +}); +const mdField2 = Object.assign(new MetadataField(), { schema: mdSchema, element: 'title' }); +const mdField3 = Object.assign(new MetadataField(), { + schema: mdSchema, + element: 'description', + qualifier: 'abstract' +}); + let itemService; const notificationsService = jasmine.createSpyObj('notificationsService', { @@ -83,7 +103,18 @@ let scheduler: TestScheduler; let item; describe('ItemMetadataComponent', () => { beforeEach(async(() => { - item = Object.assign(new Item(), { metadata: [metadatum1, metadatum2, metadatum3] }, { lastModified: date }); + item = Object.assign(new Item(), { + metadata: { + [metadatum1.key]: [metadatum1], + [metadatum2.key]: [metadatum2], + [metadatum3.key]: [metadatum3] + } + }, + { + lastModified: date + } + ) + ; itemService = jasmine.createSpyObj('itemService', { update: observableOf(new RemoteData(false, false, true, undefined, item)), commitUpdates: {} @@ -93,6 +124,11 @@ describe('ItemMetadataComponent', () => { data: observableOf({ item: new RemoteData(false, false, true, null, item) }) } }; + paginatedMetadataFields = new PaginatedList(undefined, [mdField1, mdField2, mdField3]); + + metadataFieldService = jasmine.createSpyObj({ + getAllMetadataFields: observableOf(new RemoteData(false, false, true, undefined, paginatedMetadataFields)) + }); scheduler = getTestScheduler(); objectUpdatesService = jasmine.createSpyObj('objectUpdatesService', { @@ -122,7 +158,8 @@ describe('ItemMetadataComponent', () => { { provide: Router, useValue: router }, { provide: ActivatedRoute, useValue: routeStub }, { provide: NotificationsService, useValue: notificationsService }, - { provide: GLOBAL_CONFIG, useValue: { notifications: { timeOut: 10 } } as any } + { provide: GLOBAL_CONFIG, useValue: { notifications: { timeOut: 10 } } as any }, + { provide: RegistryService, useValue: metadataFieldService }, ], schemas: [ NO_ERRORS_SCHEMA ] @@ -176,9 +213,9 @@ describe('ItemMetadataComponent', () => { }); it('it should call reinstateFieldUpdates on the objectUpdatesService with the correct url and metadata', () => { - expect(objectUpdatesService.getUpdatedFields).toHaveBeenCalledWith(url, comp.item.metadata); - expect(itemService.update).toHaveBeenCalledWith(comp.item); - expect(objectUpdatesService.getFieldUpdates).toHaveBeenCalledWith(url, comp.item.metadata); + expect(objectUpdatesService.getUpdatedFields).toHaveBeenCalledWith(url, comp.item.metadataAsList); + expect(itemService.update).toHaveBeenCalledWith(Object.assign(comp.item, { metadata: Metadata.toMetadataMap(comp.item.metadataAsList) })); + expect(objectUpdatesService.getFieldUpdates).toHaveBeenCalledWith(url, comp.item.metadataAsList); }); }); diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index fb6820d5fd..1d5c1064ba 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -72,7 +72,7 @@ export class ItemMetadataComponent implements OnInit { * Set up and initialize all fields */ ngOnInit(): void { - this.metadataFields$ = this.findMetadataFields() + this.metadataFields$ = this.findMetadataFields(); this.route.parent.data.pipe(map((data) => data.item)) .pipe( first(), diff --git a/src/app/core/eperson/models/eperson.model.ts b/src/app/core/eperson/models/eperson.model.ts index 0218e52c7d..7d2138b633 100644 --- a/src/app/core/eperson/models/eperson.model.ts +++ b/src/app/core/eperson/models/eperson.model.ts @@ -19,6 +19,7 @@ export class EPerson extends DSpaceObject { public selfRegistered: boolean; + /** Getter to retrieve the EPerson's full name as a string */ get name(): string { return this.firstMetadataValue('eperson.firstname') + ' ' + this.firstMetadataValue('eperson.lastname'); } diff --git a/src/app/core/shared/dspace-object.model.ts b/src/app/core/shared/dspace-object.model.ts index b23de0da90..a2f5f721a4 100644 --- a/src/app/core/shared/dspace-object.model.ts +++ b/src/app/core/shared/dspace-object.model.ts @@ -1,4 +1,9 @@ -import { MetadataMap, MetadataValue, MetadataValueFilter } from './metadata.models'; +import { + MetadataMap, + MetadataValue, + MetadataValueFilter, + MetadatumViewModel +} from './metadata.models'; import { Metadata } from './metadata.utils'; import { CacheableObject } from '../cache/object-cache.reducer'; import { RemoteData } from '../data/remote-data'; @@ -40,7 +45,10 @@ export class DSpaceObject implements CacheableObject, ListableObject { */ metadata: MetadataMap; - get metadataAsList() { + /** + * Retrieve the current metadata as a list of MetadatumViewModels + */ + get metadataAsList(): MetadatumViewModel[] { return Metadata.toViewModelList(this.metadata); } diff --git a/src/app/core/shared/metadata.models.ts b/src/app/core/shared/metadata.models.ts index 9ff08d3c3d..b72eb340d3 100644 --- a/src/app/core/shared/metadata.models.ts +++ b/src/app/core/shared/metadata.models.ts @@ -1,5 +1,6 @@ import * as uuidv4 from 'uuid/v4'; import { autoserialize, Serialize, Deserialize } from 'cerialize'; +/* tslint:disable:max-classes-per-file */ /** A map of metadata keys to an ordered list of MetadataValue objects. */ export class MetadataMap { @@ -9,7 +10,6 @@ export class MetadataMap { /** A single metadata value and its properties. */ export class MetadataValue { - /** The uuid. */ uuid: string = uuidv4(); @@ -20,7 +20,6 @@ export class MetadataValue { /** The string value. */ @autoserialize value: string; - } /** Constraints for matching metadata values. */ @@ -55,7 +54,10 @@ export class MetadatumViewModel { order: number; } - +/** Serializer used for MetadataMaps. + * This is necessary because Cerialize has trouble instantiating the MetadataValues using their constructor + * when they are inside arrays which also represent the values in a map. + */ export const MetadataMapSerializer = { Serialize(map: MetadataMap): any { const json = {}; @@ -73,3 +75,4 @@ export const MetadataMapSerializer = { return metadataMap; } }; +/* tslint:enable:max-classes-per-file */ diff --git a/src/app/core/shared/metadata.model.spec.ts b/src/app/core/shared/metadata.utils.spec.ts similarity index 100% rename from src/app/core/shared/metadata.model.spec.ts rename to src/app/core/shared/metadata.utils.spec.ts diff --git a/src/app/core/shared/metadata.utils.ts b/src/app/core/shared/metadata.utils.ts index d7cca987d6..1e9446912d 100644 --- a/src/app/core/shared/metadata.utils.ts +++ b/src/app/core/shared/metadata.utils.ts @@ -149,7 +149,7 @@ export class Metadata { * @param {MetadataMap} mdMap The source map. * @param {string|string[]} keyOrKeys The metadata key(s) in scope. Wildcards are supported; see above. */ - private static resolveKeys(mdMap: MetadataMap, keyOrKeys: string | string[]): string[] { + private static resolveKeys(mdMap: MetadataMap = {}, keyOrKeys: string | string[]): string[] { const inputKeys: string[] = keyOrKeys instanceof Array ? keyOrKeys : [keyOrKeys]; const outputKeys: string[] = []; for (const inputKey of inputKeys) { @@ -167,33 +167,51 @@ export class Metadata { return outputKeys; } - public static toViewModelList(mdMap: MetadataMap) { + /** + * Creates an array of MetadatumViewModels from an existing MetadataMap. + * + * @param {MetadataMap} mdMap The source map. + * @returns {MetadatumViewModel[]} List of metadata view models based on the source map. + */ + public static toViewModelList(mdMap: MetadataMap): MetadatumViewModel[] { let metadatumList: MetadatumViewModel[] = []; Object.keys(mdMap) .sort() .forEach((key: string) => { - const fields = mdMap[key].map( - (metadataValue: MetadataValue, index: number) => - Object.assign( - {}, - metadataValue, - { - order: index, - key - })); - metadatumList = [...metadatumList, ...fields]; - }); + const fields = mdMap[key].map( + (metadataValue: MetadataValue, index: number) => + Object.assign( + {}, + metadataValue, + { + order: index, + key + })); + metadatumList = [...metadatumList, ...fields]; + }); return metadatumList; } - public static toMetadataMap(viewModelList: MetadatumViewModel[]) { + /** + * Creates an MetadataMap from an existing array of MetadatumViewModels. + * + * @param {MetadatumViewModel[]} viewModelList The source list. + * @returns {MetadataMap} Map with metadata values based on the source list. + */ + public static toMetadataMap(viewModelList: MetadatumViewModel[]): MetadataMap { const metadataMap: MetadataMap = {}; const groupedList = groupBy(viewModelList, (viewModel) => viewModel.key); Object.keys(groupedList) .sort() .forEach((key: string) => { const orderedValues = sortBy(groupedList[key], ['order']); - metadataMap[key] = orderedValues.map((value: MetadataValue, index: number) => Object.assign({}, value, { order: index })) + metadataMap[key] = orderedValues.map((value: MetadataValue) => { + const val = Object.assign({}, value); + delete (val as any).order; + delete (val as any).key; + return val; + } + ) }); return metadataMap; } diff --git a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts index f8263fab73..e24676a646 100644 --- a/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts +++ b/src/app/shared/comcol-forms/comcol-form/comcol-form.component.ts @@ -83,10 +83,10 @@ export class ComColFormComponent implements OnInit { onSubmit() { const formMetadata = new Object() as MetadataMap; this.formModel.forEach((fieldModel: DynamicInputModel) => { - const value: MetadataValue = Object.assign(new MetadataValue(), { - value: fieldModel.value as string, - language: null - }); + const value: MetadataValue = { + value: fieldModel.value as string, + language: null + } as any; if (formMetadata.hasOwnProperty(fieldModel.name)) { formMetadata[fieldModel.name].push(value); } else { From 27180c5960ac4e4f163899f38c0471b1a5bf8244 Mon Sep 17 00:00:00 2001 From: lotte Date: Fri, 1 Mar 2019 09:31:03 +0100 Subject: [PATCH 17/18] Applied feedback --- config/environment.default.js | 7 ++++++- .../edit-in-place-field.component.html | 1 - .../item-metadata/item-metadata.component.spec.ts | 2 +- .../item-metadata/item-metadata.component.ts | 12 +++++++----- src/app/core/registry/registry.service.ts | 15 ++++++++++++--- src/app/shared/utils/auto-focus.directive.ts | 9 ++++++++- src/config/global-config.interface.ts | 2 ++ src/config/item-page-config.interface.ts | 7 +++++++ 8 files changed, 43 insertions(+), 12 deletions(-) create mode 100644 src/config/item-page-config.interface.ts diff --git a/config/environment.default.js b/config/environment.default.js index d46dc10dee..b8eae1ccff 100644 --- a/config/environment.default.js +++ b/config/environment.default.js @@ -79,5 +79,10 @@ module.exports = { code: 'nl', label: 'Nederlands', active: false, - }] + }], + item: { + edit: { + undoTimeout: 10000 // 10 seconds + } + } }; diff --git a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html index 05eb03dd12..e9c5de95ca 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html +++ b/src/app/+item-page/edit-item-page/item-metadata/edit-in-place-field/edit-in-place-field.component.html @@ -1,4 +1,3 @@ -
    diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts index 674e41e13f..f2cd74fc2f 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.spec.ts @@ -158,7 +158,7 @@ describe('ItemMetadataComponent', () => { { provide: Router, useValue: router }, { provide: ActivatedRoute, useValue: routeStub }, { provide: NotificationsService, useValue: notificationsService }, - { provide: GLOBAL_CONFIG, useValue: { notifications: { timeOut: 10 } } as any }, + { provide: GLOBAL_CONFIG, useValue: { item: { edit: { undoTimeout: 10 } } } as any }, { provide: RegistryService, useValue: metadataFieldService }, ], schemas: [ NO_ERRORS_SCHEMA diff --git a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts index 1d5c1064ba..6b3e05c818 100644 --- a/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts +++ b/src/app/+item-page/edit-item-page/item-metadata/item-metadata.component.ts @@ -47,8 +47,10 @@ export class ItemMetadataComponent implements OnInit { * The time span for being able to undo discarding changes */ private discardTimeOut: number; - - private notitifactionPrefix = 'item.edit.metadata.notifications.'; + /** + * Prefix for this component's notification translate keys + */ + private notificationsPrefix = 'item.edit.metadata.notifications.'; /** * Observable with a list of strings with all existing metadata field keys @@ -81,7 +83,7 @@ export class ItemMetadataComponent implements OnInit { this.item = item; }); - this.discardTimeOut = this.EnvConfig.notifications.timeOut; + this.discardTimeOut = this.EnvConfig.item.edit.undoTimeout; this.url = this.router.url; if (this.url.indexOf('?') > 0) { this.url = this.url.substr(0, this.url.indexOf('?')); @@ -207,7 +209,7 @@ export class ItemMetadataComponent implements OnInit { * @param key */ private getNotificationTitle(key: string) { - return this.translateService.instant(this.notitifactionPrefix + key + '.title'); + return this.translateService.instant(this.notificationsPrefix + key + '.title'); } /** @@ -215,7 +217,7 @@ export class ItemMetadataComponent implements OnInit { * @param key */ private getNotificationContent(key: string) { - return this.translateService.instant(this.notitifactionPrefix + key + '.content'); + return this.translateService.instant(this.notificationsPrefix + key + '.content'); } diff --git a/src/app/core/registry/registry.service.ts b/src/app/core/registry/registry.service.ts index dbc60eeec0..87410394a0 100644 --- a/src/app/core/registry/registry.service.ts +++ b/src/app/core/registry/registry.service.ts @@ -173,6 +173,12 @@ export class RegistryService { return this.rdb.toRemoteDataObservable(requestEntryObs, payloadObs); } + /** + * Retrieve all existing metadata fields as a paginated list + * @param pagination Pagination options to determine which page of metadata fields should be requested + * When no pagination is provided, all metadata fields are requested in one large page + * @returns an observable that emits a remote data object with a page of metadata fields + */ public getAllMetadataFields(pagination?: PaginationComponentOptions): Observable>> { if (hasNoValue(pagination)) { pagination = { currentPage: 1, pageSize: 10000 } as any; @@ -557,10 +563,13 @@ export class RegistryService { }); } + /** + * Retrieve a filtered paginated list of metadata fields + * @param query {string} The query to filter the field names by + * @returns an observable that emits a remote data object with a page of metadata fields that match the query + */ queryMetadataFields(query: string): Observable>> { - /** - * This should come directly from the server in the future - */ + /* TODO This should come directly from the server in the future */ return this.getAllMetadataFields().pipe( map((rd: RemoteData>) => { const filteredFields: MetadataField[] = rd.payload.page.filter( diff --git a/src/app/shared/utils/auto-focus.directive.ts b/src/app/shared/utils/auto-focus.directive.ts index b009754412..a2d860a8e1 100644 --- a/src/app/shared/utils/auto-focus.directive.ts +++ b/src/app/shared/utils/auto-focus.directive.ts @@ -1,12 +1,19 @@ import { Directive, AfterViewInit, ElementRef, Input } from '@angular/core'; import { isNotEmpty } from '../empty.util'; +/** + * Directive to set focus on an element when it is rendered + */ @Directive({ selector: '[dsAutoFocus]' }) export class AutoFocusDirective implements AfterViewInit { - @Input() autoFocusSelector: string; + /** + * Optional input to specify which element in a component should get the focus + * If left empty, the component itself will get the focus + */ + @Input() autoFocusSelector: string = undefined; constructor(private el: ElementRef) { } diff --git a/src/config/global-config.interface.ts b/src/config/global-config.interface.ts index 6d1d4da6f9..59cc21a3b2 100644 --- a/src/config/global-config.interface.ts +++ b/src/config/global-config.interface.ts @@ -5,6 +5,7 @@ import { UniversalConfig } from './universal-config.interface'; import { INotificationBoardOptions } from './notifications-config.interfaces'; import { FormConfig } from './form-config.interfaces'; import {LangConfig} from './lang-config.interface'; +import { ItemPageConfig } from './item-page-config.interface'; export interface GlobalConfig extends Config { ui: ServerConfig; @@ -19,4 +20,5 @@ export interface GlobalConfig extends Config { debug: boolean; defaultLanguage: string; languages: LangConfig[]; + item: ItemPageConfig; } diff --git a/src/config/item-page-config.interface.ts b/src/config/item-page-config.interface.ts new file mode 100644 index 0000000000..c76d2cdb01 --- /dev/null +++ b/src/config/item-page-config.interface.ts @@ -0,0 +1,7 @@ +import { Config } from './config.interface'; + +export interface ItemPageConfig extends Config { + edit: { + undoTimeout: number; + } +} From f12e0d04be2ba3edf3421dc5f3b23e99f4f92a2b Mon Sep 17 00:00:00 2001 From: lotte Date: Fri, 1 Mar 2019 10:00:33 +0100 Subject: [PATCH 18/18] removed todo comment --- src/app/core/registry/registry.service.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/app/core/registry/registry.service.ts b/src/app/core/registry/registry.service.ts index 87410394a0..8fa1ca893a 100644 --- a/src/app/core/registry/registry.service.ts +++ b/src/app/core/registry/registry.service.ts @@ -569,7 +569,6 @@ export class RegistryService { * @returns an observable that emits a remote data object with a page of metadata fields that match the query */ queryMetadataFields(query: string): Observable>> { - /* TODO This should come directly from the server in the future */ return this.getAllMetadataFields().pipe( map((rd: RemoteData>) => { const filteredFields: MetadataField[] = rd.payload.page.filter(