valkyrjaio / ci-phparkitect-php / 30720982539

100%

push

github

[Provider] feat: Add a rule that a provider name contains its component (#166)

# Description

This change adds an architecture rule. A provider class must carry the
name of the component that it
belongs to.

The rule closes a gap that a real defect exposed. The file
`src/Valkyrja/Session/Provider/SmsServiceProvider.php` in the framework
declared
`namespace Valkyrja\Session\Provider;` and `class SmsServiceProvider`.
The class registered Session
services only, but it carried the Sms component's name. PHPArkitect
passed the file. The existing
rules check the `*ServiceProvider` name suffix and the `Provider\`
segment, and neither one checks
the component name. valkyrjaio/valkyrja-php#1005 renamed the class. This
change stops the next one.

The recursive uniqueness rule in `AGENTS.md` §4 exists because the
generated data-cache file
references providers from many components at the same time. Two
providers with the same name collide
in that file. A wrong component name is therefore a correctness risk,
not a style preference.

## The new expression

`HaveNameContainingComponent` reads the component from the class
namespace, so a static pattern
cannot express it. A namespace takes the form
`Root\Component\...\Segment`, so the component is the
second segment. A namespace of two segments has no component segment, so
the root names the
component. `Sindri\Provider\SindriComponentProvider` therefore takes
`Sindri`.

The expression tests for a substring, not for a prefix. A prefix test
gives a false positive on three
shapes that are correct today:

| Class | Component | Result |
|-------|-----------|--------|
| `Valkyrja\Application\Provider\CliApplicationComponentProvider` |
`Application` | passes — a protocol qualifier comes first |
| `Valkyrja\Http\Routing\Provider\HttpRoutingHttpRoutesProvider` |
`Http` | passes — a sub-component follows |
| `Sindri\Provider\SindriComponentProvider` | `Sindri` | passes — the
root names the component |
| `Valkyrja\Session\Provid... (continued)

31 of 31 new or added lines in 2 files covered. (100.0%)

319 of 319 relevant lines covered (100.0%)

1.33 hits per line