VarDump.Extensions 0.3.6-alpha

Stand with the people of Ukraine: How to Help

VarDump is a utility for serialization of runtime objects to C# or Visual Basic string.

Developed as a free alternative to ObjectDumper.NET, which is not free for commercial use.

C# & VB Dumper:

<p align="right"><a href="https://dotnetfiddle.net/vI6Wq4">Run .NET fiddle</a></p>

using System;
using VarDump;

var anonymousObject = new { Name = "Name", Surname = "Surname" };
var cs = new CSharpDumper().Dump(anonymousObject);
Console.WriteLine(cs);
var vb = new VisualBasicDumper().Dump(anonymousObject);
Console.WriteLine(vb);

C# & VB Dumper, how to use DumpOptions:

<p align="right"><a href="https://dotnetfiddle.net/p4oIKX">Run .NET fiddle</a></p>

using System;
using System.ComponentModel;
using VarDump;
using VarDump.Visitor;

var person = new Person { Name = "Nick", Age = 23 };
var dumpOptions = new DumpOptions { SortDirection = ListSortDirection.Ascending };

var csDumper = new CSharpDumper(dumpOptions);
var cs = csDumper.Dump(person);

var vbDumper = new VisualBasicDumper(dumpOptions);
var vb = vbDumper.Dump(person);

// C# string
Console.WriteLine(cs);
// VB string
Console.WriteLine(vb);

class Person
{
    public string Name {get; set;}
    public int Age {get; set;}
}

Object Extension methods:

<p align="right"><a href="https://dotnetfiddle.net/n9kjiF">Run .NET fiddle</a></p>

using System;
using System.Linq;
using VarDump.Extensions;
using VarDump.Visitor;

var dictionary = new[]
{
    new
    {
        Name = "Name1",
        Surname = "Surname1"
    }
}.ToDictionary(x => x.Name, x => x);

Console.WriteLine(dictionary.Dump(new DumpOptions()));

Object Extension methods, how to switch default dumper to VB:

<p align="right"><a href="https://dotnetfiddle.net/OGCcrk">Run .NET fiddle</a></p>

using System;
using System.Linq;
using VarDump.Extensions;
using VarDump.Visitor;

VarDumpExtensions.VarDumpFactory = VarDumpFactories.VisualBasic;

var dictionary = new[]
{
    new
    {
        Name = "Name1",
        Surname = "Surname1"
    }
}.ToDictionary(x => x.Name, x => x);

Console.WriteLine(dictionary.Dump(new DumpOptions()));

Extensibility:

With middleware:

<p align="right"><a href="https://dotnetfiddle.net/hfrbo6">Run .NET fiddle</a></p>

using System;
using System.Linq;
using VarDump;
using VarDump.Visitor;
using VarDump.Visitor.Descriptors;

// For more examples see https://github.com/ycherkes/VarDump/blob/main/test/VarDump.UnitTests/ObjectDescriptorMiddlewareSpec.cs

var obj = new
{
    FullName = "BRUCE LEE",
    CardNumber = "4953089013607",
    OtherInfo = new 
    {
        CardNumber = "5201294442453002",
    }
};

var dumpOptions = new DumpOptions
{
    Descriptors = { new CardNumberMaskingMiddleware() }
};

var csDumper = new CSharpDumper(dumpOptions);
var cs = csDumper.Dump(obj);

var vbDumper = new VisualBasicDumper(dumpOptions);
var vb = vbDumper.Dump(obj);

// C# string
Console.WriteLine(cs);

// VB string
Console.WriteLine(vb);

class CardNumberMaskingMiddleware : IObjectDescriptorMiddleware
{
    public IObjectDescription GetObjectDescription(object @object, Type objectType, Func<IObjectDescription> prev)
    {
        var objectDescription = prev();

        return new ObjectDescription
        {
            Type = objectDescription.Type,
            ConstructorArguments = objectDescription.ConstructorArguments.Select(MaskCardNumber),
            Properties = objectDescription.Properties.Select(MaskCardNumber),
            Fields = objectDescription.Fields.Select(MaskCardNumber)
        };
    }

    private static bool IsCardNumber<T>(T description) where T : ReflectionDescription
    {
        return description.Type == typeof(string)
               && description.Name?.EndsWith("cardnumber", StringComparison.OrdinalIgnoreCase) == true;
    }

    private static T MaskCardNumber<T>(T description) where T : ReflectionDescription
    {
        if (!IsCardNumber(description) || string.IsNullOrWhiteSpace((string)description.Value))
        {
            return description;
        }

        var stringValue = (string)description.Value;

        var maskedValue = stringValue.Length - 4 > 0
                ? new string('*', stringValue.Length - 4) + stringValue.Substring(stringValue.Length - 4)
                : stringValue;

        return description with
        {
            Value = maskedValue
        };
    }
}

With KnownObjectVisitor:

<p align="right"><a href="https://dotnetfiddle.net/kScIyR">Run .NET fiddle</a></p>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.CompilerServices;
using VarDump;
using VarDump.CodeDom.Compiler;
using VarDump.Visitor;
using VarDump.Visitor.KnownObjects;

// For more examples see https://github.com/ycherkes/VarDump/blob/main/test/VarDump.UnitTests/KnownObjectsSpec.cs

const string name = "World";
FormattableString str = $"Hello, {name}";

var dumpOptions = new DumpOptions
{
    ConfigureKnownObjects = (knownObjects, rootVisitor, _, codeWriter) =>
    {
        knownObjects.Add(new FormattableStringVisitor(rootVisitor, codeWriter));
    }
};

var dumper = new CSharpDumper(dumpOptions);
var result = dumper.Dump(str);
Console.WriteLine(result);

return;

class FormattableStringVisitor(IRootVisitor rootVisitor, ICodeWriter codeWriter) : IKnownObjectVisitor
{
    public bool IsSuitableFor(object obj, Type objectType)
    {
        return obj is FormattableString;
    }

    public void Visit(object obj, Type objectType, VisitContext context)
    {
        var formattableString = (FormattableString)obj;

        IEnumerable<Action> arguments =
        [
            () => codeWriter.WritePrimitive(formattableString.Format)
        ];

        arguments = arguments.Concat(formattableString.GetArguments().Select(a => (Action)(() => rootVisitor.Visit(a, context))));

        codeWriter.WriteMethodInvoke(() =>
            codeWriter.WriteMethodReference(
                () => codeWriter.WriteType(typeof(FormattableStringFactory)),
                nameof(FormattableStringFactory.Create)),
            arguments);
    }
}

For more examples see Unit Tests

Compare VarDump with ObjectDumper.NET - Run .NET fiddle

Powered By

Repository	License
Heavily customized version of System.CodeDom

Privacy Notice: No personal data is collected at all.

This tool has been working well for my personal needs, but outside that its future depends on your feedback. Feel free to open an issue.

🍪 Sponsor me on GitHub or PayPal.