Skip to content

Commit

Permalink
Amended readme with commented out bits for nuget package, created pac…
Browse files Browse the repository at this point in the history
…kage and added to nuget. Add a bit more xml documentation.
  • Loading branch information
code-dispenser committed Apr 25, 2024
1 parent f2f7c48 commit 08253e8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
10 changes: 5 additions & 5 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@

[download-image]: https://img.shields.io/nuget/dt/Conditionals.Core
[download-url]: https://www.nuget.org/packages/Conditionals.Core

<h1>
<img src="https://raw.github.com/code-dispenser/Conditionals/main/Assets/icons-64.png" align="center" alt="Conditionals icon" /> Conditionals
</h1>
<!--
# ![icon](https://raw.github.com/code-dispenser/Conditionals/main/Assets/icon-64.png) Conditionals
# ![icon](https://raw.githubusercontent.com/code-dispenser/Conditionals/main/Assets/icons-64.png) Conditionals
-->
<!-- H1 for git hub, but for nuget the markdown is fine as it centers the image, uncomment as appropriate and do the same at the bottom of this file for the icon author -->

## Overview

Docs in Progress so not on nuget yet ....


Conditionals is essentially a Boolean expression-based rules engine, based on my other project [Devs' Rule](https://github.com/code-dispenser/DevsRule). It operates by evaluating conditions, which can be conceptualised as "condition trees." These
trees consist of left and right operands, combined with the logical short-circuiting AndAlso (&&) and OrElse (||) operators.

Expand Down Expand Up @@ -125,8 +123,10 @@ project/nuget package.

<img src="https://raw.githubusercontent.com/code-dispenser/Conditionals/main/Assets/icons-64.png" align="middle" height="32px" alt="Conditionals icon" />
<a target="_blank" href="https://icons8.com/icon/kxE6S5YOUvM6/if">If</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>

<!--
![icon](https://raw.github.com/code-dispenser/Conditionals/main/Assets/icon-48.png) Thanks also to Peerapak Takpho the icon creator, which I found on [freepik.com](https://www.freepik.com/icon/setting_7012934).
![icon](https://raw.githubusercontent.com/code-dispenser/Conditionals/main/Assets/icon-48.png) If [icon by Icons8](https://icons8.com)
-->



10 changes: 10 additions & 0 deletions Source/Conditionals.Core/Areas/Engine/IConditionEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,23 @@ public interface IConditionEngine
/// The rules value type is obtained from the json.
/// </summary>
/// <param name="ruleJson">The string representing the rule in the Json format.</param>
/// <exception cref="MissingExpressionToEvaluateException">Thrown when the expression to evaluate value is missing.</exception>
/// <exception cref="ContextTypeAssemblyNotFoundException">Thrown when the context type name of the condition is missing or not found in the current app domain assemblies.</exception>
/// <exception cref="EventNotFoundException">Thrown when the event type for a rule or condition was not found in the current app domain assemblies.</exception>
/// <exception cref="MissingConditionSetsException">Thrown when the condition set is missing or empty.</exception>
/// <exception cref="RuleFromJsonException">Thrown when an unknown exception was caught, you should check the inner exception for details.</exception>
void IngestRuleFromJson(string ruleJson);

/// <summary>
/// Ingests a rule in json format into the engine.
/// </summary>
/// <typeparam name="T">The return data type of the rule.</typeparam>
/// <param name="ruleJson">The string representing the rule in the Json format.</param>
/// <exception cref="MissingExpressionToEvaluateException">Thrown when the expression to evaluate value is missing.</exception>
/// <exception cref="ContextTypeAssemblyNotFoundException">Thrown when the context type name of the condition is missing or not found in the current app domain assemblies.</exception>
/// <exception cref="EventNotFoundException">Thrown when the event type for a rule or condition was not found in the current app domain assemblies.</exception>
/// <exception cref="MissingConditionSetsException">Thrown when the condition set is missing or empty.</exception>
/// <exception cref="RuleFromJsonException">Thrown when an unknown exception was caught, you should check the inner exception for details.</exception>
void IngestRuleFromJson<T>(string ruleJson);


Expand Down

0 comments on commit 08253e8

Please sign in to comment.