First release 1.0.0

Author: Calabonga

README.md

@@ -1,4 +1,40 @@
 # Calabonga.AspNetCore.AppDefinitions
-Application Definitions base classes. The small but very helpful packege that can help you to organize your ASP.NET Core application.
+
+Сборка позволяет навести порядок в вашем `Program.cs`. Можно всё разложить "по полочкам". Чтобы воспользоваться сборкой надо:
+
+## Установка nuget-пакета
+
+Можно воспользоваться инструментов Visual Studio:
+
+![image1](./docs/1.jpg)
+
+Или можно просто прописать в файле проекта, но тогда надо будет подставить правильную версию пакета. Посмотреть последнюю актуальную версию можно на [nuget.org](https://www.nuget.org/packages/Calabonga.AspNetCore.AppDefinitions/).
+
+![image2](./docs/2.jpg)
+
+### Создание AppDefinitions
+
+Создайте папку `Definitions` в вашем проекте. В папке создайте `ContainerDefinition` и унаследуйте его от `AppDefinition`, как показано ниже на картинке. После этого сделайте переопределение метода `ConfigureServices` и/или других методов и свойств.
+
+![image3](./docs/3.jpg)
+
+На этой картинке переопределено два метода:
+
+![image4](./docs/4.jpg)
+
+Подключите ваши определения как показано на этой картинке:
+
+![image6](./docs/6.jpg)
+
+Таких определений (наследников от `AppDefinition`) может быть сколько угодно (конечно же в разумных пределах). После старта приложения вы увидите (если включен уровень логирования `Debug`) список всех подключенных определений (`AppDefinition`). Например, в моём случае их 18.
+
+![image5](./docs/5.jpg)
+
+### Фильтрация и порядок
+
+У каждого из созданных вами наследников от `AppDefinition` есть свойство `Enabled` и `OrderIndex`. Угадайте, что можно с ними (с `AppDefinition`ами) сделать?
+
+# An English
+Application Definitions base classes. The small but very helpful package that can help you to organize your ASP.NET Core application.
 
 You can find more information in my blog [Nimble Framework](https://www.calabonga.net/blog/post/nimble-framework-v-6-1)

docs/1.jpg

@@ -3,7 +3,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
-namespace Calabonga.MinimalApi.Definitions;
+namespace Calabonga.AspNetCore.AppDefinitions;
 
 /// <summary>
 /// Base implementation for <see cref="IAppDefinition"/>
@@ -23,4 +23,14 @@ public virtual void ConfigureServices(IServiceCollection services, IConfiguratio
     /// <param name="app"></param>
     /// <param name="env"></param>
     public virtual void ConfigureApplication(WebApplication app, IWebHostEnvironment env) { }
+
+    /// <summary>
+    /// Order index for including into pipeline. Default value is 0 for, that's why order index can be undefined.
+    /// </summary>
+    public virtual int OrderIndex => 0;
+
+    /// <summary>
+    /// Enable or disable to register into pipeline for the current application definition
+    /// </summary>
+    public virtual bool Enabled => true;
 }

docs/2.jpg

@@ -1,33 +1,70 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 
-namespace Calabonga.MinimalApi.Definitions;
+namespace Calabonga.AspNetCore.AppDefinitions;
 
 public static class AppDefinitionExtensions
 {
+    /// <summary>
+    /// Finding all definitions in your project and include their into pipeline.<br/>
+    /// Using <see cref="IServiceCollection"/> for registration.
+    /// </summary>
+    /// <remarks>
+    /// When executing on development environment there are more diagnostic information available on console.
+    /// </remarks>
+    /// <param name="source"></param>
+    /// <param name="builder"></param>
+    /// <param name="entryPointsAssembly"></param>
     public static void AddDefinitions(this IServiceCollection source, WebApplicationBuilder builder, params Type[] entryPointsAssembly)
     {
+        var logger = source.BuildServiceProvider().GetRequiredService<ILogger<AppDefinition>>();
         var definitions = new List<IAppDefinition>();
-
         foreach (var entryPoint in entryPointsAssembly)
         {
             var types = entryPoint.Assembly.ExportedTypes.Where(x => !x.IsAbstract && typeof(IAppDefinition).IsAssignableFrom(x));
-            var instances = types.Select(Activator.CreateInstance).Cast<IAppDefinition>();
-            definitions.AddRange(instances);
+            var instances = types.Select(Activator.CreateInstance).Cast<IAppDefinition>().ToList();
+            var instancesOrdered = instances.Where(x => x.Enabled).OrderBy(x => x.OrderIndex).ToList();
+            if (builder.Environment.IsDevelopment())
+            {
+                logger.LogDebug("[AppDefinitions] Founded: {0}. Enabled: {1}", instances.Count, instancesOrdered.Count);
+                logger.LogDebug("[AppDefinitions] Registered [{0}]", string.Join(", ", instancesOrdered.Select(x => x.GetType().Name).ToArray()));
+            }
+
+            definitions.AddRange(instancesOrdered);
         }
 
         definitions.ForEach(app => app.ConfigureServices(source, builder.Configuration));
         source.AddSingleton(definitions as IReadOnlyCollection<IAppDefinition>);
+
     }
 
+    /// <summary>
+    /// Finding all definitions in your project and include their into pipeline.<br/>
+    /// Using <see cref="WebApplication"/> for registration.
+    /// </summary>
+    /// <remarks>
+    /// When executing on development environment there are more diagnostic information available on console.
+    /// </remarks>
+    /// <param name="source"></param>
     public static void UseDefinitions(this WebApplication source)
     {
-        var definitions = source.Services.GetRequiredService<IReadOnlyCollection<IAppDefinition>>();
+        var logger = source.Services.GetRequiredService<ILogger<AppDefinition>>();
         var environment = source.Services.GetRequiredService<IWebHostEnvironment>();
-        foreach (var endpoint in definitions)
+
+        var definitions = source.Services.GetRequiredService<IReadOnlyCollection<IAppDefinition>>();
+        var instancesOrdered = definitions.Where(x => x.Enabled).OrderBy(x => x.OrderIndex).ToList();
+        foreach (var endpoint in instancesOrdered)
         {
             endpoint.ConfigureApplication(source, environment);
         }
+
+        if (environment.IsDevelopment())
+        {
+            logger.LogDebug("Total application definitions configured {0}", instancesOrdered.Count());
+        }
     }
+
 }

docs/3.jpg

@@ -6,7 +6,7 @@
 		<Nullable>enable</Nullable>
 		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 		<Title>Calabonga.AspNetCore.AppDefinitions</Title>
-		<Version>1.0.0-beta1</Version>
+		<Version>1.0.0</Version>
 		<Authors>Calabonga</Authors>
 		<Company>Calabonga Soft</Company>
 		<Product>Calabonga.AspNetCore.AppDefinitions</Product>