Updated Builder intreface with GeneratePdbSteram

function

Author: shehrozeee

Pack.ps1

@@ -1,4 +1,4 @@
 dotnet build -c Release
 dotnet test
 dotnet pack -c Release -o artifacts RazorEngineCore\RazorEngineCore.csproj -p:symbolPackageFormat=snupkg --include-symbols
-dotnet nuget push artifacts\RazorEngineCore.2022.8.1.nupkg --source https://www.nuget.org/api/v2/package -k KEY
+dotnet nuget push artifacts\RazorEngineCore.2022.8.1.nupkg --source https://www.nuget.org/api/v2/package -k KEY

README.md

@@ -209,22 +209,20 @@ string result = compiledTemplate.Run(new { name = "Hello" });
 ```
 
 #### Debugging templates
-Add the following line in your template source and your debugger(vs code/vs studio) break on it.
-```cs
-System.Diagnostics.Debugger.Break();
-```
-Use this overload for the Compile function and pass true for the addPdb argument
+In the builder options, set GeneratePdbStream to true, and set the TemplateFilename.
 ```cs
 razorEngine.Compile(templateSource, builder =>
 {
-    builder.AddAssemblyReferenceByName("System.Security"); // by name
-    builder.AddAssemblyReference(typeof(System.IO.File)); // by type
-    builder.AddAssemblyReference(Assembly.Load("source")); // by reference
-},
-true); //This 'true' will enable debugging.
+    builder.Options.GeneratePdbStream = true;
+    builder.Options.TemplateFilename = "TemplateFilename.cshtml"
+});
 ```
-Your debbuger will ask you to provide the path to the source file, by defult it is set to be generated in %temp% (point your there when asked for the file). 
+Your debugger will popup a window asking you to find the source file, after which you can step through as normal. 
 
+To set a breakpoint add this line in a code block in the template.
+```cs
+System.Diagnostics.Debugger.Break();
+```
 
 #### Credits
 This package is inspired by [Simon Mourier SO post](https://stackoverflow.com/a/47756437/267736)

RazorEngineCore/IRazorEngineCompilationOptionsBuilder.cs

@@ -14,5 +14,6 @@ public interface IRazorEngineCompilationOptionsBuilder
         void AddMetadataReference(MetadataReference reference);
         void AddUsing(string namespaceName);
         void Inherits(Type type);
+        void GeneratePdbSteram(bool flag);
     }
 }

RazorEngineCore/RazorEngine.cs

@@ -14,33 +14,37 @@ namespace RazorEngineCore
 {
     public class RazorEngine : IRazorEngine
     {
-        public IRazorEngineCompiledTemplate<T> Compile<T>(string content, Action<IRazorEngineCompilationOptionsBuilder> builderAction = null) where T : IRazorEngineTemplate
+        public IRazorEngineCompiledTemplate<T> Compile<T>(string content, Action<IRazorEngineCompilationOptionsBuilder> builderAction = null, bool addPdb = false) where T : IRazorEngineTemplate
         {
             IRazorEngineCompilationOptionsBuilder compilationOptionsBuilder = new RazorEngineCompilationOptionsBuilder();
             compilationOptionsBuilder.AddAssemblyReference(typeof(T).Assembly);
             compilationOptionsBuilder.Inherits(typeof(T));
 
             builderAction?.Invoke(compilationOptionsBuilder);
-
-            CompiledStreams streams = this.CreateAndCompileToStream(content, compilationOptionsBuilder.Options);
-            return new RazorEngineCompiledTemplate<T>(streams.assembly, compilationOptionsBuilder.Options.TemplateNamespace);
+            if (compilationOptionsBuilder.Options.GeneratePdbStream)
+            {
+                CompiledStreams streams = this.CreateAndCompileToStream(content, compilationOptionsBuilder.Options);
+                return new RazorEngineCompiledTemplate<T>(streams.assembly, compilationOptionsBuilder.Options.TemplateNamespace, streams.pdb);
+            }
+            else
+            {
+                CompiledStreams streams = this.CreateAndCompileToStream(content, compilationOptionsBuilder.Options);
+                return new RazorEngineCompiledTemplate<T>(streams.assembly, compilationOptionsBuilder.Options.TemplateNamespace);
+            }
         }
 
         public Task<IRazorEngineCompiledTemplate<T>> CompileAsync<T>(string content, Action<IRazorEngineCompilationOptionsBuilder> builderAction = null) where T : IRazorEngineTemplate
         {
             return Task.Factory.StartNew(() => this.Compile<T>(content: content, builderAction: builderAction));
         }
-        public IRazorEngineCompiledTemplate Compile(string content, Action<IRazorEngineCompilationOptionsBuilder> builderAction = null)
-        {
-            return Compile(content, builderAction, false);
-        }
+
         public IRazorEngineCompiledTemplate Compile(string content, Action<IRazorEngineCompilationOptionsBuilder> builderAction = null, bool addPdb = false)
         {
             IRazorEngineCompilationOptionsBuilder compilationOptionsBuilder = new RazorEngineCompilationOptionsBuilder();
             compilationOptionsBuilder.Inherits(typeof(RazorEngineTemplateBase));
 
             builderAction?.Invoke(compilationOptionsBuilder);
-            if (compilationOptionsBuilder.Options.GeneratePdbSteram)
+            if (compilationOptionsBuilder.Options.GeneratePdbStream)
             {
                 CompiledStreams streams = this.CreateAndCompileToStream(content, compilationOptionsBuilder.Options);
                 return new RazorEngineCompiledTemplate(streams.assembly, compilationOptionsBuilder.Options.TemplateNamespace, streams.pdb);
@@ -62,12 +66,12 @@ protected virtual CompiledStreams CreateAndCompileToStream(string templateSource
         {
             templateSource = this.WriteDirectives(templateSource, options);
             string projectPath = @".";
-            string fileName = Path.GetRandomFileName()+".cshtml";
-            if (options.GeneratePdbSteram)
+            string pdbfileName = Path.GetRandomFileName() + ".cshtml";
+            if (options.GeneratePdbStream)
             {
                 projectPath = Path.GetTempPath();
                 Directory.CreateDirectory(projectPath);
-                File.WriteAllText(Path.Combine(projectPath, fileName), templateSource);
+                File.WriteAllText(Path.Combine(projectPath, pdbfileName), templateSource);
             }
 
             RazorProjectEngine engine = RazorProjectEngine.Create(
@@ -119,7 +123,7 @@ protected virtual CompiledStreams CreateAndCompileToStream(string templateSource
                 new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary));
             CompiledStreams streams = new CompiledStreams();
             EmitResult emitResult;
-            if (options.GeneratePdbSteram)
+            if (options.GeneratePdbStream)
                 emitResult = compilation.Emit(streams.assembly, streams.pdb);
             else
                 emitResult = compilation.Emit(streams.assembly);
@@ -136,7 +140,7 @@ protected virtual CompiledStreams CreateAndCompileToStream(string templateSource
             }
 
             streams.assembly.Position = 0;
-            if(options.GeneratePdbSteram)
+            if(options.GeneratePdbStream)
                 streams.pdb.Position = 0;
             return streams;
         }
@@ -156,7 +160,7 @@ protected virtual string WriteDirectives(string content, RazorEngineCompilationO
             return stringBuilder.ToString();
         }
 
-        private class CompiledStreams
+        protected class CompiledStreams
         {
             public CompiledStreams()
             {

RazorEngineCore/RazorEngineCompilationOptions.cs

@@ -15,7 +15,7 @@ public class RazorEngineCompilationOptions
         public string TemplateFilename { get; set; } = "";
         public string Inherits { get; set; } = "RazorEngineCore.RazorEngineTemplateBase";
         ///Set to true to generate PDB symbols information along with the assembly for debugging support
-        public bool GeneratePdbSteram {get;set;} = false;
+        public bool GeneratePdbStream {get;set;} = false;
         public HashSet<string> DefaultUsings { get; set; } = new HashSet<string>()
         {
             "System.Linq",

RazorEngineCore/RazorEngineCompilationOptionsBuilder.cs

@@ -92,5 +92,10 @@ private string RenderDeclaringType(Type type)
 
             return parent + "." + type.Name;
         }
+        
+        public void GeneratePdbSteram(bool flag)
+        {
+            this.Options.GeneratePdbStream = flag;
+        }
     }
-}
+}

RazorEngineCore/RazorEngineCompiledTemplateT.cs

@@ -16,6 +16,13 @@ internal RazorEngineCompiledTemplate(MemoryStream assemblyByteCode, string templ
 
             Assembly assembly = Assembly.Load(assemblyByteCode.ToArray());
             this.templateType = assembly.GetType($"{templateNamespace}.Template");
+        }
+        internal RazorEngineCompiledTemplate(MemoryStream assemblyByteCode, string templateNamespace, MemoryStream pdbByteCode)
+        {
+            this.assemblyByteCode = assemblyByteCode;
+
+            Assembly assembly = Assembly.Load(assemblyByteCode.ToArray(), pdbByteCode.ToArray());
+            this.templateType = assembly.GetType(templateNamespace + ".Template");
         }
 
         public static IRazorEngineCompiledTemplate<T> LoadFromFile(string fileName, string templateNamespace = "TemplateNamespace")