Add ScriptPath property to DiagnosticRecord

This lets the user have easy access the script path property. Prior to this, the user needed to probe the Extent property of DiagnosticRecord to get the script path.

Author: Kapil Borle

Engine/Generic/DiagnosticRecord.cs

@@ -10,6 +10,7 @@
 // THE SOFTWARE.
 //
 
+using System;
 using System.Management.Automation.Language;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
@@ -24,7 +25,7 @@ public class DiagnosticRecord
         private IScriptExtent extent;
         private string ruleName;
         private DiagnosticSeverity severity;
-        private string scriptName;
+        private string scriptPath;
         private string ruleSuppressionId;
 
         /// <summary>
@@ -33,7 +34,7 @@ public class DiagnosticRecord
         public string Message
         {
             get { return message; }
-            set { message = value; }
+            protected set { message = string.IsNullOrEmpty(value) ? string.Empty : value; }
         }
 
         /// <summary>
@@ -42,7 +43,7 @@ public string Message
         public IScriptExtent Extent
         {
             get { return extent; }
-            set { extent = value; }
+            protected set { extent = value; }
         }
 
         /// <summary>
@@ -51,7 +52,7 @@ public IScriptExtent Extent
         public string RuleName
         {
             get { return ruleName; }
-            set { ruleName = value; }
+            protected set { ruleName = string.IsNullOrEmpty(value) ? string.Empty : value; }
         }
 
         /// <summary>
@@ -68,18 +69,16 @@ public DiagnosticSeverity Severity
         /// </summary>
         public string ScriptName
         {
-            get { return scriptName; }
-            //Trim down to the leaf element of the filePath and pass it to Diagnostic Record
-            set {
-                if (!string.IsNullOrWhiteSpace(value))
-                {
-                    scriptName = System.IO.Path.GetFileName(value);
-                }
-                else
-                {
-                    scriptName = string.Empty;
-                }
-            }
+            get { return string.IsNullOrEmpty(scriptPath) ? string.Empty : System.IO.Path.GetFileName(scriptPath);}
+        }
+
+        /// <summary>
+        /// Returns the path of the script.
+        /// </summary>
+        public string ScriptPath
+        {
+            get { return scriptPath; }
+            protected set { scriptPath = string.IsNullOrEmpty(value) ? string.Empty : value; }
         }
 
         /// <summary>
@@ -106,16 +105,28 @@ public DiagnosticRecord()
         /// <param name="extent">The place in the script this diagnostic refers to</param>
         /// <param name="ruleName">The name of the rule that created this diagnostic</param>
         /// <param name="severity">The severity of this diagnostic</param>
-        /// <param name="scriptName">The name of the script file being analyzed</param>
-        public DiagnosticRecord(string message, IScriptExtent extent, string ruleName, DiagnosticSeverity severity, string scriptName, string ruleId = null)
+        /// <param name="scriptName">The path of the script file being analyzed</param>
+        public DiagnosticRecord(string message, IScriptExtent extent, string ruleName, DiagnosticSeverity severity, string scriptPath, string ruleId = null)
         {
-            Message  = string.IsNullOrEmpty(message)  ? string.Empty : message;
-            RuleName = string.IsNullOrEmpty(ruleName) ? string.Empty : ruleName;
+            Message  = message;
+            RuleName = ruleName;
             Extent   = extent;
             Severity = severity;
-            ScriptName = string.IsNullOrEmpty(scriptName) ? string.Empty : scriptName;
+            ScriptPath = scriptPath;
             ruleSuppressionId = ruleId;
         }
+
+        /// <summary>
+        /// Copy Constructor
+        /// </summary>
+        /// <param name="record"></param>
+        public DiagnosticRecord(DiagnosticRecord diagnosticRecord)
+        {
+            if (diagnosticRecord == null)
+            {
+                throw new ArgumentNullException("diagnosticRecord");
+            }
+        }
     }
 
 

Engine/Generic/SuppressedRecord.cs

@@ -40,7 +40,7 @@ public SuppressedRecord(DiagnosticRecord record, RuleSuppression suppression)
                 Message = record.Message;
                 Extent = record.Extent;
                 Severity = record.Severity;
-                ScriptName = record.ScriptName;
+                ScriptPath = record.ScriptPath;
                 RuleSuppressionID = record.RuleSuppressionID;
             }
         }