refac: interface and class naming

changes:
- renamed all the interfaces
- renamed all the implementations
- renamed all the unit tests
- improved comments
- added new constructors

closes #76

Author: BoBoBaSs84

src/BB84.Notifications/BindableProperty.cs

@@ -3,16 +3,20 @@
 namespace BB84.Notifications.Components;
 
 /// <summary>
-/// The property changed event args class.
+/// Provides data for the <see cref="INotifyPropertyChanged"/> event.
 /// </summary>
 /// <typeparam name="T">The type to work with.</typeparam>
-/// <remarks>
-/// Initializes a instance of the property changed event args class.
-/// </remarks>
-/// <param name="name">The name of the property that is changed.</param>
+/// <param name="propertyName">The name of the property that is changed.</param>
 /// <param name="value">The value of the property that is changed.</param>
-public sealed class PropertyChangedEventArgs<T>(string name, T value) : PropertyChangedEventArgs(name)
+public sealed class PropertyChangedEventArgs<T>(string? propertyName, T value) : PropertyChangedEventArgs(propertyName)
 {
+  /// <remarks>
+  /// Initializes a instance of the <see cref="PropertyChangedEventArgs{T}"/> class.
+  /// </remarks>
+  /// <param name="value">The value of the property that is changed.</param>
+  public PropertyChangedEventArgs(T value) : this(null, value)
+    => Value = value;
+
   /// <summary>
   /// The value of the property that is changed.
   /// </summary>

src/BB84.Notifications/Components/PropertyChangedEventArgs.cs

@@ -3,16 +3,20 @@
 namespace BB84.Notifications.Components;
 
 /// <summary>
-/// The property changing event args class.
+/// Provides data for the <see cref="INotifyPropertyChanging"/> event.
 /// </summary>
 /// <typeparam name="T">The type to work with.</typeparam>
-/// <remarks>
-/// Initializes a instance of the property changing event args class.
-/// </remarks>
-/// <param name="name">The name of the property that is changing.</param>
+/// <param name="propertyName">The name of the property that is changing.</param>
 /// <param name="value">The value of the property that is changing.</param>
-public sealed class PropertyChangingEventArgs<T>(string name, T value) : PropertyChangingEventArgs(name)
+public sealed class PropertyChangingEventArgs<T>(string? propertyName, T value) : PropertyChangingEventArgs(propertyName)
 {
+  /// <summary>
+  /// Initializes a instance of the <see cref="PropertyChangingEventArgs{T}"/> class.
+  /// </summary>
+  /// <param name="value">The value of the property that is changing.</param>
+  public PropertyChangingEventArgs(T value) : this(null, value)
+    => Value = value;
+
   /// <summary>
   /// The value of the property that is changing.
   /// </summary>

src/BB84.Notifications/Components/PropertyChangingEventArgs.cs

@@ -6,8 +6,8 @@
 namespace BB84.Notifications.Interfaces;
 
 /// <summary>
-/// The notification collection interface.
+/// The notifiable collection interface.
 /// </summary>
 [SuppressMessage("Naming", "CA1711", Justification = "Identifier is correct here")]
-public interface INotificationCollection : INotifyCollectionChanged, INotifyCollectionChanging, INotifyPropertyChanged, INotifyPropertyChanging
+public interface INotifiableCollection : INotifyCollectionChanged, INotifyCollectionChanging, INotifyPropertyChanged, INotifyPropertyChanging
 { }

src/BB84.Notifications/Interfaces/INotificationCollection.cs src/BB84.Notifications/Interfaces/INotifiableCollection.cs

@@ -0,0 +1,9 @@
+using System.ComponentModel;
+
+namespace BB84.Notifications.Interfaces;
+
+/// <summary>
+/// The notifiable object interface.
+/// </summary>
+public interface INotifiableObject : INotifyPropertyChanged, INotifyPropertyChanging
+{ }

src/BB84.Notifications/Interfaces/INotifiableObject.cs

@@ -3,23 +3,23 @@
 namespace BB84.Notifications.Interfaces;
 
 /// <summary>
-/// The bindable property interface.
+/// The notifiable property interface.
 /// </summary>
 /// <typeparam name="T">The value type to work with.</typeparam>
-public interface IBindableProperty<T> : INotifyPropertyChanged, INotifyPropertyChanging
+public interface INotifiableProperty<T> : INotifyPropertyChanged, INotifyPropertyChanging
 {
   /// <summary>
-  /// Is the value of the bindable property the default value?
+  /// Is the value of the notifiable property the default value?
   /// </summary>
   bool IsDefault { get; }
 
   /// <summary>
-  /// Is the value of the bindable property null?
+  /// Is the value of the notifiable property null?
   /// </summary>
   bool IsNull { get; }
 
   /// <summary>
-  /// The actual value of the bindable property.
+  /// The actual value of the notifiable property.
   /// </summary>
   T Value { get; set; }
 }

src/BB84.Notifications/Interfaces/IBindableProperty.cs src/BB84.Notifications/Interfaces/INotifiableProperty.cs

@@ -7,10 +7,10 @@
 namespace BB84.Notifications;
 
 /// <summary>
-/// The notification collection class.
+/// The notifiable collection class.
 /// </summary>
 [SuppressMessage("Naming", "CA1711", Justification = "Identifier is correct here")]
-public abstract class NotificationCollection : NotificationObject, INotificationCollection
+public abstract class NotifiableCollection : NotifiableObject, INotifiableCollection
 {
   /// <inheritdoc/>
   public event CollectionChangedEventHandler? CollectionChanged;

src/BB84.Notifications/Interfaces/INotificationObject.cs

@@ -9,9 +9,9 @@
 namespace BB84.Notifications;
 
 /// <summary>
-///	The notification object class.
+///	The notifiable object class.
 /// </summary>
-public abstract class NotificationObject : INotificationObject
+public abstract class NotifiableObject : INotifiableObject
 {
   /// <inheritdoc/>
   public event PropertyChangedEventHandler? PropertyChanged;

src/BB84.Notifications/NotificationCollection.cs src/BB84.Notifications/NotifiableCollection.cs

@@ -0,0 +1,51 @@
+using System.ComponentModel;
+
+using BB84.Notifications.Components;
+using BB84.Notifications.Interfaces;
+
+namespace BB84.Notifications;
+
+/// <summary>
+/// The notifiable property class.
+/// </summary>
+/// <typeparam name="T">The value type to work with.</typeparam>
+/// <inheritdoc/>
+/// <param name="value">The value of the notifiable property.</param>
+public sealed class NotifiableProperty<T>(T value) : INotifiableProperty<T>
+{
+  private T _value = value;
+
+  /// <inheritdoc/>
+  public bool IsDefault => EqualityComparer<T>.Default.Equals(_value, default!);
+
+  /// <inheritdoc/>
+  public bool IsNull => _value is null;
+
+  /// <inheritdoc/>
+  public T Value
+  {
+    get => _value;
+    set => SetProperty(ref _value, value);
+  }
+
+  /// <inheritdoc/>
+  public event PropertyChangedEventHandler? PropertyChanged;
+
+  /// <inheritdoc/>
+  public event PropertyChangingEventHandler? PropertyChanging;
+
+  /// <summary>
+  /// Sets the new value the property and notifies about the change.
+  /// </summary>
+  /// <param name="fieldValue">The referenced value field.</param>
+  /// <param name="newValue">The new value for the property.</param>
+  private void SetProperty(ref T fieldValue, T newValue)
+  {
+    if (!EqualityComparer<T>.Default.Equals(fieldValue, newValue))
+    {
+      PropertyChanging?.Invoke(this, new PropertyChangingEventArgs<T>(fieldValue));
+      fieldValue = newValue;
+      PropertyChanged?.Invoke(this, new PropertyChangedEventArgs<T>(newValue));
+    }
+  }
+}

src/BB84.Notifications/NotificationObject.cs src/BB84.Notifications/NotifiableObject.cs

@@ -8,7 +8,7 @@ namespace BB84.Notifications;
 /// <summary>
 /// The validatable object class.
 /// </summary>
-public abstract class ValidatableObject : NotificationObject, Interfaces.IValidatableObject
+public abstract class ValidatableObject : NotifiableObject, Interfaces.IValidatableObject
 {
   private readonly Dictionary<string, List<string?>> _errors = [];
 
@@ -21,20 +21,13 @@ public abstract class ValidatableObject : NotificationObject, Interfaces.IValida
 #if NET5_0_OR_GREATER
   /// <inheritdoc/>
   public IEnumerable GetErrors(string? propertyName)
-  {
-    if (propertyName is null)
-      return _errors;
-
-    List<string?>? values = [];
-    return _errors.TryGetValue(propertyName, out values) ? values : Array.Empty<string?>();
-  }
+    => propertyName is null
+    ? _errors
+    : _errors.TryGetValue(propertyName, out List<string?>? values) ? values : Array.Empty<string?>();
 #else
   /// <inheritdoc/>
   public IEnumerable GetErrors(string propertyName)
-  {
-    List<string?> values = [];
-    return _errors.TryGetValue(propertyName, out values) ? values : Array.Empty<string?>();
-  }
+    => _errors.TryGetValue(propertyName, out List<string?> values) ? values : Array.Empty<string?>();
 #endif
 
   /// <summary>

src/BB84.Notifications/NotifiableProperty.cs

@@ -20,7 +20,7 @@ public void NotifyChangedAttributeTest()
     Assert.AreEqual(nameof(TestClass.TotalValue), propertiesNotified.Last());
   }
 
-  private sealed class TestClass : NotificationObject
+  private sealed class TestClass : NotifiableObject
   {
     private int _quantity;
     private int _value;

src/BB84.Notifications/ValidatableObject.cs

@@ -20,7 +20,7 @@ public void NotifyChangingAttributeTest()
     Assert.AreEqual(nameof(TestClass.TotalValue), propertiesNotified.Last());
   }
 
-  private sealed class TestClass : NotificationObject
+  private sealed class TestClass : NotifiableObject
   {
     private int _quantity;
     private int _value;

tests/BB84.NotificationsTests/Attributes/NotifyChangedAttributeTests.cs

@@ -4,7 +4,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class NotificationCollectionTests
+public sealed partial class NotifiableCollectionTests
 {
   [TestMethod]
   public void Adding()

tests/BB84.NotificationsTests/Attributes/NotifyChangingAttributeTests.cs

@@ -2,7 +2,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class NotificationCollectionTests
+public sealed partial class NotifiableCollectionTests
 {
   [TestMethod]
   public void Refreshing()

tests/BB84.NotificationsTests/NotificationCollectionTests.Add.cs tests/BB84.NotificationsTests/NotifiableCollectionTests.Add.cs

@@ -4,7 +4,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class NotificationCollectionTests
+public sealed partial class NotifiableCollectionTests
 {
   [TestMethod]
   public void Removing()

tests/BB84.NotificationsTests/NotificationCollectionTests.Refresh.cs tests/BB84.NotificationsTests/NotifiableCollectionTests.Refresh.cs

@@ -7,11 +7,11 @@
 namespace BB84.NotificationsTests;
 
 [TestClass]
-public sealed partial class NotificationCollectionTests
+public sealed partial class NotifiableCollectionTests
 {
   private const string UnitTestString = "UnitTest";
 
-  private sealed class MyCollection : NotificationCollection, ICollection<string>
+  private sealed class MyCollection : NotifiableCollection, ICollection<string>
   {
     private readonly Collection<string> _collection;
 

tests/BB84.NotificationsTests/NotificationCollectionTests.Remove.cs tests/BB84.NotificationsTests/NotifiableCollectionTests.Remove.cs

@@ -2,7 +2,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class NotificationObjectTests
+public sealed partial class NotifiableObjectTests
 {
   [TestMethod]
   public void Changed()

tests/BB84.NotificationsTests/NotificationCollectionTests.cs tests/BB84.NotificationsTests/NotifiableCollectionTests.cs

@@ -2,7 +2,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class NotificationObjectTests
+public sealed partial class NotifiableObjectTests
 {
   [TestMethod]
   public void Changing()

tests/BB84.NotificationsTests/NotificationObjectTests.Changed.cs tests/BB84.NotificationsTests/NotifiableObjectTests.Changed.cs

@@ -3,9 +3,9 @@
 namespace BB84.NotificationsTests;
 
 [TestClass]
-public sealed partial class NotificationObjectTests
+public sealed partial class NotifiableObjectTests
 {
-  private sealed class TestClass : NotificationObject
+  private sealed class TestClass : NotifiableObject
   {
     private int _property;
 

tests/BB84.NotificationsTests/NotificationObjectTests.Changing.cs tests/BB84.NotificationsTests/NotifiableObjectTests.Changing.cs

@@ -2,7 +2,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class BindablePropertyTests
+public sealed partial class NotifiablePropertyTests
 {
   [TestMethod]
   public void Changed()

tests/BB84.NotificationsTests/NotificationObjectTests.cs tests/BB84.NotificationsTests/NotifiableObjectTests.cs

@@ -2,7 +2,7 @@
 
 namespace BB84.NotificationsTests;
 
-public sealed partial class BindablePropertyTests
+public sealed partial class NotifiablePropertyTests
 {
   [TestMethod]
   public void Changing()