Tests and comments on shared => DONE

client/src/app/instance/documentation/containers/dataset-list.component.ts

@@ -58,7 +58,7 @@ export class DatasetListComponent implements OnInit {
         this.datasetList = store.select(datasetSelector.selectAllDatasets);
     }
 
-    ngOnInit() {
+    ngOnInit(): void {
         this.store.dispatch(datasetActions.loadDatasetList());
     }
 }

client/src/app/instance/documentation/containers/documentation.component.ts

@@ -45,7 +45,7 @@ export class DocumentationComponent implements OnInit {
         this.attributeList = store.select(attributeSelector.selectAllAttributes);
     }
 
-    ngOnInit() {
+    ngOnInit(): void {
         this.store.dispatch(attributeActions.loadAttributeList());
     }
 

client/src/app/shared/components/navbar.component.spec.ts

+import { TestBed, ComponentFixture  } from '@angular/core/testing';
+import { RouterTestingModule } from '@angular/router/testing';
+
+import { NavbarComponent } from './navbar.component';
+import { INSTANCE } from '../../../test-data';
+
+describe('[Shared][Component] NavbarComponent', () => {
+    let component: NavbarComponent;
+    let fixture: ComponentFixture<NavbarComponent>;
+
+    beforeEach(() => {
+        TestBed.configureTestingModule({
+            declarations: [NavbarComponent],
+            imports: [RouterTestingModule]
+
+        }).compileComponents();
+        fixture = TestBed.createComponent(NavbarComponent);
+        component = fixture.componentInstance;
+    });
+
+    it('should create the component', () => {
+        expect(component).toBeDefined();
+    });
+
+    it('should return logo href', () => {
+        component.apiUrl = 'http://test.com';
+        component.instance = INSTANCE;
+        expect(component.getLogoHref()).toEqual('http://test.com/download-instance-file/myInstance/path/to/logo');
+        component.instance.config.design.design_logo = '';
+        expect(component.getLogoHref()).toEqual('assets/cesam_anis40.png');
+    });
+});

client/src/app/shared/components/navbar.component.ts

@@ -12,6 +12,10 @@ import { Component, Input, Output, EventEmitter, ChangeDetectionStrategy } from
 import { Instance } from 'src/app/metamodel/models';
 import { UserProfile } from 'src/app/auth/user-profile.model';
 
+/**
+ * @class
+ * @classdesc Navbar component.
+ */
 @Component({
     selector: 'app-navbar',
     templateUrl: 'navbar.component.html',
@@ -30,11 +34,15 @@ export class NavbarComponent {
     @Output() logout: EventEmitter<any> = new EventEmitter();
     @Output() openEditProfile: EventEmitter<any> = new EventEmitter();
 
-    getLogoHref() {
+    /**
+     * Returns logo href.
+     *
+     * @return  string
+     */
+    getLogoHref(): string {
         if (this.instance.config.design.design_logo) {
             return `${this.apiUrl}/download-instance-file/${this.instance.name}/${this.instance.config.design.design_logo}`;
-        } else {
-            return 'assets/cesam_anis40.png';
         }
+        return 'assets/cesam_anis40.png';
     }
 }

client/src/app/shared/components/spinner.component.spec.ts

+import { TestBed, ComponentFixture  } from '@angular/core/testing';
+
+import { SpinnerComponent } from './spinner.component';
+
+describe('[Shared][Component] SpinnerComponent', () => {
+    let component: SpinnerComponent;
+    let fixture: ComponentFixture<SpinnerComponent>;
+
+    beforeEach(() => {
+        TestBed.configureTestingModule({
+            declarations: [SpinnerComponent]
+
+        }).compileComponents();
+        fixture = TestBed.createComponent(SpinnerComponent);
+        component = fixture.componentInstance;
+    });
+
+    it('should create the component', () => {
+        expect(component).toBeDefined();
+    });
+});

client/src/app/shared/components/spinner.component.ts

@@ -9,9 +9,13 @@
 
 import { Component, ChangeDetectionStrategy } from '@angular/core';
 
+/**
+ * @class
+ * @classdesc Spinner component.
+ */
 @Component({
     selector: 'app-spinner',
     templateUrl: 'spinner.component.html',
     changeDetection: ChangeDetectionStrategy.OnPush
 })
-export class SpinnerComponent { }
+export class SpinnerComponent { }
\ No newline at end of file

client/src/app/shared/pipes/attribute-list-by-family.pipe.spec.ts

+import { AttributeListByFamilyPipe } from './attribute-list-by-family.pipe';
+import { ATTRIBUTE_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] AttributeListByFamilyPipe', () => {
+    let pipe = new AttributeListByFamilyPipe();
+
+    it('should return attributes corresponding to the given criteria family ID', () => {
+        expect(pipe.transform(ATTRIBUTE_LIST, 1).length).toEqual(1);
+        expect(pipe.transform(ATTRIBUTE_LIST, 1)).toContain(ATTRIBUTE_LIST[0]);
+    });
+});

client/src/app/shared/pipes/attribute-list-by-family.pipe.ts

@@ -11,7 +11,15 @@ import { Pipe, PipeTransform } from '@angular/core';
 
 import { Attribute } from 'src/app/metamodel/models';
 
-@Pipe({name: 'attributeListByFamily'})
+/**
+ * @class
+ * @classdesc Returns attributes corresponding to the given criteria family ID.
+ *
+ * @example
+ * // returns attributes that matching with the criteria family ID among the attribute list
+ * {{ attributeList | attributesListByFamily:1 }}
+ */
+@Pipe({ name: 'attributeListByFamily' })
 export class AttributeListByFamilyPipe implements PipeTransform {
     transform(attributeList: Attribute[], idCriteriaFamily: number): Attribute[] {
         return attributeList.filter(attribute => attribute.id_criteria_family === idCriteriaFamily);

client/src/app/shared/pipes/dataset-by-name.pipe.spec.ts

+import { DatasetByNamePipe } from './dataset-by-name.pipe';
+import { DATASET_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] DatasetByNamePipe', () => {
+    let pipe = new DatasetByNamePipe();
+
+    it('should return dataset corresponding to the given name', () => {
+        expect(pipe.transform(DATASET_LIST, 'myDataset')).toEqual(DATASET_LIST[0]);
+    });
+});

client/src/app/shared/pipes/dataset-by-name.pipe.ts

@@ -11,7 +11,15 @@ import { Pipe, PipeTransform } from '@angular/core';
 
 import { Dataset } from 'src/app/metamodel/models';
 
-@Pipe({name: 'datasetByName'})
+/**
+ * @class
+ * @classdesc Returns dataset corresponding to the given name.
+ *
+ * @example
+ * // returns dataset object that matching with the 'myDataset' name among the dataset list
+ * {{ datasetList | datasetByName:'myDataset' }}
+ */
+@Pipe({ name: 'datasetByName' })
 export class DatasetByNamePipe implements PipeTransform {
     transform(datasetList: Dataset[], datasetName: string): Dataset {
         return datasetList.find(dataset => dataset.name === datasetName);

client/src/app/shared/pipes/dataset-list-by-family.pipe.spec.ts

+import { DatasetListByFamilyPipe } from './dataset-list-by-family.pipe';
+import { DATASET_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] DatasetListByFamilyPipe', () => {
+    let pipe = new DatasetListByFamilyPipe();
+
+    it('should return datasets corresponding to the given dataset family ID', () => {
+        expect(pipe.transform(DATASET_LIST, 1)).toEqual(DATASET_LIST);
+    });
+});

client/src/app/shared/pipes/dataset-list-by-family.pipe.ts

@@ -11,7 +11,15 @@ import { Pipe, PipeTransform } from '@angular/core';
 
 import { Dataset } from 'src/app/metamodel/models';
 
-@Pipe({name: 'datasetListByFamily'})
+/**
+ * @class
+ * @classdesc Returns datasets corresponding to the given dataset family ID.
+ *
+ * @example
+ * // returns datasets that matching with the dataset family ID among the dataset list
+ * {{ datasetList | datasetListByFamily:1 }}
+ */
+@Pipe({ name: 'datasetListByFamily' })
 export class DatasetListByFamilyPipe implements PipeTransform {
     transform(datasetList: Dataset[], idDatasetFamily: number): Dataset[] {
         return datasetList.filter(dataset => dataset.id_dataset_family === idDatasetFamily);

client/src/app/shared/pipes/index.ts

@@ -11,7 +11,7 @@ import { DatasetListByFamilyPipe } from './dataset-list-by-family.pipe';
 import { AttributeListByFamilyPipe } from './attribute-list-by-family.pipe';
 import { SurveyByNamePipe } from './survey-by-name.pipe';
 import { OptionListBySelectPipe } from './option-list-by-select.pipe';
-import { OutputFamilyById } from './output-family-by-id.pipe';
+import { OutputFamilyByIdPipe } from './output-family-by-id.pipe';
 import { DatasetByNamePipe } from './dataset-by-name.pipe';
 import { InstanceByNamePipe } from './instance-by-name.pipe';
 
@@ -20,7 +20,7 @@ export const sharedPipes = [
     AttributeListByFamilyPipe,
     SurveyByNamePipe,
     OptionListBySelectPipe,
-    OutputFamilyById,
+    OutputFamilyByIdPipe,
     DatasetByNamePipe,
     InstanceByNamePipe
 ];

client/src/app/shared/pipes/instance-by-name.pipe.spec.ts

+import { InstanceByNamePipe } from './instance-by-name.pipe';
+import { INSTANCE_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] InstanceByNamePipe', () => {
+    let pipe = new InstanceByNamePipe();
+
+    it('should return survey corresponding to the given name', () => {
+        expect(pipe.transform(INSTANCE_LIST, 'myOtherInstance')).toEqual(INSTANCE_LIST[0]);
+    });
+});

client/src/app/shared/pipes/instance-by-name.pipe.ts

@@ -11,7 +11,15 @@ import { Pipe, PipeTransform } from '@angular/core';
 
 import { Instance } from 'src/app/metamodel/models';
 
-@Pipe({name: 'instanceByName'})
+/**
+ * @class
+ * @classdesc Returns instance corresponding to the given name.
+ *
+ * @example
+ * // returns instance object that matching with the 'myInstance' name among the instance list
+ * {{ instanceList | instanceByName:'myInstance' }}
+ */
+@Pipe({ name: 'instanceByName' })
 export class InstanceByNamePipe implements PipeTransform {
     transform(instanceList: Instance[], instanceName: string): Instance {
         return instanceList.find(instance => instance.name === instanceName);

client/src/app/shared/pipes/option-list-by-select.pipe.spec.ts

+import { OptionListBySelectPipe } from './option-list-by-select.pipe';
+import { SELECT_OPTION_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] OptionListBySelect', () => {
+    let pipe = new OptionListBySelectPipe();
+
+    it('should return options corresponding to the given select name', () => {
+        expect(pipe.transform(SELECT_OPTION_LIST, 'name_one')).toContain(SELECT_OPTION_LIST[1]);
+        expect(pipe.transform(SELECT_OPTION_LIST, 'name_one').length).toEqual(1);
+    });
+});

client/src/app/shared/pipes/option-list-by-select.pipe.ts

@@ -11,7 +11,15 @@ import { Pipe, PipeTransform } from '@angular/core';
 
 import { SelectOption } from 'src/app/metamodel/models';
 
-@Pipe({name: 'optionListBySelect'})
+/**
+ * @class
+ * @classdesc Returns options corresponding to the given select name.
+ *
+ * @example
+ * // returns options that matching with the select name among the option list
+ * {{ optionList | optionListBySelect:'search_flag' }}
+ */
+@Pipe({ name: 'optionListBySelect' })
 export class OptionListBySelectPipe implements PipeTransform {
     transform(optionList: SelectOption[], selectName: string): SelectOption[] {
         return optionList.filter(option => option.select_name  === selectName);

client/src/app/shared/pipes/output-family-by-id.pipe.spec.ts

+import { OutputFamilyByIdPipe } from './output-family-by-id.pipe';
+import { OUTPUT_FAMILY_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] OutputFamilyByIdPipe', () => {
+    let pipe = new OutputFamilyByIdPipe();
+
+    it('should return output family corresponding to the given ID', () => {
+        expect(pipe.transform(OUTPUT_FAMILY_LIST, 1)).toEqual(OUTPUT_FAMILY_LIST[1]);
+    });
+});

client/src/app/shared/pipes/output-family-by-id.pipe.ts

@@ -11,8 +11,16 @@ import { Pipe, PipeTransform } from '@angular/core';
 
 import { OutputFamily } from 'src/app/metamodel/models';
 
-@Pipe({name: 'outputFamilyById'})
-export class OutputFamilyById implements PipeTransform {
+/**
+ * @class
+ * @classdesc Returns output family corresponding to the given ID.
+ *
+ * @example
+ * // returns output family object that matching with the ID 1 among the output family list
+ * {{ outputFamilyList | outputFamilyById:1 }}
+ */
+@Pipe({ name: 'outputFamilyById' })
+export class OutputFamilyByIdPipe implements PipeTransform {
     transform(outputFamilyList: OutputFamily[], outputFamilyId: number): OutputFamily {
         return outputFamilyList.find(outputFamily => outputFamily.id === outputFamilyId);
     }

client/src/app/shared/pipes/survey-by-name.pipe.spec.ts

+import { SurveyByNamePipe } from './survey-by-name.pipe';
+import { SURVEY_LIST } from '../../../test-data';
+
+describe('[Shared][Pipes] SurveyByNamePipe', () => {
+    let pipe = new SurveyByNamePipe();
+
+    it('should return survey corresponding to the given name', () => {
+        expect(pipe.transform(SURVEY_LIST, 'survey-one')).toEqual(SURVEY_LIST[0]);
+    });
+});