Refactor HistoricEventsInterface to allow testing

fisharebest · Oct 23, 2024 · 3ee4c7e · 3ee4c7e
1 parent d7c2f5c
commit 3ee4c7e
Show file tree

Hide file tree

Showing 26 changed files with 190 additions and 52 deletions.
diff --git a/app/Module/AustrianHistoricEvents.php b/app/Module/AustrianHistoricEvents.php
@@ -19,7 +19,6 @@
 
 namespace Fisharebest\Webtrees\Module;
 
-use Fisharebest\Webtrees\I18N;
 use Illuminate\Support\Collection;
 
 /**
@@ -52,9 +51,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'de':
                 return new Collection([
                     "1 EVEN Feldzug Karls des Großen gegen die Awaren\n2 DATE 791\n2 TYPE Österreichische Geschichte\n2 SOUR [Wikipedia:Geschichte Österreichs](https://de.wikipedia.org/wiki/Geschichte_%C3%96sterreichs#Fr%C3%BChmittelalter_(bis_976))\n3 CONT Im Jahr 791 führte Karl der Große einen ersten misslungenen Feldzug gegen die Awaren, konnte sie aber dennoch bis zum Wienerwald zurückdrängen und fränkische Stützpunkte in Comagena (Tulln) und Aelium Cetium (St. Pölten) errichten.",

diff --git a/app/Module/AustrianPresidents.php b/app/Module/AustrianPresidents.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'de':
                 return new Collection([
                     "1 EVEN Karl Seitz\n2 TYPE Präsident des Staatsdirektoriums\n2 DATE FROM 30 OCT 1918 TO 09 DEC 1920",

diff --git a/app/Module/BritishMonarchs.php b/app/Module/BritishMonarchs.php
@@ -19,7 +19,6 @@
 
 namespace Fisharebest\Webtrees\Module;
 
-use Fisharebest\Webtrees\I18N;
 use Illuminate\Support\Collection;
 
 /**
@@ -52,9 +51,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'en-AU':
             case 'en-GB':
             case 'en-US':

diff --git a/app/Module/BritishPrimeMinisters.php b/app/Module/BritishPrimeMinisters.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'en-AU':
             case 'en-GB':
             case 'en-US':

diff --git a/app/Module/BritishSocialHistory.php b/app/Module/BritishSocialHistory.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'en-AU':
             case 'en-GB':
             case 'en-US':

diff --git a/app/Module/CzechMonarchsAndPresidents.php b/app/Module/CzechMonarchsAndPresidents.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'cs':
                 return new Collection([
                     /** @link https://cs.wikipedia.org/wiki/Seznam_představitelů_českého_státu */

diff --git a/app/Module/DutchMonarchs.php b/app/Module/DutchMonarchs.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'nl':
                 return new Collection([
                     "1 EVEN Lodewijk I, de Lamme Koning (Lodewijk Napoleon Bonaparte)\n2 TYPE Koning van Holland\n2 DATE FROM 05 JUN 1806 TO 01 JUL 1810\n2 NOTE Koninkrijk Holland (1806 - 1810), vazalstaat van het Eerste Franse Keizerrijk",

diff --git a/app/Module/DutchPrimeMinisters.php b/app/Module/DutchPrimeMinisters.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'nl':
                 return new Collection([
                     "1 EVEN Gerrit graaf Schimmelpenninck\n2 TYPE Voorzitter van de ministerraad\n2 DATE FROM 25 MAR 1848 TO 21 NOV 1848\n2 NOTE kabinet-Schimmelpenninck",

diff --git a/app/Module/FrenchHistory.php b/app/Module/FrenchHistory.php
@@ -54,9 +54,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'fr':
             case 'fr-CA':
                 return new Collection([

diff --git a/app/Module/LowCountriesRulers.php b/app/Module/LowCountriesRulers.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'nl':
                 return new Collection([
                     "1 EVEN Koningen, graven en potestaten van Friesland\n2 TYPE vorstendom, graafschap, potestaat\n2 DATE FROM 600 TO 1515",
@@ -104,7 +104,7 @@ public function historicEventsAll(): Collection
                     "1 EVEN Koningen der Nederlanden\n2 TYPE koninkrijk\n2 DATE FROM 1831",
                     "1 EVEN Staten-Generaal van het Koninkrijk der Nederlanden\n2 TYPE koninkrijk\n2 DATE FROM 1848",
                     "1 EVEN Raad van State\n2 TYPE koninkrijk\n2 DATE FROM 1889 TO 1890",
-                    "1 EVEN Koningin-regentes van Nederland\n2 TYPE koninkrijk\\n2 DATE FROM 1890 TO 1898",
+                    "1 EVEN Koningin-regentes van Nederland\n2 TYPE koninkrijk\n2 DATE FROM 1890 TO 1898",
                     "1 EVEN Prins-regent van België\n2 TYPE koninkrijk\n2 DATE FROM 1944 TO 1950",
                 ]);
 

diff --git a/app/Module/ModuleHistoricEventsInterface.php b/app/Module/ModuleHistoricEventsInterface.php
@@ -31,7 +31,7 @@ interface ModuleHistoricEventsInterface extends ModuleInterface
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection;
+    public function historicEventsAll(string $language_tag): Collection;
 
     /**
      * @return Collection<int,Fact>

diff --git a/app/Module/ModuleHistoricEventsTrait.php b/app/Module/ModuleHistoricEventsTrait.php
@@ -35,7 +35,7 @@ public function description(): string
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
         return new Collection();
     }
@@ -48,7 +48,7 @@ public function historicEventsForIndividual(Individual $individual): Collection
         $min_date = $individual->getEstimatedBirthDate();
         $max_date = $individual->getEstimatedDeathDate();
 
-        return $this->historicEventsAll()
+        return $this->historicEventsAll(I18N::languageTag())
             ->map(static fn (string $gedcom): Fact => new Fact($gedcom, $individual, 'histo'))
             ->filter(static fn (Fact $fact): bool => Date::compare($fact->date(), $min_date) >= 0)
             ->filter(static fn (Fact $fact): bool => Date::compare($fact->date(), $max_date) <= 0);

diff --git a/app/Module/NewZealandPrimeMinisters.php b/app/Module/NewZealandPrimeMinisters.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'en-AU':
             case 'en-GB':
             case 'en-US':

diff --git a/app/Module/USPresidents.php b/app/Module/USPresidents.php
@@ -52,9 +52,9 @@ public function isEnabledByDefault(): bool
     /**
      * @return Collection<int,string>
      */
-    public function historicEventsAll(): Collection
+    public function historicEventsAll(string $language_tag): Collection
     {
-        switch (I18N::languageTag()) {
+        switch ($language_tag) {
             case 'en-AU':
             case 'en-GB':
             case 'en-US':

diff --git a/tests/app/Module/AustrianHistoricEventsTest.php b/tests/app/Module/AustrianHistoricEventsTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(AustrianHistoricEvents::class)]
 class AustrianHistoricEventsTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(AustrianHistoricEvents::class));
+        $module = new AustrianHistoricEvents();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'de') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }
diff --git a/tests/app/Module/AustrianPresidentsTest.php b/tests/app/Module/AustrianPresidentsTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(AustrianPresidents::class)]
 class AustrianPresidentsTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(AustrianPresidents::class));
+        $module = new AustrianPresidents();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'de') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }
diff --git a/tests/app/Module/BritishMonarchsTest.php b/tests/app/Module/BritishMonarchsTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(BritishMonarchs::class)]
 class BritishMonarchsTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(BritishMonarchs::class));
+        $module = new BritishMonarchs();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'en-GB') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }
diff --git a/tests/app/Module/BritishPrimeMinistersTest.php b/tests/app/Module/BritishPrimeMinistersTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(BritishPrimeMinisters::class)]
 class BritishPrimeMinistersTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(BritishPrimeMinisters::class));
+        $module = new BritishPrimeMinisters();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'en-GB') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }
diff --git a/tests/app/Module/BritishSocialHistoryTest.php b/tests/app/Module/BritishSocialHistoryTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(BritishSocialHistory::class)]
 class BritishSocialHistoryTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(BritishSocialHistory::class));
+        $module = new BritishSocialHistory();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'en-GB') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }
diff --git a/tests/app/Module/CzechMonarchsAndPresidentsTest.php b/tests/app/Module/CzechMonarchsAndPresidentsTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(CzechMonarchsAndPresidents::class)]
 class CzechMonarchsAndPresidentsTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(CzechMonarchsAndPresidents::class));
+        $module = new CzechMonarchsAndPresidents();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'cs') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }
diff --git a/tests/app/Module/DutchMonarchsTest.php b/tests/app/Module/DutchMonarchsTest.php
@@ -19,14 +19,23 @@
 
 namespace Fisharebest\Webtrees\Module;
 
+use Fisharebest\Webtrees\Fact;
+use Fisharebest\Webtrees\Individual;
 use Fisharebest\Webtrees\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(DutchMonarchs::class)]
 class DutchMonarchsTest extends TestCase
 {
-    public function testClass(): void
+    public function testEventsHaveValidDate(): void
     {
-        self::assertTrue(class_exists(DutchMonarchs::class));
+        $module = new DutchMonarchs();
+
+        $individual = $this->createMock(Individual::class);
+
+        foreach ($module->historicEventsAll(language_tag: 'nl') as $gedcom) {
+            $fact = new Fact(gedcom: $gedcom, parent: $individual, id: 'test');
+            self::assertTrue(condition: $fact->date()->isOK(), message: 'No date found in: ' . $gedcom);
+        }
     }
 }