valkyrjaio / valkyrja-php / 30720582621

100%

push

github

[Cache] feat!: Configure the cache component with a typed config contract (#1002)

# Description

`Valkyrja\Application\Env\Env` is deprecated. It is one non-final class
that holds
about 120 `public const` env variables for every component at once. This
pull
request gives the Cache component its own typed config contract and its
own config
classes. It also converts `CacheServiceProvider` to read that contract.

`CacheServiceProvider` no longer reads `Env`. An application that sets
an
`Env::CACHE_*` constant loses that setting, so this change breaks a
public
contract.

This pull request does not change `Env.php`. Each component gets its own
pull
request, and all of those pull requests are independent. A pull request
that
deleted its own constants would conflict with every sibling pull request
on that
one file. `Env` therefore stays in place and goes unread. A later pull
request
removes the whole class.

The shape follows `Cli\Interaction`, which already uses this pattern:

- `CacheConfigContract` is the container binding key. The application
can
implement the contract on its own `Config` class. `publishConfig` then
binds
  that object.
- `CacheConfig` is the default. `publishConfig` binds a new instance
when the
  application config does not implement the contract.
- The adapter configs are plain data classes without a contract. They
are values
that the parent config holds, not services that the container resolves.
This
  matches `Session\Data\CookieParams`.

The Cache component reads 7 env constants across 3 adapters. The nested
shape
keeps one container binding for the component and keeps each class
short.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [ ] Bug fix _(non-breaking change which fixes an issue)_
- [x] New feature _(non-breaking change which adds functionality)_
- [ ] Deprecation _(breaking change which removes functionality)_
- [x] Breaking change _(fix or feature that would cause existing
functiona... (continued)

65 of 0 new or added lines in 0 files covered. (NaN%)

12691 of 12691 relevant lines covered (100.0%)

24.31 hits per line