A refined version of the original EmbeddedResourceAccessGenerator by ChristophHornung

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.
• Added GetMatches method for filesystem globbing support (be careful - it supports only string literals).
• Added [FromPattern] xUnit attribute for use with the [Theory] attribute.
• Added GetFileInfo method to Content and None generators.

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.

Accessing 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);

Using GetMatches for Pattern Matching

var matches = EmbeddedResources.GetMatches("**/*e?/*");
foreach (var resource in matches)
{
    Console.WriteLine(resource);
}

xUnit integration

[Theory]
[EmbeddedResources.FromPattern("**/*")]
public void PrintEmbeddedResource(EmbeddedResource file)
{
    testOutputHelper.WriteLine(file.ToString());
}

ContentItemAccessGenerator

The Raffinert.ContentItemAccessGenerator is a code generator to allow easy access to all content files with CopyToOutputDirectory attribute specified as Always or PreserveNewest.

Usage

Get the nuget package here.

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

Using GetMatches for Pattern Matching

var matches = Contents.GetMatches("**/*?t/*");
foreach (var content in matches)
{
    Console.WriteLine(content);
}

xUnit integration

[Theory]
[Contents.FromPattern("**/cont*")]
public void PrintContentPath(Content file)
{
    testOutputHelper.WriteLine(file.GetContentFilePath());
}

NoneItemAccessGenerator

The Raffinert.NoneItemAccessGenerator is a code generator to allow easy access to all none item files with CopyToOutputDirectory attribute specified as Always or PreserveNewest.

Usage

Get the nuget package here.

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

Using GetMatches for Pattern Matching

var matches = Nones.GetMatches("**/*");
foreach (var none in matches)
{
    Console.WriteLine(none);
}

xUnit integration

[Theory]
[Nones.FromPattern("**/*test.txt")]
public void PrintNonePath(None file)
{
    testOutputHelper.WriteLine(file.GetNoneFilePath());
}

Motivation

Instead of using magic strings in the resource access code that may point to non-existent 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 resources in a subfolder.

Also, it saves quite a bit of typing effort.

Filesystem Globbing Support

For pattern matching in GetMatches and FromPattern xUnit attribute, all three generators use embedded sources from the DotNet.Glob library, which is licensed under MIT.