add tuple defs and floss some warnings

sjohansson · sjohansson · commit d080a2015d94 · 2024-06-24T08:27:31.000+10:00
tuple definitions are in `GlobalUsings.cs`, which makes the list definitions and their items easier
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DataWarehouseAutomation.csproj b/DataWarehouseAutomation/DataWarehouseAutomation/DataWarehouseAutomation.csproj
@@ -8,10 +8,10 @@
     <Authors>Roelant Vos</Authors>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <Title>Data Warehouse Automation</Title>
-    <PackageProjectUrl>https://roelantvos.com/blog/interface-for-data-warehouse-automation/</PackageProjectUrl>
+    <PackageProjectUrl>https://github.com/data-solution-automation-engine/data-warehouse-automation-metadata-schema</PackageProjectUrl>
     <PackageIcon>Ravos-logo.png</PackageIcon>
     <PackageReadmeFile>index.md</PackageReadmeFile>
-    <RepositoryUrl>https://github.com/RoelantVos/data-warehouse-automation-metadata-schema</RepositoryUrl>
+    <RepositoryUrl>https://github.com/data-solution-automation-engine/data-warehouse-automation-metadata-schema</RepositoryUrl>
     <PackageTags>data warehouse; etl; data integration; data warehouse automation</PackageTags>
     <Description>The generic schema for Data Warehouse Automation covers the efforts towards defining a standard interface to exchange Data Warehouse Automation and ETL generation metadata.
 
@@ -25,12 +25,32 @@ The interface itself is a Json schema definition (JSDL) with examples on how to
       <Pack>True</Pack>
       <PackagePath>\</PackagePath>
     </None>
+    <None Include="..\Images\Ravos-logo.png">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Handlebars.Net" Version="2.1.4" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="Newtonsoft.Json.Schema" Version="3.0.15" />
+    <PackageReference Include="Roslynator.Analyzers" Version="4.12.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Roslynator.CodeFixes" Version="4.12.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Roslynator.Formatting.Analyzers" Version="4.12.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Roslynator.Refactorings" Version="4.12.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
 </Project>
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/BusinessKeyDefinition.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/BusinessKeyDefinition.cs
@@ -22,10 +22,10 @@ public class BusinessKeyDefinition
     /// <summary>
     /// Items that define the Business Key e.g. the collection of columns for a business key.
     /// The integer value defines the order of the components in the business key definition.
-    /// The order is significant, and can be recorded as part of the tuple definition.
+    /// The order is significant, and is recorded as part of the tuple definition.
     /// </summary>
     [JsonPropertyName("businessKeyComponents")]
-    public List<Tuple<int, IDataItem>> BusinessKeyComponents { get; set; } = new();
+    public List<BusinessKeyComponents>? BusinessKeyComponents { get; set; }
 
     /// <summary>
     /// An optional label for the end result e.g. the target business key attribute.
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/Cardinality.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/Cardinality.cs
@@ -77,7 +77,7 @@ public override bool Equals(object? obj)
     /// <returns>The Name</returns>
     public override string ToString()
     {
-        return Name;
+        return Name ?? string.Empty;
     }
     #endregion
 }
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/CardinalityRange.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/CardinalityRange.cs
@@ -1,8 +1,4 @@
-﻿using System.Buffers.Text;
-using System.Collections.Generic;
-using System.Xml.Linq;
-
-namespace DataWarehouseAutomation.DwaModel;
+﻿namespace DataWarehouseAutomation.DwaModel;
 
 /// <summary>
 /// The possible range for a from/to component for the cardinality.
@@ -13,4 +9,4 @@ public class CardinalityRange
 {
     public string? Min { get; set; }
     public string? Max { get; set; }
-}
+}
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataItem.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataItem.cs
@@ -18,7 +18,7 @@ public class DataItem : IDataItem
     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.
+    /// The <see cref="IDataObject"/> to which the data item belongs. This can be used to construct fully qualified names.
     /// </summary>
     [JsonPropertyName("dataObject")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataItemMapping.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataItemMapping.cs
@@ -1,7 +1,7 @@
 ﻿namespace DataWarehouseAutomation.DwaModel;
 
 /// <summary>
-/// The individual column-to-column mapping.
+/// The individual <see cref="IDataItem"/> to <see cref="IDataItem"/>, column-to-column mapping.
 /// </summary>
 public class DataItemMapping
 {
@@ -13,7 +13,7 @@ public class DataItemMapping
     public string? Id { get; set; }
 
     [JsonPropertyName("sourceDataItems")]
-    public List<IDataItem> SourceDataItems { get; set; } = new();
+    public List<IDataItem> SourceDataItems { get; set; } = [];
 
     [JsonPropertyName("targetDataItem")]
     public IDataItem TargetDataItem { get; set; } = new DataItem() { Name = "newTargetDataItem" };
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataItemQuery.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataItemQuery.cs
@@ -16,8 +16,9 @@ public class DataItemQuery : IDataItem
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public string Name { get; set; } = string.Empty;
 
-    // convenience property for parent, derived on json load, never stored in the json file
-    // Can be either a DataObject or a DataQuery when the DataQuery is a DataItem level thing
+    /// <summary>
+    /// The <see cref="IDataObject"/> to which the data item belongs. This can be used to construct fully qualified names.
+    /// </summary>
     [JsonIgnore(Condition = JsonIgnoreCondition.Always)]
     public IDataObject? DataObject { get; set; }
 
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataObject.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataObject.cs
@@ -2,8 +2,9 @@
 
 /// <summary>
 /// The definition of a data set, file, or table.
-/// The Data Object can be the 'source' or 'target' in a Data Object Mapping.
-/// A Data Object which acts as target in one mapping, can be a source in another mapping, building up the data logistics lineage.
+/// The Data Object can be the 'source' or 'target' in a <see cref="DataObjectMapping"/>.
+/// A Data Object which acts as target in one mapping, can be a source in another mapping,
+/// building up the data logistics lineage.
 /// </summary>
 public class DataObject : IMetadata, IDataObject
 {
@@ -42,15 +43,14 @@ public class DataObject : IMetadata, IDataObject
     /// </summary>
     [JsonPropertyName("businessKeyDefinitions")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
-    public List<Tuple<int,BusinessKeyDefinition>>? BusinessKeyDefinitions { get; set; }
-
+    public List<BusinessKeyDefinitions>? BusinessKeyDefinitions { get; set; }
 
     /// <summary>
     /// Any relationship to other data objects.
     /// </summary>
     [JsonPropertyName("relationships")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
-    public List<Tuple<int,Relationship>>? Relationships { get; set; }
+    public List<Relationships>? Relationships { get; set; }
 
     /// <summary>
     /// Free-form and optional classification for the Data Object.
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataObjectMapping.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataObjectMapping.cs
@@ -56,27 +56,14 @@ public class DataObjectMapping : IMetadata
     /// </summary>
     [JsonPropertyName("relatedDataObjects")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
-    public List<Tuple<int, Relationship>>? Relationships { get; set; }
+    public List<Relationships>? Relationships { get; set; }
 
-    private List<IDataItem> _dataItems = [];
     /// <summary>
     /// The collection of Data Items <see cref="IDataItem"/> specifically associated with this Data Object Mapping,
     /// used as source/target Data Items/Queries for the mapping or the Mappings BKCM as needed.
     /// </summary>
     [JsonPropertyName("dataItems")]
-    [JsonPropertyOrder(order: 55)]
-    public List<IDataItem> DataItems
-    {
-        get
-        {
-            return _dataItems;
-        }
-        set
-        {
-            _dataItems = value;
-            isSorted = false;
-        }
-    }
+    public List<IDataItem>? DataItems { get; set; }
 
     /// <summary>
     /// The collection of individual attribute (column or query) mappings.
@@ -91,7 +78,7 @@ public List<IDataItem> DataItems
     /// </summary>
     [JsonPropertyName("businessKeyDefinitions")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
-    public List<Tuple<int, BusinessKeyDefinition>>? BusinessKeyDefinitions { get; set; }
+    public List<BusinessKeyDefinitions>? BusinessKeyDefinitions { get; set; }
 
     /// <summary>
     /// Any filtering that needs to be applied to the source-to-target mapping.
@@ -123,25 +110,6 @@ public List<IDataItem> DataItems
     #endregion
 
     #region Json Representation
-    private bool isSorted = false;
-
-    /// <summary>
-    /// Sort all the lists in the metadata object
-    /// </summary>
-    public void SortLists()
-    {
-        if (!isSorted)
-        {
-            isSorted = true;
-            SourceDataObjects.Sort();
-            RelatedDataObjects.Sort();
-            DataItemMappings.Sort();
-            BusinessKeyDefinitions.Sort();
-            Classifications.Sort();
-            Extensions.Sort();
-        }
-    }
-
     /// <summary>
     /// Get the standard Json representation
     /// </summary>
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataObjectQuery.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/DataObjectQuery.cs
@@ -35,23 +35,11 @@ public class DataObjectQuery : IDataObject
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public string? QueryLanguage { get; set; }
 
-    private List<IDataItem> _dataItems = [];
     /// <summary>
     /// The collection of Data Items <see cref="IDataItem"/> associated with this Data Object Query.
     /// </summary>
     [JsonPropertyName("dataItems")]
-    [JsonPropertyOrder(order: 40)]
-    public List<IDataItem> DataItems
-    {
-        get
-        {
-            return _dataItems;
-        }
-        set
-        {
-            _dataItems = value;
-        }
-    }
+    public List<IDataItem>? DataItems { get; set; }
 
     /// <summary>
     /// The connection for the query.
@@ -74,7 +62,7 @@ public List<IDataItem> DataItems
     /// </summary>
     [JsonPropertyName("relationships")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
-    public List<Tuple<int, Relationship>>? Relationships { get; set; }
+    public List<Relationships>? Relationships { get; set; }
 
     /// <summary>
     /// Free-form and optional classification for the Data Query for use in generation logic (evaluation).
@@ -119,7 +107,7 @@ public override bool Equals(object? obj)
     /// 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;
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/Relationship.cs b/DataWarehouseAutomation/DataWarehouseAutomation/DwaModel/Relationship.cs
@@ -7,8 +7,6 @@ namespace DataWarehouseAutomation.DwaModel;
 /// </summary>
 public class Relationship
 {
-    
-
     #region Properties
     /// <summary>
     /// An optional identifier for the relationship.
@@ -92,15 +90,15 @@ public override bool Equals(object? obj)
     /// Generates a Hash Code derived from the Entity's Id.
     /// </summary>
     /// <returns>Hash Code</returns>
-    public override int GetHashCode() => Id.GetHashCode();
+    public override int GetHashCode() => Id?.GetHashCode() ?? 0;
 
     /// <summary>
     /// String representation override for the Entity
     /// </summary>
     /// <returns>The Name Attribute</returns>
     public override string ToString()
     {
-        return Name;
+        return Name ?? string.Empty;
     }
     #endregion
 }
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/GlobalUsings.cs b/DataWarehouseAutomation/DataWarehouseAutomation/GlobalUsings.cs
@@ -1,5 +1,14 @@
-﻿global using HandlebarsDotNet;
+﻿// Global Using Statements
+global using DataWarehouseAutomation.DwaModel;
+global using HandlebarsDotNet;
+global using System.Collections;
 global using System.Security.Cryptography;
-global using System.Text;
+global using System.Text.Json.Serialization.Metadata;
+global using System.Text.Json.Serialization;
 global using System.Text.Json;
-global using System.Text.Json.Serialization;
+global using System.Text;
+
+// Global Tuple definitions
+global using BusinessKeyComponents = (int OrdinalPosition, DataWarehouseAutomation.DwaModel.IDataItem DataItem);
+global using BusinessKeyDefinitions = (int OrdinalPosition, DataWarehouseAutomation.DwaModel.BusinessKeyDefinition);
+global using Relationships = (int OrdinalPosition, DataWarehouseAutomation.DwaModel.Relationship);
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/Utils/DefaultJsonOptions.cs b/DataWarehouseAutomation/DataWarehouseAutomation/Utils/DefaultJsonOptions.cs
@@ -1,36 +1,29 @@
-﻿using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Text.Json.Serialization.Metadata;
-using System.Threading.Tasks;
+﻿using System.Text.Json.Serialization.Metadata;
 
-namespace DataWarehouseAutomation.Utils
+namespace DataWarehouseAutomation.Utils;
+
+public static class DefaultJsonOptions
 {
-    public static class DefaultJsonOptions
+    /// <summary>
+    /// Use as default when serializing objects to json strings/files
+    /// </summary>
+    public static JsonSerializerOptions SerializerOptions => new()
     {
-        /// <summary>
-        /// Use as default when serializing objects to json strings/files
-        /// </summary>
-        public static JsonSerializerOptions SerializerOptions => new()
-        {
-            TypeInfoResolver = new DefaultJsonTypeInfoResolver
-            {
-                Modifiers = { UtilityFunctions.DefaultValueModifier }
-            },
-            WriteIndented = true,
-            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-        };
-
-        /// <summary>
-        /// Use as default when deserializing json strings/files to objects
-        /// </summary>
-        public static JsonSerializerOptions DeserializerOptions => new()
+        TypeInfoResolver = new DefaultJsonTypeInfoResolver
         {
-            AllowTrailingCommas = true,
-            PropertyNameCaseInsensitive = true,
-            ReadCommentHandling = JsonCommentHandling.Skip,
-        };
+            Modifiers = { UtilityFunctions.DefaultValueModifier }
+        },
+        WriteIndented = true,
+        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+    };
 
-    }
+    /// <summary>
+    /// Use as default when deserializing json strings/files to objects
+    /// </summary>
+    public static JsonSerializerOptions DeserializerOptions => new()
+    {
+        AllowTrailingCommas = true,
+        PropertyNameCaseInsensitive = true,
+        ReadCommentHandling = JsonCommentHandling.Skip,
+    };
 }
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/Utils/HandleBarsHelpers.cs b/DataWarehouseAutomation/DataWarehouseAutomation/Utils/HandleBarsHelpers.cs
@@ -237,14 +237,14 @@ public static void RegisterHandleBarsHelpers()
 
         // Character spacing not satisfactory? Do not panic, help is near! Make sure the character spacing is righteous using this Handlebars helper.
         // Usage {{space sourceDataObject.name}} will space out (!?) the name of the source to 30 characters and a few tabs for lots of white spaces.
-        Handlebars.RegisterHelper("space", (writer, context, arguments) =>
+        Handlebars.RegisterHelper("space", (writer, _, arguments) =>
         {
             if (arguments.Length != 1)
             {
                 throw new HandlebarsException("The {{space}} functions requires an input string value to space out against.");
             }
 
-            string outputString = arguments[0].ToString();
+            string outputString = arguments[0]?.ToString() ?? "";
             if (outputString.Length < 30)
             {
                 outputString = outputString.PadRight(30);
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/Utils/JsonValidation.cs b/DataWarehouseAutomation/DataWarehouseAutomation/Utils/JsonValidation.cs
@@ -3,7 +3,7 @@
 
 namespace DataWarehouseAutomation.Utils;
 
-public class JsonValidation
+public static class JsonValidation
 {
     /// <summary>
     /// Struct to contain a Json.Net validation result with the collection of errors (if any).
diff --git a/DataWarehouseAutomation/DataWarehouseAutomation/Utils/UtilityFunctions.cs b/DataWarehouseAutomation/DataWarehouseAutomation/Utils/UtilityFunctions.cs

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public override bool Equals(object? obj)`
`77`	`77`	`/// <returns>The Name</returns>`
`78`	`78`	`public override string ToString()`
`79`	`79`	`{`
`80`		`- return Name;`
	`80`	`+ return Name ?? string.Empty;`
`81`	`81`	`}`
`82`	`82`	`#endregion`
`83`	`83`	`}`