Skip to content

CHANGELOG.md

Latest commit

 

History

History
497 lines (350 loc) · 20.3 KB

CHANGELOG.md

File metadata and controls

497 lines (350 loc) · 20.3 KB

Changelog

All Notable changes to bakame/http-strucured-fields will be documented in this file.

Next - TBD

Added

  • None

Fixed

  • None

Deprecated

  • None

Removed

  • None

2.0.0 - 2024-12-12

Added

  • Bytes class replace the ByteSequence class.
  • Ietf enum.
  • methods fromRFC9651, fromRfc8941, toRFC9651, toRfc8941, to ease parsing/serializing Structured Fields.
  • method equals, to allow comparison of Structured Fields DataType.
  • method when to allow conditional addition to Structured Field DataType.
  • methods map, reduce, filter, sort to all containers classes.
  • methods isEmpty, isNotEmpty to all containers classes.
  • methods getByIndex, hasIndices, indices to all containers classes.
  • methods getByKey, hasKeys, indexByKey, keyByIndex, toAssociative to all ordered map classes (Dictionary and Parameters).
  • StructuredFieldProvider interface
  • Item::parameterByKey and Item::parameterByIndex methods to mirror the new public API.
  • All Item named constructors have a try equivalent which return null instead of throwing an exception
  • Parameters::valueByKey
  • Parameters::valueByIndex
  • Added a validation mechanism to facilitate Item and Parameters validation against field definition.
  • Dictionary::mergeParametersByPairs, Dictionary::mergeParametersByAssociative
  • Parameters::mergeParametersByPairs, Parameters::mergeParametersByAssociative

Fixed

  • Fixed Type inference.
  • Container IteratorAggregate interface always uses the index as key; it uses to be the key for Ordered Map.
  • append, prepend and add methods now accept null as value which result in doing nothing for consistency.

Deprecated

  • None

Removed

  • Removed the Parser from the public API.
  • MemberContainer, MemberList, MemberOrderedMap, and all the Parser related methods.
  • All deprecated methods during the version 1 cycle.
  • Item::parameter replaced by Item::parameterByKey
  • Parameters:get replaced by Parameters::getByKey
  • Parameters:pair replaced by Parameters::getByIndex
  • Dictionary:get replaced by Dictionary::getByKey
  • Dictionary:pair replaced by Dictionary::getByIndex
  • OuterList:remove replaced by OuterList:removeByIndices
  • InnerList:remove replaced by InnerList:removeByIndices
  • ::hasNoMember and ::hasMembers methods have been replaced by isEmpty and isNotEmpty on containers
  • Dictionary::toPairs and Parameters::toPairs
  • ByteSequence class replaced by Bytes class
  • DataType::create method use a specific DataType class instead.
  • Value internal class.

1.3.0 - 2024-01-05

Added

  • DataType::create returns an StructuredField instance from an iterable construct.
  • DataType::serialize returns the HTTP string representation of a structured field.

Fixed

  • InnerList::fromPair should not throw if the pair is empty because an inner list can be empty.

Deprecated

  • DataType::build use DataType::serialize instead.

Removed

  • None

1.2.2 - 2024-01-01

Added

  • None

Fixed

  • Type::ByteSequence value is renamed from bytesequence to binary to comply with the RFC.

Deprecated

  • None

Removed

  • None

1.2.1 - 2024-01-01

Added

  • None

Fixed

  • Item::new is fixed to better handle parsing with parameters values.

Deprecated

  • None

Removed

  • None

1.2.0 - 2023-12-30

Added

  • Support for the DisplayString type
  • ByteSequence::tryFromEncoded
  • Token::tryFromString
  • OuterList::fromPairs
  • DataType enum
  • Type::fromVariable
  • Type::tryFromVariable
  • Parser::new to simplify parser usage.

Fixed

  • Tests file moved under the /tests directory
  • Fix Type::tryFromVariable to correctly detect string type derivative.
  • the Type enum is now a baked string Enum.

Deprecated

  • Type::fromValue use Type::fromVariable instead
  • Type::tryFromValue use Type::tryFromVariable instead

Removed

  • None

1.1.0 - 2023-05-07

Added

  • OrederedMap::push
  • OrederedMap::unshift
  • OrederedMap::insert
  • OrederedMap::replace
  • OrederedMap::removeByIndices
  • OrederedMap::removeByKeys
  • ParameterAccess::pushParanmeters
  • ParameterAccess::unshiftParamaters
  • ParameterAccess::insertParamaters
  • ParameterAccess::replaceParamater
  • ParameterAccess::withoutParametersByKeys
  • ParameterAccess::withoutParametersByIndices
  • ItemParser interface to return an array representation of a Structured Field as an item.
  • ParametersParser interface to return an array representation of a Structured Field parameter container.
  • DictionaryParser interface to return an array representation of a Structured Field dictionary container.
  • ListParser interface to return an array representation of a Structured Field list container.
  • InnerListParser interface to return an array representation of a Structured Field inner list container.
  • ValueParser interface to return a PHP type from a Structured Field Value string representation.
  • Parser is now part of the public API
  • Item::fromHttpValue now has an optional second parameter to shift the parser implementation used
  • Parameters::fromHttpValue now has an optional second parameter to shift the parser implementation used
  • Dictionary::fromHttpValue now has an optional second parameter to shift the parser implementation used
  • OuterList::fromHttpValue now has an optional second parameter to shift the parser implementation used
  • InnerList::fromHttpValue now has an optional second parameter to shift the parser implementation used

Fixed

  • Parameters::remove also removes parameters per indices
  • Type::fromValue throws an InvalidArgument exception.
  • Type::fromValue and Type::tryFromValue should only check the PHP variable type and not take into account the variable value.

Deprecated

  • ParameterAccess::withoutParameters replaced by ParameterAccess::withoutParametersBykeys

Removed

  • None

1.0.1 - 2023-04-20

Added

  • None

Fixed

  • Parser no longer instantiate an Item object
  • Parser internal Date generation simplified
  • Value float serialization simplified
  • OuterList::fromHttpValue, InnerList::fromHttpValue, Dictionnary::fromHttpValue rewritten to improve decoupling from Parser
  • Adding missing interoperability test for the Token type

Deprecated

  • None

Removed

  • None

1.0.0 - 2023-04-16

Added

  • InnerList::fromPair to improve InnerList public API;
  • InnerList::toPair to improve InnerList public API;
  • InnerList::fromAssociative to improve InnerList public API;
  • Item implements the ValueAccess interface;
  • Item::toPair to complement Item::fromPair;
  • Item::fromDate to improve and complete the Item Date public API;
  • Item::fromAssociative to improve Item public API;
  • Item::fromString to improve Item public API;
  • Token::toString to return the string representation of the token.
  • Item::new, Parameters::new, Dictionary::new, InnerList::new and OuterList::new to return a new instance

Fixed

  • Improve annotation using @phpstan-type
  • Value internal class to improve Item public API;
  • [BC Break] ::fromAssociative and ::fromPair the $parameters argument is now required;
  • [BC Break] MemberOrderedMap instances can no longer be added to Dictionary or OuterList instances.
  • RFC restriction on eligible container members.
  • Exception normalization.

Deprecated

  • None

Removed

  • [BC Break] Remove Stringable automatically converted into a string type.
  • [BC Break] InnerList::fromPairParameters use InnerList::fromPair instead.
  • [BC Break] InnerList::fromAssociativeParameters use InnerList::fromAssociative instead.
  • [BC Break] Value interface use a combination of ValueAccess and ParameterAccess instead.
  • [BC Break] Token::value is no longer public use Token::toString instead.
  • [BC Break] Item::from is removed use Item::fromAssociative or Item::new instead.
  • [BC Break] Parameters::create is removed use Parameters::new instead.
  • [BC Break] InnerList::from is removed use InnerList::new instead.
  • [BC Break] OuterList::create is removed use OuterList::new instead.

0.8.0 - 2023-03-12

Added

  • Item::fromTimestamp, Item::fromDateFormat, Item::fromDateString to improve item instantiation with dates.
  • ParameterAccess::parameter to ease parameter members value access.
  • InnerList::fromAssociativeParameters, InnerList::fromPairParameters to improve item instantiation with parameters.
  • [BC Break] ParameterAccess::withoutAllParameters is renamed ParameterAccess::withoutAnyParameter.
  • [BC Break] OrderedList is renamed OuterList.
  • [BC Break] MemberContainer::remove methods get added to the interface.
  • [BC Break] MemberContainer::keys method added to the interface.

Fixed

  • Test suite migrated to PHPUnit 10
  • Adding Benchmark test with PHPBench
  • Improve Collection immutability with method changes
  • [BC Break] ParameterAccess interface signature updated to use the Value interface instead of the Item implementation.
  • [BC Break] MemberList::remove, MemberOrderedMap::remove and MemberOrderedMap::keys methods are moved to their parent interface.
  • [BC Break] Renamed arguments for indexation for normalization
  • [BC Break] MemberContainer::has and MemberOrderedMap::hasPair methods accept a variadic argument. All submitted indexes/keys should be present for the method to return true

Deprecated

  • None

Removed

  • [BC Break] OrderedList is removed, use OuterList instead.
  • [BC Break] ParameterAccess::withoutAllParameters is removed, use ParameterAccess::withoutAnyParameters instead.
  • [BC Break] remove the $parameters argument from all Item named constructors except from Item::from.
  • [BC Break] remove InnerList::fromList, use InnerList::fromAssociativeParameters or InnerList::fromPairParameters instead.
  • [BC Break] remove OuterList::fromList, use OuterList::from instead.

0.7.0 - 2023-02-06

Added

  • Support for Stringable instances added to Item::from, the instances will be converted to the string data type.
  • Support for the upcoming Date data type in Item represented as a DateTimeImmutable object. (see https://httpwg.org/http-extensions/draft-ietf-httpbis-sfbis.html)
  • ParameterAccess interface with new methods to ease parameter members modification.
  • Parameter::create named constructor to create a new instance without any parameter.
  • Dictionnary::create named constructor to create a new instance without any parameter.
  • Type Enum of all supported datatype.
  • Value Interface is introduced with Item being the only available implementation.
  • MemberOrderedMap::add and MemberOrderedMap::remove methods
  • ByteSequence::equals and Token::equals to easily compare type instances.
  • StructuredField extends the Stringable interface
  • ForbiddenOperation exception to reports invalid operation on immutable value objects.

Fixed

  • Item::fromHttpValue now internally uses the Parser previously it was using its own parsing rules.
  • Parameters::fromHttpValue now internally uses the Parser previously it was using its own parsing rules.
  • [BC Break] ::fromAssociative, ::fromList, ::fromPairs methods require iterable arguments without default value.
  • [BC Break] Item::value method returns the Item (returns value can be float|int|string|bool|ByteSequence|DateTimeImmutable|Token).
  • [BC Break] InnerList::parameters is no longer accessible as a public readonly property.
  • [BC Break] Modifying container instances with ArrayAccess modifying methods is forbidden and will trigger a ForbiddenOperation exception.

Deprecated

  • None

Removed

  • [BC Break] ForbiddenStateError exception is removed; the InvalidArgument exception is used instead.
  • [BC Break] Item::is* methods are removed; the enum Type is used instead.
  • [BC Break] MemberContainer::clear method is removed without replacement.
  • [BC Break] MemberOrderedMap::set and MemberOrderedMap::delete methods removed; use MemberOrderedMap::add and MemberOrderedMap::remove instead

0.6.0 - 2022-11-12

Added

  • The Container, MemberList, MemberOrderedMap, ParameterAccess interfaces.
  • OrderedList and InnerList implement the MemberList interface.
  • Parameters and Dictionnary implement the MemberOrderedMap interface.
  • The InvalidArgument exception.
  • Token::value is a readonly property.
  • Item::value method returns the decoded value of an Item (returns value can be float|int|string|bool).
  • Item::fromToken, Item::fromDecodedByteSequence , Item::fromEncodedByteSequence to ease Item creation.
  • Item::withValue to ease Item value update.
  • Parser methods also accepts Stringable objects.

Fixed

  • None.

Deprecated

  • None

Removed

  • [BC Break] __set_state implementation in all objects.
  • [BC Break] Token no longer implements the StructuredField interface.
  • [BC Break] Token::toHttpValue is removed; use the Item class to serialize a Token.
  • [BC Break] Token::toString is removed use its readonly property instead Token::value.
  • [BC Break] ByteSequence no longer implements the StructuredField interface.
  • [BC Break] ByteSequence::toHttpValue is removed; use the Item class to serialize a ByteSequence.
  • [BC Break] ::sanitize method is removed use Parameters::clear method instead if needed.
  • [BC Break] isEmpty method is removed use hasMembers method instead.
  • [BC Break] Parameters::value use Item::value method instead.
  • [BC Break] Parameters::values use Parameters::getIterator instead.
  • [BC Break] Item::value public readonly property use Item::value method instead.
  • [BC Break] Item::parameters public readonly property use Item::parameters method instead.
  • [BC Break] InnerList::parameters public readonly property use InnerList::parameters method instead.

0.5.0 - 2022-05-13

Added

  • Item::fromPair named constructor to create a new instance from a pair expressed as an array list with two values.
  • Parameters::sanitize ensure the container always contains only Bare Items.
  • InnerList::sanitize ensure the list is without gaps and calls Parameters::sanitize.
  • OrderedList::sanitize ensure the list is without gaps and calls Parameters::sanitize.
  • Dictionnary::sanitize ensure the list is without gaps and calls Parameters::sanitize.
  • Item::sanitize calls Parameters::sanitize.
  • autoload.php script to allow non composer application to load the package
  • OrderedList and InnerList now implements the PHP ArrayAccess interface.

Fixed

  • InnerList::fromHttpValue accepts Optional White Spaces at the start of its textual representation.
  • Parameters::fromHttpValue accepts Optional White Spaces at the start of its textual representation.
  • Item::fromHttpValue bugfix parsing Token data type.

Deprecated

  • None

Removed

  • [BC Break] InnerList no longer re-index its content replaced by InnerList::sanitize to force re-indexation.
  • [BC Break] OrdererList no longer re-index its content replaced by InnerList::sanitize to force re-indexation.

0.4.0 - 2022-03-27

Added

  • Dictionary::mergeAssociative and Dictionary::mergePairs to allow merging with associative structures
  • Parameters::mergeAssociative and Parameters::mergePairs to allow merging with key-value pairs structures

Fixed

  • All containers Dictionary, InnerList, OrderedList, Parameters modifying methods are made chainable.
  • Parser only returns array's of items or bare items value.
  • All Parameters getters checks for bare items validity.
  • ForbiddenStateError extends SPL LogicException instead of UnexpectedValueException

Deprecated

  • None

Removed

  • [BC Break] Dictionary::merge replaced by Dictionary::mergeAssociative
  • [BC Break] Parameters::merge replaced by Parameters::mergeAssociative

0.3.0 - 2022-03-21

Added

  • InnerList::fromHttpValue named constructor to make the public API consistent for all VOs

Fixed

  • None

Deprecated

  • None

Removed

  • None

0.2.0 - 2022-03-20

Added

  • Item::value is a public readonly property that gives access to the item value
  • Item::parameters is a public readonly property that gives access to the item parameters
  • InnerList::parameters is a public readonly property that gives access to the list parameters
  • OrderedList::from named constructor which accepts a variadic list of members items
  • Token::fromString named constructor which accepts string and Stringable object
  • Parameter::values returns an array of all the values contained inside the Parameters instance
  • [BC Break] ForbiddenStateError to replace SerializationError
  • [BC Break] InnerList::fromList to replace InnerList::fromMembers
  • [BC Break] OrderedList::fromList to replace OrderedList::fromMembers
  • [BC Break] Parameter::value to replace InnerList::parameter and Item::parameter

Fixed

  • ByteSequence::fromDecoded named constructor also accepts a Stringable object
  • ByteSequence::fromEncoded named constructor also accepts a Stringable object
  • Dictionary::merge accepts any iterable that can be accepted by Dictionary::fromAssociative as variadic parameter
  • Parameter::merge accepts any iterable that can be accepted by Parameter::fromAssociative as variadic parameter
  • [BC Break] OrderedList::__construct is made private use OrderedList::from instead
  • [BC Break] InnerList::__construct is made private use InnerList::fromList instead
  • [BC Break] Token::__construct is made private use Token::fromString instead
  • [BC Break] Parameter::get, Parameter::value, Parameter::pair will throw ForbiddenStateError if the BareItem is in invalid state.

Deprecated

  • None

Removed

  • [BC Break] InnerList::fromMembers replaced by InnerList::fromList
  • [BC Break] OrderedList::fromMembers replaced by OrderedList::fromList
  • [BC Break] Item::parameter replaced by Parameter::value
  • [BC Break] InnerList::parameter replaced by Parameter::value
  • [BC Break] SupportsParameters interface is removed without replacement
  • [BC Break] Item::value() replaced by Item::value public readonly property
  • [BC Break] Item::parameters() replaced by Item::parameters public readonly property
  • [BC Break] InnerList::parameters() replaced by InnerList::parameters public readonly property
  • [BC Break] InnerList::merge() use InnerList::push() or InnerList::unshift() instead
  • [BC Break] OrderedList::merge() use OrderedList::push() or OrderedList::unshift() instead
  • [BC Break] SerializationError use ForbiddenStateError instead

0.1.0 - 2022-03-18

Initial release!