Influx.CodeGenerators.AutoWireup 1.0.16

dotnet add package Influx.CodeGenerators.AutoWireup --version 1.0.16
NuGet\Install-Package Influx.CodeGenerators.AutoWireup -Version 1.0.16
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="Influx.CodeGenerators.AutoWireup" Version="1.0.16">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Influx.CodeGenerators.AutoWireup --version 1.0.16
#r "nuget: Influx.CodeGenerators.AutoWireup, 1.0.16"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Influx.CodeGenerators.AutoWireup as a Cake Addin
#addin nuget:?package=Influx.CodeGenerators.AutoWireup&version=1.0.16

// Install Influx.CodeGenerators.AutoWireup as a Cake Tool
#tool nuget:?package=Influx.CodeGenerators.AutoWireup&version=1.0.16

Influx: AutoWireup

[AutoWireup]
public partial class testClass
{
    [Required]
    [Range(minimum:16, maximum:21, ErrorMessage ="Range must be between 16 and 21")]
    int age; // ** all generated code seeded from THIS field, once project builds. **
}

The AutoWireUp attribute, when applied to a class, can generate properties for you. That may not sounds very useful, until you understand that when the property values changes, an event is triggered.

That might sound more useful if you're looking for a reactive entity without the boilerplate! You might also be thinking that if you wanted an event to fire when ever a property changes, that you'd need to wire up an event listener to every property. But you don't!

// ** AUTO GENERATED CODE: Last generated: 04/11/2022 09:46:42 **
// ***********************

using InFlux;
using InFlux.Attributes;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.ComponentModel.DataAnnotations;

namespace InFluxTests 
{
	public partial class testClass
	{
		public testClass()
		{
			AgeInsight = new(() => age, value => age = value);
			AgeInsight.ValueChangedNotification.Subscribe(() => OnEntityChanged.FireEvent());
		}

		public readonly QueuedEvent OnEntityChanged = new();

		[Required]
		[Range(minimum:16, maximum:21, ErrorMessage ="Range must be between 16 and 21")]
		public int Age {get => AgeInsight.Value; set => AgeInsight.Value = value; }
		public readonly QueuedEventPropertyIndirect<int> AgeInsight;
	}
}

GOTCHA!

Ensure your class is partial. Otherwise you'll get build errors.

Every FIELD encountered will have its first letter CAPITALISED as a way of generating the name for the property.

Attributes

Thankfully DataAnnotation attributes can be placed on fields too. The idea being that you make private fields (lower case) and this will generate public properties with an upper-cased first letter. The attributes are duplicated. The set code block of the property will check for changes, and fire an event to say so.

The constructor generated will pick up on this, and fire off the generic OnEntityChanged event too.

What if I don't won't a property generated?
[AutoWireupIgnore]
int ignoreMe;

Need I say more?

The BIG picture

In an MVC or Blazor style of application, you make come to depend on DataAnnotations for model validation. Especially where you use components (Blazor) and point to the property being represented. As such, the data annotations need to be on a simple property. We can therefore only hide complexity in the setter of the property.

How to access property Events?

Each property generated has a buddy property (insights) named the same as the property but with "Insight" appended, such as "IdInsight".

This property leverages a special version of the QueuedEventProperty to provide you with methods to subscribe to the ValueChanged event either once or indefinitely, as well as being able to unsubscribe from the event.

Perhaps you're beginning to see there's quite a lot of consideration around interactions with such an entity, and its properties, and why leveraging auto-generated code will mean you won't need to test the behaviour, or else you're testing Influx's AutoWireup!

Whilst I fully acknowledge that this generator is far from fully complete, its certainly in a state I'm personally happy to make use of it, and hopefully you will too.

If you've any feedback, you can contact me through the Nuget package page: https://www.nuget.org/packages/InFlux or via the GitHub project issues: https://github.com/Simon-Miller/InFlux/issues

‐ Simon Miller ‐

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.16 147 11/8/2022
1.0.15 140 11/8/2022
1.0.14 143 11/8/2022
1.0.13 159 11/6/2022
1.0.12 162 11/4/2022

Added interface to represent generated model's entity changed event.
Generated code will now implement this interface.