Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibrahimgunduz34/maria-bundle
Maria Bundle is a rule engine implementation for Symfony applications that you can integrate to your projects and define your business rules easily.
https://github.com/ibrahimgunduz34/maria-bundle
bundle library php rules-engine symfony
Last synced: about 1 month ago
JSON representation
Maria Bundle is a rule engine implementation for Symfony applications that you can integrate to your projects and define your business rules easily.
- Host: GitHub
- URL: https://github.com/ibrahimgunduz34/maria-bundle
- Owner: ibrahimgunduz34
- License: mit
- Created: 2019-11-15T16:23:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-17T14:39:37.000Z (almost 4 years ago)
- Last Synced: 2024-10-01T15:27:40.833Z (about 1 month ago)
- Topics: bundle, library, php, rules-engine, symfony
- Language: PHP
- Size: 49.8 KB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MariaBundle
[](https://travis-ci.com/ibrahimgunduz34/maria-bundle)
[](https://gitHub.com/ibrahimgunduz34/maria-bundle/releases/)
[](https://github.com/ibrahimgunduz34/maria-bundle/blob/master/LICENSE)
## What is MariaBundle
Maria is a simple and flexible business rule engine that you can integrate easily into
your Symfony applications through Bundle mechanism. It allows taking
an action based on the rules when the input data matched. You can
trigger Maria by a trigger event you defined. It checks the input
argument which comes through the trigger event by the rules and
invokes the action handler when matching occurred. Action handlers
might be a class or a reference that points to a service definition
in the dependency injection system. So you can communicate with other Symfony
components easily through action handlers on Maria scenarios.
## Installation
You can install Maria through composer
```bash
$ composer require ibrahimgunduz34/maria-bundle
```
Add the bundle class to the bundle list by your Symfony version:
### For Symfony 3.x users:
**AppKernel.php**
```php
= 4 users:
**config/bundles.php**
```php
['all' => true],
//...
];
```
## Configuration Reference
```yaml
# config/packages/maria.yaml
maria:
scenarios_name:
trigger:
handler:
# handler:
# reference:
# method:
# serialize:
rules:
# You can define matchers as any, all, none, first or last matcher
# in the first line. If you won't an iterable object, you can simply
# use default or ignore the first line.
default: # [any | all | none | first | last | default ]
# You can define rules by numeric or associative arrays.
# Associative arrays indicate that you will apply AND logic between the
# elements in the array
# Numeric arrays indicate that you will apply OR logic between the
# elements in the array.
# amount > 100 AND category_id IN [1, 2, 3]
amount: {gt: 100}
category_id: { in: [1,2,3] }
# (amount > AND category_id=1) OR (amount < 500 AND category_id IN [5,6])
- amount: {gt: 100}
category_id: { eql: 1 }
- amount: [lt: 500]
category_id: { in: [5,6] }
# (category_id IN [1,2] AND amount BETWEEN 100-200) OR (category_id = 3 AND amount >= 200
- amount: { btw: [100, 200] }
category_id: { in: [1, 2] }
- amount: [lte: 200]
category_id: { eql: 3 }
# Matching by RegExp
- { category_id: { in: [1,5] }, description: { regex: /awesome/i } }
```
## See Also
* [Iterable Matchers](/Resources/docs/matchers.md)
* [Arithmetic And Logic Operators](/Resources/docs/operators.md)
## Example Usage
Define the following configuration into `config/packages/maria.yaml`
```yaml
maria:
free_shipment:
trigger: cart.updated
handler: App\Handler\FreeShipmentHandler
rules:
amount: {gt: 100}
category_id: {eql: 1}
```
Create a handler class in order to take an action to give free shipment
```php
getData();
}
}
```
Trigger Maria where you updated cart in the project.
```php
get('event_dispatcher');
// You can simply send an object or associative array to Maria through event context.
$context = [
'amount' => $order->getAmount(),
'category_id' => $order->getCategoryId(),
]
$eventDispatcher->dispatch(new \SweetCode\MariaBundle\MariaEventArg($context), 'cart.updated');
//...
```
## Working In Asynchronous Way
Maria does not provide a way to invoke action handlers as asynchronous. However, you can make
action handlers asynchronous easily by using other third-parties like `RabbitMqBundle` or
built-in Symfony components like `Messenger` You can make your action handler asynchronous by
following the steps below:
**Important Notice:** We strongly recommend to follow the installation steps from `rabbitmq-bundle` repository:
[https://github.com/php-amqplib/RabbitMqBundle](https://github.com/php-amqplib/RabbitMqBundle)
Install RabbitMqBundle
```bash
$ composer require php-amqplib/rabbitmq-bundle
```
Add the bundle class to bundle the bundle list in the project:
### For Symfony 3.x users:
**AppKernel.php**
```php
= 4 users:
**config/bundles.php**
```php
['all' => true],
//...
];
```
Configure the RabbitMq bundle.
```yaml
# config/packages/rabbitmq.yaml
old_sound_rabbit_mq:
connections:
host: my.rabbitmq.host
user: rabbitmq
password: rabbitmq
vhost: '/'
lazy: false
connection_timeout: 3
read_write_timeout: 3
keepalive: false
heartbeat: 0
use_socket: true
producers:
email_producer:
connection: default
exchange_options: {name: 'emails', type: direct}
service_alias: email_producer # otherwise it gives very long service name
consumers:
email_consumer:
exchange_options: {name: 'emails', type: direct}
queue_options: {name: 'emails'}
# That's the service you need to implement as a consumer.
# Check the documentation from the repository to see how to implement a consumer:
# https://github.com/php-amqplib/RabbitMqBundle#consumers
callback: email_sender_service
```
And.. say maria, use `email_producer` as an action handler.
```yaml
maria:
gift-email:
trigger: some.event
handler:
reference: '@email_producer'
method: 'publish'
erialize: true
rules:
##...
```
Enjoy!
## TODO:
* Moving the scenario rules into different type of storage providers such as `in_memory` or `doctrine`
* Validation improvement for configuration.
## License:
You can access the license documentation [here](/LICENSE).
## Credits:
Bundles structure, extension tests and the documentation partially inspired `RabbitMqBundle`.