Rules Engine

A simple rules library written in Java

License

License

GroupId

GroupId

au.com.agilepractices.rules.engine
ArtifactId

ArtifactId

rules-engine
Last Version

Last Version

1.0.2
Release Date

Release Date

Type

Type

pom
Description

Description

Rules Engine
A simple rules library written in Java
Project URL

Project URL

https://github.com/amcghie/rules-engine
Source Code Management

Source Code Management

https://github.com/amcghie/rules-engine

Download rules-engine

Filename Size
rules-engine-1.0.2.pom 8 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/au.com.agilepractices.rules.engine/rules-engine/ -->
<dependency>
    <groupId>au.com.agilepractices.rules.engine</groupId>
    <artifactId>rules-engine</artifactId>
    <version>1.0.2</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/au.com.agilepractices.rules.engine/rules-engine/
implementation 'au.com.agilepractices.rules.engine:rules-engine:1.0.2'
// https://jarcasting.com/artifacts/au.com.agilepractices.rules.engine/rules-engine/
implementation ("au.com.agilepractices.rules.engine:rules-engine:1.0.2")
'au.com.agilepractices.rules.engine:rules-engine:pom:1.0.2'
<dependency org="au.com.agilepractices.rules.engine" name="rules-engine" rev="1.0.2">
  <artifact name="rules-engine" type="pom" />
</dependency>
@Grapes(
@Grab(group='au.com.agilepractices.rules.engine', module='rules-engine', version='1.0.2')
)
libraryDependencies += "au.com.agilepractices.rules.engine" % "rules-engine" % "1.0.2"
[au.com.agilepractices.rules.engine/rules-engine "1.0.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

  • rules-engine-core
  • examples/rules-engine-examples-hmrc-tax

Getting Started

To start playing with rules just add the dependency to your project: au.com.agilepractices.rules.engine:rule-engine-core:

Maven

<dependency>
    <groupId>au.com.agilepractices.rules.engine</groupId>
    <artifactId>rules-engine-core</artifactId>
    <version>${rules.version}</version>
</dependency>

Gradle

dependencies {
  compile "au.com.agilepractices.rules.engine:rules-engine-core:$rulesVersion"
}

A rule consists of:

  • A Condition - which must evaluate to true or false
  • An Action - which is executed if the Condition evaluates to true
  • An optional alternative Action - which is executed if the Condition evaluates to false

Example

First step towards evaluation using the rule engine is to define a rule.

We can do it using:

  • Java DSL
final Rule<String, String> rule = RuleBuilder.newRule()
        .when((input, ruleAuditor) -> true)
        .then(context -> context.setResult("Hello " + context.getData()))
        .build();

Then add the Rule to a RuleBook

RuleBook<String, String> ruleBook = RuleBook.newInstance(String.class, String.class)
        .add(rule);

To execute the RuleBook:

String result = new SimpleRuleExecutor<>(ruleBook)
        .execute("World");

assertThat(result).isEqualTo("Hello World");

Versions

Version
1.0.2
1.0.1