Add DefaultPropertyValueParamIdentifier property

Exposes a single method for generating a default Let\Set RHS
property parameter IdentifierName.

Author: BZngr

Rubberduck.Refactorings/Common/CodeBuilder.cs

@@ -1,4 +1,5 @@
-using Rubberduck.Parsing.Grammar;
+using Rubberduck.Common;
+using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
 using System;
 using System.Collections.Generic;
@@ -11,19 +12,13 @@ public interface ICodeBuilder
         /// <summary>
         /// Returns ModuleBodyElementDeclaration signature with an ImprovedArgument list
         /// </summary>
-        /// <param name="declaration"></param>
-        /// <returns></returns>
         string ImprovedFullMemberSignature(ModuleBodyElementDeclaration declaration);
 
         /// <summary>
         /// Returns a ModuleBodyElementDeclaration block
         /// with an ImprovedArgument List
         /// </summary>
-        /// <param name="declaration"></param>
         /// <param name="content">Main body content/logic of the member</param>
-        /// <param name="accessibility"></param>
-        /// <param name="newIdentifier"></param>
-        /// <returns></returns>
         string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declaration,
                                             string content = null,
                                             string accessibility = null,
@@ -34,19 +29,14 @@ string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declaration,
         /// 1. Explicitly declares Property Let\Set value parameter as ByVal
         /// 2. Ensures UserDefined Type parameters are declared either explicitly or implicitly as ByRef
         /// </summary>
-        /// <param name="declaration"></param>
-        /// <returns></returns>
         string ImprovedArgumentList(ModuleBodyElementDeclaration declaration);
 
         /// <summary>
         /// Generates a Property Get codeblock based on the prototype declaration 
         /// </summary>
         /// <param name="prototype">VariableDeclaration or UserDefinedTypeMember</param>
-        /// <param name="propertyIdentifier"></param>
-        /// <param name="accessibility"></param>
         /// <param name="content">Member body content.  Formatting is the responsibility of the caller</param>
-        /// <param name="parameterIdentifier">Defaults to 'value' unless otherwise specified</param>
-        /// <returns></returns>
+        /// <param name="parameterIdentifier">Defaults to '<paramref name="propertyIdentifier"/>Value' unless otherwise specified</param>
         bool TryBuildPropertyGetCodeBlock(Declaration prototype,
                                             string propertyIdentifier,
                                             out string codeBlock,
@@ -57,11 +47,8 @@ bool TryBuildPropertyGetCodeBlock(Declaration prototype,
         /// Generates a Property Let codeblock based on the prototype declaration 
         /// </summary>
         /// <param name="prototype">VariableDeclaration or UserDefinedTypeMember</param>
-        /// <param name="propertyIdentifier"></param>
-        /// <param name="accessibility"></param>
-        /// <param name="content">Membmer body content.  Formatting is the responsibility of the caller</param>
-        /// <param name="parameterIdentifier">Defaults to 'value' unless otherwise specified</param>
-        /// <returns></returns>
+        /// <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>
         bool TryBuildPropertyLetCodeBlock(Declaration prototype,
                                             string propertyIdentifier,
                                             out string codeBlock,
@@ -73,21 +60,28 @@ bool TryBuildPropertyLetCodeBlock(Declaration prototype,
         /// Generates a Property Set codeblock based on the prototype declaration 
         /// </summary>
         /// <param name="prototype">VariableDeclaration or UserDefinedTypeMember</param>
-        /// <param name="propertyIdentifier"></param>
-        /// <param name="accessibility"></param>
-        /// <param name="content">Membmer body content.  Formatting is the responsibility of the caller</param>
-        /// <param name="parameterIdentifier">Defaults to 'value' unless otherwise specified</param>
-        /// <returns></returns>
+        /// <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>
         bool TryBuildPropertySetCodeBlock(Declaration prototype,
                                             string propertyIdentifier,
                                             out string codeBlock,
                                             string accessibility = null,
                                             string content = null,
                                             string parameterIdentifier = null);
+        /// <summary>
+        /// Generates a default RHS property parameter IdentifierName
+        /// </summary>
+        /// <param name="propertyIdentifier">Let/Set Property IdentifierName</param>
+        string DefaultPropertyValueParamIdentifier(string propertyIdentifier);
     }
 
     public class CodeBuilder : ICodeBuilder
     {
+        private static string ParameterSuffix => Resources.RubberduckUI.EncapsulateField_DefaultPropertyParameter.Capitalize();
+
+        public string DefaultPropertyValueParamIdentifier(string propertyIdentifier)
+            => $"{propertyIdentifier.ToLowerCaseFirstLetter()}{ParameterSuffix}";
+
         public string BuildMemberBlockFromPrototype(ModuleBodyElementDeclaration declaration, 
                                         string content = null, 
                                         string accessibility = null, 
@@ -127,7 +121,7 @@ private bool TryBuildPropertyBlockFromTarget<T>(T prototype, DeclarationType let
                 return false;
             }
 
-            var propertyValueParam = parameterIdentifier ?? Resources.RubberduckUI.EncapsulateField_DefaultPropertyParameter;
+            var propertyValueParam = parameterIdentifier ?? DefaultPropertyValueParamIdentifier(propertyIdentifier);
 
             var asType = prototype.IsArray
                 ? $"{Tokens.Variant}"

RubberduckTests/CodeBuilderTests.cs

@@ -1,4 +1,5 @@
 using NUnit.Framework;
+using Rubberduck.Common;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Refactorings;
 using RubberduckTests.Mocks;
@@ -10,6 +11,7 @@ namespace RubberduckTests
     [TestFixture]
     public class CodeBuilderTests
     {
+        private static string Param(string property) => $"{property.ToLowerCaseFirstLetter()}Value";
 
         [TestCase("fizz", DeclarationType.Variable, "Integer")]
         [TestCase("FirstValue", DeclarationType.UserDefinedTypeMember, "Long")]
@@ -192,8 +194,7 @@ Private fuzz As ETestType2
                                                         declarationType,
                                                         testParams,
                                                         PropertyLetBlockFromPrototypeTest);
-
-            StringAssert.Contains($"Property Let {testParams.Identifier}(ByVal value As {typeName})", result);
+            StringAssert.Contains($"Property Let {testParams.Identifier}(ByVal {Param(testParams.Identifier)} As {typeName})", result);
         }
 
         [TestCase("fizz", DeclarationType.Variable, "Variant")]
@@ -219,7 +220,7 @@ Private fizz As Variant
                                                         testParams,
                                                         PropertySetBlockFromPrototypeTest);
 
-            StringAssert.Contains($"Property Set {testParams.Identifier}(ByVal value As {typeName})", result);
+            StringAssert.Contains($"Property Set {testParams.Identifier}(ByVal {Param(testParams.Identifier)} As {typeName})", result);
         }
 
         [TestCase(DeclarationType.PropertyLet)]