Refactor Library

[maennchen]

Motivation

Refactor Library to make full use of new PHP features and remove outdated code like DeflateStream.

TODO

• Fix Psalm Errors
• Add new up-to-date README
• Update GitHub Actions Config
• Provide Migration Guide in README
• Provide updated contribution guide
• Link to Deployed Documentation in Wiki after release (https://maennchen.github.io/ZipStream-PHP/)
• Update PHP-CS-Fixer (blocked - incompatible to PHP 8.2) Lowered support to 8.1.
• Install PHP Documentor (blocked - incompatible to PHP 8.2 / Start building on php 8.2 phpDocumentor/phpDocumentor#3376)
• Use Stable PHP 8.2 release in .tool-versions

Open Questions

Stream handling

Right now every file is converted into a StreamInterface. resources are converted into a StreamInterface via ResourceStream. To improve performance this could also be inverted so that StreamInterface is converted into a resource via stream_wrapper_register().

This would improve performance for native resources.

Inspiration: https://github.com/guzzle/psr7/blob/master/src/StreamWrapper.php

Steps TODO

• Create & Register StreamWrapper for StreamInterface
• Cast outputStream into custom stream wrapper
• Cast stream of addFileFromPsr7Stream into custom stream wrapper
• Read data of addFile into php://memory stream
• Pass fopen of path in addFileFromPath into addFileFromStream
• Pass resource directly into File in addFileFromStream
• Change File to use resources exclusively

Related Issues

Closes #194
Closes #135
Closes #161
Closes #175
Closes #78

[coveralls]

Pull Request Test Coverage Report for Build 3648952678

• 310 of 310 (100.0%) changed or added relevant lines in 17 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+17.9%) to 100.0%

---

Totals
Change from base Build 3648269894:	17.9%
Covered Lines:	642
Relevant Lines:	642

---

💛 - Coveralls

[maennchen]

@donatj I would also really like your input if you have some time :)

I'm especially interested in your opinion on the stream handling question from the PR description.

[donatj]

I opened a little PR against this, #232 - removes the need for deflate state from File - but I'm not entirely sure how to fix the phan complaint/php-cs-fixer complaint, I don't have PHP 8.2 to run against

[donatj]

I think it's kinda silly to release a library targeting a version of PHP that isn't even out yet.

There's still over 30% of users using 7.4 - I can't personally imagine targeting a library 8.2 that isn't even out yet.

https://packagist.org/packages/maennchen/zipstream-php/php-stats

I'm personally stuck professionally on 7.4 for at least a few months and then I suspect we're probably just going to kick up to 8.0 so it'll be like 4-5 years before I could even use this.

[maennchen]

@donatj The idea was to rewrite it in a way that is more understandable for other people to contribute.

This is not a call to abandon v2 which is compatible with PHP 8.0.

I would fix bugs in v2 until 8.2 is the minimum supported version of PHP.

The maintenance effort of the library is quite minimal, so I don’t see an issue in temporarily adressing bugs in two versions.

PHP 8.1 support runs out in two years.

[maennchen]

@donatj Actually, the new features used were mostly PHP 8.0 / 8.1. With a tiny change 8.1 is supported as well.

PHP 8.0 doesn't work because there are no enums. Given that active support for PHP 8.0 has already ended, that's not that big an issue for me for an upcoming release as long as there's an alternative still available.

Therefore bugfixes need to be provided for v2 until Nov 23.

[maennchen]

I've added a commit to use a stream wrapper for the StreamInterface instead of converting resource to StreamInterface.

This seems to work fine and removes all required (non-dev) dependencies.

I've added the psr dependencies to suggested and added some docs on how to install it as well.

[maennchen]

released as 3.0.0-beta.2 (after a tiny bugfix for the CI)