Replace accessibility parameter string with enum

BZngr · BZngr · commit 3d2ed907d650 · 2020-10-05T17:54:01.000-07:00
Also added more content to xmldocs.
diff --git a/Rubberduck.Refactorings/Common/CodeBuilder.cs b/Rubberduck.Refactorings/Common/CodeBuilder.cs
@@ -21,7 +21,7 @@ public interface ICodeBuilder
         /// <param name="content">Main body content/logic of the member</param>
         string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declaration,
             string content = null,
-            string accessibility = null,
+            Accessibility accessibility = Accessibility.Public,
             string newIdentifier = null);
 
         /// <summary>
@@ -35,37 +35,36 @@ string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declaration,
         /// Generates a Property Get codeblock based on the prototype declaration 
         /// </summary>
         /// <param name="prototype">DeclarationType with flags: Variable, Constant, UserDefinedTypeMember, or Function</param>
-        /// <param name="content">Member body content.  Formatting is the responsibility of the caller</param>
-        /// <param name="parameterIdentifier">Defaults to '<paramref name="propertyIdentifier"/>Value' unless otherwise specified</param>
+        /// <param name="content">Member body content.  Null results in an empty body.  Formatting is the responsibility of the caller</param>
         bool TryBuildPropertyGetCodeBlock(Declaration prototype,
             string propertyIdentifier,
             out string codeBlock,
-            string accessibility = null,
+            Accessibility accessibility = Accessibility.Public,
             string content = null);
 
         /// <summary>
         /// Generates a Property Let codeblock based on the prototype declaration 
         /// </summary>
         /// <param name="prototype">DeclarationType with flags: Variable, Constant, UserDefinedTypeMember, or Function</param>
-        /// <param name="content">Member body content.  Formatting is the responsibility of the caller</param>
-        /// <param name="parameterIdentifier">Defaults to '<paramref name="propertyIdentifier"/>Value' unless otherwise specified</param>
+        /// <param name="content">Member body content.  Null results in an empty body.  Formatting is the responsibility of the caller</param>
+        /// <param name="parameterIdentifier">Defaults to 'RHS' unless otherwise specified</param>
         bool TryBuildPropertyLetCodeBlock(Declaration prototype,
             string propertyIdentifier,
             out string codeBlock,
-            string accessibility = null,
+            Accessibility accessibility = Accessibility.Public,
             string content = null,
             string parameterIdentifier = null);
 
         /// <summary>
         /// Generates a Property Set codeblock based on the prototype declaration 
         /// </summary>
         /// <param name="prototype">DeclarationType with flags: Variable, Constant, UserDefinedTypeMember, or Function</param>
-        /// <param name="content">Member body content.  Formatting is the responsibility of the caller</param>
-        /// <param name="parameterIdentifier">Defaults to '<paramref name="propertyIdentifier"/>Value' unless otherwise specified</param>
+        /// <param name="content">Member body content.  Null results in an empty body.  Formatting is the responsibility of the caller</param>
+        /// <param name="parameterIdentifier">Defaults to 'RHS' unless otherwise specified</param>
         bool TryBuildPropertySetCodeBlock(Declaration prototype,
             string propertyIdentifier,
             out string codeBlock,
-            string accessibility = null,
+            Accessibility accessibility = Accessibility.Public,
             string content = null,
             string parameterIdentifier = null);
 
@@ -82,15 +81,15 @@ bool TryBuildPropertySetCodeBlock(Declaration prototype,
         /// Generates a <c>UserDefinedTypeMember</c> declaration expression based on the prototype declaration
         /// </summary>
         /// <param name="prototype">DeclarationType with flags: Variable, Constant, UserDefinedTypeMember, or Function</param>
-        /// <param name="indentation">Defaults is 4 spaces</param>
+        /// <param name="indentation">If left null, 4 spaces of indentation are applied</param>
         bool TryBuildUDTMemberDeclaration(string identifier, Declaration prototype, out string declaration, string indentation = null);
     }
 
     public class CodeBuilder : ICodeBuilder
     {
         public string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declaration, 
             string content = null, 
-            string accessibility = null, 
+            Accessibility accessibility = Accessibility.Public, 
             string newIdentifier = null)
         {
 
@@ -105,16 +104,16 @@ public string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declara
             return string.Concat(elements);
         }
 
-        public bool TryBuildPropertyGetCodeBlock(Declaration prototype, string propertyIdentifier, out string codeBlock, string accessibility = null, string content = null)
+        public bool TryBuildPropertyGetCodeBlock(Declaration prototype, string propertyIdentifier, out string codeBlock, Accessibility accessibility = Accessibility.Public, string content = null)
             => TryBuildPropertyBlockFromTarget(prototype, DeclarationType.PropertyGet, propertyIdentifier, out codeBlock, accessibility, content);
 
-        public bool TryBuildPropertyLetCodeBlock(Declaration prototype, string propertyIdentifier, out string codeBlock, string accessibility = null, string content = null, string parameterIdentifier = null)
+        public bool TryBuildPropertyLetCodeBlock(Declaration prototype, string propertyIdentifier, out string codeBlock, Accessibility accessibility = Accessibility.Public, string content = null, string parameterIdentifier = null)
             => TryBuildPropertyBlockFromTarget(prototype, DeclarationType.PropertyLet, propertyIdentifier, out codeBlock, accessibility, content, parameterIdentifier);
 
-        public bool TryBuildPropertySetCodeBlock(Declaration prototype, string propertyIdentifier, out string codeBlock, string accessibility = null, string content = null, string parameterIdentifier = null)
+        public bool TryBuildPropertySetCodeBlock(Declaration prototype, string propertyIdentifier, out string codeBlock, Accessibility accessibility = Accessibility.Public, string content = null, string parameterIdentifier = null)
             => TryBuildPropertyBlockFromTarget(prototype, DeclarationType.PropertySet, propertyIdentifier, out codeBlock, accessibility, content, parameterIdentifier);
 
-        private bool TryBuildPropertyBlockFromTarget<T>(T prototype, DeclarationType letSetGetType, string propertyIdentifier, out string codeBlock, string accessibility = null, string content = null, string parameterIdentifier = null) where T : Declaration
+        private bool TryBuildPropertyBlockFromTarget<T>(T prototype, DeclarationType letSetGetType, string propertyIdentifier, out string codeBlock, Accessibility accessibility, string content = null, string parameterIdentifier = null) where T : Declaration
         {
             codeBlock = string.Empty;
             if (!letSetGetType.HasFlag(DeclarationType.Property))
@@ -142,27 +141,23 @@ private bool TryBuildPropertyBlockFromTarget<T>(T prototype, DeclarationType let
             var letSetParamExpression = $"{paramMechanism} {propertyValueParam} {asTypeClause}";
 
             codeBlock = letSetGetType.HasFlag(DeclarationType.PropertyGet)
-                ? string.Join(Environment.NewLine, $"{accessibility ?? Tokens.Public} {TypeToken(letSetGetType)} {propertyIdentifier}() {asTypeClause}", content, EndStatement(letSetGetType))
-                : string.Join(Environment.NewLine, $"{accessibility ?? Tokens.Public} {TypeToken(letSetGetType)} {propertyIdentifier}({letSetParamExpression})", content, EndStatement(letSetGetType));
+                ? string.Join(Environment.NewLine, $"{AccessibilityToken(accessibility)} {TypeToken(letSetGetType)} {propertyIdentifier}() {asTypeClause}", content, EndStatement(letSetGetType))
+                : string.Join(Environment.NewLine, $"{AccessibilityToken(accessibility)} {TypeToken(letSetGetType)} {propertyIdentifier}({letSetParamExpression})", content, EndStatement(letSetGetType));
             return true;
         }
 
         public string ImprovedFullMemberSignature(ModuleBodyElementDeclaration declaration)
-            => ImprovedFullMemberSignatureInternal(declaration);
+            => ImprovedFullMemberSignatureInternal(declaration, declaration.Accessibility);
 
-        private string ImprovedFullMemberSignatureInternal(ModuleBodyElementDeclaration declaration, string accessibility = null, string newIdentifier = null)
+        private string ImprovedFullMemberSignatureInternal(ModuleBodyElementDeclaration declaration, Accessibility accessibility, string newIdentifier = null)
         {
-            var accessibilityToken = declaration.Accessibility.Equals(Accessibility.Implicit)
-                ? Tokens.Public
-                : $"{declaration.Accessibility.ToString()}";
-
             var asTypeName = string.IsNullOrEmpty(declaration.AsTypeName)
                 ? string.Empty
                 : $" {Tokens.As} {declaration.AsTypeName}";
             
             var elements = new List<string>()
             {
-                accessibility ?? accessibilityToken,
+                AccessibilityToken(accessibility),
                 $" {TypeToken(declaration.DeclarationType)} ",
                 newIdentifier ?? declaration.IdentifierName,
                 $"({ImprovedArgumentList(declaration)})",
@@ -297,6 +292,11 @@ private static string BuildUDTMemberDeclaration(string udtMemberIdentifier, Decl
             return $"{indentation ?? "    "}{identifierExpression} {Tokens.As} {prototype.AsTypeName}";
         }
 
+        private static string AccessibilityToken(Accessibility accessibility)
+            => accessibility.Equals(Accessibility.Implicit)
+                ? Tokens.Public
+                : $"{accessibility.ToString()}";
+
         private static bool IsValidPrototypeDeclarationType(DeclarationType declarationType)
         {
             return declarationType.HasFlag(DeclarationType.Variable)
diff --git a/Rubberduck.Refactorings/ImplementInterface/AddInterfaceImplementations/AddInterfaceImplementationsRefactoringAction.cs b/Rubberduck.Refactorings/ImplementInterface/AddInterfaceImplementations/AddInterfaceImplementationsRefactoringAction.cs
@@ -38,12 +38,12 @@ private string GetInterfaceMember(Declaration member, string interfaceName)
         {
             if (member is ModuleBodyElementDeclaration mbed)
             {
-                return _codeBuilder.BuildMemberBlockFromPrototype(mbed, accessibility: Tokens.Private, newIdentifier: $"{interfaceName}_{member.IdentifierName}", content: _memberBody);
+                return _codeBuilder.BuildMemberBlockFromPrototype(mbed, accessibility: Accessibility.Private, newIdentifier: $"{interfaceName}_{member.IdentifierName}", content: _memberBody);
             }
 
             if (member is VariableDeclaration variable)
             {
-                if (!_codeBuilder.TryBuildPropertyGetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyGet, Tokens.Private, _memberBody))
+                if (!_codeBuilder.TryBuildPropertyGetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyGet, Accessibility.Private, _memberBody))
                 {
                     throw new InvalidOperationException();
                 }
@@ -52,7 +52,7 @@ private string GetInterfaceMember(Declaration member, string interfaceName)
 
                 if (variable.AsTypeName.Equals(Tokens.Variant) || !variable.IsObject)
                 {
-                    if (!_codeBuilder.TryBuildPropertyLetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyLet, Tokens.Private, _memberBody))
+                    if (!_codeBuilder.TryBuildPropertyLetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyLet, Accessibility.Private, _memberBody))
                     {
                         throw new InvalidOperationException();
                     }
@@ -61,7 +61,7 @@ private string GetInterfaceMember(Declaration member, string interfaceName)
 
                 if (variable.AsTypeName.Equals(Tokens.Variant) || variable.IsObject)
                 {
-                    if (!_codeBuilder.TryBuildPropertySetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertySet, Tokens.Private, _memberBody))
+                    if (!_codeBuilder.TryBuildPropertySetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertySet, Accessibility.Private, _memberBody))
                     {
                         throw new InvalidOperationException();
                     }
diff --git a/RubberduckTests/CodeBuilderTests.cs b/RubberduckTests/CodeBuilderTests.cs
@@ -56,12 +56,12 @@ Private fuzz As ETestType2
             StringAssert.Contains($"Property Get {testParams.Identifier}() As {typeName}", result);
         }
 
-        [TestCase("fizz", DeclarationType.Variable, "Integer", "Public")]
-        [TestCase("FirstValue", DeclarationType.UserDefinedTypeMember, "Long", "Public")]
-        [TestCase("fazz", DeclarationType.Variable, "Long", "Public")]
-        [TestCase("fuzz", DeclarationType.Variable, "ETestType2", "Private")]
+        [TestCase("fizz", DeclarationType.Variable, "Integer", Accessibility.Public)]
+        [TestCase("FirstValue", DeclarationType.UserDefinedTypeMember, "Long", Accessibility.Public)]
+        [TestCase("fazz", DeclarationType.Variable, "Long", Accessibility.Public)]
+        [TestCase("fuzz", DeclarationType.Variable, "ETestType2", Accessibility.Private)]
         [Category(nameof(CodeBuilder))]
-        public void PropertyBlockFromPrototype_PropertyGetAccessibility(string targetIdentifier, DeclarationType declarationType, string typeName, string accessibility)
+        public void PropertyBlockFromPrototype_PropertyGetAccessibility(string targetIdentifier, DeclarationType declarationType, string typeName, Accessibility accessibility)
         {
             var testParams = new PropertyBlockFromPrototypeParams("Bazz", DeclarationType.PropertyGet, accessibility);
             string inputCode =
@@ -643,7 +643,7 @@ private static string ImprovedArgumentListTest(ModuleBodyElementDeclaration mbed
             => new CodeBuilder().ImprovedArgumentList(mbed);
 
         private static string MemberBlockFromPrototypeTest(ModuleBodyElementDeclaration mbed, MemberBlockFromPrototypeTestParams testParams)
-            => new CodeBuilder().BuildMemberBlockFromPrototype(mbed, testParams.Accessibility, testParams.Content, testParams.NewIdentifier);
+            => new CodeBuilder().BuildMemberBlockFromPrototype(mbed, testParams.Content, testParams.Accessibility, testParams.NewIdentifier);
 
         private (string procType, string endStmt) ProcedureTypeIdentifier(DeclarationType declarationType)
         {
@@ -666,7 +666,7 @@ private static string MemberBlockFromPrototypeTest(ModuleBodyElementDeclaration
 
         private struct PropertyBlockFromPrototypeParams
         {
-            public PropertyBlockFromPrototypeParams(string identifier, DeclarationType propertyType, string accessibility = null, string content = null, string paramIdentifier = null)
+            public PropertyBlockFromPrototypeParams(string identifier, DeclarationType propertyType, Accessibility accessibility = Accessibility.Public, string content = null, string paramIdentifier = null)
             {
                 Identifier = identifier;
                 DeclarationType = propertyType;
@@ -676,21 +676,21 @@ public PropertyBlockFromPrototypeParams(string identifier, DeclarationType prope
             }
             public DeclarationType DeclarationType { get; }
             public string Identifier { get; }
-            public string Accessibility {get; }
+            public Accessibility Accessibility {get; }
             public string Content { get; }
             public string WriteParam { get; }
         }
 
         private struct MemberBlockFromPrototypeTestParams
         {
-            public MemberBlockFromPrototypeTestParams(ModuleBodyElementDeclaration mbed, string accessibility = null, string content = null, string newIdentifier = null)
+            public MemberBlockFromPrototypeTestParams(ModuleBodyElementDeclaration mbed, Accessibility accessibility = Accessibility.Public, string content = null, string newIdentifier = null)
             {
                 Accessibility = accessibility;
                 Content = content;
                 NewIdentifier = newIdentifier;
             }
 
-            public string Accessibility { get; }
+            public Accessibility Accessibility { get; }
             public string Content { get; }
             public string NewIdentifier { get; }
         }

Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,12 @@ private string GetInterfaceMember(Declaration member, string interfaceName)`
`38`	`38`	`{`
`39`	`39`	`if (member is ModuleBodyElementDeclaration mbed)`
`40`	`40`	`{`
`41`		`- return _codeBuilder.BuildMemberBlockFromPrototype(mbed, accessibility: Tokens.Private, newIdentifier: $"{interfaceName}_{member.IdentifierName}", content: _memberBody);`
	`41`	`+ return _codeBuilder.BuildMemberBlockFromPrototype(mbed, accessibility: Accessibility.Private, newIdentifier: $"{interfaceName}_{member.IdentifierName}", content: _memberBody);`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`if (member is VariableDeclaration variable)`
`45`	`45`	`{`
`46`		`- if (!_codeBuilder.TryBuildPropertyGetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyGet, Tokens.Private, _memberBody))`
	`46`	`+ if (!_codeBuilder.TryBuildPropertyGetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyGet, Accessibility.Private, _memberBody))`
`47`	`47`	`{`
`48`	`48`	`throw new InvalidOperationException();`
`49`	`49`	`}`
`@@ -52,7 +52,7 @@ private string GetInterfaceMember(Declaration member, string interfaceName)`
`52`	`52`
`53`	`53`	`if (variable.AsTypeName.Equals(Tokens.Variant) \|\| !variable.IsObject)`
`54`	`54`	`{`
`55`		`- if (!_codeBuilder.TryBuildPropertyLetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyLet, Tokens.Private, _memberBody))`
	`55`	`+ if (!_codeBuilder.TryBuildPropertyLetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertyLet, Accessibility.Private, _memberBody))`
`56`	`56`	`{`
`57`	`57`	`throw new InvalidOperationException();`
`58`	`58`	`}`
`@@ -61,7 +61,7 @@ private string GetInterfaceMember(Declaration member, string interfaceName)`
`61`	`61`
`62`	`62`	`if (variable.AsTypeName.Equals(Tokens.Variant) \|\| variable.IsObject)`
`63`	`63`	`{`
`64`		`- if (!_codeBuilder.TryBuildPropertySetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertySet, Tokens.Private, _memberBody))`
	`64`	`+ if (!_codeBuilder.TryBuildPropertySetCodeBlock(variable, $"{interfaceName}_{variable.IdentifierName}", out var propertySet, Accessibility.Private, _memberBody))`
`65`	`65`	`{`
`66`	`66`	`throw new InvalidOperationException();`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,12 +56,12 @@ Private fuzz As ETestType2`
`56`	`56`	`StringAssert.Contains($"Property Get {testParams.Identifier}() As {typeName}", result);`
`57`	`57`	`}`
`58`	`58`
`59`		`- [TestCase("fizz", DeclarationType.Variable, "Integer", "Public")]`
`60`		`- [TestCase("FirstValue", DeclarationType.UserDefinedTypeMember, "Long", "Public")]`
`61`		`- [TestCase("fazz", DeclarationType.Variable, "Long", "Public")]`
`62`		`- [TestCase("fuzz", DeclarationType.Variable, "ETestType2", "Private")]`
	`59`	`+ [TestCase("fizz", DeclarationType.Variable, "Integer", Accessibility.Public)]`
	`60`	`+ [TestCase("FirstValue", DeclarationType.UserDefinedTypeMember, "Long", Accessibility.Public)]`
	`61`	`+ [TestCase("fazz", DeclarationType.Variable, "Long", Accessibility.Public)]`
	`62`	`+ [TestCase("fuzz", DeclarationType.Variable, "ETestType2", Accessibility.Private)]`
`63`	`63`	`[Category(nameof(CodeBuilder))]`
`64`		`- public void PropertyBlockFromPrototype_PropertyGetAccessibility(string targetIdentifier, DeclarationType declarationType, string typeName, string accessibility)`
	`64`	`+ public void PropertyBlockFromPrototype_PropertyGetAccessibility(string targetIdentifier, DeclarationType declarationType, string typeName, Accessibility accessibility)`
`65`	`65`	`{`
`66`	`66`	`var testParams = new PropertyBlockFromPrototypeParams("Bazz", DeclarationType.PropertyGet, accessibility);`
`67`	`67`	`string inputCode =`
`@@ -643,7 +643,7 @@ private static string ImprovedArgumentListTest(ModuleBodyElementDeclaration mbed`
`643`	`643`	`=> new CodeBuilder().ImprovedArgumentList(mbed);`
`644`	`644`
`645`	`645`	`private static string MemberBlockFromPrototypeTest(ModuleBodyElementDeclaration mbed, MemberBlockFromPrototypeTestParams testParams)`
`646`		`- => new CodeBuilder().BuildMemberBlockFromPrototype(mbed, testParams.Accessibility, testParams.Content, testParams.NewIdentifier);`
	`646`	`+ => new CodeBuilder().BuildMemberBlockFromPrototype(mbed, testParams.Content, testParams.Accessibility, testParams.NewIdentifier);`
`647`	`647`
`648`	`648`	`private (string procType, string endStmt) ProcedureTypeIdentifier(DeclarationType declarationType)`
`649`	`649`	`{`
`@@ -666,7 +666,7 @@ private static string MemberBlockFromPrototypeTest(ModuleBodyElementDeclaration`
`666`	`666`
`667`	`667`	`private struct PropertyBlockFromPrototypeParams`
`668`	`668`	`{`
`669`		`- public PropertyBlockFromPrototypeParams(string identifier, DeclarationType propertyType, string accessibility = null, string content = null, string paramIdentifier = null)`
	`669`	`+ public PropertyBlockFromPrototypeParams(string identifier, DeclarationType propertyType, Accessibility accessibility = Accessibility.Public, string content = null, string paramIdentifier = null)`
`670`	`670`	`{`
`671`	`671`	`Identifier = identifier;`
`672`	`672`	`DeclarationType = propertyType;`
`@@ -676,21 +676,21 @@ public PropertyBlockFromPrototypeParams(string identifier, DeclarationType prope`
`676`	`676`	`}`
`677`	`677`	`public DeclarationType DeclarationType { get; }`
`678`	`678`	`public string Identifier { get; }`
`679`		`- public string Accessibility {get; }`
	`679`	`+ public Accessibility Accessibility {get; }`
`680`	`680`	`public string Content { get; }`
`681`	`681`	`public string WriteParam { get; }`
`682`	`682`	`}`
`683`	`683`
`684`	`684`	`private struct MemberBlockFromPrototypeTestParams`
`685`	`685`	`{`
`686`		`- public MemberBlockFromPrototypeTestParams(ModuleBodyElementDeclaration mbed, string accessibility = null, string content = null, string newIdentifier = null)`
	`686`	`+ public MemberBlockFromPrototypeTestParams(ModuleBodyElementDeclaration mbed, Accessibility accessibility = Accessibility.Public, string content = null, string newIdentifier = null)`
`687`	`687`	`{`
`688`	`688`	`Accessibility = accessibility;`
`689`	`689`	`Content = content;`
`690`	`690`	`NewIdentifier = newIdentifier;`
`691`	`691`	`}`
`692`	`692`
`693`		`- public string Accessibility { get; }`
	`693`	`+ public Accessibility Accessibility { get; }`
`694`	`694`	`public string Content { get; }`
`695`	`695`	`public string NewIdentifier { get; }`
`696`	`696`	`}`