jean85/pretty-package-versions

Added

• PHP 8.1 support verified
• Added the Version::NO_VERSION_TEXT constant to retrieve the string used when no version is available (#41)

Fixed

• Handle with Version::NO_VERSION_TEXT constant when no version is available due to replaced package (#41)

Fixed

• Handle deprecation of InstalledVersions::getRawData() from Composer 2.0.14 (#39, thanks @BramRoets)

Added

• Added the Version::NO_REFERENCE_TEXT constant to retrieve the string used when no reference is availabled (#38, thanks @DeyV)

Changed

• Retrieve root package information without indirection (a1cfeec)

Fixed

• Handle null as reference when constructing Version (#36)

This small patch handles replaced and provided packages, so that consumers of this library can handle bad requests gracefully.

Added

• Add VersionMissingExceptionInterface, and two exceptions implementing it: ProvidedPackageException and ReplacedPackageException

Fixed

• Throw explicit ProvidedPackageException when asking for the version of a package which is provided (was \TypeError before)
• Throw explicit ReplacedPackageException when asking for the version of a package which is replaced (was \TypeError before)

This release is aimed to become a bridge for native Composer 2 support. The BC breaks are minimal; if you're using it in a library, you're encouraged to require it with ^1.5 || ^2.0, so that your end users will not be constrained to use a specific Composer version.

Added

• Version methods added: getReference, getShortReference, getVersionWithShortReference (see table below)

Changed

• Use Composer 2 API directly to retrieve versions
• Version methods deprecated; this is a simple rename (commit to reference), to better reflect the meaning of Composer API data; the old methods are preserved but deprecated to reduce breaking changes:

New method	Old, deprecated method
Version::getReference()	Version::getCommitHash()
Version::getShortReference()	Version::getShortCommitHash()
Version::getVersionWithShortReference()	Version::getVersionWithShortCommit()

Removed

• Drop PHP 7.0 support
• Drop Composer 1 support
• Drop dependencies
• [BC BREAK] Constant PrettyVersions::SHORT_COMMIT_LENGTH removed
• [BC BREAK] Constant Version::SHORT_COMMIT_LENGTH made private
• [BC BREAK] Version constructor changed arguments: second argument string $version has been split into string $prettyVersion, string $reference

Added

• Add forward compatibility layer for newer methods in 2.0 (see the 2.0 changelog)

Added

• PHP 8 support (#28)

Changed

• Require at least ocramius/package-versions 1.2 to fix root package version (see #3)

Known issues

• Use this package with Composer >= 1.5.3 to fix root package version when in version-branch (see #4)

Added

• Add PHP 7.2 to the build matrix for official support

Changed

• Require at least ocramius/package-versions 1.1.3 to avoid issues when removing the package (see this issue)

Changed

• Make the package lightweight thanks to the .gitattributes file (#1)

Added

• Add Version::__getShortCommitHash() method (see #8, thanks @emodric)

Added

• Add Version::__toString() method (see #5)

First release

Changed

• Jean85\PrettyVersions wraps the PackageVersions\Versions class and returns a Jean85\Version object
• The Jean85\Version has these methods available:
  • public function getPrettyVersion(): string
  • public function getFullVersion(): string
  • public function getVersionWithShortCommit(): string
  • public function getPackageName(): string
  • public function getShortVersion(): string
  • public function getCommitHash(): string