Merge lp:~mandel/wadlsharp/fix_names into lp:~manishsinha/wadlsharp/trunk

[Manuel de la Peña]

Allows users to provide a command line parameter that will allow to fix the casing of the code by using PAscalCase notation. Other notations can be added to the code.

[Manish Sinha (मनीष सिन्हा) (manishsinha)]

Since this is implemented after implementing WadlConsole and WadlConsole itself is broken, so merging this will make introduce one feature and one defect.

The Fixing of names is really great except that WadlConsole project needs to be fixed first.

[Manish Sinha (मनीष सिन्हा) (manishsinha)]

Manual, can you try to merge this branch with trunk which is at r30 ATM. If it works, then please merge it yourself. Reviewing this merge request will take just too much of my time.

[Manuel de la Peña (mandel)]

Ok, no worries, I'll take care of it.

[Manish Sinha (मनीष सिन्हा) (manishsinha)]

Wait. This branch has been asked to merge in the wrong branch. It should be requested to merge in lp:wadlsharp and not lp:~manishsinha/wadlsharp/trunk

The correct merge request is at
https://code.launchpad.net/~mandel/wadlsharp/fix_names/+merge/36070

Manual, please try to merge it in lp:wadlsharp yourself because of the reason I told in the above comment. I am Disapproving this merge request as it asked to merge in the wrong branch.

review: Disapprove

[Manuel de la Peña (mandel)]

Cool, agree! it should not be merged to your personal branch but the teams one. I'll make sure everything is done in the correct branch.

Unmerged revisions

30. By Manuel de la Peña on 2010-09-17

Fixed issue with not using the identify generator for the results.

29. By Manuel de la Peña on 2010-09-17

Modified the code to allow the users to fix the casing of the generated code to follow naming conventions.

28. By Manuel de la Peña on 2010-09-17

Added implementation of console application that will allow user to automate the code generation.

27. By Manuel de la Peña on 2010-09-17

Ignore resharper user config.

26. By Manuel de la Peña on 2010-09-17

Added lib dependencies so that the contributors have no ref errors.

=== modified file 'LpNet.WadlSharp.Common/Generator/LpClass.cs'
--- LpNet.WadlSharp.Common/Generator/LpClass.cs	2010-05-02 07:16:04 +0000
+++ LpNet.WadlSharp.Common/Generator/LpClass.cs	2010-09-17 16:11:21 +0000
@@ -26,6 +26,8 @@
  ********************************************************************/
 
 
+using System;
+
 namespace LpNet.WadlSharp.Common.Generator
 {
     using System.CodeDom;
@@ -36,6 +38,36 @@
 
     public class LpClass : IClass
     {
+        #region Variables
+
+        private readonly Func<string, string> _createIdentifier;
+
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Creates a new instance of the class that will be use the 
+        /// basic identifier generator.
+        /// </summary>
+        public LpClass()
+            : this(WadlSharpUtils.CreateIdentifier)
+        {
+
+        }
+
+        /// <summary>
+        /// Creates a new instance of the class with the given identifier generator.
+        /// </summary>
+        /// <param name="createIdentifier">The generator that will create 
+        /// the identifiers used in the generated class.</param>
+        public LpClass(Func<string, string> createIdentifier)
+        {
+            _createIdentifier = createIdentifier;
+        }
+
+        #endregion
+
         #region IClass Members
 
         /// <summary>
@@ -47,12 +79,13 @@
         /// <returns>Instance of CodeTypeDeclaration</returns>
         public CodeTypeDeclaration Create(representation_type repType, HashSet<string> nameSpaces, CodeNamespace ns)
         {
-            CodeTypeDeclaration cdDec= new CodeTypeDeclaration();
-
-            cdDec.Name = WadlSharpUtils.CreateIdentifier(repType.id);
-            cdDec.IsClass = true;
-            cdDec.Attributes = MemberAttributes.Public | MemberAttributes.Static;
-            cdDec.IsPartial = true;
+            CodeTypeDeclaration cdDec= new CodeTypeDeclaration
+            {
+                Name = _createIdentifier(repType.id),
+                IsClass = true,
+                Attributes = MemberAttributes.Public | MemberAttributes.Static,
+                IsPartial = true
+            };
 
             #region Namespaces Import
 
@@ -85,12 +118,12 @@
                     if (param.option != null)
                     {
                         paramName = string.Format("{0}_{1}", cdDec.Name,
-                                                         WadlSharpUtils.CreateIdentifier(param.name));
+                                                         _createIdentifier(param.name));
 
                         CodeTypeMember existingEnum = LpMethod.CheckEnumExists(ns, param, paramName);
                         if (existingEnum == null)
                         {
-                            string enumName = WadlSharpUtils.CreateIdentifier(param.name);
+                            string enumName = _createIdentifier(param.name);
 
                             IEnum paramEnum = new LpEnum();
                             CodeTypeDeclaration memberEnum = paramEnum.Create(paramName, param.option, nameSpaces);
@@ -104,7 +137,7 @@
 
                     CodeMemberField field;
 
-                    IProperty property = new LpProperty();
+                    IProperty property = new LpProperty(_createIdentifier);
                     CodeMemberProperty prop = property.Create(param, out field, nameSpaces, ns, paramName);
 
                     propertiesList.Add(prop);
@@ -139,7 +172,7 @@
 
             #region The Class Definition and Properties
 
-            typeDeclaration.Name = WadlSharpUtils.CreateIdentifier(resourceType.id);
+            typeDeclaration.Name = _createIdentifier(resourceType.id);
             typeDeclaration.IsClass = true;
             typeDeclaration.Attributes = MemberAttributes.Public | MemberAttributes.Static;
             typeDeclaration.IsPartial = true;
@@ -177,7 +210,7 @@
 
                 foreach (method method in resourceType.method)
                 {
-                    IMethod lpmethod = new LpMethod();
+                    IMethod lpmethod = new LpMethod(_createIdentifier);
                     CodeMemberMethod memberMethod;
 
                     if (method.request != null && method.request.representation != null)
@@ -206,7 +239,7 @@
             {
                 foreach (param param in resourceType.param)
                 {
-                    IProperty paramInst = new LpProperty();
+                    IProperty paramInst = new LpProperty(_createIdentifier);
                     CodeMemberField field;
 
                     CodeMemberProperty prop = paramInst.Create(param, out field, nameSpaces, ns, string.Empty);

=== modified file 'LpNet.WadlSharp.Common/Generator/LpMethod.cs'
--- LpNet.WadlSharp.Common/Generator/LpMethod.cs	2010-05-02 07:16:04 +0000
+++ LpNet.WadlSharp.Common/Generator/LpMethod.cs	2010-09-17 16:11:21 +0000
@@ -24,26 +24,58 @@
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  * OTHER DEALINGS IN THE SOFTWARE.
  ********************************************************************/
-
+using System;
+using System.CodeDom;
+using System.Collections.Generic;
+using LpNet.WadlSharp.Common.Enum;
+using LpNet.WadlSharp.Common.Interface.Generator;
+using LpNet.WadlSharp.Common.Resources;
 
 namespace LpNet.WadlSharp.Common.Generator
 {
-    using System.CodeDom;
-    using System.Collections.Generic;
-    using Interface.Generator;
-    using Resources;
-    using Enum;
+    
 
     public class LpMethod : IMethod
     {
+        #region Vars
+
+        private readonly Func<string, string> _createIdentifier;
+
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Creates a new instance of the class with the basic identifier generator.
+        /// </summary>
+        public LpMethod()
+            : this(WadlSharpUtils.CreateIdentifier)
+        {
+
+        }
+
+        /// <summary>
+        /// Creates a new instance of the class that will use the passed 
+        /// identifier generator.
+        /// </summary>
+        /// <param name="createIdentifier">The identifier generator used to create the names of the methods.</param>
+        public LpMethod(Func<string, string> createIdentifier)
+        {
+            _createIdentifier = createIdentifier;
+        }
+
+        #endregion
+
         #region Public Methods Exposed by Interface
 
         public CodeMemberMethod Create(method methodInstance, HashSet<string> nameSpaces, CodeNamespace ns, CodeTypeDeclaration typeDeclaration)
         {
             // Create am instance of CodeMemberMethod and set it's name
-            CodeMemberMethod memberMethod = new CodeMemberMethod();
-            memberMethod.Name = WadlSharpUtils.CreateIdentifier(methodInstance.id);
-            memberMethod.Attributes = MemberAttributes.Public | MemberAttributes.Final;
+            CodeMemberMethod memberMethod = new CodeMemberMethod
+            {
+                Name = _createIdentifier(methodInstance.id),
+                Attributes = MemberAttributes.Public | MemberAttributes.Final
+            };
 
             typeDeclarationField = typeDeclaration;
 
@@ -110,9 +142,11 @@
             if (paramSet != null)
             {
                 // Create am instance of CodeMemberMethod and set it's name
-                CodeMemberMethod memberMethod = new CodeMemberMethod();
-                memberMethod.Name = WadlSharpUtils.CreateIdentifier(methodInstance.id);
-                memberMethod.Attributes = MemberAttributes.Public | MemberAttributes.Final;
+                CodeMemberMethod memberMethod = new CodeMemberMethod
+                {
+                    Name = _createIdentifier(methodInstance.id),
+                    Attributes = MemberAttributes.Public | MemberAttributes.Final
+                };
 
                 typeDeclarationField = typeDeclaration;
 
@@ -384,7 +418,7 @@
 
                         if (s.href != null)
                         {
-                            IReturn ret = new LpReturn();
+                            IReturn ret = new LpReturn(_createIdentifier);
 
                             memberMethod.ReturnType.BaseType = ret.Create(s, nameSpaces, ns);
                         }

=== modified file 'LpNet.WadlSharp.Common/Generator/LpNamespace.cs'
--- LpNet.WadlSharp.Common/Generator/LpNamespace.cs	2010-05-02 07:16:04 +0000
+++ LpNet.WadlSharp.Common/Generator/LpNamespace.cs	2010-09-17 16:11:21 +0000
@@ -25,6 +25,7 @@
  * OTHER DEALINGS IN THE SOFTWARE.
  ********************************************************************/
 
+using System;
 using LpNet.WadlSharp.Common.Custom;
 
 namespace LpNet.WadlSharp.Common.Generator
@@ -36,6 +37,35 @@
 
     public class LpNamespace : INamespace
     {
+        #region Vars
+
+        private readonly Func<string, string> _createIdentifier;
+
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Creates a new instance of the class with the basic identifier generator.
+        /// </summary>
+        public LpNamespace()
+            : this(WadlSharpUtils.CreateIdentifier)
+        {
+
+        }
+
+        /// <summary>
+        /// Creates a new instance of the class that will use the passed 
+        /// identifier generator.
+        /// </summary>
+        /// <param name="createIdentifier">The identifier generator used to create the names of the methods.</param>
+        public LpNamespace(Func<string, string> createIdentifier)
+        {
+            _createIdentifier = createIdentifier;
+        }
+
+        #endregion
+
         #region INamespace Members
 
         public CodeNamespace Create(application app, string namespaceName)
@@ -52,7 +82,7 @@
                 {
                     representation_type repType = item as representation_type;
 
-                    IClass customType = new LpClass();
+                    IClass customType = new LpClass(_createIdentifier);
                     CodeTypeDeclaration typeDec = customType.Create(repType, namespaces, ns);
 
                     ns.Types.Add(typeDec);
@@ -61,7 +91,7 @@
                 {
                     resource_type resType = item as resource_type;
 
-                    IClass customType = new LpClass();
+                    IClass customType = new LpClass(_createIdentifier);
                     CodeTypeDeclaration typeDec = customType.Create(resType, namespaces, ns);
                     
                     ns.Types.Add(typeDec);

=== modified file 'LpNet.WadlSharp.Common/Generator/LpProperty.cs'
--- LpNet.WadlSharp.Common/Generator/LpProperty.cs	2010-05-01 21:19:11 +0000
+++ LpNet.WadlSharp.Common/Generator/LpProperty.cs	2010-09-17 16:11:21 +0000
@@ -38,6 +38,31 @@
 
     public class LpProperty : IProperty
     {
+        #region Vars
+
+        private readonly Func<string, string> _createIdentifier;
+
+        #endregion
+
+        /// <summary>
+        /// Creates a new instance of the class with the basic identifier generator.
+        /// </summary>
+        public LpProperty()
+            : this(WadlSharpUtils.CreateIdentifier)
+        {
+
+        }
+
+        /// <summary>
+        /// Creates a new instance of the class that will use the passed 
+        /// identifier generator.
+        /// </summary>
+        /// <param name="createIdentifier">The identifier generator used to create the names of the methods.</param>
+        public LpProperty(Func<string, string> createIdentifier)
+        {
+            _createIdentifier = createIdentifier;
+        }
+
         #region IProperty Method
 
         public CodeMemberProperty Create(param propertyInstance, out CodeMemberField memberField, HashSet<string> nameSpaces, CodeNamespace ns, string propertyType)
@@ -67,7 +92,7 @@
 
             #endregion
 
-            property.Name = WadlSharpUtils.CreateIdentifier(propertyInstance.name);
+            property.Name = _createIdentifier(propertyInstance.name);
             property.Attributes = MemberAttributes.Public | MemberAttributes.Final;
             property.Type = new CodeTypeReference(dataType);
 
@@ -80,7 +105,8 @@
                                                                                        propertyInstance.link.resource_type)))));
             }
 
-            string fieldName = string.Format("_{0}", property.Name);
+            // always use camelcase for porperties
+            string fieldName = string.Format("_{0}", WadlSharpUtils.CreateCamelCaseIdentifier(propertyInstance.name));
             property.GetStatements.Add(new CodeMethodReturnStatement(new CodeFieldReferenceExpression(new CodeThisReferenceExpression(), fieldName)));
             property.SetStatements.Add(new CodeAssignStatement(new CodeFieldReferenceExpression(new CodeThisReferenceExpression(), fieldName), new CodePropertySetValueReferenceExpression()));
 

=== modified file 'LpNet.WadlSharp.Common/Generator/LpReturn.cs'
--- LpNet.WadlSharp.Common/Generator/LpReturn.cs	2010-04-23 13:16:28 +0000
+++ LpNet.WadlSharp.Common/Generator/LpReturn.cs	2010-09-17 16:11:21 +0000
@@ -26,16 +26,43 @@
  ********************************************************************/
 
 
+using System;
+using System.Collections.Generic;
+using System.Data;
+using LpNet.WadlSharp.Common.Interface.Generator;
+using LpNet.WadlSharp.Common.Resources;
+using System.CodeDom;
+
 namespace LpNet.WadlSharp.Common.Generator
 {
-    using System.Collections.Generic;
-    using System.Data;
-    using Interface.Generator;
-    using Resources;
-    using System.CodeDom;
+    
 
     public class LpReturn : IReturn
     {
+        #region Vars
+
+        private readonly Func<string, string> _createIdentifier;
+
+        #endregion
+
+        /// <summary>
+        /// Creates a new instance of the class with the basic identifier generator.
+        /// </summary>
+        public LpReturn()
+            : this(WadlSharpUtils.CreateIdentifier)
+        {
+
+        }
+
+        /// <summary>
+        /// Creates a new instance of the class that will use the passed 
+        /// identifier generator.
+        /// </summary>
+        /// <param name="createIdentifier">The identifier generator used to create the names of the methods.</param>
+        public LpReturn(Func<string, string> createIdentifier)
+        {
+            _createIdentifier = createIdentifier;
+        }
         #region IReturn Members
 
         /// <summary>
@@ -50,7 +77,7 @@
             if (hashPos != -1)
             {
                 string href = repType.href.Substring(hashPos + 1);
-                href = WadlSharpUtils.CreateIdentifier(href);
+                href = _createIdentifier(href);
 
                 return href;
             }

=== modified file 'LpNet.WadlSharp.Common/Utils.cs'
--- LpNet.WadlSharp.Common/Utils.cs	2010-05-02 07:16:04 +0000
+++ LpNet.WadlSharp.Common/Utils.cs	2010-09-17 16:11:21 +0000
@@ -26,12 +26,12 @@
  ********************************************************************/
 
 
-
+using System.Text;
+using System.Text.RegularExpressions;
+using LpNet.WadlSharp.Common.Enum;
 
 namespace LpNet.WadlSharp.Common
 {
-    using System.Text.RegularExpressions;
-    using Enum;
 
     public class WadlSharpUtils
     {
@@ -49,6 +49,44 @@
             return filteredString;
         }
 
+        public static string CreateCamelCaseIdentifier(string methodCandidate)
+        {
+            var splittedPhrase = methodCandidate.Split(' ', '-', '.', '_');
+            var sb = new StringBuilder();
+
+            sb.Append(splittedPhrase[0].ToLower());
+
+            for (var index = 1; index < splittedPhrase.Length; index++)
+            {
+                var s = splittedPhrase[index];
+                var splittedPhraseChars = s.ToCharArray();
+                if (splittedPhraseChars.Length > 0)
+                {
+                    splittedPhraseChars[0] = ((new string(splittedPhraseChars[0], 1)).ToUpper().ToCharArray())[0];
+                }
+                sb.Append(new string(splittedPhraseChars));
+            }
+
+            return sb.ToString();
+        }
+
+        public static string CreatePascalCaseIdentifier(string methodCandidate)
+        {
+            var splittedCancidate = methodCandidate.Split(' ', '-', '.', '_');
+            var sb = new StringBuilder();
+            foreach (var currentNamePart in splittedCancidate)
+            {
+                var splittedPhraseChars = currentNamePart.ToCharArray();
+                if (splittedPhraseChars.Length > 0)
+                {
+                    splittedPhraseChars[0] = ((new string(splittedPhraseChars[0], 1)).ToUpper().ToCharArray())[0];
+                }
+                sb.Append(new string(splittedPhraseChars));
+            }
+
+            return sb.ToString();
+        }
+
         public static string FilterComments(string commentString)
         {
             string filteredText = commentString.Replace("\n", "");
@@ -83,7 +121,7 @@
 
         public static HttpMethodType ParseHttpMethod(string methodName)
         {
-            HttpMethodType method = (HttpMethodType)System.Enum.Parse(typeof (HttpMethodType), methodName);
+            HttpMethodType method = (HttpMethodType)System.Enum.Parse(typeof(HttpMethodType), methodName);
 
             return method;
         }

=== modified file 'LpNet.WadlSharp.Common/WadlConverter.cs'
--- LpNet.WadlSharp.Common/WadlConverter.cs	2010-09-17 11:19:00 +0000
+++ LpNet.WadlSharp.Common/WadlConverter.cs	2010-09-17 16:11:21 +0000
@@ -26,6 +26,8 @@
  ********************************************************************/
 
 
+using System;
+
 namespace LpNet.WadlSharp.Common
 {
     using Interface;
@@ -40,6 +42,35 @@
 
     public class WadlConverter :IConverter
     {
+        #region Vars
+
+        private readonly Func<string, string> _createIdentifier;
+
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Creates a new instance of the class with the basic identifier generator.
+        /// </summary>
+        public WadlConverter()
+            : this(WadlSharpUtils.CreateIdentifier)
+        {
+
+        }
+
+        /// <summary>
+        /// Creates a new instance of the class that will use the passed 
+        /// identifier generator.
+        /// </summary>
+        /// <param name="createIdentifier">The identifier generator used to create the names of the methods.</param>
+        public WadlConverter(Func<string, string> createIdentifier)
+        {
+            _createIdentifier = createIdentifier;
+        }
+
+        #endregion
+
         #region IConverter Members
 
         public void Convert(string inputFileName, string outputFileName, string rootNamespace)
@@ -60,7 +91,7 @@
 
             #region Create the Code File's DOM
 
-            INamespace nsp = new LpNamespace();
+            INamespace nsp = new LpNamespace(_createIdentifier);
             CodeNamespace nameSpace = nsp.Create(app, rootNamespace);
 
             #endregion

=== modified file 'WadlConsole/Program.cs'
--- WadlConsole/Program.cs	2010-09-17 16:11:21 +0000
+++ WadlConsole/Program.cs	2010-09-17 16:11:21 +0000
@@ -77,9 +77,18 @@
         /// <param name="outputFileName">The filename of the .cs file. If the file does not exist, 
         /// it would be created. If it does exist, it would be truncated and then overwritten.</param>
         /// <param name="rootNamespace">The name of the namespace which you would like the generated code to have.</param>
-        private static void GenerateCode(string inputFileName, string outputFileName, string rootNamespace)
+        /// <param name="fixCase">A flag that states if the case of the generated code should be fixed.</param>
+        private static void GenerateCode(string inputFileName, string outputFileName, string rootNamespace, bool fixCase)
         {
-            var converter = new WadlConverter();
+            WadlConverter converter;
+            if(fixCase)
+            {
+                converter = new WadlConverter(WadlSharpUtils.CreatePascalCaseIdentifier);
+            }
+            else
+            {
+                converter = new WadlConverter();
+            }
             converter.Convert(inputFileName, outputFileName, rootNamespace);
         }
 
@@ -91,14 +100,16 @@
             var outputFile = "";
             var rootNamespace = "";
             var input = "";
-            var help   = false;
+            var help = false;
+            var fixCase = false;
 
             // create the option set that will provide the diff options
             // of the command line
             var options = new OptionSet
             {
                 { "i|input=", Resources.InputDescription, v => input = v },
-                { "u|url", Resources.UrlDescription, v=> isFile = false },
+                { "u|url", Resources.UrlDescription, v => isFile = false },
+                { "c|fixCase", Resources.FixCaseDescription, v => fixCase = v != null  },
                 { "o|output=", Resources.OutputDescription, v=> outputFile = v },
                 { "n|namespace=", Resources.NamespaceDescription, v=> rootNamespace = v },
                 { "h|?|help", Resources.HelpDescription, v => help = v != null },
@@ -143,7 +154,7 @@
             }
 
             // eveyhthin is ok, therefore we generate the code
-            GenerateCode(input, outputFile, rootNamespace);
+            GenerateCode(input, outputFile, rootNamespace, fixCase);
             Console.WriteLine(Resources.Completed);
         }
     }

=== modified file 'WadlConsole/Resources.Designer.cs'
--- WadlConsole/Resources.Designer.cs	2010-09-17 16:11:21 +0000
+++ WadlConsole/Resources.Designer.cs	2010-09-17 16:11:21 +0000
@@ -70,6 +70,15 @@
         }
         
         /// <summary>
+        ///   Looks up a localized string similar to A boolean flag stating if the case of the generated code should be fixed..
+        /// </summary>
+        internal static string FixCaseDescription {
+            get {
+                return ResourceManager.GetString("FixCaseDescription", resourceCulture);
+            }
+        }
+        
+        /// <summary>
         ///   Looks up a localized string similar to Usage: wadl-sharp [OPTIONS]
         ///
         ///Generates the C# code required to communicate with a wadl service.
@@ -109,7 +118,7 @@
         }
         
         /// <summary>
-        ///   Looks up a localized string similar to The fiilename of the .cs file to be generated. If the file does not exist, it would be created. If it does exist, it would be truncated and then overwritten..
+        ///   Looks up a localized string similar to The filename of the .cs file to be generated. If the file does not exist, it would be created. If it does exist, it would be truncated and then overwritten..
         /// </summary>
         internal static string OutputDescription {
             get {

=== modified file 'WadlConsole/Resources.resx'
--- WadlConsole/Resources.resx	2010-09-17 16:11:21 +0000
+++ WadlConsole/Resources.resx	2010-09-17 16:11:21 +0000
@@ -120,6 +120,9 @@
   <data name="Completed" xml:space="preserve">
     <value>Generation completed.</value>
   </data>
+  <data name="FixCaseDescription" xml:space="preserve">
+    <value>A boolean flag stating if the case of the generated code should be fixed.</value>
+  </data>
   <data name="Help" xml:space="preserve">
     <value>Usage: wadl-sharp [OPTIONS]
 
@@ -136,7 +139,7 @@
     <value>The name of the namespace which you would like the generated code to have.</value>
   </data>
   <data name="OutputDescription" xml:space="preserve">
-    <value>The fiilename of the .cs file to be generated. If the file does not exist, it would be created. If it does exist, it would be truncated and then overwritten.</value>
+    <value>The filename of the .cs file to be generated. If the file does not exist, it would be created. If it does exist, it would be truncated and then overwritten.</value>
   </data>
   <data name="TryHelp" xml:space="preserve">
     <value>Try `wadl-sharp --help' for more information.</value>