Removed magic string for property names from exceptions

Andrei-Constantin-Programmer · Andrei-Constantin-Programmer · commit ae132d1ca6b2 · 2024-06-06T01:46:56.000+01:00
diff --git a/RecipeSocialMediaAPI.Application.Tests.Unit/Exceptions/HandleAlreadyInUseExceptionTests.cs b/RecipeSocialMediaAPI.Application.Tests.Unit/Exceptions/HandleAlreadyInUseExceptionTests.cs
@@ -17,7 +17,7 @@ public void HandleAlreadyInUseException_IsCorrectlySerializedAndDeserialized()
         var handle = "test_handler";
         HandleAlreadyInUseException exception = new(handle);
 
-        CustomExceptionSerializationData serializedData = new(exception.Message, exception.HResult, exception.Source, exception.StackTrace, handle);
+        CustomExceptionSerializationData serializedData = new(exception.Message, exception.HResult, exception.Source, exception.StackTrace, exception.Handle);
 
         // When
         var json = JsonSerializer.Serialize(serializedData);
diff --git a/RecipeSocialMediaAPI.Application/Exceptions/EmailAlreadyInUseException.cs b/RecipeSocialMediaAPI.Application/Exceptions/EmailAlreadyInUseException.cs
@@ -5,6 +5,7 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;
 [Serializable]
 public class EmailAlreadyInUseException : Exception
 {
+    private const string EMAIL_PROPERTY_NAME = "Email";
     public string Email { get; }
 
     public EmailAlreadyInUseException(string email)
@@ -14,12 +15,12 @@ public EmailAlreadyInUseException(string email)
 
     protected EmailAlreadyInUseException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
-        Email = info.GetString("Email") ?? string.Empty;
+        Email = info.GetString(EMAIL_PROPERTY_NAME) ?? string.Empty;
     }
 
     public override void GetObjectData(SerializationInfo info, StreamingContext context)
     {
         base.GetObjectData(info, context);
-        info.AddValue("Email", Email);
+        info.AddValue(EMAIL_PROPERTY_NAME, Email);
     }
 }
diff --git a/RecipeSocialMediaAPI.Application/Exceptions/HandleAlreadyInUseException.cs b/RecipeSocialMediaAPI.Application/Exceptions/HandleAlreadyInUseException.cs
@@ -5,21 +5,22 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;
 [Serializable]
 public class HandleAlreadyInUseException : Exception
 {
+    private const string HANDLE_PROPERTY_NAME = "Handle";
     public string Handle { get; }
 
-    public HandleAlreadyInUseException(string handler)
+    public HandleAlreadyInUseException(string handle)
     {
-        Handle = handler;
+        Handle = handle;
     }
 
     protected HandleAlreadyInUseException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
-        Handle = info.GetString("Handler") ?? string.Empty;
+        Handle = info.GetString(HANDLE_PROPERTY_NAME) ?? string.Empty;
     }
 
     public override void GetObjectData(SerializationInfo info, StreamingContext context)
     {
         base.GetObjectData(info, context);
-        info.AddValue("Handle", Handle);
+        info.AddValue(HANDLE_PROPERTY_NAME, Handle);
     }
 }
diff --git a/RecipeSocialMediaAPI.Application/Exceptions/InvalidUserRoleException.cs b/RecipeSocialMediaAPI.Application/Exceptions/InvalidUserRoleException.cs
@@ -5,20 +5,22 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;
 [Serializable]
 public class InvalidUserRoleException : Exception
 {
+    private const string INVALID_ROLE_PROPERTY_NAME = "InvalidRole";
     public string InvalidRole { get; }
+
     public InvalidUserRoleException(string role) : base($"Invalid user role {role}")
     {
         InvalidRole = role;
     }
 
     protected InvalidUserRoleException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
-        InvalidRole = info.GetString("InvalidRole") ?? string.Empty;
+        InvalidRole = info.GetString(INVALID_ROLE_PROPERTY_NAME) ?? string.Empty;
     }
 
     public override void GetObjectData(SerializationInfo info, StreamingContext context)
     {
         base.GetObjectData(info, context);
-        info.AddValue("InvalidRole", InvalidRole);
+        info.AddValue(INVALID_ROLE_PROPERTY_NAME, InvalidRole);
     }
 }
diff --git a/RecipeSocialMediaAPI.Application/Exceptions/UnsupportedConnectionStatusException.cs b/RecipeSocialMediaAPI.Application/Exceptions/UnsupportedConnectionStatusException.cs
@@ -6,6 +6,7 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;
 [Serializable]
 public class UnsupportedConnectionStatusException : Exception
 {
+    private const string UNSUPPORTED_STATUS_PROPERTY_NAME = "UnsupportedStatus";
     public string UnsupportedStatus { get; }
 
     public UnsupportedConnectionStatusException(string connectionStatus) : base($"Could not map {connectionStatus} to {typeof(ConnectionStatus)}")
@@ -15,12 +16,12 @@ public UnsupportedConnectionStatusException(string connectionStatus) : base($"Co
 
     protected UnsupportedConnectionStatusException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
-        UnsupportedStatus = info.GetString("UnsupportedStatus") ?? string.Empty;
+        UnsupportedStatus = info.GetString(UNSUPPORTED_STATUS_PROPERTY_NAME) ?? string.Empty;
     }
 
     public override void GetObjectData(SerializationInfo info, StreamingContext context)
     {
         base.GetObjectData(info, context);
-        info.AddValue("UnsupportedStatus", UnsupportedStatus);
+        info.AddValue(UNSUPPORTED_STATUS_PROPERTY_NAME, UnsupportedStatus);
     }
 }
diff --git a/RecipeSocialMediaAPI.Application/Exceptions/UsernameAlreadyInUseException.cs b/RecipeSocialMediaAPI.Application/Exceptions/UsernameAlreadyInUseException.cs
@@ -5,6 +5,7 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;
 [Serializable]
 public class UsernameAlreadyInUseException : Exception
 {
+    private const string USERNAME_PROPERTY_NAME = "Username";
     public string Username { get; }
 
     public UsernameAlreadyInUseException(string username)
@@ -14,12 +15,12 @@ public UsernameAlreadyInUseException(string username)
 
     protected UsernameAlreadyInUseException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
-        Username = info.GetString("Username") ?? string.Empty;
+        Username = info.GetString(USERNAME_PROPERTY_NAME) ?? string.Empty;
     }
 
     public override void GetObjectData(SerializationInfo info, StreamingContext context)
     {
         base.GetObjectData(info, context);
-        info.AddValue("Username", Username);
+        info.AddValue(USERNAME_PROPERTY_NAME, Username);
     }
 }
diff --git a/RecipeSocialMediaAPI.Infrastructure/Exceptions/DocumentAlreadyExistsException.cs b/RecipeSocialMediaAPI.Infrastructure/Exceptions/DocumentAlreadyExistsException.cs
@@ -6,6 +6,7 @@ namespace RecipeSocialMediaAPI.Infrastructure.Exceptions;
 [Serializable]
 public class DocumentAlreadyExistsException<TDocument> : Exception where TDocument : MongoDocument
 {
+    private const string DOCUMENT_PROPERTY_NAME = "Document";
     public TDocument Document { get; }
 
     public DocumentAlreadyExistsException(TDocument document) : base($"{document.GetType()} already exists with id {document.Id}")
@@ -15,12 +16,12 @@ public DocumentAlreadyExistsException(TDocument document) : base($"{document.Get
 
     protected DocumentAlreadyExistsException(SerializationInfo info, StreamingContext context) : base(info, context)
     {
-        Document = info.GetValue("Document", typeof(TDocument)) as TDocument ?? default!;
+        Document = info.GetValue(DOCUMENT_PROPERTY_NAME, typeof(TDocument)) as TDocument ?? default!;
     }
 
     public override void GetObjectData(SerializationInfo info, StreamingContext context)
     {
         base.GetObjectData(info, context);
-        info.AddValue("Document", Document);
+        info.AddValue(DOCUMENT_PROPERTY_NAME, Document);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;`
`5`	`5`	`[Serializable]`
`6`	`6`	`public class EmailAlreadyInUseException : Exception`
`7`	`7`	`{`
	`8`	`+ private const string EMAIL_PROPERTY_NAME = "Email";`
`8`	`9`	`public string Email { get; }`
`9`	`10`
`10`	`11`	`public EmailAlreadyInUseException(string email)`
`@@ -14,12 +15,12 @@ public EmailAlreadyInUseException(string email)`
`14`	`15`
`15`	`16`	`protected EmailAlreadyInUseException(SerializationInfo info, StreamingContext context) : base(info, context)`
`16`	`17`	`{`
`17`		`- Email = info.GetString("Email") ?? string.Empty;`
	`18`	`+ Email = info.GetString(EMAIL_PROPERTY_NAME) ?? string.Empty;`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`public override void GetObjectData(SerializationInfo info, StreamingContext context)`
`21`	`22`	`{`
`22`	`23`	`base.GetObjectData(info, context);`
`23`		`- info.AddValue("Email", Email);`
	`24`	`+ info.AddValue(EMAIL_PROPERTY_NAME, Email);`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,21 +5,22 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;`
`5`	`5`	`[Serializable]`
`6`	`6`	`public class HandleAlreadyInUseException : Exception`
`7`	`7`	`{`
	`8`	`+ private const string HANDLE_PROPERTY_NAME = "Handle";`
`8`	`9`	`public string Handle { get; }`
`9`	`10`
`10`		`- public HandleAlreadyInUseException(string handler)`
	`11`	`+ public HandleAlreadyInUseException(string handle)`
`11`	`12`	`{`
`12`		`- Handle = handler;`
	`13`	`+ Handle = handle;`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`protected HandleAlreadyInUseException(SerializationInfo info, StreamingContext context) : base(info, context)`
`16`	`17`	`{`
`17`		`- Handle = info.GetString("Handler") ?? string.Empty;`
	`18`	`+ Handle = info.GetString(HANDLE_PROPERTY_NAME) ?? string.Empty;`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`public override void GetObjectData(SerializationInfo info, StreamingContext context)`
`21`	`22`	`{`
`22`	`23`	`base.GetObjectData(info, context);`
`23`		`- info.AddValue("Handle", Handle);`
	`24`	`+ info.AddValue(HANDLE_PROPERTY_NAME, Handle);`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,20 +5,22 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;`
`5`	`5`	`[Serializable]`
`6`	`6`	`public class InvalidUserRoleException : Exception`
`7`	`7`	`{`
	`8`	`+ private const string INVALID_ROLE_PROPERTY_NAME = "InvalidRole";`
`8`	`9`	`public string InvalidRole { get; }`
	`10`	`+`
`9`	`11`	`public InvalidUserRoleException(string role) : base($"Invalid user role {role}")`
`10`	`12`	`{`
`11`	`13`	`InvalidRole = role;`
`12`	`14`	`}`
`13`	`15`
`14`	`16`	`protected InvalidUserRoleException(SerializationInfo info, StreamingContext context) : base(info, context)`
`15`	`17`	`{`
`16`		`- InvalidRole = info.GetString("InvalidRole") ?? string.Empty;`
	`18`	`+ InvalidRole = info.GetString(INVALID_ROLE_PROPERTY_NAME) ?? string.Empty;`
`17`	`19`	`}`
`18`	`20`
`19`	`21`	`public override void GetObjectData(SerializationInfo info, StreamingContext context)`
`20`	`22`	`{`
`21`	`23`	`base.GetObjectData(info, context);`
`22`		`- info.AddValue("InvalidRole", InvalidRole);`
	`24`	`+ info.AddValue(INVALID_ROLE_PROPERTY_NAME, InvalidRole);`
`23`	`25`	`}`
`24`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;`
`6`	`6`	`[Serializable]`
`7`	`7`	`public class UnsupportedConnectionStatusException : Exception`
`8`	`8`	`{`
	`9`	`+ private const string UNSUPPORTED_STATUS_PROPERTY_NAME = "UnsupportedStatus";`
`9`	`10`	`public string UnsupportedStatus { get; }`
`10`	`11`
`11`	`12`	`public UnsupportedConnectionStatusException(string connectionStatus) : base($"Could not map {connectionStatus} to {typeof(ConnectionStatus)}")`
`@@ -15,12 +16,12 @@ public UnsupportedConnectionStatusException(string connectionStatus) : base($"Co`
`15`	`16`
`16`	`17`	`protected UnsupportedConnectionStatusException(SerializationInfo info, StreamingContext context) : base(info, context)`
`17`	`18`	`{`
`18`		`- UnsupportedStatus = info.GetString("UnsupportedStatus") ?? string.Empty;`
	`19`	`+ UnsupportedStatus = info.GetString(UNSUPPORTED_STATUS_PROPERTY_NAME) ?? string.Empty;`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`public override void GetObjectData(SerializationInfo info, StreamingContext context)`
`22`	`23`	`{`
`23`	`24`	`base.GetObjectData(info, context);`
`24`		`- info.AddValue("UnsupportedStatus", UnsupportedStatus);`
	`25`	`+ info.AddValue(UNSUPPORTED_STATUS_PROPERTY_NAME, UnsupportedStatus);`
`25`	`26`	`}`
`26`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ namespace RecipeSocialMediaAPI.Application.Exceptions;`
`5`	`5`	`[Serializable]`
`6`	`6`	`public class UsernameAlreadyInUseException : Exception`
`7`	`7`	`{`
	`8`	`+ private const string USERNAME_PROPERTY_NAME = "Username";`
`8`	`9`	`public string Username { get; }`
`9`	`10`
`10`	`11`	`public UsernameAlreadyInUseException(string username)`
`@@ -14,12 +15,12 @@ public UsernameAlreadyInUseException(string username)`
`14`	`15`
`15`	`16`	`protected UsernameAlreadyInUseException(SerializationInfo info, StreamingContext context) : base(info, context)`
`16`	`17`	`{`
`17`		`- Username = info.GetString("Username") ?? string.Empty;`
	`18`	`+ Username = info.GetString(USERNAME_PROPERTY_NAME) ?? string.Empty;`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`public override void GetObjectData(SerializationInfo info, StreamingContext context)`
`21`	`22`	`{`
`22`	`23`	`base.GetObjectData(info, context);`
`23`		`- info.AddValue("Username", Username);`
	`24`	`+ info.AddValue(USERNAME_PROPERTY_NAME, Username);`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ namespace RecipeSocialMediaAPI.Infrastructure.Exceptions;`
`6`	`6`	`[Serializable]`
`7`	`7`	`public class DocumentAlreadyExistsException<TDocument> : Exception where TDocument : MongoDocument`
`8`	`8`	`{`
	`9`	`+ private const string DOCUMENT_PROPERTY_NAME = "Document";`
`9`	`10`	`public TDocument Document { get; }`
`10`	`11`
`11`	`12`	`public DocumentAlreadyExistsException(TDocument document) : base($"{document.GetType()} already exists with id {document.Id}")`
`@@ -15,12 +16,12 @@ public DocumentAlreadyExistsException(TDocument document) : base($"{document.Get`
`15`	`16`
`16`	`17`	`protected DocumentAlreadyExistsException(SerializationInfo info, StreamingContext context) : base(info, context)`
`17`	`18`	`{`
`18`		`- Document = info.GetValue("Document", typeof(TDocument)) as TDocument ?? default!;`
	`19`	`+ Document = info.GetValue(DOCUMENT_PROPERTY_NAME, typeof(TDocument)) as TDocument ?? default!;`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`public override void GetObjectData(SerializationInfo info, StreamingContext context)`
`22`	`23`	`{`
`23`	`24`	`base.GetObjectData(info, context);`
`24`		`- info.AddValue("Document", Document);`
	`25`	`+ info.AddValue(DOCUMENT_PROPERTY_NAME, Document);`
`25`	`26`	`}`
`26`	`27`	`}`