sebastian/comparator

Added

• Factory::setExporter() and Factory::exporter() for configuring the SebastianBergmann\Exporter\Exporter instance that is used by comparators registered with the factory

Changed

• Comparators now use the Exporter instance configured for their Factory instead of creating their own instances (this allows customizing how values are represented in comparison failure messages)
• When an object exporter provides the representation for the objects that are compared then that representation is used in the comparison failure message instead of the property-by-property representation; this does not apply to objects for which a comparator of their own exists (DateTimeComparator, for instance), as the representation such a comparator provides always has precedence

Added

• Factory::setExporter() and Factory::exporter() for configuring the SebastianBergmann\Exporter\Exporter instance that is used by comparators registered with the factory

Changed

• Comparators now use the Exporter instance configured for their Factory instead of creating their own instances (this allows customizing how values are represented in comparison failure messages)
• When an object exporter provides the representation for the objects that are compared then that representation is used in the comparison failure message instead of the property-by-property representation; this does not apply to objects for which a comparator of their own exists (DateTimeComparator, for instance), as the representation such a comparator provides always has precedence

Added

• #163: Expose detection of closure comparisons

Added

• #163: Expose detection of closure comparisons

Changed

• #136: Cleaner diff output for canonicalized list comparisons
• #160: Use by-value comparison for closures

Fixed

• #136: Canonicalized array comparison destroys string keys

Changed

• #136: Cleaner diff output for canonicalized list comparisons
• #160: Use by-value comparison for closures

Fixed

• #136: Canonicalized array comparison destroys string keys

Added

• #126: DateIntervalComparator for comparing DateInterval objects with a delta tolerance

Fixed

• #70: Non-ASCII text in XML diffs is rendered as numeric character references, making diffs unreadable
• #87: DOMNodeComparator crashes or returns false positives when DOMNode::C14N() fails
• #107: DOMNodeComparator reports XML documents as equal when they differ only in comments
• #115: DateTimeComparator does not track processed pairs, producing misleading diffs in nested structures
• #158: ComparisonFailure cannot be serialized when stack trace contains non-serializable objects

Added

• #126: DateIntervalComparator for comparing DateInterval objects with a delta tolerance

Fixed

• #70: Non-ASCII text in XML diffs is rendered as numeric character references, making diffs unreadable
• #87: DOMNodeComparator crashes or returns false positives when DOMNode::C14N() fails
• #107: DOMNodeComparator reports XML documents as equal when they differ only in comments
• #115: DateTimeComparator does not track processed pairs, producing misleading diffs in nested structures
• #158: ComparisonFailure cannot be serialized when stack trace contains non-serializable objects

Changed

• #138: Use StrictUnifiedDiffOutputBuilder instead of UnifiedDiffOutputBuilder

Changed

• #138: Use StrictUnifiedDiffOutputBuilder instead of UnifiedDiffOutputBuilder

Changed

• Pass configuration options introduced in sebastian/diff 8.3.0

Changed

• Pass configuration options introduced in sebastian/diff 8.3.0

Fixed

• #141: ArrayComparator sorts objects by spl_object_id(), breaking canonicalized equality for arrays of equal objects

Fixed

• #141: ArrayComparator sorts objects by spl_object_id(), breaking canonicalized equality for arrays of equal objects

Fixed

• #140: sort() in ArrayComparator produces non-deterministic results for arrays with mixed types

Added

• #137: Make diff context lines configurable

Removed

• Removed support for PHP 8.3

Changed

• #136: Cleaner diff output for canonicalized list comparisons
• #160: Use by-value comparison for closures

Fixed

• #136: Canonicalized array comparison destroys string keys

Changed

• #136: Cleaner diff output for canonicalized list comparisons
• #160: Use by-value comparison for closures

Fixed

• #136: Canonicalized array comparison destroys string keys

Fixed

• #70: Non-ASCII text in XML diffs is rendered as numeric character references, making diffs unreadable
• #87: DOMNodeComparator crashes or returns false positives when DOMNode::C14N() fails
• #107: DOMNodeComparator reports XML documents as equal when they differ only in comments
• #115: DateTimeComparator does not track processed pairs, producing misleading diffs in nested structures
• #158: ComparisonFailure cannot be serialized when stack trace contains non-serializable objects

Fixed

• #70: Non-ASCII text in XML diffs is rendered as numeric character references, making diffs unreadable
• #87: DOMNodeComparator crashes or returns false positives when DOMNode::C14N() fails
• #107: DOMNodeComparator reports XML documents as equal when they differ only in comments
• #115: DateTimeComparator does not track processed pairs, producing misleading diffs in nested structures
• #158: ComparisonFailure cannot be serialized when stack trace contains non-serializable objects

Fixed

• #141: ArrayComparator sorts objects by spl_object_id(), breaking canonicalized equality for arrays of equal objects

Fixed

• #141: ArrayComparator sorts objects by spl_object_id(), breaking canonicalized equality for arrays of equal objects

Fixed

• #140: sort() in ArrayComparator produces non-deterministic results for arrays with mixed types

Changed

• #134: Suppress warning introduced in PHP 8.5

Changed

• #130: Provide a diff when ClosureComparator fails

Fixed

• SebastianBergmann\Comparator\Comparator should not have been marked as private implementation detail of this library

Changed

• Do not use SplObjectStorage methods that will be deprecated in PHP 8.5

Added

• #127: Support for comparing Closure objects

Fixed

• #122: INF is considered equal to -INF

Removed

• Removed support for PHP 8.2

Changed

• #134: Suppress warning introduced in PHP 8.5

Changed

• Do not use SplObjectStorage methods that will be deprecated in PHP 8.5

Fixed

• #122: INF is considered equal to -INF

Added

• #121: Support for BcMath\Number objects

Fixed

• #119: Uninitialized string offset -1 warning

Changed

• #117: Remove common prefixes and suffixes from actual and expected single-line strings

Fixed

• Reverted #113 as it broke backward compatibility

Added

• Specialized comparator for enumerations

Fixed

• #112: Arrays with different keys and the same values are considered equal in canonicalize mode

Changed

• This project now uses PHPStan instead of Psalm for static analysis

Removed

• Removed support for PHP 8.1

Changed

• #134: Suppress warning introduced in PHP 8.5

Changed

• Do not use SplObjectStorage methods that will be deprecated in PHP 8.5

Fixed

• Reverted #113 as it broke backward compatibility

Fixed

• #112: Arrays with different keys and the same values are considered equal in canonicalize mode

Fixed

• MockObjectComparator only works on instances of PHPUnit\Framework\MockObject\MockObject, but not on instances of PHPUnit\Framework\MockObject\Stub
• MockObjectComparator only ignores the $__phpunit_invocationMocker property, but not other properties with names prefixed with __phpunit_

Changed

• Methods now have parameter and return type declarations
• Comparator::$factory is now private, use Comparator::factory() instead
• ComparisonFailure, DOMNodeComparator, DateTimeComparator, ExceptionComparator, MockObjectComparator, NumericComparator, ResourceComparator, SplObjectStorageComparator, and TypeComparator are now final
• ScalarComparator and DOMNodeComparator now use mb_strtolower($string, 'UTF-8') instead of strtolower($string)

Removed

• Removed $identical parameter from ComparisonFailure::__construct()
• Removed Comparator::$exporter
• Removed support for PHP 7.3, PHP 7.4, and PHP 8.0

Changed

• #134: Suppress warning introduced in PHP 8.5

Changed

• Do not use SplObjectStorage methods that will be deprecated in PHP 8.5

Fixed

• #102: Fix float comparison precision

Fixed

• #99: Fix weak comparison between '0' and false

Fixed

• SebastianBergmann\Comparator\Exception now correctly extends \Throwable

Fixed

• #89: Handle PHP 8 ValueError

Changed

• Changed PHP version constraint in composer.json from ^7.3 || ^8.0 to >=7.3

Added

• This component is now supported on PHP 8

Fixed

• #85: Version 4.0.1 breaks backward compatibility

Changed

• Tests etc. are now ignored for archive exports

Removed

• Removed support for PHP 7.1 and PHP 7.2

Changed

• #134: Suppress warning introduced in PHP 8.5

Changed

• Do not use SplObjectStorage methods that will be deprecated in PHP 8.5

Fixed

• #102: Fix float comparison precision

Fixed

• #99: Fix weak comparison between '0' and false

Changed

• Changed PHP version constraint in composer.json from ^7.1 to >=7.1

Changed

• By default, MockObjectComparator is now tried before all other (default) comparators

Fixed

• #53: DOMNodeComparator ignores $ignoreCase parameter
• #58: ScalarComparator does not handle extremely ugly string comparison edge cases

Fixed

• #48: DateTimeComparator does not support fractional second deltas

Removed

• Removed support for PHP 7.0

Changed

• This component is now compatible with version 3 of sebastian/diff

Fixed

• Fix comparison of DateTimeImmutable objects

Fixed

• phpunit/#2923: Unexpected failed date matching