From b846384ba730130117a286254f2f60a3cd60278f Mon Sep 17 00:00:00 2001
From: lotte <lotte_hofstede@hotmail.com>
Date: Wed, 29 May 2019 13:10:42 +0200
Subject: [PATCH] Added typedoc and remove unnecessary import statements
---
src/app/core/shared/item.model.spec.ts | 6 +--
src/app/shared/testing/utils.ts | 42 +++++++++++++++----
...bmission-form-collection.component.spec.ts | 25 ++++++++---
3 files changed, 54 insertions(+), 19 deletions(-)
diff --git a/src/app/core/shared/item.model.spec.ts b/src/app/core/shared/item.model.spec.ts
index 101dc4986e..f20fb3299a 100644
--- a/src/app/core/shared/item.model.spec.ts
+++ b/src/app/core/shared/item.model.spec.ts
@@ -1,7 +1,6 @@
import { Observable, of as observableOf } from 'rxjs';
import { Item } from './item.model';
-import { RemoteData } from '../data/remote-data';
import { Bitstream } from './bitstream.model';
import { isEmpty } from '../../shared/empty.util';
import { first, map } from 'rxjs/operators';
@@ -38,7 +37,6 @@ describe('Item', () => {
remoteDataAll = createSuccessfulRemoteDataObject$([...bitstreams, thumbnail]);
// Create Bundles
-
const bundles =
[
{
@@ -52,7 +50,6 @@ describe('Item', () => {
}];
item = Object.assign(new Item(), { bitstreams: remoteDataAll });
-
});
it('should return the bitstreams related to this item with the specified bundle name', () => {
@@ -100,5 +97,4 @@ describe('Item', () => {
});
});
-
-});
\ No newline at end of file
+});
diff --git a/src/app/shared/testing/utils.ts b/src/app/shared/testing/utils.ts
index c372ea06a4..4a551582ee 100644
--- a/src/app/shared/testing/utils.ts
+++ b/src/app/shared/testing/utils.ts
@@ -26,7 +26,7 @@ export const hasClass = (element: any, className: string): boolean => {
*/
export const createTestComponent = <T>(html: string, type: { new(...args: any[]): T }): ComponentFixture<T> => {
TestBed.overrideComponent(type, {
- set: {template: html}
+ set: { template: html }
});
const fixture = TestBed.createComponent(type);
@@ -54,7 +54,11 @@ export function spyOnOperator(obj: any, prop: string): any {
return spyOn(obj, prop);
}
-export function createSuccessfulRemoteDataObject<T>(object: T): RemoteData<T>{
+/**
+ * Method to create a remote data object that has succeeded
+ * @param object The object to wrap
+ */
+export function createSuccessfulRemoteDataObject<T>(object: T): RemoteData<T> {
return new RemoteData(
false,
false,
@@ -64,11 +68,20 @@ export function createSuccessfulRemoteDataObject<T>(object: T): RemoteData<T>{
);
}
-export function createSuccessfulRemoteDataObject$<T>(object: T): Observable<RemoteData<T>>{
+/**
+ * Method to create a remote data object that has succeeded, wrapped in an observable
+ * @param object The object to wrap
+ */
+export function createSuccessfulRemoteDataObject$<T>(object: T): Observable<RemoteData<T>> {
return observableOf(createSuccessfulRemoteDataObject(object));
}
-export function createFailedRemoteDataObject<T>(object?: T, error?: RemoteDataError): RemoteData<T>{
+/**
+ * Method to create a remote data object that has failed
+ * @param object The object to wrap
+ * @param error The RemoteDataError that caused the failure
+ */
+export function createFailedRemoteDataObject<T>(object?: T, error?: RemoteDataError): RemoteData<T> {
return new RemoteData(
false,
false,
@@ -78,11 +91,20 @@ export function createFailedRemoteDataObject<T>(object?: T, error?: RemoteDataEr
);
}
-export function createFailedRemoteDataObject$<T>(object?: T, error?: RemoteDataError): Observable<RemoteData<T>>{
+/**
+ * Method to create a remote data object that has failed, wrapped in an observable
+ * @param object The object to wrap
+ * @param error The RemoteDataError that caused the failure
+ */
+export function createFailedRemoteDataObject$<T>(object?: T, error?: RemoteDataError): Observable<RemoteData<T>> {
return observableOf(createFailedRemoteDataObject(object, error));
}
-export function createPendingRemoteDataObject<T>(object?: T): RemoteData<T>{
+/**
+ * Method to create a remote data object that is still pending
+ * @param object The object to wrap
+ */
+export function createPendingRemoteDataObject<T>(object?: T): RemoteData<T> {
return new RemoteData(
true,
true,
@@ -92,6 +114,10 @@ export function createPendingRemoteDataObject<T>(object?: T): RemoteData<T>{
);
}
-export function createPendingRemoteDataObject$<T>(object?: T): Observable<RemoteData<T>>{
+/**
+ * Method to create a remote data object that is still pending, wrapped in an observable
+ * @param object The object to wrap
+ */
+export function createPendingRemoteDataObject$<T>(object?: T): Observable<RemoteData<T>> {
return observableOf(createPendingRemoteDataObject(object));
-}
\ No newline at end of file
+}
diff --git a/src/app/submission/form/collection/submission-form-collection.component.spec.ts b/src/app/submission/form/collection/submission-form-collection.component.spec.ts
index efbe2eccfe..3daedbee14 100644
--- a/src/app/submission/form/collection/submission-form-collection.component.spec.ts
+++ b/src/app/submission/form/collection/submission-form-collection.component.spec.ts
@@ -1,4 +1,10 @@
-import { ChangeDetectorRef, Component, CUSTOM_ELEMENTS_SCHEMA, DebugElement, SimpleChange } from '@angular/core';
+import {
+ ChangeDetectorRef,
+ Component,
+ CUSTOM_ELEMENTS_SCHEMA,
+ DebugElement,
+ SimpleChange
+} from '@angular/core';
import { async, ComponentFixture, fakeAsync, inject, TestBed, tick } from '@angular/core/testing';
import { By } from '@angular/platform-browser';
import { FormsModule, ReactiveFormsModule } from '@angular/forms';
@@ -10,7 +16,10 @@ import { NgbModule } from '@ng-bootstrap/ng-bootstrap';
import { Store } from '@ngrx/store';
import { SubmissionServiceStub } from '../../../shared/testing/submission-service-stub';
-import { mockSubmissionId, mockSubmissionRestResponse } from '../../../shared/mocks/mock-submission';
+import {
+ mockSubmissionId,
+ mockSubmissionRestResponse
+} from '../../../shared/mocks/mock-submission';
import { SubmissionService } from '../../submission.service';
import { SubmissionFormCollectionComponent } from './submission-form-collection.component';
import { CommunityDataService } from '../../../core/data/community-data.service';
@@ -19,7 +28,6 @@ import { SubmissionJsonPatchOperationsServiceStub } from '../../../shared/testin
import { JsonPatchOperationsBuilder } from '../../../core/json-patch/builder/json-patch-operations-builder';
import { JsonPatchOperationPathCombiner } from '../../../core/json-patch/builder/json-patch-operation-path-combiner';
import { Community } from '../../../core/shared/community.model';
-import { RemoteData } from '../../../core/data/remote-data';
import { PaginatedList } from '../../../core/data/paginated-list';
import { PageInfo } from '../../../core/shared/page-info.model';
import { Collection } from '../../../core/shared/collection.model';
@@ -104,7 +112,7 @@ const mockCommunity = Object.assign(new Community(), {
language: 'en_US',
value: 'Community 1'
}],
- collections: createSuccessfulRemoteDataObject$(new PaginatedList(new PageInfo(), [mockCommunity1Collection1, mockCommunity1Collection2])), //LOTTE
+ collections: createSuccessfulRemoteDataObject$(new PaginatedList(new PageInfo(), [mockCommunity1Collection1, mockCommunity1Collection2])),
subcommunities: createSuccessfulRemoteDataObject$(new PaginatedList(new PageInfo(), subcommunities)),
});
@@ -212,7 +220,10 @@ describe('SubmissionFormCollectionComponent Component', () => {
TestComponent
],
providers: [
- { provide: SubmissionJsonPatchOperationsService, useClass: SubmissionJsonPatchOperationsServiceStub },
+ {
+ provide: SubmissionJsonPatchOperationsService,
+ useClass: SubmissionJsonPatchOperationsServiceStub
+ },
{ provide: SubmissionService, useClass: SubmissionServiceStub },
{ provide: CommunityDataService, useValue: communityDataService },
{ provide: JsonPatchOperationsBuilder, useValue: jsonPatchOpBuilder },
@@ -426,6 +437,8 @@ class TestComponent {
definitionId = 'traditional';
submissionId = mockSubmissionId;
- onCollectionChange = () => { return; }
+ onCollectionChange = () => {
+ return;
+ }
}
--
GitLab