Make Imperator spouses not nullable (#355)

* Make Imperator spouses not nullable

This means we no longer need to add null checks for them in converter logic.

see https://discord.com/channels/612683871112396800/612683871112396802/896687063087349771

* Spouse linking tests

Author: IhateTrains

ImperatorToCK3.UnitTests/Imperator/Characters/CharactersTests.cs

@@ -2,6 +2,8 @@
 using Xunit;
 
 namespace ImperatorToCK3.UnitTests.Imperator.Characters {
+	[Collection("Sequential")]
+	[CollectionDefinition("Sequential", DisableParallelization = true)]
 	public class CharactersTests {
 		private readonly ImperatorToCK3.Imperator.Genes.GenesDB genesDB = new();
 		[Fact]
@@ -14,8 +16,7 @@ public void CharactersDefaultToEmpty() {
 		[Fact]
 		public void CharactersCanBeLoaded() {
 			var reader = new BufferedReader(
-				"=\n" +
-				"{\n" +
+				"= {\n" +
 				"\t42={}\n" +
 				"\t43={}\n" +
 				"}"
@@ -33,5 +34,27 @@ public void CharactersCanBeLoaded() {
 				}
 			);
 		}
+		[Fact]
+		public void SpousesAreLinked() {
+			var reader = new BufferedReader(
+				"= {\n" +
+				"\t42={}\n" +
+				"\t43={ spouse = { 42 } }\n" +
+				"}"
+			);
+			var characters = new ImperatorToCK3.Imperator.Characters.Characters(reader, genesDB);
+			Assert.Equal((ulong)42, characters.StoredCharacters[43].Spouses[42].Id);
+		}
+
+		[Fact]
+		public void MissingSpousesAreDropped() {
+			var reader = new BufferedReader(
+				"= {\n" +
+				"\t43={ spouse = { 42 } }\n" + // character 42 is missing definition
+				"}"
+			);
+			var characters = new ImperatorToCK3.Imperator.Characters.Characters(reader, genesDB);
+			Assert.Empty(characters.StoredCharacters[43].Spouses);
+		}
 	}
 }

ImperatorToCK3.sln.DotSettings

@@ -1,4 +1,5 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=DB/@EntryIndexedValue">DB</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Antigonid/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=aquitane/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Biggus/@EntryIndexedValue">True</s:Boolean>

ImperatorToCK3/CK3/Characters/Character.cs

@@ -172,9 +172,7 @@ Date ck3BookmarkDate
 
 			if (provinceMapper.GetCK3ProvinceNumbers(impProvForProvinceMapper).Count == 0 && ImperatorCharacter.Spouses.Count > 0) {
 				var firstSpouse = ImperatorCharacter.Spouses.First().Value;
-				if (firstSpouse is not null) {
-					impProvForProvinceMapper = firstSpouse.ProvinceId;
-				}
+				impProvForProvinceMapper = firstSpouse.ProvinceId;
 			}
 
 			var ck3ProvinceNumbers = provinceMapper.GetCK3ProvinceNumbers(impProvForProvinceMapper);

ImperatorToCK3/CK3/World.cs

@@ -559,19 +559,20 @@ private void PurgeLandlessVanillaCharacters(Date ck3BookmarkDate) {
 		private void LinkSpouses() {
 			var spouseCounter = 0;
 			foreach (var ck3Character in Characters.Values) {
-				var newSpouses = new Dictionary<ulong, Character>();
 				// make links between Imperator characters
 				if (ck3Character.ImperatorCharacter is null) {
 					// imperatorRegnal characters do not have ImperatorCharacter
 					continue;
 				}
 				foreach (var impSpouseCharacter in ck3Character.ImperatorCharacter.Spouses.Values) {
-					if (impSpouseCharacter is not null) {
-						var ck3SpouseCharacter = impSpouseCharacter.CK3Character;
-						ck3Character.Spouses[ck3SpouseCharacter.ID] = ck3SpouseCharacter;
-						ck3SpouseCharacter.Spouses[ck3Character.ID] = ck3Character;
-						++spouseCounter;
+					var ck3SpouseCharacter = impSpouseCharacter.CK3Character;
+					if (ck3SpouseCharacter is null) {
+						Logger.Warn($"Imperator spouse {impSpouseCharacter.Id} has no CK3 character!");
+						continue;
 					}
+					ck3Character.Spouses[ck3SpouseCharacter.ID] = ck3SpouseCharacter;
+					ck3SpouseCharacter.Spouses[ck3Character.ID] = ck3Character;
+					++spouseCounter;
 				}
 			}
 			Logger.Info($"{spouseCounter} spouses linked in CK3.");

ImperatorToCK3/Imperator/Characters/Character.cs

@@ -1,6 +1,7 @@
-using System.Collections.Generic;
-using commonItems;
+using commonItems;
 using ImperatorToCK3.Imperator.Families;
+using System.Collections.Generic;
+using System.Linq;
 
 namespace ImperatorToCK3.Imperator.Characters {
 	public class Character {
@@ -33,7 +34,8 @@ public string Culture {
 		public Date? DeathDate { get; private set; }
 		public bool IsDead => DeathDate is not null;
 		public string? DeathReason { get; set; }
-		public Dictionary<ulong, Character?> Spouses { get; set; } = new();
+		private HashSet<ulong> parsedSpouseIds = new();
+		public Dictionary<ulong, Character> Spouses { get; set; } = new();
 		public Dictionary<ulong, Character?> Children { get; set; } = new();
 		public KeyValuePair<ulong, Character?> Mother { get; set; } = new();
 		public KeyValuePair<ulong, Character?> Father { get; set; } = new();
@@ -141,9 +143,7 @@ static Character() {
 				parsedCharacter.Wealth = ParserHelpers.GetDouble(reader);
 			});
 			parser.RegisterKeyword("spouse", reader => {
-				foreach (var spouse in ParserHelpers.GetULongs(reader)) {
-					parsedCharacter.Spouses.Add(spouse, null);
-				}
+				parsedCharacter.parsedSpouseIds = ParserHelpers.GetULongs(reader).ToHashSet();
 			});
 			parser.RegisterKeyword("children", reader => {
 				foreach (var child in ParserHelpers.GetULongs(reader)) {
@@ -170,5 +170,20 @@ public static Character Parse(BufferedReader reader, string idString, Genes.Gene
 
 			return parsedCharacter;
 		}
+
+		// Returns counter of linked spouses
+		public int LinkSpouses(Dictionary<ulong, Character> characters) {
+			var counter = 0;
+			foreach (var spouseId in parsedSpouseIds) {
+				if (characters.TryGetValue(spouseId, out var spouseToLink)) {
+					Spouses.Add(spouseToLink.Id, spouseToLink);
+					++counter;
+				} else {
+					Logger.Warn($"Spouse ID: {spouseId} has no definition!");
+				}
+			}
+
+			return counter;
+		}
 	}
 }

ImperatorToCK3/Imperator/Characters/Characters.cs

@@ -1,6 +1,7 @@
-using System.Collections.Generic;
+using commonItems;
+using System.Collections.Generic;
+using System.Linq;
 using System.Text;
-using commonItems;
 
 namespace ImperatorToCK3.Imperator.Characters {
 	public class Characters : Parser {
@@ -10,6 +11,11 @@ public Characters(BufferedReader reader, Genes.GenesDB? genesDB) {
 			RegisterKeys();
 			ParseStream(reader);
 			ClearRegisteredRules();
+
+			Logger.Info("Linking Characters with Spouses...");
+			LinkSpouses();
+			Logger.Info("Linking Characters with Mothers and Fathers...");
+			LinkMothersAndFathers();
 		}
 		public Dictionary<ulong, Character> StoredCharacters { get; } = new();
 		public void LinkFamilies(Families.Families families) {
@@ -44,26 +50,12 @@ public void LinkFamilies(Families.Families families) {
 
 			Logger.Info($"{counter} families linked to characters.");
 		}
-		public void LinkSpouses() {
-			var spouseCounter = 0;
-			foreach (var (characterID, character) in StoredCharacters) {
-				if (character.Spouses.Count == 0) {
-					continue;
-				}
-				var newSpouses = new Dictionary<ulong, Character?>();
-				foreach (var spouseID in character.Spouses.Keys) {
-					if (StoredCharacters.TryGetValue(spouseID, out var spouseToLink)) {
-						newSpouses.Add(spouseToLink.Id, spouseToLink);
-						++spouseCounter;
-					} else {
-						Logger.Warn($"Spouse ID: {spouseID} has no definition!");
-					}
-				}
-				character.Spouses = newSpouses;
-			}
+		private void LinkSpouses() {
+			var spouseCounter = StoredCharacters.Values.Sum(character => character.LinkSpouses(StoredCharacters));
 			Logger.Info($"{spouseCounter} spouses linked.");
 		}
-		public void LinkMothersAndFathers() {
+
+		private void LinkMothersAndFathers() {
 			var motherCounter = 0;
 			var fatherCounter = 0;
 			foreach (var (characterID, character) in StoredCharacters) {

ImperatorToCK3/Imperator/World.cs

@@ -143,10 +143,6 @@ public World(Configuration configuration, ConverterVersion converterVersion) {
 			Logger.Info("Linking Characters with Families");
 			Characters.LinkFamilies(Families);
 			Families.RemoveUnlinkedMembers();
-			Logger.Info("Linking Characters with Spouses");
-			Characters.LinkSpouses();
-			Logger.Info("Linking Characters with Mothers and Fathers");
-			Characters.LinkMothersAndFathers();
 			Logger.Info("Linking Characters with Countries");
 			Characters.LinkCountries(Countries);
 			Logger.Info("Linking Provinces with Pops");