Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.2.1] - 2021-10-22

Added

Added tests to verify repeatability. That is, you can navigate to the end of the input, back to the beginning, back to the end, so on and so forth. Keep in mind, the chunks are only deterministic in one direction (i.e., the last chunk moving forward may not equal the first chunk moving backwards).

Changed

Updated navigation methods to be idempotent (i.e., calling next() at the end of the input multiple times does not change the current chunk or update the internal index).

Fixed

Fix README's examples and improved the language a little bit.
Fixed a bug where the chunker might return a string starting or ending with malformed byte sequences.

[0.2.0] - 2021-10-12

Version 0.2.0 includes a number of breaking changes, intended to make the library easier to use and maintain.

Removed

Removed the setIndex() method. It's better if you can't change a low-level component.
Removed the getName() and getText() methods. You already have that information and probably don't need the library to echo it back.

Changed

Updated the library for PHP 7.4+.
The $text and $name constructor arguments are now required for Text and File chunkers, respectively. You shouldn't be able to instantiate a chunker without either.
Added a $size argument to chunker constructors (i.e., removed setSize() and setEncoding() methods; added $size argument). Once a chunker has started chunking, changing the encoding or chunk size will break it. It seemed like a good idea to help prevent you from accidentally making a mistake.
Modernized the classes with property type hints, argument type hints, return type hints, guard clauses, etc.
Changed File tests from using concrete files and folders to using a virtual file system with bovigo/vfsStream.
Updated the README to better explain the problem this library solves.
Removed lots and lots of unnecessary comments :).

Added

Added ext-mbstring requirement to composer.json.
Added slevomat/coding-standard to enforce coding standards.
Added roave/security-advisories to exclude dependencies with known vulnerabilities.
Added continuous integration with CircleCI.
Added code coverage analysis with CodeCov.

[0.1.0] - 2015-07-03

The initial release.