valkyrjaio / valkyrja-php / 30722854124

100%

push

github

[Filesystem] feat!: Configure the filesystem component with typed config contracts (#1023)

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

`FilesystemServiceProvider` no longer reads `Env`. An application that
sets an
`Env::FILESYSTEM_*` constant, or `Env::FLYSYSTEM_FILESYSTEM_DEFAULT`,
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:

- `FilesystemConfigContract` holds `defaultFilesystem`.
- `FilesystemFlysystemConfigContract` holds
`defaultFlysystemFilesystem`, which
  chooses between the local adapter and the S3 adapter.
- `FilesystemFlysystemLocalConfigContract` holds `flysystemLocalPath`.
- `FilesystemFlysystemS3ConfigContract` holds the seven `flysystemS3*`
settings.

An application that stores files on S3 never constructs the local path
config,
and an application that stores files locally never constructs the seven
S3
settings. 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/Filesystem/Data/FilesystemConfigFixture.php`
implements all
four.

valkyrjaio/architecture#131 records t... (continued)

70 of 70 new or added lines in 5 files covered. (100.0%)

12777 of 12777 relevant lines covered (100.0%)

24.39 hits per line