rulerz

RéguaZ

Este projeto não é mais mantido , entre em contato comigo se estiver interessado em se tornar um mantenedor

A ideia central da Especificação é separar a declaração de como combinar um candidato do objeto candidato com o qual ele é comparado.

Especificações, explicadas por Eric Evans e Martin Fowler

RulerZ é uma implementação PHP do padrão de especificação que enfatiza três aspectos principais:

• uma DSL fácil e independente de dados para definir regras e especificações de negócios,
• a capacidade de verificar se um candidato satisfaz uma especificação,
• a capacidade de filtrar ou consultar qualquer fonte de dados para recuperar apenas candidatos que correspondam a uma especificação.

Introdução

As regras de negócios podem ser escritas como texto usando uma linguagem dedicada, muito próxima do SQL, caso em que nos referimos a elas como regras ou podem ser encapsuladas em classes únicas e chamadas de especificações .

Depois que uma regra (ou especificação) é escrita, ela pode ser usada para verificar se um único candidato a satisfaz ou diretamente para consultar uma fonte de dados.

As seguintes fontes de dados são suportadas nativamente:

• matriz de matrizes,
• matriz de objetos.

E o suporte para cada um deles é fornecido por uma biblioteca adicional:

• Doutrina DBAL QueryBuilders: governantez-php/doctrine-dbal,
• Doutrina ORM QueryBuilders: governantez-php/doctrine-orm,
• Modelos Pomm: governantez-php/pomm,
• Elasticsearch (usando o cliente oficial: governantez-php/elasticsearch,
• Solr (usando o solário: governantez-php/solarium,
• ORM Eloquent do Laravel: governantez-php/eloquent.

Recurso matador: ao trabalhar com Doctrine, Pomm ou Elasticsearch, o RulerZ é capaz de converter regras diretamente em consultas e não precisa buscar dados previamente.

Isso é legal, mas por que eu preciso disso?

Em primeiro lugar, você consegue expressar regras de negócios em uma linguagem simples e dedicada. Então, essas regras de negócio podem ser encapsuladas em classes de especificação, reutilizadas e compostas para formar regras mais complexas. As especificações agora são reutilizáveis ​​e testáveis . E por último, mas não menos importante, essas regras podem ser usadas tanto para verificar se um candidato o satisfaz quanto para filtrar qualquer fonte de dados .

Se ainda precisar ser convencido, você pode ler todo o raciocínio neste artigo.

Uso rápido

Como uma rápida visão geral, propomos ver um pequeno exemplo que manipula uma regra simples e diversas fontes de dados.

1. Escreva uma regra

A regra a seguir descreve uma " jogadora com classificação elevada " (basicamente, uma jogadora com mais de 9.000 pontos).

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

2. Defina uma fonte de dados

Temos as seguintes fontes de dados:

 // 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. Use uma regra para consultar uma fonte de dados

Para qualquer fonte de dados, recuperar os resultados é tão simples quanto chamar o 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) Verifique se um candidato atende a uma regra

Dado um candidato, verificar se ele satisfaz uma regra se resume a chamar o método satisfies :

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

Indo mais longe

Confira a documentação para descobrir o que o RulerZ pode fazer por você.

Licença

Esta biblioteca está sob licença do MIT.