Merge branch 'doiRelatedPublication340-771' into 'main'

JhonathanLepidus · JhonathanLepidus · commit 906f46893b81 · 2025-04-17T16:01:06.000Z
Atualização do campo Publicação Relacionada - 3.4.0

See merge request softwares-pkp/plugins_ojs/dataverse!193
diff --git a/classes/APACitation.php b/classes/APACitation.php
@@ -30,16 +30,11 @@ public function getFormattedCitationBySubmission(Submission $submission, ?Public
         $context = Application::getContextDAO()->getById($submission->getData('contextId'));
         $authors =  $publication->getData('authors')->toArray();
         $submittedDate = new DateTime($submission->getData('dateSubmitted'));
-        $doiObject = $publication->getData('doiObject');
 
         $submissionCitation = $this->createAuthorsCitationAPA($authors) . ' ';
         $submissionCitation .= '(' . date_format($submittedDate, 'Y') . '). ';
         $submissionCitation .= '<em>' . $publication->getLocalizedTitle($this->locale) . '</em>. ';
         $submissionCitation .= $context->getLocalizedName();
-        if ($doiObject) {
-            $doiUrl = $doiObject->getResolvingUrl();
-            $submissionCitation .= ". <a href=\"$doiUrl\">$doiUrl</a>";
-        }
 
         return $submissionCitation;
     }
diff --git a/classes/dispatchers/DataverseEventsDispatcher.php b/classes/dispatchers/DataverseEventsDispatcher.php
@@ -12,12 +12,12 @@
 use APP\plugins\generic\dataverse\api\v1\datasets\DatasetHandler;
 use APP\plugins\generic\dataverse\api\v1\dataverse\DataverseHandler;
 use APP\plugins\generic\dataverse\api\v1\draftDatasetFiles\DraftDatasetFileHandler;
-use APP\plugins\generic\dataverse\classes\APACitation;
 use APP\plugins\generic\dataverse\classes\components\forms\SelectDataFilesForReviewForm;
 use APP\plugins\generic\dataverse\classes\dataverseConfiguration\DataverseConfiguration;
 use APP\plugins\generic\dataverse\classes\dispatchers\DataverseDispatcher;
 use APP\plugins\generic\dataverse\classes\exception\DataverseException;
 use APP\plugins\generic\dataverse\classes\facades\Repo;
+use APP\plugins\generic\dataverse\classes\factories\SubmissionDatasetFactory;
 use APP\plugins\generic\dataverse\classes\observers\listeners\DatasetDepositOnSubmission;
 use APP\plugins\generic\dataverse\classes\observers\listeners\ProcessDataverseDecisionsActions;
 use APP\plugins\generic\dataverse\classes\services\DatasetService;
@@ -328,9 +328,9 @@ public function updateDatasetOnPublicationUpdate(string $hookName, array $params
             return false;
         }
 
-        $apaCitation = new APACitation();
+        $datasetFactory = new SubmissionDatasetFactory($submission);
         $data['persistentId'] = $study->getPersistentId();
-        $data['pubCitation'] = $apaCitation->getFormattedCitationBySubmission($submission, $publication);
+        $data['relatedPublication'] = $datasetFactory->getDatasetRelatedPublication($publication);
 
         $datasetService = new DatasetService();
         $datasetService->update($data);
diff --git a/classes/entities/Dataset.php b/classes/entities/Dataset.php
@@ -99,14 +99,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.php b/classes/entities/DatasetRelatedPublication.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace APP\plugins\generic\dataverse\classes\entities;
+
+use PKP\core\DataObject;
+
+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.php b/classes/factories/JsonDatasetFactory.php
@@ -6,6 +6,7 @@
 use APP\plugins\generic\dataverse\classes\entities\DatasetAuthor;
 use APP\plugins\generic\dataverse\classes\entities\DatasetContact;
 use APP\plugins\generic\dataverse\classes\entities\DatasetFile;
+use APP\plugins\generic\dataverse\classes\entities\DatasetRelatedPublication;
 use stdClass;
 
 class JsonDatasetFactory extends DatasetFactory
@@ -94,7 +95,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.php b/classes/factories/SubmissionDatasetFactory.php
@@ -13,6 +13,7 @@
 use APP\plugins\generic\dataverse\classes\entities\DatasetAuthor;
 use APP\plugins\generic\dataverse\classes\entities\DatasetContact;
 use APP\plugins\generic\dataverse\classes\entities\DatasetFile;
+use APP\plugins\generic\dataverse\classes\entities\DatasetRelatedPublication;
 use APP\plugins\generic\dataverse\classes\draftDatasetFile\DraftDatasetFile;
 use APP\plugins\generic\dataverse\classes\APACitation;
 use APP\plugins\generic\dataverse\classes\facades\Repo;
@@ -48,7 +49,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;
@@ -98,10 +99,22 @@ private function getDatasetDepositor(): string
         return $userName . ' (via ' . $contextName . ')';
     }
 
-    private function getDatasetPubCitation(): string
+    public function getDatasetRelatedPublication($publication): DatasetRelatedPublication
     {
         $apaCitation = new APACitation();
-        return $apaCitation->getFormattedCitationBySubmission($this->submission);
+        $submissionCitation = $apaCitation->getFormattedCitationBySubmission($this->submission, $publication);
+        $doiObject = $publication->getData('doiObject');
+
+        if (empty($doiObject)) {
+            return new DatasetRelatedPublication($submissionCitation, null, null, null);
+        }
+
+        return new DatasetRelatedPublication(
+            $submissionCitation,
+            'doi',
+            $doiObject->getDoi(),
+            $doiObject->getResolvingUrl()
+        );
     }
 
     private function getDatasetFiles(): array
diff --git a/dataverseAPI/packagers/NativeAPIDatasetPackager.php b/dataverseAPI/packagers/NativeAPIDatasetPackager.php
@@ -115,7 +115,7 @@ public function getMetadataField(string $metadata): array
                 'multiple' => false,
                 'typeClass' => 'primitive'
             ],
-            'pubCitation' => [
+            'relatedPublication' => [
                 'typeName' => 'publication',
                 'multiple' => true,
                 'typeClass' => 'compound'
@@ -144,14 +144,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
@@ -120,8 +120,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);
@@ -138,8 +137,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);
     }
@@ -153,8 +151,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);
     }
@@ -168,8 +165,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);
     }
@@ -183,8 +179,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);
     }
@@ -197,8 +192,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
@@ -6,6 +6,7 @@
 use APP\plugins\generic\dataverse\classes\entities\Dataset;
 use APP\plugins\generic\dataverse\classes\entities\DatasetContact;
 use APP\plugins\generic\dataverse\classes\entities\DatasetFile;
+use APP\plugins\generic\dataverse\classes\entities\DatasetRelatedPublication;
 
 class NativeAPIDatasetPackagerTest extends PKPTestCase
 {
@@ -68,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,30 +1,37 @@
 <?php
 
 use PKP\tests\PKPTestCase;
+use APP\plugins\generic\dataverse\classes\entities\DatasetAuthor;
+use APP\plugins\generic\dataverse\classes\entities\DatasetContact;
+use APP\plugins\generic\dataverse\classes\entities\DatasetRelatedPublication;
 use APP\plugins\generic\dataverse\classes\factories\JsonDatasetFactory;
 
 class JsonDatasetFactoryTest extends PKPTestCase
 {
-    public function testCreateDataset()
+    public function testCreatesDatasetFromJsonResponse()
     {
         $jsonContent = file_get_contents(__DIR__ . '/../fixtures/datasetVersionsResponseExample.json');
         $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
`@@ -99,14 +99,14 @@ public function setKeywords(array $keywords): void`
`99`	`99`	`$this->setData('keywords', $keywords);`
`100`	`100`	`}`
`101`	`101`
`102`		`- public function getPubCitation(): ?string`
	`102`	`+ public function getRelatedPublication(): ?DatasetRelatedPublication`
`103`	`103`	`{`
`104`		`- return $this->getData('pubCitation');`
	`104`	`+ return $this->getData('relatedPublication');`
`105`	`105`	`}`
`106`	`106`
`107`		`- public function setPubCitation(string $pubCitation): void`
	`107`	`+ public function setRelatedPublication(DatasetRelatedPublication $relatedPublication): void`
`108`	`108`	`{`
`109`		`- $this->setData('pubCitation', $pubCitation);`
	`109`	`+ $this->setData('relatedPublication', $relatedPublication);`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`public function getFiles(): ?array`