Merge branch 'addOJSVersionField-936' into 'main'

Adds OJS Version column. See merge request softwares-pkp/plugins_ojs/carinianaPreservation!11
lepidus · Feb 5, 2025 · e4d17b9 · e4d17b9
2 parents 9d3aea3 + fa046ae
commit e4d17b9
Show file tree

Hide file tree

Showing 14 changed files with 39 additions and 19 deletions.
diff --git a/CarinianaPreservationPlugin.inc.php b/CarinianaPreservationPlugin.inc.php
@@ -3,7 +3,7 @@
 /**
  * @file plugins/generic/carinianaPreservation/CarinianaPreservationPlugin.inc.php
  *
- * Copyright (c) 2023 Lepidus Tecnologia
+ * Copyright (c) 2023-2025 Lepidus Tecnologia
  * Distributed under the GNU GPL v3. For full terms see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt.
  *
  * @class CarinianaPreservationPlugin

diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ O plugin Preservação Cariniana tem o intuito de facilitar o processo de preser
 * Anos disponíveis
 * Volumes das edições
 * Notas e Comentários
+* Versão do OJS
 
 Além destas informações, também é enviado o Termo de Responsabilidade e Autorização para preservação na rede Cariniana, preenchido pelos responsáveis pelo periódico.
 
@@ -57,4 +58,4 @@ Caso algum dos dados necessários para a submissão não tenha sido preenchido n
 ## Licença
 __Esse plugin é licenciado através da Licença Pública Geral GNU v3.0__
 
-__Copyright (c) 2023 Lepidus Tecnologia__
+__Copyright (c) 2023-2025 Lepidus Tecnologia__
diff --git a/classes/PreservedJournal.inc.php b/classes/PreservedJournal.inc.php
@@ -11,6 +11,7 @@ class PreservedJournal
     private $availableYears;
     private $issuesVolumes;
     private $notesAndComments;
+    private $ojsVersion;
 
     public function __construct(
         string $publisherOrInstitution,
@@ -21,7 +22,8 @@ public function __construct(
         string $journalPath,
         string $availableYears,
         ?string $issuesVolumes,
-        string $notesAndComments
+        string $notesAndComments,
+        string $ojsVersion
     ) {
         $this->publisherOrInstitution = $publisherOrInstitution;
         $this->title = $title;
@@ -32,6 +34,7 @@ public function __construct(
         $this->availableYears = $availableYears;
         $this->issuesVolumes = $issuesVolumes;
         $this->notesAndComments = $notesAndComments;
+        $this->ojsVersion = $ojsVersion;
     }
 
     public function asRecord(): array
@@ -45,7 +48,8 @@ public function asRecord(): array
             $this->journalPath,
             $this->availableYears,
             $this->issuesVolumes,
-            $this->notesAndComments
+            $this->notesAndComments,
+            $this->ojsVersion
         ];
     }
 }
diff --git a/classes/PreservedJournalFactory.inc.php b/classes/PreservedJournalFactory.inc.php
@@ -13,6 +13,8 @@ public function buildPreservedJournal($journal, $baseUrl, $notesAndComments, $lo
         $journalPath = $journal->getData('urlPath');
         $availableYears = $this->getAvailableYears($journal);
         $issuesVolumes = $this->getIssuesVolumes($journal);
+        $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
+        $ojsVersion = $versionDao->getCurrentVersion();
 
         return new PreservedJournal(
             $publisherOrInstitution,
@@ -23,7 +25,8 @@ public function buildPreservedJournal($journal, $baseUrl, $notesAndComments, $lo
             $journalPath,
             $availableYears,
             $issuesVolumes,
-            $notesAndComments
+            $notesAndComments,
+            $ojsVersion->getVersionString()
         );
     }
 

diff --git a/classes/PreservedJournalSpreadsheet.inc.php b/classes/PreservedJournalSpreadsheet.inc.php
@@ -25,7 +25,8 @@ private function getHeaders(): array
             __("plugins.generic.carinianaPreservation.headers.journalPath"),
             __("plugins.generic.carinianaPreservation.headers.availableYears"),
             __("plugins.generic.carinianaPreservation.headers.issuesVolumes"),
-            __("plugins.generic.carinianaPreservation.headers.notesAndComments")
+            __("plugins.generic.carinianaPreservation.headers.notesAndComments"),
+            __("admin.systemVersion")
         ];
     }
 

diff --git a/classes/form/CarinianaPreservationSettingsForm.inc.php b/classes/form/CarinianaPreservationSettingsForm.inc.php
@@ -3,7 +3,7 @@
 /**
  * @file CarinianaPreservationSettingsForm.inc.php
  *
- * Copyright (c) 2023 Lepidus Tecnologia
+ * Copyright (c) 2023-2025 Lepidus Tecnologia
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
  * @class CarinianaPreservationSettingsForm

diff --git a/classes/form/PreservationSubmissionForm.inc.php b/classes/form/PreservationSubmissionForm.inc.php
@@ -3,7 +3,7 @@
 /**
  * @file PreservationSubmissionForm.inc.php
  *
- * Copyright (c) 2023 Lepidus Tecnologia
+ * Copyright (c) 2023-2025 Lepidus Tecnologia
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
  * @class PreservationSubmissionForm

diff --git a/index.php b/index.php
@@ -7,7 +7,7 @@
 /**
  * @file plugins/generic/carinianaPreservation/index.php
  *
- * Copyright (c) 2023 Lepidus Tecnologia
+ * Copyright (c) 2023-2025 Lepidus Tecnologia
  * Distributed under the GNU GPL v3. For full terms see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt.
  *
  * @ingroup plugins_generic_carinianaPreservation

diff --git a/templates/preservationSubmission.tpl b/templates/preservationSubmission.tpl
@@ -1,7 +1,7 @@
 {**
  * templates/preservationSubmission.tpl
  *
- * Copyright (c) 2023 Lepidus Tecnologia
+ * Copyright (c) 2023-2025 Lepidus Tecnologia
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
  * Cariniana preservation submission form

diff --git a/templates/settingsForm.tpl b/templates/settingsForm.tpl
@@ -1,7 +1,7 @@
 {**
  * templates/settingsForm.tpl
  *
- * Copyright (c) 2023 Lepidus Tecnologia
+ * Copyright (c) 2023-2025 Lepidus Tecnologia
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
  * Cariniana Preservation plugin settings

diff --git a/tests/PreservedJournalFactoryTest.php b/tests/PreservedJournalFactoryTest.php
@@ -22,6 +22,7 @@ class PreservedJournalFactoryTest extends DatabaseTestCase
     private $firstIssueVolume = 1;
     private $secondIssueVolume = 2;
     private $notesAndComments = 'We are the 18th SciELO journal';
+    private $ojsVersion;
 
     public function setUp(): void
     {
@@ -30,6 +31,9 @@ public function setUp(): void
         $this->preservedJournalFactory = new PreservedJournalFactory();
         $this->createTestIssue($this->firstIssueYear, $this->firstIssueVolume);
         $this->createTestIssue($this->lastIssueYear, $this->secondIssueVolume);
+        $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
+        $currentVersion = $versionDao->getCurrentVersion();
+        $this->ojsVersion = $currentVersion->getVersionString();
     }
 
     protected function getAffectedTables()
@@ -75,7 +79,8 @@ public function testFactoryBuildsPreservedJournal(): void
             'scielojournal18',
             '2018; 2022',
             '1; 2',
-            'We are the 18th SciELO journal'
+            'We are the 18th SciELO journal',
+            $this->ojsVersion
         ];
         $this->assertEquals($expectedRecord, $preservedJournal->asRecord());
     }
@@ -93,7 +98,8 @@ public function testFactoryBuildsPreservedJournalWithEmptyNotesAndComments(): vo
             'scielojournal18',
             '2018; 2022',
             '1; 2',
-            ''
+            '',
+            $this->ojsVersion
         ];
         $this->assertEquals($expectedRecord, $preservedJournal->asRecord());
     }

diff --git a/tests/PreservedJournalSpreadsheetTest.php b/tests/PreservedJournalSpreadsheetTest.php
@@ -25,7 +25,8 @@ public function setUp(): void
                 'scielojournal18',
                 '2018; 2022',
                 '1; 2; 12; 18',
-                'We are the 18th SciELO journal'
+                'We are the 18th SciELO journal',
+                '3.3.0.20'
             )
         ];
 
@@ -61,6 +62,7 @@ public function testGeneratedSpreadsheetHasHeaders(): void
             __("plugins.generic.carinianaPreservation.headers.availableYears"),
             __("plugins.generic.carinianaPreservation.headers.issuesVolumes"),
             __("plugins.generic.carinianaPreservation.headers.notesAndComments"),
+            __("admin.systemVersion")
         ];
 
         $firstRow = $worksheet->toArray()[0];
@@ -73,7 +75,7 @@ public function testGeneratedSpreadsheetHasJournals(): void
         $this->spreadsheet->createSpreadsheet($this->filePath);
         $worksheet = $this->getWorksheet();
 
-        $expectedJournalData = ['SciELO', 'SciELO Journal n18', '1234-1234', '0101-1010', 'https://scielo-journal-18.com.br/', 'scielojournal18', '2018; 2022', '1; 2; 12; 18', 'We are the 18th SciELO journal'];
+        $expectedJournalData = ['SciELO', 'SciELO Journal n18', '1234-1234', '0101-1010', 'https://scielo-journal-18.com.br/', 'scielojournal18', '2018; 2022', '1; 2; 12; 18', 'We are the 18th SciELO journal', '3.3.0.20'];
         $secondRow = $worksheet->toArray()[1];
 
         $this->assertEquals($expectedJournalData, $secondRow);

diff --git a/tests/PreservedJournalTest.php b/tests/PreservedJournalTest.php
@@ -17,6 +17,7 @@ class PreservedJournalTest extends TestCase
     private $availableYears = '2018; 2022';
     private $notesAndComments = 'We are the 18th SciELO journal';
     private $issuesVolumes = '1; 2; 12; 18';
+    private $ojsVersion = '3.3.0.20';
 
     public function setUp(): void
     {
@@ -30,6 +31,7 @@ public function setUp(): void
             $this->availableYears,
             $this->issuesVolumes,
             $this->notesAndComments,
+            $this->ojsVersion,
         );
     }
 
@@ -44,7 +46,8 @@ public function testJournalRecord(): void
             'scielojournal18',
             '2018; 2022',
             '1; 2; 12; 18',
-            'We are the 18th SciELO journal'
+            'We are the 18th SciELO journal',
+            '3.3.0.20'
         ];
         $this->assertEquals($expectedRecord, $this->preservedJournal->asRecord());
     }

diff --git a/version.xml b/version.xml
@@ -3,7 +3,7 @@
 
 <!--
   *
-  * Copyright (c) 2023 Lepidus Tecnologia
+  * Copyright (c) 2023-2025 Lepidus Tecnologia
   * Distributed under the GNU GPL v3. For full terms see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt.
   *
   -->
@@ -12,7 +12,7 @@
 	<application>carinianaPreservation</application>
 	<type>plugins.generic</type>
 	<lazy-load>0</lazy-load>
-	<release>1.4.1.2</release>
-	<date>2024-11-13</date>
+	<release>1.4.1.3</release>
+	<date>2025-02-05</date>
   <class>CarinianaPreservationPlugin</class>
 </version>