valkyrjaio / valkyrja-php / 30719226954

100%

push

github

[Log] feat!: Configure the log component with a typed config contract (#1004)

# 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 Log component its own typed config contract and its
own config
class. It also converts `LogServiceProvider` to read that contract.

`LogServiceProvider` no longer reads `Env`. An application that sets
`Env::LOG_DEFAULT_LOGGER` 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`:

- `LogConfigContract` is the container binding key. The application can
implement
the contract on its own `Config` class. `publishConfig` then binds that
object.
- `LogConfig` is the default. `publishConfig` binds a new instance when
the
  application config does not implement the contract.

The Log component reads one env constant, so the config class holds one
property
and needs no nested adapter config.

This is one of 14 pull requests that give each component its own config
contract.
See #1002 for the first one, which describes the pattern in full.

## 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
functionality to change)_
- [ ] Documentation improvement

## Changes

- **`src/Valkyrja/Log/Data/Contract/LogConfigContract.php`** — added the
... (continued)

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

12616 of 12616 relevant lines covered (100.0%)

23.77 hits per line