Add tests for Equality

Linguini.Bundle.Test/Unit/BundleTests.cs

@@ -358,5 +358,40 @@ public void TestDynamicSelectors()
             Assert.That(bundle.TryGetMessage("you-see", args, out _, out var message2));
             Assert.That("You see a fairy.", Is.EqualTo(message2));
         }
+
+        [Test]
+        public void TestDeepClone()
+        {
+            var originalBundleOption = new FluentBundleOption
+            {
+                Locales = { "en-US" },
+                MaxPlaceable = 123,
+                UseIsolating = false,
+                TransformFunc = _transform,
+                FormatterFunc = _formatter,
+                Functions = new Dictionary<string, ExternalFunction>()
+                {
+                    ["zero"] = _zeroFunc,
+                    ["id"] = _idFunc,
+                }
+            };
+
+            // Assume FluentBundle object has DeepClone method
+            FluentBundle originalBundle = FluentBundle.MakeUnchecked(originalBundleOption);
+            FluentBundle clonedBundle = originalBundle.DeepClone();
+
+            // Assert that the original and cloned objects are not the same reference
+            Assert.That(originalBundle, Is.Not.SameAs(clonedBundle));
+
+            // Assert that the properties are copied properly
+            Assert.That(originalBundle, Is.EqualTo(clonedBundle));
+
+            // Assert that if original property is changed, new property isn't.
+            originalBundle.AddFunctionOverriding("zero", _idFunc);
+            clonedBundle.TryGetFunction("zero", out var clonedZero);
+            Assert.That((FluentFunction) _zeroFunc, Is.EqualTo(clonedZero));
+            originalBundle.TryGetFunction("zero", out var originalZero);
+            Assert.That((FluentFunction) _idFunc, Is.EqualTo(originalZero));
+        }
     }
 }

Linguini.Bundle/ConcurrentBundle.cs

@@ -13,7 +13,7 @@
 
 namespace Linguini.Bundle
 {
-    public sealed class ConcurrentBundle : FluentBundle
+    public sealed class ConcurrentBundle : FluentBundle, IEquatable<ConcurrentBundle>
     {
         internal ConcurrentDictionary<string, FluentFunction> FuncList = new();
         private ConcurrentDictionary<string, AstTerm> _terms = new();
@@ -49,7 +49,7 @@ protected override bool TryAddMessage(AstMessage message, List<FluentError>? err
             return false;
         }
 
-        
+
         /// <inheritdoc />
         public override bool TryAddFunction(string funcName, ExternalFunction fluentFunction)
         {
@@ -74,7 +74,7 @@ public override bool HasMessage(string identifier)
         {
             return _messages.ContainsKey(identifier);
         }
-        
+
         /// <inheritdoc />
         public override bool TryGetAstMessage(string ident, [NotNullWhen(true)] out AstMessage? message)
         {
@@ -111,7 +111,7 @@ public override IEnumerable<string> GetTermEnumerable()
         {
             return _terms.Keys.ToArray();
         }
-        
+
         /// <inheritdoc/>
         public override FluentBundle DeepClone()
         {
@@ -120,7 +120,7 @@ public override FluentBundle DeepClone()
                 FuncList = new ConcurrentDictionary<string, FluentFunction>(FuncList),
                 _terms = new ConcurrentDictionary<string, AstTerm>(_terms),
                 _messages = new ConcurrentDictionary<string, AstMessage>(_messages),
-                Culture = (CultureInfo) Culture.Clone(),
+                Culture = (CultureInfo)Culture.Clone(),
                 Locales = new List<string>(Locales),
                 UseIsolating = UseIsolating,
                 TransformFunc = (Func<string, string>?)TransformFunc?.Clone(),
@@ -129,6 +129,26 @@ public override FluentBundle DeepClone()
                 EnableExtensions = EnableExtensions,
             };
         }
+
+        /// <inheritdoc/>
+        public bool Equals(ConcurrentBundle? other)
+        {
+            if (ReferenceEquals(null, other)) return false;
+            if (ReferenceEquals(this, other)) return true;
+            return base.Equals(other) && FuncList.SequenceEqual(other.FuncList) && _terms.SequenceEqual(other._terms) &&
+                   _messages.SequenceEqual(other._messages);
+        }
+
+        /// <inheritdoc/>
+        public override bool Equals(object? obj)
+        {
+            return ReferenceEquals(this, obj) || obj is ConcurrentBundle other && Equals(other);
+        }
 
+        /// <inheritdoc/>
+        public override int GetHashCode()
+        {
+            return HashCode.Combine(base.GetHashCode(), FuncList, _terms, _messages);
+        }
     }
 }

Linguini.Bundle/FluentBundle.cs

@@ -15,7 +15,7 @@
 
 namespace Linguini.Bundle
 {
-    public abstract class FluentBundle
+    public abstract class FluentBundle : IEquatable<FluentBundle>
     {
         /// <summary>
         /// <see cref="CultureInfo"/> of the bundle. Primary bundle locale
@@ -60,7 +60,7 @@ public abstract class FluentBundle
         /// </summary>
         // ReSharper disable once MemberCanBeProtected.Global
         public bool EnableExtensions { get; init; }
-        
+
         public bool AddResource(string input, [NotNullWhen(false)] out List<FluentError>? errors)
         {
             var res = new LinguiniParser(input, EnableExtensions).Parse();
@@ -123,10 +123,23 @@ private void InternalResourceOverriding(Resource resource)
             }
         }
 
+        /// <summary>
+        /// Adds the given AstMessage to the collection of messages, by overriding any existing messages with the same name.
+        /// </summary>
+        /// <param name="message">The AstMessage to be added.</param>
         protected abstract void AddMessageOverriding(AstMessage message);
 
+        /// <summary>
+        /// Adds a term to the AstTerm list, overriding any existing term with the same name.
+        /// </summary>
+        /// <param name="term">The term to be added.</param>
         protected abstract void AddTermOverriding(AstTerm term);
 
+        /// <summary>
+        /// Adds a resource.
+        /// Any messages or terms in bundle will be overriden by the existing ones.
+        /// </summary>
+        /// <param name="input">The input string containing the resource data.</param>
         public void AddResourceOverriding(string input)
         {
             var res = new LinguiniParser(input, EnableExtensions).Parse();
@@ -387,5 +400,32 @@ public static FluentBundle MakeUnchecked(FluentBundleOption option)
                 }
             };
         }
+
+        /// <inheritdoc/>
+        public bool Equals(FluentBundle? other)
+        {
+            if (ReferenceEquals(null, other)) return false;
+            if (ReferenceEquals(this, other)) return true;
+            return Culture.Equals(other.Culture) && Locales.SequenceEqual(other.Locales) &&
+                   UseIsolating == other.UseIsolating && Equals(TransformFunc, other.TransformFunc) &&
+                   Equals(FormatterFunc, other.FormatterFunc) && MaxPlaceable == other.MaxPlaceable &&
+                   EnableExtensions == other.EnableExtensions;
+        }
+
+        /// <inheritdoc/>
+        public override bool Equals(object? obj)
+        {
+            if (ReferenceEquals(null, obj)) return false;
+            if (ReferenceEquals(this, obj)) return true;
+            if (obj.GetType() != GetType()) return false;
+            return Equals((FluentBundle)obj);
+        }
+
+        /// <inheritdoc/>
+        public override int GetHashCode()
+        {
+            return HashCode.Combine(Culture, Locales, UseIsolating, TransformFunc, FormatterFunc, MaxPlaceable,
+                EnableExtensions);
+        }
     }
 }

Linguini.Bundle/NonConcurrentBundle.cs

@@ -12,7 +12,7 @@
 
 namespace Linguini.Bundle
 {
-    public sealed class NonConcurrentBundle : FluentBundle
+    public sealed class NonConcurrentBundle : FluentBundle, IEquatable<NonConcurrentBundle>
     {
         internal Dictionary<string, FluentFunction> FuncList = new();
         private Dictionary<string, AstTerm> _terms = new();
@@ -48,7 +48,7 @@ protected override bool TryAddMessage(AstMessage message, List<FluentError>? err
             return false;
         }
 
-        
+
         /// <inheritdoc />
         public override bool TryAddFunction(string funcName, ExternalFunction fluentFunction)
         {
@@ -72,7 +72,7 @@ public override bool HasMessage(string identifier)
         {
             return _messages.ContainsKey(identifier);
         }
-        
+
         /// <inheritdoc />
         public override bool TryGetAstMessage(string ident, [NotNullWhen(true)] out AstMessage? message)
         {
@@ -119,7 +119,7 @@ public override FluentBundle DeepClone()
                 FuncList = new Dictionary<string, FluentFunction>(FuncList),
                 _terms = new Dictionary<string, AstTerm>(_terms),
                 _messages = new Dictionary<string, AstMessage>(_messages),
-                Culture = (CultureInfo) Culture.Clone(),
+                Culture = (CultureInfo)Culture.Clone(),
                 Locales = new List<string>(Locales),
                 UseIsolating = UseIsolating,
                 TransformFunc = (Func<string, string>?)TransformFunc?.Clone(),
@@ -128,5 +128,23 @@ public override FluentBundle DeepClone()
                 EnableExtensions = EnableExtensions,
             };
         }
+
+        public bool Equals(NonConcurrentBundle? other)
+        {
+            if (ReferenceEquals(null, other)) return false;
+            if (ReferenceEquals(this, other)) return true;
+            return base.Equals(other) && FuncList.SequenceEqual(other.FuncList) && _terms.SequenceEqual(other._terms) &&
+                   _messages.SequenceEqual(other._messages);
+        }
+
+        public override bool Equals(object? obj)
+        {
+            return ReferenceEquals(this, obj) || obj is NonConcurrentBundle other && Equals(other);
+        }
+
+        public override int GetHashCode()
+        {
+            return HashCode.Combine(base.GetHashCode(), FuncList, _terms, _messages);
+        }
     }
 }