Skip to content

Latest commit

 

History

History
142 lines (89 loc) · 6.07 KB

CHANGELOG.md

File metadata and controls

142 lines (89 loc) · 6.07 KB

Changelog

2.0.0

  • Breaking change: Switched away from custom normalizers to the normalizers from digital-craftsman/self-aware-normalizers.
  • Breaking change: Removed base doctrine type IdListType in favor of ArrayNormalizableType of digital-craftsman/self-aware-normalizers.
  • Breaking change: Dropped support for PHP 8.2.
  • Added support for PHP 8.4.

1.4.0

  • Added method toString(): string to Id.

1.3.0

  • Added method mapWithIdKeys(callable $mapFunction): array to IdList.

1.2.1

  • Extend annotations for Id and IdList.

1.2.0

  • Renamed parameter $exception to $otherwiseThrow in the guard methods of Id and IdList to make it more clear what the parameter does when using named parameters.

1.1.0

  • Added option to supply a custom exception to the guard methods of Id and IdList. This allows for more specific exceptions when the guard fails.

Example of using the new (optional) parameter:

$requestingUser->userId->mustNotBeEqualTo(
    $command->targetUserId,
    static fn () => new Exception\UserCanNotTargetItself(),
);

1.0.0

Reached stability after 2 years of usage in multiple scaled production systems.

0.15.0

  • Added new guard method mustNotBeEmpty(): void to IdList.

0.14.0

  • Breaking change: Converted database column type from JSON to JSONB for IdListType to improve comparison performance and enable index creation.

0.13.0

  • Added compatibility for Symfony 7.

0.12.0

  • Dropped final keyword from method generateRandom(): static from Id, so that it can be overridden in subclasses. For example to be able to create UUID version 7 ids instead of the default version 4.

0.11.0

  • Breaking change: Changed abstract methods of types to be public and static to enable automatic registration.
  • Breaking change: Removed OrderedIdList as there weren't enough use cases for it.
  • Fixed return type of IdList::fromMap to be static instead of self.

0.10.0

  • Breaking change: Dropped support for Symfony below 6.3.
  • Added new method mustNotBeEqualTo(self $idList): void to IdList.
  • Added new method mustNotBeEqualTo(self $idList): void to OrderedIdList.
  • Added new method fromMap(iterable $items, callable $mapFunction): static to IdList.
  • Added support for getSupportedTypes to IdNormalizer and IdListNormalizer for new Symfony 6.3 serializer performance improvements.

0.9.0

  • Breaking change: Added readonly keyword to Id and IdList.
  • Drop support for PHP 8.1.
  • Add support for PHP 8.3.

0.8.0

  • Breaking change: Updated method removeId from IdList to throw an exception when the id is not in the list. This is the same behaviour as the addId method has.
  • Breaking change: Performance improvements for larger lists. Internal ids of IdList now use the string representation of an id as key instead of the index.
  • Added new method removeIdWhenInList(Id $id): static to IdList.
  • Added new method addIds(self $idList): static to IdList.
  • Added new method addIdsWhenNotInList(self $idList): static to IdList.
  • Added new method removeIds(self $idList): static to IdList.
  • Added new method removeIdsWhenInList(self $idList): static to IdList.
  • Added new method notContainsEveryId(self $idList): bool to IdList.
  • Added new method containsNoneIds(self $idList): bool to IdList.
  • Added new method mustNotContainEveryId(self $idList): void to IdList.
  • Added new method mustContainNoneIds(self $idList): void to IdList.
  • Added new named constructor fromIdStrings to IdList.

0.7.0

  • Breaking change: Changed the way IdList's diff method behaves to match array_diff's behavior.
    • Previously it returned an IdList containing all elements that were present in the IdList itself but not in the given IdList (method parameter) as well as all elements that were in the given IdList (method parameter) but not in the IdList itself.
    • Now it returns an IdList containing only the elements that are present in the IdList itself but not in the given IdList (method parameter).

0.6.0

  • Added containsEveryId(self $idList): bool to IdList.
  • Added containsSomeIds(self $idList): bool to IdList.
  • Added mustContainEveryId(self $idList): void to IdList.
  • Added mustContainSomeIds(self $idList): void to IdList.

0.5.1

  • Added PHPStan on level 9 and fixed PHPStan issues.

0.5.0

  • Reduced visibility of internal methods idAtPosition, mustNotContainDuplicateIds and mustOnlyContainIdsOfHandledClass of IdList from public to private.

0.4.0

  • Drop support for PHP 8.0.
  • Add support for PHP 8.2.

0.3.3

  • Improve template annotations

0.3.2

  • Return same instance of list when addIdWhenNotInList doesn't mutate the list.

0.3.1

  • The IdList now implements the \IteratorAggregate instead the \Iterator interface to fix comparing lists in tests with equal checks.

0.3.0

  • Breaking change: The methods isExistingInList and isNotExistingInList have been removed. The containsId method of the list class must be used instead.

0.2.0

  • Breaking change: The methods isExistingInList and isNotExistingInList now expect an id list as parameter instead of an array of ids.
  • Id list now supports ids of id subclass.

0.1.0

  • Initial release