timophe.RulesEngine 1.2.1

dotnet add package timophe.RulesEngine --version 1.2.1                
NuGet\Install-Package timophe.RulesEngine -Version 1.2.1                
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.
<PackageReference Include="timophe.RulesEngine" Version="1.2.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add timophe.RulesEngine --version 1.2.1                
#r "nuget: timophe.RulesEngine, 1.2.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install timophe.RulesEngine as a Cake Addin
#addin nuget:?package=timophe.RulesEngine&version=1.2.1

// Install timophe.RulesEngine as a Cake Tool
#tool nuget:?package=timophe.RulesEngine&version=1.2.1                

build Coverage Status Nuget download

Rules Engine

NOTICE: This is a FORK of microsoft/RulesEngine

This fork will develop detached from the original project.

Now with Interface

I added Interfaces for Rule and Workflow, to easier customize the behaviour of the rule to personal needs. Tried to not do breaking changes.

Roadmap

This is the Roadmap of this RulesEngine fork.

  • Add Event to OnFailed
  • Enhance and Correct the Wiki
  • Add LogicalRule and LeafRule as classes for easier use
  • Add AI Support for the RulesEngine (OpenAI and Google probably)

Somewhat later: Probably breaking changes:

  • Migrate from Newtonsoft.Json to System.Text.Json

Overview

Rules Engine is a library/NuGet package for abstracting business logic/rules/policies out of a system. It provides a simple way of giving you the ability to put your rules in a store outside the core logic of the system, thus ensuring that any change in rules don't affect the core system.

Installation

To install this library, download the latest version of NuGet Package from nuget.org and refer it into your project.

How to use it

There are several ways to populate workflows for the Rules Engine as listed below.

You need to store the rules based on the schema definition given, and they can be stored in any store as deemed appropriate like Azure Blob Storage, Cosmos DB, Azure App Configuration, Entity Framework, SQL Servers, file systems etc. For RuleExpressionType LambdaExpression, the rule is written as a lambda expressions.

An example rule:

[
  {
    "WorkflowName": "Discount",
    "Rules": [
      {
        "RuleName": "GiveDiscount10",
        "SuccessEvent": "10",
        "ErrorMessage": "One or more adjust rules failed.",
        "ErrorType": "Error",
        "RuleExpressionType": "LambdaExpression",
        "Expression": "input1.country == \"india\" AND input1.loyaltyFactor <= 2 AND input1.totalPurchasesToDate >= 5000"
      },
      {
        "RuleName": "GiveDiscount20",
        "SuccessEvent": "20",
        "ErrorMessage": "One or more adjust rules failed.",
        "ErrorType": "Error",
        "RuleExpressionType": "LambdaExpression",
        "Expression": "input1.country == \"india\" AND input1.loyaltyFactor >= 3 AND input1.totalPurchasesToDate >= 10000"
      }
    ]
  }
]

You can inject the rules into the Rules Engine by initiating an instance by using the following code -

var rulesEngine = new RulesEngine(workflow);

Here, workflow is a list of deserialized objects based on the schema explained above Once initialised, the Rules Engine needs to execute the rules for a given input. This can be done by calling the method ExecuteAllRulesAsync:

List<RuleResultTree> response = await rulesEngine.ExecuteAllRulesAsync(workflowName, input);

Here, workflowName is the name of the workflow, which is Discount in the above-mentioned example. And input is the object which needs to be checked against the rules, which itself may consist of a list of class instances.

The response will contain a list of RuleResultTree which gives information if a particular rule passed or failed.

A demo app for the is available at this location.

Basic

<details> A simple example via code only is as follows:

List<Rule> rules = new List<Rule>();

Rule rule = new Rule();
rule.RuleName = "Test Rule";
rule.SuccessEvent = "Count is within tolerance.";
rule.ErrorMessage = "Over expected.";
rule.Expression = "count < 3";
rule.RuleExpressionType = RuleExpressionType.LambdaExpression;
rules.Add(rule);

var workflows = new List<Workflow>();

Workflow exampleWorkflow = new Workflow();
exampleWorkflow.WorkflowName = "Example Workflow";
exampleWorkflow.Rules = rules;

workflows.Add(exampleWorkflow);

var bre = new RulesEngine.RulesEngine(workflows.ToArray());

</details>

Entity Framework

<details> Consuming Entity Framework and populating the Rules Engine is shown in the EFDemo class with Workflow rules populating the array and passed to the Rules Engine, The Demo App includes an example RulesEngineDemoContext using SQLite and could be swapped out for another provider.

var wfr = db.Workflows.Include(i => i.Rules).ThenInclude(i => i.Rules).ToArray();
var bre = new RulesEngine.RulesEngine(wfr, null);

Note: For each level of nested rules expected, a ThenInclude query appended will be needed as shown above. </details>

How it works

<details>

alternate text is missing from this package README image

The rules can be stored in any store and be fed to the system in a structure which adheres to the schema of WorkFlow model.

A wrapper needs to be created over the Rules Engine package, which will get the rules and input message(s) from any store that your system dictates and put it into the Engine. The wrapper then handles the output using appropriate means.

Note: To know in detail of the workings of Rules Engine, please visit How it works section in Rules Engine Wiki.

</details>

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.


For more details please check out Rules Engine Wiki.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.1 94 10/8/2024
1.2.0 98 7/18/2024
1.1.4 452 6/26/2024
1.1.3-alpha 86 6/25/2024
1.1.0-alpha 113 6/23/2024
1.0.2 96 6/25/2024
1.0.1 106 6/22/2024
1.0.0 106 6/21/2024