Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyperjumptech/grule-rule-engine
Rule engine implementation in Golang
https://github.com/hyperjumptech/grule-rule-engine
golang hacktoberfest hacktoberfest2021 inference-engine rule rule-based rule-based-engine rule-engine
Last synced: 2 days ago
JSON representation
Rule engine implementation in Golang
- Host: GitHub
- URL: https://github.com/hyperjumptech/grule-rule-engine
- Owner: hyperjumptech
- License: other
- Created: 2019-12-13T09:45:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T00:08:28.000Z (5 months ago)
- Last Synced: 2024-12-03T08:05:54.994Z (9 days ago)
- Topics: golang, hacktoberfest, hacktoberfest2021, inference-engine, rule, rule-based, rule-based-engine, rule-engine
- Language: Go
- Homepage:
- Size: 10.6 MB
- Stars: 2,224
- Watchers: 59
- Forks: 347
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-2.0.txt
- Code of conduct: CODE_OF_CONDUCTS.md
Awesome Lists containing this project
- awesome-repositories - hyperjumptech/grule-rule-engine - Rule engine implementation in Golang (Go)
README
[](https://github.com/hyperjumptech/grule-rule-engine/blob/master/gopher-grule.png?raw=true)
[](https://github.com/hyperjumptech/grule-rule-engine/actions/workflows/build-test-workflow.yml)
[](https://goreportcard.com/report/github.com/hyperjumptech/grule-rule-engine)
[](https://opensource.org/licenses/Apache-2.0)
__"Gopher Holds The Rules"__
# Grule-Rule-Engine
```go
import "github.com/hyperjumptech/grule-rule-engine"
```
## Rule Engine for Go
**Grule** is a Rule Engine library for the Go (Golang) programming language. Inspired by the acclaimed JBOSS Drools, and done in a much simpler manner.
Like **Drools**, **Grule** has its own *DSL* or Domain-Specific Language.
Below is an example of Drools's DRL or Drools Rule Language:
```drool
rule "SpeedUp"
salience 10
when
$TestCar : TestCarClass( speedUp == true && speed < maxSpeed )
$DistanceRecord : DistanceRecordClass()
then
$TestCar.setSpeed($TestCar.Speed + $TestCar.SpeedIncrement);
update($TestCar);
$DistanceRecord.setTotalDistance($DistanceRecord.getTotalDistance() + $TestCar.Speed);
update($DistanceRecord);
end
```
Grule's GRL is as follows:
```go
rule SpeedUp "When testcar is speeding up we keep increase the speed." salience 10 {
when
TestCar.SpeedUp == true && TestCar.Speed < TestCar.MaxSpeed
then
TestCar.Speed = TestCar.Speed + TestCar.SpeedIncrement;
DistanceRecord.TotalDistance = DistanceRecord.TotalDistance + TestCar.Speed;
}
```
# What is a Rule Engine
There isn't a better explanation than the article authored by Martin Fowler. You can read the article here ([RulesEngine by Martin Fowler](https://martinfowler.com/bliki/RulesEngine.html)).
Taken from **TutorialsPoint** website (with slight modifications),
The **Grule** Rule Engine is a Production Rule System that uses the rule-based approach to implement an Expert System. Expert Systems are knowledge-based systems that use knowledge representations to process acquired knowledge into a knowledgebase that can be used for reasoning.
A Production Rule System is Turing complete with a focus on knowledge representation to express propositional and first-order logic in a concise, non-ambiguous and declarative manner.
The brain of a Production Rules System is an *Inference Engine* that can scale to a large number of rules and facts. The Inference Engine matches facts and data against Production Rules – also called **Productions** or just **Rules** – to infer conclusions which result in actions.
A Production Rule is a two-part structure that uses first-order logic for reasoning over knowledge representation. A business rule engine is a software system that executes one or more business rules in a runtime production environment.
A Rule Engine allows you to define **“What to Do”** and not **“How to do it.”**
## What is a Rule
*(also taken from TutorialsPoint)*
Rules are pieces of knowledge often expressed as, "When some conditions occur, then do some tasks."
```go
When
Then
```
The most important part of a Rule is its when part. If the **when** part is satisfied, the **then** part is triggered.
```go
rule
{
when
then
}
```
## Advantages of a Rule Engine
### Declarative Programming
Rules make it easy to express solutions to difficult problems and get the verifications as well. Unlike code, Rules are written with less complex language; Business Analysts can easily read and verify a set of rules.
### Logic and Data Separation
The data resides in the Domain Objects and the business logic resides in the Rules. Depending upon the kind of project, this kind of separation can be very advantageous.
### Centralization of Knowledge
By using Rules, you create a repository of knowledge (a knowledge base) which is executable. It is a single point of truth for business policy. Ideally, Rules are so readable that they can also serve as documentation.
### Agility To Change
Since business rules are actually treated as data. Adjusting the rule according to business's dynamic nature becomes trivial. No need to re-build code or deploy as normal software development does - you only need to roll out sets of rules and apply them to knowledge repository.
## Use Cases
The following cases are better solved with a rule-engine:
1. An expert system that must evaluate facts to provide some sort of real-world
conclusion. If not using a RETE-style rule engine, one would code up a
cascading set of `if`/`else` statements, and the permutations of the
combinations of how those might be evaluated would quickly become impossible
to manage. A table-based rule engine might suffice, but it is still more
brittle against change, and is not terribly easy to code. A system like Grule
allows you to describe the rules and facts of your system, releasing you from
the need to describe how the rules are evaluated against those facts, and hiding
the bulk of that complexity from you.
2. A rating system. For example, a bank system may want to create a "score" for
each customer based on the customer's transaction records (facts). We could
see their score change based on how often they interact with the bank, how
much money they transfer in and out, how quickly they pay their bills, how
much interest they accrue, how much they earn for themselves or for the bank,
and so on. A rule engine could be provided by a developer, and the specification
of the facts and rules can then be supplied by subject matter experts within the
bank's customer analytics department. Decoupling these different teams puts the
responsibilities where they should be.
3. Computer games. Player status, rewards, penalties, damage, scores, and
probability systems are many different examples of where rules play a
significant part in most computer games. These rules can interact in
very complex ways, often times in ways that the developer didn't foresee.
Coding these dynamic situations through the use of a scripting language
(e.g. Lua) can get quite complex, and a rule engine can help simplify
the work tremendously.
4. Classification systems. This is actually a generalization of the rating
system described above. Using a rule engine, we can classify things such as
credit eligibility, biochemical identification, risk assessment for
insurance products, potential security threats, and many more.
5. Advice/suggestion system. A "rule" is simply another kind of data, which
makes it a prime candidate for definition by another program. This program
can be another expert system or artificial intelligence. Rules can be
manipulated by other systems in order to deal with new types of facts or
newly discovered information about the domain which the ruleset is intending
to model.
There are many other use-cases that would benefit from the use of a Rule-Engine.
The above cases represent only a small number of the potential ones.
However, it is important to remember that a Rule-Engine not a silver bullet, of
course. Many alternatives exist to solve "knowledge" problems in software, and
those should be employed where they are most appropriate. One would not employ a
rule engine where a simple `if` / `else` branch would suffice, for instance.
Theres's something else to note: some rule engine implementations are extremely
expensive, yet many businesses gain so much value from them that the cost of
running them is easily offset by that value. For even moderately complex use
cases, the benefit of a strong rule engine that can decouple teams and tame
business complexity seems to be quite clear.
## Docs
Documentation page [here](docs/Documentation.md)
To dive into the Tutorial, see the Wiki Docs [here on Github](docs/en/Tutorial_en.md).
### Benchmark
`Loading rules into KnowledgeBase`:
* To load `100` rules into knowledgeBase it took `99342047 ns/op` (took the highest value) that is equal to `~99.342047ms` and (`49295906 B/op`) `~49.295906MB` memory per operation
* To load `1000` rules into knowledgeBase it took `933617752 ns/op` (took the highest value) that is equal to `~933.617752ms` and (`488126636 B/op`) `~488.126636` memory per operation
`Executing rules against a fact`:
* To execute a fact against 100 rules, Grule Engine took `~9697 ns/op` (took the highest value as base) that is hardly `~0.009697ms` and `3957 B/op` which is pretty fast.
* To execute a fact against 1000 rules, Grule Engine took `~568959 ns/op` (took the highest value as base) that is hardly `~0.568959ms` and `293710 B/op` which is also pretty fast.
You can read the [detail report here](docs/en/Benchmarking_en.md)
# Tasks and Help Wanted
Yes. We need contributors to make Grule even better and useful to the Open Source Community.
* Need to do more and more and more tests.
* Better code coverage test.
* Better commenting for go doc best practice.
* Improve function argument handling to be more fluid and intuitive.
If you really want to help us, simply `Fork` the project and apply for Pull Request.
Please read our [Contribution Manual](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCTS.md)