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.

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

Feature/358 add unpublished label to collections page #372

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/collection/domain/models/Collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export interface Collection {
id: string
name: string
hierarchy: UpwardHierarchyNode
isReleased: boolean
description?: string
affiliation?: string
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export class JSCollectionMapper {
return {
id: jsCollection.alias,
name: jsCollection.name,
isReleased: true, // TODO: replace with real value, waiting for https://github.com/IQSS/dataverse-client-javascript/issues/139
description: jsCollection.description,
affiliation: jsCollection.affiliation,
hierarchy: JSCollectionMapper.toHierarchy(
Expand Down
5 changes: 5 additions & 0 deletions src/sections/collection/Collection.module.scss
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
margin-bottom: $spacer;
}

.infoContainer {
display: flex;
gap: 10px;
}

.subtext {
color: $dv-subtext-color;
}
13 changes: 10 additions & 3 deletions src/sections/collection/CollectionInfo.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { Collection } from '../../collection/domain/models/Collection'
import styles from './Collection.module.scss'
import { MarkdownComponent } from '../dataset/markdown/MarkdownComponent'
import { Badge } from '@iqss/dataverse-design-system'
import { DatasetLabelSemanticMeaning } from '../../dataset/domain/models/Dataset'

interface CollectionInfoProps {
collection: Collection
Expand All @@ -11,9 +13,14 @@ export function CollectionInfo({ collection }: CollectionInfoProps) {
<>
<header className={styles.header}>
<h1>{collection.name}</h1>
{collection.affiliation && (
<span className={styles.subtext}>({collection.affiliation})</span>
)}
<div className={styles.infoContainer}>
{collection.affiliation && (
<span className={styles.subtext}>({collection.affiliation})</span>
)}
{!collection.isReleased && (
<Badge variant={DatasetLabelSemanticMeaning.WARNING}>Unpublished</Badge>
)}
</div>
</header>
{collection.description && (
<div>
Expand Down
3 changes: 3 additions & 0 deletions src/stories/collection/CollectionInfo.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ export const WithAffiliation: Story = {
render: () => <CollectionInfo collection={CollectionMother.createWithAffiliation()} />
}

export const Unpublished: Story = {
render: () => <CollectionInfo collection={CollectionMother.createUnpublished()} />
}
export const WithDescription: Story = {
render: () => <CollectionInfo collection={CollectionMother.createWithDescription()} />
}
11 changes: 10 additions & 1 deletion tests/component/collection/domain/models/CollectionMother.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export class CollectionMother {
return {
id: faker.datatype.uuid(),
name: faker.lorem.words(3),
isReleased: faker.datatype.boolean(),
description: faker.datatype.boolean()
? `${faker.lorem.paragraph()} **${faker.lorem.sentence()}** ${faker.lorem.paragraph()}`
: undefined,
Expand All @@ -20,6 +21,7 @@ export class CollectionMother {
static createRealistic(): Collection {
return CollectionMother.create({
id: 'science',
isReleased: true,
name: 'Collection Name',
description: 'We do all the science.',
affiliation: 'Scientific Research University'
Expand All @@ -30,6 +32,7 @@ export class CollectionMother {
return CollectionMother.create({
id: faker.datatype.uuid(),
name: FakerHelper.collectionName(),
isReleased: faker.datatype.boolean(),
affiliation: undefined,
description: undefined,
...props
Expand All @@ -39,12 +42,18 @@ export class CollectionMother {
static createComplete(): Collection {
return CollectionMother.create({
id: faker.datatype.uuid(),
isReleased: faker.datatype.boolean(),
name: FakerHelper.collectionName(),
description: FakerHelper.paragraph(),
affiliation: FakerHelper.affiliation()
})
}

static createUnpublished(): Collection {
return CollectionMother.createWithOnlyRequiredFields({
isReleased: false,
affiliation: FakerHelper.affiliation()
})
}
static createWithDescription(): Collection {
return CollectionMother.createWithOnlyRequiredFields({
description: FakerHelper.paragraph()
Expand Down
8 changes: 8 additions & 0 deletions tests/component/sections/collection/CollectionInfo.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ describe('CollectionInfo', () => {
const collection = CollectionMother.create({
name: 'Collection Name',
affiliation: 'Affiliation',
isReleased: true,
description: 'Here is a description with [a link](https://dataverse.org)'
})
cy.customMount(<CollectionInfo collection={collection} />)
Expand All @@ -14,6 +15,7 @@ describe('CollectionInfo', () => {
cy.findByText('(Affiliation)').should('exist')
cy.findByText(/Here is a description with/).should('exist')
cy.findByRole('link', { name: 'a link' }).should('exist')
cy.findByText('Unpublished').should('not.exist')
})

it('does not render affiliation when it is not present', () => {
Expand All @@ -33,4 +35,10 @@ describe('CollectionInfo', () => {

cy.findByText('Description').should('not.exist')
})
it('renders unpublished label when isReleased is false', () => {
const collection = CollectionMother.createUnpublished()
cy.customMount(<CollectionInfo collection={collection} />)

cy.findByText('Unpublished').should('exist')
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const collectionExpected = {
id: 'new-collection',
name: 'Scientific Research',
description: 'We do all the science.',
isReleased: true,
affiliation: 'Scientific Research University',
hierarchy: new UpwardHierarchyNode(
'Scientific Research',
Expand Down
Loading