Continue Repository Base Setup

Author: gruenwaldlk

PG.Commons/PG.Commons/Data/IId.cs

@@ -0,0 +1,20 @@
+using System;
+
+namespace PG.Commons.Data;
+
+/// <summary>
+///     A generic ID definition
+/// </summary>
+public interface IId : IEquatable<IId>
+{
+    /// <summary>
+    ///     The arity of the ID.
+    /// </summary>
+    int Arity { get; }
+
+    /// <summary>
+    ///     The string representation of the ID
+    /// </summary>
+    /// <returns></returns>
+    string Unwrap();
+}

PG.Commons/PG.Commons/Data/IdBase.cs

@@ -0,0 +1,85 @@
+using System;
+using System.Linq;
+using System.Text;
+using PG.Commons.Exceptions;
+
+namespace PG.Commons.Data;
+
+/// <inheritdoc />
+public abstract class IdBase : IId
+{
+    /// <summary>
+    ///     The ID components.
+    /// </summary>
+    protected readonly object?[] Components;
+
+    /// <summary>
+    ///     .ctor
+    /// </summary>
+    protected IdBase(params object[] components)
+    {
+        if (components.Length != Arity) throw new ArgumentException("Invalid number of components");
+        Components = new object[Arity];
+        for (var i = 0; i < Components.Length; i++) Components[i] = components[i];
+    }
+
+    /// <inheritdoc />
+    public bool Equals(IId? other)
+    {
+        return other != null && Arity == other.Arity && GetHashCode().Equals(other.GetHashCode());
+    }
+
+    /// <inheritdoc />
+    public int Arity => GetConfiguredArity();
+
+    /// <inheritdoc />
+    public string Unwrap()
+    {
+        var b = new StringBuilder();
+        b.Append(GetType().Name).Append('[');
+        foreach (var idComponent in Components) b.Append(idComponent).Append(';');
+        b.Remove(b.Length - 1, 1); // remove the last ";".
+        b.Append(']');
+        return b.ToString();
+    }
+
+    /// <summary>
+    ///     Convenience method to access components in a type-safe manner.
+    /// </summary>
+    /// <param name="idx"></param>
+    /// <param name="type"></param>
+    /// <typeparam name="T"></typeparam>
+    /// <returns></returns>
+    /// <exception cref="ArgumentException">If the provided index is out of bounds.</exception>
+    /// <exception cref="ArgumentNullException">If no <see cref="Type" /> is provided.</exception>
+    /// <exception cref="Exception"></exception>
+    protected T? GetIdComponent<T>(int idx, Type type) where T : class
+    {
+        if (idx > 0 || idx >= Arity) throw new ArgumentException("Invalid component index");
+        if (type == null) throw new ArgumentNullException(nameof(type));
+        var c = Components[idx];
+        if (c?.GetType() != type) throw new TypeMismatchException($"Component {idx - 1} is not of type {type}");
+        return c as T;
+    }
+
+    /// <inheritdoc />
+    public override int GetHashCode()
+    {
+        return HashCode.Combine(GetConfiguredArity(), HashCode.Combine(Components));
+    }
+
+    /// <summary>
+    ///     Returns true if this ID is equivalent to null.
+    /// </summary>
+    /// <returns></returns>
+    protected virtual bool IsNullId()
+    {
+        return Components.Any();
+    }
+
+    /// <summary>
+    ///     The arity of this ID type.
+    /// </summary>
+    /// <returns></returns>
+    protected abstract int GetConfiguredArity();
+}

PG.Commons/PG.Commons/Data/RootIdBase.cs

@@ -0,0 +1,40 @@
+using System;
+
+namespace PG.Commons.Data;
+
+/// <inheritdoc cref="PG.Commons.Data.IdBase" />
+public abstract class RootIdBase<T> : IdBase, IComparable<RootIdBase<T>> where T : class, IComparable<T>
+{
+    /// <inheritdoc />
+    protected RootIdBase(T rawId) : base(rawId)
+    {
+    }
+
+    /// <inheritdoc />
+    public int CompareTo(RootIdBase<T>? other)
+    {
+        return other == null ? 1 : Raw().CompareTo(other.Raw());
+    }
+
+    /// <inheritdoc />
+    protected override int GetConfiguredArity()
+    {
+        return 1;
+    }
+
+    /// <inheritdoc />
+    protected override bool IsNullId()
+    {
+        return Components[0] == null;
+    }
+
+    /// <summary>
+    ///     Raw value.
+    /// </summary>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
+    public T Raw()
+    {
+        return Components[0] as T ?? throw new InvalidOperationException();
+    }
+}

PG.Commons/PG.Commons/Exceptions/TypeMismatchException.cs

@@ -0,0 +1,25 @@
+using System;
+
+namespace PG.Commons.Exceptions;
+
+/// <summary>
+///     Thrown if the provided type does not match the requested type. Usually thrown when a generic request for a key
+///     component is not logically sound.
+/// </summary>
+public class TypeMismatchException : Exception
+{
+    /// <inheritdoc />
+    public TypeMismatchException()
+    {
+    }
+
+    /// <inheritdoc />
+    public TypeMismatchException(string message) : base(message)
+    {
+    }
+
+    /// <inheritdoc />
+    public TypeMismatchException(string message, Exception inner) : base(message, inner)
+    {
+    }
+}

PG.StarWarsGame.Components.Localisation/PG.StarWarsGame.Components.Localisation/Repository/Content/ITranslationItemContent.cs

@@ -13,5 +13,5 @@ public interface ITranslationItemContent
     /// <summary>
     ///     The string value, usually mapped to <see cref="PG.StarWarsGame.Files.DAT.Data.DatStringEntry.Value" />
     /// </summary>
-    string Value { get; set; }
+    string? Value { get; set; }
 }

PG.StarWarsGame.Components.Localisation/PG.StarWarsGame.Components.Localisation/Repository/Content/ITranslationItemId.cs

@@ -1,8 +1,10 @@
+using PG.Commons.Data;
+
 namespace PG.StarWarsGame.Components.Localisation.Repository.Content;
 
 /// <summary>
 ///     The unique item ID, could be the string key, or any other unique ID.
 /// </summary>
-public interface ITranslationItemId
+public interface ITranslationItemId : IId
 {
 }

PG.StarWarsGame.Components.Localisation/PG.StarWarsGame.Components.Localisation/Repository/Content/OrderedTranslationItem.cs

@@ -0,0 +1,43 @@
+using System;
+
+namespace PG.StarWarsGame.Components.Localisation.Repository.Content;
+
+/// <inheritdoc />
+public class OrderedTranslationItem : TranslationItemBase
+{
+    /// <inheritdoc />
+    protected OrderedTranslationItem(OrderedTranslationItemId itemId, TranslationItemContent content,
+        ITranslationItem.TranslationItemSource source, bool overwritten) : base(itemId, content, source, overwritten)
+    {
+    }
+
+    /// <summary>
+    ///     Convenience method to create a new <see cref="OrderedTranslationItem" />
+    /// </summary>
+    /// <param name="itemId"></param>
+    /// <param name="content"></param>
+    /// <param name="source"></param>
+    /// <param name="overwritten"></param>
+    /// <returns></returns>
+    public static OrderedTranslationItem Of(OrderedTranslationItemId itemId, TranslationItemContent content,
+        ITranslationItem.TranslationItemSource source, bool overwritten)
+    {
+        return new OrderedTranslationItem(itemId, content, source, overwritten);
+    }
+
+    /// <summary>
+    ///     Convenience method to create a new <see cref="OrderedTranslationItem" />
+    /// </summary>
+    /// <param name="content"></param>
+    /// <param name="source"></param>
+    /// <param name="overwritten"></param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
+    public static OrderedTranslationItem Of(TranslationItemContent content,
+        ITranslationItem.TranslationItemSource source = ITranslationItem.TranslationItemSource.Mod,
+        bool overwritten = false)
+    {
+        return Of(OrderedTranslationItemId.Of(content.Key) ?? throw new InvalidOperationException(), content, source,
+            overwritten);
+    }
+}

PG.StarWarsGame.Components.Localisation/PG.StarWarsGame.Components.Localisation/Repository/Content/OrderedTranslationItemId.cs

@@ -0,0 +1,24 @@
+using PG.Commons.Data;
+
+namespace PG.StarWarsGame.Components.Localisation.Repository.Content;
+
+/// <summary>
+///     Item ID for ordered translation items. Equivalent to the raw string key from a sorted DAT file.
+/// </summary>
+public class OrderedTranslationItemId : RootIdBase<string>, ITranslationItemId
+{
+    /// <inheritdoc />
+    protected OrderedTranslationItemId(string rawId) : base(rawId)
+    {
+    }
+
+    /// <summary>
+    ///     Convenience method to create a new <see cref="OrderedTranslationItemId" />
+    /// </summary>
+    /// <param name="rawId"></param>
+    /// <returns></returns>
+    public static OrderedTranslationItemId? Of(string rawId)
+    {
+        return string.IsNullOrWhiteSpace(rawId) ? null : new OrderedTranslationItemId(rawId);
+    }
+}

PG.StarWarsGame.Components.Localisation/PG.StarWarsGame.Components.Localisation/Repository/Content/TranslationItemBase.cs

@@ -0,0 +1,33 @@
+namespace PG.StarWarsGame.Components.Localisation.Repository.Content;
+
+/// <inheritdoc />
+public abstract class TranslationItemBase : ITranslationItem
+{
+    /// <summary>
+    ///     .ctor
+    /// </summary>
+    /// <param name="itemId"></param>
+    /// <param name="content"></param>
+    /// <param name="source"></param>
+    /// <param name="overwritten"></param>
+    protected TranslationItemBase(ITranslationItemId itemId, TranslationItemContent content,
+        ITranslationItem.TranslationItemSource source, bool overwritten)
+    {
+        ItemId = itemId;
+        Content = content;
+        Source = source;
+        Overwritten = overwritten;
+    }
+
+    /// <inheritdoc />
+    public ITranslationItemContent Content { get; set; }
+
+    /// <inheritdoc />
+    public ITranslationItemId ItemId { get; }
+
+    /// <inheritdoc />
+    public ITranslationItem.TranslationItemSource Source { get; }
+
+    /// <inheritdoc />
+    public bool Overwritten { get; }
+}

PG.StarWarsGame.Components.Localisation/PG.StarWarsGame.Components.Localisation/Repository/Content/TranslationItemContent.cs

@@ -0,0 +1,11 @@
+namespace PG.StarWarsGame.Components.Localisation.Repository.Content;
+
+/// <inheritdoc />
+public record TranslationItemContent : ITranslationItemContent
+{
+    /// <inheritdoc />
+    public required string Key { get; set; }
+
+    /// <inheritdoc />
+    public string? Value { get; set; }
+}