summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web
diff options
context:
space:
mode:
authorJamie Taylor <Jamie.Taylor@pobox.com>2022-09-22 23:03:26 -0400
committerJamie Taylor <Jamie.Taylor@pobox.com>2022-10-01 21:18:50 -0400
commit6d4eed56b1d80d02db773b0cd2f372baec6b2d1b (patch)
tree3e596b6d35501f51cd557f44bdefe4170b8a17ec /src/SMAPI.Web
parentc0e31d17a6d3f235c8a251e851c446e00c804cdb (diff)
downloadSMAPI-6d4eed56b1d80d02db773b0cd2f372baec6b2d1b.tar.gz
SMAPI-6d4eed56b1d80d02db773b0cd2f372baec6b2d1b.tar.bz2
SMAPI-6d4eed56b1d80d02db773b0cd2f372baec6b2d1b.zip
refactor UpdateKey parsing, move responsibility for subkey matching
UpdateKey parsing now allows multiple : and @ inside the update key, splitting on the first occurence of each Subkey matching is moved into IModDownload / GenericModDownload, in preparation for some Mod Sites using something less error-prone than substring matching.
Diffstat (limited to 'src/SMAPI.Web')
-rw-r--r--src/SMAPI.Web/Framework/Clients/GenericModDownload.cs14
-rw-r--r--src/SMAPI.Web/Framework/IModDownload.cs5
-rw-r--r--src/SMAPI.Web/Framework/ModSiteManager.cs12
3 files changed, 25 insertions, 6 deletions
diff --git a/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs b/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
index 548f17c3..b37e5cda 100644
--- a/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
+++ b/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
@@ -1,3 +1,5 @@
+using System;
+
namespace StardewModdingAPI.Web.Framework.Clients
{
/// <summary>Generic metadata about a file download on a mod page.</summary>
@@ -29,5 +31,17 @@ namespace StardewModdingAPI.Web.Framework.Clients
this.Description = description;
this.Version = version;
}
+
+ /// <summary>
+ /// Return true if the subkey matches this download. A subkey matches if it appears as
+ /// a substring in the name or description.
+ /// </summary>
+ /// <param name="subkey">the subkey</param>
+ /// <returns><c>true</c> if <paramref name="subkey"/> matches this download, otherwise <c>false</c></returns>
+ /// <exception cref="System.NotImplementedException"></exception>
+ public bool MatchesSubkey(string subkey) {
+ return this.Name.Contains(subkey, StringComparison.OrdinalIgnoreCase) == true
+ || this.Description?.Contains(subkey, StringComparison.OrdinalIgnoreCase) == true;
+ }
}
}
diff --git a/src/SMAPI.Web/Framework/IModDownload.cs b/src/SMAPI.Web/Framework/IModDownload.cs
index fe171785..13739f8f 100644
--- a/src/SMAPI.Web/Framework/IModDownload.cs
+++ b/src/SMAPI.Web/Framework/IModDownload.cs
@@ -14,5 +14,10 @@ namespace StardewModdingAPI.Web.Framework
/// <summary>The download's file version.</summary>
string? Version { get; }
+
+ /// <summary>Return <c>true</c> iff the subkey matches this download</summary>
+ /// <param name="subkey">the subkey</param>
+ /// <returns><c>true</c> if <paramref name="subkey"/> matches this download, otherwise <c>false</c></returns>
+ bool MatchesSubkey(string subkey);
}
}
diff --git a/src/SMAPI.Web/Framework/ModSiteManager.cs b/src/SMAPI.Web/Framework/ModSiteManager.cs
index 674b9ffc..70070d63 100644
--- a/src/SMAPI.Web/Framework/ModSiteManager.cs
+++ b/src/SMAPI.Web/Framework/ModSiteManager.cs
@@ -119,7 +119,7 @@ namespace StardewModdingAPI.Web.Framework
preview = null;
// parse all versions from the mod page
- IEnumerable<(string? name, string? description, ISemanticVersion? version)> GetAllVersions()
+ IEnumerable<(IModDownload? download, ISemanticVersion? version)> GetAllVersions()
{
if (mod != null)
{
@@ -132,14 +132,14 @@ namespace StardewModdingAPI.Web.Framework
// get mod version
ISemanticVersion? modVersion = ParseAndMapVersion(mod.Version);
if (modVersion != null)
- yield return (name: null, description: null, version: ParseAndMapVersion(mod.Version));
+ yield return (download: null, version: ParseAndMapVersion(mod.Version));
// get file versions
foreach (IModDownload download in mod.Downloads)
{
ISemanticVersion? cur = ParseAndMapVersion(download.Version);
if (cur != null)
- yield return (download.Name, download.Description, cur);
+ yield return (download, cur);
}
}
}
@@ -148,13 +148,13 @@ namespace StardewModdingAPI.Web.Framework
.ToArray();
// get main + preview versions
- void TryGetVersions([NotNullWhen(true)] out ISemanticVersion? mainVersion, out ISemanticVersion? previewVersion, Func<(string? name, string? description, ISemanticVersion? version), bool>? filter = null)
+ void TryGetVersions([NotNullWhen(true)] out ISemanticVersion? mainVersion, out ISemanticVersion? previewVersion, Func<(IModDownload? download, ISemanticVersion? version), bool>? filter = null)
{
mainVersion = null;
previewVersion = null;
// get latest main + preview version
- foreach ((string? name, string? description, ISemanticVersion? version) entry in versions)
+ foreach ((IModDownload? download, ISemanticVersion? version) entry in versions)
{
if (entry.version is null || filter?.Invoke(entry) == false)
continue;
@@ -178,7 +178,7 @@ namespace StardewModdingAPI.Web.Framework
}
if (subkey is not null)
- TryGetVersions(out main, out preview, entry => entry.name?.Contains(subkey, StringComparison.OrdinalIgnoreCase) == true || entry.description?.Contains(subkey, StringComparison.OrdinalIgnoreCase) == true);
+ TryGetVersions(out main, out preview, entry => entry.download?.MatchesSubkey(subkey) == true);
if (main is null)
TryGetVersions(out main, out preview);