Add RecurseCustomRulePath to settings file

Author: Kapil Borle

Engine/Settings.cs

@@ -28,14 +28,16 @@ internal enum SettingsMode { None = 0, Auto, File, Hashtable, Preset };
     /// </summary>
     public class Settings
     {
-        private bool includeDefaultRules;
+        private bool recurseCustomRulePath = false;
+        private bool includeDefaultRules = false;
         private string filePath;
         private List<string> includeRules;
         private List<string> excludeRules;
         private List<string> severities;
         private List<string> customRulePath;
         private Dictionary<string, Dictionary<string, object>> ruleArguments;
 
+        public bool RecurseCustomRulePath => recurseCustomRulePath;
         public bool IncludeDefaultRules => includeDefaultRules;
         public string FilePath => filePath;
         public IEnumerable<string> IncludeRules => includeRules;
@@ -409,12 +411,19 @@ private void parseSettingsHashtable(Hashtable settingsHashtable)
                         break;
 
                     case "includedefaultrules":
+                    case "recursecustomrulepath":
+                        // todo localize
                         if (!(val is bool))
                         {
                             throw new InvalidDataException(string.Format(CultureInfo.CurrentCulture, "Not a boolean"));
                         }
 
-                        includeDefaultRules = (bool)val;
+                        var booleanVal = (bool)val;
+                        var thisType = this.GetType();
+                        var field = this.GetType().GetField(
+                            key,
+                            BindingFlags.Instance | BindingFlags.IgnoreCase | BindingFlags.NonPublic);
+                        field.SetValue(this, booleanVal);
                         break;
 
                     case "rules":

Tests/Engine/Settings.tests.ps1

@@ -146,37 +146,37 @@ Describe "Settings Class" {
         }
     }
 
-    Context "When IncludeDefaultRules parameter is provided" {
-        It "Should correctly set the value if a boolean is given - true" {
-            $settingsHashtable = @{
-                IncludeDefaultRules = $true
+    @("IncludeDefaultRules", "RecurseCustomRulePath") | ForEach-Object {
+        $paramName = $_
+        Context "When $paramName parameter is provided" {
+            It "Should correctly set the value if a boolean is given - true" {
+                $settingsHashtable = @{}
+                $settingsHashtable.Add($paramName, $true)
+
+                $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
+                $settings."$paramName" | Should Be $true
             }
 
-            $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
-            $settings.IncludeDefaultRules | Should Be $true
-        }
+            It "Should correctly set the value if a boolean is given - false" {
+                $settingsHashtable = @{}
+                $settingsHashtable.Add($paramName, $false)
 
-        It "Should correctly set the value if a boolean is given - false" {
-            $settingsHashtable = @{
-                IncludeDefaultRules = $false
+                $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
+                $settings."$paramName" | Should Be $false
             }
 
-            $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
-            $settings.IncludeDefaultRules | Should Be $false
-        }
+            It "Should throw if a non-boolean value is given" {
+                $settingsHashtable = @{}
+                $settingsHashtable.Add($paramName, "some random string")
 
-        It "Should throw if a non-boolean value is given" {
-            $settingsHashtable = @{
-                IncludeDefaultRules = "some random string"
+                { New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable } | Should Throw
             }
 
-            { New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable } | Should Throw
-        }
-
-        It "Should detect the parameter in a settings file" {
-            $settings = New-Object -TypeName $settingsTypeName `
-                              -ArgumentList ([System.IO.Path]::Combine($project1Root, "CustomRulePathSettings.psd1"))
-            $settings.IncludeDefaultRules | Should Be $true
+            It "Should detect the parameter in a settings file" {
+                $settings = New-Object -TypeName $settingsTypeName `
+                    -ArgumentList ([System.IO.Path]::Combine($project1Root, "CustomRulePathSettings.psd1"))
+                $settings."$paramName" | Should Be $true
+            }
         }
     }
 }