Move Settings class to Engine/ from Engine/Generic/

Kapil Borle · Kapil Borle · commit b9da9c5607f3 · 2017-02-28T11:59:18.000-08:00
Also changes the namespace from `Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings` to `Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings`.
diff --git a/Engine/Commands/InvokeScriptAnalyzerCommand.cs b/Engine/Commands/InvokeScriptAnalyzerCommand.cs
@@ -238,7 +238,7 @@ protected override void BeginProcessing()
             }
 
             object settingsFound;
-            var settingsMode = Generic.Settings.FindSettingsMode(
+            var settingsMode = PowerShell.ScriptAnalyzer.Settings.FindSettingsMode(
                 this.settings,
                 processedPaths == null || processedPaths.Count == 0 ? null : processedPaths[0],
                 out settingsFound);
diff --git a/Engine/PSScriptAnalyzer.psm1 b/Engine/PSScriptAnalyzer.psm1
@@ -34,7 +34,7 @@ if (Get-Command Register-ArgumentCompleter -ErrorAction Ignore)
     Register-ArgumentCompleter -CommandName 'Invoke-ScriptAnalyzer' -ParameterName 'Settings' -ScriptBlock {
         param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParmeter)
 
-        [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::GetSettingPresets() | `
+        [Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings]::GetSettingPresets() | `
             Where-Object {$_ -like "$wordToComplete*"} | `
             ForEach-Object { New-Object System.Management.Automation.CompletionResult $_ }
     }
diff --git a/Engine/ScriptAnalyzerEngine.csproj b/Engine/ScriptAnalyzerEngine.csproj
@@ -74,7 +74,7 @@
     <Compile Include="Generic\ConfigurableRule.cs" />
     <Compile Include="Generic\ModuleDependencyHandler.cs" />
     <Compile Include="Generic\CorrectionExtent.cs" />
-    <Compile Include="Generic\Settings.cs" />
+    <Compile Include="Settings.cs" />
     <Compile Include="Generic\SuppressedRecord.cs" />
     <Compile Include="Generic\DiagnosticRecord.cs" />
     <Compile Include="Generic\ExternalRule.cs" />
diff --git a/Engine/Settings.cs b/Engine/Settings.cs
@@ -19,7 +19,7 @@
 using System.Management.Automation.Language;
 using System.Reflection;
 
-namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
+namespace Microsoft.Windows.PowerShell.ScriptAnalyzer
 {
     internal enum SettingsMode { None = 0, Auto, File, Hashtable, Preset };
 
@@ -548,7 +548,7 @@ private static bool IsBuiltinSettingPreset(object settingPreset)
             var preset = settingPreset as string;
             if (preset != null)
             {
-                return Generic.Settings.GetSettingPresets().Contains(preset, StringComparer.OrdinalIgnoreCase);
+                return GetSettingPresets().Contains(preset, StringComparer.OrdinalIgnoreCase);
             }
 
             return false;
diff --git a/Tests/Engine/Settings.tests.ps1 b/Tests/Engine/Settings.tests.ps1
@@ -6,6 +6,7 @@ $directory = Split-Path $MyInvocation.MyCommand.Path
 $settingsTestDirectory = [System.IO.Path]::Combine($directory, "SettingsTest")
 $project1Root = [System.IO.Path]::Combine($settingsTestDirectory, "Project1")
 $project2Root = [System.IO.Path]::Combine($settingsTestDirectory, "Project2")
+$settingsTypeName = 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings'
 
 Describe "Settings Precedence" {
     Context "settings object is explicit" {
@@ -33,8 +34,7 @@ Describe "Settings Precedence" {
 Describe "Settings Class" {
     Context "When an empty hashtable is provided" {
         BeforeAll {
-            $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
-                              -ArgumentList @{}
+            $settings = New-Object -TypeName $settingsTypeName -ArgumentList @{}
         }
 
         'IncludeRules', 'ExcludeRules', 'Severity', 'RuleArguments' | ForEach-Object {
@@ -47,8 +47,7 @@ Describe "Settings Class" {
     Context "When a string is provided for IncludeRules in a hashtable" {
         BeforeAll {
             $ruleName = "PSAvoidCmdletAliases"
-            $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
-                              -ArgumentList @{ IncludeRules = $ruleName }
+            $settings = New-Object -TypeName $settingsTypeName -ArgumentList @{ IncludeRules = $ruleName }
         }
 
         It "Should return an IncludeRules array with 1 element" {
@@ -69,8 +68,7 @@ Describe "Settings Class" {
                     }
                 }
             }
-            $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
-                              -ArgumentList $settingsHashtable
+            $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
         }
 
         It "Should return the rule arguments" {
@@ -88,7 +86,7 @@ Describe "Settings Class" {
 
     Context "When a settings file path is provided" {
         BeforeAll {
-            $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
+            $settings = New-Object -TypeName $settingsTypeName `
                               -ArgumentList ([System.IO.Path]::Combine($project1Root, "ExplicitSettings.psd1"))
         }
 

Original file line number	Diff line number	Diff line change
`@@ -238,7 +238,7 @@ protected override void BeginProcessing()`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`object settingsFound;`
`241`		`- var settingsMode = Generic.Settings.FindSettingsMode(`
	`241`	`+ var settingsMode = PowerShell.ScriptAnalyzer.Settings.FindSettingsMode(`
`242`	`242`	`this.settings,`
`243`	`243`	`processedPaths == null \|\| processedPaths.Count == 0 ? null : processedPaths[0],`
`244`	`244`	`out settingsFound);`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ if (Get-Command Register-ArgumentCompleter -ErrorAction Ignore)`
`34`	`34`	`Register-ArgumentCompleter -CommandName 'Invoke-ScriptAnalyzer' -ParameterName 'Settings' -ScriptBlock {`
`35`	`35`	`param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParmeter)`
`36`	`36`
`37`		- [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::GetSettingPresets() \| `
	`37`	+ [Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings]::GetSettingPresets() \| `
`38`	`38`	Where-Object {$_ -like "$wordToComplete*"} \| `
`39`	`39`	`ForEach-Object { New-Object System.Management.Automation.CompletionResult $_ }`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`using System.Management.Automation.Language;`
`20`	`20`	`using System.Reflection;`
`21`	`21`
`22`		`-namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic`
	`22`	`+namespace Microsoft.Windows.PowerShell.ScriptAnalyzer`
`23`	`23`	`{`
`24`	`24`	`internal enum SettingsMode { None = 0, Auto, File, Hashtable, Preset };`
`25`	`25`
`@@ -548,7 +548,7 @@ private static bool IsBuiltinSettingPreset(object settingPreset)`
`548`	`548`	`var preset = settingPreset as string;`
`549`	`549`	`if (preset != null)`
`550`	`550`	`{`
`551`		`- return Generic.Settings.GetSettingPresets().Contains(preset, StringComparer.OrdinalIgnoreCase);`
	`551`	`+ return GetSettingPresets().Contains(preset, StringComparer.OrdinalIgnoreCase);`
`552`	`552`	`}`
`553`	`553`
`554`	`554`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ $directory = Split-Path $MyInvocation.MyCommand.Path`
`6`	`6`	`$settingsTestDirectory = [System.IO.Path]::Combine($directory, "SettingsTest")`
`7`	`7`	`$project1Root = [System.IO.Path]::Combine($settingsTestDirectory, "Project1")`
`8`	`8`	`$project2Root = [System.IO.Path]::Combine($settingsTestDirectory, "Project2")`
	`9`	`+$settingsTypeName = 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings'`
`9`	`10`
`10`	`11`	`Describe "Settings Precedence" {`
`11`	`12`	`Context "settings object is explicit" {`
`@@ -33,8 +34,7 @@ Describe "Settings Precedence" {`
`33`	`34`	`Describe "Settings Class" {`
`34`	`35`	`Context "When an empty hashtable is provided" {`
`35`	`36`	`BeforeAll {`
`36`		- $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
`37`		`- -ArgumentList @{}`
	`37`	`+ $settings = New-Object -TypeName $settingsTypeName -ArgumentList @{}`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`'IncludeRules', 'ExcludeRules', 'Severity', 'RuleArguments' \| ForEach-Object {`
`@@ -47,8 +47,7 @@ Describe "Settings Class" {`
`47`	`47`	`Context "When a string is provided for IncludeRules in a hashtable" {`
`48`	`48`	`BeforeAll {`
`49`	`49`	`$ruleName = "PSAvoidCmdletAliases"`
`50`		- $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
`51`		`- -ArgumentList @{ IncludeRules = $ruleName }`
	`50`	`+ $settings = New-Object -TypeName $settingsTypeName -ArgumentList @{ IncludeRules = $ruleName }`
`52`	`51`	`}`
`53`	`52`
`54`	`53`	`It "Should return an IncludeRules array with 1 element" {`
`@@ -69,8 +68,7 @@ Describe "Settings Class" {`
`69`	`68`	`}`
`70`	`69`	`}`
`71`	`70`	`}`
`72`		- $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
`73`		`- -ArgumentList $settingsHashtable`
	`71`	`+ $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable`
`74`	`72`	`}`
`75`	`73`
`76`	`74`	`It "Should return the rule arguments" {`
`@@ -88,7 +86,7 @@ Describe "Settings Class" {`
`88`	`86`
`89`	`87`	`Context "When a settings file path is provided" {`
`90`	`88`	`BeforeAll {`
`91`		- $settings = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.Settings' `
	`89`	+ $settings = New-Object -TypeName $settingsTypeName `
`92`	`90`	`-ArgumentList ([System.IO.Path]::Combine($project1Root, "ExplicitSettings.psd1"))`
`93`	`91`	`}`
`94`	`92`