rulerz

ReglaZ

Este proyecto ya no se mantiene , comuníquese conmigo si está interesado en convertirse en mantenedor

La idea central de la Especificación es separar la declaración de cómo hacer coincidir un candidato del objeto candidato con el que se compara.

Especificaciones, explicadas por Eric Evans y Martin Fowler

RulerZ es una implementación PHP del patrón Especificación que pone énfasis en tres aspectos principales:

• un DSL sencillo e independiente de los datos para definir reglas y especificaciones comerciales,
• la capacidad de comprobar si un candidato satisface una especificación,
• la capacidad de filtrar o consultar cualquier fuente de datos para recuperar solo candidatos que coincidan con una especificación.

Introducción

Las reglas comerciales se pueden escribir como texto usando un lenguaje dedicado, muy cercano a SQL, en cuyo caso nos referimos a ellas como reglas o se pueden encapsular en clases individuales y denominarlas especificaciones .

Una vez escrita una regla (o una especificación), se puede utilizar para comprobar si un único candidato la satisface o directamente para consultar una fuente de datos.

Las siguientes fuentes de datos son compatibles de forma nativa:

• conjunto de conjuntos,
• conjunto de objetos.

Y el soporte para cada uno de ellos lo proporciona una biblioteca adicional:

• Doctrine DBAL QueryBuilders: gobernantez-php/doctrine-dbal,
• Generadores de consultas ORM de Doctrine: rulez-php/doctrine-orm,
• Modelos Pomm: gobernantez-php/pomm,
• Elasticsearch (usando el cliente oficial: rulez-php/elasticsearch,
• Solr (usando el solarium: rulez-php/solarium,
• ORM elocuente de Laravel: rulez-php/eloquent.

Característica excelente: cuando se trabaja con Doctrine, Pomm o Elasticsearch, RulerZ puede convertir reglas directamente en consultas y no necesita recuperar datos de antemano.

Eso está bien, pero ¿por qué lo necesito?

En primer lugar, puede expresar las reglas comerciales en un lenguaje sencillo y específico. Luego, estas reglas de negocio pueden encapsularse en clases de especificación, reutilizarse y componerse para formar reglas más complejas. Las especificaciones ahora son reutilizables y comprobables . Y por si fuera poco, estas reglas se pueden utilizar tanto para comprobar si un candidato la cumple como para filtrar cualquier fuente de datos .

Si aún necesitas que te convenzan, puedes leer el razonamiento completo en este artículo.

Uso rápido

Como descripción general rápida, proponemos ver un pequeño ejemplo que manipula una regla simple y varias fuentes de datos.

1. Escribe una regla

La regla siguiente describe una " jugadora de alto rango " (básicamente, una jugadora que tiene más de 9000 puntos).

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

2. Definir una fuente de datos

Contamos con las siguientes fuentes de datos:

 // 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. Utilice una regla para consultar una fuente de datos

Para cualquiera de nuestras fuentes de datos, recuperar los resultados es tan simple como llamar al método 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) Comprobar si un candidato cumple una regla

Dado un candidato, comprobar si satisface una regla se reduce a llamar al método satisfies :

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

Yendo más lejos

Consulte la documentación para descubrir qué puede hacer RulerZ por usted.

Licencia

Esta biblioteca está bajo la licencia MIT.