Merge pull request #22 from data-solution-automation-engine/dev

Dev

Author: RoelantVos

DataWarehouseAutomation/DataWarehouseAutomation/DataClassification.cs

@@ -19,18 +19,18 @@ public class DataClassification
     public string Classification { get; set; } = "NewClassification";
 
     /// <summary>
-    /// Free-format notes on the data classification.
+    /// Free-format notes on the Data Classification.
     /// </summary>
     [JsonPropertyName("notes")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public string? Notes { get; set; }
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataClassifications are the same, based on their Id.
+    /// Use this method to assert if two Data Classifications are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Classifications are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataClassification;
@@ -40,14 +40,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns the classification value ('classification').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Classification" property will be returned.
     /// </summary>
-    /// <returns>string</returns>
+    /// <returns>The Classification value</returns>
     public override string ToString()
     {
         return Classification;

DataWarehouseAutomation/DataWarehouseAutomation/DataConnection.cs

@@ -42,10 +42,10 @@ public class DataConnection : IMetadata
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataConnections are the same, based on their Id.
+    /// Use this method to assert if two Data Connections are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Connections are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataConnection;
@@ -55,14 +55,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns its value ('connection string').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Connection String" property will be returned.
     /// </summary>
-    /// <returns>string</returns>
+    /// <returns>The Name</returns>
     public override string ToString()
     {
         return Name;

DataWarehouseAutomation/DataWarehouseAutomation/DataItem.cs

@@ -11,7 +11,7 @@ public class DataItem : IDataItem
 
     [JsonPropertyName("name")]
     [JsonIgnore(Condition = JsonIgnoreCondition.Never)]
-    public string Name { get; set; }
+    public string Name { get; set; } = "NewDataItem";
 
     /// <summary>
     /// The data object to which the data item belongs. This can be used to construct fully qualified names.
@@ -67,10 +67,10 @@ public class DataItem : IDataItem
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataItems are the same, based on their Id.
+    /// Use this method to assert if two Data Items are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Items are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataItem;
@@ -80,14 +80,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns its value ('name').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Name" property will be returned.
     /// </summary>
-    /// <returns>string</returns>
+    /// <returns>The Name</returns>
     public override string ToString()
     {
         return Name;

DataWarehouseAutomation/DataWarehouseAutomation/DataItemMapping.cs

@@ -27,10 +27,10 @@ public class DataItemMapping
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataItemMappings are the same, based on their Id.
+    /// Use this method to assert if two DataItemMappings are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Item Mappings are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataItemMapping;
@@ -40,14 +40,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns its value ('name of the target data item').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the Data Item "Name" property will be returned.
     /// </summary>
-    /// <returns>string</returns>
+    /// <returns>The Target Data Item's Name</returns>
     public override string ToString()
     {
         return TargetDataItem.Name;

DataWarehouseAutomation/DataWarehouseAutomation/DataItemQuery.cs

@@ -81,10 +81,10 @@ public class DataItemQuery : IDataItem
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataItemQueries are the same, based on their Id.
+    /// Use this method to assert if two Data Item Queries are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Item Queries are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataItemQuery;
@@ -94,14 +94,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns its value ('name').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Name" property will be returned.
     /// </summary>
-    /// <returns>string</returns>
+    /// <returns>The Name</returns>
     public override string ToString()
     {
         return Name;

DataWarehouseAutomation/DataWarehouseAutomation/DataObject.cs

@@ -57,10 +57,10 @@ public class DataObject : IMetadata, IDataObject
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataObjects are the same, based on their Id.
+    /// Use this method to assert if two Data Objects are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Objects are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataObject;
@@ -69,14 +69,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns its value ('name').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Name" property will be returned.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The Name</returns>
     public override string ToString()
     {
         return Name;

DataWarehouseAutomation/DataWarehouseAutomation/DataObjectMapping.cs

@@ -101,10 +101,10 @@ public class DataObjectMapping : IMetadata
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataObjectMappings are the same, based on their Id.
+    /// Use this method to assert if two Data Object Mappings are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>True if the Data Object Mappings are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataObjectMapping;
@@ -114,14 +114,14 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>
     /// String override so that the object returns its value ('Name').
     /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Name" property will be returned.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The Name</returns>
     public override string ToString()
     {
         return Name;

DataWarehouseAutomation/DataWarehouseAutomation/DataObjectQuery.cs

@@ -59,10 +59,10 @@ public class DataObjectQuery : IDataObject
 
     #region Methods
     /// <summary>
-    /// Use this method to assert if two DataObjectQueries are the same, based on their Id.
+    /// Use this method to assert if two DataObjectQueries are the same, based on their Ids.
     /// </summary>
     /// <param name="obj"></param>
-    /// <returns>bool</returns>
+    /// <returns>true if Data Object Queries are the same, based on their Ids</returns>
     public override bool Equals(object? obj)
     {
         var other = obj as DataObjectQuery;
@@ -72,7 +72,7 @@ public override bool Equals(object? obj)
     /// <summary>
     /// Override to get a hash value that represents the identifier.
     /// </summary>
-    /// <returns>int</returns>
+    /// <returns>A 32-bit signed integer hash code</returns>
     public override int GetHashCode() => (Id?.GetHashCode()) ?? 0;
 
     /// <summary>

DataWarehouseAutomation/DataWarehouseAutomation/HandleBarsHelpers.cs

@@ -277,7 +277,7 @@ public static void RegisterHandleBarsHelpers()
         // Run at data object mapping level.
         Handlebars.RegisterHelper("exists", (output, options, context, arguments) =>
         {
-            if (arguments.Length == 0 || arguments.Length>2) throw new HandlebarsException("The {{exists}} function must have one or two arguments, which must be a property of a data object mapping which is mandatory and an optional exception value.");
+            if (arguments.Length == 0 || arguments.Length > 2) throw new HandlebarsException("The {{exists}} function must have one or two arguments, which must be a property of a data object mapping which is mandatory and an optional exception value.");
 
             var property = arguments[0] == null ? "" : arguments[0].ToString();
 
@@ -327,7 +327,7 @@ public static void RegisterHandleBarsHelpers()
                 }
                 else if (property == "targetDataItem")
                 {
-                    var targetDataItem = dataObjectMapping?.DataItemMappings?.Where(x => x.TargetDataItem != null).FirstOrDefault();
+                    var targetDataItem = dataObjectMapping?.DataItemMappings?.Find(x => x.TargetDataItem != null);
 
                     if (targetDataItem != null)
                     {
@@ -367,7 +367,7 @@ public static void RegisterHandleBarsHelpers()
 
             var extensionList = JsonSerializer.Deserialize<List<Extension>>(parameters[0].ToString() ?? string.Empty);
             var key = (string)parameters[1];
-            var result = extensionList.Find(i => i.Key.Equals(key, StringComparison.OrdinalIgnoreCase))?.Value ?? "";
+            var result = extensionList?.Find(i => i.Key.Equals(key, StringComparison.OrdinalIgnoreCase))?.Value ?? "";
 
             writer.WriteSafeString($"{result}");
         });