php dependency analysis

PHP -зависимость анализатор

PHP DA - это инструмент для проверки и поддержки зависимостей внутри вашего проекта.

Например:

• У вас есть проект с 3 -й пространствами именами: домен, приложение, инфраструктура
• Вы хотите быть уверенным, что зависимости в вашем проекте определяются как график

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

Это означает, что все классы из пространства доменных имен должны использовать только классы из этого пространства имен и, возможно, поставщика (он настроен).

Все классы из приложения могут использовать классы из пространств имен домена и приложений , но не из инфраструктуры и т. Д.

Если некоторые классы, использующие зависимости, не выполненные определенным графом зависимостей, вы даете ошибки в отчете:

 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

Варианты использования

Это может быть полезно, например, в некоторых случаях:

• Вы хотите извлечь часть вашего приложения в отдельную службу, вы определяете достоверные зависимости и запускаете PHP-DA для исследования рабочей нагрузки
• Вы хотите поддерживать низкую связь в вашем приложении, вы определяете достоверные зависимости и запускаете PHP-DA на вашем CI-сервере для каждого MR, только для измененных файлов
• Вы хотите внести видимые изменения структуры вашего приложения для всех разработчиков, теперь оно видно в конфигурации PHP-DA

Быстрый старт

Установить библиотеку с помощью композитора

 composer require paglliac/dependency-analysis

Конфигурация

Добавить файл конфигурации config.php в root от вашего проекта:

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

Бег

Запустите валидацию зависимости:

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

Параметры:

• -c или --config требуется опция с относительным путем к файлу конфигурации

Аргументы:

• [files filter] Список файлов для анализа, он полезен для использования в CI Combine с -DIFF

Пример вывода

 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