DiegoOnSoftware.CommonDomainTypes 1.0.4

Common Domain Types

A small library I'm building for my own use containing definitions of frequently used datatypes and some useful extension methods.

Nuget package

Package Manager

Install-Package DiegoOnSoftware.CommonDomainTypes

.NET CLI

dotnet add package DiegoOnSoftware.CommonDomainTypes

Paket CLI

paket add DiegoOnSoftware.CommonDomainTypes

Types

All of these datatypes enforce validation according to brazilian standards.

• Cnpj
• Email
• Cep
• BrazilianPhoneNumber

Paginated Result

Provides a way to represent a collection of items as a "page". It is not a pagination component. Its intent is to provide a semanthic way of represent a result page. Usage sample (in a repository implementation):

public async Task<PaginatedResult<Expense>> FilterBy(Guid tenantId, ExpenseFilter filter)
{
    if(filter == null)
    {
        throw new ArgumentNullException("Filter must not be null");
    }
    var expensesQuery = _context.Expenses
        .Where(e => e.TenantId == tenantId)
        .ApplyFilters(filter);

    var totalResults = await expensesQuery.CountAsync();

    var results = await expensesQuery
        .Skip(PaginationHelpers.CalculateRecordsToSkip(filter.PageNumber, filter.PageSize))
        .Take((filter.PageSize > 0) ? filter.PageSize : 10)
        .ToListAsync();

    return PaginatedResult<Expense>.NewPage(
        totalResults, filter.PageNumber, results, filter.PageSize);
}

Assertion / Validation

Add meaningful and descriptive assertions using the static methods of AssertionConcern class. Here are some examples:

// equality
AssertionConcern.AssertArgumentEquals(2, y, "Y must be 2");

// null value checking
AssertionConcern.AssertArgumentNotNull(obj, "A valid object must be provided");

// range 
AssertionConcern.AssertArgumentRange(number, 1, 10, "You must provide a number between 1 and 10");

// property validation
public string Value
{
    get { return _value;}
    private set 
    {
        AssertionConcern.AssertArgumentNotNull(value, "value must not be null.");
        AssertionConcern.AssertArgumentTrue(IsValid(value), "A valid value must be provided.");
        
        _value = value;
    }
}

Extension methods

• someString.Sanitize(string charsToBeRemoved):

Removes unwanted characters from a string. Usage:

Console.WriteLine($"{"d-i-e*g-o".Sanitize("-*")}");

will print "diego" to the screen.

• someObject.CompareTo(otherObject):

Compares two objects and returns a IList<ChangedField> including information on properties that have been changed. Usage:

var changes = person.CompareTo(otherPerson);

You can ignore some properties when comparing two objects:

var changes = person.CompareTo(otherPerson, new string[] { "NameOfPropertyToBeIgnored" });