Merge lp:~mandel/wadlsharp/refactor_code_serialization into lp:wadlsharp/trunk

[Manuel de la Peña]

Refactored the serialization code to allow more options. Increased the code coverage.

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

review: Approve

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

review: Approve

=== added file 'LpNet.WadlSharp.Common/Interface/ICodeSerializer.cs'
--- LpNet.WadlSharp.Common/Interface/ICodeSerializer.cs	1970-01-01 00:00:00 +0000
+++ LpNet.WadlSharp.Common/Interface/ICodeSerializer.cs	2010-09-21 10:04:56 +0000
@@ -0,0 +1,60 @@
+/*
+ * The MIT License (MIT)
+ * 
+ * Copyright 2010 Canonical Ltd.
+ * 
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * Authors: Manuel de la Peña <[e-mail]>
+ */
+using System.CodeDom;
+using System.CodeDom.Compiler;
+using System.Collections.Generic;
+
+namespace LpNet.WadlSharp.Common.Interface
+{
+    /// <summary>
+    /// Interface to be implemented by those objects that know how to serialize
+    /// the generated code 
+    /// </summary>
+    public interface ICodeSerializer
+    {
+        /// <summary>
+        /// Gets the options to be used in the code generation.
+        /// </summary>
+        CodeGeneratorOptions Options { get; }
+
+        /// <summary>
+        /// Gets and sets the string that will use to state that the code was 
+        /// generated by a tool.
+        /// </summary>
+        string AutoGeneratedMessage { get; set; }
+
+        /// <summary>
+        /// Serializes the  given code and returns an enumerable with the names of the files
+        /// in which the code was serialized.
+        /// </summary>
+        /// <returns>The enumerable with the files in which the code was serialized.</returns>
+        IEnumerable<string> Serialize(CodeNamespace codeNamespace);
+    }
+
+}

=== modified file 'LpNet.WadlSharp.Common/Interface/IConverter.cs'
--- LpNet.WadlSharp.Common/Interface/IConverter.cs	2010-05-02 07:49:15 +0000
+++ LpNet.WadlSharp.Common/Interface/IConverter.cs	2010-09-21 10:04:56 +0000
@@ -27,8 +27,18 @@
 
 namespace LpNet.WadlSharp.Common.Interface
 {
+    /// <summary>
+    /// Interface to be implemented by an object that is able to generate the C# code required to use a 
+    /// wadl service.
+    /// </summary>
     public interface IConverter
     {
-        void Convert(string inputFileName, string outputFileName, string rootNamespace);
+        /// <summary>
+        /// Gets and sets the code serializer that will be used to serialize the code to a collection
+        /// of files.
+        /// </summary>
+        ICodeSerializer CodeSerializer { get; set; }
+
+        void Convert(string inputFileName, string rootNamespace);
     }
 }

=== modified file 'LpNet.WadlSharp.Common/LpNet.WadlSharp.Common.csproj'
--- LpNet.WadlSharp.Common/LpNet.WadlSharp.Common.csproj	2010-09-21 10:04:56 +0000
+++ LpNet.WadlSharp.Common/LpNet.WadlSharp.Common.csproj	2010-09-21 10:04:56 +0000
@@ -76,6 +76,7 @@
     <Compile Include="Interface\Generator\IParamater.cs" />
     <Compile Include="Interface\Generator\IProperty.cs" />
     <Compile Include="Interface\Generator\IReturn.cs" />
+    <Compile Include="Interface\ICodeSerializer.cs" />
     <Compile Include="Interface\IConverter.cs" />
     <Compile Include="Interface\ILoader.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
@@ -83,6 +84,7 @@
     <Compile Include="Resources\wadl.cs">
       <DependentUpon>wadl.xsd</DependentUpon>
     </Compile>
+    <Compile Include="Serialize\SingleFileCodeSerializer.cs" />
     <Compile Include="Utils.cs" />
     <Compile Include="WadlConverter.cs" />
     <Compile Include="WadlLoader.cs" />

=== added directory 'LpNet.WadlSharp.Common/Serialize'
=== added file 'LpNet.WadlSharp.Common/Serialize/SingleFileCodeSerializer.cs'
--- LpNet.WadlSharp.Common/Serialize/SingleFileCodeSerializer.cs	1970-01-01 00:00:00 +0000
+++ LpNet.WadlSharp.Common/Serialize/SingleFileCodeSerializer.cs	2010-09-21 10:04:56 +0000
@@ -0,0 +1,113 @@
+/*
+ * The MIT License (MIT)
+ * 
+ * Copyright 2010 Canonical Ltd.
+ * 
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * Authors: Manuel de la Peña <[e-mail]>
+ */
+using System.CodeDom;
+using System.CodeDom.Compiler;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+using LpNet.WadlSharp.Common.Interface;
+using Microsoft.CSharp;
+
+namespace LpNet.WadlSharp.Common.Serialize
+{
+    /// <summary>
+    /// Serializer that writes all the code that has been generated in a single file.
+    /// </summary>
+    public class SingleFileCodeSerializer : ICodeSerializer
+    {
+        #region Variables
+
+        private readonly string _outputFile;
+
+        #endregion
+
+        #region Construtors
+
+        /// <summary>
+        /// Creates a new serializer that will serialize the code in a single file.
+        /// </summary>
+        /// <param name="outputFile">The path in which the code will be serialized.</param>
+        public SingleFileCodeSerializer(string outputFile)
+        {
+            _outputFile = outputFile;
+            Options = new CodeGeneratorOptions();
+        }
+
+        #endregion
+
+        #region Implementation of ICodeSerializer
+
+        /// <summary>
+        /// Gets the options to be used in the code generation.
+        /// </summary>
+        public CodeGeneratorOptions Options { get; private set; }
+
+        /// <summary>
+        /// Gets and sets the string that will use to state that the code was 
+        /// generated by a tool.
+        /// </summary>
+        public string AutoGeneratedMessage { get;set; }
+
+        /// <summary>
+        /// Serializes the  given code and returns an enumerable with the names of the files
+        /// in which the code was serialized.
+        /// </summary>
+        /// <returns>The enumerable with the files in which the code was serialized.</returns>
+        public IEnumerable<string> Serialize(CodeNamespace codeNamespace)
+        {
+            var sb = new StringBuilder();
+            
+            var sw = new StringWriter(sb);
+
+            var provider = new CSharpCodeProvider();
+            provider.GenerateCodeFromNamespace(codeNamespace,
+                sw, Options);
+            var codeString = sb.ToString();
+            if (!string.IsNullOrEmpty(AutoGeneratedMessage))
+            {
+                codeString = string.Format("{0}\n{1}", AutoGeneratedMessage, codeString);
+                sb.Append(AutoGeneratedMessage);
+            }
+            var code = Encoding.ASCII.GetBytes(codeString);
+            var outputFileInfo = new FileInfo(_outputFile);
+            // if the files exists, delete it
+            if (outputFileInfo.Exists)
+            {
+                outputFileInfo.Delete();
+            }
+
+            using(var fileStream = new FileStream(outputFileInfo.FullName, FileMode.OpenOrCreate, FileAccess.Write))
+                fileStream.Write(code, 0, code.Length);
+
+            return new[] {_outputFile};
+        }
+
+        #endregion
+    }
+}

=== modified file 'LpNet.WadlSharp.Common/WadlConverter.cs'
--- LpNet.WadlSharp.Common/WadlConverter.cs	2010-09-17 16:07:11 +0000
+++ LpNet.WadlSharp.Common/WadlConverter.cs	2010-09-21 10:04:56 +0000
@@ -36,11 +36,8 @@
     using System.CodeDom;
     using Generator;
     using Interface.Generator;
-    using System.CodeDom.Compiler;
-    using System.Text;
-    using Microsoft.CSharp;
 
-    public class WadlConverter :IConverter
+    public class WadlConverter : IConverter
     {
         #region Vars
 
@@ -73,12 +70,17 @@
 
         #region IConverter Members
 
-        public void Convert(string inputFileName, string outputFileName, string rootNamespace)
+        /// <summary>
+        /// Gets and sets the code serializer that will be used to serialize the code to a collection
+        /// of files.
+        /// </summary>
+        public ICodeSerializer CodeSerializer { get; set; }
+
+        public void Convert(string inputFileName, string rootNamespace)
         {
             #region Check if the input file is correct or not
 
-            FileInfo inputFileInfo = new FileInfo(inputFileName);
-            FileInfo outputFileInfo = new FileInfo(outputFileName);
+            var inputFileInfo = new FileInfo(inputFileName);
 
             #endregion
 
@@ -96,36 +98,11 @@
 
             #endregion
 
-            #region Get the CSharpCodeProvider
-
-            CodeGeneratorOptions options = new CodeGeneratorOptions();
-            options.BracingStyle = "C";
-            options.IndentString = "    ";
-
-            StringBuilder sbCode = new StringBuilder();
-            StringWriter sw = new StringWriter(sbCode);
-
-            CSharpCodeProvider provider = new CSharpCodeProvider();
-            provider.GenerateCodeFromNamespace(nameSpace,
-                sw, options);
-
-            #endregion
-
-            #region Serialize the DOM
-
-            string finalCode = sbCode.ToString();
-
-            byte[] code = Encoding.ASCII.GetBytes(finalCode);
-
-            if(outputFileInfo.Exists)
-            {
-                outputFileInfo.Delete();
-            }
-
-            FileStream fileStream = new FileStream(outputFileInfo.FullName, FileMode.OpenOrCreate, FileAccess.Write);
-            fileStream.Write(code, 0, code.Length);
-
-            #endregion
+            // serialize the code using the serializer
+            CodeSerializer.Options.BracingStyle = "C";
+            CodeSerializer.Options.IndentString = "    ";
+            CodeSerializer.Serialize(nameSpace);
+
         }
 
         #endregion

=== modified file 'LpNet.WadlSharp.UnitTest/LpNet.WadlSharp.UnitTest.csproj'
--- LpNet.WadlSharp.UnitTest/LpNet.WadlSharp.UnitTest.csproj	2010-09-21 10:04:56 +0000
+++ LpNet.WadlSharp.UnitTest/LpNet.WadlSharp.UnitTest.csproj	2010-09-21 10:04:56 +0000
@@ -55,6 +55,7 @@
   <ItemGroup>
     <Compile Include="Generator\LpClassFactoryFixture.cs" />
     <Compile Include="Generator\LpNamespaceFixture.cs" />
+    <Compile Include="Serialize\SingleFileCodeSerializerFixture.cs" />
     <Compile Include="WadlLoaderTest.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>

=== added directory 'LpNet.WadlSharp.UnitTest/Serialize'
=== added file 'LpNet.WadlSharp.UnitTest/Serialize/SingleFileCodeSerializerFixture.cs'
--- LpNet.WadlSharp.UnitTest/Serialize/SingleFileCodeSerializerFixture.cs	1970-01-01 00:00:00 +0000
+++ LpNet.WadlSharp.UnitTest/Serialize/SingleFileCodeSerializerFixture.cs	2010-09-21 10:04:56 +0000
@@ -0,0 +1,111 @@
+/*
+ * The MIT License (MIT)
+ * 
+ * Copyright 2010 Canonical Ltd.
+ * 
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * Authors: Manuel de la Peña <[e-mail]>
+ */
+using System.CodeDom;
+using System.IO;
+using LpNet.WadlSharp.Common.Serialize;
+using NUnit.Framework;
+
+namespace LpNet.WadlSharp.UnitTest.Serialize
+{
+    [TestFixture]
+    public class SingleFileCodeSerializerFixture
+    {
+        #region Variables
+
+        private CodeNamespace _nameSpace;
+        private string _expectedOutput;
+        private string _outputFilePath;
+        private SingleFileCodeSerializer _serializer;
+
+        #endregion
+
+        #region Setup
+
+        [SetUp]
+        public void Setup()
+        {
+            _nameSpace = new CodeNamespace("TestNamespace");
+            _expectedOutput = "namespace TestNamespace\r\n{\r\n    \r\n}\r\n";
+            _outputFilePath = Path.GetTempFileName();
+            _serializer = new SingleFileCodeSerializer(_outputFilePath);
+        }
+
+        #endregion
+
+        #region Tests
+
+        [Test]
+        public void SerializeAutoGeneratedCommentTest()
+        {
+            // set the auto gen comment to ensure that it is present
+            var autogenComment = "/// autogenerated by a tool\r\n";
+
+            _serializer.AutoGeneratedMessage = autogenComment;
+            _serializer.Options.BracingStyle = "C";
+            _serializer.Options.IndentString = "    ";
+            _serializer.Serialize(_nameSpace);
+
+            Assert.IsTrue(File.Exists(_outputFilePath));
+            // read the contents of the file an assert they are the expected
+            var contents = File.ReadAllText(_outputFilePath);
+            var expected = string.Format("{0}\n{1}", autogenComment, _expectedOutput);
+            Assert.AreEqual(expected, contents);
+        }
+
+        [Test]
+        public void SerializeFileExistsTest()
+        {
+            // create the file to see if we do not have any issues
+            File.WriteAllText(_outputFilePath, "Test file!");
+            // serialize the code, make sure the file is created with the correct contents
+            _serializer.Options.BracingStyle = "C";
+            _serializer.Options.IndentString = "    ";
+            _serializer.Serialize(_nameSpace);
+            Assert.IsTrue(File.Exists(_outputFilePath));
+            // read the contents of the file an assert they are the expected
+            var contents = File.ReadAllText(_outputFilePath);
+            Assert.AreEqual(_expectedOutput, contents);
+        }
+
+        [Test]
+        public void SerializeTest()
+        {
+            // serialize the code, make sure the file is created with the correct contents
+            _serializer.Options.BracingStyle = "C";
+            _serializer.Options.IndentString = "    ";
+            _serializer.Serialize(_nameSpace);
+            Assert.IsTrue(File.Exists(_outputFilePath));
+            // read the contents of the file an assert they are the expected
+            var contents = File.ReadAllText(_outputFilePath);
+            Assert.AreEqual(_expectedOutput, contents);
+        }
+
+        #endregion
+    }
+}

=== modified file 'WadlConsole/Program.cs'
--- WadlConsole/Program.cs	2010-09-20 13:59:06 +0000
+++ WadlConsole/Program.cs	2010-09-21 10:04:56 +0000
@@ -30,6 +30,7 @@
 using System.IO;
 using System.Net;
 using LpNet.WadlSharp.Common;
+using LpNet.WadlSharp.Common.Serialize;
 using NDesk.Options;
 
 namespace Wadl
@@ -89,7 +90,8 @@
             {
                 converter = new WadlConverter();
             }
-            converter.Convert(inputFileName, outputFileName, rootNamespace);
+            converter.CodeSerializer = new SingleFileCodeSerializer(outputFileName);
+            converter.Convert(inputFileName, rootNamespace);
         }
 
         #endregion