[Add] string output to Mardkown and HTML Generators

ECoreNetto.Reporting/ECoreNetto.Reporting.csproj

@@ -6,7 +6,7 @@
         <Company>Starion Group S.A.</Company>
         <Copyright>Copyright © Starion Group S.A.</Copyright>
         <Title>ECoreNetto.Reporting</Title>
-        <Version>5.0.0</Version>
+        <Version>5.1.0</Version>
         <Description>Ecore Reporting use in combination with the ECoreNetto library generate reports</Description>
         <PackageId>ECoreNetto.Reporting</PackageId>
         <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
@@ -23,7 +23,7 @@
         <Authors>Sam Gerene</Authors>
         <PackageTags>Ecore HandleBars Reporting</PackageTags>
         <PackageReleaseNotes>
-            [Add] Report Generators
+            [Add] string output to HTML and Markdown reporters
         </PackageReleaseNotes>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>

ECoreNetto.Reporting/Generators/HtmlReportGenerator.cs

@@ -64,23 +64,18 @@ public string QueryReportType()
         /// Generates a table that contains all classes, attributes and their documentation
         /// </summary>
         /// <param name="modelPath">
-        /// the path to the Ecore model of which the report is to be generated.
+        /// /// the path to the Ecore model of which the report is to be generated.
         /// </param>
-        /// <param name="outputPath">
-        /// the path, including filename, where the output is to be generated.
-        /// </param>
-        public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
+        /// <returns>
+        /// the content of an HTML report in a string
+        /// </returns>
+        public string GenerateReport(FileInfo modelPath)
         {
             if (modelPath == null)
             {
                 throw new ArgumentNullException(nameof(modelPath));
             }
 
-            if (outputPath == null)
-            {
-                throw new ArgumentNullException(nameof(outputPath));
-            }
-
             var sw = Stopwatch.StartNew();
 
             this.logger.LogInformation("Start Generating Html report tables");
@@ -93,6 +88,31 @@ public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
 
             var generatedHtml = template(payload);
 
+            this.logger.LogInformation("Generated HTML report in {ElapsedTime} [ms]", sw.ElapsedMilliseconds);
+
+            return generatedHtml;
+        }
+
+        /// <summary>
+        /// Generates a table that contains all classes, attributes and their documentation
+        /// </summary>
+        /// <param name="modelPath">
+        /// the path to the Ecore model of which the report is to be generated.
+        /// </param>
+        /// <param name="outputPath">
+        /// the path, including filename, where the output is to be generated.
+        /// </param>
+        public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
+        {
+            if (outputPath == null)
+            {
+                throw new ArgumentNullException(nameof(outputPath));
+            }
+
+            var sw = Stopwatch.StartNew();
+
+            var generatedHtml = this.GenerateReport(modelPath);
+
             if (outputPath.Exists)
             {
                 outputPath.Delete();
@@ -101,7 +121,7 @@ public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
             using var writer = outputPath.CreateText();
             writer.Write(generatedHtml);
 
-            this.logger.LogInformation("Generated HTML report in {ElapsedTime} [ms]", sw.ElapsedMilliseconds);
+            this.logger.LogInformation("Generated and saved HTML report in {ElapsedTime} [ms]", sw.ElapsedMilliseconds);
         }
 
         /// <summary>

ECoreNetto.Reporting/Generators/IHtmlReportGenerator.cs

@@ -20,11 +20,23 @@
 
 namespace ECoreNetto.Reporting.Generators
 {
+    using System.IO;
+
     /// <summary>
     /// The purpose of the <see cref="IHtmlReportGenerator"/> is to generate an HTML report of an
     /// Ecore Model
     /// </summary>
     public interface IHtmlReportGenerator : IReportGenerator
     {
+        /// <summary>
+        /// Generates a table that contains all classes, attributes and their documentation
+        /// </summary>
+        /// <param name="modelPath">
+        /// /// the path to the Ecore model of which the report is to be generated.
+        /// </param>
+        /// <returns>
+        /// the content of an HTML report in a string
+        /// </returns>
+        public string GenerateReport(FileInfo modelPath);
     }
 }

ECoreNetto.Reporting/Generators/IMarkdownReportGenerator.cs

@@ -20,11 +20,23 @@
 
 namespace ECoreNetto.Reporting.Generators
 {
+    using System.IO;
+
     /// <summary>
     /// The purpose of the <see cref="IMarkdownReportGenerator"/> is to generate a Markdown report of an
     /// Ecore Model
     /// </summary>
     public interface IMarkdownReportGenerator : IReportGenerator
     {
+        /// <summary>
+        /// Generates a Markdown document with a table that contains all classes, attributes and their documentation
+        /// </summary>
+        /// <param name="modelPath">
+        /// the path to the Ecore model of which the report is to be generated.
+        /// </param>
+        /// <returns>
+        /// the content of a Markdown report in a string
+        /// </returns>
+        public string GenerateReport(FileInfo modelPath);
     }
 }

ECoreNetto.Reporting/Generators/MarkdownReportGenerator.cs

@@ -61,26 +61,21 @@ public string QueryReportType()
         }
 
         /// <summary>
-        /// Generates a Markdown document with a table that contains all classes, attributes and their documentation
+        /// Generates a table that contains all classes, attributes and their documentation
         /// </summary>
         /// <param name="modelPath">
-        /// the path to the Ecore model of which the report is to be generated.
-        /// </param>
-        /// <param name="outputPath">
-        /// the path, including filename, where the output is to be generated.
+        /// /// the path to the Ecore model of which the report is to be generated.
         /// </param>
-        public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
+        /// <returns>
+        /// the content of an HTML report in a string
+        /// </returns>
+        public string GenerateReport(FileInfo modelPath)
         {
             if (modelPath == null)
             {
                 throw new ArgumentNullException(nameof(modelPath));
             }
 
-            if (outputPath == null)
-            {
-                throw new ArgumentNullException(nameof(outputPath));
-            }
-
             var sw = Stopwatch.StartNew();
 
             this.logger.LogInformation("Start Generating Markdown report");
@@ -93,6 +88,31 @@ public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
 
             var generatedHtml = template(payload);
 
+            this.logger.LogInformation("Generated Markdown report in {ElapsedTime} [ms]", sw.ElapsedMilliseconds);
+
+            return generatedHtml;
+        }
+
+        /// <summary>
+        /// Generates a Markdown document with a table that contains all classes, attributes and their documentation
+        /// </summary>
+        /// <param name="modelPath">
+        /// the path to the Ecore model of which the report is to be generated.
+        /// </param>
+        /// <param name="outputPath">
+        /// the path, including filename, where the output is to be generated.
+        /// </param>
+        public void GenerateReport(FileInfo modelPath, FileInfo outputPath)
+        {
+            if (outputPath == null)
+            {
+                throw new ArgumentNullException(nameof(outputPath));
+            }
+
+            var sw = Stopwatch.StartNew();
+
+            var generatedHtml = this.GenerateReport(modelPath) ;
+
             if (outputPath.Exists)
             {
                 outputPath.Delete();

ECoreNetto.Tools/ECoreNetto.Tools.csproj

@@ -9,14 +9,14 @@
         <PackAsTool>true</PackAsTool>
         <PackageId>ECoreNetto.Tools</PackageId>
         <ToolCommandName>ecoretools</ToolCommandName>
-        <Version>5.0.0</Version>
+        <Version>5.1.0</Version>
         <ImplicitUsings>disable</ImplicitUsings>
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageIcon>ecorenetto-Icon.png</PackageIcon>
         <NeutralLanguage>en-US</NeutralLanguage>
         <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
         <PackageReleaseNotes>
-            [Add] DataTypes to Excel report
+            [Update] to reporting version 5.1.0
         </PackageReleaseNotes>
     </PropertyGroup>