Merge branch 'doiRelatedPublication330-771' into 'stable-3_3_0'

JhonathanLepidus · JhonathanLepidus · commit cbe2c6584f75 · 2025-04-16T17:44:43.000Z
Atualização do campo Publicação Relacionada - 3.3.0

See merge request softwares-pkp/plugins_ojs/dataverse!192
diff --git a/classes/APACitation.inc.php b/classes/APACitation.inc.php
@@ -18,17 +18,12 @@ public function getFormattedCitationBySubmission(Submission $submission): string
         $publication = $submission->getCurrentPublication();
         $authors =  $publication->getData('authors');
         $submittedDate = new DateTime($submission->getDateSubmitted());
-        $submissionDoi = $this->getSubmissionDoi($submission);
 
         $submissionCitation = $this->createAuthorsCitationAPA($authors) . ' ';
         $submissionCitation .= '(' . date_format($submittedDate, 'Y') . '). ';
         $submissionCitation .= '<em>' . $submission->getLocalizedTitle($submission->getLocale()) . '</em>. ';
         $submissionCitation .= $journal->getLocalizedName();
 
-        if ($submissionDoi) {
-            $submissionCitation .= ". <a href=\"$submissionDoi\">$submissionDoi</a>";
-        }
-
         return $submissionCitation;
     }
 
@@ -71,24 +66,4 @@ private function getAuthorCitation(Author $author): string
 
         return $familyName . ', ' . mb_substr($givenName, 0, 1) . ".";
     }
-
-    private function getSubmissionDoi(Submission $submission): string
-    {
-        $publication = $submission->getCurrentPublication();
-        $doi = $publication->getStoredPubId('doi');
-
-        if ($doi) {
-            return 'https://doi.org/' . $this->doiURLEncode($doi);
-        }
-
-        return '';
-    }
-
-    private function doiURLEncode($pubId)
-    {
-        $search = ['%', '"', '#', ' ', '<', '>', '{'];
-        $replace = ['%25', '%22', '%23', '%20', '%3c', '%3e', '%7b'];
-        $pubId = str_replace($search, $replace, $pubId);
-        return $pubId;
-    }
 }
diff --git a/classes/dispatchers/DataverseEventsDispatcher.inc.php b/classes/dispatchers/DataverseEventsDispatcher.inc.php
@@ -420,11 +420,11 @@ public function updateDatasetOnPublicationUpdate(string $hookName, array $args):
             return false;
         }
 
-        import('plugins.generic.dataverse.classes.APACitation');
-        $apaCitation = new APACitation();
+        import('plugins.generic.dataverse.classes.factories.SubmissionDatasetFactory');
+        $datasetFactory = new SubmissionDatasetFactory($submission);
 
         $data['persistentId'] = $study->getPersistentId();
-        $data['pubCitation'] = $apaCitation->getFormattedCitationBySubmission($submission);
+        $data['relatedPublication'] = $datasetFactory->getDatasetRelatedPublication($publication);
 
         $datasetService = new DatasetService();
         $datasetService->update($data);
diff --git a/classes/entities/Dataset.inc.php b/classes/entities/Dataset.inc.php
@@ -95,14 +95,14 @@ public function setKeywords(array $keywords): void
         $this->setData('keywords', $keywords);
     }
 
-    public function getPubCitation(): ?string
+    public function getRelatedPublication(): ?DatasetRelatedPublication
     {
-        return $this->getData('pubCitation');
+        return $this->getData('relatedPublication');
     }
 
-    public function setPubCitation(string $pubCitation): void
+    public function setRelatedPublication(DatasetRelatedPublication $relatedPublication): void
     {
-        $this->setData('pubCitation', $pubCitation);
+        $this->setData('relatedPublication', $relatedPublication);
     }
 
     public function getFiles(): ?array
diff --git a/classes/entities/DatasetRelatedPublication.inc.php b/classes/entities/DatasetRelatedPublication.inc.php
@@ -0,0 +1,32 @@
+<?php
+
+class DatasetRelatedPublication extends DataObject
+{
+    public function __construct(string $citation, ?string $idType, ?string $idNumber, ?string $url)
+    {
+        $this->setData('citation', $citation);
+        $this->setData('IDType', $idType);
+        $this->setData('IDNumber', $idNumber);
+        $this->setData('URL', $url);
+    }
+
+    public function getCitation(): string
+    {
+        return $this->getData('citation');
+    }
+
+    public function getIdType(): ?string
+    {
+        return $this->getData('IDType');
+    }
+
+    public function getIdNumber(): ?string
+    {
+        return $this->getData('IDNumber');
+    }
+
+    public function getUrl(): ?string
+    {
+        return $this->getData('URL');
+    }
+}
diff --git a/classes/factories/JsonDatasetFactory.inc.php b/classes/factories/JsonDatasetFactory.inc.php
@@ -4,6 +4,7 @@
 import('plugins.generic.dataverse.classes.entities.DatasetAuthor');
 import('plugins.generic.dataverse.classes.entities.DatasetContact');
 import('plugins.generic.dataverse.classes.entities.DatasetFile');
+import('plugins.generic.dataverse.classes.entities.DatasetRelatedPublication');
 
 class JsonDatasetFactory extends DatasetFactory
 {
@@ -91,7 +92,19 @@ protected function sanitizeProps(): array
                     }, $metadata->value);
                     break;
                 case 'publication':
-                    $props['pubCitation'] = $metadata->value[0]->publicationCitation->value;
+                    $publication = $metadata->value[0];
+                    $props['relatedPublication'] = new DatasetRelatedPublication(
+                        $publication->publicationCitation->value,
+                        isset($publication->publicationIDType->value) ?
+                            $publication->publicationIDType->value
+                            : null,
+                        isset($publication->publicationIDNumber->value) ?
+                            $publication->publicationIDNumber->value
+                            : null,
+                        isset($publication->publicationURL->value) ?
+                            $publication->publicationURL->value
+                            : null
+                    );
                     break;
                 default:
                     break;
diff --git a/classes/factories/SubmissionDatasetFactory.inc.php b/classes/factories/SubmissionDatasetFactory.inc.php
@@ -5,6 +5,7 @@
 import('plugins.generic.dataverse.classes.entities.DatasetAuthor');
 import('plugins.generic.dataverse.classes.entities.DatasetContact');
 import('plugins.generic.dataverse.classes.entities.DatasetFile');
+import('plugins.generic.dataverse.classes.entities.DatasetRelatedPublication');
 
 class SubmissionDatasetFactory extends DatasetFactory
 {
@@ -30,7 +31,7 @@ protected function sanitizeProps(): array
         $props['authors'] = array_map([$this, 'createDatasetAuthor'], $authors);
         $props['contact'] = $this->createDatasetContact();
         $props['depositor'] = $this->getDatasetDepositor();
-        $props['pubCitation'] = $this->getDatasetPubCitation();
+        $props['relatedPublication'] = $this->getDatasetRelatedPublication($publication);
         $props['files'] = $this->getDatasetFiles();
 
         return $props;
@@ -81,11 +82,30 @@ private function getDatasetDepositor(): string
         return $userName . ' (via ' . $contextName . ')';
     }
 
-    private function getDatasetPubCitation(): string
+    public function getDatasetRelatedPublication($publication): DatasetRelatedPublication
     {
         import('plugins.generic.dataverse.classes.APACitation');
         $apaCitation = new APACitation();
-        return $apaCitation->getFormattedCitationBySubmission($this->submission);
+        $submissionCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
+        $submissionDoi = $publication->getStoredPubId('doi');
+
+        if (empty($submissionDoi)) {
+            return new DatasetRelatedPublication($submissionCitation, null, null, null);
+        }
+
+        return new DatasetRelatedPublication(
+            $submissionCitation,
+            'doi',
+            $submissionDoi,
+            "https://doi.org/" . $this->doiURLEncode($submissionDoi)
+        );
+    }
+
+    private function doiURLEncode($doi)
+    {
+        $search = ['%', '"', '#', ' ', '<', '>', '{'];
+        $replace = ['%25', '%22', '%23', '%20', '%3c', '%3e', '%7b'];
+        return str_replace($search, $replace, $doi);
     }
 
     private function getDatasetFiles(): array
diff --git a/dataverseAPI/packagers/NativeAPIDatasetPackager.inc.php b/dataverseAPI/packagers/NativeAPIDatasetPackager.inc.php
@@ -112,7 +112,7 @@ public function getMetadataField(string $metadata): array
                 'multiple' => false,
                 'typeClass' => 'primitive'
             ],
-            'pubCitation' => [
+            'relatedPublication' => [
                 'typeName' => 'publication',
                 'multiple' => true,
                 'typeClass' => 'compound'
@@ -141,14 +141,15 @@ private function createSimpleCompoundMetadata(array $metadataField, string $valu
     private function createMultiCompoundMetadata(array $metadataField, object $object): array
     {
         $objectData = $object->getAllData();
+        $controlledVocabMetadata = ['identifierScheme', 'IDType'];
 
         $metadataValue = [];
         foreach ($objectData as $attr => $value) {
             if (is_null($value)) {
                 continue;
             }
 
-            $metadataTypeClass = $attr == 'identifierScheme' ? 'controlledVocabulary' : 'primitive';
+            $metadataTypeClass = in_array($attr, $controlledVocabMetadata) ? 'controlledVocabulary' : 'primitive';
             $metadataValue = array_merge($metadataValue, [
                 $metadataField['typeName'] . ucfirst($attr) => [
                     'typeName' =>  $metadataField['typeName'] . ucfirst($attr),
diff --git a/tests/APACitationTest.php b/tests/APACitationTest.php
@@ -101,8 +101,7 @@ public function testDatasetCitationGetsDoiMarkup(): void
 
     public function testPreprintCitationIsAPA(): void
     {
-        $expectedSubmissionCitation = 'Castanheiras, I. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus.';
-        $expectedSubmissionCitation .= ' <a href="https://doi.org/10.1234/LepidusPreprints.1245">https://doi.org/10.1234/LepidusPreprints.1245</a>';
+        $expectedSubmissionCitation = 'Castanheiras, I. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus';
 
         $apaCitation = new APACitation();
         $preprintCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
@@ -118,8 +117,7 @@ public function testFamilyNameWithAccentOnTheFirstLetter(): void
         $apaCitation = new APACitation();
         $preprintCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
 
-        $expectedSubmissionCitation = 'Álamo, Á. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus.';
-        $expectedSubmissionCitation .= ' <a href="https://doi.org/10.1234/LepidusPreprints.1245">https://doi.org/10.1234/LepidusPreprints.1245</a>';
+        $expectedSubmissionCitation = 'Álamo, Á. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus';
         $this->assertEquals($expectedSubmissionCitation, $preprintCitation);
     }
 
@@ -131,8 +129,7 @@ public function testGivenNameWithAccentAnyLetterExceptFirstLetterAndFamilyNameWi
         $apaCitation = new APACitation();
         $preprintCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
 
-        $expectedSubmissionCitation = 'Fernandes, M. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus.';
-        $expectedSubmissionCitation .= ' <a href="https://doi.org/10.1234/LepidusPreprints.1245">https://doi.org/10.1234/LepidusPreprints.1245</a>';
+        $expectedSubmissionCitation = 'Fernandes, M. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus';
         $this->assertEquals($expectedSubmissionCitation, $preprintCitation);
     }
 
@@ -144,8 +141,7 @@ public function testFamilyNameWithAccentOnTheFirstLetterAndGivenNameWithoutAccen
         $apaCitation = new APACitation();
         $preprintCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
 
-        $expectedSubmissionCitation = 'Átila, L. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus.';
-        $expectedSubmissionCitation .= ' <a href="https://doi.org/10.1234/LepidusPreprints.1245">https://doi.org/10.1234/LepidusPreprints.1245</a>';
+        $expectedSubmissionCitation = 'Átila, L. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus';
         $this->assertEquals($expectedSubmissionCitation, $preprintCitation);
     }
 
@@ -157,8 +153,7 @@ public function testGivenNameAndFamilyNameWithAccentExceptFirstLetter(): void
         $apaCitation = new APACitation();
         $preprintCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
 
-        $expectedSubmissionCitation = 'Sérgio, C. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus.';
-        $expectedSubmissionCitation .= ' <a href="https://doi.org/10.1234/LepidusPreprints.1245">https://doi.org/10.1234/LepidusPreprints.1245</a>';
+        $expectedSubmissionCitation = 'Sérgio, C. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus';
         $this->assertEquals($expectedSubmissionCitation, $preprintCitation);
     }
 
@@ -169,8 +164,7 @@ public function testGivenNameWithAccentOnTheFirstLetter(): void
         $apaCitation = new APACitation();
         $preprintCitation = $apaCitation->getFormattedCitationBySubmission($this->submission);
 
-        $expectedSubmissionCitation = 'Castanheiras, Â. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus.';
-        $expectedSubmissionCitation .= ' <a href="https://doi.org/10.1234/LepidusPreprints.1245">https://doi.org/10.1234/LepidusPreprints.1245</a>';
+        $expectedSubmissionCitation = 'Castanheiras, Â. (2021). <em>The Rise of The Machine Empire</em>. Preprints da Lepidus';
         $this->assertEquals($expectedSubmissionCitation, $preprintCitation);
     }
 }
diff --git a/tests/dataverseAPI/packagers/NativeAPIDatasetPackagerTest.php b/tests/dataverseAPI/packagers/NativeAPIDatasetPackagerTest.php
@@ -2,6 +2,10 @@
 
 import('lib.pkp.tests.PKPTestCase');
 import('plugins.generic.dataverse.dataverseAPI.packagers.NativeAPIDatasetPackager');
+import('plugins.generic.dataverse.classes.entities.Dataset');
+import('plugins.generic.dataverse.classes.entities.DatasetContact');
+import('plugins.generic.dataverse.classes.entities.DatasetFile');
+import('plugins.generic.dataverse.classes.entities.DatasetRelatedPublication');
 import('plugins.generic.dataverse.classes.DataverseMetadata');
 
 class NativeAPIDatasetPackagerTest extends PKPTestCase
@@ -65,22 +69,46 @@ public function testNativeAPIPackagerBuildsSimpleCompoundMetadata(): void
         $this->assertContains($descriptionMetadata, $this->packager->getDatasetMetadata());
     }
 
-    public function testNativeAPIPackagerBuildsPubCitationMetadata(): void
+    public function testNativeAPIPackagerBuildsRelatedPublicationMetadata(): void
     {
+        $relatedPublication = new DatasetRelatedPublication(
+            'User, T. (2023). <em>Test Dataset</em>. Open Preprint Systems',
+            'doi',
+            '10.1234/LepidusPreprints.1245',
+            'https://doi.org/10.1234/LepidusPreprints.1245'
+        );
         $dataset = new Dataset();
-        $dataset->setPubCitation('User, T. (2023). <em>Test Dataset</em>. Open Preprint Systems');
+        $dataset->setRelatedPublication($relatedPublication);
 
         $this->packager = new NativeAPIDatasetPackager($dataset);
         $this->packager->loadPackageData();
 
-        $publicationMetadata = $this->packager->getMetadataField('pubCitation');
+        $publicationMetadata = $this->packager->getMetadataField('relatedPublication');
         $publicationMetadata['value'] = [
             [
                 'publicationCitation' => [
                     'typeName' => 'publicationCitation',
                     'multiple' => false,
                     'typeClass' => 'primitive',
-                    'value' => $dataset->getPubCitation()
+                    'value' => $relatedPublication->getCitation()
+                ],
+                'publicationIDType' => [
+                    'typeName' => 'publicationIDType',
+                    'multiple' => false,
+                    'typeClass' => 'controlledVocabulary',
+                    'value' => $relatedPublication->getIdType()
+                ],
+                'publicationIDNumber' => [
+                    'typeName' => 'publicationIDNumber',
+                    'multiple' => false,
+                    'typeClass' => 'primitive',
+                    'value' => $relatedPublication->getIdNumber()
+                ],
+                'publicationURL' => [
+                    'typeName' => 'publicationURL',
+                    'multiple' => false,
+                    'typeClass' => 'primitive',
+                    'value' => $relatedPublication->getUrl()
                 ]
             ]
         ];
diff --git a/tests/factories/JsonDatasetFactoryTest.php b/tests/factories/JsonDatasetFactoryTest.php
@@ -1,6 +1,9 @@
 <?php
 
 import('lib.pkp.tests.PKPTestCase');
+import('plugins.generic.dataverse.classes.entities.DatasetAuthor');
+import('plugins.generic.dataverse.classes.entities.DatasetContact');
+import('plugins.generic.dataverse.classes.entities.DatasetRelatedPublication');
 import('plugins.generic.dataverse.classes.factories.JsonDatasetFactory');
 
 class JsonDatasetFactoryTest extends PKPTestCase
@@ -11,20 +14,24 @@ public function testCreateDataset()
         $datasetFactory = new JsonDatasetFactory($jsonContent);
         $dataset = $datasetFactory->getDataset();
 
+        $expectedDatasetAuthor = new DatasetAuthor('Test, Author', 'Dataverse', 'ORCID', '0000-0000-0000-0000');
+        $expectedDatasetContact = new DatasetContact('Test, Contact', 'test@example.com', 'Dataverse');
+        $expectedDatasetRelatedPublication = new DatasetRelatedPublication(
+            'User, T. (2023). <em>Test Dataset</em>. Open Preprint Systems',
+            'doi',
+            '10.1234/LepidusPreprints.1245',
+            'https://doi.org/10.1234/LepidusPreprints.1245'
+        );
+
         $this->assertEquals('doi:10.12345/FK2/ABCDEFG', $dataset->getPersistentId());
         $this->assertEquals('Test title', $dataset->getTitle());
         $this->assertEquals('<p>An example description</p>', $dataset->getDescription());
         $this->assertEquals('CC BY 4.0', $dataset->getLicense());
         $this->assertEquals('Other', $dataset->getSubject());
         $this->assertEquals(['test'], $dataset->getKeywords());
-        $this->assertEquals('Test, Author', $dataset->getAuthors()[0]->getName());
-        $this->assertEquals('Dataverse', $dataset->getAuthors()[0]->getAffiliation());
-        $this->assertEquals('0000-0000-0000-0000', $dataset->getAuthors()[0]->getIdentifier());
-        $this->assertEquals('ORCID', $dataset->getAuthors()[0]->getIdentifierScheme());
-        $this->assertEquals('Test, Contact', $dataset->getContact()->getName());
-        $this->assertEquals('test@example.com', $dataset->getContact()->getEmail());
-        $this->assertEquals('Dataverse', $dataset->getContact()->getAffiliation());
-        $this->assertEquals('Related publication', $dataset->getPubCitation());
+        $this->assertEquals($expectedDatasetAuthor, $dataset->getAuthors()[0]);
+        $this->assertEquals($expectedDatasetContact, $dataset->getContact());
+        $this->assertEquals($expectedDatasetRelatedPublication, $dataset->getRelatedPublication());
         $this->assertEquals('Test, Depositor', $dataset->getDepositor());
         $this->assertEquals('RELEASED', $dataset->getVersionState());
 
diff --git a/tests/factories/SubmissionDatasetFactoryTest.php b/tests/factories/SubmissionDatasetFactoryTest.php
diff --git a/tests/fixtures/datasetVersionsResponseExample.json b/tests/fixtures/datasetVersionsResponseExample.json
diff --git a/version.xml b/version.xml

Original file line number	Diff line number	Diff line change
`@@ -95,14 +95,14 @@ public function setKeywords(array $keywords): void`
`95`	`95`	`$this->setData('keywords', $keywords);`
`96`	`96`	`}`
`97`	`97`
`98`		`- public function getPubCitation(): ?string`
	`98`	`+ public function getRelatedPublication(): ?DatasetRelatedPublication`
`99`	`99`	`{`
`100`		`- return $this->getData('pubCitation');`
	`100`	`+ return $this->getData('relatedPublication');`
`101`	`101`	`}`
`102`	`102`
`103`		`- public function setPubCitation(string $pubCitation): void`
	`103`	`+ public function setRelatedPublication(DatasetRelatedPublication $relatedPublication): void`
`104`	`104`	`{`
`105`		`- $this->setData('pubCitation', $pubCitation);`
	`105`	`+ $this->setData('relatedPublication', $relatedPublication);`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`public function getFiles(): ?array`