Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editor: Extract and remove national/regional toggle #1063

Merged
merged 5 commits into from
Dec 19, 2024
Merged

Editor: Extract and remove national/regional toggle #1063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b6edbd6
feat(editor): create form-field-spatial-toggle
Angi-Kinas Dec 12, 2024
efeed3a
feat: extract national/regional toggle from
Angi-Kinas Dec 12, 2024
4e196fd
chore(e2e): remove test for nation/regional toggle
Angi-Kinas Dec 12, 2024
5684c88
chore: fix unit test
Angi-Kinas Dec 12, 2024
87cff9b
chore: move unit tests to spatial toggle comp
Angi-Kinas Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions apps/metadata-editor-e2e/src/e2e/edit.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,27 +441,6 @@ describe('editor form', () => {
.should('have.length', 1)
})
})
describe('spatial scope', () => {
it('toggle between national and regional spatial coverage', () => {
cy.get('gn-ui-switch-toggle').should('exist')

cy.get('gn-ui-switch-toggle').find('mat-button-toggle').eq(0).click()
cy.get('mat-button-toggle')
.eq(0)
.should('have.class', 'mat-button-toggle-checked')
cy.get('mat-button-toggle')
.eq(1)
.should('not.have.class', 'mat-button-toggle-checked')

cy.get('gn-ui-switch-toggle').find('mat-button-toggle').eq(1).click()
cy.get('mat-button-toggle')
.eq(1)
.should('have.class', 'mat-button-toggle-checked')
cy.get('mat-button-toggle')
.eq(0)
.should('not.have.class', 'mat-button-toggle-checked')
})
})
})
describe('distribution resources', () => {
beforeEach(() => {
Expand Down
101 changes: 101 additions & 0 deletions libs/common/fixtures/src/lib/records.fixtures.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import {
CatalogRecord,
DatasetRecord,
DatasetSpatialExtent,
Keyword,
} from '@geonetwork-ui/common/domain/model/record'

export const datasetRecordsFixture: () => CatalogRecord[] = () => [
Expand Down Expand Up @@ -464,3 +466,102 @@ export const simpleDatasetRecordAsXmlFixture =
</mrl:LI_Lineage>
</mdb:resourceLineage>
</mdb:MD_Metadata>`

export const NATIONAL_KEYWORD = {
key: 'http://inspire.ec.europa.eu/metadata-codelist/SpatialScope/national',
label: 'National',
description: '',
type: 'theme',
}

export const SAMPLE_PLACE_KEYWORDS: Keyword[] = [
// these keywords come from a thesaurus available locally
{
key: 'uri1',
label: 'Berlin',
thesaurus: {
id: '1',
name: 'places',
},
type: 'place',
bbox: [13.27, 52.63, 52.5, 13.14],
},
{
key: 'uri2',
label: 'Hamburg',
thesaurus: {
id: '1',
name: 'places',
},
type: 'place',
bbox: [10.5, 53.66, 53.53, 10],
},
// this keyword is available locally but has no extent linked to it
{
key: 'uri3',
label: 'Munich',
thesaurus: {
id: '1',
name: 'places',
},
type: 'place',
bbox: [11.64, 48.65, 48.51, 11.5],
},
// this keyword comes from a thesaurus not available locally
{
label: 'Europe',
thesaurus: {
id: '2',
name: 'otherPlaces',
},
type: 'place',
},
// this keyword has no thesaurus
{
label: 'Narnia',
type: 'place',
},
]

// records coming from XML do not have a key or a bbox in them
export const SAMPLE_PLACE_KEYWORDS_FROM_XML = SAMPLE_PLACE_KEYWORDS.map(
({ label, thesaurus, type }) => ({
label,
type,
...(thesaurus && { thesaurus }),
})
)

export const SAMPLE_SPATIAL_EXTENTS: DatasetSpatialExtent[] = [
// these extents are linked to keywords known locally
{
description: 'uri1',
bbox: [13.5, 52.5, 14.5, 53.5],
},
{
description: 'uri2',
bbox: [10, 53.5, 11, 53.4],
},
{
description: 'uri4',
bbox: [11.5, 48.5, 11.5, 48.3],
},
// this extent is linked to a keyword not available locally
{
description: 'URI-Paris',
bbox: [1, 2, 3, 4],
},
// this extent is not linked to any keyword
{
bbox: [5, 6, 7, 8],
},
]

export const SAMPLE_RECORD = {
...datasetRecordsFixture()[0],
spatialExtents: SAMPLE_SPATIAL_EXTENTS,
keywords: [
...datasetRecordsFixture()[0].keywords,
...SAMPLE_PLACE_KEYWORDS_FROM_XML,
],
}
5 changes: 0 additions & 5 deletions ...record-form/form-field/form-field-spatial-extent/form-field-spatial-extent.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
<div class="flex flex-col gap-8">
<gn-ui-switch-toggle
[options]="switchToggleOptions$ | async"
(selectedValue)="onSpatialScopeChange($event)"
extraClasses="grow text-sm"
></gn-ui-switch-toggle>
<gn-ui-generic-keywords
[placeholder]="'Search for place keywords'"
[keywords]="shownKeywords$ | async"
Expand Down
174 changes: 9 additions & 165 deletions ...ord-form/form-field/form-field-spatial-extent/form-field-spatial-extent.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,116 +1,23 @@
import { ComponentFixture, TestBed } from '@angular/core/testing'
import { FormFieldSpatialExtentComponent } from './form-field-spatial-extent.component'
import { BehaviorSubject, firstValueFrom, from, of } from 'rxjs'
import { BehaviorSubject, from, of } from 'rxjs'
import { PlatformServiceInterface } from '@geonetwork-ui/common/domain/platform.service.interface'
import {
CatalogRecord,
DatasetSpatialExtent,
Keyword,
} from '@geonetwork-ui/common/domain/model/record'
import { MockBuilder, MockProvider } from 'ng-mocks'
import { EditorFacade } from '../../../../+state/editor.facade'
import { datasetRecordsFixture } from '@geonetwork-ui/common/fixtures'
import {
datasetRecordsFixture,
NATIONAL_KEYWORD,
SAMPLE_PLACE_KEYWORDS,
SAMPLE_PLACE_KEYWORDS_FROM_XML,
SAMPLE_RECORD,
SAMPLE_SPATIAL_EXTENTS,
} from '@geonetwork-ui/common/fixtures'
import { TranslateModule } from '@ngx-translate/core'

const NATIONAL_KEYWORD = {
key: 'http://inspire.ec.europa.eu/metadata-codelist/SpatialScope/national',
label: 'National',
description: '',
type: 'theme',
}

const SAMPLE_PLACE_KEYWORDS: Keyword[] = [
// these keywords come from a thesaurus available locally
{
key: 'uri1',
label: 'Berlin',
thesaurus: {
id: '1',
name: 'places',
},
type: 'place',
bbox: [13.27, 52.63, 52.5, 13.14],
},
{
key: 'uri2',
label: 'Hamburg',
thesaurus: {
id: '1',
name: 'places',
},
type: 'place',
bbox: [10.5, 53.66, 53.53, 10],
},
// this keyword is available locally but has no extent linked to it
{
key: 'uri3',
label: 'Munich',
thesaurus: {
id: '1',
name: 'places',
},
type: 'place',
bbox: [11.64, 48.65, 48.51, 11.5],
},
// this keyword comes from a thesaurus not available locally
{
label: 'Europe',
thesaurus: {
id: '2',
name: 'otherPlaces',
},
type: 'place',
},
// this keyword has no thesaurus
{
label: 'Narnia',
type: 'place',
},
]

// records coming from XML do not have a key or a bbox in them
const SAMPLE_PLACE_KEYWORDS_FROM_XML = SAMPLE_PLACE_KEYWORDS.map(
({ label, thesaurus, type }) => ({
label,
type,
...(thesaurus && { thesaurus }),
})
)

const SAMPLE_SPATIAL_EXTENTS: DatasetSpatialExtent[] = [
// these extents are linked to keywords known locally
{
description: 'uri1',
bbox: [13.5, 52.5, 14.5, 53.5],
},
{
description: 'uri2',
bbox: [10, 53.5, 11, 53.4],
},
{
description: 'uri4',
bbox: [11.5, 48.5, 11.5, 48.3],
},
// this extent is linked to a keyword not available locally
{
description: 'URI-Paris',
bbox: [1, 2, 3, 4],
},
// this extent is not linked to any keyword
{
bbox: [5, 6, 7, 8],
},
]

const SAMPLE_RECORD = {
...datasetRecordsFixture()[0],
spatialExtents: SAMPLE_SPATIAL_EXTENTS,
keywords: [
...datasetRecordsFixture()[0].keywords,
...SAMPLE_PLACE_KEYWORDS_FROM_XML,
],
}

class PlatformServiceInterfaceMock {
// this simulates a search of a complete keyword with bbox, key...
// only thesaurus 1 is known
Expand Down Expand Up @@ -354,69 +261,6 @@ describe('FormFieldSpatialExtentComponent', () => {
})
})
describe('spatial coverage', () => {
describe('switch toggle option is based on the keywords present in the record', () => {
it('should return true if the record has a national keyword', async () => {
const keywords = [
...SAMPLE_PLACE_KEYWORDS,
NATIONAL_KEYWORD,
] as Keyword[]
editorFacade = TestBed.inject(EditorFacade)
editorFacade.record$ = from([
{ ...SAMPLE_RECORD, keywords } as CatalogRecord,
])
fixture = TestBed.createComponent(FormFieldSpatialExtentComponent)
component = fixture.componentInstance
fixture.detectChanges()

const results = await firstValueFrom(component.switchToggleOptions$)
const nationalOption = results.filter(
(result) => result.label === 'National'
)[0]

expect(nationalOption.checked).toBe(true)
})
it('should return false if the record does not have a national keyword', async () => {
const keywords2 = [...SAMPLE_PLACE_KEYWORDS] as Keyword[]
editorFacade = TestBed.inject(EditorFacade)
editorFacade.record$ = from([
{ ...SAMPLE_RECORD, keywords: keywords2 } as CatalogRecord,
])
fixture = TestBed.createComponent(FormFieldSpatialExtentComponent)
component = fixture.componentInstance
fixture.detectChanges()

const results = await firstValueFrom(component.switchToggleOptions$)
const nationalOption = results.filter(
(result) => result.label === 'National'
)[0]

expect(nationalOption.checked).toBe(false)
})
})
describe('#onSpatialScopeChange', () => {
it('removes all existing spatial scope keywords and add the selected one', async () => {
const spatialScopes = [{ label: 'National' }, { label: 'Regional' }]

const allKeywords = await firstValueFrom(component.allKeywords$)
const filteredKeywords = allKeywords.filter((keyword) => {
const spatialScopeLabels = spatialScopes.map((scope) => scope.label)
return !spatialScopeLabels.includes(keyword.label)
})

const selectedOption = {
label: 'National',
value: NATIONAL_KEYWORD,
checked: true,
}
await component.onSpatialScopeChange(selectedOption)

expect(editorFacade.updateRecordField).toHaveBeenCalledWith(
'keywords',
[...filteredKeywords, NATIONAL_KEYWORD]
)
})
})

describe('#emitChanges', () => {
const allKeywords = [
...datasetRecordsFixture()[0].keywords,
Expand Down
Loading
Loading