refactor: move citation to DatasetVersion

IQSS · Dec 15, 2023 · 37180ad · 37180ad
1 parent 9c3a455
commit 37180ad
Show file tree

Hide file tree

Showing 11 changed files with 90 additions and 127 deletions.
diff --git a/src/dataset/domain/models/Dataset.ts b/src/dataset/domain/models/Dataset.ts
@@ -220,9 +220,10 @@ export class DatasetVersion {
     public readonly isLatest: boolean,
     public readonly isInReview: boolean,
     public readonly latestVersionStatus: DatasetPublishingStatus,
+    public readonly citation: string,
     public readonly majorNumber?: number,
-    public readonly minorNumber?: number,
     // requestedVersion will be set if the user requested a version that did not exist.
+    public readonly minorNumber?: number,
     public readonly requestedVersion?: string
   ) {}
 
@@ -273,7 +274,6 @@ export class Dataset {
   constructor(
     public readonly persistentId: string,
     public readonly version: DatasetVersion,
-    public readonly citation: string,
     public readonly labels: DatasetLabel[],
     public readonly alerts: Alert[],
     public readonly summaryFields: DatasetMetadataBlock[],
@@ -361,7 +361,6 @@ export class Dataset {
     constructor(
       public readonly persistentId: string,
       public readonly version: DatasetVersion,
-      public readonly citation: string,
       public readonly summaryFields: DatasetMetadataBlock[],
       public readonly license: DatasetLicense = defaultLicense,
       public readonly metadataBlocks: DatasetMetadataBlocks,
@@ -470,7 +469,6 @@ export class Dataset {
       return new Dataset(
         this.persistentId,
         this.version,
-        this.citation,
         this.labels,
         this.alerts,
         this.summaryFields,

diff --git a/src/dataset/infrastructure/mappers/JSDatasetMapper.ts b/src/dataset/infrastructure/mappers/JSDatasetMapper.ts
@@ -26,8 +26,8 @@ import {
 export class JSDatasetMapper {
   static toDataset(
     jsDataset: JSDataset,
-    citation: string,
-    summaryFieldsNames: string[],
+    jsDatasetCitation: string,
+    jsDatasetSummaryFieldsNames: string[],
     jsDatasetPermissions: JSDatasetPermissions,
     jsDatasetLocks: JSDatasetLock[],
     requestedVersion?: string,
@@ -36,13 +36,13 @@ export class JSDatasetMapper {
     const version = JSDatasetMapper.toVersion(
       jsDataset.versionId,
       jsDataset.versionInfo,
+      jsDatasetCitation,
       requestedVersion
     )
     return new Dataset.Builder(
       jsDataset.persistentId,
       version,
-      citation,
-      JSDatasetMapper.toSummaryFields(jsDataset.metadataBlocks, summaryFieldsNames),
+      JSDatasetMapper.toSummaryFields(jsDataset.metadataBlocks, jsDatasetSummaryFieldsNames),
       jsDataset.license,
       JSDatasetMapper.toMetadataBlocks(
         jsDataset.metadataBlocks,
@@ -66,14 +66,16 @@ export class JSDatasetMapper {
   static toVersion(
     jDatasetVersionId: number,
     jsDatasetVersionInfo: JSDatasetVersionInfo,
+    jsDatasetCitation: string,
     requestedVersion?: string
   ): DatasetVersion {
     return new DatasetVersion(
       jDatasetVersionId,
       JSDatasetMapper.toStatus(jsDatasetVersionInfo.state),
-      true, // TODO Connect with dataset version isLatest
-      false, // TODO Connect with dataset version isInReview
-      JSDatasetMapper.toStatus(jsDatasetVersionInfo.state), // TODO Connect with dataset version latestVersionState
+      true,
+      false,
+      JSDatasetMapper.toStatus(jsDatasetVersionInfo.state),
+      jsDatasetCitation,
       jsDatasetVersionInfo.majorNumber,
       jsDatasetVersionInfo.minorNumber,
       requestedVersion

diff --git a/src/sections/dataset/Dataset.tsx b/src/sections/dataset/Dataset.tsx
@@ -60,7 +60,6 @@ export function Dataset({ fileRepository }: DatasetProps) {
                 <DatasetCitation
                   title={dataset.getTitle()}
                   thumbnail={dataset.thumbnail}
-                  citation={dataset.citation}
                   version={dataset.version}
                 />
               </Col>

diff --git a/src/sections/dataset/dataset-citation/DatasetCitation.tsx b/src/sections/dataset/dataset-citation/DatasetCitation.tsx
@@ -8,11 +8,10 @@ import { CitationThumbnail } from './CitationThumbnail'
 interface DatasetCitationProps {
   thumbnail?: string
   title: string
-  citation: string
   version: DatasetVersion
 }
 
-export function DatasetCitation({ thumbnail, title, citation, version }: DatasetCitationProps) {
+export function DatasetCitation({ thumbnail, title, version }: DatasetCitationProps) {
   const { t } = useTranslation('dataset')
   return (
     <>
@@ -32,7 +31,10 @@ export function DatasetCitation({ thumbnail, title, citation, version }: Dataset
           </Col>
           <Col>
             <Row>
-              <CitationDescription citation={citation} version={version} />
+              <CitationDescription
+                citation={version.citation}
+                publishingStatus={version.publishingStatus}
+              />
             </Row>
             <Row>
               <div>
@@ -53,13 +55,19 @@ export function DatasetCitation({ thumbnail, title, citation, version }: Dataset
   )
 }
 
-function CitationDescription({ citation, version }: { citation: string; version: DatasetVersion }) {
+function CitationDescription({
+  citation,
+  publishingStatus
+}: {
+  citation: string
+  publishingStatus: DatasetPublishingStatus
+}) {
   const citationAsReactElement = parse(citation)
 
   return (
     <span className={styles.citation}>
       {citationAsReactElement}
-      <CitationTooltip status={version.publishingStatus} />
+      <CitationTooltip status={publishingStatus} />
     </span>
   )
 }

diff --git a/src/stories/dataset/dataset-alerts/DatasetAlert.stories.tsx b/src/stories/dataset/dataset-alerts/DatasetAlert.stories.tsx
@@ -62,7 +62,8 @@ export const DraftVersion: Story = {
         DatasetPublishingStatus.DRAFT,
         true,
         false,
-        DatasetPublishingStatus.DRAFT
+        DatasetPublishingStatus.DRAFT,
+        ''
       ),
       permissions: DatasetPermissionsMother.createWithPublishingDatasetAllowed()
     })
@@ -83,6 +84,7 @@ export const VersionNotFound: Story = {
         true,
         false,
         DatasetPublishingStatus.RELEASED,
+        '',
         1,
         0,
         '3.0'
@@ -105,6 +107,7 @@ export const VersionNotFoundShowDraft: Story = {
         true,
         false,
         DatasetPublishingStatus.DRAFT,
+        '',
         1,
         0,
         '3.0'
@@ -127,6 +130,7 @@ export const SharePrivateUrl: Story = {
         true,
         false,
         DatasetPublishingStatus.DRAFT,
+        '',
         1,
         0
       ),
@@ -153,6 +157,7 @@ export const UsePrivateUrl: Story = {
         true,
         false,
         DatasetPublishingStatus.DRAFT,
+        '',
         1,
         0
       ),

diff --git a/src/stories/dataset/dataset-citation/DatasetCitation.stories.tsx b/src/stories/dataset/dataset-citation/DatasetCitation.stories.tsx
@@ -1,9 +1,11 @@
 import type { Meta, StoryObj } from '@storybook/react'
 import { WithI18next } from '../../WithI18next'
 import { DatasetCitation } from '../../../sections/dataset/dataset-citation/DatasetCitation'
-import { DatasetPublishingStatus, DatasetVersion } from '../../../dataset/domain/models/Dataset'
 import { faker } from '@faker-js/faker'
-import { DatasetMother } from '../../../../tests/component/dataset/domain/models/DatasetMother'
+import {
+  DatasetMother,
+  DatasetVersionMother
+} from '../../../../tests/component/dataset/domain/models/DatasetMother'
 
 const meta: Meta<typeof DatasetCitation> = {
   title: 'Sections/Dataset Page/DatasetCitation',
@@ -21,11 +23,7 @@ export const Default: Story = {
       <div>
         <br></br>
         <br></br>
-        <DatasetCitation
-          title={dataset.getTitle()}
-          citation={dataset.citation}
-          version={dataset.version}
-        />
+        <DatasetCitation title={dataset.getTitle()} version={dataset.version} />
       </div>
     )
   }
@@ -41,7 +39,6 @@ export const WithThumbnail: Story = {
         <DatasetCitation
           title={dataset.getTitle()}
           thumbnail={dataset.thumbnail}
-          citation={dataset.citation}
           version={dataset.version}
         />
       </div>
@@ -52,15 +49,7 @@ export const WithThumbnail: Story = {
 export const DraftVersion: Story = {
   render: () => {
     const dataset = DatasetMother.createRealistic({
-      citation:
-        'Admin, Dataverse, 2023, "Dataset Title", <a href="https://doi.org/10.5072/FK2/BUDNRV" target="_blank">https://doi.org/10.5072/FK2/BUDNRV</a>, Root, DRAFT VERSION',
-      version: new DatasetVersion(
-        1,
-        DatasetPublishingStatus.DRAFT,
-        true,
-        false,
-        DatasetPublishingStatus.DRAFT
-      )
+      version: DatasetVersionMother.createDraft()
     })
 
     /*
@@ -70,11 +59,7 @@ export const DraftVersion: Story = {
       <div>
         <br></br>
         <br></br>
-        <DatasetCitation
-          title={dataset.getTitle()}
-          citation={dataset.citation}
-          version={dataset.version}
-        />
+        <DatasetCitation title={dataset.getTitle()} version={dataset.version} />
       </div>
     )
   }
@@ -83,17 +68,7 @@ export const DraftVersion: Story = {
 export const Deaccessioned: Story = {
   render: () => {
     const dataset = DatasetMother.createRealistic({
-      citation:
-        'Admin, Dataverse, 2023, "Dataset Title", <a href="https://doi.org/10.5072/FK2/BUDNRV" target="_blank">https://doi.org/10.5072/FK2/BUDNRV</a>, Root, V1 DEACCESSIONED VERSION',
-      version: new DatasetVersion(
-        1,
-        DatasetPublishingStatus.DEACCESSIONED,
-        true,
-        false,
-        DatasetPublishingStatus.DEACCESSIONED,
-        1,
-        0
-      )
+      version: DatasetVersionMother.createDeaccessioned()
     })
 
     /*
@@ -103,22 +78,15 @@ export const Deaccessioned: Story = {
       <div>
         <br></br>
         <br></br>
-        <DatasetCitation
-          title={dataset.getTitle()}
-          citation={dataset.citation}
-          version={dataset.version}
-        />
+        <DatasetCitation title={dataset.getTitle()} version={dataset.version} />
       </div>
     )
   }
 }
 
 export const Anonymized: Story = {
   render: () => {
-    const dataset = DatasetMother.createRealistic({
-      citation:
-        'Author name(s) withheld, 2023, "Dataset Title", <a href="https://doi.org/10.5072/FK2/BUDNRV" target="_blank">https://doi.org/10.5072/FK2/BUDNRV</a>, Root, V1'
-    })
+    const dataset = DatasetMother.createRealisticAnonymized()
 
     /*
         Includes extra breaks, so you can see the DRAFT tooltip message
@@ -127,11 +95,7 @@ export const Anonymized: Story = {
       <div>
         <br></br>
         <br></br>
-        <DatasetCitation
-          title={dataset.getTitle()}
-          citation={dataset.citation}
-          version={dataset.version}
-        />
+        <DatasetCitation title={dataset.getTitle()} version={dataset.version} />
       </div>
     )
   }