Skip to content

Latest commit

 

History

History
302 lines (196 loc) · 13.3 KB

CHANGELOG.md

File metadata and controls

302 lines (196 loc) · 13.3 KB

Changelog

[Unreleased]

[4.0.0] - 2024-06-20

Added

  • Performance improvements
  • Validation error logging
  • \Rowbot\URL\URL and \Rowbot\URL\URLSearchParams now implement \Stringable
  • \Rowbot\URL\URLSearchParams constructor now has a native typehint of array|object|string
  • \Rowbot\URL\URLSearchParams now has a size getter per whatwg/url#734
    • \Rowbot\URL\URLSearchParams now also implements \Countable
  • Added \Rowbot\URL\URL::canParse(), which returns a boolean if parsing was successful, per whatwg/url#713 and whatwg/url#763
  • Add value parameter to \Rowbot\URL\URLSearchParams::has() and \Rowbot\URL\URLSearchParams::delete() per whatwg/url#335 and whatwg/url#735
  • Added \Rowbot\URL\URL::parse(), which will return the parsed URL or null on failure, avoiding needing a try statement per whatwg/url#372 and whatwg/url#825

Changed

  • Bump minimum PHP version to 8.1
  • Lone surrogate code points are no longer treated differently from other invalid code points
  • \Rowbot\URL\String\Exception\UConverterException has been renamed to \Rowbot\URL\String\Exception\EncodingException
  • Moved 32-bit tests to GitHub Actions from Appveyor
  • \Rowbot\URL\URL's $url and $base parameters now also accept \Stringable
  • \Rowbot\URL\URLSearchParams::current() now returns null when the iterator is invalid instead of ['', ''], which better matches the expected behavior
  • Ensure opaque paths can round trip from the API whatwg/url#651 whatwg/url#728
  • Blob URL's with an inner non-http(s) URL now returns an opaque origin per whatwg/url#770 and whatwg/url#771

Removed

  • Removed \Rowbot\URL\Exception\JsonException in favor of \JsonException

Internals

  • Removed class \Rowbot\URL\String\IDLString
  • Added method \Rowbot\URL\String\Utf8String::scrub()
  • Added method \Rowbot\URL\String\Utf8String::fromUnsafe()
  • Moved method \Rowbot\URL\String\AbstractUSVString::transcode() to \Rowbot\URL\String\Utf8String
  • Removed method \Rowbot\URL\String\Exception\RegexException::getNameFromLastCode()
  • All objects with a __toString() method now implement \Stringable
  • Added native union typehints where possible
  • \Rowbot\URL\Origin is now an interface
    • Added class \Rowbot\URL\Component\TupleOrigin which implements \Rowbot\URL\Origin
    • Added class \Rowbot\URL\Component\OpaqueOrigin which implements \Rowbot\URL\Origin
  • \Rowbot\URL\Component\PathListInterface renamed to \Rowbot\URL\PathInterface
    • Added class \Rowbot\URL\Component\OpaquePath which implements \Rowbot\URL\PathInterface
  • \Rowbot\URL\Component\Path was renamed to \Rowbot\URL\Component\PathSegment
  • \Rowbot\URL\State\CannotBeABaseUrlPathState was renamed to \Rowbot\URL\State\OpaquePathState
    • Removed property \Rowbot\URL\URLRecord::$cannotBeABaseUrl
  • Adopted the specs new percent encoding model
    • Removed const \Rowbot\URL\String\CodePoint::C0_CONTROL_PERCENT_ENCODE_SET
    • Removed const \Rowbot\URL\String\CodePoint::FRAGMENT_PERCENT_ENCODE_SET
    • Removed const \Rowbot\URL\String\CodePoint::PATH_PERCENT_ENCODE_SET
    • Removed const \Rowbot\URL\String\CodePoint::USERINFO_PERCENT_ENCODE_SET
    • Removed method \Rowbot\URL\String\CodePoint::utf8PercentEncode()
    • Added enum \Rowbot\URL\String\EncodeSet
    • Added class \Rowbot\URL\String\PercentEncoder
    • \Rowbot\URL\Component\Host\HostParser methods are no longer static
  • \Rowbot\URL\String\StringListInterface extends \IteratorAggregate instead of \Iterator
  • \Rowbot\URL\Component\QueryList now implements \Countable
  • Added enum \Rowbot\URL\State\StatusCode
    • \Rowbot\URL\State\State now has a return type of \Rowbot\URL\State\StatusCode instead of int
    • Removed const \Rowbot\URL\State\State::RETURN_OK
    • Removed const \Rowbot\URL\State\State::RETURN_CONTINUE
    • Removed const \Rowbot\URL\State\State::RETURN_BREAK
    • Removed const \Rowbot\URL\State\State::RETURN_FAILURE

[3.1.7] - 2022-08-26

Fixed

  • Detection of windows drive letters

[3.1.6] - 2022-08-16

Changed

  • Forbid C0 control code points and U+007F DEL code point in non-opaque domain names per whatwg/url#685

Fixed

  • Fix parsing IPv4-mapped IPv6 addresses due to wrong logical condition

[3.1.5] - 2022-01-10

Changed

  • Upgraded to PHPStan 1.0

Fixed

  • Initialization of URLSearchParams using an object now behaves the same as when using and iterator or string

[3.1.4] - 2021-07-27

Added

  • Support for PHP 8.1

Changed

Fixed

[3.1.3] - 2021-05-11

Fixed

  • File URL reparse bug with percent encoded windows drive letter whatwg/url#589

Changed

  • Switched to GitHub Actions for CI
  • Minimum PHPUnit version is now 7.5

[3.1.2] - 2021-02-11

Added

  • Performance improvements
  • Test on PHP 8 release in CI

[3.1.1] - 2020-10-17

Added

  • Support for brick/math ^0.9

Changed

[3.1.0] - 2020-07-15

Added

  • Added test coverage on Windows 32-bit.
  • Dependency on rowbot/idna to support international domain names without ext-intl.

Changed

  • URLSearchParams::sort() now correctly sorts by code units instead of trying to fake it using code points.
  • Null bytes are now percent encoded in fragments instead of being ignored per whatwg/url#440.
  • Domain names of URLs with special schemes can no longer be an empty string per whatwg/url#492 and whatwg/url#497.
  • Host names now also forbid the use of the <, >, and ^ code points per whatwg/url#458.

Fixed

  • Incorrect output encoding used when encoding was overriden to be "replacement", "utf-16", "utf-16le", or "utf-16be".
  • ext-json is now correctly listed as a dependency.

Removed

  • Dependency on ext-intl and lib-ICU.

[3.0.1] - 2020-02-29

Added

  • Improved portability and 32-bit PHP support.
  • Dependency on brick/math to support 32-bit versions of PHP.

Removed

  • Removed ext-gmp as a dependency.

[3.0.0] - 2020-02-11

The majority of this library was rewritten in this update, but the public API has remain unchanged. This should make for a relatively painless upgrade.

Added

  • Installation requirement of ICU >= 4.6 to assist with #6
  • Support for PHPUnit ^8.0 and ^9.0.
  • More test coverage.
  • Support for symfony/cache ^5.0.

Changed

  • "gopher" was removed from the list of special schemes per whatwg/url#453 and whatwg/url#454.
  • Coding style has been updated for PSR-12.
  • Non-iterable objects passed to the URLSearchParams constructor now have their properties iterated over using \ReflectionObject::getProperties() rather than directly. There should not be any change in behavior.
  • Removed artificial limitation when passing a sequence of sequences to the URLSearchParams constructor that required the non-array sub-sequences to implement the \ArrayAccess interface.
    • Note that sub-sequences must still be countable and only contain exactly 2 items.
    • This broadens the type of sequences that can be supplied from iterable<mixed, array{0: string, 1: string}> to iterable<mixed, iterable<mixed, stringable>>, where stringable is a scalar value or an object with the __toString() method.
  • URLSearchParams now throws a \Rowbot\URL\Exception\TypeError instead of a \InvalidArgument exception to match browsers when passed an iterable that does not solely contain other iterables that are countable.
  • JSON encoding the URL object will now throw a \Rowbot\URL\Exception\JsonException when JSON encoding fails.

Fixed

  • Documentaion errors.
  • Restores expected string conversion behavior on systems using an ICU version >= 60.1 (#7).
  • Origin::getEffectiveDomain() was incorrectly returning the string "null" instead of the actual value null when the origin was an opaque origin.

Removed

  • phpstan/phpstan and associated packages are no longer a dev dependency and is now only run in CI.
  • No longer depends on ext-ctype, which was an unlisted dependency.
  • php-coveralls/php-coveralls is no longer a dev dependency. The project has moved to Codecov instead.
  • squizlabs/php_codesniffer is no longer a dev dependency and is only run in CI now.

[2.0.3] - 2019-08-13

Fixed

  • "%2e%2E" and "%2E%2e" were not properly detected as percent encoded double dot path segments.

[2.0.2] - 2019-04-28

Added

  • PHP 7.4 compatibility
  • Sped up IPv6 address serialization by removing some unncessary type casting.

[2.0.1] - 2019-04-15

Fixed

  • Loading cached test data failed when using newer versions of the symfony/cache component.

[2.0.0] - 2018-12-08

Added

  • Tests now automatically pull the latest data directly from the Web Platform Tests repository - thanks @nyamsprod

Changed

  • The minimum required PHP version is now 7.1.
  • Testing environment updated for PHP 7.1 - thanks @nyamsprod
  • Native typehints are now used. This which means that an \TypeError is now thrown instead of an \InvalidArgumentException when a value with an incorrect type is passed.
  • \Rowbot\URL\Exception\TypeError and \Rowbot\URL\Exception\InvalidParserState now inherit from \Rowbot\URL\Exception\URLException

[1.1.1] - 2018-08-15

Added

  • Sped up URLSearchParams::has() when the string does not exist in the list.
  • TravisCI automation for tests and code coverage.

Fixed

  • The query string sorting algorithm now correctly sorts by code units instead of code points.

[1.1.0] - 2018-06-21

Added

  • Updated documentation
  • Updated tests

Changed

  • Only scalar values (bool, float, int, string) and objects with a __toString() method are considered as valid input now for methods and properties that only accept strings. This matches what PHP's string type hint would allow, allowing for an easier upgrade path when adding native type hints in the future.
    • A null value is no longer considered valid input and will cause an \InvalidArgumentException to be thrown. Previously, this was converted to the string "null".
    • A resource value such as that returned by a call to fopen() is no longer considered valid input and will cause an \InvalidArgumentException to be thrown. This was previously casted to a string resulting in something like "Resource id #1".
    • Previously, the values true and false were converted to the strings "true" and "false". This is no longer the case. They now are now simply cast to a string resulting in the values "1" and "" respectively.
  • Passing an iterable that does not solely contain other iterables to the URLSearchParams constructor now causes it to throw an \InvalidArgumentException.
  • Trying to access an invalid property on the URL object will now throw an \InvalidArgumentException to help catch typos.

[1.0.3] - 2018-06-19

Added

  • Sped up serialization of IPv6 addresses
  • Slightly better handling of non-UTF-8 encoded text when parsing query strings.
  • A bunch of missing use import statements
  • Updated tests and test data.

Changed

  • URLs with special schemes now percent encode ' characters in the query string.
  • The application/x-www-form-urlencoded parser now only handles UTF-8 encoded text.

[1.0.2] - 2018-02-28

Changed

  • Trying to set URL::searchParams directly will now throw a \Rowbot\URL\Exception\TypeError
  • Passing invalid input will throw an \InvalidArgumentException
  • Malformed byte sequences will now get fixed up with \u{FFFD} replacement characters.
  • URLSearchParams now implements \Iterator instead of \IteratorAggregate to match test expectations.

Fixed

  • The last few failing tests are now passing with the exception of 3 errors as a result of PHP bug 72506

[1.0.1] - 2018-02-22

Added

  • MIT License

[1.0.0] - 2018-02-22

  • Initial Release!