From 83b51153eae974aedff13b76bf35f61f2504215a Mon Sep 17 00:00:00 2001
From: samatstarion <s.gerene@stariongroup.eu>
Date: Sat, 16 Nov 2024 17:13:22 +0100
Subject: [PATCH] [Add] IEnumerableHelper

---
 uml4net.HandleBars/IEnumerableHelper.cs       |  53 +++
 .../Generators/HandleBarsReportGenerator.cs   |   2 +
 .../Templates/uml-to-html-docs.hbs            | 385 +++++++++++-------
 3 files changed, 286 insertions(+), 154 deletions(-)
 create mode 100644 uml4net.HandleBars/IEnumerableHelper.cs

diff --git a/uml4net.HandleBars/IEnumerableHelper.cs b/uml4net.HandleBars/IEnumerableHelper.cs
new file mode 100644
index 00000000..ea4d6faf
--- /dev/null
+++ b/uml4net.HandleBars/IEnumerableHelper.cs
@@ -0,0 +1,53 @@
+// -------------------------------------------------------------------------------------------------
+//  <copyright file="IEnumerableHelper.cs" company="Starion Group S.A.">
+// 
+//    Copyright 2019-2024 Starion Group S.A.
+// 
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+// 
+//        http://www.apache.org/licenses/LICENSE-2.0
+// 
+//    Unless required by applicable law or agreed to in writing, softwareUseCases
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+// 
+//  </copyright>
+//  ------------------------------------------------------------------------------------------------
+
+namespace uml4net.HandleBars
+{
+    using System.Collections.Generic;
+    using System.Linq;
+
+    using HandlebarsDotNet;
+
+    /// <summary>
+    /// A  helper that supports operations on IEnumerable
+    /// </summary>
+    public static class IEnumerableHelper
+    {
+        /// <summary>
+        /// Registers the <see cref="IEnumerableHelper"/>
+        /// </summary>
+        /// <param name="handlebars">
+        /// The <see cref="IHandlebars"/> context with which the helper needs to be registered
+        /// </param>
+        public static void RegisterEnumerableHelper(this IHandlebars handlebars)
+        {
+            handlebars.RegisterHelper("IEnumerable.IsEmpty", (context, parameters) =>
+            {
+                if (parameters[0] is IEnumerable<object> list && !list.Any())
+                {
+                    return true;
+                }
+                
+                return false;
+                
+            });
+        }
+    }
+}
\ No newline at end of file
diff --git a/uml4net.Reporting/Generators/HandleBarsReportGenerator.cs b/uml4net.Reporting/Generators/HandleBarsReportGenerator.cs
index abe963a1..5a16a05d 100644
--- a/uml4net.Reporting/Generators/HandleBarsReportGenerator.cs
+++ b/uml4net.Reporting/Generators/HandleBarsReportGenerator.cs
@@ -35,6 +35,7 @@ namespace uml4net.Reporting.Generators
     using uml4net.Reporting.Payload;
     using uml4net.Reporting.Resources;
     using uml4net.xmi.Readers;
+    using uml4net.HandleBars;
 
     /// <summary>
     /// Abstract super class from which all <see cref="HandlebarsDotNet"/> generators
@@ -75,6 +76,7 @@ protected HandleBarsReportGenerator(ILoggerFactory loggerFactory = null) : base(
         protected virtual void RegisterHelpers()
         {
             uml4net.HandleBars.StringHelper.RegisterStringHelper(this.Handlebars);
+            uml4net.HandleBars.IEnumerableHelper.RegisterEnumerableHelper(this.Handlebars);
             uml4net.HandleBars.PropertyHelper.RegisterStructuralFeatureHelper(this.Handlebars);
             uml4net.HandleBars.GeneralizationHelper.RegisterGeneralizationHelper(this.Handlebars);
             uml4net.HandleBars.DocumentationHelper.RegisteredDocumentationHelper(this.Handlebars);
diff --git a/uml4net.Reporting/Templates/uml-to-html-docs.hbs b/uml4net.Reporting/Templates/uml-to-html-docs.hbs
index f3a8eb86..18457fa3 100644
--- a/uml4net.Reporting/Templates/uml-to-html-docs.hbs
+++ b/uml4net.Reporting/Templates/uml-to-html-docs.hbs
@@ -265,168 +265,245 @@
                 </table>
 
                 <H2 id="Enumeration">1. Enumeration Types</H2>
-                {{#each this.Enumerations as | enumeration |}}
-                <H3 id="{{enumeration.Name}}">{{enumeration.Name}}</H3>
-                <H4>Definition</H4>
-                {{ #RawDocumentation enumeration }}
-                <H4>Enumeration Literals</H4>
-                <table class="starion-table">
-                    <thead>
-                        <tr>
-                            <th>Name</th>
-                            <th>Description</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                        {{#each enumeration.OwnedLiteral as | enumerationLiteral |}}
-                        <tr>
-                            <td id="{{enumerationLiteral.Name}}">{{enumerationLiteral.Name}}</td>
-                            <td>
-                                {{ #RawDocumentation enumerationLiteral }}
-                            </td>
-                        </tr>
-                        {{/each}}
-                    </tbody>
-                </table>
-                {{/each}}
+                {{ #if (IEnumerable.IsEmpty this.Enumerations) }}
+                    <p>No Enumerations have been found in the UML model</p>
+                {{ else }}
+                    {{#each this.Enumerations as | enumeration |}}
+                    <H3 id="{{enumeration.Name}}">{{enumeration.Name}} [Enumeration] </H3>
+                    <H4>Features</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Description</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr>
+                                <td>Fully Qualified Name</td>
+                                <td> {{ enumeration.QualifiedName }} </td>
+                            </tr>
+                            <tr>
+                                <td>Definition</td>
+                                <td>{{ #RawDocumentation enumeration }}</td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    <H4>Enumeration Literals</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Description</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            {{#each enumeration.OwnedLiteral as | enumerationLiteral |}}
+                            <tr>
+                                <td id="{{enumerationLiteral.Name}}">{{enumerationLiteral.Name}}</td>
+                                <td>
+                                    {{ #RawDocumentation enumerationLiteral }}
+                                </td>
+                            </tr>
+                            {{/each}}
+                        </tbody>
+                    </table>
+                    {{/each}}
+                {{ /if }}
 
                 <H2 id="PrimitiveTypes">2. Primitive Types</H2>
-                {{#each this.PrimitiveTypes as | primitiveType |}}
-                <H3 id="{{primitiveType.Name}}">{{primitiveType.Name}}</H3>
-                <H4>Definition</H4>
-                {{ #RawDocumentation primitiveType }}
-                {{/each}}
+                {{ #if (IEnumerable.IsEmpty this.PrimitiveTypes) }}
+                    <p>No Primitive Types have been found in the UML model</p>
+                {{ else }}
+                    {{#each this.PrimitiveTypes as | primitiveType |}}
+                    <H3 id="{{primitiveType.Name}}">{{primitiveType.Name}} [PrimitiveType]</H3>
+                    <H4>Features</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Description</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr>
+                                <td>Fully Qualified Name</td>
+                                <td> {{ primitiveType.QualifiedName }} </td>
+                            </tr>
+                            <tr>
+                                <td>Definition</td>
+                                <td>{{ #RawDocumentation primitiveType }}</td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    {{/each}}
+                {{ /if }}
 
                 <H2 id="OtherDataTypes">3. Data Types</H2>
-                {{#each this.DataTypes as | datatype |}}
-                <H3 id="{{datatype.Name}}">{{datatype.Name}}</H3>
-                <H4>Definition</H4>
-                {{ #RawDocumentation datatype }}
-                {{/each}}
+                {{ #if (IEnumerable.IsEmpty this.DataTypes) }}
+                    <p>No Data Types (other than <a href="#Enumeration">Enumerations</a> and <a href="#PrimitiveTypes">Primitive Types</a>) have been found in the UML model</p>
+                {{ else }}
+                    {{#each this.DataTypes as | datatype |}}
+                    <H3 id="{{datatype.Name}}">{{datatype.Name}} [DataType]</H3>
+                    <H4>Features</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Description</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr>
+                                <td>Fully Qualified Name</td>
+                                <td> {{ primitiveType.QualifiedName }} </td>
+                            </tr>
+                            <tr>
+                                <td>Definition</td>
+                                <td>{{ #RawDocumentation primitiveType }}</td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    {{/each}}
+                {{ /if }}
 
                 <H2 id="Classes">4. Classes</H2>
-                {{#each this.Classes as | class |}}
-
-                <H3 id="{{class.Name}}">{{class.Name}}</H3>
-                <H4>Definition</H4>
-                {{ #RawDocumentation class }}
-                <H4>Features</H4>
-                <table class="starion-table">
-                    <thead>
-                        <tr>
-                            <th>Name</th>
-                            <th>Description</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                        <tr>
-                            <td>Is Abstract</td>
-                            <td> {{#if class.IsAbstract}} TRUE {{else}} FALSE {{/if}} </td>
-                        </tr>
-                        <tr>
-                            <td>Generalizations</td>
-                            <td>
-                                {{#each class.SuperClass as | superClass |}}
-                                <a href="#{{superClass.Name}}">{{superClass.Name}}</a>
-                                {{/each}}
-                            </td>
-                        </tr>
-                        <tr>
-                            <td>Specializations</td>
-                            <td> TBD
-                                <!--
-                                {{#each class.SuperClass as | subClass |}}
-                                <a href="#{{subClass.Name}}">{{subClass.Name}}</a>
-                                {{/each}}
-                                -->
-                            </td>
-                        </tr>
-                    </tbody>
-                </table>
-                <H4>Properties</H4>
-                <table class="starion-table">
-                    <thead>
-                        <tr>
-                            <th>Name</th>
-                            <th>Type</th>
-                            <th>Default</th>
-                            <th>Description</th>
-                            <th>Inheritance</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                        {{#each this.QueryAllProperties as | property |}}
-                        <tr>
-                            <td>{{ property.Name }}</td>
-                            <td>
-                                <a href="#{{Property.QueryTypeName property}}">{{Property.QueryTypeName property}}</a> [{{ property.Lower }}..{{ property.Upper }}]
-                                {{#if property.IsDerived }} {derived} {{/if}}
-                                {{#if (Property.QueryIsContainment property) }} {composite} {{/if}}
-                            </td>
-                            <td>{{ property.DefaultValueLiteral }}</td>
-                            <td>{{ #RawDocumentation property }}</td>
-                            <td><a href="#{{property.Owner.Name}}">{{property.Owner.Name}}</a></td>
-                        </tr>
-                        {{/each}}
-                    </tbody>
-                </table>
-                {{/each}}
-
-
+                {{ #if (IEnumerable.IsEmpty this.Classes) }}
+                    <p>No Classes have been found in the UML model</p>
+                {{ else }}
+                    {{#each this.Classes as | class |}}
+                    <H3 id="{{class.Name}}">{{class.Name}} [Class]</H3>
+                    <H4>Features</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Description</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr>
+                                <td>Fully Qualified Name</td>
+                                <td> {{ class.QualifiedName }} </td>
+                            </tr>
+                            <tr>
+                                <td>Definition</td>
+                                <td>{{ #RawDocumentation class }}</td>
+                            </tr>
+                            <tr>
+                                <td>Is Abstract</td>
+                                <td> {{#if class.IsAbstract}} TRUE {{else}} FALSE {{/if}} </td>
+                            </tr>
+                            <tr>
+                                <td>Generalizations</td>
+                                <td>
+                                    {{#each class.SuperClass as | superClass |}}
+                                    <a href="#{{superClass.Name}}">{{superClass.Name}}</a>
+                                    {{/each}}
+                                </td>
+                            </tr>
+                            <tr>
+                                <td>Specializations</td>
+                                <td> TBD
+                                    <!--
+                                    {{#each class.SuperClass as | subClass |}}
+                                    <a href="#{{subClass.Name}}">{{subClass.Name}}</a>
+                                    {{/each}}
+                                    -->
+                                </td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    <H4>Properties</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Type</th>
+                                <th>Default</th>
+                                <th>Description</th>
+                                <th>Inheritance</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            {{#each this.QueryAllProperties as | property |}}
+                            <tr>
+                                <td>{{ property.Name }}</td>
+                                <td>
+                                    <a href="#{{Property.QueryTypeName property}}">{{Property.QueryTypeName property}}</a> [{{ property.Lower }}..{{ property.Upper }}]
+                                    {{#if property.IsDerived }} {derived} {{/if}}
+                                    {{#if (Property.QueryIsContainment property) }} {composite} {{/if}}
+                                </td>
+                                <td>{{ property.DefaultValueLiteral }}</td>
+                                <td>{{ #RawDocumentation property }}</td>
+                                <td><a href="#{{property.Owner.Name}}">{{property.Owner.Name}}</a></td>
+                            </tr>
+                            {{/each}}
+                        </tbody>
+                    </table>
+                    {{/each}}
+                {{ /if }}
 
                 <H2 id="Interfaces">4. Interfaces</H2>
-                {{#each this.Interfaces as | interface |}}
-
-                <H3 id="{{interface.Name}}">{{interface.Name}}</H3>
-                <H4>Definition</H4>
-                {{ #RawDocumentation interface }}
-                <H4>Features</H4>
-                <table class="starion-table">
-                    <thead>
-                        <tr>
-                            <th>Name</th>
-                            <th>Description</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                        <tr>
-                            <td>Generalizations</td>
-                            <td>
-                                {{#each interface.ESuperTypes as | superInterface |}}
-                                <a href="#{{superInterface.Name}}">{{superInterface.Name}}</a>
-                                {{/each}}
-                            </td>
-                        </tr>
-                    </tbody>
-                </table>
-                <H4>Properties</H4>
-                <table class="starion-table">
-                    <thead>
-                        <tr>
-                            <th>Name</th>
-                            <th>Type</th>
-                            <th>Default</th>
-                            <th>Description</th>
-                            <th>Inheritance</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                        {{#each this.QueryAllProperties as | property |}}
-                        <tr>
-                            <td>{{ property.Name }}</td>
-                            <td>
-                                <a href="#{{Property.QueryTypeName property}}">{{Property.QueryTypeName property}}</a> [{{ property.Lower }}..{{ property.Upper }}]
-                                {{#if property.IsDerived }} {derived} {{/if}}
-                                {{#if (Property.QueryIsContainment property) }} {composite} {{/if}}
-                            </td>
-                            <td>{{ property.DefaultValueLiteral }}</td>
-                            <td>{{ #RawDocumentation property }}</td>
-                            <td><a href="#{{property.Owner.Name}}">{{property.Owner.Name}}</a></td>
-                        </tr>
-                        {{/each}}
-                    </tbody>
-                </table>
-                {{/each}}
+                {{ #if (IEnumerable.IsEmpty this.Interfaces) }}
+                    <p>No Interfaces have been found in the UML model</p>
+                {{ else }}
+                    {{#each this.Interfaces as | interface |}}
+                    <H3 id="{{interface.Name}}">{{interface.Name}} [Interface] </H3>
+                    <H4>Definition</H4>
+                    {{ #RawDocumentation interface }}
+                    <H4>Features</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Description</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr>
+                                <td>Fully Qualified Name</td>
+                                <td> {{ interface.QualifiedName }} </td>
+                            </tr>
+                            <tr>
+                                <td>Generalizations</td>
+                                <td>
+                                    {{#each interface.ESuperTypes as | superInterface |}}
+                                    <a href="#{{superInterface.Name}}">{{superInterface.Name}}</a>
+                                    {{/each}}
+                                </td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    <H4>Properties</H4>
+                    <table class="starion-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Type</th>
+                                <th>Default</th>
+                                <th>Description</th>
+                                <th>Inheritance</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            {{#each this.QueryAllProperties as | property |}}
+                            <tr>
+                                <td>{{ property.Name }}</td>
+                                <td>
+                                    <a href="#{{Property.QueryTypeName property}}">{{Property.QueryTypeName property}}</a> [{{ property.Lower }}..{{ property.Upper }}]
+                                    {{#if property.IsDerived }} {derived} {{/if}}
+                                    {{#if (Property.QueryIsContainment property) }} {composite} {{/if}}
+                                </td>
+                                <td>{{ property.DefaultValueLiteral }}</td>
+                                <td>{{ #RawDocumentation property }}</td>
+                                <td><a href="#{{property.Owner.Name}}">{{property.Owner.Name}}</a></td>
+                            </tr>
+                            {{/each}}
+                        </tbody>
+                    </table>
+                    {{/each}}
+                {{ /if }}
             </article>
         </main>
     </div>