ExpressWalker NuGet Package

ExpressWalker provides a generic way to examine and change any object graph in fashion similar to "Visitor Pattern".

You can build generic hierarchy composition (visitor) that can visit and change any object's property, basing on configuration. Relies on expression trees while visiting objects (uses reflection only once while building a visitor). That's why IT IS WAY FASTER than custom solutions built with reflection.
It is protected from circular references so you can avoid exceptions. Provides fluent API which increases code readability in terms of guessing the hierarchy being built from the code.

Some of functionalities: visiting properties by matching owner type, property name and type (or only property type), visiting collecitons and dictionary items, specifying depth, custom expression for changing property value, cloning etc.

//example 1 - IVisitor that visits properties by ownner type and property names and/or types (start from TypeWalker class):

var typeVisitor = TypeWalker<Parent>.Create()
.ForProperty<Parent, string>(p => p.TestString1, (old, met) => old + met)
.ForProperty<Child, DateTime>(p => p.TestDate1, (old, met) => old.AddYears(10))
.ForProperty<CommonType>((old, met) => new CommonType { CommonString = "..." })
.Build(depth:10, guard:new PropertyGuard(), supportsCloning: true);

//guard is protection against type-wise circular references. supportsCloning = false improves build time.

var parentClone = new Parent();
var propertyValues = new HashSet<PropertyValue>()
typeVisitor.Visit(parentObject, parentClone, depth:10, guard:new InstanceGuard(), values:propertyValues);

//guard is protection against instance-wise circular references. values will hold flat list of new/old values.

//example 2 - IVisitor that visits properties by explicit configuration (start from ManualWalker class):

var manualVisitor = ManualWalker.Create<A1>()
.Property<A1, DateTime>(a1 => a1.A1Date, (va1, met) => va1.AddYears(10))
.Element<A1, B1>(a1 => a1.B1, b1 =>
b1.Property<B1, string>(x => x.B1Name, (vb1, met) => vb1 + "Test2"))
.Collection<A1, B2>(a1 => a1.B2List, b2 => b2
.Property<B2, DateTime>(x => x.B2Date, (vb2, met) => vb2.AddYears(10)))
.Build();

manualVisitor.Visit(parentObject, blueprint:null, depth:10, guard:new InstanceGuard(), values:null);

//Paremeter 'met' in expressions above is optional metadata object set in design-time.
//It can be set by [VisitorMetadata] property attribute in visited class.
//e.g.

in example above, there is [VisitorMetadata("AnyString")] on property Parent.TestString1.

//example 3 - IVisitor built and cached using the IVisitorsFactory:
//scenario for visitors of same settings built for different types:

var factory = new VisitorsFactory().WithSettings("name1", depth:5, usePropertyGuard:false, supportsCloning:false)
.ForProperty<int>((val, met) => 2)
.WithSettings("name6")
.ForProperty<Parent, string>( x => x.Name, (val, met) => "t");

var visitor1 = factory.GetVisitor("name1", typeof(Class1));
var visitor1a = factory.GetVisitor("name1", typeof(Class1));
var visitor2 = factory.GetVisitor("name1", typeof(Class2));
var visitor6 = factory.GetVisitor("name6", typeof(Class6));

//visitor1 == visitor1a --true
//visitor1 == visitor2 --false

Many thanks to Francisco José Rey Gozalo for contributing with ideas and solutions.
Read more on https://github.com/kopalite/ExpressWalker.




Got any ExpressWalker Question?





Info

Version: 2.1.0.1
Author(s): Ivan Kopcanski
Last Update: Sunday, April 1, 2018
.NET Fiddle: Create the first Fiddle
Project Url: https://github.com/kopalite/ExpressWalker
NuGet Url: https://www.nuget.org/packages/ExpressWalker


Install
Install-Package ExpressWalker
dotnet add package ExpressWalker
paket add ExpressWalker
ExpressWalker Download (Unzip the "nupkg" after downloading)



Tags



STATS

must-have-score

avg-downloads-per-day

4

days-since-last-release

2426