rulerz

RègleZ

Ce projet n'est plus maintenu , contactez-moi si vous souhaitez devenir responsable

L'idée centrale de la spécification est de séparer l'énoncé indiquant comment faire correspondre un candidat de l'objet candidat auquel il est comparé.

Spécifications, expliquées par Eric Evans et Martin Fowler

RulerZ est une implémentation PHP du modèle Spécification qui met l'accent sur trois aspects principaux :

• un DSL simple et indépendant des données pour définir des règles et spécifications métier,
• la capacité de vérifier si un candidat satisfait à un cahier des charges,
• la possibilité de filtrer ou d'interroger n'importe quelle source de données pour récupérer uniquement les candidats correspondant à une spécification.

Introduction

Les règles métier peuvent être écrites sous forme de texte en utilisant un langage dédié, très proche de SQL, auquel cas nous les appelons règles ou elles peuvent être encapsulées dans des classes uniques et appelées spécifications .

Une fois qu'une règle (ou une spécification) est écrite, elle peut être utilisée pour vérifier si un seul candidat la satisfait ou directement pour interroger une source de données.

Les sources de données suivantes sont prises en charge de manière native :

• tableau de tableaux,
• tableau d'objets.

Et la prise en charge de chacun d’entre eux est assurée par une bibliothèque supplémentaire :

• Doctrine DBAL QueryBuilders :  Rulerz-php/doctrine-dbal,
• Doctrine ORM QueryBuilders :  Rulerz-php/doctrine-orm,
• Modèles Pomm :  Rulerz-php/pomm,
• Elasticsearch (en utilisant le client officiel : Rulerz-php/elasticsearch,
• Solr (en utilisant le solarium : Rulerz-php/solarium,
• L'ORM éloquent de Laravel : Rulerz-php/eloquent.

Fonctionnalité qui tue : lorsque vous travaillez avec Doctrine, Pomm ou Elasticsearch, RulerZ est capable de convertir les règles directement en requêtes et n'a pas besoin de récupérer les données au préalable.

C'est cool, mais pourquoi ai-je besoin de ça ?

Tout d’abord, vous exprimez les règles métier dans un langage simple et dédié. Ces règles métier peuvent ensuite être encapsulées dans des classes de spécifications, réutilisées et composées pour former des règles plus complexes. Les spécifications sont désormais réutilisables et testables . Et enfin, ces règles peuvent être utilisées à la fois pour vérifier si un candidat y satisfait et pour filtrer n'importe quelle source de données .

Si vous avez encore besoin d’être convaincu, vous pouvez lire l’intégralité du raisonnement dans cet article.

Utilisation rapide

Pour un aperçu rapide, nous proposons de voir un petit exemple qui manipule une règle simple et plusieurs sources de données.

1. Écrivez une règle

La règle ci-après décrit une « joueuse de haut rang » (en gros, une joueuse ayant plus de 9000 points).

 $ highRankFemalesRule = ' gender = "F" and points > 9000 ' ;

2. Définir une source de données

Nous disposons des sources de données suivantes :

 // a Doctrine QueryBuilder
$ playersQb = $ entityManager
    -> createQueryBuilder ()
    -> select ( ' p ' )
    -> from ( ' EntityPlayer ' , ' p ' );

// or an array of arrays
$ playersArr = [
    [ ' pseudo ' => ' Joe ' ,   ' gender ' => ' M ' , ' points ' => 2500 ],
    [ ' pseudo ' => ' Moe ' ,   ' gender ' => ' M ' , ' points ' => 1230 ],
    [ ' pseudo ' => ' Alice ' , ' gender ' => ' F ' , ' points ' => 9001 ],
];

// or an array of objects
$ playersObj = [
    new Player ( ' Joe ' ,   ' M ' , 40 , 2500 ),
    new Player ( ' Moe ' ,   ' M ' , 55 , 1230 ),
    new Player ( ' Alice ' , ' F ' , 27 , 9001 ),
];

3. Utilisez une règle pour interroger une source de données

Pour n’importe laquelle de nos sources de données, récupérer les résultats est aussi simple que d’appeler la méthode filter :

 // converts the rule in DQL and makes a single query to the DB
$ highRankFemales = $ rulerz -> filter ( $ playersQb , $ highRankFemalesRule );
// filters the array of arrays
$ highRankFemales = $ rulerz -> filter ( $ playersArr , $ highRankFemalesRule );
// filters the array of objects
$ highRankFemales = $ rulerz -> filter ( $ playersObj , $ highRankFemalesRule );

3. (bis) Vérifier si un candidat satisfait à une règle

Étant donné un candidat, vérifier s’il satisfait à une règle revient à appeler la méthode satisfies :

 $ isHighRankFemale = $ rulerz -> satisfies ( $ playersObj [ 0 ], $ highRankFemalesRule );

Aller plus loin

Consultez la documentation pour découvrir ce que RulerZ peut faire pour vous.

Licence

Cette bibliothèque est sous licence MIT.