Refactor naming of sanitize levels

Updating the names to more commonly used terms that reflect the intended usage. "Aggressive" implies an extra-strong level, rather than what is actually the normal, standard level that should be used for most projects. Hopefully this will make the levels more clear for new users to understand.

Author: joyfullservice

Version Control.accda.src/modules/clsOptions.cls

@@ -79,8 +79,8 @@ Public Sub LoadDefaults()
         .ForceImportOriginalQuerySQL = False
         .SaveTableSQL = True
         .StripPublishOption = True
-        .SanitizeLevel = eslAggressive
-        .SanitizeColors = eslBasic
+        .SanitizeLevel = eslStandard
+        .SanitizeColors = eslMinimal
         .ShowVCSLegacy = True
         .HashAlgorithm = DefaultHashAlgorithm
         .UseShortHash = True
@@ -280,7 +280,7 @@ Private Sub Upgrade(ByRef dOptions As Dictionary)
             ' Check for non-default level
             If Not dOptions("AggressiveSanitize") Then
                 ' Set to basic level
-                dOptions.Add "SanitizeLevel", eslBasic
+                dOptions.Add "SanitizeLevel", eslMinimal
             End If
         End If
     End If
@@ -476,9 +476,9 @@ End Function
 Public Function GetSanitizeLevelName(intSanitizeLevel As eSanitizeLevel) As String
     Select Case intSanitizeLevel
         Case eslNone:           GetSanitizeLevelName = "None (Off)"
-        Case eslBasic:          GetSanitizeLevelName = "Basic"
-        Case eslAggressive:     GetSanitizeLevelName = "Aggressive"
-        Case eslAdvancedBeta:   GetSanitizeLevelName = "Advanced (BETA)"
+        Case eslMinimal:        GetSanitizeLevelName = "Minimal"
+        Case eslStandard:       GetSanitizeLevelName = "Standard"
+        Case eslExtended:       GetSanitizeLevelName = "Extended"
         Case Else:              GetSanitizeLevelName = vbNullString
     End Select
 End Function

Version Control.accda.src/modules/modAPI.bas

@@ -25,16 +25,13 @@ Public Enum eTableDataExportFormat
     [_Last] = 2
 End Enum
 
+' Sanitize levels used for sanitizing general and color elements in source files.
 Public Enum eSanitizeLevel
-    eslNone = 0     ' Sanitize only items which won't build correctly unless you sanitize them.
-    eslBasic        ' Strip out excess items (like GUIDs) that are just noise and no effect can be found.
-    eslAggressive    ' Strip out anything that can be reliably rebuilt by Access during Build (themed control colors).
-
-    ' WARNING: AdvancedBeta introduces sanitzation that may or may not work in all environments, and has known
-    '          (or highly suspected) edge cases where it does not always operate correctly. Do not use this level in
-    '          production databases.
-    eslAdvancedBeta ' Remove all excess noise. Try out new sanitize features that still have ragged edges.
-    [_Last]         ' DO NOT REMOVE: This is a "Fake" level, and must be at the end.
+    eslNone = 0     ' Don't sanitize anything.
+    eslMinimal      ' Sanitize minimal things like GUIDs.
+    eslStandard     ' Remove non-critical elements that cause VCS noise between builds.
+    eslExtended     ' Remove as much as possible. May have possible negative effects.
+    [_Last]         ' Placeholder for the end of the list.
 End Enum
 
 

Version Control.accda.src/modules/modConnect.bas

@@ -44,7 +44,7 @@ Public Function SanitizeConnectionString(strConnection As String) As String
                     StartsWith(strPart, "PWD=", vbTextCompare)
                     ' These values are not needed when using a trusted connection.
                     If (InStr(1, strConnection, "Trusted_Connection=Yes", vbTextCompare) = 0) _
-                        Or (Options.SanitizeLevel < eslAggressive) Then
+                        Or (Options.SanitizeLevel < eslStandard) Then
                         ' Retain the values if not using trusted connection, or if
                         ' using less than the normal sanitize level.
                         .Add strPart

Version Control.accda.src/modules/modSanitize.bas

@@ -116,7 +116,7 @@ Public Function SanitizeFile(strPath As String, blnReturnHash As Boolean) As Str
                     "NameMap = Begin", _
                     "dbLongBinary ""DOL"" = Begin", _
                     "dbBinary ""GUID"" = Begin"
-                    If Options.SanitizeLevel >= eslAggressive Then
+                    If Options.SanitizeLevel >= eslStandard Then
                         blnInsideIgnoredBlock = True
                         SkipLine lngLine
                     End If
@@ -154,7 +154,7 @@ Public Function SanitizeFile(strPath As String, blnReturnHash As Boolean) As Str
                     If blnIsPassThroughQuery Then
                         ' Ignore remaining content. (See Issue #182)
                         Do While lngLine < UBound(varLines)
-                            SkipLine lngLine, eslAggressive
+                            SkipLine lngLine, eslStandard
                             lngLine = lngLine + 1
                         Loop
                         Exit Do
@@ -175,7 +175,7 @@ Public Function SanitizeFile(strPath As String, blnReturnHash As Boolean) As Str
                         SkipLine lngLine
                     ElseIf StartsWith(strTLine, "Checksum =") Then
                         ' Ignore Checksum lines, since they will change.
-                        SkipLine lngLine, eslBasic
+                        SkipLine lngLine, eslMinimal
                     ElseIf StartsWith(strTLine, "ColumnInfo =") _
                         Or StartsWith(strTLine, "BaseInfo =") Then
                         ' [ColumnInfo] contains some cached info from the record source
@@ -184,24 +184,24 @@ Public Function SanitizeFile(strPath As String, blnReturnHash As Boolean) As Str
                         ' Since the value could span multiple lines, we need to
                         ' check the indent level of the following lines to see how
                         ' many lines to skip.
-                        SkipLine lngLine, eslAggressive
+                        SkipLine lngLine, eslStandard
                         intIndent = GetIndent(strLine)
                         ' Preview the next line, and check the indent level
                         Do While GetIndent(varLines(lngLine + 1)) > intIndent
                             ' Skip previewed line and move to next line
-                            SkipLine lngLine + 1, eslAggressive
+                            SkipLine lngLine + 1, eslStandard
                             lngLine = lngLine + 1
                         Loop
                     ElseIf blnIsReport And StartsWith(strLine, "    Right =") Then
                         ' Ignore this line. (Not important, and frequently changes.)
-                        SkipLine lngLine, eslAggressive
+                        SkipLine lngLine, eslStandard
                     ElseIf blnIsReport And StartsWith(strLine, "    Bottom =") Then
                         ' Turn flag back off now that we have ignored these two lines.
-                        SkipLine lngLine, eslAggressive
+                        SkipLine lngLine, eslStandard
                         blnIsReport = False
                     ElseIf StartsWith(strTLine, "WebImagePadding") Then
                         ' These values tend to drift between builds. See #423
-                        SkipLine lngLine, eslAggressive
+                        SkipLine lngLine, eslStandard
                     ElseIf StartsWith(strTLine, "Begin ") Then
                         ' Include block type name for controls
                         BeginBlock Mid$(strTLine, 7)
@@ -425,7 +425,7 @@ Private Sub CloseBlock()
                     ' unless otherwise specified.
                     ' As discussed in #183, this can be affected by incomplete
                     ' component definition blocks.
-                    If Options.SanitizeColors = eslAdvancedBeta Then
+                    If Options.SanitizeColors = eslExtended Then
                         strKey = varBase(intCnt) & "Color"
                         If dBlock.Exists(strKey) Then
                             ' Skip the dynamic color line
@@ -531,7 +531,7 @@ Public Function SanitizeVBA(strCode As String) As String
     Dim lngLastLine As Long
 
     ' Skip sanitizing if not using that option.
-    If Options.SanitizeLevel < eslAggressive Then
+    If Options.SanitizeLevel < eslStandard Then
         SanitizeVBA = strCode
         Exit Function
     End If