From ad2dcc28791eb8026335646474fb2e0766fcc51b Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Fri, 11 Nov 2022 21:22:52 -0500 Subject: [PATCH] expand code comments for clarity --- src/SMAPI.Tests/Core/AssetNameTests.cs | 5 ++--- src/SMAPI/Framework/Content/AssetName.cs | 12 ++++++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/src/SMAPI.Tests/Core/AssetNameTests.cs b/src/SMAPI.Tests/Core/AssetNameTests.cs index cd4d0473..2d546ec7 100644 --- a/src/SMAPI.Tests/Core/AssetNameTests.cs +++ b/src/SMAPI.Tests/Core/AssetNameTests.cs @@ -265,15 +265,14 @@ namespace SMAPI.Tests.Core return name.StartsWith(otherAssetName, allowPartialWord: true, allowSubfolder: allowSubfolder); } - // the enumerator strips the trailing path seperator - // so each of these cases has to be handled on each branch. + // The enumerator strips the trailing path separator, so each of these cases has to be handled on each branch. [TestCase("Mods/SomeMod", "Mods/", false, ExpectedResult = true)] [TestCase("Mods/SomeMod", "Mods", false, ExpectedResult = false)] [TestCase("Mods/Jasper/Data", "Mods/Jas/", false, ExpectedResult = false)] [TestCase("Mods/Jasper/Data", "Mods/Jas", false, ExpectedResult = false)] [TestCase("Mods/Jas", "Mods/Jas/", false, ExpectedResult = false)] [TestCase("Mods/Jas", "Mods/Jas", false, ExpectedResult = true)] - public bool StartsWith_PrefixHasSeperator(string mainAssetName, string otherAssetName, bool allowSubfolder) + public bool StartsWith_PrefixHasSeparator(string mainAssetName, string otherAssetName, bool allowSubfolder) { // arrange mainAssetName = PathUtilities.NormalizeAssetName(mainAssetName); diff --git a/src/SMAPI/Framework/Content/AssetName.cs b/src/SMAPI/Framework/Content/AssetName.cs index a1c6a5da..8355f9ec 100644 --- a/src/SMAPI/Framework/Content/AssetName.cs +++ b/src/SMAPI/Framework/Content/AssetName.cs @@ -162,10 +162,14 @@ namespace StardewModdingAPI.Framework.Content if (prefixHasMore) return false; - // match if subfolder paths are fine (e.g. prefix 'Data/Events' with target 'Data/Events/Beach') - // special case if the original prefix ended with a '/' - subfolder checking pushes forward one, to check the Remainder instead of Current - // which is necessarily nonzero in this block. - return allowSubfolder || (pathSeparators.Contains(trimmedPrefix[^1]) && curParts.Remainder.Length == 0); + // match: every segment in the prefix matched and subfolders are allowed (e.g. prefix 'Data/Events' with target 'Data/Events/Beach') + if (allowSubfolder) + return true; + + // Special case: the prefix ends with a path separator, but subfolders aren't allowed. This case + // matches if there's no further path separator in the asset name *after* the current separator. + // For example, the prefix 'A/B/' matches 'A/B/C' but not 'A/B/C/D'. + return pathSeparators.Contains(trimmedPrefix[^1]) && curParts.Remainder.Length == 0; } // previous segments matched exactly and both reached the end