valkyrjaio / valkyrja-php / 30722873509

100%

push

github

[Mail] feat!: Configure the mail component with typed config contracts (#1022)

# 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 Mail component its own typed config contracts. It also
converts
`MailServiceProvider` to read those contracts.

`MailServiceProvider` no longer reads `Env`. An application that sets an
`Env::MAIL_*` 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

The component config holds only the component-wide setting, and each
adapter gets
its own contract, its own default class, and its own container binding:

- `MailConfigContract` holds `defaultMailer`.
- `MailMailgunConfigContract` holds `mailgunDomain` and `mailgunApiKey`.
- `MailPhpMailerConfigContract` holds the five `phpMailer*` settings.

An application that sends through Mailgun never constructs the PHPMailer
settings, because the container resolves an adapter config only when
something
asks for that adapter.

Each property carries the adapter name as a prefix, so one application
config
class can implement several of these contracts at once.
`tests/Tests/Fixtures/Mail/Data/MailConfigFixture.php` implements all
three.

valkyrjaio/architecture#131 records this shape as a rule.

## 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 chan... (continued)

57 of 57 new or added lines in 4 files covered. (100.0%)

12802 of 12802 relevant lines covered (100.0%)

24.38 hits per line