From 9b247b67f64af903fd610481e74dbe7175580b84 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 24 Sep 2017 13:19:02 -0400 Subject: improve version normalising (#336, #361) --- .../Framework/ModRepositories/BaseRepository.cs | 51 ++++++++++++++++++++++ .../ModRepositories/ChucklefishRepository.cs | 27 +++++------- .../Framework/ModRepositories/GitHubRepository.cs | 32 ++++---------- .../Framework/ModRepositories/NexusRepository.cs | 23 ++++------ 4 files changed, 77 insertions(+), 56 deletions(-) create mode 100644 src/StardewModdingAPI.Web/Framework/ModRepositories/BaseRepository.cs (limited to 'src/StardewModdingAPI.Web/Framework/ModRepositories') diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/BaseRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/BaseRepository.cs new file mode 100644 index 00000000..d98acd89 --- /dev/null +++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/BaseRepository.cs @@ -0,0 +1,51 @@ +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using StardewModdingAPI.Models; + +namespace StardewModdingAPI.Web.Framework.ModRepositories +{ + internal abstract class RepositoryBase : IModRepository + { + /********* + ** Accessors + *********/ + /// The unique key for this vendor. + public string VendorKey { get; } + + + /********* + ** Public methods + *********/ + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + public abstract void Dispose(); + + /// Get metadata about a mod in the repository. + /// The mod ID in this repository. + public abstract Task GetModInfoAsync(string id); + + + /********* + ** Protected methods + *********/ + /// Construct an instance. + /// The unique key for this vendor. + protected RepositoryBase(string vendorKey) + { + this.VendorKey = vendorKey; + } + + /// Normalise a version string. + /// The version to normalise. + protected string NormaliseVersion(string version) + { + if (string.IsNullOrWhiteSpace(version)) + return null; + + version = version.Trim(); + if (Regex.IsMatch(version, @"^v\d", RegexOptions.CultureInvariant | RegexOptions.IgnoreCase)) // common version prefix + version = version.Substring(1); + + return version; + } + } +} diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs index 59d7f3ba..4822c414 100644 --- a/src/StardewModdingAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs +++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs @@ -8,26 +8,19 @@ using StardewModdingAPI.Models; namespace StardewModdingAPI.Web.Framework.ModRepositories { /// An HTTP client for fetching mod metadata from the Chucklefish mod site. - internal class ChucklefishRepository : IModRepository + internal class ChucklefishRepository : RepositoryBase { /********* ** Properties *********/ - /// The underlying HTTP client. - private readonly IClient Client; - - - /********* - ** Accessors - *********/ - /// The unique key for this vendor. - public string VendorKey { get; } - /// The base URL for the Chucklefish mod site. - public string BaseUrl { get; } + private readonly string BaseUrl; /// The URL for a mod page excluding the base URL, where {0} is the mod ID. - public string ModPageUrlFormat { get; } + private readonly string ModPageUrlFormat; + + /// The underlying HTTP client. + private readonly IClient Client; /********* @@ -39,8 +32,8 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /// The base URL for the Chucklefish mod site. /// The URL for a mod page excluding the , where {0} is the mod ID. public ChucklefishRepository(string vendorKey, string userAgent, string baseUrl, string modPageUrlFormat) + : base(vendorKey) { - this.VendorKey = vendorKey; this.BaseUrl = baseUrl; this.ModPageUrlFormat = modPageUrlFormat; this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); @@ -48,7 +41,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /// Get metadata about a mod in the repository. /// The mod ID in this repository. - public async Task GetModInfoAsync(string id) + public override async Task GetModInfoAsync(string id) { try { @@ -77,7 +70,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories string version = doc.DocumentNode.SelectSingleNode("//h1/span").InnerText; // create model - return new ModInfoModel(name, version, url); + return new ModInfoModel(name, this.NormaliseVersion(version), url); } catch (Exception ex) { @@ -86,7 +79,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories } /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - public void Dispose() + public override void Dispose() { this.Client.Dispose(); } diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs index f794c605..7dfe9f62 100644 --- a/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs +++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs @@ -7,25 +7,18 @@ using StardewModdingAPI.Models; namespace StardewModdingAPI.Web.Framework.ModRepositories { /// An HTTP client for fetching mod metadata from GitHub project releases. - internal class GitHubRepository : IModRepository + internal class GitHubRepository : RepositoryBase { /********* ** Properties *********/ + /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. + private readonly string ReleaseUrlFormat; + /// The underlying HTTP client. private readonly IClient Client; - /********* - ** Accessors - *********/ - /// The unique key for this vendor. - public string VendorKey { get; } - - /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. - public string ReleaseUrlFormat { get; } - - /********* ** Public methods *********/ @@ -38,8 +31,8 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /// The username with which to authenticate to the GitHub API. /// The password with which to authenticate to the GitHub API. public GitHubRepository(string vendorKey, string baseUrl, string releaseUrlFormat, string userAgent, string acceptHeader, string username, string password) + : base(vendorKey) { - this.VendorKey = vendorKey; this.ReleaseUrlFormat = releaseUrlFormat; this.Client = new FluentClient(baseUrl) @@ -51,23 +44,14 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /// Get metadata about a mod in the repository. /// The mod ID in this repository. - public async Task GetModInfoAsync(string id) + public override async Task GetModInfoAsync(string id) { try { - // fetch data GitRelease release = await this.Client .GetAsync(string.Format(this.ReleaseUrlFormat, id)) .As(); - - // extract fields - string name = id; - string version = release.Tag; - if (version.StartsWith("v")) // common format on GitHub - version = version.Substring(1); - string url = $"https://github.com/{id}/releases"; - - return new ModInfoModel(name, version, url); + return new ModInfoModel(id, this.NormaliseVersion(release.Tag), $"https://github.com/{id}/releases"); } catch (Exception ex) { @@ -76,7 +60,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories } /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - public void Dispose() + public override void Dispose() { this.Client.Dispose(); } diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs index 6cf5b04a..e679b977 100644 --- a/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs +++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs @@ -7,25 +7,18 @@ using StardewModdingAPI.Models; namespace StardewModdingAPI.Web.Framework.ModRepositories { /// An HTTP client for fetching mod metadata from Nexus Mods. - internal class NexusRepository : IModRepository + internal class NexusRepository : RepositoryBase { /********* ** Properties *********/ + /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. + private readonly string ModUrlFormat; + /// The underlying HTTP client. private readonly IClient Client; - /********* - ** Accessors - *********/ - /// The unique key for this vendor. - public string VendorKey { get; } - - /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. - public string ModUrlFormat { get; } - - /********* ** Public methods *********/ @@ -35,15 +28,15 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /// The base URL for the Nexus Mods API. /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. public NexusRepository(string vendorKey, string userAgent, string baseUrl, string modUrlFormat) + : base(vendorKey) { - this.VendorKey = vendorKey; this.ModUrlFormat = modUrlFormat; this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); } /// Get metadata about a mod in the repository. /// The mod ID in this repository. - public async Task GetModInfoAsync(string id) + public override async Task GetModInfoAsync(string id) { try { @@ -52,7 +45,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories .As(); return response != null - ? new ModInfoModel(response.Name, response.Version, response.Url) + ? new ModInfoModel(response.Name, this.NormaliseVersion(response.Version), response.Url) : new ModInfoModel("Found no mod with this ID."); } catch (Exception ex) @@ -62,7 +55,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories } /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - public void Dispose() + public override void Dispose() { this.Client.Dispose(); } -- cgit