deptrac.yaml

deptrac:
  paths:
    - ./src
  exclude_files:
    - '#.*tests.*#'
  layers:
    - name: Domain
      collectors:
        - type: classLike
          value: WMDE\\Fundraising\\PaymentContext\\Domain\\.*
    - name: UseCase
      collectors:
        - type: classLike
          value: WMDE\\Fundraising\\PaymentContext\\UseCases.*
    - name: DataAccess
      collectors:
        - type: classLike
          value: WMDE\\Fundraising\\PaymentContext\\DataAccess.*
        - type: class
          value: WMDE\\Fundraising\\PaymentContext\\ScalarTypeConverter
    # Interfaces and value objects for services
    - name: ServiceModel
      collectors:
        - type: interface
          value: WMDE\\Fundraising\\PaymentContext\\Services.*
        - type: class
          value: WMDE\\Fundraising\\PaymentContext\\Services\\Paypal\\Model.*
        - type: classLike
          value: WMDE\\Fundraising\\PaymentContext\\Services\\PaymentUrlGenerator\\Sofort.*
    - name: Service
      collectors:
        - type: bool
          must:
            - type: class
              value: WMDE\\Fundraising\\PaymentContext\\Services.*
          must_not:
            - type: class
              value: WMDE\\Fundraising\\PaymentContext\\Services\\Paypal\\Model.*
            - type: class
              value: WMDE\\Fundraising\\PaymentContext\\Services\\PaymentUrlGenerator\\Sofort.*
    # Domain libraries from WMDE
    - name: DomainLibrary
      collectors:
        - type: classNameRegex
          value: /WMDE\\Euro\\.*/
        - type: classNameRegex
          value: /WMDE\\FunValidators\\.*/
    # External Vendor libraries
    - name: Doctrine
      collectors:
        - type: classNameRegex
          value: /Doctrine\\.*/
    - name: Guzzle
      collectors:
        - type: classNameRegex
          value: /GuzzleHttp\\.*/
    - name: Sofort
      collectors:
        - type: classNameRegex
          value: /^Sofort\\.*/
    - name: Psr
      collectors:
        - type: classNameRegex
          value: /^Psr\\.*/
    - name: Symfony Config
      collectors:
        - type: classNameRegex
          value: /^Symfony\\Component\\(Config|Yaml)\\.*/
  ruleset:
    Domain:
      - DomainLibrary
    UseCase:
      - Domain
      - DataAccess
      - ServiceInterface
      - DomainLibrary
      - DomainValidators
      - ServiceModel
    DataAccess:
      - Domain
      - DomainLibrary
      - Doctrine
    Service:
      - DomainLibrary
      - Domain
      # This dependency is too broad, as services should not depend on whole use cases.
      # At the moment the dependency is necessary, because the Services\ExternalVerificationService implementations
      # depend both on the ExternalVerificationService interface and the value objects (request, response) it defines.
      # A solution here would be its own namespace and layer for "UseCaseDomain" or moving the external verification
      # into the Domain layer.
      - UseCase
      - DataAccess
      - ServiceModel
      # Maybe the Services should not directly depend on Doctrine but should go through the `DataAccess` layer
      # TODO: Move  DoctrineTransactionIdFinder.php and UniquePaymentReferenceCodeGenerator.php into DataAccess
      - Doctrine
      - Guzzle
      - Sofort
      - Psr
      - Symfony Config
    ServiceModel:
      - Domain
      - DomainLibrary
      - ServiceInterface
  formatters:
    graphviz:
      groups:
        Service:
          - Service
          - ServiceModel
        Vendor:
          - Doctrine
          - Guzzle
          - Sofort
          - Psr
          - Symfony Config