php dependency analysis

Analisador de dependência do PHP

O PHP DA é ferramenta para dependências de verificação e suporte dentro do seu projeto.

Por exemplo:

• Você tem projeto com 3 namespaces de raiz: domínio, aplicação, infraestrutura
• Você quer ter certeza de que as dependências em seu projeto são definidas como gráfico

[
    ' dependencies ' => [
        ' Domain ' => null ,
        ' Application ' => [ ' Domain ' ],
        ' Infrastructure ' => [ ' Domain ' , ' Application ' ]
    ]
];

Isso significa que todas as classes do namespace de domínio devem usar apenas classes deste espaço para nome e possivelmente fornecedor (está configurado).

Todas as classes do aplicativo podem usar classes de namespaces de domínio e aplicativos , mas não da infraestrutura , etc.

Se algumas classes usando dependências não atendidas no gráfico de dependência definida, você dará erros no relatório:

 Have been analyzed 4 files
You have dependency problems in 2 files in your project:

Class ApplicationTrackingService have errors:
    - Class ApplicationTrackingService using class InfrastructureShipImplementation which not satisfy dependency graph

Class DomainCargo have errors:
    - Class DomainCargo using class ApplicationTrackingService which not satisfy dependency graph
    - Class DomainCargo using class InfrastructureShipImplementation which not satisfy dependency graph

Casos de uso

Pode ser útil em alguns casos, por exemplo:

• Você deseja extrair parte do seu aplicativo em serviço separado, definir dependências válidas e executar o PHP-DA para investigar a carga de trabalho
• Você deseja oferecer suporte ao baixo acoplamento em seu aplicativo, define dependências válidas e executa o PHP-DA no seu servidor de CI para cada MR, apenas para arquivos alterados
• Você deseja fazer mudanças visíveis na estrutura de seu aplicativo para todos os desenvolvedores, agora está visível na configuração php-da

Início rápido

Instale a biblioteca usando compositor

 composer require paglliac/dependency-analysis

Configuração

Adicione o arquivo de configuração config.php ao root do seu projeto:

 return [
    /**
     * REQUIRED
     * Dependencies Graph
     *
     * Description of valid dependencies in project
     *
     * This config means
     *
     * Package (every class in namespace) Domain can use only classes from namespace Domain or vendor dependencies
     * Package Application can use only classes from namespaces Domain, Application or vendor dependencies
     * Package Infrastructure can use only classes from namespaces Domain, Application, Infrastructure or vendor dependencies
     */
    ' dependencies ' => [
        ' Domain ' => null ,
        ' Application ' => [ ' Domain ' ],
        ' Infrastructure ' => [ ' Domain ' , ' Application ' ]
    ],

    /**
     * REQUIRED
     * Source path where dependencies will be analyzed
     */
    ' path ' => __DIR__ ,

    /**
     * OPTIONAL
     *
     * Make available to use vendor dependencies in whole project
     *
     * true - all project classes can use vendor dependencies
     * false - all project can not use vendor dependencies
     */
    ' skip_vendor_dir ' => true ,

    /**
     * OPTIONAL
     * Flag that define how to do when some files placed in namespaces not presented in Dependencies Graph
     *
     * true - mark class as having incorrect dependencies
     * false - skip this file
     *
     * For example, in directory we have namespace SomeNamespace with class SomeNamespaceSomeClass
     * if flag is true, it will be marked as incorrect file, if flag is true, this file wil be marked as correct
     */
    ' fail_on_non_presented_namespace ' => false ,

    /**
     * OPTIONAL
     * Flag for php parser, correct values:
     *
     * PhpParserParserFactory::PREFER_PHP7 - 1 (default)
     * PhpParserParserFactory::PREFER_PHP5 - 2
     * PhpParserParserFactory::ONLY_PHP7 - 3
     * PhpParserParserFactory::ONLY_PHP5 - 4
     */
    ' php_version ' => PhpParser ParserFactory:: PREFER_PHP7 ,

    /**
     * OPTIONAL
     * 
     * List of allowed files extensions, all files with other extensions will be skipped from analysis
     * 
     * Default - ['php']
     */
    ' allowed_extensions ' => [ ' php ' ]
];

Correndo

Execute a validação de dependência:

 /vendor/bin/php-da -c config.php [files filter]

Opções:

• -c ou --config é a opção necessária com o caminho relativo ao arquivo de configuração

Argumentos:

• [files filter] Lista de arquivos para análise, é útil usar no CI combinar com - -diff

Exemplo de saída

 Have been analyzed 4 files
You have dependency problems in 2 files in your project:

Class ApplicationTrackingService have errors:
    - Class ApplicationTrackingService using class InfrastructureShipImplementation which not satisfy dependency graph

Class DomainCargo have errors:
    - Class DomainCargo using class ApplicationTrackingService which not satisfy dependency graph
    - Class DomainCargo using class InfrastructureShipImplementation which not satisfy dependency graph