Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/StefH/ProxyInterfaceSourceGenerator
This project uses Source Generation to generate an interface and a Proxy class for classes. This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use Dependency Injection.
https://github.com/StefH/ProxyInterfaceSourceGenerator
code-generation
Last synced: about 1 month ago
JSON representation
This project uses Source Generation to generate an interface and a Proxy class for classes. This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use Dependency Injection.
- Host: GitHub
- URL: https://github.com/StefH/ProxyInterfaceSourceGenerator
- Owner: StefH
- License: mit
- Created: 2021-07-23T14:02:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T18:33:17.000Z (2 months ago)
- Last Synced: 2024-10-29T18:44:39.610Z (about 1 month ago)
- Topics: code-generation
- Language: C#
- Homepage:
- Size: 308 KB
- Stars: 38
- Watchers: 9
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - ProxyInterfaceGenerator
- csharp-source-generators - ProxyInterfaceGenerator -   generate an interface and a Proxy class for classes. This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use DI. (Source Generators / Testing)
README
# ProxyInterfaceGenerator
This project uses Source Generation to generate an interface and a Proxy class for classes.
This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use DI.
It supports:
- properties
- methods
- events
- implicit and explicit operators
## NuGet
[](https://www.nuget.org/packages/ProxyInterfaceGenerator)
## Usage
### Given: an external existing class which does not implement an interface
``` c#
public sealed class Person
{
public string Name { get; set; }
public string HelloWorld(string name)
{
return $"Hello {name} !";
}
}
```
### Create a partial interface
And annotate this with `ProxyInterfaceGenerator.Proxy[...]` and with the Type which needs to be wrapped:
``` c#
[ProxyInterfaceGenerator.Proxy(typeof(Person))]
public partial interface IPerson
{
}
```
#### ProxyBaseClasses
In case also want to proxy the properties/methods/events from the base class(es), use this:
``` c#
[ProxyInterfaceGenerator.Proxy(typeof(Person), true)] // 👈 Provide `true` as second parameter.
public partial interface IPerson
{
}
```
#### ProxyClassAccessibility
By default, the generated Proxy class is `public`. If you want to create the Proxy class as `internal`, use the following:
``` c#
[ProxyInterfaceGenerator.Proxy(typeof(Person), ProxyClassAccessibility.Internal)] // 👈 Provide `ProxyClassAccessibility.Internal` as second parameter.
public partial interface IPerson
{
}
```
### When the code is compiled, this source generator creates the following
#### :one: An additional partial interface
Which defines the same properties and methods as in the external class.
``` c#
public partial interface IPerson
{
string Name { get; set; }
string HelloWorld(string name);
}
```
#### :two: A Proxy class
Which takes the external class in the constructor and wraps all public properties, events and methods.
``` c#
// ⭐
public class PersonProxy : IPerson
{
public Person _Instance { get; }
public PersonProxy(Person instance)
{
_Instance = instance;
}
public string Name { get => _Instance.Name; set => _Instance.Name = value; }
public string HelloWorld(string name)
{
string name_ = name;
var result_19479959 = _Instance.HelloWorld(name_);
return result_19479959;
}
}
```
:star: By default the accessibility from the generated Proxy class is `public`.
### :three: Use it
``` c#
IPerson p = new PersonProxy(new Person());
p.Name = "test";
p.HelloWorld("stef");
```
### Extra functionality
#### Ignore members
You can ignore members by adding a property to the membersToIgnore string array.
Example when you want to ignore the `Postcode` property:
``` c#
[Proxy(typeof(Address), ["Postcode"])]
public partial interface IAddress
{
}
```
Note that's also possible to use wildcard matching to ignore multiple members at once.
``` c#
[Proxy(typeof(Address), ["Post*"])]
public partial interface IAddress
{
}
```
# References
- https://route2roslyn.netlify.app/symbols-for-dummies/