Codescovery.Library.Commons 1.0.0-beta3

library-commons

.Net 7 package that provides some common:

• Extensions
• Services
• Entities
• Constant
• Builders
• Abstractions
• Helpers
• Interfaces

Extensions

Deep Clone Extension

The deep clone extension uses Activator.CreateInstace to clone the entity.

This approach considered some studies made by cinorid in this answer.

Benchmark

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.18363.1734 (1909/November2019Update/19H2)
Intel Core i5-6200U CPU 2.30GHz (Skylake), 1 CPU, 4 logical and 2 physical cores
[Host]     : .NET Framework 4.8 (4.8.4400.0), X86 LegacyJIT
DefaultJob : .NET Framework 4.8 (4.8.4400.0), X86 LegacyJIT

Object Extensions

Provides six Methods:

IsNullOrDefault

bool IsNullOrDefault(this object obj)

Returns whether object has a null or a default value

As

T As<T>(this object sourceObject, T defaultValue = default, bool throwExceptionOnError = false)

Cast an object to a Generic Type.

It throws an CastingException case throwExceptionOnError argument is true, else it will return a default value;

And

IFluentPropertySelectorService<T> And<T>(this T obj)

Returns an IFluentPropertySelectorService used in Fluent property Setter(#Fluent property Setter).

With

 IFluentPropertySelectorService<T> With<T>(this T obj)

Returns an IFluentPropertySelectorService used in Fluent property Setter(#Fluent property Setter).

FillWith

void FillWith<T>(this T obj, T source) where T : class

Fill obj with the values from source object using [DeepCloneExtensions](#Deep Clone Extension)

DeepCloneWith

IFluentPropertySelectorService<T> DeepCloneWith<T>(this T obj) where T : new()

Creates a new cloned instance of generic type T using [DeepCloneExtensions](#Deep Clone Extension)

Base64

There's an extension that will handle base64 encode and decode from a raw string

Usage

Import extensions

using Codescovery.Library.Commons.Extensions;

public void Encode()
{
    var encodedString = rawString.ToBase64Encoded();
}
public void Decode()
{
    var decodedString = rawString.ToBase64Decoded();
}
public void EncodeNull()
{
    string? nullRawString = null;
    var encodedString = nullRawString.ToBase64Encoded();
}
public void DecodeNull()
{
    string? nullEncodedString = null;
    var decodedString = nullEncodedString.ToBase64Decoded();
}

Enum Extension

The enum extensions provide two methods:

• ToNullableInt
• ToInt

Usage

Import extensions

using Codescovery.Library.Commons.Extensions;

For this example, we are going to use the enum bellow

ExampleEnum example

public enum ExampleEnum
{
    Value1 = 1,
    Value2 = 5,
}

var exampleEnum = ExampleEnum.Value1;
var exampleEnumCastedInt = exampleEnum.ToInt();
var exampleEnumCastedNullableInt = exampleEnum.ToNullableInt();

Fluent property Setter

We are providing a fluent property setter, thanks to Adem Catamak answer.

Which allow us to modify and clone an object using like fluent api.

Usage

Firts you need to import the extensions:

using Codescovery.Library.Commons.Extensions;

For this example, we are going to use the class bellow

ClonableExampleClass example

    public class ClonableExampleClass
    {


        public string? ExampleString { get; set; } = default;
        public int ExampleInt { get; set; } = default;
        public ExampleEnum ExampleEnum { get; set; } = default;
        public ClonableExampleClass? ExampleNestedClass { get; set; }
        public List<ClonableExampleClass>? ExampleList { get; set; }
    }

How to use:

Modify the values of the current class using fluent api

var exampleClass = new ClonableExampleClass
{
ExampleInt = 1
}
.With()
.Property(@class => @class.ExampleInt)
.Set(intValue;

Deep clone class and modify using fluent api

 var exampleClass = new ClonableExampleClass
        {
            ExampleInt = 1
        };
var cloned= exampleClass.DeepCloneWith()
.Property(@class => @class.ExampleInt)
.Set(1234)
.And()
.Property(@class => "Example string")
.Set(stringValue);

ExceptionsExtensions

Create a full formated exception message.

Usage

Firts you need to import the extensions:

using Codescovery.Library.Commons.Extensions;

Or you can inherint our BaseException class that will handle it for you.

using Codescovery.Library.Commons.Abstractions;

ListExtensions

Converts any objects to a list of type

Helpers

ConfiguratioBuilder Helper

Provides two Methods:

GetCurrentDirectoryBasePath

FolderPath GetCurrentDirectoryBasePath(FolderPath basePath =null, params string[] paths)

Based on a nullable folder path it will return the application current directory base path concatenated with aditional path parameters passed.

GetBasePath

 FolderPath GetBasePath(FolderPath basePath = null)

Will return the basePath if <> null, else will return the DefaultBasePath

Constants

public const string DefaultConfigurationFileName = "appsettings.json";
public const string DefaultConfigurationFileExtension = ".json";
public const string DefaultConfigurationFileExtensionSeparator = ".";
public const string DefaultConfigurationsProjectSubFolderName = "Configurations";
public static readonly FolderPath DefaultBasePath = Directory.GetCurrentDirectory();

ExceptionMessageHelper

Helper to override Exception default messages:

Provides 3 Methods

OverrideAditionalInfoHeaderText

void OverrideAditionalInfoHeaderText(this string aditionalInfoHeaderText)

Will Override the AditionalInfoHeaderText text

Default Value : Aditional Info:

OverrideStackTraceHeaderText

void OverrideStackTraceHeaderText(this string stackTraceHeaderText)

Will Override the StackTraceHeaderText text

Default Value: Stack Trace:

OverrideMessageHeaderText

 void OverrideMessageHeaderText(this string messageHeaderText)

Will Override the MessageHeaderText text

Default Value : Message:

Constants

    public const string DefaultErrorMesage = "Error: Application reports that an error occurred:";
    public const string DefaultMessageHeaderText = "Message:";
    public const string DefaultAditionalInfoHeaderText = "Aditional Info:";
    public const string DefaultStackTraceHeaderText = "Stack Trace:";