(chocolatey-community#34) Implement note rule CPMR0061 - Id Contains "."

This implements the note rule CPMR0061 that verifies whether a package
uses a dot in its identifier, which is not recommended to do unless
absolutely necessary.

This implementation is more comprehensive than what is implemented in
package validator, where package validator will have false negatives
that this implementation will properly flag.

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=different.something.commandline.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=something.other.extension.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=something.other.install.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=something.other.portable.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=something.other.powershell.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=something.other.template.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldFlagIdentifier_id=something.other.verified.txt

@@ -0,0 +1,8 @@
+[
+  {
+    HelpUrl: https://ch0.co/rules/cpmr0061,
+    Id: CPMR0061,
+    Message: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    Severity: Note
+  }
+]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.ShouldReturnAvailableRulesForImplementation.verified.txt

@@ -10,5 +10,11 @@
     Id: CPMR0029,
     Summary: Package ID ends with the reserved suffix `.config`.,
     HelpUrl: https://ch0.co/rules/cpmr0029
+  },
+  {
+    Severity: Note,
+    Id: CPMR0061,
+    Summary: Package ID contains dots (.), that is not part of the accepted suffixes.,
+    HelpUrl: https://ch0.co/rules/cpmr0061
   }
 ]

src/Chocolatey.Community.Validation.Tests/Rules/IdElementRulesTests.cs

@@ -7,6 +7,22 @@ namespace Chocolatey.Community.Validation.Tests.Rules
 
     public class IdElementRulesTests : RuleTestBase<IdElementRules>
     {
+        [TestCase(null)]
+        [TestCase("")]
+        [TestCase("some-id")]
+        [TestCase("something.portable")]
+        [TestCase("something.commandline")]
+        [TestCase("something.powershell")]
+        [TestCase("something.install")]
+        [TestCase("something.template")]
+        [TestCase("something.extension")]
+        public async Task SholudNotFlagIdentifier(string id)
+        {
+            var testContent = GetTestContent(id);
+
+            await VerifyEmptyResults(testContent);
+        }
+
         [TestCase("testalpha")]
         [TestCase("test-ALPha")]
         [TestCase("testBETA")]
@@ -15,29 +31,20 @@ public class IdElementRulesTests : RuleTestBase<IdElementRules>
         [TestCase("my prerelease")]
         [TestCase("my-package.CONFIG")]
         [TestCase("pkg.config")]
+        [TestCase("something.other")]
+        [TestCase("something.other.portable")]
+        [TestCase("different.something.commandline")]
+        [TestCase("something.other.powershell")]
+        [TestCase("something.other.install")]
+        [TestCase("something.other.template")]
+        [TestCase("something.other.extension")]
         public async Task ShouldFlagIdentifier(string id)
         {
             var testContent = GetTestContent(id);
 
             await VerifyNuspec(testContent);
         }
 
-        [Test]
-        public async Task ShouldNotFlagIdentifierWithoutPrereleaseName()
-        {
-            var testContent = GetTestContent("some-id");
-
-            await VerifyEmptyResults(testContent);
-        }
-
-        [Test]
-        public async Task ShouldNotFlagAnEmptyIdentifier()
-        {
-            var testContent = GetTestContent(string.Empty);
-
-            await VerifyEmptyResults(testContent);
-        }
-
         private static string GetTestContent(string? id)
         {
             const string format = @"<?xml version=""1.0"" encoding=""utf-8""?>

src/Chocolatey.Community.Validation/Rules/IdElementRules.cs

@@ -7,8 +7,9 @@ namespace Chocolatey.Community.Validation.Rules
 
     public sealed class IdElementRules : CCRMetadataRuleBase
     {
-        private const string PreReleaseRuleId = "CPMR0024";
         private const string ConfigRuleId = "CPMR0029";
+        private const string DotsInIdentifierRuleId = "CPMR0061";
+        private const string PreReleaseRuleId = "CPMR0024";
 
         public override IEnumerable<RuleResult> Validate(global::NuGet.Packaging.NuspecReader reader)
         {
@@ -35,12 +36,45 @@ public override IEnumerable<RuleResult> Validate(global::NuGet.Packaging.NuspecR
             {
                 yield return GetRule(ConfigRuleId);
             }
+
+            var subId = GetSubIdentifier(id);
+
+            if (subId.IndexOf('.') > -1)
+            {
+                yield return GetRule(DotsInIdentifierRuleId);
+            }
         }
 
         protected internal override IEnumerable<(RuleType severity, string? id, string summary)> GetRulesInformation()
         {
             yield return (RuleType.Error, PreReleaseRuleId, "Package ID includes a prerelease version name.");
             yield return (RuleType.Error, ConfigRuleId, "Package ID ends with the reserved suffix `.config`.");
+            yield return (RuleType.Note, DotsInIdentifierRuleId, "Package ID contains dots (.), that is not part of the accepted suffixes.");
+        }
+
+        private static string GetSubIdentifier(string id)
+        {
+            var possibleSuffixes = new[]
+            {
+                ".portable",
+                ".commandline",
+                ".install",
+                ".extension",
+                ".template",
+                ".powershell",
+                // This is not an accepted suffix, but an existing rule aready handle this. So we ignore it.
+                ".config"
+            };
+
+            foreach (var suffix in possibleSuffixes)
+            {
+                if (id.EndsWith(suffix, StringComparison.OrdinalIgnoreCase))
+                {
+                    return id.Substring(0, id.Length - suffix.Length);
+                }
+            }
+
+            return id;
         }
     }
 }