Merge pull request rubberduck-vba#299 from retailcoder/refactor

Abstracted IInspectionModel; closes #139
retailcoder · Mar 8, 2015 · 3dfbee3 · 3dfbee3
2 parents 54ce610 + fb691dc
commit 3dfbee3
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 16 deletions.
diff --git a/RetailCoder.VBE/Config/CodeInspectionSettings.cs b/RetailCoder.VBE/Config/CodeInspectionSettings.cs
@@ -8,21 +8,21 @@ namespace Rubberduck.Config
     public class CodeInspectionSettings
     {
         [XmlArrayItemAttribute("CodeInspection", IsNullable = false)]
-        public CodeInspection[] CodeInspections { get; set; }
+        public CodeInspectionSetting[] CodeInspections { get; set; }
 
         public CodeInspectionSettings()
         {
             //default constructor requied for serialization
         }
 
-        public CodeInspectionSettings(CodeInspection[] inspections)
+        public CodeInspectionSettings(CodeInspectionSetting[] inspections)
         {
             this.CodeInspections = inspections;
         }
     }
 
     [XmlTypeAttribute(AnonymousType = true)]
-    public class CodeInspection
+    public class CodeInspectionSetting : IInspectionModel
     {
         [XmlAttribute]
         public string Name { get; set; }
@@ -33,19 +33,19 @@ public class CodeInspection
         [XmlAttribute]
         public CodeInspectionType InspectionType { get; set; }
 
-        public CodeInspection()
+        public CodeInspectionSetting()
         {
             //default constructor required for serialization
         }
 
-        public CodeInspection(string name, CodeInspectionType type, CodeInspectionSeverity severity)
+        public CodeInspectionSetting(string name, CodeInspectionType type, CodeInspectionSeverity severity)
         {
             this.Name = name;
             this.InspectionType = type;
             this.Severity = severity;
         }
 
-        public CodeInspection(Inspections.IInspection inspection)
+        public CodeInspectionSetting(IInspectionModel inspection)
             : this(inspection.Name, inspection.InspectionType, inspection.Severity)
         { }
     }

diff --git a/RetailCoder.VBE/Config/ConfigurationLoader.cs b/RetailCoder.VBE/Config/ConfigurationLoader.cs
@@ -89,7 +89,7 @@ public Configuration LoadConfiguration()
             }
         }
 
-        private List<CodeInspection> MergeImplementedInspectionsNotInConfig(List<CodeInspection> configInspections, IList<IInspection> implementedInspections)
+        private List<CodeInspectionSetting> MergeImplementedInspectionsNotInConfig(List<CodeInspectionSetting> configInspections, IList<IInspection> implementedInspections)
         {
             bool found;
             foreach (var implementedInspection in implementedInspections)
@@ -106,7 +106,7 @@ private List<CodeInspection> MergeImplementedInspectionsNotInConfig(List<CodeIns
 
                 if (!found)
                 {
-                    configInspections.Add(new CodeInspection(implementedInspection));
+                    configInspections.Add(new CodeInspectionSetting(implementedInspection));
                 }
             }
             return configInspections;
@@ -133,12 +133,12 @@ public ToDoMarker[] GetDefaultTodoMarkers()
 
         /// <summary>   Converts implemented code inspections into array of Config.CodeInspection objects. </summary>
         /// <returns>   An array of Config.CodeInspection. </returns>
-        public CodeInspection[] GetDefaultCodeInspections()
+        public CodeInspectionSetting[] GetDefaultCodeInspections()
         {
-            var configInspections = new List<CodeInspection>();
+            var configInspections = new List<CodeInspectionSetting>();
             foreach (var inspection in GetImplementedCodeInspections())
             {
-                configInspections.Add(new CodeInspection(inspection));
+                configInspections.Add(new CodeInspectionSetting(inspection));
             }
 
             return configInspections.ToArray();

diff --git a/RetailCoder.VBE/Config/IConfigurationService.cs b/RetailCoder.VBE/Config/IConfigurationService.cs
@@ -6,7 +6,7 @@ namespace Rubberduck.Config
 {
     public interface IConfigurationService
     {
-        CodeInspection[] GetDefaultCodeInspections();
+        CodeInspectionSetting[] GetDefaultCodeInspections();
         Configuration GetDefaultConfiguration();
         ToDoMarker[] GetDefaultTodoMarkers();
         IList<Rubberduck.Inspections.IInspection> GetImplementedCodeInspections();

diff --git a/RetailCoder.VBE/Inspections/IInspection.cs b/RetailCoder.VBE/Inspections/IInspection.cs
@@ -8,9 +8,9 @@
 namespace Rubberduck.Inspections
 {
     /// <summary>
-    /// An interface that abstracts a code inspection.
+    /// An interface that abstracts the data structure for a code inspection
     /// </summary>
-    public interface IInspection 
+    public interface IInspectionModel
     {
         /// <summary>
         /// Gets a short description for the code inspection.
@@ -26,7 +26,13 @@ public interface IInspection
         /// Gets a value indicating the severity level of the code inspection.
         /// </summary>
         CodeInspectionSeverity Severity { get; set; }
+    }
 
+    /// <summary>
+    /// An interface that abstracts a runnable code inspection.
+    /// </summary>
+    public interface IInspection : IInspectionModel
+    {
         /// <summary>
         /// Runs code inspection on specified parse trees.
         /// </summary>

diff --git a/RetailCoder.VBE/UI/Settings/CodeInspectionControl.cs b/RetailCoder.VBE/UI/Settings/CodeInspectionControl.cs
@@ -19,10 +19,10 @@ public CodeInspectionControl()
             InitializeComponent();
         }
 
-        public CodeInspectionControl(IEnumerable<CodeInspection> inspections)
+        public CodeInspectionControl(IEnumerable<CodeInspectionSetting> inspections)
             : this()
         {
-            var allInspections = new BindingList<CodeInspection>(inspections
+            var allInspections = new BindingList<CodeInspectionSetting>(inspections
                 .OrderBy(c => c.InspectionType.ToString())
                 .ThenBy(c => c.Name)
                 .ToList()