mirror of
https://github.com/DSpace/dspace-angular.git
synced 2025-10-07 10:04:11 +00:00
Merge pull request #421 from atmire/Configurable-Browse-By
Configurable browse-by
This commit is contained in:
@@ -149,7 +149,32 @@ module.exports = {
|
|||||||
// Limit for years to display using jumps of five years (current year - fiveYearLimit)
|
// Limit for years to display using jumps of five years (current year - fiveYearLimit)
|
||||||
fiveYearLimit: 30,
|
fiveYearLimit: 30,
|
||||||
// The absolute lowest year to display in the dropdown (only used when no lowest date can be found for all items)
|
// The absolute lowest year to display in the dropdown (only used when no lowest date can be found for all items)
|
||||||
defaultLowerLimit: 1900
|
defaultLowerLimit: 1900,
|
||||||
|
// List of all the active Browse-By types
|
||||||
|
// Adding a type will activate their Browse-By page and add them to the global navigation menu, as well as community and collection pages
|
||||||
|
// Allowed fields and their purpose:
|
||||||
|
// id: The browse id to use for fetching info from the rest api
|
||||||
|
// type: The type of Browse-By page to display
|
||||||
|
// metadataField: The metadata-field used to create starts-with options (only necessary when the type is set to 'date')
|
||||||
|
types: [
|
||||||
|
{
|
||||||
|
id: 'title',
|
||||||
|
type: 'title'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'dateissued',
|
||||||
|
type: 'date',
|
||||||
|
metadataField: 'dc.date.issued'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'author',
|
||||||
|
type: 'metadata'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'subject',
|
||||||
|
type: 'metadata'
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
item: {
|
item: {
|
||||||
edit: {
|
edit: {
|
||||||
|
@@ -781,7 +781,7 @@
|
|||||||
"control_panel": "Control Panel",
|
"control_panel": "Control Panel",
|
||||||
"browse_global": "All of DSpace",
|
"browse_global": "All of DSpace",
|
||||||
"browse_global_communities_and_collections": "Communities & Collections",
|
"browse_global_communities_and_collections": "Communities & Collections",
|
||||||
"browse_global_by_issue_date": "By Issue Date",
|
"browse_global_by_dateissued": "By Issue Date",
|
||||||
"browse_global_by_author": "By Author",
|
"browse_global_by_author": "By Author",
|
||||||
"browse_global_by_title": "By Title",
|
"browse_global_by_title": "By Title",
|
||||||
"browse_global_by_subject": "By Subject",
|
"browse_global_by_subject": "By Subject",
|
||||||
|
@@ -13,6 +13,7 @@ import { BrowseService } from '../../core/browse/browse.service';
|
|||||||
import { DSpaceObjectDataService } from '../../core/data/dspace-object-data.service';
|
import { DSpaceObjectDataService } from '../../core/data/dspace-object-data.service';
|
||||||
import { GLOBAL_CONFIG, GlobalConfig } from '../../../config';
|
import { GLOBAL_CONFIG, GlobalConfig } from '../../../config';
|
||||||
import { StartsWithType } from '../../shared/starts-with/starts-with-decorator';
|
import { StartsWithType } from '../../shared/starts-with/starts-with-decorator';
|
||||||
|
import { BrowseByType, rendersBrowseBy } from '../+browse-by-switcher/browse-by-decorator';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ds-browse-by-date-page',
|
selector: 'ds-browse-by-date-page',
|
||||||
@@ -21,9 +22,10 @@ import { StartsWithType } from '../../shared/starts-with/starts-with-decorator';
|
|||||||
})
|
})
|
||||||
/**
|
/**
|
||||||
* Component for browsing items by metadata definition of type 'date'
|
* Component for browsing items by metadata definition of type 'date'
|
||||||
* A metadata definition is a short term used to describe one or multiple metadata fields.
|
* A metadata definition (a.k.a. browse id) is a short term used to describe one or multiple metadata fields.
|
||||||
* An example would be 'dateissued' for 'dc.date.issued'
|
* An example would be 'dateissued' for 'dc.date.issued'
|
||||||
*/
|
*/
|
||||||
|
@rendersBrowseBy(BrowseByType.Date)
|
||||||
export class BrowseByDatePageComponent extends BrowseByMetadataPageComponent {
|
export class BrowseByDatePageComponent extends BrowseByMetadataPageComponent {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -53,12 +55,12 @@ export class BrowseByDatePageComponent extends BrowseByMetadataPageComponent {
|
|||||||
})
|
})
|
||||||
.subscribe((params) => {
|
.subscribe((params) => {
|
||||||
const metadataField = params.metadataField || this.defaultMetadataField;
|
const metadataField = params.metadataField || this.defaultMetadataField;
|
||||||
this.metadata = params.metadata || this.defaultMetadata;
|
this.browseId = params.id || this.defaultBrowseId;
|
||||||
this.startsWith = +params.startsWith || params.startsWith;
|
this.startsWith = +params.startsWith || params.startsWith;
|
||||||
const searchOptions = browseParamsToOptions(params, Object.assign({}), this.sortConfig, this.metadata);
|
const searchOptions = browseParamsToOptions(params, Object.assign({}), this.sortConfig, this.browseId);
|
||||||
this.updatePageWithItems(searchOptions, this.value);
|
this.updatePageWithItems(searchOptions, this.value);
|
||||||
this.updateParent(params.scope);
|
this.updateParent(params.scope);
|
||||||
this.updateStartsWithOptions(this.metadata, metadataField, params.scope);
|
this.updateStartsWithOptions(this.browseId, metadataField, params.scope);
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,8 +80,9 @@ export class BrowseByDatePageComponent extends BrowseByMetadataPageComponent {
|
|||||||
let lowerLimit = this.config.browseBy.defaultLowerLimit;
|
let lowerLimit = this.config.browseBy.defaultLowerLimit;
|
||||||
if (hasValue(firstItemRD.payload)) {
|
if (hasValue(firstItemRD.payload)) {
|
||||||
const date = firstItemRD.payload.firstMetadataValue(metadataField);
|
const date = firstItemRD.payload.firstMetadataValue(metadataField);
|
||||||
if (hasValue(date) && hasValue(+date.split('-')[0])) {
|
if (hasValue(date)) {
|
||||||
lowerLimit = +date.split('-')[0];
|
const dateObj = new Date(date);
|
||||||
|
lowerLimit = dateObj.getFullYear();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const options = [];
|
const options = [];
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="browse-by-metadata w-100">
|
<div class="browse-by-metadata w-100">
|
||||||
<ds-browse-by *ngIf="startsWithOptions" class="col-xs-12 w-100"
|
<ds-browse-by *ngIf="startsWithOptions" class="col-xs-12 w-100"
|
||||||
title="{{'browse.title' | translate:{collection: (parent$ | async)?.payload?.name || '', field: 'browse.metadata.' + metadata | translate, value: (value)? '"' + value + '"': ''} }}"
|
title="{{'browse.title' | translate:{collection: (parent$ | async)?.payload?.name || '', field: 'browse.metadata.' + browseId | translate, value: (value)? '"' + value + '"': ''} }}"
|
||||||
[objects$]="(items$ !== undefined)? items$ : browseEntries$"
|
[objects$]="(items$ !== undefined)? items$ : browseEntries$"
|
||||||
[paginationConfig]="paginationConfig"
|
[paginationConfig]="paginationConfig"
|
||||||
[sortConfig]="sortConfig"
|
[sortConfig]="sortConfig"
|
||||||
|
@@ -15,6 +15,7 @@ import { DSpaceObjectDataService } from '../../core/data/dspace-object-data.serv
|
|||||||
import { DSpaceObject } from '../../core/shared/dspace-object.model';
|
import { DSpaceObject } from '../../core/shared/dspace-object.model';
|
||||||
import { take } from 'rxjs/operators';
|
import { take } from 'rxjs/operators';
|
||||||
import { StartsWithType } from '../../shared/starts-with/starts-with-decorator';
|
import { StartsWithType } from '../../shared/starts-with/starts-with-decorator';
|
||||||
|
import { BrowseByType, rendersBrowseBy } from '../+browse-by-switcher/browse-by-decorator';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ds-browse-by-metadata-page',
|
selector: 'ds-browse-by-metadata-page',
|
||||||
@@ -23,9 +24,10 @@ import { StartsWithType } from '../../shared/starts-with/starts-with-decorator';
|
|||||||
})
|
})
|
||||||
/**
|
/**
|
||||||
* Component for browsing (items) by metadata definition
|
* Component for browsing (items) by metadata definition
|
||||||
* A metadata definition is a short term used to describe one or multiple metadata fields.
|
* A metadata definition (a.k.a. browse id) is a short term used to describe one or multiple metadata fields.
|
||||||
* An example would be 'author' for 'dc.contributor.*'
|
* An example would be 'author' for 'dc.contributor.*'
|
||||||
*/
|
*/
|
||||||
|
@rendersBrowseBy(BrowseByType.Metadata)
|
||||||
export class BrowseByMetadataPageComponent implements OnInit {
|
export class BrowseByMetadataPageComponent implements OnInit {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -63,14 +65,14 @@ export class BrowseByMetadataPageComponent implements OnInit {
|
|||||||
subs: Subscription[] = [];
|
subs: Subscription[] = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The default metadata definition to resort to when none is provided
|
* The default browse id to resort to when none is provided
|
||||||
*/
|
*/
|
||||||
defaultMetadata = 'author';
|
defaultBrowseId = 'author';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The current metadata definition
|
* The current browse id
|
||||||
*/
|
*/
|
||||||
metadata = this.defaultMetadata;
|
browseId = this.defaultBrowseId;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The type of StartsWith options to render
|
* The type of StartsWith options to render
|
||||||
@@ -112,10 +114,10 @@ export class BrowseByMetadataPageComponent implements OnInit {
|
|||||||
return Object.assign({}, params, queryParams);
|
return Object.assign({}, params, queryParams);
|
||||||
})
|
})
|
||||||
.subscribe((params) => {
|
.subscribe((params) => {
|
||||||
this.metadata = params.metadata || this.defaultMetadata;
|
this.browseId = params.id || this.defaultBrowseId;
|
||||||
this.value = +params.value || params.value || '';
|
this.value = +params.value || params.value || '';
|
||||||
this.startsWith = +params.startsWith || params.startsWith;
|
this.startsWith = +params.startsWith || params.startsWith;
|
||||||
const searchOptions = browseParamsToOptions(params, this.paginationConfig, this.sortConfig, this.metadata);
|
const searchOptions = browseParamsToOptions(params, this.paginationConfig, this.sortConfig, this.browseId);
|
||||||
if (isNotEmpty(this.value)) {
|
if (isNotEmpty(this.value)) {
|
||||||
this.updatePageWithItems(searchOptions, this.value);
|
this.updatePageWithItems(searchOptions, this.value);
|
||||||
} else {
|
} else {
|
||||||
|
@@ -0,0 +1,12 @@
|
|||||||
|
import { BrowseByType, rendersBrowseBy } from './browse-by-decorator';
|
||||||
|
|
||||||
|
describe('BrowseByDecorator', () => {
|
||||||
|
const titleDecorator = rendersBrowseBy(BrowseByType.Title);
|
||||||
|
const dateDecorator = rendersBrowseBy(BrowseByType.Date);
|
||||||
|
const metadataDecorator = rendersBrowseBy(BrowseByType.Metadata);
|
||||||
|
it('should have a decorator for all types', () => {
|
||||||
|
expect(titleDecorator.length).not.toEqual(0);
|
||||||
|
expect(dateDecorator.length).not.toEqual(0);
|
||||||
|
expect(metadataDecorator.length).not.toEqual(0);
|
||||||
|
});
|
||||||
|
});
|
@@ -0,0 +1,37 @@
|
|||||||
|
import { hasNoValue } from '../../shared/empty.util';
|
||||||
|
|
||||||
|
export enum BrowseByType {
|
||||||
|
Title = 'title',
|
||||||
|
Metadata = 'metadata',
|
||||||
|
Date = 'date'
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_BROWSE_BY_TYPE = BrowseByType.Metadata;
|
||||||
|
|
||||||
|
const map = new Map();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decorator used for rendering Browse-By pages by type
|
||||||
|
* @param browseByType The type of page
|
||||||
|
*/
|
||||||
|
export function rendersBrowseBy(browseByType: BrowseByType) {
|
||||||
|
return function decorator(component: any) {
|
||||||
|
if (hasNoValue(map.get(browseByType))) {
|
||||||
|
map.set(browseByType, component);
|
||||||
|
} else {
|
||||||
|
throw new Error(`There can't be more than one component to render Browse-By of type "${browseByType}"`);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the component used for rendering a Browse-By page by type
|
||||||
|
* @param browseByType The type of page
|
||||||
|
*/
|
||||||
|
export function getComponentByBrowseByType(browseByType) {
|
||||||
|
const comp = map.get(browseByType);
|
||||||
|
if (hasNoValue(comp)) {
|
||||||
|
map.get(DEFAULT_BROWSE_BY_TYPE);
|
||||||
|
}
|
||||||
|
return comp;
|
||||||
|
}
|
@@ -0,0 +1 @@
|
|||||||
|
<ng-container *ngComponentOutlet="browseByComponent | async"></ng-container>
|
@@ -0,0 +1,55 @@
|
|||||||
|
import { BrowseBySwitcherComponent } from './browse-by-switcher.component';
|
||||||
|
import { async, ComponentFixture, TestBed } from '@angular/core/testing';
|
||||||
|
import { NO_ERRORS_SCHEMA } from '@angular/core';
|
||||||
|
import { ENV_CONFIG, GLOBAL_CONFIG } from '../../../config';
|
||||||
|
import { ActivatedRoute } from '@angular/router';
|
||||||
|
import * as decorator from './browse-by-decorator';
|
||||||
|
import createSpy = jasmine.createSpy;
|
||||||
|
import { BehaviorSubject } from 'rxjs/internal/BehaviorSubject';
|
||||||
|
|
||||||
|
describe('BrowseBySwitcherComponent', () => {
|
||||||
|
let comp: BrowseBySwitcherComponent;
|
||||||
|
let fixture: ComponentFixture<BrowseBySwitcherComponent>;
|
||||||
|
|
||||||
|
const types = ENV_CONFIG.browseBy.types;
|
||||||
|
|
||||||
|
const params = new BehaviorSubject(createParamsWithId('initialValue'));
|
||||||
|
|
||||||
|
const activatedRouteStub = {
|
||||||
|
params: params
|
||||||
|
};
|
||||||
|
|
||||||
|
beforeEach(async(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
declarations: [ BrowseBySwitcherComponent ],
|
||||||
|
providers: [
|
||||||
|
{ provide: GLOBAL_CONFIG, useValue: ENV_CONFIG },
|
||||||
|
{ provide: ActivatedRoute, useValue: activatedRouteStub }
|
||||||
|
],
|
||||||
|
schemas: [ NO_ERRORS_SCHEMA ]
|
||||||
|
}).compileComponents();
|
||||||
|
}));
|
||||||
|
|
||||||
|
beforeEach(async(() => {
|
||||||
|
fixture = TestBed.createComponent(BrowseBySwitcherComponent);
|
||||||
|
comp = fixture.componentInstance;
|
||||||
|
spyOnProperty(decorator, 'getComponentByBrowseByType').and.returnValue(createSpy('getComponentByItemType'));
|
||||||
|
}));
|
||||||
|
|
||||||
|
types.forEach((type) => {
|
||||||
|
describe(`when switching to a browse-by page for "${type.id}"`, () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
params.next(createParamsWithId(type.id));
|
||||||
|
fixture.detectChanges();
|
||||||
|
});
|
||||||
|
|
||||||
|
it(`should call getComponentByBrowseByType with type "${type.type}"`, () => {
|
||||||
|
expect(decorator.getComponentByBrowseByType).toHaveBeenCalledWith(type.type);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
export function createParamsWithId(id) {
|
||||||
|
return { id: id };
|
||||||
|
}
|
@@ -0,0 +1,40 @@
|
|||||||
|
import { Component, Inject, OnInit } from '@angular/core';
|
||||||
|
import { ActivatedRoute } from '@angular/router';
|
||||||
|
import { Observable } from 'rxjs/internal/Observable';
|
||||||
|
import { GLOBAL_CONFIG, GlobalConfig } from '../../../config';
|
||||||
|
import { BrowseByTypeConfig } from '../../../config/browse-by-type-config.interface';
|
||||||
|
import { map, tap } from 'rxjs/operators';
|
||||||
|
import { getComponentByBrowseByType } from './browse-by-decorator';
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'ds-browse-by-switcher',
|
||||||
|
templateUrl: './browse-by-switcher.component.html'
|
||||||
|
})
|
||||||
|
/**
|
||||||
|
* Component for determining what Browse-By component to use depending on the metadata (browse ID) provided
|
||||||
|
*/
|
||||||
|
export class BrowseBySwitcherComponent implements OnInit {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolved browse-by component
|
||||||
|
*/
|
||||||
|
browseByComponent: Observable<any>;
|
||||||
|
|
||||||
|
public constructor(@Inject(GLOBAL_CONFIG) public config: GlobalConfig,
|
||||||
|
protected route: ActivatedRoute) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch the correct browse-by component by using the relevant config from environment.js
|
||||||
|
*/
|
||||||
|
ngOnInit(): void {
|
||||||
|
this.browseByComponent = this.route.params.pipe(
|
||||||
|
map((params) => {
|
||||||
|
const id = params.id;
|
||||||
|
return this.config.browseBy.types.find((config: BrowseByTypeConfig) => config.id === id);
|
||||||
|
}),
|
||||||
|
map((config: BrowseByTypeConfig) => getComponentByBrowseByType(config.type))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,6 +1,5 @@
|
|||||||
import { combineLatest as observableCombineLatest } from 'rxjs';
|
import { combineLatest as observableCombineLatest } from 'rxjs';
|
||||||
import { Component } from '@angular/core';
|
import { Component } from '@angular/core';
|
||||||
import { ItemDataService } from '../../core/data/item-data.service';
|
|
||||||
import { ActivatedRoute, Router } from '@angular/router';
|
import { ActivatedRoute, Router } from '@angular/router';
|
||||||
import { hasValue } from '../../shared/empty.util';
|
import { hasValue } from '../../shared/empty.util';
|
||||||
import {
|
import {
|
||||||
@@ -11,6 +10,7 @@ import { BrowseEntrySearchOptions } from '../../core/browse/browse-entry-search-
|
|||||||
import { DSpaceObjectDataService } from '../../core/data/dspace-object-data.service';
|
import { DSpaceObjectDataService } from '../../core/data/dspace-object-data.service';
|
||||||
import { BrowseService } from '../../core/browse/browse.service';
|
import { BrowseService } from '../../core/browse/browse.service';
|
||||||
import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
|
import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
|
||||||
|
import { BrowseByType, rendersBrowseBy } from '../+browse-by-switcher/browse-by-decorator';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'ds-browse-by-title-page',
|
selector: 'ds-browse-by-title-page',
|
||||||
@@ -20,6 +20,7 @@ import { SortDirection, SortOptions } from '../../core/cache/models/sort-options
|
|||||||
/**
|
/**
|
||||||
* Component for browsing items by title (dc.title)
|
* Component for browsing items by title (dc.title)
|
||||||
*/
|
*/
|
||||||
|
@rendersBrowseBy(BrowseByType.Title)
|
||||||
export class BrowseByTitlePageComponent extends BrowseByMetadataPageComponent {
|
export class BrowseByTitlePageComponent extends BrowseByMetadataPageComponent {
|
||||||
|
|
||||||
public constructor(protected route: ActivatedRoute,
|
public constructor(protected route: ActivatedRoute,
|
||||||
@@ -41,8 +42,8 @@ export class BrowseByTitlePageComponent extends BrowseByMetadataPageComponent {
|
|||||||
return Object.assign({}, params, queryParams, data);
|
return Object.assign({}, params, queryParams, data);
|
||||||
})
|
})
|
||||||
.subscribe((params) => {
|
.subscribe((params) => {
|
||||||
this.metadata = params.metadata || this.defaultMetadata;
|
this.browseId = params.id || this.defaultBrowseId;
|
||||||
this.updatePageWithItems(browseParamsToOptions(params, this.paginationConfig, this.sortConfig, this.metadata), undefined);
|
this.updatePageWithItems(browseParamsToOptions(params, this.paginationConfig, this.sortConfig, this.browseId), undefined);
|
||||||
this.updateParent(params.scope)
|
this.updateParent(params.scope)
|
||||||
}));
|
}));
|
||||||
this.updateStartsWithTextOptions();
|
this.updateStartsWithTextOptions();
|
||||||
|
@@ -1,6 +1,7 @@
|
|||||||
import { first } from 'rxjs/operators';
|
import { first } from 'rxjs/operators';
|
||||||
import { BrowseByGuard } from './browse-by-guard';
|
import { BrowseByGuard } from './browse-by-guard';
|
||||||
import { of as observableOf } from 'rxjs';
|
import { of as observableOf } from 'rxjs';
|
||||||
|
import { ENV_CONFIG } from '../../config';
|
||||||
|
|
||||||
describe('BrowseByGuard', () => {
|
describe('BrowseByGuard', () => {
|
||||||
describe('canActivate', () => {
|
describe('canActivate', () => {
|
||||||
@@ -11,20 +12,20 @@ describe('BrowseByGuard', () => {
|
|||||||
const name = 'An interesting DSO';
|
const name = 'An interesting DSO';
|
||||||
const title = 'Author';
|
const title = 'Author';
|
||||||
const field = 'Author';
|
const field = 'Author';
|
||||||
const metadata = 'author';
|
const id = 'author';
|
||||||
const metadataField = 'dc.contributor';
|
const metadataField = 'dc.contributor';
|
||||||
const scope = '1234-65487-12354-1235';
|
const scope = '1234-65487-12354-1235';
|
||||||
const value = 'Filter';
|
const value = 'Filter';
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
dsoService = {
|
dsoService = {
|
||||||
findById: (id: string) => observableOf({ payload: { name: name }, hasSucceeded: true })
|
findById: (dsoId: string) => observableOf({ payload: { name: name }, hasSucceeded: true })
|
||||||
};
|
};
|
||||||
|
|
||||||
translateService = {
|
translateService = {
|
||||||
instant: () => field
|
instant: () => field
|
||||||
};
|
};
|
||||||
guard = new BrowseByGuard(dsoService, translateService);
|
guard = new BrowseByGuard(ENV_CONFIG, dsoService, translateService);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should return true, and sets up the data correctly, with a scope and value', () => {
|
it('should return true, and sets up the data correctly, with a scope and value', () => {
|
||||||
@@ -34,7 +35,7 @@ describe('BrowseByGuard', () => {
|
|||||||
metadataField,
|
metadataField,
|
||||||
},
|
},
|
||||||
params: {
|
params: {
|
||||||
metadata,
|
id,
|
||||||
},
|
},
|
||||||
queryParams: {
|
queryParams: {
|
||||||
scope,
|
scope,
|
||||||
@@ -47,7 +48,7 @@ describe('BrowseByGuard', () => {
|
|||||||
(canActivate) => {
|
(canActivate) => {
|
||||||
const result = {
|
const result = {
|
||||||
title,
|
title,
|
||||||
metadata,
|
id,
|
||||||
metadataField,
|
metadataField,
|
||||||
collection: name,
|
collection: name,
|
||||||
field,
|
field,
|
||||||
@@ -66,7 +67,7 @@ describe('BrowseByGuard', () => {
|
|||||||
metadataField,
|
metadataField,
|
||||||
},
|
},
|
||||||
params: {
|
params: {
|
||||||
metadata,
|
id,
|
||||||
},
|
},
|
||||||
queryParams: {
|
queryParams: {
|
||||||
scope
|
scope
|
||||||
@@ -79,7 +80,7 @@ describe('BrowseByGuard', () => {
|
|||||||
(canActivate) => {
|
(canActivate) => {
|
||||||
const result = {
|
const result = {
|
||||||
title,
|
title,
|
||||||
metadata,
|
id,
|
||||||
metadataField,
|
metadataField,
|
||||||
collection: name,
|
collection: name,
|
||||||
field,
|
field,
|
||||||
@@ -98,7 +99,7 @@ describe('BrowseByGuard', () => {
|
|||||||
metadataField,
|
metadataField,
|
||||||
},
|
},
|
||||||
params: {
|
params: {
|
||||||
metadata,
|
id,
|
||||||
},
|
},
|
||||||
queryParams: {
|
queryParams: {
|
||||||
value
|
value
|
||||||
@@ -110,7 +111,7 @@ describe('BrowseByGuard', () => {
|
|||||||
(canActivate) => {
|
(canActivate) => {
|
||||||
const result = {
|
const result = {
|
||||||
title,
|
title,
|
||||||
metadata,
|
id,
|
||||||
metadataField,
|
metadataField,
|
||||||
collection: '',
|
collection: '',
|
||||||
field,
|
field,
|
||||||
|
@@ -1,11 +1,12 @@
|
|||||||
import { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
|
import { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
|
||||||
import { Injectable } from '@angular/core';
|
import { Inject, Injectable } from '@angular/core';
|
||||||
import { DSpaceObjectDataService } from '../core/data/dspace-object-data.service';
|
import { DSpaceObjectDataService } from '../core/data/dspace-object-data.service';
|
||||||
import { hasValue } from '../shared/empty.util';
|
import { hasNoValue, hasValue } from '../shared/empty.util';
|
||||||
import { map } from 'rxjs/operators';
|
import { map } from 'rxjs/operators';
|
||||||
import { getSucceededRemoteData } from '../core/shared/operators';
|
import { getSucceededRemoteData } from '../core/shared/operators';
|
||||||
import { TranslateService } from '@ngx-translate/core';
|
import { TranslateService } from '@ngx-translate/core';
|
||||||
import { of as observableOf } from 'rxjs';
|
import { of as observableOf } from 'rxjs';
|
||||||
|
import { GLOBAL_CONFIG, GlobalConfig } from '../../config';
|
||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
/**
|
/**
|
||||||
@@ -13,36 +14,43 @@ import { of as observableOf } from 'rxjs';
|
|||||||
*/
|
*/
|
||||||
export class BrowseByGuard implements CanActivate {
|
export class BrowseByGuard implements CanActivate {
|
||||||
|
|
||||||
constructor(protected dsoService: DSpaceObjectDataService,
|
constructor(@Inject(GLOBAL_CONFIG) public config: GlobalConfig,
|
||||||
|
protected dsoService: DSpaceObjectDataService,
|
||||||
protected translate: TranslateService) {
|
protected translate: TranslateService) {
|
||||||
}
|
}
|
||||||
|
|
||||||
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot) {
|
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot) {
|
||||||
const title = route.data.title;
|
const title = route.data.title;
|
||||||
const metadata = route.params.metadata || route.queryParams.metadata || route.data.metadata;
|
const id = route.params.id || route.queryParams.id || route.data.id;
|
||||||
const metadataField = route.data.metadataField;
|
let metadataField = route.data.metadataField;
|
||||||
|
if (hasNoValue(metadataField) && hasValue(id)) {
|
||||||
|
const config = this.config.browseBy.types.find((conf) => conf.id === id);
|
||||||
|
if (hasValue(config) && hasValue(config.metadataField)) {
|
||||||
|
metadataField = config.metadataField;
|
||||||
|
}
|
||||||
|
}
|
||||||
const scope = route.queryParams.scope;
|
const scope = route.queryParams.scope;
|
||||||
const value = route.queryParams.value;
|
const value = route.queryParams.value;
|
||||||
const metadataTranslated = this.translate.instant('browse.metadata.' + metadata);
|
const metadataTranslated = this.translate.instant('browse.metadata.' + id);
|
||||||
if (hasValue(scope)) {
|
if (hasValue(scope)) {
|
||||||
const dsoAndMetadata$ = this.dsoService.findById(scope).pipe(getSucceededRemoteData());
|
const dsoAndMetadata$ = this.dsoService.findById(scope).pipe(getSucceededRemoteData());
|
||||||
return dsoAndMetadata$.pipe(
|
return dsoAndMetadata$.pipe(
|
||||||
map((dsoRD) => {
|
map((dsoRD) => {
|
||||||
const name = dsoRD.payload.name;
|
const name = dsoRD.payload.name;
|
||||||
route.data = this.createData(title, metadata, metadataField, name, metadataTranslated, value);
|
route.data = this.createData(title, id, metadataField, name, metadataTranslated, value);
|
||||||
return true;
|
return true;
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
route.data = this.createData(title, metadata, metadataField, '', metadataTranslated, value);
|
route.data = this.createData(title, id, metadataField, '', metadataTranslated, value);
|
||||||
return observableOf(true);
|
return observableOf(true);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private createData(title, metadata, metadataField, collection, field, value) {
|
private createData(title, id, metadataField, collection, field, value) {
|
||||||
return {
|
return {
|
||||||
title: title,
|
title: title,
|
||||||
metadata: metadata,
|
id: id,
|
||||||
metadataField: metadataField,
|
metadataField: metadataField,
|
||||||
collection: collection,
|
collection: collection,
|
||||||
field: field,
|
field: field,
|
||||||
|
@@ -1,16 +1,12 @@
|
|||||||
import { RouterModule } from '@angular/router';
|
import { RouterModule } from '@angular/router';
|
||||||
import { NgModule } from '@angular/core';
|
import { NgModule } from '@angular/core';
|
||||||
import { BrowseByTitlePageComponent } from './+browse-by-title-page/browse-by-title-page.component';
|
|
||||||
import { BrowseByMetadataPageComponent } from './+browse-by-metadata-page/browse-by-metadata-page.component';
|
|
||||||
import { BrowseByDatePageComponent } from './+browse-by-date-page/browse-by-date-page.component';
|
|
||||||
import { BrowseByGuard } from './browse-by-guard';
|
import { BrowseByGuard } from './browse-by-guard';
|
||||||
|
import { BrowseBySwitcherComponent } from './+browse-by-switcher/browse-by-switcher.component';
|
||||||
|
|
||||||
@NgModule({
|
@NgModule({
|
||||||
imports: [
|
imports: [
|
||||||
RouterModule.forChild([
|
RouterModule.forChild([
|
||||||
{ path: 'title', component: BrowseByTitlePageComponent, canActivate: [BrowseByGuard], data: { metadata: 'title', title: 'browse.title' } },
|
{ path: ':id', component: BrowseBySwitcherComponent, canActivate: [BrowseByGuard], data: { title: 'browse.title' } }
|
||||||
{ path: 'dateissued', component: BrowseByDatePageComponent, canActivate: [BrowseByGuard], data: { metadata: 'dateissued', metadataField: 'dc.date.issued', title: 'browse.title' } },
|
|
||||||
{ path: ':metadata', component: BrowseByMetadataPageComponent, canActivate: [BrowseByGuard], data: { title: 'browse.title' } }
|
|
||||||
])
|
])
|
||||||
]
|
]
|
||||||
})
|
})
|
||||||
|
@@ -8,6 +8,7 @@ import { BrowseService } from '../core/browse/browse.service';
|
|||||||
import { BrowseByMetadataPageComponent } from './+browse-by-metadata-page/browse-by-metadata-page.component';
|
import { BrowseByMetadataPageComponent } from './+browse-by-metadata-page/browse-by-metadata-page.component';
|
||||||
import { BrowseByDatePageComponent } from './+browse-by-date-page/browse-by-date-page.component';
|
import { BrowseByDatePageComponent } from './+browse-by-date-page/browse-by-date-page.component';
|
||||||
import { BrowseByGuard } from './browse-by-guard';
|
import { BrowseByGuard } from './browse-by-guard';
|
||||||
|
import { BrowseBySwitcherComponent } from './+browse-by-switcher/browse-by-switcher.component';
|
||||||
|
|
||||||
@NgModule({
|
@NgModule({
|
||||||
imports: [
|
imports: [
|
||||||
@@ -18,12 +19,18 @@ import { BrowseByGuard } from './browse-by-guard';
|
|||||||
declarations: [
|
declarations: [
|
||||||
BrowseByTitlePageComponent,
|
BrowseByTitlePageComponent,
|
||||||
BrowseByMetadataPageComponent,
|
BrowseByMetadataPageComponent,
|
||||||
BrowseByDatePageComponent
|
BrowseByDatePageComponent,
|
||||||
|
BrowseBySwitcherComponent
|
||||||
],
|
],
|
||||||
providers: [
|
providers: [
|
||||||
ItemDataService,
|
ItemDataService,
|
||||||
BrowseService,
|
BrowseService,
|
||||||
BrowseByGuard
|
BrowseByGuard
|
||||||
|
],
|
||||||
|
entryComponents: [
|
||||||
|
BrowseByTitlePageComponent,
|
||||||
|
BrowseByMetadataPageComponent,
|
||||||
|
BrowseByDatePageComponent
|
||||||
]
|
]
|
||||||
})
|
})
|
||||||
export class BrowseByModule {
|
export class BrowseByModule {
|
||||||
|
@@ -11,6 +11,7 @@ import { NoopAnimationsModule } from '@angular/platform-browser/animations';
|
|||||||
import { Injector, NO_ERRORS_SCHEMA } from '@angular/core';
|
import { Injector, NO_ERRORS_SCHEMA } from '@angular/core';
|
||||||
import { MenuService } from '../shared/menu/menu.service';
|
import { MenuService } from '../shared/menu/menu.service';
|
||||||
import { MenuServiceStub } from '../shared/testing/menu-service-stub';
|
import { MenuServiceStub } from '../shared/testing/menu-service-stub';
|
||||||
|
import { ENV_CONFIG, GLOBAL_CONFIG } from '../../config';
|
||||||
|
|
||||||
let comp: NavbarComponent;
|
let comp: NavbarComponent;
|
||||||
let fixture: ComponentFixture<NavbarComponent>;
|
let fixture: ComponentFixture<NavbarComponent>;
|
||||||
@@ -30,6 +31,7 @@ describe('NavbarComponent', () => {
|
|||||||
{ provide: Injector, useValue: {} },
|
{ provide: Injector, useValue: {} },
|
||||||
{ provide: MenuService, useValue: menuService },
|
{ provide: MenuService, useValue: menuService },
|
||||||
{ provide: HostWindowService, useValue: new HostWindowServiceStub(800) },
|
{ provide: HostWindowService, useValue: new HostWindowServiceStub(800) },
|
||||||
|
{ provide: GLOBAL_CONFIG, useValue: ENV_CONFIG }
|
||||||
],
|
],
|
||||||
schemas: [NO_ERRORS_SCHEMA]
|
schemas: [NO_ERRORS_SCHEMA]
|
||||||
})
|
})
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
import { Component, Injector, OnInit } from '@angular/core';
|
import { Component, Inject, Injector, OnInit } from '@angular/core';
|
||||||
import { slideMobileNav } from '../shared/animations/slide';
|
import { slideMobileNav } from '../shared/animations/slide';
|
||||||
import { MenuComponent } from '../shared/menu/menu.component';
|
import { MenuComponent } from '../shared/menu/menu.component';
|
||||||
import { MenuService } from '../shared/menu/menu.service';
|
import { MenuService } from '../shared/menu/menu.service';
|
||||||
@@ -6,6 +6,7 @@ import { MenuID, MenuItemType } from '../shared/menu/initial-menus-state';
|
|||||||
import { TextMenuItemModel } from '../shared/menu/menu-item/models/text.model';
|
import { TextMenuItemModel } from '../shared/menu/menu-item/models/text.model';
|
||||||
import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model';
|
import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model';
|
||||||
import { HostWindowService } from '../shared/host-window.service';
|
import { HostWindowService } from '../shared/host-window.service';
|
||||||
|
import { GLOBAL_CONFIG, GlobalConfig } from '../../config';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Component representing the public navbar
|
* Component representing the public navbar
|
||||||
@@ -23,7 +24,8 @@ export class NavbarComponent extends MenuComponent implements OnInit {
|
|||||||
*/
|
*/
|
||||||
menuID = MenuID.PUBLIC;
|
menuID = MenuID.PUBLIC;
|
||||||
|
|
||||||
constructor(protected menuService: MenuService,
|
constructor(@Inject(GLOBAL_CONFIG) public config: GlobalConfig,
|
||||||
|
protected menuService: MenuService,
|
||||||
protected injector: Injector,
|
protected injector: Injector,
|
||||||
public windowService: HostWindowService
|
public windowService: HostWindowService
|
||||||
) {
|
) {
|
||||||
@@ -39,7 +41,7 @@ export class NavbarComponent extends MenuComponent implements OnInit {
|
|||||||
* Initialize all menu sections and items for this menu
|
* Initialize all menu sections and items for this menu
|
||||||
*/
|
*/
|
||||||
createMenu() {
|
createMenu() {
|
||||||
const menuList = [
|
const menuList: any[] = [
|
||||||
/* News */
|
/* News */
|
||||||
{
|
{
|
||||||
id: 'browse_global',
|
id: 'browse_global',
|
||||||
@@ -62,50 +64,6 @@ export class NavbarComponent extends MenuComponent implements OnInit {
|
|||||||
// link: '#'
|
// link: '#'
|
||||||
// } as LinkMenuItemModel,
|
// } as LinkMenuItemModel,
|
||||||
// },
|
// },
|
||||||
{
|
|
||||||
id: 'browse_global_global_by_title',
|
|
||||||
parentID: 'browse_global',
|
|
||||||
active: false,
|
|
||||||
visible: true,
|
|
||||||
model: {
|
|
||||||
type: MenuItemType.LINK,
|
|
||||||
text: 'menu.section.browse_global_by_title',
|
|
||||||
link: '/browse/title'
|
|
||||||
} as LinkMenuItemModel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: 'browse_global_global_by_issue_date',
|
|
||||||
parentID: 'browse_global',
|
|
||||||
active: false,
|
|
||||||
visible: true,
|
|
||||||
model: {
|
|
||||||
type: MenuItemType.LINK,
|
|
||||||
text: 'menu.section.browse_global_by_issue_date',
|
|
||||||
link: '/browse/dateissued'
|
|
||||||
} as LinkMenuItemModel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: 'browse_global_by_author',
|
|
||||||
parentID: 'browse_global',
|
|
||||||
active: false,
|
|
||||||
visible: true,
|
|
||||||
model: {
|
|
||||||
type: MenuItemType.LINK,
|
|
||||||
text: 'menu.section.browse_global_by_author',
|
|
||||||
link: '/browse/author'
|
|
||||||
} as LinkMenuItemModel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: 'browse_global_by_subject',
|
|
||||||
parentID: 'browse_global',
|
|
||||||
active: false,
|
|
||||||
visible: true,
|
|
||||||
model: {
|
|
||||||
type: MenuItemType.LINK,
|
|
||||||
text: 'menu.section.browse_global_by_subject',
|
|
||||||
link: '/browse/subject'
|
|
||||||
} as LinkMenuItemModel,
|
|
||||||
},
|
|
||||||
|
|
||||||
/* Statistics */
|
/* Statistics */
|
||||||
{
|
{
|
||||||
@@ -120,6 +78,21 @@ export class NavbarComponent extends MenuComponent implements OnInit {
|
|||||||
index: 2
|
index: 2
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
// Read the different Browse-By types from config and add them to the browse menu
|
||||||
|
const types = this.config.browseBy.types;
|
||||||
|
types.forEach((typeConfig) => {
|
||||||
|
menuList.push({
|
||||||
|
id: `browse_global_by_${typeConfig.id}`,
|
||||||
|
parentID: 'browse_global',
|
||||||
|
active: false,
|
||||||
|
visible: true,
|
||||||
|
model: {
|
||||||
|
type: MenuItemType.LINK,
|
||||||
|
text: `menu.section.browse_global_by_${typeConfig.id}`,
|
||||||
|
link: `/browse/${typeConfig.id}`
|
||||||
|
} as LinkMenuItemModel
|
||||||
|
});
|
||||||
|
});
|
||||||
menuList.forEach((menuSection) => this.menuService.addSection(this.menuID, menuSection));
|
menuList.forEach((menuSection) => this.menuService.addSection(this.menuID, menuSection));
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,7 +1,6 @@
|
|||||||
<h3>{{'browse.comcol.head' | translate}}</h3>
|
<h3>{{'browse.comcol.head' | translate}}</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a [routerLink]="['/browse/title']" [queryParams]="{scope: id}">{{'browse.comcol.by.title' | translate}}</a></li>
|
<li *ngFor="let config of types">
|
||||||
<li><a [routerLink]="['/browse/dateissued']" [queryParams]="{scope: id}">{{'browse.comcol.by.dateissued' | translate}}</a></li>
|
<a [routerLink]="['/browse/' + config.id]" [queryParams]="{scope: id}">{{'browse.comcol.by.' + config.id | translate}}</a>
|
||||||
<li><a [routerLink]="['/browse/author']" [queryParams]="{scope: id}">{{'browse.comcol.by.author' | translate}}</a></li>
|
</li>
|
||||||
<li><a [routerLink]="['/browse/subject']" [queryParams]="{scope: id}">{{'browse.comcol.by.subject' | translate}}</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
@@ -1,4 +1,6 @@
|
|||||||
import { Component, Input } from '@angular/core';
|
import { Component, Inject, Input, OnInit } from '@angular/core';
|
||||||
|
import { GLOBAL_CONFIG, GlobalConfig } from '../../../config';
|
||||||
|
import { BrowseByTypeConfig } from '../../../config/browse-by-type-config.interface';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A component to display the "Browse By" section of a Community or Collection page
|
* A component to display the "Browse By" section of a Community or Collection page
|
||||||
@@ -8,9 +10,22 @@ import { Component, Input } from '@angular/core';
|
|||||||
selector: 'ds-comcol-page-browse-by',
|
selector: 'ds-comcol-page-browse-by',
|
||||||
templateUrl: './comcol-page-browse-by.component.html',
|
templateUrl: './comcol-page-browse-by.component.html',
|
||||||
})
|
})
|
||||||
export class ComcolPageBrowseByComponent {
|
export class ComcolPageBrowseByComponent implements OnInit {
|
||||||
/**
|
/**
|
||||||
* The ID of the Community or Collection
|
* The ID of the Community or Collection
|
||||||
*/
|
*/
|
||||||
@Input() id: string;
|
@Input() id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of currently active browse configurations
|
||||||
|
*/
|
||||||
|
types: BrowseByTypeConfig[];
|
||||||
|
|
||||||
|
constructor(@Inject(GLOBAL_CONFIG) public config: GlobalConfig) {
|
||||||
|
}
|
||||||
|
|
||||||
|
ngOnInit(): void {
|
||||||
|
this.types = this.config.browseBy.types;
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
import { Config } from './config.interface';
|
import { Config } from './config.interface';
|
||||||
|
import { BrowseByTypeConfig } from './browse-by-type-config.interface';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Config that determines how the dropdown list of years are created for browse-by-date components
|
* Config that determines how the dropdown list of years are created for browse-by-date components
|
||||||
@@ -18,4 +19,9 @@ export interface BrowseByConfig extends Config {
|
|||||||
* The absolute lowest year to display in the dropdown when no lowest date can be found for all items
|
* The absolute lowest year to display in the dropdown when no lowest date can be found for all items
|
||||||
*/
|
*/
|
||||||
defaultLowerLimit: number;
|
defaultLowerLimit: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of all the active Browse-By pages
|
||||||
|
*/
|
||||||
|
types: BrowseByTypeConfig[];
|
||||||
}
|
}
|
||||||
|
23
src/config/browse-by-type-config.interface.ts
Normal file
23
src/config/browse-by-type-config.interface.ts
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import { Config } from './config.interface';
|
||||||
|
import { BrowseByType } from '../app/+browse-by/+browse-by-switcher/browse-by-decorator';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Config used for rendering Browse-By pages and links
|
||||||
|
*/
|
||||||
|
export interface BrowseByTypeConfig extends Config {
|
||||||
|
/**
|
||||||
|
* The browse id used for fetching browse data from the rest api
|
||||||
|
* e.g. author
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of Browse-By page to render
|
||||||
|
*/
|
||||||
|
type: BrowseByType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The metadata field to use for rendering starts-with options (only necessary when type is set to BrowseByType.Date)
|
||||||
|
*/
|
||||||
|
metadataField: string;
|
||||||
|
}
|
Reference in New Issue
Block a user