Refactoring for nullable (microsoft#1880)

src/PSRule.Types/Converters/Yaml/StringArrayMapConverter.cs

@@ -45,7 +45,7 @@ bool IYamlTypeConverter.Accepts(Type type)
                 }
                 else if (parser.TryConsume<Scalar>(out scalar))
                 {
-                    result[key] = new string[] { scalar.Value };
+                    result[key] = [scalar.Value];
                 }
 #pragma warning restore IDE0001
             }

src/PSRule/Definitions/ILanguageBlock.cs → src/PSRule.Types/Definitions/ILanguageBlock.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using PSRule.Pipeline;
-
 namespace PSRule.Definitions;
 
 /// <summary>
@@ -18,5 +16,5 @@ public interface ILanguageBlock
     /// <summary>
     /// The source location for the block.
     /// </summary>
-    SourceFile Source { get; }
+    ISourceFile Source { get; }
 }

src/PSRule/Definitions/IResource.cs → src/PSRule.Types/Definitions/IResource.cs

@@ -24,24 +24,24 @@ public interface IResource : ILanguageBlock
     string Name { get; }
 
     /// <summary>
-    /// An optional reference identifer for the resource.
+    /// An optional reference identifier for the resource.
     /// </summary>
     ResourceId? Ref { get; }
 
     /// <summary>
     /// Any additional aliases for the resource.
     /// </summary>
-    ResourceId[] Alias { get; }
+    ResourceId[]? Alias { get; }
 
     /// <summary>
     /// Any resource tags.
     /// </summary>
-    ResourceTags Tags { get; }
+    IResourceTags? Tags { get; }
 
     /// <summary>
     /// Any taxonomy references.
     /// </summary>
-    ResourceLabels Labels { get; }
+    IResourceLabels? Labels { get; }
 
     /// <summary>
     /// Flags for the resource.

src/PSRule.Types/Definitions/IResourceAnnotations.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace PSRule.Definitions;
+
+/// <summary>
+/// 
+/// </summary>
+public interface IResourceAnnotations : IDictionary<string, object>
+{ 
+}

src/PSRule.Types/Definitions/IResourceHelpInfo.cs

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace PSRule.Definitions;
+
+/// <summary>
+/// Metadata about a PSRule resource.
+/// </summary>
+public interface IResourceHelpInfo
+{
+    /// <summary>
+    /// The name of the resource.
+    /// </summary>
+    string Name { get; }
+
+    /// <summary>
+    /// A display name of the resource if set.
+    /// </summary>
+    string DisplayName { get; }
+
+    /// <summary>
+    /// A short description of the resource if set.
+    /// </summary>
+    InfoString Synopsis { get; }
+
+    /// <summary>
+    /// A long description of the resource if set.
+    /// </summary>
+    InfoString Description { get; }
+}

src/PSRule.Types/Definitions/IResourceLabels.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace PSRule.Definitions;
+
+/// <summary>
+/// 
+/// </summary>
+public interface IResourceLabels : IDictionary<string, string[]>
+{
+    /// <summary>
+    /// Check if the resource label matches.
+    /// </summary>
+    /// <param name="key"></param>
+    /// <param name="value"></param>
+    /// <returns></returns>
+    bool Contains(string key, string[] value);
+}

src/PSRule.Types/Definitions/IResourceMetadata.cs

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace PSRule.Definitions;
+
+/// <summary>
+/// Additional resource metadata.
+/// </summary>
+public interface IResourceMetadata
+{
+    /// <summary>
+    /// Annotations on the resource.
+    /// </summary>
+    public IResourceAnnotations Annotations { get;}
+}

src/PSRule.Types/Definitions/IResourceTags.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Collections;
+
+namespace PSRule.Definitions;
+
+/// <summary>
+/// 
+/// </summary>
+public interface IResourceTags : IDictionary<string, string>
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <returns></returns>
+    Hashtable ToHashtable();
+
+    /// <summary>
+    /// Check if a specific resource tag exists.
+    /// </summary>
+    /// <param name="key"></param>
+    /// <param name="value"></param>
+    /// <returns></returns>
+    bool Contains(object key, object value);
+}

src/PSRule.Types/Definitions/ISourceExtent.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 namespace PSRule.Definitions;
@@ -11,7 +11,7 @@ public interface ISourceExtent
     /// <summary>
     /// The source file path.
     /// </summary>
-    string File { get; }
+    ISourceFile File { get; }
 
     /// <summary>
     /// The first line of the expression.

src/PSRule.Types/Definitions/ISourceFile.cs

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace PSRule.Definitions;
+
+/// <summary>
+/// A source file containing resources that will be loaded and interpreted by PSRule.
+/// </summary>
+public interface ISourceFile
+{
+    /// <summary>
+    /// The file path to the source.
+    /// </summary>
+    string Path { get; }
+
+    /// <summary>
+    /// The name of the module if the source was loaded from a module.
+    /// </summary>
+    string Module { get; }
+
+    /// <summary>
+    /// The type of source file.
+    /// </summary>
+    SourceType Type { get; }
+
+    /// <summary>
+    /// The base path to use for loading help content.
+    /// </summary>
+    string HelpPath { get; }
+
+    /// <summary>
+    /// Determines if the source file exists.
+    /// </summary>
+    /// <returns>Returns <c>true</c> when the source file exists.</returns>
+    bool Exists();
+
+    /// <summary>
+    /// Determines if the source file is a dependency.
+    /// </summary>
+    /// <returns>Returns <c>true</c> when the source file is a dependency.</returns>
+    bool IsDependency();
+}

src/PSRule/Definitions/ResourceAnnotations.cs → src/PSRule.Types/Definitions/ResourceAnnotations.cs

@@ -6,7 +6,7 @@ namespace PSRule.Definitions;
 /// <summary>
 /// Additional resource annotations.
 /// </summary>
-public sealed class ResourceAnnotations : Dictionary<string, object>
+public sealed class ResourceAnnotations : Dictionary<string, object>, IResourceAnnotations
 {
 
 }

src/PSRule/Definitions/IResourceHelpInfo.cs → src/PSRule.Types/Definitions/ResourceHelpInfo.cs

@@ -1,36 +1,10 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 using Newtonsoft.Json;
 
 namespace PSRule.Definitions;
 
-/// <summary>
-/// Metadata about a PSRule resource.
-/// </summary>
-public interface IResourceHelpInfo
-{
-    /// <summary>
-    /// The name of the resource.
-    /// </summary>
-    string Name { get; }
-
-    /// <summary>
-    /// A display name of the resource if set.
-    /// </summary>
-    string DisplayName { get; }
-
-    /// <summary>
-    /// A short description of the resource if set.
-    /// </summary>
-    InfoString Synopsis { get; }
-
-    /// <summary>
-    /// A long description of the resource if set.
-    /// </summary>
-    InfoString Description { get; }
-}
-
 internal sealed class ResourceHelpInfo : IResourceHelpInfo
 {
     internal ResourceHelpInfo(string name, string displayName, InfoString synopsis, InfoString description)

src/PSRule/Definitions/ResourceHelper.cs → src/PSRule.Types/Definitions/ResourceHelper.cs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using PSRule.Definitions.Rules;
-using PSRule.Runtime;
-
 namespace PSRule.Definitions;
 
 internal static class ResourceHelper
@@ -12,24 +9,26 @@ internal static class ResourceHelper
 
     private const char SCOPE_SEPARATOR = '\\';
 
+    internal const string STANDALONE_SCOPENAME = ".";
+
     internal static string GetIdString(string scope, string name)
     {
         return name.IndexOf(SCOPE_SEPARATOR) >= 0
             ? name
             : string.Concat(
-            LanguageScope.Normalize(scope),
+            NormalizeScope(scope),
             SCOPE_SEPARATOR,
             name
         );
     }
 
-    internal static void ParseIdString(string defaultScope, string id, out string scope, out string name)
+    internal static void ParseIdString(string defaultScope, string id, out string? scope, out string? name)
     {
         ParseIdString(id, out scope, out name);
-        scope ??= LanguageScope.Normalize(defaultScope);
+        scope ??= NormalizeScope(defaultScope);
     }
 
-    internal static void ParseIdString(string id, out string scope, out string name)
+    internal static void ParseIdString(string id, out string? scope, out string? name)
     {
         scope = null;
         name = null;
@@ -48,7 +47,7 @@ internal static void ParseIdString(string id, out string scope, out string name)
     /// <param name="name">An array of names. Qualified names (RuleIds) supplied are left intact.</param>
     /// <param name="kind">The <seealso cref="ResourceIdKind"/> of the <seealso cref="ResourceId"/>.</param>
     /// <returns>An array of RuleIds.</returns>
-    internal static ResourceId[] GetRuleId(string defaultScope, string[] name, ResourceIdKind kind)
+    internal static ResourceId[]? GetRuleId(string defaultScope, string[] name, ResourceIdKind kind)
     {
         if (name == null || name.Length == 0)
             return null;
@@ -60,8 +59,9 @@ internal static ResourceId[] GetRuleId(string defaultScope, string[] name, Resou
         return (result.Length == 0) ? null : result;
     }
 
-    internal static ResourceId GetRuleId(string defaultScope, string name, ResourceIdKind kind)
+    internal static ResourceId GetRuleId(string? defaultScope, string name, ResourceIdKind kind)
     {
+        defaultScope ??= STANDALONE_SCOPENAME;
         return name.IndexOf(SCOPE_SEPARATOR) > 0 ? ResourceId.Parse(name, kind) : new ResourceId(defaultScope, name, kind);
     }
 
@@ -70,7 +70,7 @@ internal static ResourceId GetRuleId(string defaultScope, string name, ResourceI
         return string.IsNullOrEmpty(name) ? null : new ResourceId(scope, name, kind);
     }
 
-    internal static bool IsObsolete(ResourceMetadata metadata)
+    internal static bool IsObsolete(IResourceMetadata metadata)
     {
         return metadata != null &&
             metadata.Annotations != null &&
@@ -80,6 +80,11 @@ internal static bool IsObsolete(ResourceMetadata metadata)
 
     internal static SeverityLevel GetLevel(SeverityLevel? level)
     {
-        return !level.HasValue || level.Value == SeverityLevel.None ? RuleV1.DEFAULT_LEVEL : level.Value;
+        return !level.HasValue || level.Value == SeverityLevel.None ? SeverityLevel.Error : level.Value;
+    }
+
+    internal static string NormalizeScope(string? scope)
+    {
+        return scope == null || string.IsNullOrEmpty(scope) ? STANDALONE_SCOPENAME : scope;
     }
 }