Support for BcMath\Number objects

[derrabus]

This PR adds support for the new BcMath\Number value objects (php/php-src#13741). It allows comparing two numbers as well as comparing a number to an integer or a numeric string. The goal is to make the following assertions pass in PHPUnit:

self::assertEquals(new Number('13.37'), new Number('13.370000'));
self::assertEquals('13.37', new Number('13.37'));
self::assertEquals(13, new Number('13.37'));

The PR also allows to compare to numbers with a delta.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (07ba41d) to head (dcff245).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #121      +/-   ##
============================================
+ Coverage     99.00%   99.04%   +0.04%     
- Complexity      142      159      +17     
============================================
  Files            15       16       +1     
  Lines           402      421      +19     
============================================
+ Hits            398      417      +19     
  Misses            4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[derrabus]

Without this setting, PHPStan would report BcMath\Number as an unknown class and we would lose type coverage for the new NumberComparator class.

[sebastianbergmann]

I just updated PHPStan to version 2.1.1 on main. Maybe that solves this?

[derrabus]

No. PHPStan 2.0.1 does already know about the Number class, so upgrading to 2.1.1 doesn't change anything for me.

The problem is that PHPStan needs a target PHP version for its analysis. If we don't set it here, it will guess it from the composer.json file and assume PHP 8.2.0 because of this setting:

comparator/composer.json

Lines 41 to 43 in 07ba41d

	"platform": {
	"php": "8.2.0"
	},

The Number class simply does not exist on PHP 8.2 yet, so PHPStan technically correct when complaining about this.

[staabm]

BC Number support is tracked here: phpstan/phpstan#12099

[derrabus]

@staabm That's for the overloaded operators only which is a different issue. Once the issue you've linked is resolved, I can remove the one ignored error from the PHPStan configuration file.

[derrabus]

I've rebased the PR to make the CI run with the updated tools.

[sebastianbergmann]

@derrabus Thank you! Do you think sebastian/exporter needs to learn about BcMath\Number as well?