Add README.md file, an image

DevOpsThinh · DevOpsThinh · commit 877f1b479d08 · 2023-09-03T12:24:08.000+07:00
diff --git a/Images/report_testing.png b/Images/report_testing.png
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Dynamic Report-building Class Library :handshake:
+___
+## Introduction
+A dynamic report-building class library with these formats: Excel, Pdf, HTML and Markdown.
+## Technology Stack
+- It uses C# based on reflection to read attributes of a class, access type members, and execute methods.
+- It uses the advanced topics of Microsoft's technology document reference: Native interoperability (COM interop programming).
+## Out formattes released
+### An Excel spreadsheet with two options
+- Without dynamic (uses strongly typed code to generate an Excel report).
+- With dynamic (uses dynamic code to generate an Excel report).
+### PDF (Coming soon)
+### HTML (Coming soon)
+### Markdown (Coming soon)
+## Usage / Testing
+<img src="Images/report_testing.png" height="480"/> <br>
+## Reference
+- [Access Office interop objects](https://learn.microsoft.com/en-us/dotnet/csharp/advanced-topics/interop/how-to-access-office-interop-objects)
+- [C# Cookbook](https://learning.oreilly.com/library/view/-/9781492093688/)
diff --git a/ReportLibrary/BusinessRules/BaseGenerator.cs b/ReportLibrary/BusinessRules/BaseGenerator.cs
@@ -132,8 +132,6 @@ protected List<string> GetColumns(IEnumerable<ReportColumnDetail> details, D ite
                         columns.Add(string.Format(formatter, (double)result)); break;
                     case "Int32":
                         columns.Add(string.Format(formatter, (int)result)); break;
-                    case "Long":
-                        columns.Add(string.Format(formatter, (long)result)); break;
                     case "String":
                         columns.Add(string.Format(formatter, (string)result)); break;
                     default: break;
diff --git a/ReportLibrary/BusinessRules/ReportTypeEnumeration.cs b/ReportLibrary/BusinessRules/ReportTypeEnumeration.cs
@@ -38,10 +38,10 @@ namespace ReportLibrary.BusinessRules
     /// </summary>
     public enum ReportTypeEnumeration
     {
+        ExcelDynamic,
+        ExcelTyped,
         Html,
         Markdown,
-        ExcelTyped,
-        ExcelDynamic,
         Pdf
     }
 }
diff --git a/ReportLibrary/OfficeApps/ExcelDynamicGenerator.cs b/ReportLibrary/OfficeApps/ExcelDynamicGenerator.cs
@@ -72,7 +72,7 @@ protected override StringBuilder GetHeaders(Dictionary<string, ReportColumnDetai
                 worksheet.Cells[3, i + 1] = detail.Attribute.Name;
             }
 
-            return new StringBuilder("Đề mục đã thêm...\n");
+            return new StringBuilder("Added header...\n");
         }
         /// <summary>
         /// The <c>GetRows</c> override method that combines and formats all rows of data.
@@ -110,18 +110,18 @@ protected override StringBuilder GetRows(List<D> items, Dictionary<string, Repor
 
             var gui = Guid.NewGuid();
 
-            workbook.SaveAs($"BaoCaoXe_{gui}.xlsx", XlSaveAsAccessMode.xlShared);
+            workbook.SaveAs($"ExcelReport_{gui}.xlsx", XlSaveAsAccessMode.xlShared);
 
-            return new StringBuilder("Dữ liệu đã thêm...\n" + "tệp Excel đã tạo có tên BaoCaoXe.xlsx");
+            return new StringBuilder("Added data...\n" + "Excel file created at ExcelReport.xlsx");
         }
         /// <summary>
         /// The <c>GetTitle</c> override method that gets title data
         /// </summary>
         protected override StringBuilder GetTitle()
         {
-            worksheet.Cells[1, 1] = "Báo Cáo";
+            worksheet.Cells[1, 1] = "My Report";
 
-            return new StringBuilder("Tựa đề đã thêm...\n");
+            return new StringBuilder("Added title...\n");
         }
     }
 }
diff --git a/ReportLibrary/OfficeApps/ExcelTypedGenerator.cs b/ReportLibrary/OfficeApps/ExcelTypedGenerator.cs
@@ -73,7 +73,7 @@ protected override StringBuilder GetHeaders(Dictionary<string, ReportColumnDetai
                 worksheet.Cells[3, i + 1] = detail.Attribute.Name;
             }
 
-            return new StringBuilder("Đề mục đã thêm...\n");
+            return new StringBuilder("Added header...\n");
         }
         /// <summary>
         /// The <c>GetRows</c> override method that combines and formats all rows of data.
@@ -112,20 +112,20 @@ protected override StringBuilder GetRows(List<D> items, Dictionary<string, Repor
             var gui = Guid.NewGuid();
 
             workbook.SaveAs(
-                $"BaoCaoXe_{gui}.xlsx", Missing.Value, Missing.Value, Missing.Value, Missing.Value,
+                $"ExcelReport_{gui}.xlsx", Missing.Value, Missing.Value, Missing.Value, Missing.Value,
                 Missing.Value, XlSaveAsAccessMode.xlShared, Missing.Value, Missing.Value,
                 Missing.Value, Missing.Value, Missing.Value);
 
-            return new StringBuilder("Dữ liệu đã thêm...\n" + "tệp Excel đã tạo có tên BaoCaoXe.xlsx");
+            return new StringBuilder("Added data...\n" + "Excel file created at ExcelReport.xlsx");
         }
         /// <summary>
         /// The <c>GetTitle</c> override method that gets title data
         /// </summary>
         protected override StringBuilder GetTitle()
         {
-            worksheet.Cells[1, 1] = "Báo Cáo";
+            worksheet.Cells[1, 1] = "My Report";
 
-            return new StringBuilder("Tựa đề đã thêm...\n");
+            return new StringBuilder("Added title...\n");
         }
     }
 }
diff --git a/ReportLibraryTest/Inventory.cs b/ReportLibraryTest/Inventory.cs
@@ -54,6 +54,6 @@ public class Inventory
         [ReportColumn("Note")]
         public string ItemNote { get; set; }
         [ReportColumn("Status")]
-        public string ISOutStock { get; set; }
+        public string IsOutStock { get; set; }
     }
 }
diff --git a/ReportLibraryTest/InventoryTest.cs b/ReportLibraryTest/InventoryTest.cs
@@ -54,7 +54,7 @@ public void TestMethod1()
                     ItemUnit = "kg",
                     ItemPrice = 15.95m,
                     ItemNote = "",
-                    ISOutStock = "0"
+                    IsOutStock = "0"
                 },
                 new Inventory
                 {
@@ -64,7 +64,7 @@ public void TestMethod1()
                     ItemUnit = "liter",
                     ItemPrice = 8.95m,
                     ItemNote = "Go to Cart",
-                    ISOutStock = "0"
+                    IsOutStock = "0"
                 },
                 new Inventory
                 {
@@ -74,14 +74,13 @@ public void TestMethod1()
                     Count = 2,
                     ItemPrice = 5.95m,
                     ItemNote = "Out of stock",
-                    ISOutStock = "1"
+                    IsOutStock = "1"
                 }
             };
 
-            var expectedResult = "Tựa đề đã thêm...\nĐề mục đã thêm...\nDữ liệu đã thêm...\ntệp Excel đã tạo có tên BaoCaoXe.xlsx";
+            var expectedResult = "Added title...\nAdded header...\nAdded data...\nExcel file created at ExcelReport.xlsx";
 
-            string report =
-                new ReportBusiness<Inventory>()
+            string report = new ReportBusiness<Inventory>()
                 .GenerateReport(inventory, ReportTypeEnumeration.ExcelDynamic);
 
             Assert.AreEqual(expectedResult, report);

Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,10 @@ namespace ReportLibrary.BusinessRules`
`38`	`38`	`/// </summary>`
`39`	`39`	`public enum ReportTypeEnumeration`
`40`	`40`	`{`
	`41`	`+ ExcelDynamic,`
	`42`	`+ ExcelTyped,`
`41`	`43`	`Html,`
`42`	`44`	`Markdown,`
`43`		`- ExcelTyped,`
`44`		`- ExcelDynamic,`
`45`	`45`	`Pdf`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ protected override StringBuilder GetHeaders(Dictionary<string, ReportColumnDetai`
`72`	`72`	`worksheet.Cells[3, i + 1] = detail.Attribute.Name;`
`73`	`73`	`}`
`74`	`74`
`75`		`- return new StringBuilder("Đề mục đã thêm...\n");`
	`75`	`+ return new StringBuilder("Added header...\n");`
`76`	`76`	`}`
`77`	`77`	`/// <summary>`
`78`	`78`	`/// The <c>GetRows</c> override method that combines and formats all rows of data.`
`@@ -110,18 +110,18 @@ protected override StringBuilder GetRows(List<D> items, Dictionary<string, Repor`
`110`	`110`
`111`	`111`	`var gui = Guid.NewGuid();`
`112`	`112`
`113`		`- workbook.SaveAs($"BaoCaoXe_{gui}.xlsx", XlSaveAsAccessMode.xlShared);`
	`113`	`+ workbook.SaveAs($"ExcelReport_{gui}.xlsx", XlSaveAsAccessMode.xlShared);`
`114`	`114`
`115`		`- return new StringBuilder("Dữ liệu đã thêm...\n" + "tệp Excel đã tạo có tên BaoCaoXe.xlsx");`
	`115`	`+ return new StringBuilder("Added data...\n" + "Excel file created at ExcelReport.xlsx");`
`116`	`116`	`}`
`117`	`117`	`/// <summary>`
`118`	`118`	`/// The <c>GetTitle</c> override method that gets title data`
`119`	`119`	`/// </summary>`
`120`	`120`	`protected override StringBuilder GetTitle()`
`121`	`121`	`{`
`122`		`- worksheet.Cells[1, 1] = "Báo Cáo";`
	`122`	`+ worksheet.Cells[1, 1] = "My Report";`
`123`	`123`
`124`		`- return new StringBuilder("Tựa đề đã thêm...\n");`
	`124`	`+ return new StringBuilder("Added title...\n");`
`125`	`125`	`}`
`126`	`126`	`}`
`127`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ protected override StringBuilder GetHeaders(Dictionary<string, ReportColumnDetai`
`73`	`73`	`worksheet.Cells[3, i + 1] = detail.Attribute.Name;`
`74`	`74`	`}`
`75`	`75`
`76`		`- return new StringBuilder("Đề mục đã thêm...\n");`
	`76`	`+ return new StringBuilder("Added header...\n");`
`77`	`77`	`}`
`78`	`78`	`/// <summary>`
`79`	`79`	`/// The <c>GetRows</c> override method that combines and formats all rows of data.`
`@@ -112,20 +112,20 @@ protected override StringBuilder GetRows(List<D> items, Dictionary<string, Repor`
`112`	`112`	`var gui = Guid.NewGuid();`
`113`	`113`
`114`	`114`	`workbook.SaveAs(`
`115`		`- $"BaoCaoXe_{gui}.xlsx", Missing.Value, Missing.Value, Missing.Value, Missing.Value,`
	`115`	`+ $"ExcelReport_{gui}.xlsx", Missing.Value, Missing.Value, Missing.Value, Missing.Value,`
`116`	`116`	`Missing.Value, XlSaveAsAccessMode.xlShared, Missing.Value, Missing.Value,`
`117`	`117`	`Missing.Value, Missing.Value, Missing.Value);`
`118`	`118`
`119`		`- return new StringBuilder("Dữ liệu đã thêm...\n" + "tệp Excel đã tạo có tên BaoCaoXe.xlsx");`
	`119`	`+ return new StringBuilder("Added data...\n" + "Excel file created at ExcelReport.xlsx");`
`120`	`120`	`}`
`121`	`121`	`/// <summary>`
`122`	`122`	`/// The <c>GetTitle</c> override method that gets title data`
`123`	`123`	`/// </summary>`
`124`	`124`	`protected override StringBuilder GetTitle()`
`125`	`125`	`{`
`126`		`- worksheet.Cells[1, 1] = "Báo Cáo";`
	`126`	`+ worksheet.Cells[1, 1] = "My Report";`
`127`	`127`
`128`		`- return new StringBuilder("Tựa đề đã thêm...\n");`
	`128`	`+ return new StringBuilder("Added title...\n");`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,6 @@ public class Inventory`
`54`	`54`	`[ReportColumn("Note")]`
`55`	`55`	`public string ItemNote { get; set; }`
`56`	`56`	`[ReportColumn("Status")]`
`57`		`- public string ISOutStock { get; set; }`
	`57`	`+ public string IsOutStock { get; set; }`
`58`	`58`	`}`
`59`	`59`	`}`