Raffinert.EmbeddedResourceAccessGenerator 1.0.4

A refined version of the original EmbeddedResourceAccessGenerator by ChristophHornung

Important: The original EmbeddedResourceAccessGenerator is incompatible with this generator and must be removed before adding this generator.

Improvements in the EmbeddedResourceAccessGenerator:

• Fixed a bug when the generator generates code for all AdditionalFiles, not EmbeddedResources only. This means that the original EmbeddedResourceAccessGenerator is incompatible with all three generators and must be removed before adding those generators.
• Removed properties from the EmbeddedResources class, because it's an anti-pattern to create disposable resources on every get property access.
• The GetReader method now creates the StreamReader with the option leaveOpen: false. It disposes the stream together with the StreamReader.
• Added synchronous and asynchronous extension methods ReadAllText, ReadAllTextAsync, ReadAllBytes, ReadAllBytesAsync.

EmbeddedResourceAccessGenerator

The Raffinert.EmbeddedResourceAccessGenerator is a code generator to allow easy access to all embedded resources.

Usage

Get the nuget package here.

After referencing the Raffinert.EmbeddedResourceAccessGenerator nuget the code generation will automatically create a class EmbeddedResources in the root namespace of the project.

Together with the generated EmbeddedResource enumeration there are several options to access embedded resources:

E.g. for a Test.txt embedded resource in the TestAsset folder:

• Via enum access through the EmbeddedResource enum:

    // Via the generated extension methods on the enum
    using Stream s = EmbeddedResource.TestAsset_Test_txt.GetStream();
    using StreamReader sr = EmbeddedResource.TestAsset_Test_txt.GetReader();
    string text = EmbeddedResource.TestAsset_Test_txt.ReadAllText();
    string textAsync = await EmbeddedResource.TestAsset_Test_txt.ReadAllTextAsync(CancellationToken.None);
    byte[] bytes = EmbeddedResource.TestAsset_Test_txt.ReadAllBytes();
    byte[] bytesAsync = await EmbeddedResource.TestAsset_Test_txt.ReadAllBytesAsync(CancellationToken.None);

• Via enum access through the EmbeddedResource[FolderName] enum:

    // Via the generated extension methods on the enum
    using Stream s = EmbeddedResource_TestAsset.Test_txt.GetStream();
    using StreamReader sr = EmbeddedResource_TestAsset.Test_txt.GetReader();
    string text = EmbeddedResource_TestAsset.Test_txt.ReadAllText();
    string textAsync = await EmbeddedResource_TestAsset.Test_txt.ReadAllTextAsync(CancellationToken.None);
    byte[] bytes = EmbeddedResource_TestAsset.Test_txt.ReadAllBytes();
    byte[] bytesAsync = await EmbeddedResource_TestAsset.Test_txt.ReadAllBytesAsync(CancellationToken.None);

Motivation

Instead of using magic strings in the resource access code that may point to non-existant resources this generator guarantees resources to exist and code to not compile when they are removed.

Grouping the resources via their path adds path specific enums, e.g. to easily write tests for all embedded resource in a subfolder.

Also it saves quite a bit of typing effort.

See also:

• Raffinert.ContentItemAccessGenerator
• Raffinert.NoneItemAccessGenerator