https://github.com/jonpsmith/genericservices.statusgeneric
Implements the "return a status" pattern - useful for code that can return errors
https://github.com/jonpsmith/genericservices.statusgeneric
Last synced: 5 months ago
JSON representation
Implements the "return a status" pattern - useful for code that can return errors
- Host: GitHub
- URL: https://github.com/jonpsmith/genericservices.statusgeneric
- Owner: JonPSmith
- License: mit
- Created: 2019-11-21T19:37:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T10:03:50.000Z (over 3 years ago)
- Last Synced: 2025-09-29T15:41:31.289Z (8 months ago)
- Language: C#
- Homepage: https://www.thereformedprogrammer.net/a-pattern-library-for-methods-that-return-a-status-including-localization/
- Size: 43.9 KB
- Stars: 30
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GenericServices.StatusGeneric
This [NuGet library](https://www.nuget.org/packages/GenericServices.StatusGeneric/) provides a way to return the status of a method/class that you run. It contains two main things
1. A IReadOnlyList of `Errors`, which may be empty. If the list is empty, then the `IsValid` property of the status will be true.
2. A `Message` which can be set by you (default value is "Success"), but if it has any errors the `Message` returns "Failed with nn errors".
3. The `IStatusGeneric` version will return a `Result` which you can set, but returns `default(T)` if there are errors.
There are various methods to add errors to the `Errors` list, and a way to combine statuses which I show next.
*NOTE: There is a companion library called [EfCore.GenericServices.AspNetCore](https://github.com/JonPSmith/EfCore.GenericServices.AspNetCore) which can convert a GenericService into Model errors for ASP.NET Core MVC controllers or Razor pages, AND ASP.NET Core Web API - well worth looking at.*
## Simple usage examples
1. Returns just a status telling you if the method was successful. You can also set the `Message` in the status - default is "Success".
```c#
public IStatusGeneric NonStatusGenericString(string s)
{
var status = new StatusGenericHandler();
//add error and return immediately
if (s == null)
//You can return just an error message, but adding the property name
//will improve the error feedback in ASP.NET Core etc.
return status.AddError("input must not be null", nameof(s));
status.Message = "All went well";
//If no errors were added then its returns a IsValid status with the message
//If there are errors then the Message says something like "Failed with 1 error"
//and the HasErrors will be true, IsValid will be false
return status;
}
```
2. Returns a status with a value
```c#
public IStatusGeneric StatusGenericNumReturnString(int i)
{
var status = new StatusGenericHandler();
//add error and return immediately
if (i <= 0)
return status.AddError("input must be positive", nameof(i));
//This sets the Result property in the generic status
status.SetResult(i.ToString());
//If there are errors then the Result is set to the default value for generic type
return status;
}
```
## Combining multiple checks
This approach makes sure all the errors are returned, which is best for the user
```c#
public IStatusGeneric CheckPassword(string password)
{
var status = new StatusGenericHandler();
//series of tests and then return all the errors together
//Good because the user gets all the errors at once
if (password.Length < 10)
status.AddError("A password must be 10 or more in length",
nameof(password));
if (!password.Any(char.IsUpper))
status.AddError("A password must contain an upper case character",
nameof(password));
if (!password.Any(char.IsLower))
status.AddError("A password must contain a lower case character",
nameof(password));
if (!password.Any(char.IsDigit))
status.AddError("A password must contain an number",
nameof(password));
return status;
}
```
## Combining errors from multiple statuses
Sometimes the testing for errors is best coded by called to other methods that return the IStatusGeneric interface. The code below shows a fictitious example of logging in with tests on the email, password and the actual login part.
```c#
public IStatusGeneric Login
(string email, string password)
{
var status = new StatusGenericHandler();
status.CombineStatuses(
CheckValidEmail(email));
if (status.HasErrors)
return status;
if (status.CombineStatuses(
CheckPassword(password)).HasErrors)
return status;
var loginStatus = LoginUser(email, password);
status.CombineStatuses(loginStatus);
status.SetResult(loginStatus.Result);
return status;
}
```
## When unit testing...
If you are testing a service its always good to check that the service returns the status you expect. If you expect it to pass then you can use this following xUnit fluent test which will
1. Test that it was a successful result
2. Show you the errors in the unit test window
```c#
status.IsValid.ShouldBeTrue(status.GetAllErrors());
```