DRN.Framework.Utils 0.2.2-preview008

Prefix Reserved
This is a prerelease version of DRN.Framework.Utils.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DRN.Framework.Utils --version 0.2.2-preview008
                    
NuGet\Install-Package DRN.Framework.Utils -Version 0.2.2-preview008
                    
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.Utils" Version="0.2.2-preview008" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DRN.Framework.Utils" Version="0.2.2-preview008" />
                    
Directory.Packages.props
<PackageReference Include="DRN.Framework.Utils" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DRN.Framework.Utils --version 0.2.2-preview008
                    
#r "nuget: DRN.Framework.Utils, 0.2.2-preview008"
                    
#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.
#:package DRN.Framework.Utils@0.2.2-preview008
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DRN.Framework.Utils&version=0.2.2-preview008&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DRN.Framework.Utils&version=0.2.2-preview008&prerelease
                    
Install as a Cake Tool

master develop Quality Gate Status

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

DRN.Framework.Utils package contains common codes for other DRN.Framework packages and projects developed with DRN.Framework.

Module

DRN.Utils can be added with following module

namespace DRN.Framework.Utils;

public static class UtilsModule
{
    public static IServiceCollection AddDrnUtils(this IServiceCollection collection)
    {
        collection.AddServicesWithAttributes();

        return collection;
    }
}

Dependency Injection with Attributes

Each module should be created in the assembly that will be scanned.

public static class InfraModule
{
    public static IServiceCollection AddSampleInfraServices(this IServiceCollection sc)
    {
        sc.AddServicesWithAttributes();

        return sc;
    }
}

Services resolution for attribute based services can be validated with a single line.

serviceProvider.ValidateServicesAddedByAttributes();

Attribute based dependency injection reduces wiring efforts and helps developer to focus on developing. This approach also improves service resolution validation during startup and integration testing.

    [Theory]
    [DataInlineContext]
    public void Validate_Sample_Dependencies(TestContext context)
    {
        context.ServiceCollection.AddSampleApplicationServices();
        context.ServiceCollection.AddSampleInfraServices();
        context.ValidateServices();
    }

Lifetime Attributes

Example attribute usage:

[Transient<IIndependent>]
public class Independent : IIndependent
{
}

Following attributes marks services with a lifetime and when service collection called with AddServicesWithAttributes method in the assembly marked belong they are automatically added.

namespace DRN.Framework.Utils.DependencyInjection.Attributes;

public class LifetimeAttribute<TService>(ServiceLifetime serviceLifetime, bool tryAdd = true, object? key = null)
    : LifetimeAttribute(serviceLifetime, typeof(TService), tryAdd, key);

public class LifetimeWithKeyAttribute<TService>(ServiceLifetime serviceLifetime, object key, bool tryAdd = true)
    : LifetimeAttribute(serviceLifetime, typeof(TService), tryAdd, key);

public class ScopedAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Scoped, tryAdd);

public class ScopedWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Scoped, key, tryAdd);

public class TransientAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Transient, tryAdd);

public class TransientWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Transient, key, tryAdd);

public class SingletonAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Singleton, tryAdd);

public class SingletonWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Singleton, key, tryAdd);

HasServiceCollectionModuleAttribute

Attributes derived from HasServiceCollectionModuleAttribute can be used to mark custom service collection modules. In the following example HasDrnContextServiceCollectionModuleAttribute marks DrnContext<TContext> and its service collection module. This way dbContexts inherited from DrnContext doesn't need a lifetime attribute and they can be registered by AddServicesWithAttributes with their custom factory.

This offers following flexibility:

  1. ServiceCollectionModule of DrnContexts are defined in DRN.Framework.EntityFramework
  2. Inherited dbContexts are defined in user defined projects and points a module in another project.
  3. AddServicesWithAttributes extension method defined in DRN.Framework.Utils registers them without depending DRN.Framework.EntityFramework project
public class HasDrnContextServiceCollectionModuleAttribute : HasServiceCollectionModuleAttribute
{
    static HasDrnContextServiceCollectionModuleAttribute()
    {
        ModuleMethodInfo = typeof(ServiceCollectionExtensions).GetMethod(nameof(ServiceCollectionExtensions.AddDbContextsWithConventions))!;
    }
}

[HasDrnContextServiceCollectionModule]
public abstract class DrnContext<TContext> : DbContext, IDesignTimeDbContextFactory<TContext>, IDesignTimeServices where TContext : DbContext, new()
{
...

HasServiceCollectionModuleAttribute has PostStartupValidationAsync when,

  • ValidateServicesAddedByAttributes extension method called from service provider,
  • PostStartupValidationAsync will be called if all services resolved successfully.
  • For instance, DrnContext can apply EF migrations after service provider services resolved successfully.

Configurations

Following configuration sources can be used to add configurations from different sources

  • JsonSerializerConfigurationSource converts poco objects to configuration
  • RemoteJsonConfigurationSource fetches remote configuration (experimental and incomplete)

AppSettings

Following IAppSettings interface is defined and can be used to obtain appsettings. It has utility methods that allow fail fast.

namespace DRN.Framework.Utils.Settings;

public interface IAppSettings
{
    IConfiguration Configuration { get; }
    bool TryGetConnectionString(string name, out string connectionString);
    string GetRequiredConnectionString(string name);
    bool TryGetSection(string key, out IConfigurationSection section);
    IConfigurationSection GetRequiredSection(string key);
}

ExtensionMethods

  • ServiceCollectionExtensions
    • ReplaceInstance
    • ReplaceTransient
    • ReplaceScoped
    • ReplaceSingleton
    • GetAllAssignableTo<TService>
  • StringExtensions
    • ToStream
  • TypeExtensions
    • MakeGenericMethod
  • AssemblyExtensions
    • GetTypesAssignableTo

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-03-18 10:49:47 +0300
Hash: 8d61c90bb7237377c11ffd70e81a219221713a98

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DRN.Framework.Utils:

Package Downloads
DRN.Framework.EntityFramework

DRN.Framework.EntityFramework provides DrnContext with conventions to develop rapid and effective domain models. ## Commit Info Author: Duran Serkan KILIÇ Date: 2025-09-28 22:00:23 +0300 Hash: 9b97bc89d55446d234e3a91d045c2e8094fd1733

DRN.Framework.Hosting

DRN.Framework.Hosting ## Commit Info Author: Duran Serkan KILIÇ Date: 2025-09-28 22:00:23 +0300 Hash: 9b97bc89d55446d234e3a91d045c2e8094fd1733

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.7.0-preview037 176 9/28/2025
0.7.0-preview036 205 9/22/2025
0.7.0-preview035 184 8/31/2025
0.7.0-preview034 198 8/31/2025
0.7.0-preview033 223 8/28/2025
0.7.0-preview032 218 8/27/2025
0.7.0-preview031 190 8/10/2025
0.7.0-preview030 103 8/1/2025
0.7.0-preview029 116 8/1/2025
0.7.0-preview028 114 8/1/2025
0.7.0-preview027 153 7/31/2025
0.7.0-preview026 120 7/29/2025
0.7.0-preview025 123 7/27/2025
0.7.0-preview024 126 7/11/2025
0.7.0-preview023 124 7/11/2025
0.7.0-preview022 194 6/29/2025
0.7.0-preview021 189 6/23/2025
0.7.0-preview020 141 5/31/2025
0.7.0-preview019 200 3/23/2025
0.7.0-preview018 137 3/2/2025
0.7.0-preview017 160 2/23/2025
0.7.0-preview016 159 2/22/2025
0.7.0-preview015 125 2/21/2025
0.7.0-preview014 139 2/20/2025
0.7.0-preview013 144 2/9/2025
0.7.0-preview012 144 2/8/2025
0.7.0-preview011 133 2/2/2025
0.7.0-preview010 117 1/20/2025
0.7.0-preview009 133 1/19/2025
0.7.0-preview008 127 1/16/2025
0.7.0-preview007 155 12/29/2024
0.7.0-preview006 134 12/23/2024
0.7.0-preview005 136 11/27/2024
0.7.0-preview004 134 11/23/2024
0.7.0-preview003 175 11/20/2024
0.7.0-preview002 156 11/17/2024
0.7.0-preview001 170 11/14/2024
0.6.0 219 11/10/2024
0.6.0-preview002 122 11/10/2024
0.6.0-preview001 122 11/10/2024
0.5.1-preview002 129 9/30/2024
0.5.1-preview001 134 9/22/2024
0.5.0 214 8/30/2024
0.5.0-preview011 183 8/30/2024
0.5.0-preview010 211 8/25/2024
0.5.0-preview009 186 8/8/2024
0.5.0-preview008 190 8/7/2024
0.5.0-preview007 148 8/2/2024
0.5.0-preview006 149 7/30/2024
0.5.0-preview005 178 7/27/2024
0.5.0-preview004 175 7/15/2024
0.5.0-preview003 193 6/6/2024
0.5.0-preview002 195 6/5/2024
0.5.0-preview001 184 6/4/2024
0.4.0 200 5/19/2024
0.4.0-preview006 187 5/19/2024
0.4.0-preview005 154 5/12/2024
0.4.0-preview004 166 5/12/2024
0.4.0-preview003 179 5/11/2024
0.4.0-preview002 163 5/8/2024
0.4.0-preview001 179 5/5/2024
0.3.1-preview001 168 4/26/2024
0.3.0 201 4/23/2024
0.3.0-preview002 173 4/23/2024
0.3.0-preview001 206 4/23/2024
0.2.2-preview010 191 4/11/2024
0.2.2-preview009 200 3/18/2024
0.2.2-preview008 196 3/18/2024
0.2.2-preview007 175 3/16/2024
0.2.2-preview006 173 3/11/2024
0.2.2-preview005 182 3/10/2024
0.2.2-preview004 172 3/10/2024
0.2.2-preview003 193 1/22/2024
0.2.2-preview002 180 1/18/2024
0.2.2-preview001 200 1/14/2024
0.2.1 292 1/7/2024
0.2.0 214 12/31/2023
0.2.0-preview009 165 12/31/2023
0.2.0-preview008 173 12/30/2023
0.2.0-preview007 185 12/28/2023
0.2.0-preview006 162 12/27/2023
0.2.0-preview005 162 12/25/2023
0.2.0-preview004 169 12/23/2023
0.2.0-preview003 162 12/20/2023
0.2.0-preview002 198 12/19/2023
0.2.0-preview001 192 12/18/2023
0.1.0 234 11/26/2023
0.1.0-preview013 191 11/26/2023
0.1.0-preview012 132 11/20/2023
0.1.0-preview011 166 11/19/2023
0.1.0-preview010 169 10/30/2023
0.1.0-preview009 175 10/29/2023
0.1.0-preview008 183 10/27/2023
0.1.0-preview007 161 10/11/2023
0.1.0-preview006 199 10/9/2023
0.1.0-preview005 191 10/8/2023
0.1.0-preview004 192 10/8/2023
0.1.0-preview003 174 10/3/2023
0.1.0-preview002 190 10/3/2023
0.1.0-preview001 194 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.2.0

### New Features

* HasServiceCollectionModuleAttribute has PostStartupValidationAsync when,
 * ValidateServicesAddedByAttributes extension method called from service provider,
 * PostStartupValidationAsync will be called if all services resolved successfully.
 * For instance, DrnContext can apply migrations after service provider services resolved successfully.

## Version 0.2.0

### Breaking Changes

* LifetimeContainer renamed as DrnServiceContainer
* Lifetime attributes moved to DRN.Framework.Utils.DependencyInjection.Attributes namespace

### New Features

* JsonSerializerConfigurationSource added to add dotnet objects to configuration
* RemoteJsonConfigurationSource added to remote settings to configuration (experimental)
* ConnectionStringsCollection added as poco model to serialize connection strings
* StringExtensions added
 * ToStream method added to convert strings to in memory stream
* HasServiceCollectionModuleAttribute added

## Version 0.1.0

### Breaking Changes

### New Features

* AppSettings added
* ServiceCollectionExtensions added
 * ReplaceInstance
 * ReplaceTransient
 * ReplaceScoped
 * ReplaceSingleton
* Attribute based dependency injection added
 * ScopedAttribute, TransientAttribute, SingletonAttribute and LifetimeAttribute added
 * ScopedWithKeyAttribute, TransientWithKeyAttribute, SingletonWithKeyAttribute and LifetimeWithKeyAttribute added
 * ServiceCollection AddServicesWithAttributes extension added
 * ServiceProvider ValidateServicesAddedByAttributes extension added

### Bug Fixes  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-03-18 10:49:47 +0300  
Hash: 8d61c90bb7237377c11ffd70e81a219221713a98