improve handling of legacy non-semantic game versions (#333)

6 files changed, 113 insertions, 33 deletions

diff --git a/src/StardewModdingAPI.Tests/Utilities/SemanticVersionTests.cs b/src/StardewModdingAPI.Tests/Utilities/SemanticVersionTests.cs
index 95d0d74f..db46aee4 100644
--- a/src/StardewModdingAPI.Tests/Utilities/SemanticVersionTests.cs
+++ b/src/StardewModdingAPI.Tests/Utilities/SemanticVersionTests.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Diagnostics.CodeAnalysis;
 using NUnit.Framework;
+using StardewModdingAPI.Framework;
 
 namespace StardewModdingAPI.Tests.Utilities
 {
@@ -206,6 +207,35 @@ namespace StardewModdingAPI.Tests.Utilities
             return version.IsBetween(lower, upper);
         }
 
+        /****
+        ** GameVersion
+        ****/
+        [Test(Description = "Assert that the GameVersion subclass correctly parses legacy game versions.")]
+        [TestCase("1.0")]
+        [TestCase("1.01")]
+        [TestCase("1.02")]
+        [TestCase("1.03")]
+        [TestCase("1.04")]
+        [TestCase("1.05")]
+        [TestCase("1.051")]
+        [TestCase("1.051b")]
+        [TestCase("1.06")]
+        [TestCase("1.07")]
+        [TestCase("1.07a")]
+        [TestCase("1.1")]
+        [TestCase("1.11")]
+        [TestCase("1.2")]
+        [TestCase("1.2.15")]
+        public void GameVersion(string versionStr)
+        {
+            // act
+            GameVersion version = new GameVersion(versionStr);
+
+            // assert
+            Assert.AreEqual(versionStr, version.ToString(), "The game version did not round-trip to the same value.");
+            Assert.IsTrue(version.IsOlderThan(new SemanticVersion("1.2.30")), "The game version should be considered older than the later semantic versions.");
+        }
+
 
         /*********
         ** Private methods
diff --git a/src/StardewModdingAPI/Constants.cs b/src/StardewModdingAPI/Constants.cs
index 8217a6a5..ee57be0f 100644
--- a/src/StardewModdingAPI/Constants.cs
+++ b/src/StardewModdingAPI/Constants.cs
@@ -9,6 +9,7 @@ using StardewModdingAPI.AssemblyRewriters.Finders;
 using StardewModdingAPI.AssemblyRewriters.Rewriters;
 using StardewModdingAPI.AssemblyRewriters.Rewriters.Wrappers;
 using StardewModdingAPI.Events;
+using StardewModdingAPI.Framework;
 using StardewValley;
 
 namespace StardewModdingAPI
@@ -86,7 +87,7 @@ namespace StardewModdingAPI
         internal static string ModPath { get; } = Path.Combine(Constants.ExecutionPath, "Mods");
 
         /// <summary>The game's current semantic version.</summary>
-        internal static ISemanticVersion GameVersion { get; } = Constants.GetGameVersion();
+        internal static ISemanticVersion GameVersion { get; } = new GameVersion(Constants.GetGameVersion());
 
         /// <summary>The target game platform.</summary>
         internal static Platform TargetPlatform { get; } =
@@ -219,19 +220,6 @@ namespace StardewModdingAPI
             };
         }
 
-        /// <summary>Get game current version as it should be displayed to players.</summary>
-        /// <param name="version">The semantic game version.</param>
-        internal static ISemanticVersion GetGameDisplayVersion(ISemanticVersion version)
-        {
-            switch (version.ToString())
-            {
-                case "1.1.1":
-                    return new SemanticVersion(1, 11, 0); // The 1.1 patch was released as 1.11
-                default:
-                    return version;
-            }
-        }
-
         /// <summary>Get the name of a save directory for the current player.</summary>
         private static string GetSaveFolderName()
         {
@@ -239,20 +227,14 @@ namespace StardewModdingAPI
             return $"{prefix}_{Game1.uniqueIDForThisGame}";
         }
 
-        /// <summary>Get the game's current semantic version.</summary>
-        private static ISemanticVersion GetGameVersion()
+        /// <summary>Get the game's current version string.</summary>
+        private static string GetGameVersion()
         {
-            // get raw version
             // we need reflection because it's a constant, so SMAPI's references to it are inlined at compile-time
             FieldInfo field = typeof(Game1).GetField(nameof(Game1.version), BindingFlags.Public | BindingFlags.Static);
             if (field == null)
                 throw new InvalidOperationException($"The {nameof(Game1)}.{nameof(Game1.version)} field could not be found.");
-            string version = (string)field.GetValue(null);
-
-            // get semantic version
-            if (version == "1.11")
-                version = "1.1.1"; // The 1.1 patch was released as 1.11, which means it's out of order for semantic version checks
-            return new SemanticVersion(version);
+            return (string)field.GetValue(null);
         }
     }
 }
diff --git a/src/StardewModdingAPI/Framework/GameVersion.cs b/src/StardewModdingAPI/Framework/GameVersion.cs
new file mode 100644
index 00000000..48159f61
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/GameVersion.cs
@@ -0,0 +1,68 @@
+using System;
+using System.Collections.Generic;
+
+namespace StardewModdingAPI.Framework
+{
+    /// <summary>An implementation of <see cref="ISemanticVersion"/> that correctly handles the non-semantic versions used by older Stardew Valley releases.</summary>
+    internal class GameVersion : SemanticVersion
+    {
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>A mapping of game to semantic versions.</summary>
+        private static readonly IDictionary<string, string> VersionMap = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase)
+        {
+            ["1.01"] = "1.0.1",
+            ["1.02"] = "1.0.2",
+            ["1.03"] = "1.0.3",
+            ["1.04"] = "1.0.4",
+            ["1.05"] = "1.0.5",
+            ["1.051"] = "1.0.6-prerelease1", // not a very good mapping, but good enough for SMAPI's purposes.
+            ["1.051b"] = "1.0.6-prelease2",
+            ["1.06"] = "1.0.6",
+            ["1.07"] = "1.0.7",
+            ["1.07a"] = "1.0.8-prerelease1",
+            ["1.11"] = "1.1.1"
+        };
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="version">The game version string.</param>
+        public GameVersion(string version)
+            : base(GameVersion.GetSemanticVersionString(version)) { }
+
+        /// <summary>Get a string representation of the version.</summary>
+        public override string ToString()
+        {
+            return GameVersion.GetGameVersionString(base.ToString());
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Convert a game version string to a semantic version string.</summary>
+        /// <param name="gameVersion">The game version string.</param>
+        private static string GetSemanticVersionString(string gameVersion)
+        {
+            return GameVersion.VersionMap.TryGetValue(gameVersion, out string semanticVersion)
+                ? semanticVersion
+                : gameVersion;
+        }
+
+        /// <summary>Convert a game version string to a semantic version string.</summary>
+        /// <param name="gameVersion">The game version string.</param>
+        private static string GetGameVersionString(string gameVersion)
+        {
+            foreach (var mapping in GameVersion.VersionMap)
+            {
+                if (mapping.Value.Equals(gameVersion, StringComparison.InvariantCultureIgnoreCase))
+                    return mapping.Key;
+            }
+            return gameVersion;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI/Program.cs b/src/StardewModdingAPI/Program.cs
index 75bb991d..ff73962e 100644
--- a/src/StardewModdingAPI/Program.cs
+++ b/src/StardewModdingAPI/Program.cs
@@ -125,7 +125,7 @@ namespace StardewModdingAPI
             try
             {
                 // init logging
-                this.Monitor.Log($"SMAPI {Constants.ApiVersion} with Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)} on {this.GetFriendlyPlatformName()}", LogLevel.Info);
+                this.Monitor.Log($"SMAPI {Constants.ApiVersion} with Stardew Valley {Constants.GameVersion} on {this.GetFriendlyPlatformName()}", LogLevel.Info);
                 this.Monitor.Log($"Mods go here: {Constants.ModPath}");
 #if SMAPI_1_x
                 this.Monitor.Log("Preparing SMAPI...");
@@ -138,13 +138,13 @@ namespace StardewModdingAPI
                 // validate game version
                 if (Constants.GameVersion.IsOlderThan(Constants.MinimumGameVersion))
                 {
-                    this.Monitor.Log($"Oops! You're running Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)}, but the oldest supported version is {Constants.GetGameDisplayVersion(Constants.MinimumGameVersion)}. Please update your game before using SMAPI. If you have the beta version on Steam, you may need to opt out to get the latest non-beta updates.", LogLevel.Error);
+                    this.Monitor.Log($"Oops! You're running Stardew Valley {Constants.GameVersion}, but the oldest supported version is {Constants.MinimumGameVersion}. Please update your game before using SMAPI. If you have the beta version on Steam, you may need to opt out to get the latest non-beta updates.", LogLevel.Error);
                     this.PressAnyKeyToExit();
                     return;
                 }
                 if (Constants.MaximumGameVersion != null && Constants.GameVersion.IsNewerThan(Constants.MaximumGameVersion))
                 {
-                    this.Monitor.Log($"Oops! You're running Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)}, but this version of SMAPI is only compatible up to Stardew Valley {Constants.GetGameDisplayVersion(Constants.MaximumGameVersion)}. Please check for a newer version of SMAPI.", LogLevel.Error);
+                    this.Monitor.Log($"Oops! You're running Stardew Valley {Constants.GameVersion}, but this version of SMAPI is only compatible up to Stardew Valley {Constants.MaximumGameVersion}. Please check for a newer version of SMAPI.", LogLevel.Error);
                     this.PressAnyKeyToExit();
                     return;
                 }
@@ -191,8 +191,8 @@ namespace StardewModdingAPI
                 ContentEvents.AfterLocaleChanged += (sender, e) => this.OnLocaleChanged();
 
                 // set window titles
-                this.GameInstance.Window.Title = $"Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)} - running SMAPI {Constants.ApiVersion}";
-                Console.Title = $"SMAPI {Constants.ApiVersion} - running Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)}";
+                this.GameInstance.Window.Title = $"Stardew Valley {Constants.GameVersion} - running SMAPI {Constants.ApiVersion}";
+                Console.Title = $"SMAPI {Constants.ApiVersion} - running Stardew Valley {Constants.GameVersion}";
             }
             catch (Exception ex)
             {
@@ -315,7 +315,7 @@ namespace StardewModdingAPI
             if (Type.GetType($"StardewValley.LocalizedContentManager+LanguageCode, {gameAssemblyName}", throwOnError: false) == null)
             {
                 PrintErrorAndExit(Constants.GameVersion.IsOlderThan(Constants.MinimumGameVersion)
-                    ? $"Oops! You're running Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)}, but the oldest supported version is {Constants.GetGameDisplayVersion(Constants.MinimumGameVersion)}. Please update your game before using SMAPI."
+                    ? $"Oops! You're running Stardew Valley {Constants.GameVersion}, but the oldest supported version is {Constants.MinimumGameVersion}. Please update your game before using SMAPI."
                     : "Oops! SMAPI doesn't seem to be compatible with your game. Make sure you're running the latest version of Stardew Valley and SMAPI."
                 );
             }
@@ -445,8 +445,8 @@ namespace StardewModdingAPI
 
             // update window titles
             int modsLoaded = this.ModRegistry.GetMods().Count();
-            this.GameInstance.Window.Title = $"Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)} - running SMAPI {Constants.ApiVersion} with {modsLoaded} mods";
-            Console.Title = $"SMAPI {Constants.ApiVersion} - running Stardew Valley {Constants.GetGameDisplayVersion(Constants.GameVersion)} with {modsLoaded} mods";
+            this.GameInstance.Window.Title = $"Stardew Valley {Constants.GameVersion} - running SMAPI {Constants.ApiVersion} with {modsLoaded} mods";
+            Console.Title = $"SMAPI {Constants.ApiVersion} - running Stardew Valley {Constants.GameVersion} with {modsLoaded} mods";
 
             // start SMAPI console
             new Thread(this.RunConsoleLoop).Start();
diff --git a/src/StardewModdingAPI/SemanticVersion.cs b/src/StardewModdingAPI/SemanticVersion.cs
index f30c43cd..782a962b 100644
--- a/src/StardewModdingAPI/SemanticVersion.cs
+++ b/src/StardewModdingAPI/SemanticVersion.cs
@@ -117,8 +117,7 @@ namespace StardewModdingAPI
                 {
                     // compare numerically if possible
                     {
-                        int curNum, otherNum;
-                        if (int.TryParse(curParts[i], out curNum) && int.TryParse(otherParts[i], out otherNum))
+                        if (int.TryParse(curParts[i], out int curNum) && int.TryParse(otherParts[i], out int otherNum))
                             return curNum.CompareTo(otherNum);
                     }
 
diff --git a/src/StardewModdingAPI/StardewModdingAPI.csproj b/src/StardewModdingAPI/StardewModdingAPI.csproj
index f7992122..4cef91d9 100644
--- a/src/StardewModdingAPI/StardewModdingAPI.csproj
+++ b/src/StardewModdingAPI/StardewModdingAPI.csproj
@@ -126,6 +126,7 @@
     <Compile Include="Events\GameEvents.cs" />
     <Compile Include="Events\GraphicsEvents.cs" />
     <Compile Include="Framework\Countdown.cs" />
+    <Compile Include="Framework\GameVersion.cs" />
     <Compile Include="Framework\IModMetadata.cs" />
     <Compile Include="Framework\Models\DisabledMod.cs" />
     <Compile Include="Framework\Models\ModCompatibilityID.cs" />