php dependency analysis

Analizador de dependencia de PHP

PHP DA es una herramienta para verificar y soportar dependencias dentro de su proyecto.

Por ejemplo:

• Tiene un proyecto con 3 espacios de nombres raíz: dominio, aplicación, infraestructura
• Desea estar seguro de dependencias en su proyecto definidos como gráfico

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

Eso significa que todas las clases del espacio de nombres de dominio deben usar solo clases de este espacio de nombres, y posiblemente el proveedor (está configurado).

Todas las clases de la aplicación pueden usar clases de espacios de nombres de dominio y aplicaciones , pero no de infraestructura , etc.

Si algunas clases que usan dependencias no satisfacen un gráfico de dependencia definido, usted da errores en el informe:

 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

Puede ser útil en algunos casos, por ejemplo:

• Desea extraer parte de su aplicación en un servicio separado, defina dependencias válidas y ejecuta PHP-DA para investigar la carga de trabajo
• Desea admitir un bajo acoplamiento en su aplicación, defina dependencias válidas y ejecuta PHP-DA en su servidor CI para cada MR, solo para archivos modificados.
• Desea realizar cambios de estructura visibles de su aplicación para todos los desarrolladores, ahora es visible en la configuración PHP-DA

Comienzo rápido

Instalar biblioteca usando el compositor

 composer require paglliac/dependency-analysis

Configuración

Agregue el archivo de configuración config.php a root de su proyecto:

 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 ' ]
];

Correr

Validación de dependencia de ejecución:

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

Opciones:

• -c o --config se requiere opción con la ruta relativa a la configuración del archivo

Argumentos:

• [files filter] Lista de archivos para el análisis, es útil usar en CI Combine con - -Diff

Ejemplo de salida

 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