Merge pull request #1 from jmayer913/v1.0.0/VersionBranch

V1.0.0/version branch

Author: jmayer913

.github/workflows/mainworkflow.yml

@@ -0,0 +1,29 @@
+# This workflow will build a .NET project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
+
+name: MainWorkflow
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --configuration Release --no-restore
+    - name: Test
+      run: dotnet test --verbosity normal

JMayer.Example.ASPReact.Server/Airlines/Airline.cs

@@ -0,0 +1,59 @@
+using JMayer.Data.Data;
+using System.ComponentModel.DataAnnotations;
+
+namespace JMayer.Example.ASPReact.Server.Airlines;
+
+/// <summary>
+/// The class represents an airline and its codes.
+/// </summary>
+public class Airline : UserEditableDataObject
+{
+    /// <summary>
+    /// The property gets/sets the IATA code assigned by the IATA organization.
+    /// </summary>
+    [Required]
+    [RegularExpression("^[A-Z0-9]{2}$", ErrorMessage = "The IATA must be 2 alphanumeric characters; letters must be capitalized.")]
+    public string IATA { get;set; } = string.Empty;
+
+    /// <summary>
+    /// The property gets/sets the ICAO code assigned by the International Aviation Organization.
+    /// </summary>
+    [RegularExpression("^[A-Z]{3}$", ErrorMessage = "The ICAO must be 3 capital letters.")]
+    public string ICAO { get; set; } = string.Empty;
+
+    /// <summary>
+    /// The property gets/sets the number code assigned by the IATA organization.
+    /// </summary>
+    [Required]
+    [RegularExpression("^\\d{3}$", ErrorMessage = "The number code must be 3 digits.")]
+    public string NumberCode { get; set; } = ZeroNumberCode;
+
+    /// <summary>
+    /// The constant for the zero number code.
+    /// </summary>
+    public const string ZeroNumberCode = "000";
+
+    /// <summary>
+    /// The default constructor.
+    /// </summary>
+    public Airline() { }
+
+    /// <summary>
+    /// The copy constructor.
+    /// </summary>
+    /// <param name="copy">The copy.</param>
+    public Airline(Airline copy) => MapProperties(copy);
+
+    /// <inheritdoc/>
+    public override void MapProperties(DataObject dataObject)
+    {
+        base.MapProperties(dataObject);
+
+        if (dataObject is Airline airline)
+        {
+            IATA = airline.IATA;
+            ICAO = airline.ICAO;
+            NumberCode = airline.NumberCode;
+        }
+    }
+}

JMayer.Example.ASPReact.Server/Airlines/AirlineController.cs

@@ -0,0 +1,15 @@
+using JMayer.Web.Mvc.Controller;
+using Microsoft.AspNetCore.Mvc;
+
+namespace JMayer.Example.ASPReact.Server.Airlines;
+
+/// <summary>
+/// The class manages HTTP requests for CRUD operations associated with an airline in a database.
+/// </summary>
+[Route("api/[controller]")]
+[ApiController]
+public class AirlineController : UserEditableController<Airline, IAirlineDataLayer>
+{
+    /// <inheritdoc/>
+    public AirlineController(IAirlineDataLayer dataLayer, ILogger<AirlineController> logger) : base(dataLayer, logger) { }
+}

JMayer.Example.ASPReact.Server/Airlines/AirlineDataLayer.cs

@@ -0,0 +1,31 @@
+using JMayer.Data.Database.DataLayer.MemoryStorage;
+using System.ComponentModel.DataAnnotations;
+
+namespace JMayer.Example.ASPReact.Server.Airlines;
+
+/// <summary>
+/// The class manages CRUD interactions with the database for an airline.
+/// </summary>
+public class AirlineDataLayer : UserEditableDataLayer<Airline>, IAirlineDataLayer
+{
+    /// <inheritdoc/>
+    /// <remarks>
+    /// Overriden to check the ICAO is unique and the number code is unique (expect for 000).
+    /// </remarks>
+    public override async Task<List<ValidationResult>> ValidateAsync(Airline dataObject, CancellationToken cancellationToken = default)
+    {
+        List<ValidationResult> validationResults = await base.ValidateAsync(dataObject, cancellationToken);
+
+        if (dataObject.ICAO != null && await ExistAsync(obj => obj.Integer64ID != dataObject.Integer64ID && obj.ICAO == dataObject.ICAO, cancellationToken) == true)
+        {
+            validationResults.Add(new ValidationResult("The ICAO must be unique.", [nameof(Airline.ICAO)]));
+        }
+
+        if (dataObject.NumberCode != Airline.ZeroNumberCode && await ExistAsync(obj => obj.Integer64ID != dataObject.Integer64ID && obj.NumberCode == dataObject.NumberCode, cancellationToken) == true)
+        {
+            validationResults.Add(new ValidationResult("The number code must be unique unless the code is 000.", [nameof(Airline.NumberCode)]));
+        }
+
+        return validationResults;
+    }
+}

JMayer.Example.ASPReact.Server/Airlines/AirlineEqualityComparer.cs

@@ -0,0 +1,63 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace JMayer.Example.ASPReact.Server.Airlines;
+
+/// <summary>
+/// The class manages comparing two Airline objects.
+/// </summary>
+public class AirlineEqualityComparer : IEqualityComparer<Airline>
+{
+    /// <summary>
+    /// Excludes the CreatedOn property from the equals check.
+    /// </summary>
+    private readonly bool _excludeCreatedOn;
+
+    /// <summary>
+    /// Excludes the ID property from the equals check.
+    /// </summary>
+    private readonly bool _excludeID;
+
+    /// <summary>
+    /// Excludes the LastEditedOn property from the equals check.
+    /// </summary>
+    private readonly bool _excludeLastEditedOn;
+
+    /// <summary>
+    /// The default constructor.
+    /// </summary>
+    public AirlineEqualityComparer() { }
+
+    /// <summary>
+    /// The property constructor.
+    /// </summary>
+    /// <param name="excludeCreatedOn">Excludes the CreatedOn property from the equals check.</param>
+    /// <param name="excludeID">Excludes the ID property from the equals check.</param>
+    /// <param name="excludeLastEditedOn">Excludes the LastEditedOn property from the equals check.</param>
+    public AirlineEqualityComparer(bool excludeCreatedOn, bool excludeID, bool excludeLastEditedOn)
+    {
+        _excludeCreatedOn = excludeCreatedOn;
+        _excludeID = excludeID;
+        _excludeLastEditedOn = excludeLastEditedOn;
+    }
+
+    /// <inheritdoc/>
+    public bool Equals(Airline? x, Airline? y)
+    {
+        if (x == null || y == null)
+        {
+            return false;
+        }
+
+        return (_excludeCreatedOn || x.CreatedOn == y.CreatedOn)
+            && x.Description == y.Description
+            && x.IATA == y.IATA
+            && x.ICAO == y.ICAO
+            && (_excludeID || x.Integer64ID == y.Integer64ID)
+            && (_excludeLastEditedOn || x.LastEditedBy == y.LastEditedBy)
+            && x.Name == y.Name
+            && x.NumberCode == y.NumberCode;
+    }
+
+    /// <inheritdoc/>
+    public int GetHashCode([DisallowNull] Airline obj) => obj.GetHashCode();
+}

JMayer.Example.ASPReact.Server/Airlines/IAirlineDataLayer.cs

@@ -0,0 +1,10 @@
+using JMayer.Data.Database.DataLayer;
+
+namespace JMayer.Example.ASPReact.Server.Airlines;
+
+/// <summary>
+/// The interface for interacting with an airline collection in a database using CRUD operations.
+/// </summary>
+public interface IAirlineDataLayer : IUserEditableDataLayer<Airline>
+{
+}