DRN.Framework.SharedKernel 0.3.0-preview001

Prefix Reserved
This is a prerelease version of DRN.Framework.SharedKernel.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DRN.Framework.SharedKernel --version 0.3.0-preview001                
NuGet\Install-Package DRN.Framework.SharedKernel -Version 0.3.0-preview001                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DRN.Framework.SharedKernel" Version="0.3.0-preview001" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DRN.Framework.SharedKernel --version 0.3.0-preview001                
#r "nuget: DRN.Framework.SharedKernel, 0.3.0-preview001"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DRN.Framework.SharedKernel as a Cake Addin
#addin nuget:?package=DRN.Framework.SharedKernel&version=0.3.0-preview001&prerelease

// Install DRN.Framework.SharedKernel as a Cake Tool
#tool nuget:?package=DRN.Framework.SharedKernel&version=0.3.0-preview001&prerelease                

master develop Quality Gate Status

Security Rating Maintainability Rating Reliability Rating Vulnerabilities Bugs Lines of Code Coverage

DRN.Framework.SharedKernel package is an lightweight package that contains common codes suitable for contract and domain layers. It can be referenced by any projects such as other DRN.Framework packages, projects developed with DRN.Framework.

Domain Base Definitions

Following definitions provide guidance and conventions for rapid and effective domain design. Their usage is not necessary however other framework features such as DrnContext benefits from them.

  • An entity should always have an long Id. It can have an additional ids.
  • All DateTime values should include offset
  • Entities should encapsulate their events
  • Entity status changes should be marked automatically by dbContext
  • Domain events should be published automatically by dbContext
namespace DRN.Framework.SharedKernel.Domain;

public abstract class AggregateRoot : Entity;

public abstract class Entity
{
    private List<IDomainEvent> DomainEvents { get; } = new();
    public IReadOnlyList<IDomainEvent> GetDomainEvents() => DomainEvents;
    public long Id { get; protected set; }

    [ConcurrencyCheck]
    public DateTimeOffset ModifiedAt { get; protected set; }
    public DateTimeOffset CreatedAt { get; protected set; }

    protected void AddDomainEvent(DomainEvent? e)
    {
        if (e != null) DomainEvents.Add(e);
    }

    public void MarkAsCreated()
    {
        CreatedAt = DateTimeOffset.UtcNow;
        ModifiedAt = DateTimeOffset.UtcNow;
        AddDomainEvent(GetCreatedEvent());
    }

    public void MarkAsModified()
    {
        ModifiedAt = DateTimeOffset.UtcNow;
        AddDomainEvent(GetModifiedEvent());
    }

    public void MarkAsDeleted()
    {
        AddDomainEvent(GetDeletedEvent());
    }

    protected abstract EntityCreated? GetCreatedEvent();
    protected abstract EntityModified? GetModifiedEvent();
    protected abstract EntityDeleted? GetDeletedEvent();

    private bool Equals(Entity other) => Id == other.Id;
    public override bool Equals(object? obj) => ReferenceEquals(this, obj) || obj is Entity other && Equals(other);
    public override int GetHashCode() => Id.GetHashCode();
    public static bool operator ==(Entity? left, Entity? right) => Equals(left, right);
    public static bool operator !=(Entity? left, Entity? right) => !Equals(left, right);
}
public interface IDomainEvent
{
    Guid Id { get; }
    DateTimeOffset Date { get; }
    long EntityId { get; }
    string EntityName { get; }
}

public abstract class DomainEvent(Entity entity) : IDomainEvent
{
    public Guid Id { get; protected init; } = Guid.NewGuid();
    public DateTimeOffset Date { get; protected init; } = DateTimeOffset.UtcNow;
    public long EntityId => entity.Id;
    public string EntityName { get; protected init; } = entity.GetType().FullName!;
}

public abstract class EntityCreated(Entity entity) : DomainEvent(entity);
public abstract class EntityModified(Entity entity) : DomainEvent(entity);
public abstract class EntityDeleted(Entity entity) : DomainEvent(entity);

AppConstants

namespace DRN.Framework.SharedKernel;

public static class AppConstants
{
    public static int ProcessId { get; } = Environment.ProcessId;
    public static Guid Id { get; } = Guid.NewGuid();
    public static string ApplicationName { get; } = Assembly.GetEntryAssembly()?.GetName().Name
                                                    ?? "Entry Assembly Not Found";

    public static string TempPath { get; } = GetTempPath(); //Cleans directory at every startup
    public static string LocalIpAddress { get; } = GetLocalIpAddress();
...
}

JsonConventions

System.Text.Json defaults will be overridden by JsonConventions when

  • TestContext is used in tests
  • DrnHostBuilder is used to build host
namespace DRN.Framework.SharedKernel.Conventions;

public static class JsonConventions
{
...
    static JsonConventions()
    {
        //https://stackoverflow.com/questions/58331479/how-to-globally-set-default-options-for-system-text-json-jsonserializer
        UpdateDefaultJsonSerializerOptions();
        UpdateHttpClientDefaultJsonSerializerOptions();
    }
    
    public static readonly JsonSerializerOptions DefaultOptions = new(JsonSerializerDefaults.Web)
    {
        Converters = { new JsonStringEnumConverter() },
        AllowTrailingCommas = true
    };
...
}

Exceptions

Following exceptions are used in DRN.Framework and DRN.Nexus and can be used any project. DRN exceptions contain additional category property so that same exception types can be differentiated with a subcategory.

namespace DRN.Framework.SharedKernel;

public abstract class DrnException(string message, Exception exception = null!, string? category = "default") : Exception(message, exception)
{
    public string Category { get; } = category ?? "default";
}

public class ValidationException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class NotSavedException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class NotFoundException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class ExpiredException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

public class ConfigurationException(string message, Exception exception = null!, string? category = null) : DrnException(message, exception, category);

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-04-23 11:39:47 +0300
Hash: 7caeb49182fcf8619a92f95e015489522b3d3602

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DRN.Framework.SharedKernel:

Package Downloads
DRN.Framework.Utils

DRN.Framework.Utils package contains common codes for other DRN.Framework packages, projects developed with DRN.Framework. ## Commit Info Author: Duran Serkan KILIÇ Date: 2024-11-14 19:53:05 +0300 Hash: a5c387d29e9caafed30ff182ceb7c960e8c07726

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.7.0-preview001 0 11/14/2024
0.6.0 101 11/10/2024
0.6.0-preview002 77 11/10/2024
0.6.0-preview001 71 11/10/2024
0.5.1-preview002 88 9/30/2024
0.5.1-preview001 88 9/22/2024
0.5.0 133 8/30/2024
0.5.0-preview011 97 8/30/2024
0.5.0-preview010 134 8/25/2024
0.5.0-preview009 134 8/8/2024
0.5.0-preview008 118 8/7/2024
0.5.0-preview007 78 8/2/2024
0.5.0-preview006 84 7/30/2024
0.5.0-preview005 95 7/27/2024
0.5.0-preview004 113 7/15/2024
0.5.0-preview003 137 6/6/2024
0.5.0-preview002 124 6/5/2024
0.5.0-preview001 119 6/4/2024
0.4.0 114 5/19/2024
0.4.0-preview006 91 5/19/2024
0.4.0-preview005 115 5/12/2024
0.4.0-preview004 111 5/12/2024
0.4.0-preview003 116 5/11/2024
0.4.0-preview002 117 5/8/2024
0.4.0-preview001 128 5/5/2024
0.3.1-preview001 115 4/26/2024
0.3.0 134 4/23/2024
0.3.0-preview002 107 4/23/2024
0.3.0-preview001 133 4/23/2024
0.2.2-preview010 119 4/11/2024
0.2.2-preview009 119 3/18/2024
0.2.2-preview008 123 3/18/2024
0.2.2-preview007 122 3/16/2024
0.2.2-preview006 104 3/11/2024
0.2.2-preview005 105 3/10/2024
0.2.2-preview004 110 3/10/2024
0.2.2-preview003 133 1/22/2024
0.2.2-preview002 94 1/18/2024
0.2.2-preview001 125 1/14/2024
0.2.1 215 1/7/2024
0.2.0 167 12/31/2023
0.2.0-preview009 128 12/31/2023
0.2.0-preview008 148 12/30/2023
0.2.0-preview007 161 12/28/2023
0.2.0-preview006 145 12/27/2023
0.2.0-preview005 143 12/25/2023
0.2.0-preview004 145 12/23/2023
0.2.0-preview003 143 12/20/2023
0.2.0-preview002 142 12/19/2023
0.2.0-preview001 148 12/18/2023
0.1.0 212 11/26/2023
0.1.0-preview013 142 11/26/2023
0.1.0-preview012 163 11/20/2023
0.1.0-preview011 150 11/19/2023
0.1.0-preview010 196 10/30/2023
0.1.0-preview009 174 10/29/2023
0.1.0-preview008 171 10/27/2023
0.1.0-preview007 168 10/11/2023
0.1.0-preview006 172 10/9/2023
0.1.0-preview005 152 10/8/2023
0.1.0-preview004 179 10/8/2023
0.1.0-preview003 167 10/3/2023
0.1.0-preview002 173 10/3/2023
0.1.0-preview001 178 10/2/2023

Not every version includes changes, features or bug fixes. This project can increment version to keep consistency with other DRN.Framework projects.

## Version 0.3.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 23 April Turkish National Sovereignty and Children's Day.

Semper Progredi: Always Progressive

### Breaking Changes

* JsonSerializerOptions moved to JsonConventions. System.Text.Json defaults will be overridden by JsonConventions when
 * TestContext is used in tests
 * DrnHostBuilder is used to build host

### New Features

* Entity and AggregateRoot base classes' ModifiedAt property now has `ConcurrencyCheck` attribute and can be used for optimistic concurrency.

### Bug Fixes

## Version 0.2.0

### New Features

* JsonSerializerOptions added to AppConstants which is same with default dotnet settings for now.
* AggregateRoot, Entity, DomainEvent definitions added

## Version 0.1.0

### Breaking Changes

### New Features

* AppConstants added
* DRN Framework exceptions added
 * ValidationException
 * NotFoundException
 * NotSavedException
 * ExpiredException
 * ConfigurationException

### Bug Fixes  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-04-23 11:39:47 +0300  
Hash: 7caeb49182fcf8619a92f95e015489522b3d3602