Ryder 0.8.0

.NET Core 2.2 .NET Standard 1.3 .NET Framework 4.5
NuGet\Install-Package Ryder -Version 0.8.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package Ryder --version 0.8.0
<PackageReference Include="Ryder" Version="0.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Ryder --version 0.8.0
#r "nuget: Ryder, 0.8.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Ryder as a Cake Addin
#addin nuget:?package=Ryder&version=0.8.0

// Install Ryder as a Cake Tool
#tool nuget:?package=Ryder&version=0.8.0

<p align="center"> <img src="./Ryder/Properties/Icon.png" alt="Ryder"> </p>

<p align="center"> Ryder is a .NET Core library providing the ability to redirect method calls from one method to another. By extension, it can also redirect property accesses, and event subscriptions / raises. </p>

<p align="center"> <a href="https://nuget.org/packages/Ryder"> <img src="https://img.shields.io/nuget/v/Ryder.svg" alt="NuGet"> </a> <a href="../../issues"> <img src="https://img.shields.io/github/issues-raw/6A/Ryder.svg" alt="Issues"> </a> <a href="./LICENSE.md"> <img src="https://img.shields.io/github/license/6A/Ryder.svg" alt="License"> </a> </p>


Get started

Redirect a method
public static int Incremented(int nbr) => nbr + 1;
public static int Decremented(int nbr) => nbr - 1;

Incremented(1); // => 2.

MethodRedirection r = Redirection.Redirect<Func<int, int>>(Incremented, Decremented);

Incremented(1); // => 0.

// You can also invoke the original method:
r.InvokeOriginal(null, 1); // => 2.

// You can also stop the redirection...
r.Stop(); // or r.IsRedirecting = false, or r.Dispose().
Incremented(1); // => 2.

// ... and restart it
r.Start(); // or r.IsRedirecting = true, unless you disposed it, in which case it's no longer usable
Incremented(1); // => 0.
Using Reactive Extensions
MethodInfo method = typeof(DateTime)
    .GetProperty(nameof(DateTime.Now), BindingFlags.Static | BindingFlags.Public)
    .GetGetMethod();

int count = 0;
DateTime bday = new DateTime(1955, 10, 28);

// Make "DateTime.get_Now()" return "bday" every two calls.
using (Redirection.Observe(method)
                  .Where(_ => count++ % 2 == 0)
                  .Subscribe(ctx => ctx.ReturnValue = bday))
{
    DateTime.Now.ShouldBe(bday);
    DateTime.Now.ShouldNotBe(bday);
    DateTime.Now.ShouldBe(bday);
    DateTime.Now.ShouldNotBe(bday);
}

DateTime.Now.ShouldNotBe(bday);
DateTime.Now.ShouldNotBe(bday);
Other features
Any Redirection also defines the following members:
  • bool IsRedirecting { get; set; }
  • void Start()
  • void Stop()
Redirections can be created in multiple ways:
  • MethodRedirection: Redirect(Delegate, Delegate), Redirect(MethodBase, MethodBase).
  • PropertyRedirection: Redirect(PropertyInfo, PropertyInfo).
  • EventRedirection: Redirect(EventInfo, EventInfo).
Tests:

All features are tested in Ryder.Tests. Please check it out, as it contains some real-world-usage code.

Gloriously unsafe:

By default, Ryder performs many safety checks when you create a new Redirection. However, should you decide to do some experimental things, disabling all those checks is as easy as setting the skipChecks parameter available on all Redirect methods to true.

Implicit JIT checks:

When creating a Redirection, Ryder will ensure that the methods you use have already been jitted. If they haven't, they will be compiled automatically.

Support for i386, x86_64, arm and arm64

Ryder is designed to work with i386, x86_64, arm and arm64 using purely runtime checks. This means that it works everywhere without additional configuration. Additionally, Windows, Linux and OSX are all supported.

Installation

You can install Ryder through the NuGet package manager:

Install-Package Ryder

Alternatively, if you don't want to add a dependency, you can copy-paste the Ryder.Lightweight.cs file in your project. Caution, however, since this version only provides the MethodRedirection class (simply called Redirection), and performs no safety checks.

Additional notes

  • Make sure the method you want to redirect does not get inlined by the JIT; if it does get inlined, redirecting it will most likely break stuff in unexpected ways, or do nothing at all. Additionally, if the method you redirect hasn't been jitted yet, the same problems may arise.
  • In order to keep the GC from collecting jitted methods, Ryder keeps static references to them. Those references are only deleted when Redirection.Dispose() is called, after which the Redirection is no longer guaranteed to work.

Inspiration

Ryder is highly inspired by Harmony, but tries to take a very minimal approach to redirection, instead of providing the ability to patch individual instructions. Moreover, it was made with .NET Core in mind.

Projects using Ryder

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Universal Windows Platform uap uap10.0
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Ryder:

Package Downloads
Cometary.Core

Core package for Cometary, required by the analyzer to edit the dependant assembly. It defines the CompilationEditor type, used to edit assemblies during compilation.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.8.0 93,943 4/8/2019
0.7.0 647 10/7/2018
0.6.0 1,311 11/9/2017
0.5.2 1,731 8/10/2017
0.5.1 715 8/7/2017
0.5.0 736 8/3/2017
0.4.1 727 8/2/2017
0.4.0 709 7/31/2017
0.3.5 708 7/31/2017
0.3.4 690 7/31/2017
0.3.3 692 7/31/2017
0.3.2 701 7/27/2017
0.3.1 671 7/27/2017
0.3.0 672 7/27/2017
0.2.0 683 7/26/2017
0.1.0 818 7/24/2017

- Added support for .NET Framework 4.5 and .NET Core 2.2.