w2p-85140 ds-rss component now adds a button to all search pages and community and collection, link-head service adds the rss to the head element

This commit is contained in:
Nathan Buckingham
2021-12-01 15:07:45 -05:00
parent c705fc42d6
commit 99e5b9c898
10 changed files with 346 additions and 2 deletions

View File

@@ -0,0 +1,5 @@
<ng-container *ngIf="isEnabled$ | async">
<div *ngIf="route$ | async as route" class="d-inline-block float-right margin-right">
<a [href]="route" class="btn btn-secondary"><i class="fas fa-rss-square"></i></a>
</div>
</ng-container>

View File

@@ -0,0 +1,12 @@
:host {
.dropdown-toggle::after {
display: none;
}
.dropdown-item {
padding-left: 20px;
}
}
.margin-right {
margin-right: .5em;
}

View File

@@ -0,0 +1,109 @@
import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
import { ConfigurationDataService } from '../../core/data/configuration-data.service';
import { RemoteData } from '../../core/data/remote-data';
import { GroupDataService } from '../../core/eperson/group-data.service';
import { PaginationService } from '../../core/pagination/pagination.service';
import { LinkHeadService } from '../../core/services/link-head.service';
import { Collection } from '../../core/shared/collection.model';
import { ConfigurationProperty } from '../../core/shared/configuration-property.model';
import { SearchConfigurationService } from '../../core/shared/search/search-configuration.service';
import { PaginationComponentOptions } from '../pagination/pagination-component-options.model';
import { createSuccessfulRemoteDataObject, createSuccessfulRemoteDataObject$ } from '../remote-data.utils';
import { PaginatedSearchOptions } from '../search/paginated-search-options.model';
import { PaginationServiceStub } from '../testing/pagination-service.stub';
import { createPaginatedList } from '../testing/utils.test';
import { RSSComponent } from './rss.component';
import { of as observableOf } from 'rxjs';
describe('RssComponent', () => {
let comp: RSSComponent;
let options: SortOptions;
let fixture: ComponentFixture<RSSComponent>;
let uuid: string;
let query: string;
let groupDataService: GroupDataService;
let linkHeadService: LinkHeadService;
let configurationDataService: ConfigurationDataService;
let paginationService;
beforeEach(waitForAsync(() => {
const mockCollection: Collection = Object.assign(new Collection(), {
id: 'ce41d451-97ed-4a9c-94a1-7de34f16a9f4',
name: 'test-collection',
_links: {
mappedItems: {
href: 'https://rest.api/collections/ce41d451-97ed-4a9c-94a1-7de34f16a9f4/mappedItems'
},
self: {
href: 'https://rest.api/collections/ce41d451-97ed-4a9c-94a1-7de34f16a9f4'
}
}
});
configurationDataService = jasmine.createSpyObj('configurationDataService', {
findByPropertyName: createSuccessfulRemoteDataObject$(Object.assign(new ConfigurationProperty(), {
name: 'test',
values: [
'org.dspace.ctask.general.ProfileFormats = test'
]
}))
});
linkHeadService = jasmine.createSpyObj('linkHeadService', {
addTag: ''
});
const mockCollectionRD: RemoteData<Collection> = createSuccessfulRemoteDataObject(mockCollection);
const mockSearchOptions = observableOf(new PaginatedSearchOptions({
pagination: Object.assign(new PaginationComponentOptions(), {
id: 'search-page-configuration',
pageSize: 10,
currentPage: 1
}),
sort: new SortOptions('dc.title', SortDirection.ASC),
scope: mockCollection.id
}));
groupDataService = jasmine.createSpyObj('groupsDataService', {
findAllByHref: createSuccessfulRemoteDataObject$(createPaginatedList([])),
getGroupRegistryRouterLink: ''
});
paginationService = new PaginationServiceStub();
const searchConfigService = {
paginatedSearchOptions: mockSearchOptions
};
TestBed.configureTestingModule({
providers: [
{ provide: GroupDataService, useValue: groupDataService },
{ provide: LinkHeadService, useValue: linkHeadService },
{ provide: ConfigurationDataService, useValue: configurationDataService },
{ provide: SearchConfigurationService, useValue: searchConfigService},
{ provide: PaginationService, useValue: paginationService }
],
declarations: [RSSComponent]
}).compileComponents();
}));
beforeEach(() => {
options = new SortOptions('dc.title', SortDirection.DESC);
uuid = '2cfcf65e-0a51-4bcb-8592-b8db7b064790';
query = 'test';
fixture = TestBed.createComponent(RSSComponent);
comp = fixture.componentInstance;
});
it('should formulate the correct url given params in url', () => {
const route = comp.formulateRoute(uuid, options, query);
expect(route).toBe('/opensearch/search?format=atom&scope=2cfcf65e-0a51-4bcb-8592-b8db7b064790&sort=dc.title&sort_direction=DESC&query=test');
});
it('should skip uuid if its null', () => {
const route = comp.formulateRoute(null, options, query);
expect(route).toBe('/opensearch/search?format=atom&sort=dc.title&sort_direction=DESC&query=test');
});
it('should default to query * if none provided', () => {
const route = comp.formulateRoute(null, options, null);
expect(route).toBe('/opensearch/search?format=atom&sort=dc.title&sort_direction=DESC&query=*');
});
});

View File

@@ -0,0 +1,94 @@
import {
ChangeDetectionStrategy,
Component,
OnDestroy,
OnInit,
ViewEncapsulation
} from '@angular/core';
import { BehaviorSubject, Observable } from 'rxjs';
import { GroupDataService } from '../../core/eperson/group-data.service';
import { LinkHeadService } from '../../core/services/link-head.service';
import { ConfigurationDataService } from '../../core/data/configuration-data.service';
import { getFirstCompletedRemoteData } from '../../core/shared/operators';
import { environment } from '../../../../src/environments/environment';
import { SearchConfigurationService } from '../../core/shared/search/search-configuration.service';
import { SortOptions } from '../../core/cache/models/sort-options.model';
import { PaginationService } from '../../core/pagination/pagination.service';
/**
* The default pagination controls component.
*/
@Component({
exportAs: 'rssComponent',
selector: 'ds-rss',
styleUrls: ['rss.component.scss'],
templateUrl: 'rss.component.html',
changeDetection: ChangeDetectionStrategy.Default,
encapsulation: ViewEncapsulation.Emulated
})
export class RSSComponent implements OnInit, OnDestroy {
route$: BehaviorSubject<string>;
isEnabled$: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false);
uuid: string;
configuration$: Observable<string>;
sortOption$: Observable<SortOptions>;
constructor(private groupDataService: GroupDataService,
private linkHeadService: LinkHeadService,
private configurationService: ConfigurationDataService,
private searchConfigurationService: SearchConfigurationService,
protected paginationService: PaginationService) {
}
ngOnDestroy(): void {
this.linkHeadService.removeTag("rel='alternate'");
}
ngOnInit(): void {
this.configuration$ = this.searchConfigurationService.getCurrentConfiguration('default');
this.configurationService.findByPropertyName('websvc.opensearch.enable').pipe(
getFirstCompletedRemoteData(),
).subscribe((result) => {
const enabled = Boolean(result.payload.values[0]);
this.isEnabled$.next(enabled);
});
this.searchConfigurationService.getCurrentQuery('').subscribe((query) => {
this.sortOption$ = this.paginationService.getCurrentSort(this.searchConfigurationService.paginationID, null, true);
this.sortOption$.subscribe((sort) => {
this.uuid = this.groupDataService.getUUIDFromString(window.location.href);
const route = environment.rest.baseUrl + this.formulateRoute(this.uuid, sort, query);
this.linkHeadService.addTag({
href: route,
type: 'application/atom+xml',
rel: 'alternate',
title: 'Sitewide Atom feed'
});
this.route$ = new BehaviorSubject<string>(route);
});
});
}
formulateRoute(uuid: string, sort: SortOptions, query: string): string {
let route = 'search?format=atom';
if (uuid) {
route += `&scope=${uuid}`;
}
if (sort.direction && sort.field) {
route += `&sort=${sort.field}&sort_direction=${sort.direction}`;
}
if (query) {
route += `&query=${query}`;
} else {
route += `&query=*`;
}
route = '/opensearch/' + route;
return route;
}
}