Release 3.0.0

[luispfgarces]

Description

Release 3.0.0

Includes:

• Remove obsolete APIs #167
• chore(deps): bump System.Text.Json from 6.0.6 to 8.0.4 in /src/Rules.Framework.WebUI #168
• Create non generic rules engine #169
• Rename content type to ruleset #171
• Replace conditions collection with dictionary #172
• Revamp Web UI #173

Warning

BREAKING CHANGES:

• PriotityCriteria property on RulesEngineOptions - previously deprecated due to a typo.

• Old rule builder APIs - were already marked obsolete.

• Condition default constructor.

• On rules engine build-up. Current usages of the library will have to remove TContentType and TConditionType from builder methods and use and additional MakeGeneric<TContentType, TConditionType>() method to get a equivalent instance of RulesEngine<TContentType, TConditionType>.

• Additional APIs were added to create and get content types from the rules engine.
  From now on, the library users will be required to create explicitly the content types using the new API, except if the AutoCreateContentTypes option is true.
  This is a breaking change on behavior.

• The rule builder API was refactored to align with the Rule Query Language specification (being developed on a separate branch).

  Take as example the RQL sentence:

  create rule "Test rule" on ruleset "TexasHoldemPokerSingleCombinations"
  set content "{\"BasePoints\":0,\"Combination\":\"Test combination\"}"
  since $2023-01-01Z$ until $2023-12-31Z$
  apply when @NumberOfAces >= 5
  set priority top;
  

  It would be written on rule builder API as:

  var rule = Rule.Create("Test rule")
      .OnRuleset("TexasHoldemPokerSingleCombinations")
      .SetContent("{\"BasePoints\":0,\"Combination\":\"Test combination\"}")
      .Since(DateTime.Parse("2023-01-01Z"))
      .Until(DateTime.Parse("2023-12-31Z"))
      .ApplyWhen("NumberOfAces", Operators.GreaterOrEqualThan, 5)
      .Build().Rule;
  
  var operationResult = await rulesEngine.AddRuleAsync(rule, RuleAddPriorityOption.AtTop);

• Conditions are no longer accepted via a collection of Condition and a dictionary is accepted instead. As such, all calls to MatchOneAsync(...), MatchAllAsync(...), and SearchAsync(...) will need adjustment to provide a dictionary of conditions alternatively.

• It was possible to set up on which resource the Web UI was exposed (e.g. /rules or /xyz). Now it is statically exposed on /rules-ui without the possibility of configuring it - Blazor's rooting limitation. It might possible to configure it but it will require experimenting on creating custom Blazor routing discovery classes.

• Multiple rules engine instances were exposed under different resources. Now all rules engine instances are exposed under the same resource /rules-ui.

• The conditions "pretty print" was removed.

Change checklist

• Code follows the code rules guidelines of this project
• Commit messages follow the commit rules of this project
• I have self-reviewed my changes before submitting this pull request
• I have covered new/changed code with new tests and/or adjusted existent ones
• I have made changes necessary to update the documentation accordingly

Please also check the I want to contribute guidelines and make sure you have done accordingly.

Disclaimer

By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement