JsonRuleEngine.Net 1.0.15

There is a newer version of this package available.
See the version list below for details.
dotnet add package JsonRuleEngine.Net --version 1.0.15
NuGet\Install-Package JsonRuleEngine.Net -Version 1.0.15
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="JsonRuleEngine.Net" Version="1.0.15" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JsonRuleEngine.Net --version 1.0.15
#r "nuget: JsonRuleEngine.Net, 1.0.15"
#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 JsonRuleEngine.Net as a Cake Addin
#addin nuget:?package=JsonRuleEngine.Net&version=1.0.15

// Install JsonRuleEngine.Net as a Cake Tool
#tool nuget:?package=JsonRuleEngine.Net&version=1.0.15

Build status Nuget

JsonRuleEngine.Net

A simple C# rule engine parser and evaluator using a simple json format. This lib is inspired by the json rules engine. (https://github.com/cachecontrol/json-rules-engine)[https://github.com/cachecontrol/json-rules-engine]

Purpose

In some case you'll need to store some complex conditions object in database. The purpose of this library is to provide a simple way to store and transform to linq Expression tree nested conditional rules stored in json in database, filesystem...

Json format of queries

Here is a basic JSON sample that represents rules

{
  "separator": "And",
  "rules": [
    {
      "separator": "Or",
      "rules": [
        {
          "field": "Name",
          "operator": "equal",
          "value": "Assassin's creed"
        },
        {
          "field": "Name",
          "operator": "equal",
          "value": "Data"
        }
      ]
    },
    {
      "field": "Category",
      "operator": "in",
      "value": [
        "Action",
        "Adventure"
      ]
    },
    {
      "field": "Price",
      "operator": "greaterThan",
      "value": 5
    }
  ]
}

You can post it to a simple controller using the ConditionRuleSet class

[HttpPost]
public IActionResult PostRules([FromBody] ConditionRuleSet rules) {
    // Save it in DB or whatever
    if (ModelState.IsValid) {
	    _db.Add(rules);
	    _db.SaveChanges();
    }
}

Simple use

Installation

You need to install the nuget library

install-package JsonRuleEngine.Net

For evaluating a rule with a single object

string ruleJson = "{  
    \"field\": \"Name\",
    \"operator\": \"equal\",
    \"value\": \"Assassin's creed\" 
}";

Game objectToTest = new Game() { 
    Name = "Assassin's creed"
};

bool result = JsonRuleEngine.Evaluate(objectToTest, ruleJson);

return result; // this must display "True"

For filtering a list using an expression

The expression parsed will work with LinqToSql query with EntityFramework Core.

string ruleJson = "{}"
var expression = JsonRuleEngine.ParseExpression<Game>(ruleJson);
var datas = new List<Game>() {
    new Game() {
        Name = "test"
    }
};

// Works with LinqToSql queries
var list = datas.Where(expression).ToList();

The nested rules object

ConditionRuleSet

Field name Type Description
separator enum (Or, And) optional The type of condition rules
field string optional The name of the field used for filtering (Camel sensitive). If the rules properties contains no element this field must be set
operator enum (equal,notEqual, lessThan,lessThanInclusive,greaterThan, greaterThanInclusive,in,notIn, contains, doesNotContains) default:equal The type of method used for comparing values
value object optional, default:null The string value, the number or the object used for egality comparison. In case, the in operator is used, this must be a list of string
rules List of ConditionRuleSet optional, default: null The nested rules contained in the group
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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.0.98 369 2/23/2024
1.0.96 195 2/12/2024
1.0.93 224 2/12/2024
1.0.92 186 2/11/2024
1.0.91 170 2/11/2024
1.0.87 448 12/3/2023
1.0.83 1,823 10/18/2023
1.0.79 1,051 7/13/2023
1.0.78 389 6/21/2023
1.0.77 917 6/13/2023
1.0.76 286 6/6/2023
1.0.75 2,351 3/29/2023
1.0.74 495 2/24/2023
1.0.73 553 1/26/2023
1.0.71 557 12/6/2022
1.0.70 463 12/5/2022
1.0.69 498 11/25/2022
1.0.68 472 11/25/2022
1.0.67 489 11/25/2022
1.0.66 463 11/25/2022
1.0.65 463 11/24/2022
1.0.64 471 11/24/2022
1.0.62 838 8/17/2022
1.0.61 574 8/17/2022
1.0.60 572 8/11/2022
1.0.59 609 8/9/2022
1.0.58 667 7/13/2022
1.0.57 638 6/28/2022
1.0.55 580 6/28/2022
1.0.54 603 6/3/2022
1.0.53 604 5/18/2022
1.0.52 669 5/18/2022
1.0.47 811 1/17/2022
1.0.45 768 1/12/2022
1.0.44 613 1/10/2022
1.0.43 642 1/10/2022
1.0.41 450 1/9/2022
1.0.40 1,520 11/12/2021
1.0.39 607 9/13/2021
1.0.38 755 4/26/2021
1.0.32 554 4/24/2021
1.0.31 557 4/22/2021
1.0.30 541 4/20/2021
1.0.29 559 4/20/2021
1.0.25 540 4/19/2021
1.0.23 534 4/19/2021
1.0.22 558 4/19/2021
1.0.21 564 4/19/2021
1.0.15 1,099 11/11/2020
1.0.12 852 11/11/2020